跳到主要内容

Pix 预约完成 Webhook

Pix 预约完成后，将向集成合作伙伴发送一个包含结果的 webhook。

注意！

QI Tech 的 webhook 不应进行严格的字段映射。我们 API 返回的 webhook 载荷中可能包含额外字段。

Webhook Request Body​

Request Body: 预约已完成并发送
{
  "webhook_type": "baas.pix_schedule.completed",
  "webhook_datetime": "2021-10-22T20:30:23.459Z",
  "data": {
    "created_at": "2024-07-10T16:17:28Z",
    "pix_message": null,
    "rejection_info": null,
    "rejection_reason": null,
    "request_control_key": "b8eb663e-10fe-4729-9db5-8f8c93de5001",
    "schedule_date": "2024-07-10",
    "schedule_key": "0c9091ab-079b-4a43-8b3d-d4ba36a23883",
    "schedule_status": "sent",
    "schedule_transfers": [
      {
        "created_at": "2024-07-10T16:19:33Z",
        "end_to_end_id": "E3240250220240710161922sSHNf8BjI",
        "pix_transfer_key": "427b70cd-73b0-45d1-bb4a-97f50f605022",
        "pix_transfer_status": "sent"
      }
    ],
    "target_account": {
      "account_branch": "0001",
      "account_digit": "8",
      "account_number": "1234567",
      "account_type": "checking_account",
      "ispb": "99999004",
      "owner_document_number": "***91111***",
      "owner_name": "Conta manual geral",
      "owner_person_type": "natural",
      "pix_key": null,
      "receiver_conciliation_id": null
    },
    "transaction_amount": 2.0,
    "updated_at": "2024-07-10T16:19:38Z"
  }
}
Request Body: 预约已完成并被拒绝
{
  "created_at": "2024-07-11T16:03:54Z",
  "pix_message": null,
  "rejection_info": {
    "error_code": "PSC000030",
    "error_description": "The maximum amount of pix transfer attempts has been reached",
    "error_translation": "A maxima quantidade de retentativas de transacao pix foi atingida",
    "rejection_reason": "max_tries_exceeded"
  },
  "rejection_reason": null,
  "request_control_key": "b8eb663e-10fe-4729-9db5-8f8c93de0008",
  "schedule_date": "2024-07-11",
  "schedule_key": "8b262d82-3fc6-40f0-bfe5-bf18556ededb",
  "schedule_status": "rejected",
  "schedule_transfers": [
    {
      "created_at": "2024-07-11T16:04:21Z",
      "end_to_end_id": "E32402502202407111604ffoPVrGebI0",
      "pix_transfer_key": "c2c4e064-e684-450b-add5-07fb1efe8991",
      "pix_transfer_status": "rejected"
    },
    {
      "created_at": "2024-07-11T16:08:33Z",
      "end_to_end_id": "E32402502202407111608TQ3C4vRPRPk",
      "pix_transfer_key": "c30254db-86b2-4d8a-be01-29fa0d93ae92",
      "pix_transfer_status": "rejected"
    },
    {
      "created_at": "2024-07-11T16:09:20Z",
      "end_to_end_id": "E32402502202407111609zSUQQOvmMV6",
      "pix_transfer_key": "1a329248-fc39-4b49-9b95-8f1c1bb10c8b",
      "pix_transfer_status": "rejected"
    }
  ],
  "target_account": {
    "account_branch": "0001",
    "account_digit": "8",
    "account_number": "1234567",
    "account_type": "checking_account",
    "ispb": "99999004",
    "owner_document_number": "***91111***",
    "owner_name": "Conta manual geral",
    "owner_person_type": "natural",
    "pix_key": null,
    "receiver_conciliation_id": null
  },
  "transaction_amount": 2.0,
  "updated_at": "2024-07-11T16:09:21Z"
}

Webhook Body Param​

字段类型描述最大字符数
webhook_typestring定义所报告事件类型的枚举器23
webhook_datetimestringwebhook 发送的日期和时间20
transaction_amountnumber转账金额10
target_accountobject预约的目标账户Objeto target_account
schedule_transfersarray预约执行的转账尝试列表Objeto schedule_transfer 列表
schedule_statusstring预约状态Enumerador schedule_status
schedule_keystring预约的唯一标识键36
schedule_datestring执行交易的日期。10
request_control_keyuuidv4客户使用的请求唯一标识键，uuid v4 格式。36
rejection_infoobject包含拒绝事件信息的对象
rejection_reasonstring拒绝原因Enumeradores rejection_reason
pix_messagestring随 Pix 转账发送的消息140
updated_atstring预约最后更新的日期和时间。20
created_atstring预约创建的日期和时间。20

Pix Schedule Status​

枚举值描述
scheduled交易已预约
sent预约完成并成功发送。最终状态
rejected预约在创建或执行期间被拒绝。最终状态
cancelled应客户申请取消预约。最终状态
pending_2fa_approval待双因素认证批准
pending_creation预约正在创建（批量预约的过渡状态）
waiting_batch_approval预约已创建并关联到批次，等待双因素认证批准

Schedule Transfer Object​

字段类型描述字符数
pix_transfer_keyuuidv4QI 系统中 Pix 转账的唯一标识键。36
end_to_end_id *stringSPI（即时支付系统）内 Pix 交易的幂等键32
pix_transfer_statusstring交易状态。Enumeradores pix_transfer_status
created_atstring交易创建日期和时间。20

Enumerador Pix Transfer Status​

枚举值描述
sent交易成功发送。最终状态
rejected交易在执行期间被拒绝。最终状态
pending交易待完成。过渡状态

Objeto target_account​

字段类型描述字符数
account_branchstring账户机构编号6
account_digitstring账户数字1
account_numberstring账户号码20
owner_document_numberstring账户持有人 CPF 或 CNPJ（仅数字）14
owner_namestring账户持有人姓名150
owner_person_typeenumerator标识所发送账户的持有人是自然人还是法人的识别器Enumerador owner_person_type
account_typeenumerator账户类型Enumerador account_type
ispbstring在巴西央行准备金转账系统中识别银行的八位代码8
pix_keystring预约目标的 Pix 密钥100

Enumerador owner_person_type​

枚举值描述
natural自然人（个人）
legal法人（企业）

Enumerador account_type​

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

Enumeradores rejection_reason​

枚举值描述
target_creation_error预约创建错误
limit_date_for_approval_surpassed超过批准的最后期限
limit_date_for_batch_approval_surpassed超过批量批准的最后期限
max_tries_exceeded超过最大尝试次数
rejection_by_transfer因转账被拒绝
target_change目标账户已变更
invalid_pix_key无效的 Pix 密钥
max_token_validation_attempts_exceeded超过令牌验证最大尝试次数
error_sending_token发送令牌时出错
max_token_validation_attempts_exceeded_for_batch超过批量令牌验证最大尝试次数