Sobre o Gateway

O Gateway Cyclopay conecta a operação do estabelecimento aos meios e provedores de pagamento utilizados para receber vendas. Ele organiza cobranças, transações, status e permite operações posteriores para que o negócio consiga vender, acompanhar pagamentos e integrar esses eventos ao seu próprio sistema.

Basicamente, o gateway funciona da mesma forma que um orquestrador!

Um orquestrador de pagamentos é uma plataforma de software que simplifica a integração de vários provedores, incluindo gateways de pagamento, adquirentes e bancos. Essa ferramenta visa proporcionar eficiência nas transações online, fortalecendo a posição das empresas em um mercado tão competitivo.

🛒

E-commerce / Negócio

Sua loja, plataforma ou aplicação cria e acompanha pagamentos.

💻

Cyclopay Gateway

Centraliza e orquestra as operações de pagamento.

Meios de pagamentos

▰ Cartão

◆ Pix

▤ Boleto

▥

Vendas

Consolida transações, status e resultados para acompanhamento da operação.

O que o Gateway resolve

Receber

Cartões, Pix e Boleto e com experiência de checkout customizavel.

Orquestrar

Automatizar e sincronizar vendas, conectando sistema, adquirências, repasse a participantes e liquidação.

Acompanhar

Consolidar Vendas, Transações, status, webhooks e operações posteriores.

Como usar esta documentação

📘
Nosso manual não é apenas para desenvolvedores!
As páginas foram organizadas para que gestores, responsáveis por e-commerce, equipes financeiras, atendimento e tecnologia entendam o que cada recurso faz, por que existe, quando usar e qual impacto produz na operação. Os detalhes de payloads e endpoints ficam na Referência da API.

Se você quer...	Comece por
Entender o fluxo de pagamentos	Como funciona um pagamento → Vendas → Transações → Ciclo de vida.
Escolher uma forma de integração	Formas de utilização → Escolha sua integração.
Entender cartão	Cartões → Autorização e captura → Tokenização → 3DS.
Entender Pix e boleto	Pix e Boleto → tipos e modalidade correspondente.
Utilizar split de pagamentos	Split e vendedores.
Integrar ao seu sistema	Depois ler esse manual, siga para a Referência da API.

Manual e Referência da API

Manual do Usuário

Explica conceitos gerais, decisões, cenários, riscos e comportamento operacional.

Referência da API

Explica conceitos técnicos; métodos, rotas, parâmetros, tipos, enums, requests, responses e erros.

🚧
Este conjunto documenta exclusivamente o Gateway. Para o serviço exclusivo de recorrências, há documentações e APIs distintas dessa.