TED 发送完成后的 Webhook

Webhook 将通知 TED 交易是否已被退回。

Webhook Request Body

Webhook Body: TED 已拒绝

{
  "webhook_type": "baas.ted.outgoing_ted",
  "webhook_datetime": "2021-10-22T20:30:23.459Z",
  "data": {
    "request_control_key": "6e290347-330d-4b3a-8ebb-2ac217ad6eb3",
    "ted_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
    "account_key": "fc6862c4-2b20-4057-8063-b8809866e494",
    "created_at": "2021-10-22T20:30:23.459Z",
    "ted_status": "sent",
    "transaction_amount": 126.97,
    "fee_amount": 0.0,
    "target_account": {
      "account_branch": "0001",
      "account_digit": "6",
      "account_number": "78340",
      "ispb": "12345678",
      "owner_document_number": "32402502000135",
      "owner_name": "QI Tech"
    },
    "refusal_reason": {
      "refusal_code": 1,
      "enumerator": "conta_destinatario_encerrada",
      "description": "Conta Destinatária do Crédito Encerrada"
    }
  }
}

Webhook Body Param

字段	类型	描述	最大字符数
webhook_type	string	定义正在报告的事件类型的枚举值	23
webhook_datetime	string	Webhook 发送的日期和时间	20
request_control_key	string	客户使用的 uuid v4 格式的请求唯一标识键	36
ted_key	string	TED 转账的唯一标识键	36
created_at	string	交易创建的日期和时间	24
ted_status	string	TED 交易状态	Enumerador ted_status
transaction_amount	number	转账金额	10
fee_amount	number	转账收取的费用金额	35
target_account	Object	目标账户 - 仅在"manual"类型的交易中发送	Objeto target_account
refusal_reason	Object	根据巴西中央银行标准的拒绝原因	Objeto refusal_reason

Enumerador ted_status

枚举值	描述
sent	TED 转账成功完成。
pending	TED 转账待处理。
rejected	TED 转账已拒绝。
returned	TED 转账已退回。

Objeto target_account

字段	类型	描述	字符数
account_branch *	string	银行代码（机构代码）。	4
account_digit *	string	账户校验码	1
account_number *	string	账户号码。	20
owner_document_number *	string	账户持有人的 CPF 或 CNPJ（仅数字）。	14
owner_name *	string	账户持有人姓名。	50
account_type *	string	账户类型。	Enumerador account_type
ispb *	string	基于金融机构 CNPJ（8 位数字）。	8

Objeto refusal_reason

字段	类型	描述	字符数
bacen_code *	string	巴西中央银行拒绝代码	3
enumerator *	string	巴西中央银行拒绝枚举值	100
description *	string	巴西中央银行拒绝描述	100

Enumerador account_type

枚举值	翻译
checking_account	活期账户
deposit_account	存款账户
guaranteed_account	担保账户
investment_account	投资账户
payment_account	付款账户
saving_account	储蓄账户

接收 TED 后的 Webhook

Webhook 将通知 TED 交易的最终状态。

Webhook Request Body

Request Body: 已接收 TED

{
  "webhook_type": "baas.ted.incoming_ted",
  "webhook_datetime": "2021-10-22T20:30:23.459Z",
  "data": {
    "request_control_key": "6e290347-330d-4b3a-8ebb-2ac217ad6eb3",
    "ted_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
    "account_key": "fc6862c4-2b20-4057-8063-b8809866e494",
    "created_at": "2021-10-22T20:30:23.459Z",
    "ted_status": "received",
    "transaction_amount": 126.97,
    "fee_amount": 0.0,
    "source_account": {
      "account_branch": "0001",
      "account_digit": "6",
      "account_number": "78340",
      "ispb": "12345678",
      "owner_document_number": "32402502000135",
      "owner_name": "QI Tech"
    },
    "refusal_reason": {}
  }
}

Webhook Body Param

字段	类型	描述	最大字符数
webhook_type	string	定义正在报告的事件类型的枚举值	23
webhook_datetime	string	Webhook 发送的日期和时间	20
ted_key	string	TED 转账的唯一标识键	36
created_at	string	交易创建的日期和时间	100
ted_status	string	TED 交易状态	Enumerador ted_status
transaction_amount	number	转账金额	10
fee_amount	number	转账收取的费用金额	35
target_account	Object	目标账户 - 仅在"manual"类型的交易中发送	Objeto target_account
refusal_reason	Object	根据巴西中央银行标准的拒绝原因	Objeto refusal_reason

Enumerador ted_status

枚举值	描述
received	TED 转账成功完成。
pending	TED 转账待处理。
rejected	TED 转账已拒绝。

Objeto target_account

字段	类型	描述	字符数
account_branch *	string	银行代码（机构代码）。	10
account_digit *	string	账户校验码	10
account_number *	string	账户号码。	10
owner_document_number *	string	账户持有人的 CPF 或 CNPJ（仅数字）。	14
owner_name *	string	账户持有人姓名。	50
account_type *	string	账户类型。	Enumerador account_type
ispb *	string	基于金融机构 CNPJ（8 位数字）。	8

Objeto refusal_reason

字段	类型	描述	字符数
bacen_code *	string	巴西中央银行拒绝代码	3
enumerator *	string	巴西中央银行拒绝枚举值	100
description *	string	巴西中央银行拒绝描述	100

Enumerador account_type

枚举值	翻译
checking_account	活期账户
deposit_account	存款账户
guaranteed_account	担保账户
investment_account	投资账户
payment_account	付款账户
saving_account	储蓄账户