> ## 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.

# Cancelar payout

> Solicite o cancelamento de um payout agendado ou em erro.

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

Solicita o cancelamento de um payout que esteja em `SCHEDULED` ou `ERROR`.

## Headers

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

Sua API key.

## Body

**splitPayoutId** `number` *required*

Identificador do payout a ser cancelado.

**reason** `string`

Motivo do cancelamento registrado pela operação.

**canceledBy** `string`

Nome ou identificação da pessoa que solicitou o cancelamento. Se não informado, a API registra `Não informado.`

## Response

Em caso de sucesso, a API retorna `202 Accepted` e o payout passa a ser tratado como cancelado. A confirmação final do estado deve ser verificada em `GET /api/v1/external/split-payments/payouts`.

```bash cURL theme={null}
curl --request PATCH \
  --url 'https://api.delbank.com.br/baas/api/v1/split-payments/payouts/cancel' \
  --header 'Content-Type: application/json' \
  --header 'x-delbank-api-key: {{apiKey}}' \
  --data '{
    "splitPayoutId": 98765,
    "reason": "Solicitação do cliente",
    "canceledBy": "Nome ou identificação do solicitante"
  }'
```

```text 202 theme={null}
Accepted
```

```json 422 theme={null}
{
    "title": "Please refer to the errors property for additional details.",
    "status": 422,
    "errors": [
        "SplitPayout não encontrado ou não pode ser cancelado."
    ]
}
```


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