Skip to main content
GET
/
withdrawals
curl -X GET "https://api.thalbank.com/withdrawals?take=20&status=PAID&startDate=2026-03-01&endDate=2026-03-10" \
  -H "x-api-key: sua_api_key"

{
  "status": true,
  "data": [
    {
      "id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
      "amount": 50000,
      "method": "PIX",
      "status": "PAID",
      "paidAt": "2026-03-10T12:01:00.000Z",
      "createdAt": "2026-03-10T12:00:00.000Z"
    }
  ],
  "count": 25
}

​
Descricao

Retorna uma lista paginada dos seus saques. Suporta filtros por status, metodo, periodo, valor e metadata.

​
Request

​
take
integer
default:"10"
Numero de registros por pagina.
​
skip
integer
default:"0"
Offset de paginacao.
​
status
string
Filtrar por status. Valores: PENDING, APPROVED, REJECTED, PROCESSING, PAID, FAILED
​
method
string
Filtrar por metodo. Valores: PIX, TED, DOC
​
withdrawalId
string
Buscar por ID exato do saque.
​
startDate
string
Data inicial (ISO 8601). Exemplo: 2026-03-01
​
endDate
string
Data final (ISO 8601). Exemplo: 2026-03-10
​
minAmount
integer
Valor minimo em centavos.
​
maxAmount
integer
Valor maximo em centavos.
​
metadataKey
string
Chave de metadata para filtrar.
​
metadataValue
string
Valor de metadata para filtrar.
​
export
boolean
default:"false"
Se true, retorna CSV.
curl -X GET "https://api.thalbank.com/withdrawals?take=20&status=PAID&startDate=2026-03-01&endDate=2026-03-10" \
  -H "x-api-key: sua_api_key"

{
  "status": true,
  "data": [
    {
      "id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
      "amount": 50000,
      "method": "PIX",
      "status": "PAID",
      "paidAt": "2026-03-10T12:01:00.000Z",
      "createdAt": "2026-03-10T12:00:00.000Z"
    }
  ],
  "count": 25
}