Consulta de Fatura de Recolhimento
Este endpoint é utilizado para consultar as informações de uma fatura de recolhimento.
Fatura de recolhimento
Esse tipo de cobrança é emitido por concessionárias de serviços (conta de água, luz, telefone e gás) e órgão públicos (tributos). Eles não são registrados na Câmara Interbancária de Pagamento (CIP/Núclea), por isso, não retornam as mesmas informações que um Boleto bancário apresenta.
Request
Request Endpoint
ENDPOINT
/bill_payment/collection_slip/DIGITABLE_LINE or BARCODEMÉTODO
GETRequest Path Params
| Campo | Tipo | Descrição | Caracteres |
|---|---|---|---|
digitable_line | string | Linha digitável a ser consultada. | 48 |
barcode | string | Código de barras a ser consultado. | 44 |
Response
Success Response
STATUS
200Response Body: Fatura de recolhimento disponível para pagamento
{
"barcode": null,
"digitable_line": "836200000138892100450006762142420244046000010192",
"collection_name": "CIA ULTRAGAZ SA-COD",
"expiration_date": "2024-04-15",
"total_amount": 1389.21
}
Response Body Params
| Campo | Tipo | Descrição |
|---|---|---|
barcode | string | Código de barras. |
digitable_line | string | Linha digitável. |
collection_name * | string | Nome do convênio. |
expiration_date * | string | Data de vencimento. |
total_amount * | number | Valor total. |
Error Response
STATUS
4XXResponse 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 | 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. |
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 |
|---|
| 828300000007411100972013905080001546763201900028 |
| 838000000009235700481007241345219112001474229880 |
| 848000000006308600802021201071261517689002201070 |
| 858200000015000000643025703477209504800448091020 |
Cenários de erro
| Linha digitável | Código de erro |
|---|---|
| 858500000037350000643217212883260006147448091022 | BIP000035 |