API Reference

Gerar Pagamento (Cash-out)

Para processar um pagamento, utilize a rota /payments/withdraw. Essa rota é compatível com pagamentos via PIX.

{
  "amount": 100.50,
  "pixKey": "[email protected]",
  "pixKeyType": "email"
}

📋 Parâmetros Obrigatórios:

Campo Tipo Descrição amount number Valor do saque (deve ser > 0) pixKey string Chave PIX para recebimento pixKeyType string Tipo da chave PIX

🔄 Tipos de Chave PIX aceitos:

  • "email" - Email
  • "phone" - Telefone
  • "document" - CPF/CNPJ
  • "random" - Chave aleatória

    Resposta de Sucesso (201):

    {
      "success": true,
      "message": "Saque processado com 
      sucesso",
      "data": {
        "transactionId": "txn_123",
        "externalTransactionId": "ext_456",
        "status": "PENDING",
        "amount": 100.50,
        "amountNet": 98.00,
        "amountFee": 2.50,
        "paymentMethod": "PIX",
        "pixKey": "[email protected]",
        "pixKeyType": "email",
        "createdAt": "2024-01-15T10:00:00Z"
      }
    }

Language
Click Try It! to start a request and see the response here!