Skip to main content
GET
Listar saques
Lista os saques do merchant com paginação bidirecional e filtro opcional por status.

Filtros

Exemplos

A listagem traz os campos essenciais. Para ver batchId em detalhe, use GET /withdrawals/{id}.

Authorizations

Authorization
string
header
required

Autentique suas requisições enviando o token no header Authorization: Bearer <token>.

O token pode ser:

Não há distinção de ambiente — toda chave vale para o único ambiente disponível (produção).

Query Parameters

after
string

Cursor opaco (do campo pagination.next da resposta anterior) para buscar a página seguinte.

before
string

Cursor opaco (do campo pagination.before da resposta anterior) para buscar a página anterior.

limit
integer
default:20

Quantidade máxima de itens por página (1 a 100).

Required range: 1 <= x <= 100
status
enum<string>
  • PENDING: solicitado, aguardando processamento
  • PROCESSING: em processamento no PSP
  • COMPLETED: PIX enviado com sucesso
  • FAILED: falhou (ver failedReason)
Available options:
PENDING,
PROCESSING,
COMPLETED,
FAILED
Example:

"COMPLETED"

Response

Lista paginada de saques.

data
object[]
required
pagination
object
required

Metadados de paginação bidirecional (usado por Checkout Transparente e Webhooks). next/before são cursores opacos — passe-os de volta em after/before para navegar.

error
null
required
Example:

null

success
enum<boolean>
required
Available options:
true
Example:

true