Saques (payouts)
Envie dinheiro para fora da sua carteira PagNow via PIX, TED ou cripto.
Criar um saque
POST /v1/withdrawals
curl -X POST 'https://v2.pagnow.com/v1/withdrawals' \
-H 'apikey: pnk_sua_chave_aqui' \
-H 'content-type: application/json' \
-d '{
"type": "PIX",
"amount": 10000,
"currency": "BRL",
"pixKey": "maria@exemplo.com",
"pixKeyType": "EMAIL"
}'amount é em centavos. Para cripto, envie type: "CRYPTO" com cryptoAddress,
cryptoNetwork e cryptoCurrency.
Cripto: apenas USDT na BSC (BEP-20)
Saques em cripto liquidam exclusivamente em USDT na rede BSC (BEP-20).
cryptoNetwork deve ser BSC e cryptoCurrency deve ser USDT; o
cryptoAddress precisa ser um endereço BEP-20 válido (0x + 40 caracteres
hexadecimais). Rede, token ou endereço inválidos são rejeitados na criação,
antes de qualquer débito da carteira. Envio em rede errada é irreversível.
Exemplo — saque em cripto (USDT/BSC)
curl -X POST 'https://v2.pagnow.com/v1/withdrawals' \
-H 'apikey: pnk_sua_chave_aqui' \
-H 'content-type: application/json' \
-d '{
"type": "CRYPTO",
"amount": 5000,
"cryptoCurrency": "USDT",
"cryptoNetwork": "BSC",
"cryptoAddress": "0x9f8e7d6c5b4a39281706f5e4d3c2b1a09f8e7d6c",
"idempotencyKey": "payout-usdt-001"
}'amount continua em centavos de USDT (2 casas) — 5000 = 50,00 USDT.
Você pode ter várias carteiras na mesma moeda (ver Carteiras).
Omita walletId e o saque usa a carteira padrão da moeda (ou qualquer gastável
com saldo); informe walletId para debitar uma carteira específica.
Exemplo — saque via Binance Pay (USDT para uma conta Binance)
Se o destinatário tem conta na Binance, use type: "BINANCE_PAY" — a transferência
chega na hora, direto no saldo Binance dele, sem taxa de rede e sem risco de
erro de endereço on-chain. Informe o Binance ID (numérico, no perfil da conta)
ou o email da conta Binance:
curl -X POST 'https://v2.pagnow.com/v1/withdrawals' \
-H 'apikey: pnk_sua_chave_aqui' \
-H 'content-type: application/json' \
-d '{
"type": "BINANCE_PAY",
"amount": 5000,
"currency": "USDT",
"binanceId": "349183884",
"idempotencyKey": "payout-binance-001"
}'Para carteira externa (endereço 0x…), use type: "CRYPTO" (acima). Regra
prática: Binance ID/email → BINANCE_PAY; endereço on-chain → CRYPTO.
Campos
| Campo | Tipo | Obrigatório | Notas |
|---|---|---|---|
type | string | sim | PIX, TED, CRYPTO ou BINANCE_PAY. |
amount | int | sim | Centavos (> 0). |
currency | string | não | Padrão BRL. |
amountType | string | não | gross (padrão) = o valor pedido chega inteiro ao destinatário, a taxa é debitada por cima; net = o amount já inclui a taxa (o destinatário recebe amount − taxa). |
walletId | string | não | Carteira a debitar. Omita para auto-selecionar a carteira da moeda. |
pixKey / pixKeyType | string | p/ PIX | Chave PIX e tipo (CPF, CNPJ, EMAIL, PHONE, RANDOM). |
bankCode / bankAgency / bankAccount | string | p/ TED | Dados bancários para saque via TED. |
cryptoAddress / cryptoNetwork / cryptoCurrency | string | p/ CRYPTO | Destino do saque em cripto. Suportado: cryptoCurrency = USDT, cryptoNetwork = BSC (BEP-20), cryptoAddress = endereço 0x (40 hex). Validados na criação, antes do débito. |
binanceId | string | p/ BINANCE_PAY | Destino do saque: Binance ID numérico ou email da conta Binance do destinatário. Validado na criação, antes do débito. USDT, chega instantâneo no saldo Binance. |
idempotencyKey | string | recomendado | Chave única da sua operação (1–255 chars). Reenviar o mesmo idempotencyKey não cria um segundo saque — retorna o saque original. Ver abaixo. |
Idempotência: proteja-se contra saque duplicado
Sempre envie um idempotencyKey único ao criar um saque. Se a requisição
der timeout ou você reenviar por engano, a PagNow não gera um segundo saque
com a mesma chave — devolve o saque original (mesmo id, mesmo status). Use uma
chave estável, tipo o id do saque no seu sistema (ex.: "payout-2026-W17").
Sem idempotencyKey, ainda há uma proteção automática que bloqueia um saque
quase idêntico repetido em poucos segundos — mas a chave explícita é a forma
correta e recomendada. Ver Início rápido → Idempotência.
Cotar um saque (taxa)
POST /v1/withdrawals/quote — calcula a taxa e o gross-up para o destinatário
receber exatamente o valor desejado, antes de criar o saque.
curl -X POST 'https://v2.pagnow.com/v1/withdrawals/quote' \
-H 'apikey: pnk_sua_chave_aqui' \
-H 'content-type: application/json' \
-d '{ "value": 10000, "currency": "BRL" }'value é em centavos. A resposta traz a taxa e o valor total a ser debitado da
carteira para que o destinatário receba o value cheio.
Validar chave PIX antes de sacar
POST /v1/withdrawals/validate-pix-key — consulta se uma chave PIX existe e
retorna os dados do titular antes de criar o saque.
curl -X POST 'https://v2.pagnow.com/v1/withdrawals/validate-pix-key' \
-H 'apikey: pnk_sua_chave_aqui' \
-H 'content-type: application/json' \
-d '{ "pixKey": "maria@exemplo.com", "pixKeyType": "EMAIL" }'Aprovação automática vs manual
Todo saque começa em PENDING. Se ele é despachado na hora ou fica
aguardando aprovação manual depende da configuração de saque automático
da sua conta:
- Saque automático ativado — o saque é aprovado e enviado imediatamente.
- Saque automático desativado (padrão) — o saque fica
PENDINGaté a PagNow aprovar.
Fale com seu gerente de conta para ativar o saque automático.
Consultar e listar
# Um saque específico
curl 'https://v2.pagnow.com/v1/withdrawals/{id}' \
-H 'apikey: pnk_sua_chave_aqui'
# Listar com paginação; filtra por status
curl 'https://v2.pagnow.com/v1/withdrawals?page=1&limit=20&status=PENDING' \
-H 'apikey: pnk_sua_chave_aqui'Parâmetros de listagem: page, limit, status.
Ciclo de vida do saque
PENDING → APPROVED → PROCESSING → CONFIRMING → COMPLETED
→ FAILED
PENDING → CANCELLED
PENDING → REJECTED| Status | Significado | Terminal |
|---|---|---|
PENDING | Aguardando aprovação (manual ou automática). | |
APPROVED | Aprovado; aguardando despacho para a rede de pagamento. | |
PROCESSING | Enviado para o provedor, aguardando liquidação. | |
CONFIRMING | Confirmação em andamento na rede (ex: cripto aguardando blocos). | |
COMPLETED | Liquidado com sucesso. | sim |
FAILED | Falhou após o despacho; valor estornado para a carteira. | sim |
CANCELLED | Cancelado antes do despacho. | sim |
REJECTED | Rejeitado pela PagNow ou pelo provedor (ex: chave PIX inválida). | sim |
O ciclo de vida chega pelos eventos de webhook withdrawal.*. Um saque que falha
após o débito tem o valor estornado para a carteira automaticamente.
