API pública
Transações, checkout hospedado, saldo e saques em contratos documentados.
Para quem constrói
Uma integração clara.De ponta a ponta.
Comece pelo contrato, preserve a intenção e acompanhe os eventos. A documentação explica o caminho entre sua aplicação e a Akkro.
Feita para conectarakkro / integração
POST /v1/transactionsHost: api.akkropay.appx-api-key: <SUA_CHAVE_NO_SERVIDOR>X-Idempotency-Key: <CHAVE_DO_PEDIDO>Content-Type: application/json { "amount": 27900, "paymentMethod": "pix", "customer": { "name": "Exemplo", "email": "demo@example.com", "document": { "type": "cpf", "number": "<CPF_DO_CLIENTE>" } }, "items": [{ "title": "Exemplo", "unitPrice": 27900, "quantity": 1, "tangible": true }]}api.akkropay.appExplorar documentação
Exemplo de leitura. Consulte o contrato completo antes de integrar. Não há ambiente público de testes.
Uma solicitação, uma identidade.
Cada passagem tem uma responsabilidade. Explore o contrato antes de conectar sua aplicação.
Idempotência
Uma chave identifica a intenção financeira nas novas tentativas de criação.
Webhooks
Receba eventos, valide a assinatura quando configurada e trate a entrega com segurança.
Boas decisões começam com boas respostas.
Prepare a autenticação, as novas tentativas e os eventos que conectam seu backend ao pagamento.
Aprofunde na documentação01Posso colocar a chave da API no navegador?
Não. A credencial da API de pagamentos deve ficar no backend, fora do JavaScript público, de repositórios e de logs. Separe o que o comprador vê do código que autoriza a operação. Se uma credencial for exposta, substitua-a e revise seu uso.
Entender este ponto02Como tratar uma nova tentativa sem duplicar a cobrança?
Para repetir a mesma intenção financeira, preserve a X-Idempotency-Key e siga as regras do endpoint. Um timeout não prova que a operação falhou: consulte o estado antes de iniciar outra intenção. Uma cobrança diferente precisa ser tratada como uma nova operação.
Entender este ponto03Como meu sistema confirma o pagamento com segurança?
Receba os webhooks no backend, valide a assinatura quando houver segredo configurado e trate eventos repetidos de forma idempotente. Relacione o evento à referência do pedido e consulte a transação quando necessário. O retorno visual do comprador, sozinho, não deve liberar o pedido.
Entender este ponto04Como investigo uma venda pendente ou divergente?
Localize a transação pela referência, confira o estado e os registros disponíveis e compare com o pedido no seu sistema. A consulta da transação pela API complementa os eventos recebidos. Evite concluir que um pagamento falhou apenas porque seu sistema ainda não recebeu uma notificação.
Entender este ponto05As demonstrações movimentam dinheiro? Existe sandbox?
As demonstrações usam registros fictícios e não fazem solicitações financeiras. Elas ajudam a entender a jornada, mas não são um ambiente de teste da API. A documentação Akkro utiliza produção; não há ambiente público de staging ou sandbox. Planeje qualquer validação real antes de executá-la.
Entender este pontoO próximo capítulo da sua operação começa aqui.
Conheça a plataforma Akkro e acompanhe seus pagamentos com contexto.