Listar saques da subconta
GET
/api/subaccounts/{{subaccount_id}}/withdrawals
Operação delegada (white-label)
{{subaccount_id}}. Autenticada pela API Key do master.subaccounts:readQuery params
| Param | Tipo | Default | Descrição |
|---|---|---|---|
page | int | 1 | Página (≥1). |
limit | int | 50 | Itens por página (1–100). |
Resposta 200 OK
{ data: [...], pagination: { page, limit, total, pages } }. Cada saque:| Campo | Tipo | Notas |
|---|---|---|
id | string | |
amount | int | CENTAVOS (valor bruto). |
fee | int | CENTAVOS — taxa de saque cheia. |
netAmount | int | CENTAVOS (líquido recebido). |
status | string | PENDING, PROCESSING, COMPLETED, FAILED, NEEDS_REVIEW. |
pixKeyType | string | Tipo da chave PIX de destino. |
pixKeyValue | string | Valor da chave (snapshot). |
createdAt | string | ISO8601. |
Sigilo (crítico): feeé a taxa cheia. Nenhuma decomposição comissão/base aparece.
Códigos de erro
| HTTP | Quando |
|---|---|
401 | API Key ausente/inválida. |
404 | Master sem white-label, ou subconta inexistente/não-sua. |
Exemplo cURL
Requisição
Parâmetros de Consulta
Parâmetros Header
Respostas
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --globoff '/api/subaccounts/{{subaccount_id}}/withdrawals?page=1&limit=50' \
--header 'Authorization: Bearer <token>'Response Response Example
200 - Sucesso (200)
{
"data": [
{
"id": "clwd0001",
"amount": 9500,
"fee": 500,
"netAmount": 9000,
"status": "COMPLETED",
"pixKeyType": "CPF",
"pixKeyValue": "12345678901",
"createdAt": "2026-05-07T14:40:00.000Z"
}
],
"pagination": { "page": 1, "limit": 50, "total": 1, "pages": 1 }
}Modificado em 2026-07-02 06:57:27