List Orders

List Orders

curl --request GET \
  --url https://uat-api.clinkbill.com/api/order \
  --header 'X-API-KEY: <api-key>' \
  --header 'X-Timestamp: <x-timestamp>'

import requests

url = "https://uat-api.clinkbill.com/api/order"

headers = {
    "X-Timestamp": "<x-timestamp>",
    "X-API-KEY": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-Timestamp': '<x-timestamp>', 'X-API-KEY': '<api-key>'}
};

fetch('https://uat-api.clinkbill.com/api/order', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "total": 123,
  "rows": [
    {
      "orderId": "<string>",
      "merchantReferenceId": "<string>",
      "invoiceId": "<string>",
      "customerId": "<string>",
      "customerEmail": "<string>",
      "createTime": 1754819711382,
      "productId": "<string>",
      "priceId": "<string>",
      "priceDataList": [
        {
          "name": "<string>",
          "unitAmount": 1,
          "quantity": 2,
          "currency": "<string>",
          "imageUrl": "<string>"
        }
      ],
      "paymentMethod": {
        "paymentMethodType": "CARD",
        "paymentInstrumentId": "<string>",
        "cardScheme": "Visa",
        "cardLastFour": "4242",
        "issuerRegion": "US",
        "issuerBank": "Chase Bank",
        "wallet": {
          "accountTag": "s*****@personal.example.com"
        }
      },
      "paymentExecutionDetails": [
        {
          "channelCode": "<string>",
          "channelTransactionId": "<string>",
          "originalFailureCode": "<string>",
          "originalFailureMessage": "<string>"
        }
      ],
      "amountSubtotal": 9.99,
      "amountTotal": 9.99,
      "paymentCurrency": "USD",
      "originalCurrency": "USD",
      "failureCode": "card_declined",
      "failureMessage": "The card was declined",
      "paymentTime": 1754819711382,
      "sessionId": "<string>",
      "metadata": {},
      "riskLevel": "<string>"
    }
  ],
  "code": 200,
  "msg": "success"
}

"<string>"

GET

order

List Orders

curl --request GET \
  --url https://uat-api.clinkbill.com/api/order \
  --header 'X-API-KEY: <api-key>' \
  --header 'X-Timestamp: <x-timestamp>'

import requests

url = "https://uat-api.clinkbill.com/api/order"

headers = {
    "X-Timestamp": "<x-timestamp>",
    "X-API-KEY": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-Timestamp': '<x-timestamp>', 'X-API-KEY': '<api-key>'}
};

fetch('https://uat-api.clinkbill.com/api/order', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "total": 123,
  "rows": [
    {
      "orderId": "<string>",
      "merchantReferenceId": "<string>",
      "invoiceId": "<string>",
      "customerId": "<string>",
      "customerEmail": "<string>",
      "createTime": 1754819711382,
      "productId": "<string>",
      "priceId": "<string>",
      "priceDataList": [
        {
          "name": "<string>",
          "unitAmount": 1,
          "quantity": 2,
          "currency": "<string>",
          "imageUrl": "<string>"
        }
      ],
      "paymentMethod": {
        "paymentMethodType": "CARD",
        "paymentInstrumentId": "<string>",
        "cardScheme": "Visa",
        "cardLastFour": "4242",
        "issuerRegion": "US",
        "issuerBank": "Chase Bank",
        "wallet": {
          "accountTag": "s*****@personal.example.com"
        }
      },
      "paymentExecutionDetails": [
        {
          "channelCode": "<string>",
          "channelTransactionId": "<string>",
          "originalFailureCode": "<string>",
          "originalFailureMessage": "<string>"
        }
      ],
      "amountSubtotal": 9.99,
      "amountTotal": 9.99,
      "paymentCurrency": "USD",
      "originalCurrency": "USD",
      "failureCode": "card_declined",
      "failureMessage": "The card was declined",
      "paymentTime": 1754819711382,
      "sessionId": "<string>",
      "metadata": {},
      "riskLevel": "<string>"
    }
  ],
  "code": 200,
  "msg": "success"
}

"<string>"

Authorizations

X-API-KEY

string

header

required

Your secret API key obtained from the Clink dashboard (Developers section)

Headers

X-Timestamp

string

required

Current timestamp in milliseconds since Unix epoch (required for request signing)

Example:

"1783513683000"

Query Parameters

subscriptionId

string

Subscription ID used to filter recurring orders

customerId

string

Customer ID used to filter orders

merchantReferenceId

string

Merchant-side reference ID used to filter orders

pageNum

integer<int32>

default:1

Current page number. Defaults to 1.

pageSize

integer<int32>

default:20

Number of records per page. Defaults to 20. The maximum is 50; larger values are capped at 50.

Required range: x <= 50

Response

Orders retrieved successfully

Table Paging Data Object

total

integer<int64>

Total number of records

rows

object[]

List of data

Show child attributes

code

integer<int32>

Response status code, 200 when success

Example:

200

msg

string

Brief description of what happened, 'success' when happy case

Example:

"success"

Create Payment Instrument Create Refund

API Documentation

Checkout Session

Payment

Payment Instrument

Order

Agent Payment Session

Refund

Product

Price

Coupon

Promotion Code

Subscription

Test Clock

Customer Portal

Webhook Endpoint Management

Webhooks

API Reference

Subscription API

Test Clock

Agent Payment Session

Authorizations

Headers

Query Parameters

Response