创建票据 tombamento 批次

请求

ENDPOINT

/bank_slip/account/ACCOUNT-KEY/requester_profile/REQUESTER-PROFILE-KEY/bank_slip_ownership_exchange_batch

MÉTODO

POST

路径参数

字段	类型	描述	字符数
ACCOUNT-KEY	uuidv4	原始账户的唯一识别键，即票据最初登记的账户。	36
REQUESTER-PROFILE-KEY	uuidv4	原始托收钱包的唯一识别键，即票据最初登记的托收钱包。	36

Request Body - 托收钱包键

{
	"bank_slips": [
		"b21c5b5a-a71f-4672-9254-022401cd15f6",
		"8197e3d0-1500-439f-9f9d-d243115542fa",
		"8293b817-bed9-418a-8c1e-ec8ef5a31468"
	],
	"request_control_key": "66c9399a-1463-4e2b-acc0-7ee447f81bf0",
	"new_requester_profile_key": "e494067f-5bd4-4819-b64f-0687bd217f45",
	"new_pix_key": "2376da91-86ad-4a0b-a466-f0f5acf53e24"
}

Request Body - 托收钱包代码

{
	"bank_slips": [
		"b21c5b5a-a71f-4672-9254-022401cd15f6",
		"8197e3d0-1500-439f-9f9d-d243115542fa",
		"8293b817-bed9-418a-8c1e-ec8ef5a31468"
	],
	"request_control_key": "66c9399a-1463-4e2b-acc0-7ee447f81bf0",
	"new_requester_profile_code": "329-09-0001-1234567",
	"new_pix_key": "2376da91-86ad-4a0b-a466-f0f5acf53e24"
}

Body 参数

字段	类型	描述	字符数
bank_slips	list	将纳入 tombamento 批次的票据列表。	36
request_control_key	uuidv4	此端点请求的唯一识别键。用于避免 API 调用重复。	36
new_requester_profile_key	uuidv4	目标托收钱包的唯一识别键，即票据将被转移（tombados）到的托收钱包。可通过账户托收钱包查询端点获取此键。	36
new_requester_profile_code	string	目标托收钱包代码，即票据将被转移（tombados）到的托收钱包。	19
new_pix_key	uuidv4	tombamento 目标账户的 Pix 密钥（BolePix 情况下使用）。	36

注意！

批次创建 payload 中 bank_slips 对象的票据列表，每次请求限制为 10,000 个票据。

票据托收钱包代码

托收钱包代码是遵循以下模式的字符串：

[ 银行编号 ] + [ 钱包代码 ] + [ 账户支行号 ] + [ 7位不含校验位的账户号 ]

在 QI Tech，银行编号、钱包代码和支行号始终分别为 329、09 和 0001。

因此，账户号 5308318-3 的托收钱包代码为：329-09-0001-5308318。

响应

STATUS

201 Created

Response Body

{
    "bank_slip_ownership_exchange_batch_key": "243c9369-ce8b-49df-969c-d891c2fc8c21",
    "request_control_key": "66c9399a-1463-4e2b-acc0-7ee447f81bf0",
    "bank_slip_ownership_exchange_batch_status": "closed",
    "bank_slips": [
        "b21c5b5a-a71f-4672-9254-022401cd15f6",
        "8197e3d0-1500-439f-9f9d-d243115542fa",
        "8293b817-bed9-418a-8c1e-ec8ef5a31468"
    ],
    "new_requester_profile_key": "e494067f-5bd4-4819-b64f-0687bd217f45",
    "new_requester_profile_code": "329-09-0001-8703524",
    "new_requester_profile_owner_name": "Fulano de Tal",
    "new_requester_profile_owner_document_number": "70896538000101",
    "new_requester_profile_account_number": "8703524",
    "new_requester_profile_account_digit": "1",
    "new_requester_profile_account_branch": "0001",
    "pix_key": "2376da91-86ad-4a0b-a466-f0f5acf53e24",
    "total_bank_slip_count": 40,
    "total_amount": 67245.96
}

响应参数

字段	类型	描述	字符数
bank_slip_ownership_exchange_batch_key	uuidv4	tombamento 批次的唯一识别键。	36
request_control_key	uuidv4	此端点请求的唯一识别键。用于避免 API 调用重复。	36
bank_slip_ownership_exchange_batch_status	enum	tombamento 批次的状态。	枚举器 bank_slip_ownership_exchange_batch_status
bank_slips	list	将纳入 tombamento 批次的票据列表。	36
new_requester_profile_key	uuidv4	目标托收钱包的唯一识别键，即票据将被转移（tombados）到的托收钱包。可通过账户托收钱包查询端点获取此键。	36
new_requester_profile_code	string	目标托收钱包代码，即票据将被转移（tombados）到的托收钱包。	19
new_requester_profile_owner_name	string	目标账户持有人及目标托收钱包受益人的姓名。	255
new_requester_profile_owner_document_number	string	目标账户持有人及目标托收钱包受益人的证件号（CPF/CNPJ）。	255
new_requester_profile_account_number	string	tombamento 目标账户号。	7
new_requester_profile_account_digit	string	tombamento 目标账户校验位。	1
new_requester_profile_account_branch	string	tombamento 目标账户支行号。	4
new_pix_key	string	tombamento 目标账户的 Pix 密钥（BolePix 情况下使用）。	255
total_bank_slip_count	float	tombamento 批次中的票据总数。	-
total_amount	float	tombamento 批次中票据面值总和。	-

枚举器 bank_slip_ownership_exchange_batch_status

枚举器	描述
open	批次已创建，仍开放以纳入/删除票据。
closed	批次已关闭，批次中票据的 tombamento 已完成。
processing	票据选择已完成，批次中票据的 tombamento 正在处理中。
canceled	tombamento 批次已取消。
rejected	tombamento 批次已拒绝。