Skip to main content
GET
/
withdrawals
Listar Saques
curl --request GET \
  --url https://api.example.com/withdrawals \
  --header 'Authorization: <authorization>'
{
  "status": true,
  "data": [
    {}
  ],
  "count": 123
}
Retorna uma lista paginada de saques do seller autenticado com suporte a multiplos filtros.
​
Authorization
string
required
API Key no formato Bearer sk_live_... ou Bearer sk_test_...
​
take
number
default:"10"
Quantidade de registros por página. Max recomendado: 100.
​
skip
number
default:"0"
Número de registros a pular. Deve ser maior ou igual a 0.
​
status
string
Filtrar por status. Valores: PENDING, APPROVED, REJECTED, PROCESSING, COMPLETED, FAILED.
​
method
string
Filtrar por método. Valores: PIX, TED, DOC.
​
withdrawalId
string
ID interno do saque para filtrar um registro específico.
​
startDate
string
Data inicial no formato YYYY-MM-DD. Filtra saques criados a partir desta data (inclusivo).Exemplo: 2024-01-01
​
endDate
string
Data final no formato YYYY-MM-DD. Filtra saques criados até esta data (inclusivo).Exemplo: 2024-03-31
​
minAmount
number
Valor mínimo do saque em centavos.Exemplo: 5000 (R$ 50,00)
​
maxAmount
number
Valor máximo do saque em centavos.Exemplo: 500000 (R$ 5.000,00)
​
metadataKey
string
Chave do campo de metadata para busca. Use com metadataValue.
​
metadataValue
string
Valor do metadata a buscar. Suporta busca por substring.
​
search
string
Termo de busca geral. Pesquisa por ID, referência externa, end-to-end ID ou chave PIX.
​
export
boolean
default:"false"
Quando true, retorna o resultado como arquivo CSV para download.

​
Resposta

​
status
boolean
true quando a lista e retornada com sucesso.
​
data
array
Array de saques.
​
count
integer
Total de saques que correspondem aos filtros.
curl -X GET "https://api.linka.com/withdrawals?take=20&status=COMPLETED&startDate=2024-01-01" \
  -H "Authorization: Bearer <token>"

​
Exemplo de resposta

{
  "status": true,
  "data": [
    {
      "id": "clx1a2b3c4d5e6f7g8h9i0j",
      "amount": 50000,
      "feeAmount": 150,
      "netAmount": 49850,
      "method": "PIX",
      "status": "COMPLETED",
      "createdAt": "2026-03-06T10:00:00.000Z"
    }
  ],
  "count": 1
}