跳到主要内容

列出票据 tombamento 批次 - 目标方

使用此端点从目标账户列出票据 tombamento 批次——即票据被转移到的账户。

请求​

ENDPOINT
/account/ACCOUNT_KEY/requester_profile/REQUESTER_PROFILE_KEY/bank_slip_ownership_exchange_batches/incoming
MÉTODO
GET

路径参数​

字段类型描述字符数
account_keyuuidv4目标账户的唯一识别键，即票据将被转移到的账户。36
requester_profile_keyuuidv4目标托收钱包的唯一识别键，即票据将被转移到的托收钱包。36

查询参数​

字段描述
page_number当前查询的页码
page_size每页结果数量

响应​

STATUS
200
Response Body
{
	"data": [
        {
            "bank_slip_exchange_batch_key": "186e73f1-456f-4265-8cb0-b32722041580",
            "request_control_key": "fa7fa38c-0356-4345-98ef-21a089d9a39a",
            "bank_slip_ownership_exchange_batch_status": "processing",
            "old_requester_profile_key": "01a30518-0b2e-4dd1-a105-8f8bf31868a2",
            "old_requester_profile_code": "329-09-0001-5963550",
            "old_requester_profile_owner_document_number": "02602536000102",
            "old_requester_profile_owner_name": "Coca Cola",
            "old_requester_profile_account_number": "5963550",
            "old_requester_profile_account_digit": "7",
            "old_requester_profile_account_branch": "0001",
            "old_pix_key": "2376da91-86ad-4a0b-a466-f0f5acf53e24",
            "total_bank_slip_count": 200,
            "total_amount": 38145.58
        },
        {
            "bank_slip_exchange_batch_key": "8a5bbded-72ff-4642-8830-f2a5a73eb62c",
            "request_control_key": "d3725802-7e56-4196-8182-2747ea18e96a",
            "bank_slip_ownership_exchange_batch_status": "open",
            "old_requester_profile_key": "316052e8-a017-4fb9-9939-9ce0390fa053",
            "old_requester_profile_code": "329-09-0001-4743630",
            "old_requester_profile_owner_document_number": "40500359000142",
            "old_requester_profile_owner_name": "QI SCD",
            "old_requester_profile_account_number": "4743630",
            "old_requester_profile_account_digit": "1",
            "old_requester_profile_account_branch": "0001",
            "old_pix_key": "2376da91-86ad-4a0b-a466-f0f5acf53e24",
            "total_bank_slip_count": 450,
            "total_amount": 548682.19
        },
        {
            "bank_slip_exchange_batch_key": "6f749806-8768-44ab-b7de-1f0d94d0a61a",
            "request_control_key": "1c1551f2-c6e7-42d5-b78d-1f7662128a33",
            "bank_slip_ownership_exchange_batch_status": "closed",
            "old_requester_profile_key": "8bfdd50f-97fd-4f29-bc53-b542a914f2d6",
            "old_requester_profile_code": "329-09-0001-7390371",
            "old_requester_profile_owner_document_number": "56000040000198",
            "old_requester_profile_name": "Meta",
            "old_requester_profile_account_number": "7390371",
            "old_requester_profile_account_digit": "7",
            "old_requester_profile_account_branch": "0001",
            "old_pix_key": "2376da91-86ad-4a0b-a466-f0f5acf53e24",
            "total_bank_slip_count": 40,
            "total_amount": 67245.96
        }
	],
	"pagination": {
		"current_page": 1,
		"rows_per_page": 100
	}
}

响应参数​

字段类型描述字符数
bank_slip_ownership_exchange_batch_keyuuidv4tombamento 批次的唯一识别键。36
request_control_keyuuidv4此端点请求的唯一识别键。用于避免 API 调用重复。36
bank_slip_ownership_exchange_batch_statusenumtombamento 批次的状态。枚举器 bank_slip_ownership_exchange_batch_status
old_requester_profile_keyuuidv4目标托收钱包的唯一识别键，即票据将被转移到的托收钱包。可通过账户托收钱包查询端点获取此键。36
old_requester_profile_codestring目标托收钱包代码，即票据将被转移到的托收钱包。19
old_requester_profile_owner_namestring目标账户持有人及目标托收钱包受益人的姓名。255
old_requester_profile_owner_document_numberstring目标账户持有人及目标托收钱包受益人的证件号（CPF/CNPJ）。255
old_requester_profile_account_numberstringtombamento 目标账户号。7
old_requester_profile_account_digitstringtombamento 目标账户校验位。1
old_requester_profile_account_branchstringtombamento 目标账户支行号。4
old_pix_keystringtombamento 目标账户的 Pix 密钥（BolePix 情况下使用）。255
total_bank_slip_countfloattombamento 批次中的票据总数。-
total_amountfloattombamento 批次中票据面值总和。-

枚举器 bank_slip_ownership_exchange_batch_status​

枚举器描述
open批次已创建，仍开放以纳入/删除票据。
sent票据选择已完成，tombamento 批次待批准。批准方需完成批准操作。
processing票据选择已完成，批次中票据的 tombamento 正在处理中。
approved批次中的票据已完成 tombamento 转移给目标方。
cancelledtombamento 批次已取消。
rejectedtombamento 批次已拒绝。