Consult collection invoice (agreement/tribute)

This endpoint is used to query information about a collection invoice.

Collection Invoice

This type of charge is issued by utility companies (water, electricity, telephone, and gas bills) and public entities (taxes). They are not registered with the Interbank Payment Clearinghouse (CIP/Núclea) and, therefore, do not return the same information as a boleto.

Request

Request Endpoint

ENDPOINT

/bill_payment/collection_slip/DIGITABLE_LINE or BARCODE

MÉTODO

GET

Request Path Params

Field	Type	Description	Characters
digitable_line	string	Digitable line to be queried.	48
barcode	string	Barcode to be queried.	44

Response

Success Response

STATUS

200

Response Body: Collection invoice available for payment

{
  "barcode": null,
  "digitable_line": "836200000138892100450006762142420244046000010192",
  "collection_name": "CIA ULTRAGAZ SA-COD",
  "expiration_date": "2024-04-15",
  "total_amount": 1389.21
}

Response Body Params

Field	Type	Description
barcode	string	Barcode.
digitable_line	string	Digitable line.
collection_name *	string	Name of the agreement.
expiration_date *	string	Due date.
total_amount *	number	Total amount.

Error Response

STATUS

4XX

Response Body

{
    "title": "Título",
    "description": "Description in english",
    "translation": "Description in portuguese",
    "code": "Código"
}

HTTP Code	QI Code	Title	Description (eng)	Description (pt-br)
400	BIP000032	Bad Request	The bill sent does not correspond to a collection slip.	A conta enviada não corresponde a uma fatura de recolhimento.
400	BIP000033	Bad Request	The barcode or digitable line of the collection slip must have 44 or 48 characters.	O código de barras ou linha digitável da fatura de recolhimento deve ter 44 ou 48 caracteres.
400	BIP000034	Bad Request	Collection slip already paid.	Fatura de recolhimento já paga.
400	BIP000035	Bad Request	Covenant slip invalid barcode.	Código de barras da fatura de recolhimento inválido.
400	BIP000036	Bad Request	Covenant slip overdue.	Fatura de recolhimento vencida.
400	BIP000037	Bad Request	Error in collection slip consultation.	Erro na consulta da fatura de recolhimento.
400	BIP000038	Bad Request	Outside of covenant payment hours.	Fora do horário de pagamento do convênio.
400	BIP000039	Bad Request	Collection slip not accepted.	Fatura de recolhimento não aceita.
400	BIP000040	Bad Request	Minimum advance not reached.	Mínimo de dias de adiantamento não atingido.
400	BIP000041	Bad Request	Max payment amount exceeded.	Valor máximo de pagamento excedido.

Sandbox Environment

In our sandbox environment, we provide mocked digitable lines for simulating successful payments and testing error scenarios.

Success Scenarios

Digitable Line
828300000007411100972013905080001546763201900028
838000000009235700481007241345219112001474229880
848000000006308600802021201071261517689002201070
858200000015000000643025703477209504800448091020

Error Scenarios

Digitable Line	Error Code
858500000037350000643217212883260006147448091022	BIP000035