Skip to main content
Payout é a conversão Crypto → BRL. O receiver deposita crypto em um endereço fornecido pela plataforma e recebe BRL via PIX.

​
Etapas

  1. Cotação payout.
  2. Criação da ordem — plataforma gera endereço de depósito.
  3. Depósito crypto — receiver envia para o endereço.
  4. Conversão — swap para USDC (ou já USDC) → BRL.
  5. PIX outbound — plataforma envia BRL para a chave PIX configurada.
  6. Webhook — order.completed.

​
Cotação

curl -X POST https://api.astronpay.co/api/v1/quote/payout \
  -H "x-api-key: $API_KEY" -H "x-api-secret: $API_SECRET" \
  -H "Content-Type: application/json" \
  -d '{ "receiverId": "rcv_...", "amountCrypto": 200.00, "sourceToken": "USDC" }'
O campo sourceToken indica o token que o receiver vai depositar. O padrão é "USDC".

​
Criação da ordem

curl -X POST https://api.astronpay.co/api/v1/payout \
  -H "x-api-key: $API_KEY" -H "x-api-secret: $API_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
    "receiverId": "rcv_...",
    "quoteId": "qt_...",
    "amountCrypto": 200.00,
    "pixKey": "12345678901",
    "pixKeyType": "CPF",
    "recipientName": "João Silva",
    "recipientDocument": "12345678901"
  }'
A resposta inclui depositAddress. Oriente o receiver a enviar exatamente amountCrypto do sourceToken especificado para esse endereço.
Valores acima do cotado entram como over-deposit e ficam em conciliação manual. Valores abaixo não disparam a conversão — a ordem expira.

​
Status

Mesmo conjunto do payin (ver Ciclo de vida das ordens). Os principais para payout são:
StatusQuando
PENDINGOrdem criada, aguardando depósito crypto.
AWAITING_DEPOSITEndereço gerado, monitorando blockchain.
DEPOSIT_RECEIVEDDepósito detectado; conversão em andamento.
PIX_SENDINGPIX outbound sendo enviado.
PIX_SENT_UNCONFIRMEDPIX enviado, aguardando confirmação.
COMPLETEDPIX entregue ao receiver.
FAILEDErro; ver failureReason.
EXPIREDReceiver não depositou dentro do prazo.

​
Chaves PIX suportadas

TipoExemplo
CPF12345678901
CNPJ12345678000190
EMAILusuario@example.com
PHONE+5511999999999
RANDOMchave aleatória (UUID v4)
QRCODEpayload EMV completo

​
Webhooks recebidos

  • order.deposit_received
  • order.processing
  • order.pix_sending
  • order.completed
  • order.failed
Payloads completos em Eventos de webhook.

​
Consultando uma ordem

curl https://api.astronpay.co/api/v1/payout/$ORDER_ID \
  -H "x-api-key: $API_KEY" -H "x-api-secret: $API_SECRET"