Open bank slip ownership exchange batch

This endpoint will create a bank slip ownership exchange batch. The batch is created without any bank slips, and the bank slips will need to be inserted through the bank slip inclusion endpoint.

Request

ENDPOINT

/account/ACCOUNT-KEY/requester_profile/REQUESTER-PROFILE-KEY/bank_slip_ownership_exchange_batch/stream

METHOD

POST

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

Request Body - Billing portfolio UUID key

{
	"request_control_key": "66c9399a-1463-4e2b-acc0-7ee447f81bf0",
	"new_requester_profile_key": "e494067f-5bd4-4819-b64f-0687bd217f45",
	"new_pix_key": "2376da91-86ad-4a0b-a466-f0f5acf53e24"
}

Request Body - Billing portfolio code

{
	"request_control_key": "66c9399a-1463-4e2b-acc0-7ee447f81bf0",
	"new_requester_profile_code": "329-09-0001-1234567",
	"new_pix_key": "2376da91-86ad-4a0b-a466-f0f5acf53e24"
}

Bank slip billing portfolio code

The Billing Portfolio Code is a string that follows the following pattern:

[ Bank Number ] + [ Portfolio Code ] + [ Account Branch Number ] + [ Account Number with 7 characters and without check digit ]

By default, at QI Tech, the Bank Number, Portfolio Code and Branch will always be 329, 09 and 0001, respectively.

Therefore, the Billing Portfolio Code for account 5308318-3 will be: 329-09-0001-5308318.

Body Params

Field	Type	Description	Characters
request_control_key	uuidv4	Unique identification key of the request on this endpoint. Used to avoid duplication in the API call.	36
new_requester_profile_key	uuidv4	Unique identification key of the destination billing portfolio. It's the billing portfolio where the bank slips will be transferred. You can obtain this key through the account billing portfolios query endpoint	36
new_requester_profile_code	string	Destination billing portfolio code. It's the billing portfolio where the bank slips will be transferred.	19
new_pix_key	string	PIX key of the destination account for the ownership exchange (for bolepix cases).	255

Response

STATUS

202

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 on this endpoint. Used to avoid duplication in the API call.	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. It's the billing portfolio where the bank slips will be transferred. You can obtain this key through the account billing portfolios query endpoint	36
new_requester_profile_code	string	Destination billing portfolio code. It's 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 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 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 bank slip inclusion/exclusion.
sent	Bank slip selection has been completed and the ownership exchange batch is pending approval. The approving party needs to perform the approval
processing	Bank slip selection has been completed and the ownership exchange of bank slips contained in the batch is being processed.
approved	Bank slips contained in the batch have already been transferred to the recipient
cancelled	Ownership exchange batch cancelled.
rejected	Ownership exchange batch rejected.