Consultar linha digitável de boleto

Request

ENDPOINT

/bank_slip/payment

MÉTODO

GET

Query params

Campo	Tipo	Descrição	Caracteres
digitable_line *	string	Linha digitável do boleto.	48

Response

STATUS

200

Response Body

{
  "barcode": "31893833500000835480005050500512130021164946",
  "beneficiary_bank_code": "318",
  "beneficiary_document_number": "61902722000126",
  "beneficiary_legal_name": "Sport Club Corinthians Paulista",
  "beneficiary_person_type": "legal",
  "calculated_internally": true,
  "calculation_date": "2020-08-05",
  "calculation_model": 1,
  "digitable_line": "31890005025050051213700211649462383350000083548",
  "discount_amount": "0",
  "expiration_date": "2020-08-02",
  "expired_as_of_payment_date": true,
  "expired_as_of_today": true,
  "factual_expiration_date": "2020-08-03",
  "fine_amount": "16.71",
  "guarantor_document": null,
  "guarantor_name": null,
  "interest_amount": "0",
  "max_payment_date": "2020-08-08",
  "nominal_amount": "835.48",
  "payer_document_number": "15676407883",
  "payer_legal_name": "LUCIANO RENATO MOREIRA",
  "payer_person_type": "natural",
  "payment_date": "2020-08-05",
  "rebate_amount": "0.0",
  "total_amount": "852.19",
  "valid_payment_amount": true,
  "valid_payment_calculation": true,
  "valid_payment_time_frame": true
}

STATUS

400

Response Body

{
  "code": "BLP000142",
  "title": "Bad Request",
  "description": "This digitable line is out of minimum or maximum length.", 
  "translation": "Esta linha digitável está fora do comprimento mínimo ou máximo.",
  "extra_fields": {}
}

STATUS

400

Response Body

{
  "code": "BLP000141",
  "title": "Bad Request",
  "http_status": 400,
  "description": "The given digitable_line must have only numbers.",
  "translation": "A linha digit\u00e1vel fornecida deve conter somente n\u00fameros.",
  "extra_fields": {}
}

STATUS

400

Response Body

{
  "code": "BLP000012",
  "title": "Bad Request",
  "http_status": 400,
  "description": "Missing mandatory parameter: digitable_line",
  "translation": "Par\u00e2metro obrigat\u00f3rio ausente: digitable_line",
  "extra_fields": {}
}

STATUS

422

Response Body

{
  "code": "IPP000014",
  "title": "Invalid Barcode",
  "http_status": 422,
  "description": "Invalid barcode",
  "translation": "O Código de barras é inválido",
  "extra_fields": {}
}

STATUS

422

Response Body

{
  "code": "IPP000022",
  "title": "Unprocessable Entity",
  "http_status": 422,
  "description": "Covenant not accepted",
  "translation": "Convênio não aceito",
  "extra_fields": {}
}

STATUS

422

Response Body

{
  "code": "IPP000023",
  "title": "Unprocessable Entity",
  "http_status": 422,
  "description": "Max retries exceeded, while trying to complete payment.",
  "translation": "Número máximo de tentativas excedido, ao tentar concluir o pagamento.",
  "extra_fields": {}
}

STATUS

422

Response Body

{
  "code": "IPP000017",
  "title": "Unprocessable Entity",
  "http_status": 422,
  "description": "The tax collection is overdue",
  "translation": "A arrecadação está vencida",
  "extra_fields": {} 
}

Response Params

Campo	Tipo	Descrição	Caracteres
barcode	string	Código de barras do boleto.	44
beneficiary_bank_code	string	Código de bancário do banco que registrou o boleto.	3
beneficiary_document_number	string	CPF/CNPJ do beneficiário (recebedor) do boleto. Também é o CPF/CNPJ do titular da conta onde o boleto foi registrado.	14
beneficiary_legal_name	string	Nome do beneficiário (recebedor) do boleto. Também é o nome do titular da conta onde o boleto foi registrado.	-
beneficiary_person_type	enum	Natureza Jurídica do beneficiário (recebedor) do boleto. Também é a natureza jurídica do titular da conta onde o boleto foi registrado.	Enumerador person_type
calculated_internally	boolean	Indica se o calculo foi realizado pela QI Tech ou não.	-
calculation_date	string	Data de referência do calculo de multa e juros do boleto.	10
calculation_model	int	Modelo de calculo utilizado no calculo de multa e juros do boleto. Este campo é informado pelo banco que registrou o boleto.	Códigos calculation_model
digitable_line	uuid	Linha digitável do boleto.	47
discount_amount	string	Valor do desconto de pontualidade do boleto.	-
expiration_date	string	Data de vencimento do boleto.	10
expired_as_of_payment_date	boolean	Informa se o boleto estará vencido na data de agendamento do pagamento (Campo pode ser ignorado).	10
expired_as_of_today	string	Informa se o boleto esta vencido na data de hoje.	10
factual_expiration_date	string	Data de vencimento do boleto em dia útil. Por exemplo, se o boleto tiver vencimento em 2023-12-16 este campo terá o valor informado 2023-12-18.	10
fine_amount	string	Valor calculado de multa do boleto.	-
guarantor_document	string	CPF/CNPJ do sacador avalista do boleto.	14
guarantor_name	string	Nome do sacador avalista do boleto.	-
interest_amount	string	Valor de juros calculado após o vencimento do boleto.	-
max_payment_date	string	Data limite de pagamento do boleto.	10
nominal_amount	string	Valor original do boleto.	-
payer_document_number	string	CPF/CNPJ do pagador do boleto.	14
payer_legal_name	string	Nome do pagador do boleto.	14
payer_person_type	enum	Natureza jurídcia do pagador do boleto.	Enumerador person_type
payment_date	string	Data do pagamento do boleto.	10
rebate_amount	string	Valor de abatimento no boleto.	-
total_amount	string	Valor do total do boleto (com juros, multa, abatimento e desconto).	-
valid_payment_amount	boolean	Informa se o valor de pagamento é válido (será sempre true).	-
valid_payment_calculation	boolean	Informa se o valor calculado pelo banco registrador do boleto é válido (quando o calculation_model for 2 ou 3).	-
valid_payment_time_frame	boolean	Informa se a data de agendamento do pagamento é menor que a data máxima para pagamento do boleto.	-

Enumeradores person_type

Enumerador	Descrição
natural	Pessoa física
legal	Pessoa jurídica

Códigos calculation_model

Enumerador	Descrição
1	Instituição pagadora do boleto calcula os valores de juros e multa do boleto (Caso seja informado no boleto consultado, o campo calculated_internally será retornado como true).
2	Instituição que registrou o boleto calcula os valores de juros e multa. Após a data de vencimento do boleto, a instituição atualiza os valores diariamente na base centralizada de boleto.
3	Instituição que registrou o boleto calcula o valor do boleto. A instituição atualiza o valor do boleto diariamente na base centralizada de boleto.

Ambiente de Sandbox

Boletos de convênio/tributos

Os boletos de convênio/tributos são emitidos por órgãos governamentais, como prefeituras, governos estaduais ou federais, para a cobrança de impostos, taxas, contribuições sociais, multas, e outros valores devidos ao governo.

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	IPP000014

Boleto bancário

Um boleto bancário, também conhecido como boleto ou bloqueto, é um documento muito usado no Brasil para pagar por produtos ou serviços. Com um boleto, a pessoa ou empresa que o emite pode receber o dinheiro que está sendo cobrado do pagador.

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

Cenários de sucesso

Linha digitável
32990001039000210987502864982109595090000063958
32990001039000000006836762871105695090000010000
32990001031000699960099000000200195070000025527
32990001039000000000103194237800895060001000000
32990001031000699960095000000208497790000030990