Pular para o conteúdo principal

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 BARCODE
MÉTODO
GET

Request Path Params

CampoTipoDescriçãoCaracteres
digitable_linestringLinha digitável a ser consultada.48
barcodestringCódigo de barras a ser consultado.44

Response

Success Response

STATUS
200
Response 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

CampoTipoDescrição
barcodestringCódigo de barras.
digitable_linestringLinha digitável.
collection_name *stringNome do convênio.
expiration_date *stringData de vencimento.
total_amount *numberValor total.

Error Response

STATUS
4XX
Response Body
{
"title": "Título",
"description": "Description in english",
"translation": "Descrição em português",
"code": "Código"
}
Código HTTPCódigo QITítuloDescrição (eng)Descrição (pt-br)
400BIP000032Bad RequestThe bill sent does not correspond to a collection slip.A conta enviada não corresponde a uma fatura de recolhimento.
400BIP000033Bad RequestThe 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.
400BIP000034Bad RequestCollection slip already paid.Fatura de recolhimento já paga.
400BIP000035Bad RequestCovenant slip invalid barcode.Código de barras da fatura de recolhimento inválido.
400BIP000036Bad RequestCovenant slip overdue.Fatura de recolhimento vencida.
400BIP000037Bad RequestError in collection slip consultation.Erro na consulta da fatura de recolhimento.
400BIP000038Bad RequestOutside of covenant payment hours.Fora do horário de pagamento do convênio.
400BIP000039Bad RequestCollection slip not accepted.Fatura de recolhimento não aceita.
400BIP000040Bad RequestMinimum advance not reached.Mínimo de dias de adiantamento não atingido.
400BIP000041Bad RequestMax 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ávelCódigo de erro
858500000037350000643217212883260006147448091022BIP000035