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/:id

​
Headers

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

​
Parametro de rota

  • id: identificador publico no formato bill_*.

​
Regras

  • Se o formato do id for invalido, retorna 422 INVALID_CHECKOUT_ID.
  • Se o checkout nao existir para o merchant autenticado, retorna 404 CHECKOUT_NOT_FOUND.

​
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
}

​
Erros do recurso

HTTPcodeQuando ocorre
422INVALID_CHECKOUT_IDid sem prefixo bill_ ou vazio apos prefixo.
404CHECKOUT_NOT_FOUNDCheckout inexistente para o merchant autenticado.

​
Observacao de semantica

  • bill_* e o identificador publico canonico do recurso checkout.
  • A URL /c/session/:sessionId e a superficie renderizada atual do frontend.
  • Isso nao redefine a semantica publica de /v1/checkouts.
Last modified on May 8, 2026