> ## 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 payouts de split

> Liste payouts por beneficiário, data, status e paginação.

> [!NOTE]
>
> Para o contexto completo, veja o guia [Ordens de Split de Pagamentos](https://docs.delfinance.com.br/guias/split-pagamentos/ordens.md).

Retorna os payouts da conta vinculada à credencial autenticada, com filtros opcionais para buscar um beneficiário, intervalo de datas ou estado específico.

## Headers

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

Sua API key.

## Query params

**beneficiaryDocument** `string`

CPF ou CNPJ do beneficiário. Deve ser um documento válido.

**beneficiaryName** `string`

Nome do beneficiário ou fragmento do nome para busca parcial.

**startDate** `string`

Data inicial para filtrar pela criação do payout. Formato aceito pela API, por exemplo `2025-01-31`.

**endDate** `string`

Data final para filtrar pela criação do payout. Formato aceito pela API, por exemplo `2025-01-31`.

**status** `string`

Estado do payout. Valores aceitos: `PENDING`, `PROCESSING`, `SUCCESS`, `ERROR`, `SCHEDULED` ou `CANCELED`.

**page** `number` (default: 1)

Número da página. Padrão: `1`.

**limit** `number` (default: 10)

Quantidade de itens por página. Padrão: `10`.

**include** `string`

Quando `metadata` é informado, a resposta retorna `data` e `metadata` em vez do array simples.

## Response

**id** `number` *required*

Identificador do payout.

**splitOrderId** `number`

Identificador da ordem de split à qual o payout pertence.

**beneficiary** `object`

Dados do beneficiário, incluindo documento e nome.

**transferType** `string`

Tipo de transferência do payout.

**instructionType** `string`

Tipo de regra que originou o payout, como `PERCENTAGE` ou `FIXED`.

**instructionAmount** `number`

Valor da instrução original aplicada.

**amount** `number`

Valor do payout.

**paymentDate** `string`

Data prevista para o pagamento.

**status** `string`

Status atual do payout: `PENDING`, `PROCESSING`, `SUCCESS`, `ERROR`, `SCHEDULED` ou `CANCELED`.

**transactionId** `string`

ID da transação associada ao payout, quando disponível.

**endToEndId** `string`

Identificador de ponta a ponta da transferência, quando disponível.

**errorMessage** `string`

Mensagem de erro do processamento, quando existir.

**cancellationDetails** `object`

Detalhes do cancelamento, quando o payout foi cancelado.

**paidAt** `string`

Data/hora do pagamento concluído.

**createdAt** `string`

Data/hora de criação do payout.

**updatedAt** `string`

Data/hora da última atualização.

```bash cURL theme={null}
curl --location 'https://api.delbank.com.br/baas/api/v1/split-payments/payouts?beneficiaryDocument=12345678901&status=ERROR&page=1&limit=10' \
--header 'x-delbank-api-key: {{apiKey}}'
```

```bash cURL (com metadata) theme={null}
curl --location 'https://api.delbank.com.br/baas/api/v1/split-payments/payouts?startDate=2025-01-01&endDate=2025-01-31&include=metadata&page=1&limit=20' \
--header 'x-delbank-api-key: {{apiKey}}'
```

```json 200 theme={null}
[
    {
        "id": 98765,
        "splitOrderId": 12345,
        "beneficiary": {
            "bankIspb": "ISPBCODE",
            "bankAccountNumber": "12345",
            "bankAccountBranch": "0001",
            "holderDocument": "12345678901",
            "holderName": "Nome do beneficiário",
            "bankAccountType": "Tipo da conta bancária do beneficiário"
        },
        "transferType": {
            "name": "PIX_MANUAL",
            "description": "Pix Manual",
            "value": 2
        },
        "instructionType": {
            "name": "PERCENTAGE",
            "description": "Porcentagem",
            "value": 0
        },
        "instructionAmount": 85.00,
        "amount": 8.29,
        "paymentDate": "2025-09-22T12:00:00.000Z",
        "status": {
            "name": "ERROR",
            "description": "Error",
            "value": 2
        },
        "transactionId": "ID-DO-SPLIT-CASHOUT",
        "endToEndId": "E2E-DO-SPLIT-CASHOUT",
        "errorMessage": "Banco rejeitou a transferência",
        "paidAt": "2025-09-22T12:00:00.000Z",
        "createdAt": "2025-09-22T12:00:00.000Z",
        "updatedAt": "2025-09-22T12:00:00.000Z",
        "splitOrder": {
            "id": 12345,
            "transactionOriginalId": "ID-DO-CASHIN",
            "grossAmount": 10.00,
            "tariffAmount": 0.25,
            "splitBaseAmount": 9.75,
            "source": {
                "name": "QR_CODE",
                "description": "QrCode",
                "value": 0
            },
            "createdAt": "2025-09-22T12:00:00.000Z",
        }
    }
]
```

```json 400 theme={null}
{
    "errors": [
        "O valor de 'status' não é um status válido."
    ]
}
```


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