Send bank slip ownership exchange batch

This endpoint is used to close the batch and start processing the ownership transfer. When making the request, the batch will be validated and the status changed to sent, where both parties involved will receive a webhook related to the ownership exchange.

Attention!

This endpoint should only be triggered when the insertion of bank slips is completed and the proper formalizations between the origin and destination counterparts of the ownership exchange are concluded.

Request

ENDPOINT

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

METHOD

PATCH

Path parameters

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

Request Body

{}

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": "processing",
    "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 of the ownership exchange batch.	36
request_control_key	uuidv4	Unique identification key of the request in this endpoint. Used to avoid duplicity 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 portfolio. This is the billing portfolio where the bank slips will be transferred to. You can obtain this key through the billing portfolio query endpoint for an account	36
new_requester_profile_code	string	Code of the destination billing portfolio. This is the billing portfolio where the bank slips will be transferred to.	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 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 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.
closed	The batch is closed and the ownership exchange of the bank slips contained in the batch has been completed.
processing	The selection of bank slips has been completed and the ownership exchange of the bank slips contained in the batch is being processed.
pending_approval	The selection of bank slips has been completed and the ownership exchange batch is pending approval. The approving party can remove bank slips from the batch.
canceled	Ownership exchange batch canceled.
rejected	Ownership exchange batch rejected.