Skip to main content
GET
/
order
/
{id}
cURL
curl --request GET \
  --url https://api.clinkbill.dev/api/order/{id} \
  --header 'X-API-KEY: <api-key>' \
  --header 'X-Timestamp: <api-key>'
{
  "code": 200,
  "msg": "success",
  "data": {
    "orderId": "<string>",
    "merchantReferenceId": "<string>",
    "invoiceId": "<string>",
    "customerId": "<string>",
    "createTime": 1754819711382,
    "productId": "<string>",
    "priceId": "<string>",
    "priceDataList": [
      {
        "name": "<string>",
        "quantity": 2,
        "unitAmount": 1,
        "currency": "<string>",
        "imageUrl": "<string>"
      }
    ],
    "paymentMethod": {
      "paymentMethodType": "CARD",
      "paymentInstrumentId": "<string>"
    },
    "amountSubtotal": 9.99,
    "amountTotal": 9.99,
    "paymentCurrency": "USD",
    "originalCurrency": "USD",
    "status": "success"
  }
}

Authorizations

​
X-API-KEY
string
header
required

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

​
X-Timestamp
string
header
required

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

Path Parameters

​
id
string
required

Unique identifier of the order

Response

200 - application/json

Order details retrieved successfully

​
code
integer

Response status code, 200 when success

Example:

200

​
msg
string

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

Example:

"success"

​
data
object