Incluir boletos em um lote de tombamento

Esse endpoint é utiliza para inclusão de boletos em um lote de tombamento de boletos.

Request

ENDPOINT

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

MÉTODO

PATCH

Path parameters

Campo	Tipo	Descrição	Caracteres
ACCOUNT-KEY	uuidv4	Chave única de identificação da conta de origem, onde os boletos foram originalmente registrados.	36
REQUESTER-PROFILE-KEY	uuidv4	Chave única de identificação da carteira de cobrança de origem, onde os boletos foram originalmente registrados.	36
BANK-SLIP-OWNERSHIP-EXCHANGE-BATCH-KEY	uuidv4	Chave única de indentificação do lote de tombamento.	36

Request Body

{
	"bank_slips": [
		"b21c5b5a-a71f-4672-9254-022401cd15f6",
		"8197e3d0-1500-439f-9f9d-d243115542fa",
		"8293b817-bed9-418a-8c1e-ec8ef5a31468"
	]
}

Atenção!

A lista de boletos informada no objeto bank_slips no payload, possui uma limitação de 10.000 boletos por requisição.

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": "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": 3,
    "total_amount": 750.00
}

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
new_requester_profile_key	uuidv4	Chave única de identificação da carteira de cobrança de destino. É a carteira de cobrança 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
new_requester_profile_code	string	Código da carteira de cobrança de destino. É a carteira de cobrança para onde os boletos serão tombados.	19
new_requester_profile_owner_name	string	Nome do titular da conta de destino e do beneficiário da carteira de cobrança de destino.	255
new_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
new_requester_profile_account_number	string	Número da conta de destino do tombamento.	7
new_requester_profile_account_digit	string	Dígito verificador da conta de destino do tombamento.	1
new_requester_profile_account_branch	string	Número da agência da conta de destino do tombamento.	4
new_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.