> ## 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 valor a receber

> Consulte quanto um beneficiário ainda vai receber de repasses e, opcionalmente, quanto já recebeu em um período.

> [!WARNING]
>
> **Funcionalidade em beta.** Contrato em proposta, sujeito a mudanças. Veja o guia [Acompanhar repasses](https://docs.delfinance.com.br/guias/split-pagamentos/acompanhar-repasses.md).

Retorna o **valor a receber** de um beneficiário na conta de recebimento: a soma dos repasses que ainda não foram concluídos (`SCHEDULED`, `PENDING` e `PROCESSING`). Se você informar um período, a resposta também traz o total já pago nesse período.

> [!NOTE]
>
> Nesta fase, todo repasse é executado logo após o recebimento. Por isso, o valor a receber costuma se resumir aos repasses Pix ainda em `PROCESSING`. Com os repasses com data futura, previstos para uma próxima fase, os repasses agendados (`SCHEDULED`) também entram nessa soma.

## Headers

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

Sua API key.

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

Número da conta de recebimento.

## Query params

**beneficiaryDocument** `string` *required*

CPF ou CNPJ do beneficiário, somente números.

**paidFrom** `string`

Data inicial para o total pago, no formato `YYYY-MM-DD`. Informe junto com `paidTo`.

**paidTo** `string`

Data final para o total pago, no formato `YYYY-MM-DD`. Informe junto com `paidFrom`.

## Response

**beneficiaryDocument** `string`

CPF ou CNPJ do beneficiário consultado.

**receivableAmount** `number`

Valor a receber: soma dos repasses em `SCHEDULED`, `PENDING` e `PROCESSING`.

**receivableByStatus** `object`

Valor a receber separado por status.

**receivableByStatus**

**scheduled** `number`

Soma dos repasses agendados.

**pending** `number`

Soma dos repasses prontos para execução.

**processing** `number`

Soma dos repasses Pix aguardando confirmação.

**paid** `object`

Total pago no período. Presente apenas quando `paidFrom` e `paidTo` são informados.

**paid**

**from** `string`

Data inicial do período.

**to** `string`

Data final do período.

**amount** `number`

Soma dos repasses `PAID` no período.

**count** `number`

Quantidade de repasses `PAID` no período.

```bash cURL theme={null}
curl --location 'https://apisandbox.delbank.com.br/baas/api/v1/split-payments/receivables?beneficiaryDocument=12345678909&paidFrom=2026-10-01&paidTo=2026-10-26' \
--header 'x-delbank-api-key: {{apiKey}}' \
--header 'x-delfinance-account-id: {{accountId}}'
```

```json 200 theme={null}
{
    "beneficiaryDocument": "12345678909",
    "receivableAmount": 5.00,
    "receivableByStatus": {
        "scheduled": 0.00,
        "pending": 0.00,
        "processing": 5.00
    },
    "paid": {
        "from": "2026-10-01",
        "to": "2026-10-26",
        "amount": 85.00,
        "count": 17
    }
}
```


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