Listar saques

GET

/api/withdrawals

Autenticação

Esta rota exige Bearer Token (sua API Key) no header. Envie EXATAMENTE assim:

Substitua o valor após Bearer pela sua API Key real (vk_live_* produção, vk_test_* sandbox). Crie a chave em https://app.dotfy.com.br/dashboard/chaves-api. Sem o header → 401. Com chave inválida/revogada → 401. Com chave sem o escopo necessário → 403 insufficient_scope.

Escopo: withdrawals:read. Saques em PENDING aparecem como PROCESSING ao usuário (aguardando aprovação interna).

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros de Consulta

Parâmetros Header

Respostas

🟢200

application/json

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api/withdrawals?page=1&limit=10' \
--header 'Authorization: Bearer <token>'

Response Example

{
  "withdrawals": [
    {
      "id": "clwd0001",
      "amount": 50000,
      "fee": 500,
      "netAmount": 49500,
      "status": "PROCESSING",
      "pixKey": {
        "type": "CNPJ",
        "key": "12.***.***/****-90"
      },
      "transactionId": null,
      "error": null,
      "createdAt": "2026-05-07T10:00:00.000Z",
      "processedAt": null
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 5,
    "pages": 1
  }
}

Modificado em 2026-07-02 06:57:27

Listar saques

Autenticação#

Requisição

Respostas

Autenticação