Gerar checkout

Implemente um checkout eficiente para suas vendas

Fazendo Requisição

A chamada deverá ser feita utilizando o método POST.

POST/v1/charges

HTTP Request Body

{
  "charge": {
    "value_cents": 0,
    "description": "string",
    "callback_url": "string",
    "expiration_date": "2024-10-23T17:42:09.477Z",
    "generator_document": "string",
    "generator_name": "string",
    "payment_methods": [
      "string"
    ],
    "platform_name": "string",
    "billing_url": "string",
    "return_url": "string"
  }
}

Descrição dos atributos

ATRIBUTOS	DESCRIÇÃO	TIPO
value_cents (Obrigatório)	Valor a ser recebido	DECIMAL maior que 0
description (Obrigatório)	Descrição	STRING
callback_url	URL do webhook onde as notificações serão enviadas	STRING
expiration_date	Tempo de expiração do checkout	STRING formato datetime YYYY-mm-ddTHH:MM:ss
generator_document	Documento (CPF/CNPJ) do pagador, que será utilizado para identificação	STRING
generator_name	Nome do Pagador, que será utilizado para identificação	STRING
payment_methods (Obrigatório)	Métodos de pagamento que será utilizado no checkout: ['pix', 'crypto']	array de strings.
platform_name	Nome da plataforma que está gerando o checkout	STRING
billing_url	URL para redirecionar o usuário para a página customizada de cobrança	STRING
return_url	URL do webhook onde as notificações serão enviadas	STRING

Sucesso

Em caso de sucesso, será retornado uma mensagem HTTP 200 – OK, contendo os dados, conforme apresentado abaixo:

HTTP 200 Response Body - Exemplo

{
  "data": {
    "charge": {
      "reference_code": "string",
      "description": "string",
      "value_cents": 0,
      "created_at": "2024-10-23T17:42:09.478Z",
      "link": "string",
      "callback_url": "string",
      "payment_methods": [
        "string"
      ],
      "platform_name": "string",
      "billing_url": "string",
      "return_url": "string",
      "generated_payments": [
        {
          "id": 0,
          "ec": "string",
          "identification_code": "string",
          "value_cents": 0,
          "code": "string",
          "origin": "string",
          "status": "string",
          "payment_method": "string",
          "payment_date": "2024-10-23T17:42:09.478Z",
          "generator_name": "string",
          "generator_document": "string",
          "payer_name": "string",
          "payer_document": "string",
          "transaction_status": "string",
          "transaction_nsu": "string",
          "paid_value_cents": 0,
          "platform_name": "string",
          "billing_url": "string",
          "return_url": "string",  
          "settlement_date": "2024-10-23T17:42:09.478Z",
          "created_at": "2024-10-23T17:42:09.478Z"
        }
      ]
    },
    "status": "string"
  }
}

Eventos Notificados

• O sistema irá enviar notificações para todos os status disponíveis da transação.
• Isso vale para Checkout, PixQrCode e Cartão
• Qualquer mudança de status (Criação, confirmação, cancelamento, etc.) resultará em uma chamada ao webhook configurado na criação da transação.
• As notificações seguirão exatamente o mesmo padrão de dados já utilizados pelo webhook existente, garantindo compatibilidade e consistência na integração.

Entre nesta página para mais detalhes sobre Webhook - Notificação do checkout

Erros

Em caso de erros, será retornado um json com o atributo error especificando o motivo de a operação ter sido invalidada.

HTTP 422 Response Body - Exemplo

{
  "data": {
    "error": "string",
    "status": "string"
  }
}