Introdução
O que a API faz, por onde começar e onde estão as URLs da sua integração.
A API da Gates2b recebe pagamentos por PIX, boleto e cartão e cripto, cobra assinaturas recorrentes e avisa o seu sistema, por webhook, quando o dinheiro entra. Esta documentação cobre tudo o que você precisa para integrar pelo backend.
Comece por aqui
Uma integração completa passa por quatro etapas, nesta ordem:
- Você, no painelLibere o IP do servidorSó IPs cadastrados podem usar a chave.
- Você, no painelGere a chave de APINo painel, em Integração.
- Seu servidorInscreva-se nos webhooksUma URL do seu backend recebe charge.paid.
- Seu servidorCrie cobrançasPOST /charge e o cliente paga.
Autenticação
Gere a chave de API e envie no header Authorization.
Liberação de IP
Cadastre os IPs dos seus servidores antes da primeira chamada.
Primeira cobrança
Crie uma cobrança PIX e receba a confirmação do pagamento.
Webhooks
Receba eventos assinados em vez de consultar a API.
Qual endpoint usar
| Para | Use |
|---|---|
| Cobrança avulsa, em qualquer meio de pagamento | POST /charge |
| Cobrança recorrente | POST /plan e POST /subscription |
| Consultar uma cobrança pelo seu número de pedido | GET /charge?externalReference= |
| Reembolsar uma cobrança | POST /charge/{chargeId}/refund |
| Saber quando uma cobrança foi paga | POST /webhook-subscriptions |
| Testar se a chave de API está válida | GET /api-key/validate |
Os endpoints de invoices (/invoices, /refunds/invoice) atendem integrações
antigas. Integração nova usa /charge.
URL base
Todas as chamadas vão para:
"https://api.gates2b.com"O painel, onde você gera a chave e cadastra IPs, fica em https://painel.gates2b.com.
Convenções
- Toda requisição e toda resposta é JSON. Envie
Content-Type: application/json. - Não envie corpo em
GET: a requisição é recusada com403. - Valores em dinheiro de cobranças e reembolsos são strings com duas casas
decimais (
"10.00"). Planos usam inteiro em centavos (amountCents: 9990). - Datas seguem ISO 8601. Os endpoints de cobrança e assinatura respondem em UTC; os de invoice, no horário de Brasília (UTC−3).
- Ids de cobrança, assinatura e inscrição de webhook são strings (ULID ou UUID). Ids de invoice são inteiros.
Integração com assistentes de IA
A doc inteira está disponível em texto para Cursor, Claude Code, Copilot e afins:
/llms.txt: índice das páginas./llms-full.txt: todo o conteúdo, com o contrato de cada endpoint.- Qualquer página em markdown: acrescente
.mdao endereço (por exemplo,/guias/autenticacao.md).