List bank slip ownership exchange batches - destination

Use this endpoint to list bank slip ownership exchange batches from the destination account — that is, the account to which the bank slips were transferred.

Request

ENDPOINT

/account/ACCOUNT_KEY/requester_profile/REQUESTER_PROFILE_KEY/bank_slip_ownership_exchange_batches/incoming

METHOD

GET

Path parameters

Field	Type	Description	Characters
`account_key`	uuidv4	Unique identification key of the destination account, to which the bank slips will be transferred.	36
`requester_profile_key`	uuidv4	Unique identification key of the destination collection portfolio, to which the bank slips will be transferred.	36

Query parameters

Field	Description
`page_number`	Current page being queried
`page_size`	Number of results per page

Response

STATUS

200

Response Body

{
	"data": [
        {
            "bank_slip_exchange_batch_key": "186e73f1-456f-4265-8cb0-b32722041580",
            "request_control_key": "fa7fa38c-0356-4345-98ef-21a089d9a39a",
            "bank_slip_ownership_exchange_batch_status": "processing",
            "old_requester_profile_key": "01a30518-0b2e-4dd1-a105-8f8bf31868a2",
            "old_requester_profile_code": "329-09-0001-5963550",
            "old_requester_profile_owner_document_number": "02602536000102",
            "old_requester_profile_owner_name": "Coca Cola",
            "old_requester_profile_account_number": "5963550",
            "old_requester_profile_account_digit": "7",
            "old_requester_profile_account_branch": "0001",
            "old_pix_key": "2376da91-86ad-4a0b-a466-f0f5acf53e24",
            "total_bank_slip_count": 200,
            "total_amount": 38145.58
        },
        {
            "bank_slip_exchange_batch_key": "8a5bbded-72ff-4642-8830-f2a5a73eb62c",
            "request_control_key": "d3725802-7e56-4196-8182-2747ea18e96a",
            "bank_slip_ownership_exchange_batch_status": "open",
            "old_requester_profile_key": "316052e8-a017-4fb9-9939-9ce0390fa053",
            "old_requester_profile_code": "329-09-0001-4743630",
            "old_requester_profile_owner_document_number": "40500359000142",
            "old_requester_profile_owner_name": "QI SCD",
            "old_requester_profile_account_number": "4743630",
            "old_requester_profile_account_digit": "1",
            "old_requester_profile_account_branch": "0001",
            "old_pix_key": "2376da91-86ad-4a0b-a466-f0f5acf53e24",
            "total_bank_slip_count": 450,
            "total_amount": 548682.19
        },
        {
            "bank_slip_exchange_batch_key": "6f749806-8768-44ab-b7de-1f0d94d0a61a",
            "request_control_key": "1c1551f2-c6e7-42d5-b78d-1f7662128a33",
            "bank_slip_ownership_exchange_batch_status": "closed",
            "old_requester_profile_key": "8bfdd50f-97fd-4f29-bc53-b542a914f2d6",
            "old_requester_profile_code": "329-09-0001-7390371",
            "old_requester_profile_owner_document_number": "56000040000198",
            "old_requester_profile_name": "Meta",
            "old_requester_profile_account_number": "7390371",
            "old_requester_profile_account_digit": "7",
            "old_requester_profile_account_branch": "0001",
            "old_pix_key": "2376da91-86ad-4a0b-a466-f0f5acf53e24",
            "total_bank_slip_count": 40,
            "total_amount": 67245.96
        }
	],
	"pagination": {
		"current_page": 1,
		"rows_per_page": 100
	}
}

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 duplicate API calls.	36
`bank_slip_ownership_exchange_batch_status`	enum	Status of the ownership exchange batch.	Enumerators `bank_slip_ownership_exchange_batch_status`
`old_requester_profile_key`	uuidv4	Unique identification key of the destination collection portfolio, to which the bank slips will be transferred. You can obtain this key through the endpoint to query collection portfolios of an account	36
`old_requester_profile_code`	string	Code of the destination collection portfolio, to which the bank slips will be transferred.	19
`old_requester_profile_owner_name`	string	Name of the destination account holder and beneficiary of the destination collection portfolio.	255
`old_requester_profile_owner_document_number`	string	Document number (CPF/CNPJ) of the destination account holder and beneficiary of the destination collection portfolio.	255
`old_requester_profile_account_number`	string	Account number of the ownership transfer destination.	7
`old_requester_profile_account_digit`	string	Check digit of the ownership transfer destination account.	1
`old_requester_profile_account_branch`	string	Branch number of the ownership transfer destination account.	4
`old_pix_key`	string	PIX key of the ownership transfer 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.
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 transfer of 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.

Request​

Path parameters​

Query parameters​

Response​

Response Params​

Enumerators bank_slip_ownership_exchange_batch_status​