Requer escopo
payouts:create para criar e payouts:read para consultar e cotar.Requisitos
Antes de solicitar um saque, confirme que:- A conta esta ativa, habilitada e com KYC aprovado.
- O servidor esta com
PAYOUTS_ENABLED=true. - A carteira possui saldo disponivel.
- A provedora esta configurada.
- Ao usar sessao, e necessaria confirmacao adicional recente.
Cotação
Antes de criar, useGET /v1/payouts/quote para conferir o valor debitado, a tarifa e o valor que o destinatario recebera.
true para descontar a tarifa do valor informado; false para cobrar a tarifa a parte. Padrao: false.curl
Exemplo: deductFee = false
Solicita-seamountCents=1000. A tarifa de 45 centavos e cobrada a parte.
Exemplo: deductFee = true
Solicita-seamountCents=1045. A tarifa de 45 centavos e descontada do valor.
Solicitar saque
EnviePOST /v1/payouts com Idempotency-Key obrigatorio.
Status de um saque
Reserva de saldo
A reserva ocorre antes da chamada externa a provedora:completedconsome a reserva definitivamente.failedlibera a reserva.unknownmantem a reserva ate confirmacao.
Consultar saque
UseGET /v1/payouts/{id} para sincronizar a situacao com a provedora, mesmo sem webhook.
curl
Tarifa
A tarifa fixa de saque e de 45 centavos por operacao. Consulte a cotacao para ver o impacto exato antes de solicitar.Idempotencia
Sempre envieIdempotency-Key ao criar. Em caso de falha de comunicacao, repita com a mesma chave, mesmo corpo e mesma credencial. Nao crie outra chave para resolver um resultado incerto.