Criar Checkout

Esta seção explica como criar uma novo Checkout e obter o checkout de pagamento para pagamento.

Visão Geral

Os checkouts de pagamento permitem que você receba pagamentos através de checkout de pagamento completo. Quando uma cobrança é criada atraves do checkout, você recebe:

• Um checkout com varias opções de pagamento (incluindo criptomoedas)
• Um metodo de integração rapido, dispensando criar um checkout para sua aplicação

Endpoint

POST /account/{account_id}/checkouts/create

Cria uma novo Checkout e retorna o checkout de pagamento para pagamento.

URL Completa:

https://app.finexis.com.br/api/v1/gateway/account/{account_id}/checkouts/create

Headers:

Authorization: Bearer {token}
Content-Type: application/json

Parâmetros da URL:

• account_id (obrigatório): ID da conta que receberá o pagamento

Body:

{
  "amount": 0.25,
  "description": "Teste com API Gateway",
  "callback_url": "https://mydomain.com/webhook/receive"
}

Campos do Body:

Campo	Tipo	Obrigatório	Descrição
amount	number	✅ Sim	Valor do checkout (decimal)
description	string	❌ Não	Descrição do checkout
callback_url	string	❌ Não	URL de notificação Webhook

Exemplo de Requisição:

curl -X POST \
  'https://app.finexis.com.br/api/v1/gateway/account/5/checkouts/create' \
  -H 'Authorization: Bearer {seu_token}' \
  -H 'Content-Type: application/json' \
  -d '{
    "amount": 0.25,
    "description": "Pagamento de serviço",
    "callback_url": "https://mydomain.com/page/payment-success"
  }'

Resposta de Sucesso (200):

{
  "status": "success",
  "message": "Charge created successfully",
  "data": {
      "id": 38,
      "account_id": 25,
      "uuid": "a4f7b597-cf59-4501-beda-c8eebebcfc5a",
      "amount": "2.99",
      "description": "Teste de callback",
      "created_at": "2025-12-16 04:28:01",
      "updated_at": "2025-12-16 04:28:01",
      "callback": "https://mydomain.com/page/payment-success",
      "url": "https://app.finexis.com.br/pay/a4f7b597-cf59-4501-beda-c8eebebcfc5f"
    }
}

Campos Importantes da Resposta

Campo	Tipo	Descrição
id	integer	ID único do checkout
account_id	integer	ID da conta
provider_id	integer	ID do provedor PIX
amount	string	Valor do checkout (alta precisão)
description	string/null	Descrição do checkout
url	string	URL do checkout de pagamento
created_at	string	Data de criação
updated_at	string	Data da última atualização