get https://api-stg.tbanks.com.br/bank-slip/identifier
Requisição para buscar dados de um boleto específico pelo nosso número do boleto
Dados da resposta
Campo | Tipo | Descrição |
---|---|---|
identifier | UUID | Identificador do boleto |
payer | Object | Dados do pagador do boleto |
└── name | String | Nome do pagador do boleto |
└── documentNumber | String | Número do documento do pagador do boleto |
└── street | String | Logradouro do pagador do boleto |
└── district | String | Bairro do pagador do boleto |
└── city | String | Cidade do pagador do boleto |
└── state | String | Estado do pagador do boleto |
└── zipCode | String | CEP do pagador do boleto |
issuer | Object | Dados do emissor do boleto |
└── code | String | Código do banco emissor do boleto |
└── name | String | Nome do banco emissor do boleto |
amounts | Object | Dados dos valores do boleto |
└── interest | Number | Valor do juros diário do boleto em caso de atraso no pagamento |
└── fine | Number | Valor da multa do boleto em caso de atraso no pagamento |
└── daysToWriteOff | Number | Dias para baixa do boleto |
└── daysToFine | Number | Dias para cobrança de juros do boleto |
└── amount | Number | Valor final do boleto |
└── originalAmount | Number | Valor original do boleto |
dates | Object | Dados de datas do boleto |
└── createDate | DateTime (Formato UTC yyyy-MM-ddTHH:mm:SS.ssssss ) | Data de criação do boleto |
└── registerDate | DateTime (Formato UTC yyyy-MM-ddTHH:mm:SS.ssssss ) | Data de registro do boleto na CIP |
└── paymentDate | DateTime (Formato UTC yyyy-MM-ddTHH:mm:SS.ssssss ) | Data de pagamento do boleto |
└── clearingDate | DateTime (Formato UTC yyyy-MM-ddTHH:mm:SS.ssssss ) | Data de liquidação do boleto |
└── writeOffDate | DateTime (Formato UTC yyyy-MM-ddTHH:mm:SS.ssssss ) | Data de baixa do boleto |
└── cancellationDate | DateTime (Formato UTC yyyy-MM-ddTHH:mm:SS.ssssss ) | Data de cancelamento do boleto |
└── dueDate | Date (Formato UTC yyyy-MM-dd ) | Data de vencimento do boleto |
barCode | String | Código de barras do boleto |
digitableLine | String | Linha digitável do boleto |
receiptMessage | String | Mensagem exibida no boleto |
ourNumber | String | Nosso número do boleto |
status | Enum | Status do boleto. (Verificar tabela de status) |
emails | Array[String] | Emails para o onde o boleto foi enviado |
Descrição dos Status possíveis
Status | Descrição |
---|---|
OPEN | Registro do boleto solicitado na instituição bancária |
REGISTERED | Boleto registrado com sucesso na CIP |
PAID | Boleto pago na rede bancária |
SETTLED | Boleto liquidado |
OVERDUE | Boleto vencido, mas passível de pagamento |
WRITE_OFF | Boleto baixado por falta de pagamento |
CANCELED | Boleto cancelado |
Json da resposta:
{
"identifier": "5d97db69-b5ef-41f8-bf12-67934e358de1",
"payer": {
"district": "Bairro Teste",
"zipCode": "58000000",
"city": "Cidade Teste",
"street": "Rua Teste",
"state": "PB",
"name": "Pessoa Teste",
"documentNumber": "40063670070"
},
"issuer": {
"code": "218",
"name": "BS2"
},
"amounts": {
"interest": 0.0,
"fine": 0.0,
"daysToWriteOff": 90,
"daysToFine": 0,
"amount": 101.45,
"originalAmount": 100.0
},
"dates": {
"createDate": "2022-07-11T16:45:21.750049",
"registerDate": "2022-07-11T16:45:31.828266",
"paymentDate": null,
"clearingDate": null,
"writeOffDate": null,
"cancellationDate": null,
"dueDate": "2022-07-30"
},
"barCode": "21892906200000101450010003114724802980255138",
"digitableLine": "21890010070311472480429802551381290620000010145",
"receiptMessage": "Teste de emissão de boleto",
"ourNumber": 330,
"status": "OPEN",
"emails": []
}