Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.turbofypay.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Endpoint

GET /v1/checkouts

​
Headers

Obrigatorios:
  • x-client-id
  • x-client-secret
Scope obrigatorio: checkout:read.

​
Query params

  • limit (opcional): inteiro entre 1 e 100. Default: 20.
  • after (opcional): cursor publico bill_*.
  • id (opcional): filtra por id publico bill_*.
  • externalId (opcional): filtra por externalId publico do checkout.
  • status (opcional): PENDING | EXPIRED | CANCELLED | PAID | REFUNDED.

​
Response 200

{
  "data": [
    {
      "id": "bill_session_abc123",
      "externalId": "pedido-123",
      "url": "https://checkout.turbofy.com.br/c/session/session_abc123",
      "amount": 10000,
      "paidAmount": null,
      "items": [
        {
          "id": "price_pro",
          "quantity": 1
        }
      ],
      "status": "PENDING",
      "frequency": "ONE_TIME",
      "coupons": [],
      "devMode": false,
      "customerId": null,
      "returnUrl": "https://seusite.com/voltar",
      "completionUrl": "https://seusite.com/sucesso",
      "receiptUrl": null,
      "metadata": {
        "source": "landing-page"
      },
      "createdAt": "2026-04-13T00:00:00.000Z",
      "updatedAt": "2026-04-13T00:00:00.000Z"
    }
  ],
  "success": true,
  "error": null,
  "pagination": {
    "hasMore": false,
    "next": null,
    "before": null
  }
}

​
Paginacao

  • hasMore: indica se existe proxima pagina.
  • next: cursor para proxima pagina (ou null).
  • before: eco do cursor after usado na consulta (ou null).

​
Erros do recurso

HTTPcodeQuando ocorre
422INVALID_CHECKOUT_IDid ou after com formato publico invalido.

​
Observacao

A lista sempre retorna o DTO publico do checkout no envelope { data, success, error }, com pagination no topo da resposta.
Last modified on May 8, 2026