银行票据批量支付令牌校验
该端点用于完成银行票据批量的双重验证(2FA)步骤。该批次在 含 tfa_info 的批次确认 后会处于 batch_status pending_2fa_approval(批准)或 pending_2fa_rejection(拒绝)。令牌校验通过后,批次进入异步处理,最终状态反映确认阶段记录的决策(approved 或 rejected)。如需在等待状态重发令牌,请使用 重发银行票据批量确认令牌。
银行票据
这是传统银行票据(可输入行不以数字 8 开头)。其已在银行间清算系统(CIP/Núclea)登记,可在经央行授权的金融机构和支付机构缴付。
请求
请求 Endpoint
ENDPOINT
/bill_payment/account/ACCOUNT_KEY/payment/batch_bank_slip/PAYMENT_BATCH_KEY/validate_token方法
PATCH请求 Path Params
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
account_key * | uuid4 | 账户唯一标识键。 | 36 |
payment_batch_key * | uuid4 | 批次唯一标识键(创建批次时返回的 batch_payment_key)。 | 36 |
通过 Email 和 SMS 认证
请求体:批次 token 校验
{
"token": "329adf"
}
通过设备认证
要通过设备完成认证,请发送空请求体。校验在服务端内部执行,无需额外请求体字段。仅当批次在 含 tfa_info 的批次确认 后进入 pending_2fa_approval(批准)或 pending_2fa_rejection(拒绝)时,才应调用该端点。
请求体:批次 token 校验
{
}
Body 参数
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
token | string | 发送给账户交易审批人的认证码,SMS 或 Email 方式的 TFA 必填 | 6 |
响应
成功响应
校验成功后,API 返回 202,批次进入异步处理。最终状态遵循确认步骤记录的决策(approved 或 rejected)。
STATUS
202响应体:token 校验后的批次(approved 示例)
{
"batch_payment_key": "a3214093-e51c-55e2-b5d3-60244475b3fb",
"request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
"account_key": "6dc89d57-fac7-4643-b151-cd2ca0a7f68f",
"total_amount": 1357.3,
"batch_status": "approved",
"payment_type": "bank_slip"
}
响应 Body Params
| 字段 | 类型 | 描述 |
|---|---|---|
batch_payment_key * | uuid4 | 批量支付唯一标识键。 |
request_control_key * | uuid4 | 客户端请求唯一标识键(批次)。 |
account_key * | uuid4 | 扣款账户键。 |
total_amount * | number | 批次内所有项目金额之和。 |
batch_status * | string | token 校验后,最终状态反映确认步骤记录的决策(approved 或 rejected)。batch_status 生命周期遵循该业务配置的批量支付申请文档(枚举 batch_payment_status)。 |
payment_type * | string | 支付类型;该流程应为 bank_slip。 |
错误响应
STATUS
4XXResponse Body
{
"title": "标题",
"description": "Description in english",
"translation": "描述 em português",
"code": "代码"
}
| HTTP 代码 | QI 代码 | 标题 | 描述 (eng) | 描述 (pt-br) |
|---|---|---|---|---|
| 403 | BIP000010 | Forbidden | User is not allowed to do this action | 用户无权限执行此操作 |
| 404 | BIP000011 | Not Found | The source account key was not found. | 未找到源账户 key。 |
| 400 | BIP000013 | Bad Request | The source account is closed. | 源账户已关闭。 |
| 400 | BIP000050 | Bad Request | Requester configuration does not exist | 请求方配置不存在。 |
| 400 | BIP000058 | Bad Request | Error while validating verification token | 校验 token 时出错 |
| 400 | BIP000059 | Bad Request | Number of verification token validation attempts exceeded. | 验证码校验尝试次数超限。 |
| 400 | BIP000060 | Bad Request | Verification token expired. | 校验 token 已过期。 |
| 400 | BIP000061 | Bad Request | Verification token validation failed. | 校验 token 验证失败。 |
| 400 | BIP000065 | Bad Request | Payment verification time window exceeded. | 支付校验时间窗口已超限。 |
| 404 | BIP000083 | Not Found | Batch payment not found by batch payment key. | 未通过批次 key 找到批量支付。 |
| 400 | BIP000085 | Bad Request | Batch payment status is not pending approval. | 批量支付状态不是待批准。 |
| 400 | BIP000086 | Bad Request | A token is required for SMS or email validation. | SMS 或 Email 校验必须提供 token。 |