Documentação da GO3PAY API
Integre pagamentos ao seu sistema em horas. Nossa API RESTful foi construída para desenvolvedores que exigem segurança, estabilidade e velocidade.
Latência média
< 100ms
Criptografia
TLS 1.3
Uptime SLA
99.99%
Autenticação
Bearer Token
Visão Geral
A GO3PAY API é uma interface RESTful proprietária que permite integrar pagamentos diretamente ao seu sistema. Todas as requisições utilizam HTTPS e retornam dados em formato JSON.
Pagamentos
PIX, Cartão de Crédito, Boleto Bancário
Split
Divisão automática entre múltiplos recebedores
Webhooks
Notificações em tempo real por eventos
Base URL: https://api.go3pay.com.br/v1
Formato: JSON · HTTPS obrigatório
Versão atual: v1
Autenticação
A API usa Bearer Token para autenticação. Sua chave secreta deve ser enviada no header Authorization em todas as requisições. Nunca exponha sua chave secreta no frontend.
Chave de Teste
sk_test_xxxxxxxxxxxxxxxxxxxxUse para desenvolver e testar.
Chave de Produção
sk_live_xxxxxxxxxxxxxxxxxxxxUse apenas em produção.
# Exemplo de autenticação via cURL
curl https://api.go3pay.com.br/v1/charges \
-H "Authorization: Bearer sk_live_xxxxxxxxxxxxxxxxxxxx"Criar Cobrança
/v1/chargesCria uma nova cobrança. O campo payment_method determina o método de pagamento utilizado.
Parâmetros do Body
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| amount | integer | Sim | Valor em centavos (ex: 10000 = R$ 100,00) |
| currency | string | Sim | Moeda. Atualmente apenas "BRL" |
| payment_method | string | Sim | "credit_card", "pix" ou "boleto" |
| description | string | Não | Descrição da cobrança |
| customer.name | string | Sim | Nome completo do cliente |
| customer.email | string | Sim | E-mail do cliente |
| customer.document | string | Sim | CPF ou CNPJ do cliente |
Requisição
curl -X POST https://api.go3pay.com.br/v1/charges \
-H "Authorization: Bearer sk_live_xxxxxxxxxxxxxxxxxxxx" \
-H "Content-Type: application/json" \
-d '{
"amount": 10000,
"currency": "BRL",
"payment_method": "credit_card",
"description": "Pedido #1042",
"customer": {
"name": "Maria Santos",
"email": "maria@email.com",
"document": "123.456.789-00"
}
}'Resposta 200 OK
{
"id": "ch_9f900a8bee294089bcb3",
"object": "charge",
"status": "approved",
"amount": 10000,
"currency": "BRL",
"payment_method": "credit_card",
"description": "Pedido #1042",
"created_at": "2026-06-25T14:30:00Z",
"approved_at": "2026-06-25T14:30:01Z",
"customer": {
"id": "cus_xxxxxxxxxxxxxxxxxxx",
"name": "Maria Santos",
"email": "maria@email.com"
},
"card": {
"brand": "visa",
"last4": "4242",
"exp_month": 12,
"exp_year": 2028
}
}PIX
/v1/chargesGera uma cobrança via PIX com QR Code. O status inicial é pending e muda para approved após o pagamento confirmado via Webhook.
Requisição
curl -X POST https://api.go3pay.com.br/v1/charges \
-H "Authorization: Bearer sk_live_xxxxxxxxxxxxxxxxxxxx" \
-H "Content-Type: application/json" \
-d '{
"amount": 15000,
"currency": "BRL",
"payment_method": "pix",
"expires_in": 3600,
"description": "Pedido #1043",
"customer": {
"name": "João Ferreira",
"document": "98.765.432-10"
}
}'Resposta
{
"id": "ch_a1b2c3d4e5f6g7h8i9j0",
"object": "charge",
"status": "pending",
"amount": 15000,
"payment_method": "pix",
"pix": {
"qr_code": "00020126360014BR.GOV.BCB...",
"qr_code_url": "https://api.go3pay.com.br/v1/pix/qr/...",
"expires_at": "2026-06-25T15:30:00Z"
}
}Criar Split
/v1/chargesDivida o valor de uma cobrança entre múltiplos recebedores no momento da transação. Ideal para marketplaces, plataformas e infoprodutores.
liable e charge_processing_fee definem quem é responsável por chargebacks e taxas.curl -X POST https://api.go3pay.com.br/v1/charges \
-H "Authorization: Bearer sk_live_xxxxxxxxxxxxxxxxxxxx" \
-H "Content-Type: application/json" \
-d '{
"amount": 10000,
"payment_method": "credit_card",
"split_rules": [
{
"recipient_id": "re_xxxxxxxxxxxxxxxx",
"amount": 8000,
"liable": true,
"charge_processing_fee": true
},
{
"recipient_id": "re_yyyyyyyyyyyyyyyy",
"amount": 2000,
"liable": false,
"charge_processing_fee": false
}
]
}'Webhooks
Webhooks permitem que sua aplicação receba notificações em tempo real quando eventos ocorrem na sua conta. Configure sua URL no painel GO3PAY.
Eventos Disponíveis
| Evento | Descrição |
|---|---|
| charge.approved | Cobrança aprovada com sucesso |
| charge.refused | Cobrança recusada pela adquirente |
| charge.refunded | Cobrança estornada |
| charge.chargeback | Chargeback iniciado pelo portador do cartão |
| pix.received | Pagamento PIX recebido e confirmado |
| boleto.paid | Boleto bancário pago |
| split.processed | Split de pagamento processado |
Payload de exemplo
{
"id": "evt_xxxxxxxxxxxxxxxxx",
"object": "event",
"type": "charge.approved",
"created_at": "2026-06-25T14:30:01Z",
"data": {
"object": {
"id": "ch_9f900a8bee294089bcb3",
"status": "approved",
"amount": 10000,
"payment_method": "credit_card"
}
}
}Códigos de Erro
A API usa os códigos de status HTTP padrão para indicar o resultado de uma requisição.
| Código | Status | Descrição |
|---|---|---|
| 200 | OK | Requisição realizada com sucesso |
| 201 | Created | Recurso criado com sucesso |
| 400 | Bad Request | Parâmetros inválidos ou ausentes |
| 401 | Unauthorized | Chave de API inválida ou ausente |
| 402 | Payment Required | Cobrança recusada pelo emissor |
| 404 | Not Found | Recurso não encontrado |
| 422 | Unprocessable | Dados corretos mas regra de negócio violada |
| 429 | Rate Limited | Muitas requisições. Aguarde e tente novamente |
| 500 | Server Error | Erro interno. Contate o suporte GO3PAY |
Rate Limits
Para garantir a estabilidade da plataforma, aplicamos limites por chave de API. Os limites são informados nos headers de resposta.
Requisições por segundo
100 req/s
Requisições por minuto
1.000 req/min
Requisições por hora
50.000 req/h
HTTP/1.1 200 OK
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 943
X-RateLimit-Reset: 1719324660SDKs & Integrações
Disponibilizamos SDKs oficiais para acelerar sua integração com a GO3PAY API.
Node.js
Disponível
PHP
Disponível
Python
Em breve
Java
Em breve
Pronto para integrar?
Abra sua conta, obtenha suas chaves de API e comece a processar pagamentos hoje mesmo.
