银行票据查询

此端点用于查询银行票据信息。

银行票据

这是常规银行票据（数字行不以数字8开头）。在银行间支付结算所（CIP/Núclea）注册，可在巴西中央银行授权的金融和支付机构付款。

Request

请求端点

ENDPOINT

/bill_payment/bank_slip/DIGITABLE_LINE or BARCODE

MÉTODO

GET

请求路径参数

字段	类型	描述	字符数
`digitable_line`	string	待查询的数字行。	47
`barcode`	string	待查询的条形码。	44

查询字符串参数

字段	类型	描述	字符数
`payment_date`	string	支付日期，将用于计算票据金额。	YYYY-MM-DD

Response

成功响应

STATUS

200

Response Body: 银行票据可支付

{
   "barcode":"00193967000009910000000003615574000000002417",
   "digitable_line":"00190000090361557400500000024174396700000991000",
   "payer_name":"COOPERATIVA AGRO.INDUSTRIAL TEST",
   "payer_document_number":"21063663000125",
   "beneficiary_name":"TESTE EQUIPAMENTOS E SERVICOS LTDA.",
   "beneficiary_trading_name":"TESTE EQUIPAMENTOS E SERVICOS LTDA",
   "beneficiary_document_number":"30639204000138",
   "beneficiary_bank_ispb":"00000000",
   "guarantor_name":null,
   "guarantor_document_number":null,
   "expiration_date":"2024-03-29",
   "max_payment_data": "2026-03-29",
   "partial_payment_indicator":"not_allowed",
   "registered_payment_amount":null,
   "nominal_amount":9910.0,
   "total_amount":10129.1,
   "rebate_amount":0.0,
   "discount_amount":0.0,
   "fine_amount":0.0,
   "interest_amount":219.1
}

Response Body 参数

字段	类型	描述
`barcode` *	string	条形码。
`digitable_line` *	string	数字行。
`payer_name` *	string	付款人名称。
`payer_document_number` *	string	付款人文件号码（CPF/CNPJ）。
`beneficiary_name` *	string	受益人名称。
`beneficiary_trading_name`	string	受益人商业名称。
`beneficiary_document_number` *	string	受益人文件号码（CPF/CNPJ）。
`beneficiary_bank_ispb` *	string	受益人银行 ISPB 代码。
`guarantor_name`	string	保证人名称。
`guarantor_document_number`	string	保证人文件号码（CPF/CNPJ）。
`expiration_date` *	string	到期日期。
`max_payment_date` *	string	最大支付日期。
`partial_payment_indicator` *	enum	部分付款指示符
`registered_payment_amount`	string	已登记的总支付金额。
`nominal_amount` *	number	原始金额。
`total_amount` *	number	总金额。
`rebate_amount` *	number	折扣金额。
`discount_amount` *	number	优惠金额。
`fine_amount` *	number	罚款金额。
`interest_amount` *	number	利息金额。

partial_payment_indicator 枚举值

枚举值	类型	描述
`allowed`	string	允许
`not_allowed`	string	不允许

错误响应

STATUS

4XX

Response Body

{
    "title": "Título",
    "description": "Description in english",
    "translation": "Descrição em português",
    "code": "Código"
}

HTTP 代码	QI 代码	标题	描述（英文）	描述（葡文）
400	BIP000001	Bad Request	The barcode or digitable line must have 44 or 47 characters.	O código de barras ou linha digitável deve ter 44 ou 47 caracteres.
400	BIP000002	Bad Request	The bill sent does not correspond to a bank slip.	A conta enviado não corresponde a um boleto bancário.
400	BIP000003	Bad Request	The digitable line sent is invalid.	A linha digitável enviada é inválida.
404	BIP000004	Not Found	The bank slip was not found.	O boleto não foi encontrado.
400	BIP000005	Bad Request	It was not possible to consult the bank slip at this time. Please try again in a few minutes.	Não foi possível consultar o boleto neste momento. Por favor, tente novamente em alguns minutos.
400	BIP000006	Bad Request	Bank slip already written off	Boleto já baixado
400	BIP000007	Bad Request	Bank slip blocked for payment	Boleto bloqueado para pagamento
400	BIP000008	Bad Request	Bank slip already paid	Boleto já pago
400	BIP000009	Bad Request	Invalid bank slip. Please consult issuing bank	Boleto inválido. Favor consultar banco emissor

沙盒环境

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

成功场景

数字行
00190000090361557400500000024174396700000991000
00190000090282802601919212747174596760001294161
23793390014000000455277000249001596900000103995
75691434020137513680900001040013196770002417240
21390001171200000570700168167484796770000148206
07790001161200000039300602819070498470000182970
23792372059034189564835003432701998420000008306
03399199530490000005254172701010698420000467696
03399135012340000000830681701014198420038743888
75691324620100735471370255730478698420064900819
75691413310108906500520369970015899610000033705
13695621010000389701400000037598810770000217000

错误场景

数字行	错误代码
34191090083273252027893634770007296690012513600	BIP000007
07090010287045349010776686070590896770001160123	BIP000007
42297048060005815702500130494123896770000239491	BIP000006
74891123702849020818918378871083196690000050000	BIP000009
23792374119000209350986000372408496610000122810	BIP000008

Request​

请求端点​

请求路径参数​

查询字符串参数​

Response​

成功响应​

Response Body 参数​

partial_payment_indicator 枚举值​

错误响应​

沙盒环境​

成功场景​

错误场景​