Create bank slip ownership exchange batch

Request

ENDPOINT

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

METHOD

POST

Path parameters

Field	Type	Description	Characters
ACCOUNT-KEY	uuidv4	Unique identification key of the source account where the bank slips were originally registered.	36
REQUESTER-PROFILE-KEY	uuidv4	Unique identification key of the source billing profile where the bank slips were originally registered.	36

Request Body - Billing profile key

{
	"bank_slips": [
		"b21c5b5a-a71f-4672-9254-022401cd15f6",
		"8197e3d0-1500-439f-9f9d-d243115542fa",
		"8293b817-bed9-418a-8c1e-ec8ef5a31468"
	],
	"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 profile code

{
	"bank_slips": [
		"b21c5b5a-a71f-4672-9254-022401cd15f6",
		"8197e3d0-1500-439f-9f9d-d243115542fa",
		"8293b817-bed9-418a-8c1e-ec8ef5a31468"
	],
	"request_control_key": "66c9399a-1463-4e2b-acc0-7ee447f81bf0",
	"new_requester_profile_code": "329-09-0001-1234567",
	"new_pix_key": "2376da91-86ad-4a0b-a466-f0f5acf53e24"
}

Body Params

Field	Type	Description	Characters
bank_slips	list	List of bank slips that will be included in the ownership exchange batch.	36
request_control_key	uuidv4	Unique request identification key for this endpoint. Used to avoid request duplication via API.	36
new_requester_profile_key	uuidv4	Unique identification key of the destination billing profile. This is the billing profile where the bank slips will be transferred to. You can obtain this key through the account billing profiles query endpoint	36
new_requester_profile_code	string	Destination billing profile code. This is the billing profile where the bank slips will be transferred to.	19
new_pix_key	uuidv4	PIX key of the ownership exchange destination account (for bolepix cases).	36

Attention!

The list of bank slips informed in the bank_slips object in the batch creation payload has a limitation of 10,000 bank slips per request.

Bank Slip Billing Profile Code

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

[ Bank Number ] + [ Profile Code ] + [ Account Branch Number ] + [ Account Number with 7 characters and no verification digit ]

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

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

Response

STATUS

201 Created

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": "closed",
    "bank_slips": [
        "b21c5b5a-a71f-4672-9254-022401cd15f6",
        "8197e3d0-1500-439f-9f9d-d243115542fa",
        "8293b817-bed9-418a-8c1e-ec8ef5a31468"
    ],
    "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",
    "pix_key": "2376da91-86ad-4a0b-a466-f0f5acf53e24",
    "total_bank_slip_count": 40,
    "total_amount": 67245.96
}

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 request identification key for this endpoint. Used to avoid request duplication via API.	36
bank_slip_ownership_exchange_batch_status	enum	Status of the ownership exchange batch.	Enumerators bank_slip_ownership_exchange_batch_status
bank_slips	list	List of bank slips that will be included in the ownership exchange batch.	36
new_requester_profile_key	uuidv4	Unique identification key of the destination billing profile. This is the billing profile where the bank slips will be transferred to. You can obtain this key through the account billing profiles query endpoint	36
new_requester_profile_code	string	Destination billing profile code. This is the billing profile 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 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	Verification 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 ownership exchange destination account (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 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	Bank slip selection has been completed and the ownership exchange of the bank slips contained in the batch is being processed.
canceled	Ownership exchange batch canceled.
rejected	Ownership exchange batch rejected.