Solicitar saque via PIX

Solicita um saque via PIX de forma programatica. Requer o token de API (obtido em POST /api/v1/api-auth/login) no header Authorization: Bearer e o header Idempotency-Key (obrigatorio) para evitar reenvio duplicado. A taxa de saque e descontada do valor solicitado: voce pede amount e recebe amount - taxa. Consulte GET /api/v1/withdrawals/fee-preview antes de solicitar para saber o valor liquido.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
number
required

Valor do saque (em reais). Deve ser maior que zero.

string
required

Chave PIX de destino.

string

(Opcional) URL para receber o callback de status do saque.

string

(Opcional) Metadados livres para sua conciliação.

Headers
string
required

Valor unico por requisicao. A mesma chave replica a resposta anterior (idempotencia).

Responses

400

Dados inválidos ou saldo insuficiente.

401

Token de API ausente/ inválido.

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json