跳到主要内容

取消票据 tombamento 批次

请求​

ENDPOINT
/bank_slip/account/ACCOUNT-KEY/requester_profile/REQUESTER-PROFILE-KEY/bank_slip_ownership_exchange_batch/BANK-SLIP-OWNERSHIP-EXCHANGE-BATCH-KEY/cancel
MÉTODO
PATCH

路径参数​

字段类型描述字符数
ACCOUNT-KEYuuidv4原始账户的唯一识别键，即票据最初登记的账户。36
REQUESTER-PROFILE-KEYuuidv4原始托收钱包的唯一识别键，即票据最初登记的托收钱包。36
BANK-SLIP-OWNERSHIP-EXCHANGE-BATCH-KEYuuidv4tombamento 批次的唯一识别键。36
Request Body
{}

响应​

STATUS
200
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": "canceled",
    "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",
    "new_pix_key": "2376da91-86ad-4a0b-a466-f0f5acf53e24",
    "total_bank_slip_count": 3,
    "total_amount": 750.00
}

响应参数​

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

枚举器 bank_slip_ownership_exchange_batch_status​

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