Skip to main content
POST
/
payout
Solicitar Saque
curl --request POST \
  --url https://api.example.com/payout \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 123,
  "pixKey": "<string>",
  "pixKeyType": "<string>",
  "referenceId": "<string>",
  "beneficiaryName": "<string>",
  "beneficiaryDocument": "<string>",
  "webhookUrl": "<string>"
}
'
Permite enviar valores da sua conta para qualquer chave Pix de terceiros ou conta bancária.

​
Validadores e Saldo

Se o saldo disponível for menor que o valor solicitado, a API retornará o erro Insufficient balance (400).

​
Body

​
amount
integer
required
Valor do saque em centavos (inteiro). Exemplo: R$ 50,00 deve ser enviado como 5000.
​
pixKey
string
required
A chave Pix de destino para onde o dinheiro será enviado.
​
pixKeyType
string
required
O tipo da chave Pix informada. Valores aceitos: CPF, CNPJ, EMAIL, PHONE, EVP (chave aleatória).
​
referenceId
string
required
Seu ID interno único para controle dessa transação.
​
beneficiaryName
string
Nome completo do beneficiário. Recomendado enviar para validação de segurança.
​
beneficiaryDocument
string
CPF ou CNPJ do beneficiário (somente números). Recomendado enviar para validação de segurança.
​
webhookUrl
string
URL para receber notificações de status da transferência (Webhooks).

​
Exemplos

curl --request POST \
  --url https://api.pagueoneip.com.br/payout \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: SUA_CHAVE_PUBLICA' \
  --header 'x-api-secret: SUA_CHAVE_SECRETA' \
  --data '{
  "amount": 5000,
  "pixKey": "[email protected]",
  "pixKeyType": "EMAIL",
  "beneficiaryName": "João da Silva",
  "beneficiaryDocument": "12345678900",
  "referenceId": "saque_001",
  "webhookUrl": "https://seu-site.com/webhook/payout"
}'

​
Respostas

{
  "id": "a1b2c3d4-...",
  "status": "PENDING",
  "amount": 5000,
  "currency": "BRL",
  "pixKey": "[email protected]",
  "pixKeyType": "EMAIL",
  "referenceId": "saque_001",
  "externalId": "tx_98765...",
  "createdAt": "2025-12-16T20:00:00.000Z"
}