Include bank slips in an ownership exchange batch

This endpoint is used to include bank slips in a bank slip ownership exchange batch.

Request

ENDPOINT

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

METHOD

PATCH

Path parameters

Field	Type	Description	Characters
ACCOUNT-KEY	uuidv4	Unique identification key for the source account where the bank slips were originally registered.	36
REQUESTER-PROFILE-KEY	uuidv4	Unique identification key for the source billing portfolio where the bank slips were originally registered.	36
BANK-SLIP-OWNERSHIP-EXCHANGE-BATCH-KEY	uuidv4	Unique identification key for the ownership exchange batch.	36

Request Body

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

Warning!

The list of bank slips provided in the bank_slips object in the payload has a limitation of 10,000 bank slips 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": 3,
    "total_amount": 750.00
}

Response Params

Field	Type	Description	Characters
bank_slip_ownership_exchange_batch_key	uuidv4	Unique identification key for the ownership exchange batch.	36
request_control_key	uuidv4	Unique identification key for the request to this endpoint. Used to avoid 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 for the destination billing portfolio. This is the billing portfolio where the bank slips will be transferred. You can obtain this key through the endpoint for querying billing portfolios of an account	36
new_requester_profile_code	string	Code for the destination billing portfolio. This is the billing portfolio where the bank slips will be transferred.	19
new_requester_profile_owner_name	string	Name of the destination account holder and beneficiary of the destination billing portfolio.	255
new_requester_profile_owner_document_number	string	Document number (CPF/CNPJ) of the destination account holder and beneficiary of the destination billing portfolio.	255
new_requester_profile_account_number	string	Destination account number for the ownership exchange.	7
new_requester_profile_account_digit	string	Check digit for the destination account of the ownership exchange.	1
new_requester_profile_account_branch	string	Branch number for the destination account of the ownership exchange.	4
new_pix_key	string	PIX key for the destination account of the ownership exchange (for PIX bank slip cases).	255
total_bank_slip_count	float	Total number of bank slips in the ownership exchange batch.	-
total_amount	float	Sum of the face value of the bank slips 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 bank slips.
sent	The bank slip selection was completed and the ownership exchange batch is pending approval. The approving party needs to perform the approval
processing	The bank slip selection was completed and the ownership exchange of the bank slips contained in the batch is being processed.
approved	The bank slips contained in the batch have already been transferred to the recipient
cancelled	Ownership exchange batch cancelled.
rejected	Ownership exchange batch rejected.