Criar saque
Envia um PIX do saldo da conta para uma carteira cadastrada ou para uma chave PIX, com idempotência obrigatória.
apiKeyAuthorizationBearer <token>Chave de API com o saque por API liberado: Authorization: Bearer <chave>.
X-Idempotency-Key*stringIdentificador único do saque no seu sistema. De 1 a 64 caracteres: letras, números, ponto, hífen, sublinhado ou dois-pontos.
^[A-Za-z0-9._:-]{1,64}$application/json- body
Envie walletId ou pixKeyType + pixKey. A chave precisa ser do
titular da conta, salvo exceção liberada pelo suporte.
amount*numberValor a enviar, em reais. A tarifa é debitada por fora.
5 <= valueurgent*booleantrue pede o envio sem esperar a janela padrão de saque.
walletId?integerId da carteira de saque PIX cadastrada no painel.
pixKeyType?PixKeyTypeTipo da chave PIX de destino. EVP é a chave aleatória.
"CPF""CNPJ""EMAIL""PHONE""EVP"pixKey?stringChave PIX de destino, no formato do pixKeyType.
1 <= length <= 77description?stringTexto livre para a sua conciliação.
Saque aceito, ou o saque já criado com esta X-Idempotency-Key
(com o header Idempotent-Replayed: true).
application/json- response
id*integerId do saque. É o payout.invoiceId dos eventos payout.*.
id_transaction*stringId da transação. É o payout.id dos eventos payout.*.
idempotencyKey*|A X-Idempotency-Key da criação.
status*stringStatus em português, para exibição. Decida pelo statusCode.
statusCode*WithdrawalStatusCodeStatus estável do saque. WITHDRAWAL_IN_PROGRESS e
WITHDRAWAL_IN_PROCESSING: aceito, o dinheiro ainda não saiu.
WITHDRAWAL_COMPLETED: o dinheiro saiu. WITHDRAWAL_FAILED: não saiu.
"WAITING_PROCESSING""WITHDRAWAL_IN_PROGRESS""WITHDRAWAL_IN_PROCESSING""WITHDRAWAL_COMPLETED""WITHDRAWAL_FAILED"amount*numberValor pedido, em reais.
fee*numberTarifa do saque, em reais.
amount_final*numberTotal debitado do saldo (valor + tarifa), negativo.
isUrgent*booleanreason*|Motivo da falha, quando houver.
transactionType*stringcreatedAt*stringdate-timeupdatedAt*stringdate-timecurl -X POST 'https://api.gates2b.com/v2/withdraw' \ -H 'X-Idempotency-Key: string' \ -H 'Content-Type: application/json' \ -d '{ "amount": 150.75, "urgent": false, "walletId": 812}'{ "id": 4242, "id_transaction": "8f0e6c1a-3b2d-4e5f-9a8b-7c6d5e4f3a2b", "idempotencyKey": "saque-123", "status": "Saque em andamento", "statusCode": "WITHDRAWAL_IN_PROGRESS", "amount": 150.75, "fee": 2.5, "amount_final": -153.25, "isUrgent": false, "reason": null, "transactionType": "PIX", "createdAt": "2026-10-22T14:00:00.000Z", "updatedAt": "2026-10-22T14:00:00.000Z"}O saque por API vem desligado. Peça a liberação da sua conta ao suporte e cadastre no painel os IPs que vão chamar
a rota (veja Liberação de IP). Sem liberação, a resposta é 403 com
WITHDRAW_API_KEY_DISABLED; de um IP fora da lista, 403 com WITHDRAW_API_IP_NOT_ALLOWED.
Regras
amounté número em reais (150.75), mínimo5. A tarifa é debitada do saldo além do valor.- Envie
walletIdoupixKeyType+pixKey. Os dois juntos respondem400comWITHDRAW_DESTINATION_CONFLICT. - Gere uma
X-Idempotency-Keypor saque e guarde-a antes de chamar. Em timeout ou erro de rede, repita o mesmo pedido com a mesma chave: se o saque já existe, a resposta é201com o headerIdempotent-Replayed: true, sem novo débito. - Depois de um saque aceito, a conta espera 30 minutos para criar outro. Antes disso, a resposta é
403com os minutos restantes emdata.timeLeftMinutes. 201quer dizer saque aceito, não dinheiro enviado. O desfecho chega pelos eventospayout.paidepayout.failed(veja Webhooks), ou consulte por Consultar saque.