Query Order

Function Description

• Query payment system payment order

Query Order API

Request URL

• /orders/{ORDER_ID}
  • {ORDER_ID}：Your payment ID

Request Method

• order.detail

HTTP Verb

• GET

Request Parameters

The request parameters are as follows:

• Header

  • View public parameters

Response Parameters

The response parameters are as follows:

• Response Body

Parameter	Type	Description	Example
amount	number	Order amount, note that this is a numeric type, floating point number, up to two decimal places	3.23
tip	number	Order tip	"10.02"
taxAmount	number	Tax	"10"
refundAmount	number	The total amount of refunds	0.99
id	string	SGate payment order ID, automatically generated by the system, globally unique	"M000001T2022101023455774363043"
clientId	string	ID of the Client through which the order was created	"CLT0000001"
clientIp	string	The customer IP address at the time of placing an order	"127.0.0.1"
merchantId	string	Merchant ID of the order	"M000001"
payLinkId	string	Payment link ID	"L549641839"
products	string	Product information purchased in the current order
customer	string	Customer, payer, buyer information
beneficiary	string	Beneficiary information
logistics	string	Domestic logistics information
overseasLogistics	string	Overseas logistics information
deliveryStatus	string	Delivery status: pending: not shipped shipping: shipped overseas domesticInStock: waiting for shipment domestically contacting: in contact delivering: delivering delivered: signed for	"pending"
afterSaleStatus	string	After-sales status: none: none applying: applying for after-sales returning: returning returned: return completed	"none"
clientPayerInfo	string	Client information
status	string	Order status: pending: the merchant creates the order paid: the user has paid closed: the order is closed, the timeout order will be closed automatically expired: the order has expired	"pending"
complainStatus	string	Order complaint status: normal: normal order complained: complained order	"normal"
ticket	string	Order payment operation ticket, when guiding the payer to make payment, the URL must contain this parameter	"Q6XU......Aw89"
name	string	Order description information, parameters submitted by the merchant when creating the order	"Purchase a game recharge card with a face value of 100"
merchantOrderId	string	Merchant payment order ID	"2022102218233400123"
notificationURL	string	Order payment success notification address
needTax	boolean	Whether taxes need to be paid	false
exchangeRate	string	Exchange rate	"15"
currency	string	Currency type Currency type, three uppercase letters	"SAR" "KWD" "BHD" "AED" "OMR" "QAR"
paidAt	string	Payment time
closedAt	string	Order closing time
expiredAt	string	The order expiration time. After the expiration, the order cannot continue to be paid. It is recommended to set it to 30 minutes. The default is 30 minutes	"2022-10-23T12:00:21.000Z"
message	string	System information
payerInfo	string	Payer information
payLink	string	Payment link information
refundStatus	string	Refund status: none: No refund fail: Refund failed processing: Refund in process partial: Partial refund full: full refund	"none"
refundTimes	number	The number of times a refund occurred	0
invoiceId	string	Invoice ID
successPaymentCardBrand	string	Card type for successful payment
successPaymentMethod	string	Payment method for successful payment	"stcpay"
createdAt	string	Order creation time	"2022-10-22T12:00:21.000Z"
updatedAt	string	Update time	"2022-12-31T12:53:17.000Z"

Response Parameter Example

{
  "amount": 12.02, // Order amount
  "tip": 0.02, // Order tip
  "taxAmount": 0, // Tax
  "refundAmount": 0, // Refund amount
  "id": "M448726T2022123112531745487632", // Payment order ID
  "clientId": "CLT9208307", // Client ID
  "clientIp": "127.0.0.1", // The customer IP address at the time of placing an order
  "merchantId": "M448726", // Merchant ID
  "payLinkId": "L298791901", // Payment link ID
  "products": "[{\"name\":\"Slip On Classic Beige\",\"type\":\"unknown\",\"quantity\":1,\"price\":\" 12.02\",\"sku\":\"xxxx-xxxx-xx\",\"productId\":\"160603886211111111111\",\"amount\":\"12.02\",\"avatar\": \"https://xxx\",\"location\":\"SA\"}]", // Product information purchased in the current order
  "customer": "{\"nickname\":\"customerName\",\"email\":\"info@gmail.com\",\"mobile\":\"900000000\",\"address\ ":\"Tabuk,Umluj,Al Balad,1022 9th Avenue\"}", // Customer, payer, buyer information
  "beneficiary": "{\"platform\":\"PUBG\",\"info\":\"ACCOUNT123_UID12345\"}", // Beneficiary information
  "logistics": "{\"trackingURL\":\"https://xxx\",\"trackingNumber\":\"TEST123345234\"}", // Domestic logistics information
  "overseasLogistics": "{\"trackingURL\":\"https://xxx\",\"trackingNumber\":\"TEST12678567\"}", // Overseas logistics information
  "deliveryStatus": "pending", // Delivery status
  "afterSaleStatus": "none", // Payment status
  "clientPayerInfo":"{\"method\":\"M424843T2024010210344240829304\",\"clientTime\":\"2024-01-02T07:34:26.867Z\",\"language\":\"en\" ,\"outerWidth\":1425,\"outerHeight\":1124,\"innerWidth\":1401,\"innerHeight\":1033,\"clientWidth\":1401,\"clientHeight\":1033,\ "availWidth\":2560,\"availHeight\":1400,\"screenWidth\":2560,\"screenHeight\":1440,\"url\":\"https:\/\/gccpay.lishaopeng.cn \/en-US\/order\/M424010210344240829304?ticket=rClF4FL2C7Bps7jllRhsPhAkIrkv73xd5sTPM6rFWeMeJPrMjX1o7c0v1GP98Wop\",\"userAgent\":\"Mozilla\/5.0 (Windows NT 1 0.0; Win64; x64) AppleWebKit\/537.36 (KHTML, like Gecko) Chrome \/120.0.0.0 Safari\/537.36 Edg\/120.0.0.0\",\"clientIp\":\"114.93.215.105\",\"activedAt\":\"2024-01-02T07:34:42.604Z \"}",
  "status": "pending", // Order status
  "complainStatus": "complainStatus", // Order complaint status
  "ticket": "QnTkb04gg5RzB6fPKlfKH9AJgTW7PYQKCYnP0Wwdz0uiQZjSt8UjsHtBJbBBmTMc", // Ticket voucher, used to verify the order ID
  "name": "Order test for desc", // Order description
  "merchantOrderId": "TEST1672491207", // Merchant order ID
  "notificationURL": null, // Callback address
  "needTax": false, // Whether taxes need to be paid
  "exchangeRate": null, // Exchange rate
  "currency": "SAR", // Payment currency
  "paidAt": "None", // Payment time
  "closedAt": null, // Order closing time
  "expiredAt": "2023-01-15T20:53:27.000Z", // Expiration time
  "message": null,
  "payerInfo": "{\"name\":\"alfa\",\"phone\":\"19884636245\",\"address\":\"alfa\",\"email\":\" alfall@qq.com\"}", // Payer information
  "payLink": "{\"amount\":10,\"tipOptions\":[1,2,3],\"id\":\"L296776508\",\"name\":null,\" clientId\":\"CLT7740145\",\"amountType\":\"fixed\",\"currency\":\"SAR\",\"needContact\":true,\"includeAddress\":true, \"needTip\":true,\"tipRequired\":false,\"tipType\":\"percent\",\"creatorId\":\"U643029\",\"createdAt\":\"2023- 03-01T14:14:00.000Z\",\"updatedAt\":\"2023-03-01T14:14:00.000Z\"}", // Payment link information
  "refundStatus": "none", // Refund status
  "refundTimes": 0, //The number of refunds that occurred
  "invoiceId": null, // Invoice ID
  "successPaymentCardBrand":null, // Successful payment card type
  "successPaymentMethod":null, // Successful payment method
  "createdAt":"2024-01-02T07:34:42.000Z",
  "updatedAt":"2024-01-03T07:39:42.000Z"
}