TED 调度完成 Webhook

TED 调度完成后，将向集成合作伙伴发送包含结果的 Webhook。

注意！

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

Webhook Request Body

Request Body: 调度已完成并发送

{
  "webhook_type": "baas.ted.ted_schedule.completed",
  "webhook_datetime": "2021-10-22T20:30:23.459Z",
  "data": {
    "request_control_key": "b8eb663e-10fe-4729-9db5-8f8c93de5001",
    "schedule_key": "0c9091ab-079b-4a43-8b3d-d4ba36a23883",
    "schedule_batch_key": null,
    "schedule_status": "sent",
    "target_account": {
      "account_branch": "0001","account_digit": "8","account_number": "1234567",
      "owner_document_number": "***91111***","owner_person_type": "natural",
      "owner_name": "Conta manual geral","account_type": "checking_account","ispb": "99999004"
    },
    "transaction_amount": 2.0,
    "rejection_info": null,
    "schedule_date": "2024-07-10",
    "updated_at": "2024-07-10T16:19:38Z",
    "created_at": "2024-06-10T11:17:28Z",
    "schedule_transfers": [{"request_control_key": "12723821-41d5-496b-b66c-fb7188f50fc1","ted_key": "91028dfa-43a2-4665-adf2-0bd4571f6f0d","created_at": "2024-07-10T16:19:38Z","ted_status": "sent","fee_amount": 2.00}]
  }
}

Request Body: 调度已完成并拒绝

{
  "webhook_type": "baas.ted.ted_schedule.completed",
  "webhook_datetime": "2021-10-22T20:30:23.459Z",
  "data": {
    "request_control_key": "b8eb663e-10fe-4729-9db5-8f8c93de5001",
    "schedule_key": "0c9091ab-079b-4a43-8b3d-d4ba36a23883",
    "schedule_batch_key": null,
    "schedule_status": "sent",
    "target_account": {
      "account_branch": "0001","account_digit": "8","account_number": "1234567",
      "owner_document_number": "***91111***","owner_person_type": "natural",
      "owner_name": "Conta manual geral","account_type": "checking_account","ispb": "99999004"
    },
    "transaction_amount": 2.0,
    "rejection_info": {
      "error_code": "TED000103","error_description": "The maximum number of failed transfer attempts has been reached",
      "error_translation": "Número máximo de tentativas de transferência foi atingida","rejection_reason": "max_tries_exceeded"
    },
    "schedule_date": "2024-07-10","updated_at": "2024-07-10T16:19:38Z","created_at": "2024-06-10T11:17:28Z",
    "schedule_transfers": [
      {"ted_key": "907e38c5-5700-492f-a181-8f651317458b","created_at": "2024-07-10T16:19:38Z","ted_status": "rejected","fee_amount": 2.00},
      {"ted_key": "356f8855-8f8d-4aaa-8e8c-1287e363d143","created_at": "2024-07-10T17:19:38Z","ted_status": "rejected","fee_amount": 2.00},
      {"ted_key": "c51cc7ee-d966-4bbb-8405-4850b90b43f8","created_at": "2024-07-10T18:19:38Z","ted_status": "rejected","fee_amount": 2.00}
    ]
  }
}

Webhook Body Param

字段	类型	描述	最大字符数
webhook_type	string	定义正在报告的事件类型的枚举值	23
webhook_datetime	string	Webhook 发送的日期和时间	20
request_control_key	uuidv4	客户使用的 uuid v4 格式的请求唯一标识键。	36
schedule_key	string	调度的唯一标识键	36
schedule_batch_key	string	批量调度的唯一标识键	36
schedule_status	string	调度状态	Enumerador schedule_status
target_account	object	调度的目标账户	Objeto target_account
transaction_amount	number	转账金额	10
schedule_transfers	array	调度执行的转账尝试列表	列表 Objeto schedule_transfer
schedule_date	string	执行交易的日期。	10
rejection_info	object	包含拒绝事件信息的对象
updated_at	string	调度最后更新的日期和时间。	20
created_at	string	调度创建的日期和时间。	20

Ted Schedule 状态

枚举值	描述
scheduled	交易已调度
sent	调度已完成并成功发送。最终状态
rejected	调度在创建或执行过程中被拒绝。最终状态
cancelled	应客户请求取消调度。最终状态
pending_2fa_approval	待双因素身份验证批准
waiting_batch_approval	调度已创建并与待双因素身份验证批准的批次关联

Objeto Schedule Transfer

字段	类型	描述	字符数
ted_key	uuidv4	QI 系统中 TED 转账的唯一标识键。	36
ted_status	string	交易状态。	Enumeradores ted_status
fee_amount	number	转账金额	10
created_at	string	交易创建的日期和时间	20

Enumerador Ted Status

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

Objeto target_account

字段	类型	描述	字符数
account_branch	string	账户银行代码	6
account_digit	string	账户校验码	1
account_number	string	账户号码	20
owner_document_number	string	账户持有人的 CPF 或 CNPJ（仅数字）	14
owner_name	string	账户持有人姓名	150
owner_person_type	enumerator	账户持有人是个人还是法人的标识符	Enumerador owner_person_type
account_type	enumerator	账户类型	Enumerador account_type
ispb	string	8 位数字，用于标识巴西中央银行储备转账系统中的银行	8

Enumerador owner_person_type

枚举值	描述
natural	个人
legal	法人

Enumerador account_type

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