Remove boletos from an ownership exchange batch

This endpoint is used to remove boletos from a boleto ownership exchange batch with status open.

Request

ENDPOINT

/account/ACCOUNT-KEY/requester_profile/REQUESTER-PROFILE-KEY/bank_slip_ownership_exchange_batch/BANK-SLIP-OWNERSHIP-EXCHANGE-BATCH-KEY/remove

METHOD

PATCH

Path parameters

Field	Type	Description	Characters
ACCOUNT-KEY	uuidv4	Unique identification key of the origin account, where the boletos were originally registered.	36
REQUESTER-PROFILE-KEY	uuidv4	Unique identification key of the origin billing profile, where the boletos were originally registered.	36
BANK-SLIP-OWNERSHIP-EXCHANGE-BATCH-KEY	uuidv4	Unique identification key of the ownership exchange batch.	36

Request Body

{
	"bank_slips": [
		"b21c5b5a-a71f-4672-9254-022401cd15f6",
		"8197e3d0-1500-439f-9f9d-d243115542fa",
		"8293b817-bed9-418a-8c1e-ec8ef5a31468"
	]
}

Attention!

The list of boletos informed in the bank_slips object in the payload has a limitation of 10,000 boletos per request.

Response

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": "open",
    "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": 0,
    "total_amount": 0
}

Response Params

Field	Type	Description	Characters
bank_slip_ownership_exchange_batch_key	uuidv4	Unique identification key of the ownership exchange batch.	36
request_control_key	uuidv4	Unique identification key of the request to this endpoint. Used to prevent duplication in API calls.	36
bank_slip_ownership_exchange_batch_status	enum	Status of the ownership exchange batch.	Enumerators bank_slip_ownership_exchange_batch_status
new_requester_profile_key	uuidv4	Unique identification key of the destination billing profile. It is the billing profile to which the boletos will be transferred. You can obtain this key through the endpoint for querying billing profiles of an account	36
new_requester_profile_code	string	Code of the destination billing profile. It is the billing profile to which the boletos will be transferred.	19
new_requester_profile_owner_name	string	Name of the destination account holder and beneficiary of the destination billing profile.	255
new_requester_profile_owner_document_number	string	Document number (CPF/CNPJ) of the destination account holder and beneficiary of the destination billing profile.	255
new_requester_profile_account_number	string	Destination account number for the ownership exchange.	7
new_requester_profile_account_digit	string	Check digit of the destination account for the ownership exchange.	1
new_requester_profile_account_branch	string	Branch number of the destination account for the ownership exchange.	4
new_pix_key	string	PIX key of the destination account for the ownership exchange (for bolepix cases).	255
total_bank_slip_count	float	Total number of boletos in the ownership exchange batch.	-
total_amount	float	Sum of the face value of boletos in the ownership exchange batch.	-

Enumerators bank_slip_ownership_exchange_batch_status

Enumerator	Description
open	The batch was created and is still open for inclusion/exclusion of boletos.
sent	The boleto selection has been completed and the ownership exchange batch is pending approval. The approving party needs to perform the approval
processing	The boleto selection has been completed and the ownership exchange of boletos contained in the batch is being processed.
approved	The boletos contained in the batch have already been transferred to the recipient
cancelled	Ownership exchange batch cancelled.
rejected	Ownership exchange batch rejected.