Visao Geral do Fluxo
Verificando o Saldo Disponível
Antes de criar um saque, verifique o saldo disponível para PIX:Resposta
balance - blockedBalance. Os campos *PendingBalance representam valores ainda em período de retenção (boleto/cartão) — ainda não disponeis para saque.
Criando um Saque
Guarde o ID do saque
A resposta O campo
201 confirma que o saldo foi reservado e o saque esta em processamento.Resposta 201
netAmount e o valor que chegara ao destinatario (amount - feeAmount).Campos da Requisicao
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
amount | integer | Sim | Valor em centavos. Mínimo: 500 (R$ 5,00) |
method | string | Sim | Deve ser "PIX" |
pixKey | string | Sim | Chave PIX do destinatario |
pixKeyType | string | Sim | Tipo da chave: CPF, CNPJ, EMAIL, PHONE, EVP |
description | string | Não | Descrição interna do saque |
metadata | object | Não | Dados extras para controle interno |
Tipos de Chave PIX
pixKeyType | Formato esperado | Exemplo |
|---|---|---|
CPF | 11 digitos numericos | 12345678901 |
CNPJ | 14 digitos numericos | 12345678000190 |
EMAIL | Email valido | [email protected] |
PHONE | +55DDD9XXXXXXXX | +5511999998888 |
EVP | UUID v4 (chave aleatoria) | 550e8400-e29b-41d4... |
Status do Saque
| Status | Descrição |
|---|---|
PENDING | Saldo debitado, aguardando processamento |
PROCESSING | Em processamento pela IP |
APPROVED | Aprovado pela IP, aguardando liquidacao |
COMPLETED | Transferencia concluida com sucesso |
FAILED | Falha — saldo reembolsado automaticamente |
CANCELLED | Cancelado — saldo reembolsado automaticamente |
Em caso de falha (
FAILED ou CANCELLED), o amount + feeAmount e reembolsado automaticamente para a wallet do seller. O saldo fica disponível imediatamente para nova tentativa.Eventos de Webhook
| Evento | Quando ocorre |
|---|---|
WITHDRAWAL_PROCESSING | Saque em processamento pela IP |
WITHDRAWAL_COMPLETED | Transferencia concluida |
WITHDRAWAL_FAILED | Falha na transferencia, saldo reembolsado |
Tratamento de Erros
| Status HTTP | Código de erro | Causa |
|---|---|---|
400 | INSUFFICIENT_WALLET_BALANCE | Saldo disponível menor que amount + fee |
400 | AMOUNT_BELOW_MINIMUM | Valor menor que R$ 5,00 (500 centavos) |
409 | IDEMPOTENCY_CONFLICT | Idempotency-Key ja usada |
422 | ACQUIRER_NOT_CONFIGURED | Nenhuma IP configurada para saques PIX |