> ## Documentation Index
> Fetch the complete documentation index at: https://docs.delfinance.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Consultar boleto ou conta

> Consulte os dados e os valores de um boleto, conta de consumo ou tributo antes de pagar.

> [!NOTE]
>
> Para o passo a passo completo, veja o guia [Consultar boleto ou conta](https://docs.delfinance.com.br/guias/pagamento-contas/consultar.md).

## Headers

**x-delbank-api-key** `string` *required*

Sua API key.

**x-delfinance-account-id** `string` *required*

Número da conta Delfinance.

## Path

**codigo** `string` *required*

Código de barras ou linha digitável do documento, apenas números.

## Response

**identifierNumber** `string`

Identificador do documento.

**type** `string`

Tipo do documento: `BANKSLIP` (boleto bancário) ou `TAXES` (conta de consumo ou tributo).

**status** `string`

Status do documento: `PENDING_PAYMENT`, `PAID`, `BLOCKED_PAYMENT` ou `PAYMENT_DEADLINE_EXCEEDED`. Só pague documentos com `PENDING_PAYMENT`.

**amount** `number`

Valor original do documento.

**dueDate** `string`

Data e hora de vencimento.

**barCode** `string`

Código de barras.

**digitableLine** `string`

Linha digitável.

**isAllowPartialPayment** `boolean`

Indica se o documento aceita pagamento com valor diferente do `chargedAmount`.

**paymentCalculation** `object`

Valores calculados para o pagamento.

**propriedades**

**rebateAmount** `number`

Valor de abatimento.

**interesetAmount** `number`

Valor total de juros. O nome do campo tem essa grafia.

**fineAmount** `number`

Valor total de multa.

**discountAmount** `number`

Valor total de descontos.

**chargedAmount** `number`

Valor total a pagar, já com juros, multa, descontos e abatimentos.

**minimumPaymentAmount** `number`

Valor mínimo aceito no pagamento.

**maximumPaymentAmount** `number`

Valor máximo aceito no pagamento.

**payer** `object`

Dados do pagador.

**propriedades**

**document** `string`

CPF ou CNPJ.

**name** `string`

Nome.

**type** `string`

`NATURAL` (pessoa física) ou `LEGAL` (pessoa jurídica).

**overduePaymentInterest** `object`

Juros após o vencimento.

**propriedades**

**date** `string`

Data a partir da qual os juros são aplicados.

**amount** `number`

Valor ou percentual dos juros.

**type** `string`

`PERCENTAGE` (percentual) ou `FIXED` (valor fixo).

**overduePaymentFine** `object`

Multa após o vencimento.

**propriedades**

**date** `string`

Data a partir da qual a multa é aplicada.

**amount** `number`

Valor ou percentual da multa.

**type** `string`

`PERCENTAGE` (percentual) ou `FIXED` (valor fixo).

**discounts** `array`

Descontos previstos no documento.

**beneficiary** `object`

Dados do beneficiário.

**propriedades**

**document** `string`

CPF ou CNPJ.

**name** `string`

Nome.

**fantasyName** `string`

Nome fantasia.

**type** `string`

`NATURAL` (pessoa física) ou `LEGAL` (pessoa jurídica).

**issuer** `object`

Dados do banco emissor.

**propriedades**

**ispb** `string`

ISPB do banco.

**name** `string`

Nome do banco.

**nameFantasy** `string`

Nome fantasia do banco.

```bash cURL theme={null}
curl --location 'https://apisandbox.delbank.com.br/baas/api/v1/bill-payments/43594939800000003250001112000000200000311672' \
--header 'x-delbank-api-key: {{apiKey}}' \
--header 'x-delfinance-account-id: {{accountId}}'
```

```json 200 theme={null}
{
    "identifierNumber": "3023063000107986253",
    "type": "BANKSLIP",
    "status": "PENDING_PAYMENT",
    "amount": 3.25,
    "dueDate": "2023-07-01T19:30:00",
    "barCode": "43594939800000003250001112000000200000311672",
    "digitableLine": "43590001161200000020300003116720493980000000325",
    "isAllowPartialPayment": false,
    "paymentCalculation": {
        "rebateAmount": 0.0,
        "interesetAmount": 2.23,
        "fineAmount": 3.25,
        "discountAmount": 0.0,
        "chargedAmount": 8.73,
        "minimumPaymentAmount": 8.73,
        "maximumPaymentAmount": 8.73
    },
    "payer": {
        "document": "1234567123",
        "name": "JAMES XPTO",
        "type": "NATURAL"
    },
    "overduePaymentInterest": {
        "date": "2023-07-02",
        "amount": 23.53,
        "type": "PERCENTAGE"
    },
    "overduePaymentFine": {
        "date": "2023-07-02",
        "amount": 3.25,
        "type": "FIXED"
    },
    "discounts": [],
    "beneficiary": {
        "document": "11468192000181",
        "name": "DEL CRED NP FUNDO DE INVESTIMENTO",
        "fantasyName": "DEL CRED NP FUNDO DE INVESTIMENTO",
        "type": "LEGAL"
    },
    "issuer": {
        "ispb": "38224857",
        "name": "DELCRED SCD S.A.",
        "nameFantasy": "DELBANK"
    }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.