Skip to main content
POST
/
payout
Criar Payout
curl --request POST \
  --url https://api.example.com/payout \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 123,
  "pixKey": "<string>",
  "pixKeyType": "<string>",
  "beneficiaryName": "<string>",
  "beneficiaryDocument": "<string>",
  "webhookUrl": "<string>",
  "referenceId": "<string>"
}
'

​
Body Parameters

​
amount
integer
required
Valor em centavos (inteiro). Ex: 5000 = R$ 50,00.
​
pixKey
string
required
A chave Pix de destino.
​
pixKeyType
string
required
Tipo da chave. Valores aceitos: CPF, CNPJ, EMAIL, PHONE, EVP.
​
beneficiaryName
string
Nome do beneficiário (recomendado para validação).
​
beneficiaryDocument
string
CPF/CNPJ do beneficiário (apenas números).
​
webhookUrl
string
URL para receber notificações de status.
​
referenceId
string
required
Seu ID interno único para controle.

​
Exemplo de Requisição

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

​
Resposta de Sucesso (201 Created)

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

​
Webhooks (Notificações)

O sistema enviará uma requisição POST para a webhookUrl informada sempre que houver atualização de status. Para detalhes sobre o payload e status, consulte o guia de Webhooks.