Query

---

• Description： Obtain details of specific order
• Path： /hosted-checkout/query
• Method： POST
• Request Header： Content-Type: application/json

Request Parameters

Parameter	Type	Mandatory	Description
merchantId	String	M	Merchant identifier
orderId	Number	C	Order ID of the payment. Mandatory when merchantReference is not given
merchantReference	String(64)	C	Unique reference of the order. Mandatory when orderId is not given

Example:

{
    "request": "{\"merchantId\":3,\"orderId\":5570}",
    "signature": "0hQ714e4KZ8uAktdRPS75LXTftfddHhYMiZ4zHW+O9Yywcdg8JkBzpYFeeb0OfaY55ZlmZesVgd+y7G14aojm7pRV0ZHhYHBtHXPat4TRuZQdtcAbuAU7j3WM4lupw1nfLrn5zvEmo41fPR725/C2qS8SRa/7lUWLKnVC5H4vN7MCc7v60AoKPxMnpAkIVfu9qT3QeD23kf720bkv0g33TAzvByqWz4rtUPu1i4OHekY5orQoq7C1T0Kr/nG/28BCmCTk/y6VkYqV+vfZBwbU1gXGuw2Z+3HeSHordAFybPzZy7L7b8HaC59Np474WbXqZshfbOHgMS8JCJxfXMNXw=="
}

Response Parameters

Parameter	Type	Mandatory	Description
responseCode	String	M	Payment Gateway response code
message	String	M	Payment Gateway response message
order	Object	M
order.id	Number	M	Order identifier
order.merchantId	Number	M	Merchant identifier which own this order
order.merchantReference	String	M	Your reference for the order
order.currency	String	M	3-Letters ISO currency code of the order
order.amount	Number	M	Order amount
order.netAmount	Number	M	Net amount of the order
order.cardType	String	M	Card type of the order
order.email	String	M	Customer's email if provided
order.createTime	Datetime	M	Timestamp when the order is created. Maintained by the Payment Gateway
order.updateTime	Datetime	M	Timestamp when the order is last updated. Maintained by the Payment Gateway
order.status	String	M	Status of the order. Maintained by the Payment Gateway
order.recurring	Boolean	M	Flags the order is a recurring order or not

Example:

{
  "responseCode": "0000",
  "message": "Success",
  "order": {
    "id": 5570,
    "merchantId": 3,
    "merchantReference": "merRef1656603707555",
    "currency": "HKD",
    "amount": 50.00,
    "netAmount": 0.00,
    "cardType": "MASTER",
    "createTime": "2022-06-30T15:41:48.000+00:00",
    "updateTime": "2022-06-30T15:42:55.000+00:00",
    "status": "VOIDED",
    "recurring": false
  }
}