Clearway Documentation
  • Home
  • Guides
  • Merchant API
  • Investor Read API
Back to Merchant APIInformation
Analytics
    Read analyticspost
Checkout
    Create checkout sessionspostCreate payment intentpost
Customers
    Manage customerspost
Orders
    Get orderpostRead orderspost
Payment links
    Create payment linkspostList payment linkspost
Payments
    Preview platform feespostProcess refundspostResolve embed displaypost
Products
    Write merchant couponspostWrite productspostDelete productpostGet productpostRead merchant couponspostRead productspostUpdate merchant couponpostUpdate productpost
Subscriptions
    Cancel subscriptionspostChange subscription planspostRead subscriptionspostPreview subscription plan changespost
Schemas
powered by Zudoku
Clearway Documentation
Clearway Documentation

Payment links

Download schema

Create payment links

POST
https://api-dev.clearway.to
/CREATE_PAYMENT_LINK

Create reusable or one-off Clearway-hosted payment links.

Create payment links › 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 links › Request Body

amount
​number
currency
​string
productName
​string
description
​string
linkUsage
​string
metadata
​object
Additional properties are allowed

Create payment links › Responses

Success

MerchantApiSuccessEnvelope
success
​boolean · required
Additional properties are allowed
POST/CREATE_PAYMENT_LINK
curl https://api-dev.clearway.to/CREATE_PAYMENT_LINK \ --request POST \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer <token>' \ --data '{ "amount": 4999, "currency": "USD", "productName": "Premium annual plan", "description": "Billed yearly", "linkUsage": "repeatable", "metadata": { "campaign": "launch-2026" } }'
Example Request Body
{ "amount": 4999, "currency": "USD", "productName": "Premium annual plan", "description": "Billed yearly", "linkUsage": "repeatable", "metadata": { "campaign": "launch-2026" } }
json
application/json
Example Responses
{ "success": true }
json
application/json

List payment links

POST
https://api-dev.clearway.to
/LIST_PAYMENT_LINKS

List your payment links with Clearway share URLs (provider fields stripped).

List payment links › Headers

x-cid
​string

Optional correlation id for support trails.

x-brand-id
​string

Optional platform brand slug for multi-brand merchants.

List payment links › Request Body

limit
​number
Additional properties are allowed

List payment links › Responses

Success

MerchantApiSuccessEnvelope
success
​boolean · required
Additional properties are allowed
POST/LIST_PAYMENT_LINKS
curl https://api-dev.clearway.to/LIST_PAYMENT_LINKS \ --request POST \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer <token>' \ --data '{ "limit": 25 }'
Example Request Body
{ "limit": 25 }
json
application/json
Example Responses
{ "success": true }
json
application/json

OrdersPayments