Documentação da API
Receba e envie Pix com poucas linhas de código.
A API da Mainum cria cobranças Pix com QR Code, avisa por webhook quando o dinheiro cai e envia saques para qualquer chave. Valores sempre em centavos, respostas em JSON, uma chave por ambiente.
- Crie uma chave em Painel → Integrações. Chaves
gw_test_não movimentam dinheiro. - Crie a cobrança com
POST /v1/chargese mostre o QR Code ao seu cliente. - Receba o webhook
charge.paidcom a cobrança completa, incluindo quem pagou.
Primeira cobrança
curl -X POST "https://api.mainumpay.com/v1/charges" \
-H "Authorization: Bearer $MAINUM_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"external_id": "pedido-48213",
"amount_cents": 4990,
"description": "Plano Pro mensal"
}'Resposta 201 (resumida)
{
"id": "0192a7c4-5b1e-7d3a-9f10-6c2e8b4d1a77",
"status": "PENDING",
"amount_cents": 4990,
"expires_at": "2026-09-24T15:02:11.000Z",
"pix": {
"copy_paste": "00020101021226870014br.gov.bcb.pix2565qr.mainumpay.com/v2/cobv/9d3e4a6f520400005303986540649.905802BR5913LOJA EXEMPLO6009SAO PAULO62070503***6304A1F3"
}
}Recursos
Checkout
NOVOPOSTGET
Loja
NOVOGET
Cobranças
NOVOQR Code, copia-e-cola, vencimento, quem pagou segundo o banco e o ID fim a fim do Pix.
GETPOST
Financeiro
Saldo disponível, a liberar e reservado, transações e cada lançamento do extrato.
GET
Saques
NOVOEnvie para qualquer chave Pix e acompanhe recebedor, banco e resultado.
GETPOST
MED
Casos de devolução especial, valores bloqueados e exposição em aberto.
GET
Eventos
NOVOOs mesmos eventos dos webhooks, consultáveis para conciliar o que você perdeu.
GET
Webhooks
Eventos assinados com HMAC, com o objeto completo em data.object.
Pagamentos, Cartão, Assinaturas, Pagar Pix, Saques cripto
EM BREVEContratos já publicados para você planejar. As rotas ainda respondem 404.