Guia de Integração
Documentação da API AurePay
Esta documentação foi pensada para acelerar a implementação: você vai encontrar os endpoints disponíveis, regras de payload, exemplos em múltiplas linguagens, formatos de erro e fluxos completos para depósitos (incluindo split de pagamentos Pix opcional), saques, conversões, webhooks e conciliação via API.
Guias e recursos
Depósitos
Pix In para recebimento de valores.
Estorno de Pix
Devolução de depósito Pix liquidado.
Saques
Pix Out para transferência de valores.
Conversões
Fluxos BRL/USDT e cotações.
Split de pagamentos
Repasse opcional a outras empresas em cada cobrança Pix.
Empresa
Dados cadastrais e saldo disponível.
Infrações e MED
Consulta, contestação e reembolso.
Carteiras
Crie carteiras com saldo isolado para separar operações por cliente, filial ou parceiro.
Webhooks
Eventos, entregas e payloads de notificação.
Sandbox
Ambiente de testes, CPFs e eventos simulados.
Para IAs
llms.txt, Markdown e OpenAPI para agentes.
SDKs
Clientes oficiais tipados multi-linguagem.
Primeiros passos
Gerar credenciais
Crie sua API Key e API Secret em Integrações > API Keys .
Configurar autenticação
Envie X-Api-Key (pk_live_/pk_test_) e X-Api-Secret (sk_live_/sk_test_) em todas as chamadas privadas.
Validar ambiente
Teste o endpoint de saldo para confirmar permissões e integração.
Base URL e autenticação
Use a URL base https://api.aurepay.com.br/v1. As rotas privadas validam os headers X-Api-Key e X-Api-Secret.
X-Api-Key: pk_live_******
X-Api-Secret: sk_live_******
Content-Type: application/jsoncurl -X GET "https://api.aurepay.com.br/v1/company/balance" \
-H "X-Api-Key: pk_live_******" \
-H "X-Api-Secret: sk_live_******" \
-H "Content-Type: application/json"Formato de resposta
O padrão de sucesso e erro segue envelope JSON no backend. Em sucesso, o campo success é true; em erro, false com detalhes em error.
{
"success": true,
"data": {
"balance": 1250.55
}
}{
"success": false,
"error": {
"code": "AUTH_FAILED",
"message": "Falha na autenticação: chave API ou secret inválido.",
"details": null
}
}Suporte técnico
Em caso de dúvidas na integração, o time técnico pode te ajudar com onboarding, debugging e validação de payloads.