Variável | Tipo | Descrição |
---|
id | string | Id de identificação do boleto. |
valueTotal | Long | Valor total do boleto. |
valuePay | Long | Valor pago. |
valueRefunded | Long | Valor recusado. |
barCode | string | Código de barras. |
dueDate | string | Data de vencimento. |
externalReference | string | Referência externa de parceria. |
status | string | Status do boleto. Ex.: PENDING, PAID, CANCELED, ERROR, GENERATED, WAITING. |
description | string | Descrição do boleto. |
url | string | Url com o pdf do boleto. |
createdAt | string | Data de criação do boleto. |
details | Object | Detalhes do boleto gerado. |
Variável | Tipo | Descrição |
---|
barcodeNumber | String | Código de barras. |
wallet | String | Carteira. |
ourNumber | String | Nosso número de identificação do boleto. |
totalValue | Long | Valor total do boleto. |
issueDate | String | Data de emissão. |
dueDate | String | Data de vencimento. |
holder | Object | Objeto contendo os dados do pagador. |
beneficiary | Object | Objeto contendo os dados do recebedor/beneficiário. |
account | Object | Objeto contendo os dados da conta bancária para recebimento do pagamento. |
Variável | Tipo | Descrição |
---|
name | String | Nome do pagador. |
email | String | Email. |
legalDocument | String | Documento (CPF ou CNPJ) do pagador. |
address | Object | Dados do endereço do pagador. |
Variável | Tipo | Descrição |
---|
state | String | Estado. |
street | String | Rua. |
city | String | Cidade. |
postalCode | String | Código postal (CEP). |
number | String | Número. |
Variável | Tipo | Descrição |
---|
establishmentName | String | Nome do estabelecimento. |
legalDocument | String | CNPJ do estabelecimento. |
Variável | Tipo | Descrição |
---|
agency | String | Número de agência. |
number | String | Número da conta bancária. |
❗️
Erros mapeados
Para visualizar os possíveis erros nesta API, acesse a Tabela de erros do pagamento web