Visão Geral do Boleto

A entidade Boleto representa o método utilizado para pagamento de uma Oferta.

Objeto

{
  "amount": 90.000000,
  "provider": "StoneOpenbank",
  "type": "BillOfExchange",
  "externalId": "jqb8ucex2tbq2y6jw1zmj9wqy",
  "dueDate": "2022-05-29",
  "status": "Settled",
  "publicUri": "https://sandbox-link.openbank.stone.com.br/api/boleto?id=b7c51a02-91f9-4a05-bbc6-0210dd4199ae",
  "barCode": "19792888200000080000000097672187089193449477",  
  "createdAt": "2021-07-15T20:55:20Z",
  "updatedAt": "2021-07-15T20:57:03Z",
  "settledAt": "2021-07-15T20:57:03Z",
  "registeredAt": "2021-07-15T20:57:03Z",
  "expiredAt": "2021-07-15T20:57:03Z"   
 }

Campos

CampoDescriçãoTipo do Dado
amountValor do boletodecimal
providerProvedor para emissão do boletostring
typeTipo do boletostring
externalIdIdentificador do boleto no provedorstring
dueDateData de vencimento do boletodate ("yyyy-MM-dd")
statusStatus do boletostring
publicUriLink público para acesso ao boletostring
barCodeCódigo de barras do boletostring
createdAtData e hora de criação do boletodateTime ("yyyy-MM-ddTHH:mm:ss")
updatedAtData e hora da atualização do boletodateTime ("yyyy-MM-ddTHH:mm:ss")
settledAtData e hora de pagamento do boletodateTime ("yyyy-MM-ddTHH:mm:ss")
registeredAtData e hora de registro do boletodateTime ("yyyy-MM-ddTHH:mm:ss")
expiredAtData e hora de expiração do boletodateTime ("yyyy-MM-ddTHH:mm:ss")

Provedores

NomeDescrição
StoneOpenbankUtilização da Stone Openbank API

Tipos

NomeDescrição
BillOfExchangeDuplicata mercantil

Estados

NomeDescrição
VazioBoleto foi criado em Offers
AcceptedOrdem de emissão do boleto foi criada em Payments
CreatedBoleto criado
RegisteredBoleto registrado
ExpiredBoleto expirado
SettledBoleto quitado
RejectedBoleto rejeitado
CancelledBoleto cancelado