Resumo para integrar
- URL base:
https://api.alphagateway.com.br. Todas as rotas começam com/v1. - Autenticação: header
x-api-keycom a API Key criada no painel, na página Integração. A mesma URL atende homologação e produção: o ambiente é o da organização dona da chave. - Formato: JSON em UTF-8 na requisição e na resposta. Valores em reais com até duas casas decimais (ex.:
49.90); datas em ISO 8601 (UTC). - Sucesso:
{ "message": "...", "response": { ... } }. - Erro:
{ "response": null, "errors": ["..."] }, com o status HTTP correspondente (400, 401, 403, 404, 409, 429, 500 ou 503). - Idempotência: cobranças, boletos e saques exigem um
idempotencyúnico por organização. Repetir a chamada com o mesmo valor não cria outra operação: a API responde 400 (409 nos links de pagamento) e o resultado da primeira chamada pode ser consultado pelo mesmoidempotency. - Confirmações: pagamentos, saques e devoluções são assíncronos. Receba o resultado por webhook (veja Configurar webhooks) ou consulte a operação pelo
idempotency. - Testes: no ambiente de homologação, as rotas de simular pagamento (em Referência da API) simulam o pagamento de cobranças e boletos sem dinheiro real.