Skip to main content
GET
Listar saques
GET /withdrawals Faz parte do recurso saques — o fluxo do saque e seus pré-requisitos estão lá. Retorna os saques da sua conta do mais recente para o mais antigo, paginados: limit vem 20 por padrão e aceita até 100. Nada no corpo avisa que houve corte — confira pagination.totalPages antes de concluir que a lista acabou.
Filtro com valor inválido responde 400, não é ignorado. ?status=pendente recusa a requisição inteira, sem devolver resultado parcial.
amount é o valor solicitado e netAmount é o que cai na conta — a diferença é a fee, todos em centavos. Para conferir a taxa antes de solicitar, use Configuração de saque.
cancelled e rejected não são a mesma coisa. cancelled é o saque que você cancelou enquanto ele ainda podia ser interrompido; rejected é o que não passou na nossa análise. Em ambos os casos o valor volta para a carteira. Já failed é falha no envio ao banco — vale conferir os dados da conta bancária.

Exemplo

Authorizations

x-api-key
string
header
required

API Key da Credential (gerada no Backoffice)

Query Parameters

page
integer
default:1

Página da listagem. Padrão: 1.

Required range: x >= 1
limit
integer
default:20

Itens por página. Padrão: 20. Máximo: 100.

Required range: 1 <= x <= 100
status
enum<string>

Etapa do saque: requested (solicitado), approved (aprovado), processing (em processamento), paid (pago), cancelled (cancelado por você), rejected (recusado) ou failed (falhou). Um valor por requisição.

Available options:
requested,
approved,
processing,
paid,
cancelled,
rejected,
failed

Response

Lista paginada de saques

data
object[]

Lista de registros retornados na página atual.

pagination
object

Dados de paginação do resultado.