Criar conta

Documentação Oficial

Bem-vindo à API do nosso Gateway. Nossa interface segue os padrões da Suitpay, permitindo uma integração rápida para quem já utiliza sistemas compatíveis. Através de nossa API, você pode processar Pix, Cartões e gerenciar recebíveis com segurança de nível bancário.

01

Obtendo suas Credenciais

Para iniciar qualquer integração, você precisará do seu Client ID e Client Secret.

  1. Acesse o seu Dashboard de Cliente.
  2. Vá até a aba API & Webhooks no menu lateral.
  3. Gere suas chaves de produção. Nunca compartilhe seu Client Secret.
02

Autenticação (Headers)

Todas as chamadas para nossos endpoints devem incluir os seguintes Headers HTTP para validação da conta.

ci: seu_client_id_aqui

cs: seu_client_secret_aqui

03

Gerar QR Code Pix

POST /api/v1/gateway/pix/request

Payload (JSON)

{
  "requestNumber": 150.50,
  "dueDate": "2026-12-31",
  "client": {
    "name": "João Silva",
    "document": "12345678909",
    "email": "[email protected]"
  }
}

Resposta Sucesso

{
  "response": "OK",
  "idTransaction": "UUID-...",
  "paymentCode": "000201...",
  "paymentCodeBase64": "..."
}
04

Enviar Pix (Payout)

POST /api/v1/gateway/pix/payout

Utilize este endpoint para realizar pagamentos e transferências via Pix (Saída). O valor será deduzido do seu saldo disponível no gateway.

Payload (JSON)

{
  "value": 50.00,
  "key": "[email protected]",
  "keyType": "EMAIL"
}

Resposta Sucesso

{
  "response": "OK",
  "idTransaction": "UUID-...",
  "status": "PROCESSING"
}
05

Consultar Status

GET /api/v1/gateway/pix/status/{idTransaction}

Verifique manualmente o status de uma transação caso o seu webhook não tenha sido processado.

05

Configurar Webhook

Nossa API enviará um POST para sua URL sempre que um pagamento for confirmado. É essencial que seu servidor responda com HTTP 200 OK.

Exemplo de Payload (JSON)

{
  "event": "payment.confirmed",
  "idTransaction": "550e8400-e29b-41d4-a716-446655440000",
  "status": "PAID",
  "amount": 150.50,
  "paymentMethod": "PIX",
  "createdAt": "2026-04-27T21:08:28Z",
  "client": {
    "document": "12345678909",
    "name": "João Silva"
  }
}

Validação X-Signature (PHP)

$secret = 'seu_client_secret';
$payload = file_get_contents('php://input');
$signature = $_SERVER['HTTP_X_SIGNATURE'];

$expected = hash_hmac('sha256', $payload, $secret);

if (hash_equals($expected, $signature)) {
    // Webhook Autêntico
    http_response_code(200);
} else {
    // Fraude detectada
    http_response_code(401);
}

Segurança HMAC

O Header X-Signature garante que o dado veio de nós e não foi alterado no caminho.

Política de Retentativa

Tentamos 5 vezes (1m, 5m, 15m, 1h, 6h) até receber o status 200.