get https://api-stg.tbanks.com.br/bill-payment/
Endpoint que permite realizar a consulta dos boletos para pagamento
Path Variable do request
| Campo | Tipo(Tamanho) | Obrigatório | Descrição |
|---|---|---|---|
barCode | String (47~48) | Sim | Código de barras do boleto. |
Corpo do response
| Campo | Tipo | Descrição |
|---|---|---|
barCode | String | Código de barras do boleto. |
digitableLine | String | Código de barras do boleto. Equivalente ao barCode |
recipientName | String | Nome do beneficiário do boleto |
recipientDocumentNumber | String | Documento do beneficiário |
payerDocumentNumber | String | Documento do pagador |
payerName | String | Nome do pagador |
bankName | String | Nome do banco emissor do boleto. Obs: para boletos de convênio e tributos este campo não terá valor, portanto será retornado null. |
dueDate | Date | Data de vencimento do boleto. |
settlementDate | Date | Data de pagamento do boleto. |
originalValue | Double | Valor do boleto. |
amount | Double | Valor do boleto abatido o desconto ou acrescido do juros e multa. |
discountValue | Double | Valor de desconto do boleto. Obs: Já consta no campo amount |
fineValue | Double | Valor da multa do boleto. Obs: Já consta no campo amount |
interestValue | Double | Valor dos juro do boleto. Obs: Já consta no campo amount. |
additionalDiscounts | Double | Outros descontos. Obs: O campo discountValue não contém este valor, porém já consta no campo amount |
reference | String | Código de referência da consulta. Será utilizado no endpoint de pagamento como chave da consulta. Pagar boleto |