Desenvolvedores
Integre a MinePag ao seu site, ao seu servidor ou a um serviço de entrega próprio.
A MinePag tem uma API REST e webhooks assinados para quem quer ir além da vitrine: montar o checkout no próprio site, sincronizar pedidos com outro sistema ou entregar produtos por um serviço próprio.
O que você pode fazer
- Checkout no seu site: liste produtos, monte o carrinho e feche o pedido pela API, usando os gateways conectados na loja. Veja Checkout pela API.
- Integrar pedidos e clientes: consulte pedidos, faça reembolsos totais ou parciais, mantenha o cadastro de clientes em dia e confira os acessos liberados. Veja Pedidos, clientes e acessos liberados.
- Reagir a eventos: receba
order.paid,entitlement.revoked,subscription.renewede outros eventos por webhook. Os endpoints podem ser cadastrados no painel ou pela API. - Gerenciar assinaturas: consulte e cancele assinaturas pela API.
- Entregar por um serviço externo: receba
delivery.requestede confirme comPOST /deliveries/{id}/complete. Veja Serviços externos.
Primeira chamada
Crie uma chave em Desenvolvedores › Chaves de API e confira se ela funciona:
const response = await fetch('https://minepag.com.br/api/v1/me', {
headers: { Authorization: `Bearer ${process.env.MINEPAG_SECRET_KEY}` }
});
const { data } = await response.json();
console.log(data.project.name, data.apiKey.scopes);Convenções da API
| Item | Regra |
|---|---|
| Endereço base | https://minepag.com.br/api/v1 |
| Autenticação | Authorization: Bearer <chave> com chave publicável (pk_…) ou secreta (sk_…) |
| Formato | JSON, com resposta no envelope { "data": …, "meta": { "requestId": … } } |
| Dinheiro | Inteiros em centavos de real (4990 = R$ 49,90) |
| Datas | ISO 8601 com fuso (2026-10-12T14:30:00.000Z) |
| Paginação | limit e cursor; a próxima página vem em meta.pagination.nextCursor |
| Idempotência | Cabeçalho Idempotency-Key nas rotas que criam algo; obrigatório no checkout e no reembolso |
| Erros | Código estável em error.code, mensagem em português e requestId para o suporte |
Chave secreta só no servidor
A chave secreta dá acesso a clientes, pedidos e reembolsos. Nunca a coloque no navegador, no app ou no plugin. Requisições de navegador com chave secreta são recusadas.
Próximos passos
Autenticação
Tipos de chave, escopos e boas práticas.
Convenções da API
Envelope, paginação, idempotência e limites.
Checkout pela API
Catálogo, carrinho e pagamento no seu site.
Webhooks
Eventos assinados no padrão Standard Webhooks.
Eventos
Catálogo de eventos com exemplos.
Erros
Todos os códigos de erro e como tratar.
Referência da API
Cada rota, com parâmetros e respostas.