Skip to main content

Approvely Checkout API

This section documents the live Checkout API surface: tokenization, charging stored tokens, and hosted payment links.

What is documented here​

AreaEndpoints
TokenizationPOST /v1/tokenization/create-session, POST /v1/tokenization/tokenize
CheckoutPOST /v1/checkout, POST /v1/checkout/card-token
Payment linksPOST /v1/payment-links, GET /v1/payment-links/{id}

The OpenAPI source of truth is checkout-api's own spec, consolidated into the Checkout API reference by this site's documentation pipeline (ENG-1579). An aspirational Gateway v3 MVP surface is not published here.

Quick start​

  1. Pick an environment base URL.
  2. Read authentication for credential guidance.
  3. See the Checkout API reference for request/response schemas and to try requests directly.
  4. Handle errors using the shared { code, message } shape — see errors.

In-service docs​

Every deployed stage also serves:

  • GET /docs — Swagger UI (as-built primary)
  • GET /openapi — JSON list of available specs
  • GET /openapi?spec=openapi — raw as-built YAML
  • GET /health — liveness + deploy-identity probe (status, stage, coinflowEnv, datadogEnv); shallow, no DB or upstream calls