Listar lotes de tombamento de boletos - destino

Utilize esse endpoint para listar os lotes de tombamento de boletos a partir da conta de destino do tombamento.

Request

ENDPOINT

/bank_slip/account/ACCOUNT-KEY/requester_profile/REQUESTER-PROFILE-KEY/bank_slip_ownership_exchange_batches/incoming

MÉTODO

GET

Path parameters

Campo	Tipo	Descrição	Caracteres
`ACCOUNT-KEY`	uuidv4	Chave única de identificação da conta de destino, para onde os boletos serão tombados.	36
`REQUESTER-PROFILE-KEY`	uuidv4	Chave única de identificação da carteira de cobrança de destino, para onde os boletos serão tombados.	36

Query parameters

Campo	Descrição
`page_number`	Página atual que está sendo consultada
`page_size`	Quantidade de resultados por página

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

Campo	Tipo	Descrição	Caracteres
`bank_slip_ownership_exchange_batch_key`	uuidv4	Chave única de indentificação do lote de tombamento.	36
`request_control_key`	uuidv4	Chave única de identificação da requisição neste endpoint. Utilizada para evitar duplicidade na chamada via API.	36
`bank_slip_ownership_exchange_batch_status`	enum	Status do lote de tombamento.	Enumeradores `bank_slip_ownership_exchange_batch_status`
`old_requester_profile_key`	uuidv4	Chave única de identificação da carteira de cobrança de destino, para onde os boletos serão tombados. Você consegue opter essa chave através do endpoint de consulta de carteiras de cobrança de uma conta	36
`old_requester_profile_code`	string	Código da carteira de cobrança de destino, para onde os boletos serão tombados.	19
`old_requester_profile_owner_name`	string	Nome do titular da conta de destino e do beneficiário da carteira de cobrança de destino.	255
`old_requester_profile_owner_document_number`	string	Número do documento (CPF/CNPJ) do titular da conta de destino e do beneficiário da carteira de cobrança de destino.	255
`old_requester_profile_account_number`	string	Número da conta de destino do tombamento.	7
`old_requester_profile_account_digit`	string	Dígito verificador da conta de destino do tombamento.	1
`old_requester_profile_account_branch`	string	Número da agência da conta de destino do tombamento.	4
`old_pix_key`	string	Chave pix da conta de destino do tombamento (para os casos de bolepix).	255
`total_bank_slip_count`	float	Total de boletos no lote de tombamento.	-
`total_amount`	float	Somatória do valor de face dos boletos no lote de tombamento.	-

Enumeradores bank_slip_ownership_exchange_batch_status

Enumerador	Descrição
open	O lote foi criado e ainda está aberto para inclusão/exclusão de boletos.
closed	O lote se encontra fechado e o tombamento dos boletos contidos no lote foi concluído.
processing	A seleção dos boletos foi concluída e o tombamento dos boletos contidos no lote esta sendo processado.
pending_approval	A seleção dos boletos foi concluída e o lote de tombamento esta pendente de aprovação. A parte aprovadora, pode remover boletos do lote.
canceled	Lote de tombamento cancelado.
rejected	Lote de tomabamento rejeitado.

Listar lotes de tombamento de boletos - destino

Request​

Path parameters​

Query parameters​

Response​

Response Params​

Enumeradores bank_slip_ownership_exchange_batch_status​