Sign in

v1

latestOpenAPI 3.0.12026-07-245303882.5 MB
Bill

Busca do boleto.

get/bill/{id}

Path parameters

idstring required

Identificador único do boleto.

Response

Success

idstring

Propriedade Id Identificador único gerado automaticamente.

walletCodeinteger

Propriedade WalletCode Código da carteira.

requestIdstring nullable

Propriedade RequestId Identificador único da requisição.

bankNumberinteger

Propriedade BankNumber Identificador nosso número.

billNumberinteger nullable

Propriedade BillNumber Número de identificação do boleto.

billReferenceNumberinteger nullable

Propriedade BillReferenceNumber Número Referência Atual Cadastro Título.

barcodestring nullable

Propriedade Barcode Número código de barras.

digitableLinestring nullable

Propriedade DigitableLine Número Linha Digitável.

nominalValuenumber double

Propriedade NominalValue Valor nominal do boleto.

paidValuenumber double

Propriedade PaidValue Valor pago do boleto.

issueDatestring nullable

Propriedade IssueDate Data de emissão do boleto.

dueDatestring nullable

Propriedade DueDate Data de Vencimento do boleto.

documentKind'DUPLICATA_MERCANTIL' | 'DUPLICATA_SERVICO' | 'OUTROS' | 'DEPOSITO_APORTE'

Valores DocumentKind Código Espécie da cobrança.<p>Values:</p><ul><li><i>DUPLICATA_MERCANTIL</i> - Duplicata Mercantil.</li><li><i>DUPLICATA_SERVICO</i> - Duplicata de Serviço.</li><li><i>OUTROS</i> - Outros.</li><li><i>DEPOSITO_APORTE</i> - Boleto de Depósito e Aporte.</li></ul>

paymentType'TOTAL' | 'DIVERGENTE' | 'PARCIAL'

Valores PaymentType Tipo de Pagamento do boleto.<p>Values:</p><ul><li><i>TOTAL</i> - Aceita apenas um único pagamento no valor total do boleto, incluindo juros, multas e descontos.</li><li><i>DIVERGENTE</i> - Aceita apenas um único pagamento no valor definido entre o intervalo dos campos maxValue e minValue.</li><li><i>PARCIAL</i> - Aceite a quantidade de pagamentos estipulada no campo partials no valor definido entre o intervalo dos campos maxValue e minValue.</li></ul>

status'PROCESSAMENTO' | 'REJEITADO' | 'REGISTRADO' | 'BAIXADO' | 'LIQUIDADO_PARCIAL' | 'LIQUIDADO_INTEGRAL' | 'CANCELADO' | 'EXPIRADO'

Valores BillStatus Situação do boleto.<p>Values:</p><ul><li><i>PROCESSAMENTO</i> - Processamento.</li><li><i>REJEITADO</i> - Rejeitado.</li><li><i>REGISTRADO</i> - Registrado.</li><li><i>BAIXADO</i> - Baixado.</li><li><i>LIQUIDADO_PARCIAL</i> - Liquidado parcial.</li><li><i>LIQUIDADO_INTEGRAL</i> - Liquidado integral.</li><li><i>CANCELADO</i> - Cancelado.</li><li><i>EXPIRADO</i> - Expirado.</li></ul>

maxValuenumber double nullable

Propriedade MaxValue Valor Máximo aceito para pagamento.

minValuenumber double nullable

Propriedade MinValue Valor Mínimo aceito para pagamento.

partialsinteger nullable

Propriedade Partials Quantidade de pagamento parcial.

deductionValuenumber double

Propriedade DeductionValue Valor de Abatimento do valor nominal por antecipação do pagamento.

interestPercentagenumber double nullable

Propriedade InterestPercentage Percentual de Juros do pagamento.

settleDaysAmountinteger

Propriedade SettleDaysAmount Quantidade de Dias de Baixa após vencimento.

receivableScheduleDelayinteger

Propriedade ReceivableScheduleDelay Atraso do agendamento do recebimento.

createdstring date-time

Propriedade Created Data de inclusão.

updatedstring date-time nullable

Propriedade Updated Data de alteração.

Example response

{
  "id": "6659cffd92bdd93b23773661",
  "walletCode": 103,
  "requestId": "9b37e3f9-c59e-4b47-a93e-41f66e89df88",
  "bankNumber": 1,
  "billNumber": 3024061305151269000,
  "billReferenceNumber": 3024061305151269000,
  "beneficiary": {
    "name": "Nome ou Razão Social do beneficiário",
    "documentType": "CNPJ",
    "document": "51236721000136"
  },
  "beneficiaryFinal": {
    "name": "Nome ou Razão Social do beneficiário",
    "documentType": "CNPJ",
    "document": "51236721000136"
  },
  "payer": {
    "name": "Nome ou Razão Social do pagador",
    "documentType": "CNPJ",
    "document": "17910432000132",
    "address": "Logradouro do pagador",
    "city": "São Paulo",
    "state": "SP",
    "zipCode": "08675040"
  },
  "barcode": "50997000000000000000000000000000000000000019",
  "digitableLine": "50990000090000000000000000000191700000000000000",
  "nominalValue": 2500,
  "issueDate": "2024-05-18",
  "dueDate": "2024-06-10",
  "documentKind": "DUPLICATA_MERCANTIL",
  "paymentType": "PARCIAL",
  "status": "PROCESSAMENTO",
  "maxValue": 1200,
  "minValue": 10,
  "partials": 12,
  "discount": {
    "discountType": "DATA_FIXA",
    "discountOne": {
      "value": 100,
      "limitDate": "2023-05-12"
    },
    "discountTwo": {
      "value": 100,
      "limitDate": "2023-05-12"
    },
    "discountThree": {
      "value": 100,
      "limitDate": "2023-05-12"
    }
  },
  "deductionValue": 32.5,
  "fine": {
    "percentage": 20,
    "daysAmount": 10
  },
  "interestPercentage": 10,
  "settleDaysAmount": 10,
  "tags": [
    {
      "key": "IDSAP",
      "value": "125262"
    }
  ]
}