Skip to main content
Este endpoint permite que o frontend recupere os dados do checkout usando o client_secret, sem necessidade de autenticação por token OAT. Ideal para renderizar a interface de pagamento no lado do cliente. A resposta inclui campos extras computados pelo servidor: installment_options (opções de parcelamento calculadas sempre que o checkout possui um valor — o frontend decide se exibe o seletor), product_image_url (URL da primeira mídia do produto) e organization_avatar_url.

​
Autenticação

Nenhuma autenticação necessária. O client_secret serve como credencial de acesso temporária ao checkout.

​
Parâmetros de Path

​
client_secret
string
required
Client secret do checkout

​
Resposta

CampoTipoDescrição
idstringID do checkout
statusstringStatus atual
product_price_idstringID do preço do produto
amountintegerValor em centavos
currencystringMoeda
productobjectDados do produto (nome, descrição, mídias)
organizationobjectDados da organização (nome, avatar)
customer_emailstringEmail do cliente (se informado)
discountobjectDesconto aplicado (se houver)
expires_atstringData/hora de expiração
installment_optionsarray|nullOpções de parcelamento calculadas sempre que o checkout possui um amount. Para assinaturas mensais via Zoop o servidor retorna as opções normalmente; o frontend decide se exibe o seletor (normalmente oculto e fixado em 1x nesses casos). null quando amount é nulo.
max_installmentsinteger|nullNúmero máximo de parcelas disponível para o valor do checkout
product_image_urlstring|nullURL da imagem principal do produto
organization_avatar_urlstring|nullURL do avatar da organização

​
Exemplo

curl -X GET https://api.chargefy.io/api/v1/checkouts/client/chk_secret_xyz789

​
Resposta de Exemplo

{
  "id": "chk_1a2b3c4d5e6f",
  "status": "open",
  "product_price_id": "pp_abc123",
  "amount": 9900,
  "currency": "BRL",
  "customer_email": "[email protected]",
  "product": {
    "id": "prod_123",
    "name": "Plano Pro",
    "description": "Acesso completo a todas as funcionalidades"
  },
  "organization": {
    "name": "Minha Empresa"
  },
  "discount": null,
  "expires_at": "2026-03-12T10:30:00Z",
  "installment_options": [
    { "installments": 1, "installment_amount": 9900, "total_amount": 9900, "interest_rate": 0 },
    { "installments": 2, "installment_amount": 5048, "total_amount": 10096, "interest_rate": 1.99 }
  ],
  "max_installments": 12,
  "product_image_url": "https://cdn.chargefy.io/products/plano-pro.png",
  "organization_avatar_url": "https://cdn.chargefy.io/orgs/logo.png"
}
O client_secret expira junto com o checkout. Após a expiração, este endpoint retorna 404 Not Found.