Checkout

Download schema

Create checkout sessions

POST

https://api-dev.clearway.to

/CREATE_CHECKOUT_SESSION

Create Stripe Checkout Sessions (and Payment Intents; both surfaces reuse this scope).

Create checkout sessions › Headers

x-cid

string

Optional correlation id for support trails.

x-brand-id

string

Optional platform brand slug for multi-brand merchants.

Idempotency-Key

string

Stable key for safe retries on money-moving requests.

Create checkout sessions › Request Body

amount

number

currency

string

productName

string

description

string

successUrl

string

cancelUrl

string

metadata

object

Create checkout sessions › Responses

Success

MerchantApiSuccessEnvelope

success

boolean · required

POST/CREATE_CHECKOUT_SESSION

curl https://api-dev.clearway.to/CREATE_CHECKOUT_SESSION \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "amount": 2500,
  "currency": "USD",
  "productName": "30-min consultation",
  "description": "Strategy session",
  "successUrl": "https://example.com/success?session_id={CHECKOUT_SESSION_ID}",
  "cancelUrl": "https://example.com/cancel",
  "metadata": {
    "order_ref": "CONS-4821"
  }
}'

Example Request Body

{
  "amount": 2500,
  "currency": "USD",
  "productName": "30-min consultation",
  "description": "Strategy session",
  "successUrl": "https://example.com/success?session_id={CHECKOUT_SESSION_ID}",
  "cancelUrl": "https://example.com/cancel",
  "metadata": {
    "order_ref": "CONS-4821"
  }
}

json

application/json

Example Responses

{
  "success": true
}

json

application/json

Create payment intent

POST

https://api-dev.clearway.to

/CREATE_PAYMENT_INTENT

Create a Payment Intent for embedded or custom checkout integrations.

Create payment intent › Headers

x-cid

string

Optional correlation id for support trails.

x-brand-id

string

Optional platform brand slug for multi-brand merchants.

Idempotency-Key

string

Stable key for safe retries on money-moving requests.

Create payment intent › Request Body

amount

number

currency

string

productName

string

description

string

Create payment intent › Responses

Success

MerchantApiSuccessEnvelope

success

boolean · required

Analytics Customers

Create checkout sessions

POST

https://api-dev.clearway.to

/CREATE_CHECKOUT_SESSION

Create Stripe Checkout Sessions (and Payment Intents; both surfaces reuse this scope).

Create checkout sessions › Headers

x-cid

string

Optional correlation id for support trails.

x-brand-id

string

Optional platform brand slug for multi-brand merchants.

Idempotency-Key

string

Stable key for safe retries on money-moving requests.

Create checkout sessions › Request Body

amount

number

currency

string

productName

string

description

string

successUrl

string

cancelUrl

string

metadata

object

Create checkout sessions › Responses

Success

MerchantApiSuccessEnvelope

success

boolean · required

Create payment intent

POST

https://api-dev.clearway.to

/CREATE_PAYMENT_INTENT

Create a Payment Intent for embedded or custom checkout integrations.

Create payment intent › Headers

x-cid

string

Optional correlation id for support trails.

x-brand-id

string

Optional platform brand slug for multi-brand merchants.

Idempotency-Key

string

Stable key for safe retries on money-moving requests.

Create payment intent › Request Body

amount

number

currency

string

productName

string

description

string

Create payment intent › Responses

Success

MerchantApiSuccessEnvelope

success

boolean · required