Criar venda

post

https://gateway-sandbox.cyclopay.com/v1/charges

Permite criar uma vendas para todas as modalides de pagamento.

Recipes

💳

💳 Primeira venda com cartão

Open Recipe

⚡

⚡ Primeira venda com Pix

Open Recipe

📅

📅 Criando um Pix com vencimento

Open Recipe

📄

📄 Criando uma cobrança com boleto

Open Recipe

🔐

🔐 Realizando um pagamento autenticado com 3DS

Open Recipe

💳

Criar uma Venda com SmartForm

Open Recipe

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

👍
Exemplo de requisição
Na direita dessa página é possível visualizar de forma direta, diversos exemplos de requisição e resposta da API 👉.

Primeiros passos

👍
Antes de gerar sua primeira venda, recomendamos fortemente que leia as seções explicativas para cada meio de pagamento.
No menu a esquerda você irá encontrar as opções:

Cartão de Crédito e Débito

Pix e Boleto

Checkout e Link de pagamento

Cobrança da Venda

📘
Ao criar uma venda, já será realizado a cobrança em conjunto. No caso de cartão haverá a cobrança de imediata, e Pix e Boleto a geração dos Códigos/QR Code.

Body Params

amount

integer

required

Valor da cobrança

order_id

string

required

Código de referência da cobrança. 1–36 caracteres: letras, números, hífen e dois-pontos.

checkout_template_uuid

string

Identificador único do template. Campo obrigatório para links de pagamento. type:"PAYMENTLINK"

order_info

string

campo livre para descrição da cobrança.

currency

string

enum

required

Tipo de moeda utilizada no pagamento. Padrão AlphaCode ISO 4217. Para R$ = "BRL"

Allowed:

type

string

enum

required

Tipo de cobrança que será realizado.

Allowed:

soft_descriptor

string

informação a ser exibida na fatura do portador. Máximo 13 Caracteres. EX.: LOJALYRACOLLC

payments

array of objects

required

Array de objetos para enviar os dados do meio de pagamento e cobrança.

payments*

customer

object

Informações do comprador

billing_address

object

Endereço de cobrança

shipping_address

object

Endereço de entrega

client_ip

string

Endereço IP

expiry_date

string

data de expiração da venda

split

array of objects

dados para realizar a divisão do split de pagamento

split

payments_supported

array of strings

Campo utilizado para mostrar as bandeiras aceitas. Campo compatível apenas utilizando: "payment_method": "smartform"

payments_supported

payment_settings

object

Campo utilizado para configurações do link de pagamento. Campo compatível apenas utilizando: "type": "PAYMENTLINK",

Headers

api_key

string

required

Idempotency-Key

uuid

Opcional. UUID que identifica a solicitação de criação da Venda. Para repetir a mesma solicitação, preserve a chave e os dados enviados. A repetição concluída retorna a Venda em seu estado atual com HTTP 201.

Responses

409

Conflito de idempotência: chave reutilizada com payload diferente, solicitação ainda em processamento, solicitação anterior marcada como falha ou resultado indisponível.

Primeiros passos

Cobrança da Venda

201201

400400