Skip to main content
GET
cURL

Escopo

O ciclo de um saque

rejected não é perda: o valor retorna ao available e o pedido pode ser refeito depois de resolver o que reason aponta — chave Pix ausente ou divergente, por exemplo.
A consulta lê sempre a conta dona do token. Um id de outra conta responde 404, nunca 403: responder 403 confirmaria que aquele saque existe.

Exemplo


Boas práticas

  • Consulte com intervalo, não em laço apertado. A análise é humana; o estado não muda em segundos.
  • Trate reason como texto para pessoa, não como regra. Ele é escrito para o produtor ler e pode mudar de redação; decida pelo status.

Authorizations

Authorization
string
header
required

Token de autenticação do tipo Bearer {access_token}, onde {access_token} é o token obtido no fluxo de autenticação.

Path Parameters

id
string
required

Identificador do saque, como devolvido na solicitação.

Response

Saque recusado: o valor volta ao saldo e reason diz por quê.

id
string
required

Identificador do saque.

amount
string<decimal>
required

Valor solicitado, como string decimal.

Example:

"2.49"

fee
string<decimal>
required

Taxa de saque cobrada.

Example:

"2.49"

amountReceived
string<decimal>
required

amount menos fee: o que efetivamente cai na conta de destino.

Example:

"2.49"

currency
string
required

Moeda do saque.

status
enum<string>
required

Estado do pedido. Saque solicitado pela API nasce pending: entra na fila de análise em vez de sair automático. approved é o dinheiro já enviado; rejected devolve o valor ao saldo, com o motivo em reason; blocked exige contato com o suporte.

  • pending - pending
  • approved - approved
  • rejected - rejected
  • blocked - blocked
Available options:
pending,
approved,
rejected,
blocked
reason
string | null
required

Motivo da recusa, quando houver — o mesmo texto que o produtor vê no painel. null enquanto o pedido não foi recusado.

createdAt
string<date-time>
required

Quando o saque foi solicitado.

paidAt
string<date-time> | null
required

Quando o dinheiro foi enviado. null enquanto o saque não foi pago.