使用双因素身份验证执行 TED 批量交易

QI Tech 提供通过单次 API 调用执行多笔 TED 交易的功能。在此系统中，交易以异步方式执行。如果初始调用返回 http status 4xx，则不会执行任何交易。请求后，集成合作伙伴将为每笔交易收到一个 Webhook，告知尝试的最终状态，可能为 rejected 或 sent。

在此类交易中，需要通过发送给账户中具有批准转账权限的人员的令牌来确认付款。

配置为使用双因素身份验证的集成合作伙伴的 TED 批量交易请求方式与执行 TED 批量交易中描述的方式类似。区别在于添加了 tfa_info 对象，以及成功请求的状态将始终为 pending_2fa_approval。

令牌发送至批准人的通知事件为 baas.token_validation.ted.batch。可以自定义发送的消息。

请求

ENDPOINT

/account/ACCOUNT_KEY/ted_batch

方法

POST

Request Body

{
  "request_control_key": "6e4fc980-f8a1-4462-b6e2-d8a49f0ac055",
  "tfa_info": {
    "approver_document_number": "98765432100",
    "contact_type": "email"
  },
  "teds": [
    {
      "request_control_key": "0c3d2a3e-c121-464e-b5a4-8e69e0c17bbd",
      "target_account": {
        "account_branch": "0001","account_number": "92796","account_digit": "1",
        "owner_document_number": "23599885000192","owner_name": "Titular da Conta",
        "ispb": "12345678","account_type": "checking_account"
      },
      "transaction_amount": 8.86
    },
    {
      "request_control_key": "ff9f2a48-918c-4911-9371-a496e37dccfc",
      "target_account": {
        "account_branch": "0001","account_number": "92797","account_digit": "2",
        "owner_document_number": "23599885000192","owner_name": "Titular da Conta",
        "ispb": "12345678","account_type": "checking_account"
      },
      "transaction_amount": 10.00
    }
  ]
}

Path Params

字段	类型	描述	字符数
`account_key`	uuidv4	账户的唯一标识键。	36

Body Params

字段	类型	描述	字符数
`request_control_key` *	uuidv4	客户使用的 uuid v4 格式的请求唯一标识键。	36
`teds` *	array	与批次关联的 TED 对象列表。	列表 Objeto ted
`tfa_info` *	Object	包含账户批准人文件号和联系方式的对象。	Objeto tfa_info

Objeto tfa_info

字段	类型	描述
`approver_document_number` *	string	账户批准人的文件号。
`contact_type` *	string	与账户批准人的联系方式，可为 sms 或 email

Objeto ted

字段	类型	描述	字符数
`request_control_key` *	string	客户使用的 uuid v4 格式的请求唯一标识键。	36
`target_account` *	object	目标账户	Objeto target_account
`transaction_amount` *	float	转账金额	10

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

Enumerador account_type

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

响应

STATUS

202

Response Body: 已请求批量转账

{
  "request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
  "ted_batch_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
  "ted_batch_status": "pending_2fa_approval"
}

Enumerador ted_batch_status

枚举值	描述
approved	批量转账已批准，交易正在执行中。
rejected	批量转账已拒绝
pending_2fa_approval	批量调度待双因素身份验证批准
cancelled	批量转账已取消

STATUS

4xx

Response Body: 已拒绝转账

{
  "title": "titulo",
  "description": "description in English",
  "translation": "descrição em portugues",
  "code": "codigo",
  "extra_fields": {
    "ted_batch_data": {
      "request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
      "ted_batch_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
      "ted_batch_status": "rejected"
    }
  }
}

信息

此端点也可能返回 TED 批量交易中列出的错误，以及以下错误。

HTTP 状态码 `status`	QI 代码 `code`	标题 `title`	描述（英文） `description`	描述（葡文） `translation`
400	TED000079	No approver permission	Given document number does not belong to an approver for this account	Número de documento enviado não pertence a um aprovador da conta
400	TED000080	tfa_info is required	Client must send object tfa_info	Cliente deve enviar objeto tfa_info
400	TED000081	Error occurred while sending token	An unexpected error occurred while sending token	Um erro inexperado ocorreu ao tentar enviar token

请求​

Path Params​

Body Params​

Objeto tfa_info​

Objeto ted​

Objeto target_account​

Enumerador account_type​

响应​

Enumerador ted_batch_status​

请求