查询票据可输入行

Request

ENDPOINT

/bank_slip/payment

MÉTODO

GET

Query params

字段	类型	描述	字符数
digitable_line *	string	票据可输入行	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ável fornecida deve conter somente números.",
  "extra_fields": {}
}

STATUS

400

Response Body

{
  "code": "BLP000012",
  "title": "Bad Request",
  "http_status": 400,
  "description": "Missing mandatory parameter: digitable_line",
  "translation": "Parâmetro obrigatório 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

字段	类型	描述	字符数
barcode	string	票据条形码	44
beneficiary_bank_code	string	注册票据的银行代码	3
beneficiary_document_number	string	票据受益人（收款人）的 CPF/CNPJ，也是注册票据的账户持有人的 CPF/CNPJ	14
beneficiary_legal_name	string	票据受益人（收款人）的姓名，也是注册票据的账户持有人姓名	-
beneficiary_person_type	enum	票据受益人（收款人）的法人性质，也是注册票据的账户持有人法人性质	Enumerador person_type
calculated_internally	boolean	表示计算是否由 QI Tech 内部完成	-
calculation_date	string	票据罚款和利息计算的参考日期	10
calculation_model	int	票据罚款和利息计算使用的计算模型，由注册票据的银行提供	Códigos calculation_model
digitable_line	uuid	票据可输入行	47
discount_amount	string	票据准时折扣金额	-
expiration_date	string	票据到期日	10
expired_as_of_payment_date	boolean	表示票据在计划付款日期时是否已到期（可忽略此字段）	10
expired_as_of_today	string	表示票据今天是否已到期	10
factual_expiration_date	string	票据到期的工作日。例如，若票据到期日为 2023-12-16，此字段将返回 2023-12-18	10
fine_amount	string	票据计算的罚款金额	-
guarantor_document	string	票据背书人的 CPF/CNPJ	14
guarantor_name	string	票据背书人的姓名	-
interest_amount	string	票据到期后计算的利息金额	-
max_payment_date	string	票据的最后付款日期	10
nominal_amount	string	票据原始金额	-
payer_document_number	string	票据付款人的 CPF/CNPJ	14
payer_legal_name	string	票据付款人的姓名	14
payer_person_type	enum	票据付款人的法人性质	Enumerador person_type
payment_date	string	票据付款日期	10
rebate_amount	string	票据的减免金额	-
total_amount	string	票据总金额（含利息、罚款、减免和折扣）	-
valid_payment_amount	boolean	表示付款金额是否有效（始终为 true）	-
valid_payment_calculation	boolean	表示注册票据的银行计算的金额是否有效（当 calculation_model 为 2 或 3 时）	-
valid_payment_time_frame	boolean	表示计划付款日期是否早于票据最后付款日期	-

Enumeradores person_type

枚举值	描述
natural	自然人
legal	法人

Códigos calculation_model

枚举值	描述
1	付款机构计算票据的罚款和利息值（如果注册票据中有提供，calculated_internally 将返回 true）
2	注册票据的机构计算罚款和利息值，到期后每日在票据集中数据库中更新这些值
3	注册票据的机构计算票据金额，每日在票据集中数据库中更新票据金额

沙盒环境

协议/税务票据

协议/税务票据由政府机构（如市政府、州政府或联邦政府）发行，用于征收税款、费用、社会保险金、罚款及其他应缴政府款项。

在我们的沙盒环境中，我们提供模拟的可输入行用于成功支付模拟和错误场景测试。

成功场景

可输入行
828300000007411100972013905080001546763201900028
838000000009235700481007241345219112001474229880
848000000006308600802021201071261517689002201070
858200000015000000643025703477209504800448091020

错误场景

可输入行	错误代码
858500000037350000643217212883260006147448091022	IPP000014

银行票据

银行票据（boleto bancário），也称 boleto 或 bloqueto，是巴西广泛用于支付商品或服务的凭证。通过票据，发行人或企业可以向付款人收取所欠款项。

在我们的沙盒环境中，我们提供模拟的可输入行用于成功支付模拟。

成功场景

可输入行
32990001039000210987502864982109595090000063958
32990001039000000006836762871105695090000010000
32990001031000699960099000000200195070000025527
32990001039000000000103194237800895060001000000
32990001031000699960095000000208497790000030990