> ## Documentation Index
> Fetch the complete documentation index at: https://scaleup-c34c4386.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# GET /api/v1/checkouts/client/:client_secret

> Recupera um checkout pelo client secret para uso no frontend

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) 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

| Campo | Tipo | Descrição |
| - | - | - |
| `id` | `string` | ID do checkout |
| `status` | `string` | Status atual |
| `product_price_id` | `string` | ID do preço do produto |
| `amount` | `integer` | Valor em centavos |
| `currency` | `string` | Moeda |
| `product` | `object` | Dados do produto (nome, descrição) |
| `organization` | `object` | Dados da organização (nome, avatar) |
| `customer_email` | `string` | Email do cliente (se informado) |
| `discount` | `object` | Desconto aplicado (se houver) |
| `expires_at` | `string` | Data/hora de expiração |
| `installment_options` | `array\|null` | Opçõ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_installments` | `integer\|null` | Número máximo de parcelas disponível para o valor do checkout |
| `organization_avatar_url` | `string\|null` | URL do avatar da organização |

## Exemplo

```bash cURL theme={null}
curl -X GET https://api.chargefy.io/api/v1/checkouts/client/chk_secret_xyz789
```

```typescript SDK theme={null}
import { Chargefy } from '@chargefy/sdk';

const chargefy = new Chargefy();

const checkout = await chargefy.checkouts.getBySecret('chk_secret_xyz789');
```

## Resposta de Exemplo

```json theme={null}
{
  "id": "chk_1a2b3c4d5e6f",
  "status": "open",
  "product_price_id": "pp_abc123",
  "amount": 9900,
  "currency": "BRL",
  "customer_email": "cliente@exemplo.com",
  "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,
  "organization_avatar_url": "https://cdn.chargefy.io/orgs/logo.png"
}
```

> [!WARNING]
>
> O `client_secret` expira junto com o checkout. Após a expiração, este endpoint retorna `404 Not Found`.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.