Query
- Description: Obtain details of specific order
- Path:
/direct/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\":\"3000001\",\"merchantReference\":\"s22tring\"}",
"signature":"c1hTR2RBNHRSNEIwd25GNk5yOFNocGZOTXRISVNXdXpMcGRLb05Xc2tJZ0Njc3BNVkZGemdrZXo0QnJtdFlYa01xWmgxdHl6LzhzTk5VM0YyVlR1MGZPeCtaUDRDbm1Wak51OGJjaXU0aFR0bnl0QTNZMUdaL3lYQVVEK21WWUdYZXlETzNmSHJxRGRJN2szeFYvUThGQ09kMGN1bFRzTjZSUk14TVpxK29xUjJ4K0VqT1hWb2ZwN0JaSndoUUU4VXM0QWw1NzNGUXo1RUhEdkNMeDM1bHEyaG9NaFhMQ1ZMVkRCSGNwQ2dvdHVZNG1nOTFNWGgvcXFjRkdZL2hRS2hHZFdBYlo5dGNwMlE1czJFU2gzN3JxeG5Pd1pycmVwSzhOQzZ2TUJQVWlTUHhRZWZwZXYybkcwSnpBSE9qUlBiQlhZdzFYQlM2UkJZS0FtdWZaWmlRPT0="
}
Response Parameters
Parameter | Type | Mandatory | Description |
---|---|---|---|
responseCode | String | M | |
message | String | M | |
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.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 |
responseCode | String | M | Payment Gateway response code |
message | String | M | Payment Gateway response message |
Example:
{
"responseCode": "0000",
"message": "SUCCESS",
"order":{
"id": "1076",
"merchantId": 3000001,
"merchantReference": "reference003589",
"currency": "HKD",
"amount": 76.19,
"netAmount": 76.19,
"cardType": "VISA",
"email": "",
"createTime": "2022-03-04T04:24:18.000+00:00",
"updateTime": "2022-03-04T04:27:01.000+00:00",
"status": "SUCCESS",
"recurring": false
}
}