🔧Desenvolvedores/Integrações

Bem-vindo à documentação oficial da GoPag API! Esta API foi desenvolvida para facilitar a integração de soluções de pagamento em sua aplicação.

🎯 Objetivo

Prover uma camada de abstração e segurança para acesso aos serviços de pagamento da GoPag, permitindo que:

• Partner (Marketplaces) integrem seus sistemas com a plataforma de pagamentos e gerenciem seus sellers e transações de forma isolada e segura

• Clientes Finais acessem funcionalidades de pagamento de forma simplificada

🔐 Modelo de Autenticação e Segurança

Marketplace Token (Atual)

O sistema utiliza um modelo de marketplace virtual onde cada parceiro possui:

• Token de Marketplace: Autenticação via OAuth2 (Bearer token) com certificado mTLS

• Escopo Limitado: Acesso restrito apenas aos sellers dentro do escopo do partner

• Marketplace Virtual: Cada parceiro opera em seu próprio "marketplace" com gestão independente

🚀 Principais Funcionalidades

📊 Gestão de Transações

• Criação de transações (cartão, boleto, Pix)

• Consulta de transações individuais e em lote

• Captura de transações pré-autorizadas

• Histórico completo de transações por seller

🖥️ Gestão de Terminais

Gerenciamento de dispositivos de pagamento:

• Físicos: Maquininhas tradicionais

• Virtuais:

  • Tap2Pay (pagamento por aproximação)

  • Aplicativos Android/iOS

• Pareamento de terminais

• Monitoramento de status

👥 Gestão de Sellers

• Listagem de sellers do marketplace

• Consulta de dados individuais

• Busca por CPF/CNPJ

💳 Gestão de Compradores (Buyers)

• CRUD completo de compradores

• Busca por CPF/CNPJ

• Validação de dados cadastrais

🔄 Fluxos de Pagamento Suportados

Fluxo Tradicional

• Cartão de Crédito/Débito: Transações com captura imediata ou posterior

• Boleto Bancário: Geração e consulta de boletos

• Pix: Pagamentos instantâneos via QR Code ou Pix Copia e Cola

Fluxo Inteligente

• Cadastro de Link de Pagamento: Criação automatizada de métodos de pagamento

• Tap2Pay: Integração nativa para pagamentos por aproximação

📚 Índice

Introdução e Aspectos Gerais

• Introdução

• Requisitos de Segurança

• Autenticação

• Testando a API

• Códigos de Erro

Cadastro e Credenciamento

Vendedores

• Listando Vendedores

• Buscando Vendedor por CPF/CNPJ

• Recuperar Detalhes de Vendedor

• Categoria MCC (Merchant Category Codes)

Compradores

• Gerenciar Compradores

Transações

• Listar Transações

• Recuperar Detalhes de Transação

• Capturar Transação

• Tokenizar Cartão

Criar Transação - Via API

• Cartão de Crédito/Débito

• PIX

• Boleto e Bolepix

Criar Transação - Payment Locales

• MPOS

• Tap to Pay (NFC)

• PINPAD

• Link de Pagamento

🚀 Começando

Para começar a usar a GoPag API, você precisará:

1. Bearer Token: Obtido via Portal GoPag ou enviado pela GoPag (Entre em contato para solicitar)

2. Certificado mTLS: Certificado ICP-Brasil para autenticação bidirecional

3. Marketplace ID: Identificador único do seu marketplace

4. Ambiente: URLs de homologação e produção

Consulte a seção Autenticação para mais detalhes.

🔒 Segurança

A GoPag API utiliza:

• Bearer Token: Autenticação via OAuth 2.0

• mTLS (Mutual TLS): Autenticação bidirecional com certificados ICP-Brasil

• Isolamento por Marketplace: Cada marketplace só acessa seus próprios dados

📞 Suporte

Para suporte técnico, dúvidas sobre integração ou solicitação de credenciamento:

📧 Email: [email protected]