Consulta de Boleto Bancário

Este endpoint é utilizado para consultar as informações de um boleto bancário.

Boleto bancário

É o boleto bancário convencional (linhas digitáveis não iniciadas com dígito 8). Possui registro na Câmara Interbancária de Pagamento (CIP/Núclea) e pode ser pago em instituições financeiras e de pagamento autorizadas a funcionar pelo Banco Central.

Request

Request Endpoint

ENDPOINT

/bill_payment/bank_slip/DIGITABLE_LINE or BARCODE

MÉTODO

GET

Request Path Params

Campo	Tipo	Descrição	Caracteres
digitable_line	string	Linha digitável a ser consultada.	47
barcode	string	Código de barras a ser consultado.	44

Request Query String Params

Campo	Tipo	Descrição	Caracteres
payment_date	string	Data do pagamento e que será levada em consideração nos cálculos dos valores do boleto.	YYYY-MM-DD

Response

Success Response

STATUS

200

Response Body: Boleto bancário disponível para pagamento

{
   "barcode":"00193967000009910000000003615574000000002417",
   "digitable_line":"00190000090361557400500000024174396700000991000",
   "payer_name":"COOPERATIVA AGRO.INDUSTRIAL TEST",
   "payer_document_number":"21063663000125",
   "beneficiary_name":"TESTE EQUIPAMENTOS E SERVICOS LTDA.",
   "beneficiary_trading_name":"TESTE EQUIPAMENTOS E SERVICOS LTDA",
   "beneficiary_document_number":"30639204000138",
   "beneficiary_bank_ispb":"00000000",
   "guarantor_name":null,
   "guarantor_document_number":null,
   "expiration_date":"2024-03-29",
   "max_payment_data": "2026-03-29",
   "partial_payment_indicator":"not_allowed",
   "registered_payment_amount":null,
   "nominal_amount":9910.0,
   "total_amount":10129.1,
   "rebate_amount":0.0,
   "discount_amount":0.0,
   "fine_amount":0.0,
   "interest_amount":219.1
}

Response Body Params

Campo	Tipo	Descrição
barcode *	string	Código de barras.
digitable_line *	string	Linha digitável.
payer_name *	string	Nome do pagador.
payer_document_number *	string	Número de documento do pagador (CPF/CNPJ).
beneficiary_name *	string	Nome do beneficiário.
beneficiary_trading_name	string	Nome fantasia do beneficiário.
beneficiary_document_number *	string	Número de documento do beneficiário (CPF/CNPJ).
beneficiary_bank_ispb *	string	Código ispb do banco do beneficiário.
guarantor_name	string	Nome do sacador avalista.
guarantor_document_number	string	Número de documento do sacador avalista (CPF/CNPJ).
expiration_date *	string	Data de vencimento.
max_payment_date *	string	Data máxima de pagamento.
partial_payment_indicator *	enum	Indicador de pagamento parcial
registered_payment_amount	string	Valor total de pagamento registrado.
nominal_amount *	number	Valor original.
total_amount *	number	Valor total.
rebate_amount *	number	Valor do abatimento.
discount_amount *	number	Valor do desconto.
fine_amount *	number	Valor da multa.
interest_amount *	number	Valor do juros.

Enumeradores partial_payment_indicator

Enumerador	Tipo	Descrição
allowed	string	Permitido
not_allowed	string	Não permitido

Error Response

STATUS

4XX

Response Body

{
    "title": "Título",
    "description": "Description in english",
    "translation": "Descrição em português",
    "code": "Código"
}

Código HTTP	Código QI	Título	Descrição (eng)	Descrição (pt-br)
400	BIP000001	Bad Request	The barcode or digitable line must have 44 or 47 characters.	O código de barras ou linha digitável deve ter 44 ou 47 caracteres.
400	BIP000002	Bad Request	The bill sent does not correspond to a bank slip.	A conta enviado não corresponde a um boleto bancário.
400	BIP000003	Bad Request	The digitable line sent is invalid.	A linha digitável enviada é inválida.
404	BIP000004	Not Found	The bank slip was not found.	O boleto não foi encontrado.
400	BIP000005	Bad Request	It was not possible to consult the bank slip at this time. Please try again in a few minutes.	Não foi possível consultar o boleto neste momento. Por favor, tente novamente em alguns minutos.
400	BIP000006	Bad Request	Bank slip already written off	Boleto já baixado
400	BIP000007	Bad Request	Bank slip blocked for payment	Boleto bloqueado para pagamento
400	BIP000008	Bad Request	Bank slip already paid	Boleto já pago
400	BIP000009	Bad Request	Invalid bank slip. Please consult issuing bank	Boleto inválido. Favor consultar banco emissor

Ambiente de Sandbox

Em nosso ambiente de sandbox, disponibilizamos linhas digitáveis mockadas para a simulação de pagamentos bem-sucedidos e testes de cenários de erro.

Cenários de sucesso

Linha digitável
00190000090361557400500000024174396700000991000
00190000090282802601919212747174596760001294161
23793390014000000455277000249001596900000103995
75691434020137513680900001040013196770002417240
21390001171200000570700168167484796770000148206
07790001161200000039300602819070498470000182970
23792372059034189564835003432701998420000008306
03399199530490000005254172701010698420000467696
03399135012340000000830681701014198420038743888
75691324620100735471370255730478698420064900819

Cenários de erro

Linha digitável	Código de erro
34191090083273252027893634770007296690012513600	BIP000007
07090010287045349010776686070590896770001160123	BIP000007
42297048060005815702500130494123896770000239491	BIP000006
74891123702849020818918378871083196690000050000	BIP000009
23792374119000209350986000372408496610000122810	BIP000008