A entidade Boleto representa o método utilizado na execução da ordem. Contém todas as informações necessárias para a emissão de um boleto.
Objeto
{
"id": "jpxyxa42fvfg416vgzvraydn3",
"status": "Created",
"provider": "StoneOpenbank",
"invoiceType": "BillOfExchange",
"dueDate": "2020-12-04",
"dueDateInDays": 3,
"limitDate": "2020-12-04",
"LimitDateInDays": 3,
"issuanceDate": "2020-12-04",
"registredAt": "2020-12-04T13:35:47.792Z",
"settledAt": "2020-12-04T13:35:47.792Z",
"expiredAt": "2020-12-04T13:35:47.792Z",
"createdAt": "2020-12-04T13:35:47.792Z",
"createdBy": "application:credit-credit",
"amount": 20.0,
"discount": {
"value": "1.0",
"date": "2020-12-04",
"dateInDays": 1
},
"fine": {
"value": "1.0",
"date": "2020-12-04",
"dateInDays": 1
},
"interest": {
"value": "1.0",
"date": "2020-12-04",
"dateInDays": 1
},
"writableLine": "19790000052020031015703344761550581910000002000",
"barCode": "19797845600000021000000063139072468215929006",
"providerId": "ec363b21-113f-44e9-8cc3-dfcdb3cc2dc3",
"providerNumber": "63139072468215929006",
"publicUri": "https://sandbox-link.openbank.stone.com.br/boleto?id=ec363b21-113f-44e9-8cc3-dfcdb3cc2dc3"
}
Campos
| Campo | Descrição | Tipo de Dados | Validações |
|---|---|---|---|
id | Identificador único do boleto | string | |
status | Status atual do boleto bancário | string | |
provider | Provedor para a emissão do boleto | string | Valores suportados: StoneOpenbank. |
invoiceType | Tipo de boleto bancário | string | Valores suportados: Proposal, Deposit e BillOfExchange. |
dueDate | Data de vencimento do boleto bancário. | date ("YYYY-MM-DD") | Precisa ser igual ou maior que o dia atual e igual ou menor do que a limitdate. Caso seja um dia não útil o pagamento poderá ser feito até o próximo dia útil. _Mesmo depois dessa data expirar o pagamento ainda pode ser feito. |
dueDateInDays | Data de vencimento expressa em número absoluto de dias | integer | Precisa ser maior ou igual a zero e menor ou igual a 365 dias. |
limitDate | Data limite para pagamento | date ("YYYY-MM-DD") | Deve ser igual ou maior a data de vencimento e menor que 365 dias. Caso não seja informada será configurada automaticamente a data de vencimento. |
limitDateInDays | Data limite de pagamento expressa em número absoluto de dias | integer | Deve ser menor ou igual ao valor contido em DueDateInDays e maior ou igual a zero. |
issuanceDate | Data da emissão de boleto bancário | date ("YYYY-MM-DD") | |
registeredAt | Data e hora de registro do boleto bancário | date ("YYYY-MM-DDThh:mm:ssZ") | |
settledAt | Data e hora em que o dinheiro do pagamento do boleto é depositado na conta do beneficiário | date ("YYYY-MM-DDThh:mm:ssZ") | |
expiredAt | Data e hora em que o boleto expirou OBS. O pagamento pode ocorrer mesmo após essa data | date ("YYYY-MM-DDThh:mm:ssZ") | |
createdAt | Data e hora em que o boleto bancário foi gerado | date ("YYYY-MM-DDThh:mm:ssZ") | |
amount | Valor a pagar | decimal | Valor Min de R$ 20,00 e valor Max: R$ 10.000,00. O valor pode variar de R$ 2,01 a R$ 250.000,00 para contas que tiverem autorização no provedor do Serviço. |
discount.value | Valor de desconto | decimal | Valor percentual (%) do desconto que será aplicado ao boleto. O valor do deve ser maior que 0.0 e até 90.0 Desconto deve ser maior que 0% e até 90%. O desconto se aplica caso o pagameto seja feito até a dta informada. A data informada deve ser menor do que a data de vencimento do boleto e maior que sua data de emissão. |
discount.date | Data até a qual o desconto deve ser aplicado | date ("YYYY-MM-DD") | |
fine.value | Valor percentual (%) da multa que será aplicada ao boleto | decimal | Multa deve ser maior que 0% e até 2% do valor do boleto. A multa é cobrada uma única vez. A multa passa a contar a partir da data informada. Essa data tem que ser maior que o vencimento e menor que data limite. Caso nenhuma data seja informada será aplicada a patir do dia seguinte ao vencimento. Nos casos em que a data de vencimento cai em um dia não últil ela é automaticamente estendida para o próximo dia útil e a multa só passará a ser aplicada depois dessa data |
fine.date | Data que define o dia a partir do qual a multa deve ser aplicada ao boleto | date ("YYYY-MM-DD") | |
interest.value | Valor de juros | decimal | Valor percentual (%) dos juros que serão aplicados ao boleto por mês. O valor do deve ser maior que 0.0 e até 1.0 Juros deve ser maior que 0% e até 1% ao mês. O valor é aplicado por dia levando em conta o valor proporcional dado o juros mensal. Ex: 1% ao mês, seria 0,033% ao dia. O juros passam a contar a partir da data informada. Essa data tem que ser maior que o vencimento e menor que data limite. Caso nenhuma data seja informada serão aplicados a patir do dia seguinte ao vencimento. Nos casos em que a data de vencimento cai em um dia não últil ela é automaticamente estendida para o próximo dia útil e os juros só passam a ser aplicados depois dessa data. |
interest.date | Data que define o dia a partir do qual os juros passam a ser aplicados ao boleto | date ("YYYY-MM-DD") | |
writableLine | Código de barras traduzido em números | string | |
barCode | Código de barras | string | |
providerNumber | Número que identifica unicamente um boleto para uma conta | string | |
publicUri | Link público do boleto emitido | string |
Estados
| Status | Descrição |
|---|---|
Created | Boleto criado |
Registered | Boleto registrado |
Settled | Boleto pago |
Expired | Boleto expirado |
Cancelled | Boleto cancelado |
Provedores
| Provider | Descrição |
|---|---|
StoneOpenbank | Utilização da Stone Openbank API |
Stream de Dados
Contrato de Streaming dos Dados do Boleto
Veja Streaming de dados
{
"Stream": {
"Content": [
{
"Data": [
{
"Id": "jq6yw5d4fk39gg4u1yv713wyy",
"OrderId": "jq6yw5d2e2p7858yw3t9dy36k",
"Amount": 20.0,
"Provider": "StoneOpenbank",
"ExternalId": "xpto",
"DueDate": "2022-01-01T00:00:00",
"LimitDate": "2022-01-01T00:00:00",
"InvoiceType": "BillOfExchange",
"IssuanceDate": null,
"RegistredAt": null,
"SettledAt": null,
"CreatedAt": null,
"CreatedBy": null,
"DiscountDate": null,
"DiscountValue": null,
"FineDate": null,
"FineValue": null,
"InterestDate": null,
"InterestValue": null,
"WritableLine": null,
"BarCode": null,
"ProviderId": null,
"ProviderNumber": null,
"Status": "",
"PublicUri": null,
"GeneratedAt": "2021-01-22T14:22:07.817272Z",
"LastUpdatedAt": "2021-01-22T14:22:07.817272Z",
"Version": -1,
"StreamDate": "2021-01-22T14:22:22.2480082Z"
}
],
"SchemaName": "order-boleto",
"SchemaVersion": 1
}
]
},
"Timestamp": "2021-01-22T14:22:22.3106853Z",
"CommandKey": "jq6yw5j3qksxeff8sy2j8gad1",
"SessionKey": "jq6yw5d2e2p7858yw3t9dy36k",
"ChannelKey": "DefaultNotificationsChannel",
"IdempotencyKey": "jq6yw5j3qks54faxbt3u5h1mk",
"SagaProcessKey": "jq6yw5cus5skevp76rm24ns3q",
"BatchProcessKey": null,
"Result": {},
"Id": "jq6yw5d2e2p7858yw3t9dy36k",
"ApplicationKey": "runscope",
"UserEmail": null,
"ValidationResult": null
}
Contrato de Streaming dos Dados - Evento
Veja Streaming de Dados - Evento na Visão Geral da Ordem de Pagamento
Tipos de Eventos e Ações
| Tipo de evento | Ação |
|---|---|
Boleto | Created |
Boleto | Registred |
Boleto | Expired |
Boleto | Settled |
Boleto | Cancelled |