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
Campo | Descrição | Tipo do Dado |
---|---|---|
amount | Valor do boleto | decimal |
provider | Provedor para emissão do boleto | string |
type | Tipo do boleto | string |
externalId | Identificador do boleto no provedor | string |
dueDate | Data de vencimento do boleto | date ("yyyy-MM-dd") |
status | Status do boleto | string |
publicUri | Link público para acesso ao boleto | string |
barCode | Código de barras do boleto | string |
createdAt | Data e hora de criação do boleto | dateTime ("yyyy-MM-ddTHH:mm:ss") |
updatedAt | Data e hora da atualização do boleto | dateTime ("yyyy-MM-ddTHH:mm:ss") |
settledAt | Data e hora de pagamento do boleto | dateTime ("yyyy-MM-ddTHH:mm:ss") |
registeredAt | Data e hora de registro do boleto | dateTime ("yyyy-MM-ddTHH:mm:ss") |
expiredAt | Data e hora de expiração do boleto | dateTime ("yyyy-MM-ddTHH:mm:ss") |
Provedores
Nome | Descrição |
---|---|
StoneOpenbank | Utilização da Stone Openbank API |
Tipos
Nome | Descrição |
---|---|
BillOfExchange | Duplicata mercantil |
Estados
Nome | Descrição |
---|---|
Vazio | Boleto foi criado em Offers |
Accepted | Ordem de emissão do boleto foi criada em Payments |
Created | Boleto criado |
Registered | Boleto registrado |
Expired | Boleto expirado |
Settled | Boleto quitado |
Rejected | Boleto rejeitado |
Cancelled | Boleto cancelado |