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

Orders

Download schema

Get order

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

Fetch a single order by Clearway order id.

Get order › Headers

x-cid
​string

Optional correlation id for support trails.

x-brand-id
​string

Optional platform brand slug for multi-brand merchants.

Get order › Request Body

orderId
​string
Additional properties are allowed

Get order › Responses

Success

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

Read orders

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

List settled orders and fetch individual order records for revenue integrations.

Read orders › Headers

x-cid
​string

Optional correlation id for support trails.

x-brand-id
​string

Optional platform brand slug for multi-brand merchants.

Read orders › Request Body

limit
​number
status
​string
lookbackDays
​number
Additional properties are allowed

Read orders › Responses

Success

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

CustomersPayment links