入站 PIX Webhook

用于通知到达某个 Alias 的 PIX 交易的 Webhook。

Webhook 请求体

请求体：已收到 PIX

{
  "webhook_type": "baas.pix_transfer.incoming_pix",
  "webhook_datetime": "2021-10-22T20:30:23.459Z",
  "data": {
    "pix_transfer_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
    "end_to_end_id": "E18236120202308111235s14fddf2801",
    "pix_transfer_status": "received",
    "account_key": "7c5a1425-73eb-420e-b4fb-0ce3386c7d0c",
    "alias_key": "fc6862c4-2b20-4057-8063-b8809866e494",
    "receiver_conciliation_id": "745c28c780bc4822bbade86dd875d10b",
    "transfer_amount": 126.97,
    "fee_amount": 0.0,
    "source_account": {
      "account_branch": "0001",
      "account_digit": "3",
      "account_number": "12345678",
      "owner_document_number": "***02502000***",
      "owner_person_type": "legal",
      "owner_name": "Qi Tech",
      "account_type": "checking_account",
      "ispb": "32402502"
    },
    "pix_transfer_type": "dynamic_qr_code",
    "pix_message": "pix message received",
    "created_at": "2021-10-22T20:30:23.459Z",
    "reversals": []
  }
}

Webhook 请求体参数

字段	类型	描述	最大字符数
webhook_type	string	定义所报告事件类型的枚举值。	23
webhook_datetime	string	Webhook 发送的日期和时间。	20
pix_transfer_type	enumerador	执行的 PIX 类型。	pix_transfer_type 枚举值
target_pix_key	string	目标账户的 PIX 密钥。	100
source_account	Object	来源账户 - 仅在 "manual" 类型交易中发送。	source_account 对象
transfer_amount	number	转账金额。	10
receiver_conciliation_id	string	接收方对账标识符。	35
end_to_end_id	string	PIX 交易的幂等性密钥 - 仅当转账类型为 "key" 时发送。	32
pix_message	string	随 PIX 转账发送的消息。	140
fee_amount	number	手续费金额。	10
pix_transfer_status	string	PIX 交易状态。	10
account_key	string	QI 账户的唯一标识密钥。	36
alias_key	string	Alias 的唯一密钥。	36
pix_transfer_key	string	PIX 转账的唯一标识密钥。	36

pix_transfer_type 枚举值

枚举值	描述
manual	使用目标账户数据的 PIX。
key	使用 PIX 密钥的 PIX。
static_qr_code	使用静态 QR 码的 PIX。
dynamic_qr_code	使用动态 QR 码的 PIX。
reversal	PIX 退款。

source_account 对象

字段	类型	描述	字符数
account_branch *	string	账户支行号。	6
account_digit *	string	账号校验位。	1
account_number *	string	账号。	20
owner_document_number *	string	账户持有人的 CPF 或 CNPJ（仅数字）。	14
owner_name	string	账户持有人姓名。	150
account_type*	enumerador	账户类型。	account_type 枚举值
ispb *	string	在巴西中央银行储备转账系统中识别银行的八位代码。	8

account_type 枚举值

枚举值	描述
checking_account	支票账户
salary_account	工资账户
saving_account	储蓄账户
payment_account	支付账户