Integre seu gateway com Vega, Adoorei, Zedy, Corvex e Nuvorafy
A API do Steex Gateway permite que checkouts externos enviem e consultem transações de pagamento. Todas as requisições são autenticadas via API Key (gerada no painel → API Keys).
Base URL
https://api.steexpay.com.br
Formato
JSON (application/json)
Autenticação
Header: x-steex-key
Chave Pública — enviada no header x-steex-key.
Chave Secreta — enviada no header x-steex-secret.
Todas as requisições exigem as duas chaves em conjunto, validadas no servidor para garantir que pertencem à mesma API Key ativa.
# Criar transação POST https://api.steexpay.com.br/functions/criarTransacao x-steex-key: pk_sua_chave_publica x-steex-secret: sk_sua_chave_secreta Content-Type: application/json # Consultar transação POST https://api.steexpay.com.br/functions/consultarTransacao x-steex-key: pk_sua_chave_publica x-steex-secret: sk_sua_chave_secreta Content-Type: application/json # Webhook (chaves na URL de configuração) POST https://api.steexpay.com.br/functions/webhookGateway?key=pk_sua_chave_publica&secret=sk_sua_chave_secreta
Cria uma nova transação de pagamento. Use na etapa de confirmação do checkout.
Request Body
{
"valor": 199.90,
"forma_pagamento": "pix",
"parcelas": 1,
"cliente": {
"nome": "João Silva",
"cpf": "12345678900",
"email": "joao@email.com",
"telefone": "11999998888"
},
"produto": {
"nome": "Curso de Marketing Digital",
"valor": 199.90
},
"metadata": {
"descricao": "Compra via Zedy Checkout",
"pedido_externo": "PED-001"
}
}Response 200
{
"ok": true,
"transaction_id": "abc123def456",
"external_id": "STX-M9ABC1-XYZ789",
"status": "pendente",
"valor": 199.90,
"valor_liquido": 197.49,
"taxa_aplicada": 1.25,
"forma_pagamento": "pix",
"empresa": "Minha Loja",
"created_at": "2026-06-10T14:32:00.000Z",
"pix": {
"qrcode": "00020126580014BR.GOV.BCB.PIX0136a629...",
"transaction_id": "ID_INTERNO_ADQUIRENTE",
"valor": 199.90,
"expires_at": "2026-06-10T15:32:00.000Z"
}
}Para pagamentos PIX, a resposta inclui o objeto pix com o qrcode (BR Code / copia-e-cola) que deve ser exibido ao cliente. Para cartão e boleto, o objeto pix é omitido — consulte o status via /consultarTransacao ou aguarde o webhook.
Formas de Pagamento
Consulta o status atual de uma transação criada anteriormente.
// Por ID externo gerado pelo Steex
{
"external_id": "STX-M9ABC1-XYZ789"
}
// OU pelo ID interno
{
"transaction_id": "abc123def456"
}Response
{
"ok": true,
"transaction_id": "abc123def456",
"external_id": "STX-M9ABC1-XYZ789",
"status": "pago",
"valor": 199.90,
"valor_liquido": 197.49,
"forma_pagamento": "pix",
"pago_em": "2026-06-10T14:35:22.000Z",
"created_at": "2026-06-10T14:32:00.000Z"
}Endpoint que recebe notificações automáticas dos checkouts (Vega, Adoorei, Zedy, Corvertex). Configure a URL nos painéis de cada checkout para receber atualizações de status em tempo real.
Vega Checkout
https://api.steexpay.com.br/functions/webhookGateway?key=pk_sua_chave&secret=sk_sua_chave
Configurar em: Webhooks → Adicionar Webhook
Adoorei
https://api.steexpay.com.br/functions/webhookGateway?key=pk_sua_chave&secret=sk_sua_chave
Configurar em: Configurações → Webhook
Zedy
https://api.steexpay.com.br/functions/webhookGateway?key=pk_sua_chave&secret=sk_sua_chave
Configurar em: Gateways → Webhook URL
Corvex
https://api.steexpay.com.br/functions/webhookGateway?key=pk_sua_chave&secret=sk_sua_chave
Configurar em: Integrações → Notificações
Detecção Automática de Origem
O endpoint detecta automaticamente a origem do payload e normaliza os dados para o formato interno. Suporta idempotência — reenvios do mesmo evento são ignorados ou apenas atualizam o status.
Notificação de saída (Webhook do Checkout)
Quando um pagamento é confirmado, a SteexPay envia um POST para a URL cadastrada no painel (API Keys → Webhook do Checkout), assinado com x-steex-signature: sha256=HMAC-SHA256(body, webhook_secret). Use isto para Nuvorafy e outros checkouts que esperam receber o webhook do gateway.
{
"event": "payment.paid",
"transaction_id": "abc123def456",
"external_id": "STX-M9ABC1-XYZ789",
"status": "pago",
"valor": 199.90,
"valor_liquido": 197.49,
"forma_pagamento": "pix",
"parcelas": 1,
"cliente_nome": "João Silva",
"cliente_cpf": "12345678900",
"cliente_email": "joao@email.com",
"produto_nome": "Curso de Marketing",
"pago_em": "2026-08-26T13:00:00.000Z"
}Vega Checkout
Configure em Adquirentes → Selecione seu Gateway → insira a Chave Pública e Chave Secreta.
Adoorei
Vá em Configurações → Webhook → cadastre a URL do endpoint webhookGateway com ?key=pk_sua_chave&secret=sk_sua_chave.
Zedy
Em Gateways → localize seu gateway → insira Chave Pública, Chave Secreta e Taxa de Parcelamento.
Corvex
Nas configurações de gateway do Corvex, informe a Chave Pública no campo "public_key" e a URL base da API.
Nuvorafy
Solicite a integração em nuvorafy.com/integrar-gateway (Gateway: Steex Pay, Whitelabel: seu gateway, Doc: esta página). No painel Steex → API Keys → Webhook do Checkout, cole a URL de notificação que a Nuvorafy fornecer e compartilhe o Webhook Secret. A SteexPay envia um POST assinado (x-steex-signature HMAC-SHA256) a cada pagamento confirmado.
Exemplo de integração (Zedy / Vega)
// No checkout externo, ao confirmar um pedido:
const response = await fetch('https://api.steexpay.com.br/functions/criarTransacao', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'x-steex-key': 'pk_sua_chave_publica',
'x-steex-secret': 'sk_sua_chave_secreta'
},
body: JSON.stringify({
valor: 299.90,
forma_pagamento: 'cartao_credito',
parcelas: 3,
cliente: {
nome: 'Maria Santos',
cpf: '98765432100',
email: 'maria@email.com'
},
produto: { nome: 'Produto Premium' }
})
});
const data = await response.json();
// data.transaction_id — salve para consultas futuras
// data.external_id — ID gerado pelo Steex| Status Steex | Vega | Adoorei | Zedy / Corvex |
|---|---|---|---|
| pago | approved | approved | paid / approved |
| pendente | pending | pending / in_analysis | pending |
| cancelado | refused / canceled | refused / cancelled / failed | refused / canceled |
| estornado | refunded | refunded | refunded |
| chargeback | charge_back | chargeback | chargeback |