Introdução à API ActivePayments

Bem-vindo à documentação da API ActivePayments. Aqui você encontrará tudo que precisa para integrar pagamentos PIX em sua aplicação de forma rápida e segura.

Por que usar ActivePayments?

Integração Rápida

API REST simples com documentação completa. Comece a receber pagamentos em minutos.

Segurança

Autenticação via API Keys, HTTPS obrigatório e webhooks assinados com HMAC.

Webhooks em Tempo Real

Receba notificações instantâneas quando pagamentos forem confirmados.

Dashboard Completo

Acompanhe todas as transações, gere relatórios e gerencie sua conta.

URL Base

Todas as requisições à API devem ser feitas para a seguinte URL base:

https://api.activepayments.com.br/api/v1

Ambiente de TestesPara testes, utilize o ambiente sandbox com suas credenciais de teste.

Endpoints Disponíveis

A API ActivePayments oferece os seguintes endpoints para integração:

POST/v1/charges

Cria uma nova cobrança PIX e retorna o QR Code para pagamento

POST/v1/charges/billet

Cria uma cobrança via Boleto Bancário

GET/v1/charges/:id

Consulta o status de uma cobrança específica

GET/v1/transactions

Lista todas as transações com paginação e filtros

GET/v1/balance

Consulta o saldo disponível e pendente da conta

Primeiros Passos

Siga os passos abaixo para começar a receber pagamentos:

Crie sua conta

Cadastre-se na plataforma ActivePayments e complete o processo de verificação KYC para ativar sua conta.

Gere suas API Keys

Acesse o Dashboard e gere suas credenciais de API. Você receberá uma public_key e um secret.

Configure seu Webhook

Configure um endpoint para receber notificações de pagamentos confirmados. Veja mais em Webhooks.

Faça sua primeira cobrança

Use o endpoint POST /v1/charges para criar sua primeira cobrança PIX e teste o fluxo completo.

Próximo passoAprenda sobre Autenticação para começar a usar a API.