GO3PAY Documentação da API
    v1 · EstávelAcessar Dashboard
    API RESTful Proprietária

    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.

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

    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_xxxxxxxxxxxxxxxxxxxx

    Use para desenvolver e testar.

    Chave de Produção

    sk_live_xxxxxxxxxxxxxxxxxxxx

    Use apenas em produção.

    bash
    # Exemplo de autenticação via cURL
    curl https://api.go3pay.com.br/v1/charges \
      -H "Authorization: Bearer sk_live_xxxxxxxxxxxxxxxxxxxx"

    Criar Cobrança

    POST/v1/charges

    Cria uma nova cobrança. O campo payment_method determina o método de pagamento utilizado.

    Parâmetros do Body

    ParâmetroTipoObrigatórioDescrição
    amountintegerSimValor em centavos (ex: 10000 = R$ 100,00)
    currencystringSimMoeda. Atualmente apenas "BRL"
    payment_methodstringSim"credit_card", "pix" ou "boleto"
    descriptionstringNãoDescrição da cobrança
    customer.namestringSimNome completo do cliente
    customer.emailstringSimE-mail do cliente
    customer.documentstringSimCPF ou CNPJ do cliente

    Requisição

    bash
    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

    json
    {
      "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

    POST/v1/charges

    Gera 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

    bash
    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

    json
    {
      "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

    POST/v1/charges

    Divida o valor de uma cobrança entre múltiplos recebedores no momento da transação. Ideal para marketplaces, plataformas e infoprodutores.

    Dica: Os campos liable e charge_processing_fee definem quem é responsável por chargebacks e taxas.
    bash
    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

    EventoDescrição
    charge.approvedCobrança aprovada com sucesso
    charge.refusedCobrança recusada pela adquirente
    charge.refundedCobrança estornada
    charge.chargebackChargeback iniciado pelo portador do cartão
    pix.receivedPagamento PIX recebido e confirmado
    boleto.paidBoleto bancário pago
    split.processedSplit de pagamento processado

    Payload de exemplo

    json
    {
      "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ódigoStatusDescrição
    200OKRequisição realizada com sucesso
    201CreatedRecurso criado com sucesso
    400Bad RequestParâmetros inválidos ou ausentes
    401UnauthorizedChave de API inválida ou ausente
    402Payment RequiredCobrança recusada pelo emissor
    404Not FoundRecurso não encontrado
    422UnprocessableDados corretos mas regra de negócio violada
    429Rate LimitedMuitas requisições. Aguarde e tente novamente
    500Server ErrorErro 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
    HTTP/1.1 200 OK
    X-RateLimit-Limit: 1000
    X-RateLimit-Remaining: 943
    X-RateLimit-Reset: 1719324660

    SDKs & 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.