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

# Consultar Saque

> Retorna os dados completos de um saque

## Descrição

Retorna os dados completos de um saque, incluindo status, chave PIX mascarada e taxa. Use para acompanhar o saque quando o webhook não chegar.

***

## Parâmetros de Path

**id** `string` *required*

UUID do saque, devolvido na criação

***

## Headers

**Authorization** `string` *required* (default: Bearer YOUR\_API\_KEY)

Bearer token de autenticação. Formato: `Bearer YOUR_API_KEY`

***

## Exemplo de Requisição

```bash cURL theme={null}
curl https://api.visepag.com/v1/payouts/aa53d5f9-a2fb-4c29-b36a-f1a2ef03fd30 \
  -H "Authorization: Bearer YOUR_API_KEY"
```

```javascript Node.js theme={null}
const response = await fetch(
  'https://api.visepag.com/v1/payouts/aa53d5f9-a2fb-4c29-b36a-f1a2ef03fd30',
  {
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY'
    }
  }
);
const payout = await response.json();
```

```python Python theme={null}
import requests

payout = requests.get(
    'https://api.visepag.com/v1/payouts/aa53d5f9-a2fb-4c29-b36a-f1a2ef03fd30',
    headers={'Authorization': 'Bearer YOUR_API_KEY'}
).json()
```

***

## Resposta `200 OK`

**id** `string`

UUID do saque.

**status** `string`

Status atual: `pending`, `processing`, `completed` ou `failed`.

**amount** `integer`

Valor do saque em centavos (o que saiu do saldo).

**platformFee** `integer`

Taxa do saque, em centavos.

**description** `string`

Descrição do saque.

**pixType** `string`

Tipo da chave PIX: `cpf`, `cnpj`, `phone`, `email` ou `random`.

**pixMasked** `string`

Chave PIX de destino mascarada.

**failureReason** `string | null`

Motivo da falha, só quando `status` é `failed`.

**createdAt** `string`

Data de criação em ISO 8601.

**completedAt** `string | null`

Data de conclusão em ISO 8601, ou `null`.

**failedAt** `string | null`

Data da falha em ISO 8601, ou `null`.

**currency** `string`

Sempre `"brl"`.

```json 200 theme={null}
{
  "id": "aa53d5f9-a2fb-4c29-b36a-f1a2ef03fd30",
  "status": "completed",
  "amount": 5000,
  "platformFee": 400,
  "description": "Saque semanal",
  "pixType": "cpf",
  "pixMasked": "********725",
  "failureReason": null,
  "createdAt": "2026-03-05T18:14:48Z",
  "completedAt": "2026-03-05T18:14:50Z",
  "failedAt": null,
  "currency": "brl"
}
```

***

## Erros

| Status | Código | Descrição |
| - | - | - |
| `404` | `payout_not_found` | Saque não encontrado, ou de outra empresa |
| `401` | `missing_authorization` | Header `Authorization` ausente |


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