Primeiros passos

A API de vendas da Cyclopay foi projetada para permitir a criação e gerenciamento de cobranças de forma simples e flexível.

Nesta seção você aprenderá como:

• Criar uma venda.
• Acompanhar o status de uma venda.
• Gerenciar operações relacionadas à cobranças.

1 - Escolhendo sua integração

O primeiro passo é escolher a sua integração.

No link a seguir, temos uma explicação detalhada de cada uma: Escolha sua integração

2 - Obtendo suas chaves

Toda comunicação com a API requer uma chave de autenticação (api_key).

O que você precisa:

• Chave de API Sandbox (testes)
• Endpoint Sandbox
• Acesso ao BackOffice

No link a seguir, temos uma explicação sobre como obter as Chaves da API

3 - Criando sua primeira venda

Para iniciar uma cobrança, utilize o endpoint: /v1/charges

Esse endpoint é responsável por criar uma nova venda na plataforma.

Ao gerar uma venda, haverá uma cobrança imediatamente. Após isso ela pode:

• Ser paga novamente: em casos de recusa ou saldo pendente.
• Permanecer em aberto aguardando pagamento, para transações como Pix/Boleto.
• Definir definições de split.
• Ser consultada posteriormente.
• Ser invalidada, quando permitido (Pix/Boleto)

4 - Acompanhe o status da venda

Após a criação da venda, acompanhe a evolução da transação.

Existe algumas maneiras de fazer isso:

• Através do retorno da API.
• Painel do BackOffice.
• Webhooks.

Para mais detalhes sobre status de vendas e transações, verifique a seção específica.

5 - Ambiente de homologação

Antes de ir liberar o seu ambiente em produção, recomendamos realizar testes em ambiente de homologação para validar:

• Criação de vendas
• Fluxos de pagamento: aprovação e recusa
• Tratamento de status
• Integração de webhooks

Ofereçemos cartões de testes para o ambiente sandbox, verifique a seção especifica.

Pronto!

Acesse a seção Criar venda para gerar sua primeira cobrança utilizando a API da Cyclopay.