Documentação da API

Alô Pagamentos Payment Gateway API

v1.0.0developers.alopagamentos.com

API REST para integração com o gateway de pagamentos da Alô Pagamentos. Gere QR Codes PIX, realize saques PIX e cripto, consulte saldo e receba notificações via webhook. Contas com cripto habilitado também podem gerar cobranças e saques em USDT, BTC e outras moedas.

Servers

productionhttps://api.alopagamentos.com/api/v1

Autenticação

Todas as rotas exigem Client ID e Client Secret.

1. Authorization Header (Basic Auth) recomendado

Header

Authorization: Basic base64(clientId:clientSecret)

2. Header api-key

Header

api-key: clientId:clientSecret

Obtenha credenciais em: Dashboard → Integrações → Gerar credenciais. Use as credenciais somente no backend.

Cash In

Geração de PIX para recebimento.

POST/cashinGerar PIX dinâmico

Gera um código PIX dinâmico para recebimento de pagamento. Retorna QR Code e código copia-e-cola.

Parameters

Name	In	Type	Description
`amount`*	body	number	Valor em reais (ex: 100.00)
`client.name`*	body	string	Nome do pagador
`client.document`*	body	string	CPF/CNPJ do pagador
`client.telefone`*	body	string	Telefone do pagador
`client.email`*	body	string	Email do pagador
`callbackUrl`*	body	string	URL para receber webhook de confirmação
`checkoutId`	body	string	ID do pedido/checkout (opcional)
`splits`	body	array	Split de pagamento [{email, percent}] (opcional)

Request body

{
  "amount": 100.00,
  "client": {
    "name": "João Silva",
    "document": "12345678900",
    "telefone": "11999999999",
    "email": "[email protected]"
  },
  "callbackUrl": "https://seusite.com/webhook",
  "checkoutId": "CHECKOUT123",
  "splits": [
    { "email": "[email protected]", "percent": 10 }
  ]
}

200Sucesso

Response

{
  "success": true,
  "data": {
    "paymentCode": "00020126...",
    "idTransaction": "TRANS123456",
    "paymentCodeBase64": "data:image/png;base64,...",
    "amount": 100.00,
    "status": "pending"
  }
}

Cash Out

Saques via PIX.

POST/cashoutRealizar saque PIX

Cripto

Cash in e cash out em criptomoedas. Requer cripto habilitado na conta.

Moedas

USDTUSDCBTCETHSOLBNBTRXPOLAVAX

Chains

tronethereumbscpolygonsolanabitcoinarbitrumbaseoptimismavalanche

Cash out exige IP autorizado no dashboard (como o saque PIX).

POST/crypto/cashinGerar cobrança cripto

POST/crypto/cashoutRealizar saque cripto

Saldo

Consulta de saldo disponível e limite de saque.

GET/balanceConsultar saldo

Transações

Listagem e consulta de transações.

GET/transactionsListar transações

GET/transaction/{id}Consultar transação

Webhooks

PIX: enviados para callbackUrl. Cripto: enviados para postback_url (HTTPS).

Cash In PIX Pagamento recebido

Payload

{
  "idTransaction": "TRANS123456",
  "status": "paid",
  "amount": 100.00,
  "client": {
    "name": "João Silva",
    "email": "[email protected]",
    "document": "12345678900"
  }
}

Cash Out PIX Saque processado

Payload

// Sucesso
{ "idTransaction": "TRANS789012", "status": "SaquePago", "amount": 50.00 }

// Falha
{ "idTransaction": "TRANS789012", "status": "SaqueFalhou", "amount": 50.00, "reason": "Motivo" }

Cripto Depósito confirmado

Evento cashin.confirmed: POST no postback_url do cash in cripto.

Payload

{
  "event": "cashin.confirmed",
  "transaction_id": "CRYPTO_TX_123",
  "data": {
    "transaction_id": "CRYPTO_TX_123",
    "external_id": "order_456",
    "status": "confirmed",
    "amount": "50.00000000",
    "amount_net": "49.50000000",
    "fee": "0.50000000",
    "currency": "USDT",
    "chain": "tron",
    "tx_hash": "abc123..."
  }
}

Cripto Saque processado

Eventos cashout.confirmed, cashout.failed ou cashout.refunded.

Payload

// Sucesso
{
  "event": "cashout.confirmed",
  "transaction_id": "CRYPTO_OUT_456",
  "data": {
    "transaction_id": "CRYPTO_OUT_456",
    "external_id": "saque_789",
    "status": "confirmed",
    "amount": "100",
    "currency": "USDT",
    "network": "tron",
    "tx_hash": "def456..."
  }
}

// Falha
{
  "event": "cashout.failed",
  "transaction_id": "CRYPTO_OUT_456",
  "data": {
    "transaction_id": "CRYPTO_OUT_456",
    "external_id": "saque_789",
    "status": "failed",
    "amount": "100",
    "currency": "USDT",
    "network": "tron",
    "reason": "Motivo da falha"
  }
}

Exemplos

Exemplos de integração em diferentes linguagens.

cURL · POST /cashin

curl -X POST https://api.alopagamentos.com/api/v1/cashin \
  -H "Authorization: Basic $(echo -n 'clientId:clientSecret' | base64)" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 100.00,
    "client": {
      "name": "João Silva",
      "document": "12345678900",
      "telefone": "11999999999",
      "email": "[email protected]"
    },
    "callbackUrl": "https://seusite.com/webhook"
  }'

Node.js · POST /cashin

const auth = Buffer.from(`${clientId}:${clientSecret}`).toString('base64');

const res = await fetch('https://api.alopagamentos.com/api/v1/cashin', {
  method: 'POST',
  headers: { Authorization: `Basic ${auth}`, 'Content-Type': 'application/json' },
  body: JSON.stringify({
    amount: 100.00,
    client: { name: 'João Silva', document: '12345678900', telefone: '11999999999', email: '[email protected]' },
    callbackUrl: 'https://seusite.com/webhook',
  }),
});
console.log(await res.json());

Python · POST /cashin

import requests, base64

auth = base64.b64encode(f'{client_id}:{client_secret}'.encode()).decode()
res = requests.post('https://api.alopagamentos.com/api/v1/cashin', json={
    'amount': 100.00,
    'client': {'name': 'João Silva', 'document': '12345678900', 'telefone': '11999999999', 'email': '[email protected]'},
    'callbackUrl': 'https://seusite.com/webhook',
}, headers={'Authorization': f'Basic {auth}'})
print(res.json())

PHP · POST /cashin

$auth = base64_encode($clientId . ':' . $clientSecret);
$ch = curl_init('https://api.alopagamentos.com/api/v1/cashin');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST => true,
    CURLOPT_HTTPHEADER => ['Authorization: Basic ' . $auth, 'Content-Type: application/json'],
    CURLOPT_POSTFIELDS => json_encode(['amount' => 100.00, 'client' => [...], 'callbackUrl' => 'https://seusite.com/webhook']),
]);
echo curl_exec($ch);