GET /api/v1/checkouts/

Retorna uma lista paginada de sessões de checkout

Lista todas as sessões de checkout da organização com suporte a paginação e filtros.

​

Autenticação

Requer Organization Access Token (OAT) via header Authorization: Bearer.

​

Parâmetros de Query

organization_id · string[]

Filtrar por ID da organização (pode ser repetido para múltiplos valores)

product_id · string[]

Filtrar por ID do produto

customer_id · string[]

Filtrar por ID do cliente

status · string[]

Filtrar por status do checkout. Valores: open, confirmed, succeeded, expired, failed

query · string

Busca por e-mail do cliente

page · integer · default: "1"

Número da página

limit · integer · default: "20"

Itens por página

sorting · string[] · default: "-created_at"

Ordenação. Use - para decrescente. Ex: -created_at, created_at

​

Resposta

items · array

Lista de objetos de checkout

pagination · object

Show Propriedades

total_count · integer

Número total de itens

max_page · integer

Número máximo de páginas

​

Exemplo

cURL

curl -X GET "https://api.chargefy.io/api/v1/checkouts/?page=1&limit=10&status=open" \
  -H "Authorization: Bearer $CHARGEFY_ACCESS_TOKEN"

​

Resposta de Exemplo

{
  "items": [
    {
      "id": "chk_1a2b3c4d5e6f",
      "status": "open",
      "product_price_id": "pp_abc123",
      "customer_email": "[e-mail]",
      "amount": 9900,
      "currency": "BRL",
      "success_url": "https://meusite.com/sucesso",
      "client_secret": "chk_secret_xyz789",
      "metadata": {},
      "created_at": "2026-03-12T10:00:00Z",
      "updated_at": "2026-03-12T10:00:00Z",
      "expires_at": "2026-03-12T10:30:00Z"
    }
  ],
  "pagination": {
    "total_count": 42,
    "max_page": 5
  }
}