- Description: Obtain details of specific order
- Path:
/direct/query
- Method:
POST
- Request Header:
Content-Type: application/json
Request Parameters
Parameter | Type | Required/optional | Description |
---|
merchantId | string | Required | Merchant identifier |
orderId | number | Conditional | Order ID of the payment. Required when merchantReference is not given |
merchantReference | string | Conditional | Unique reference of the order. Required when orderId is not given |
Example:
{
"request": "{\"merchantId\":\"3000001\",\"merchantReference\":\"s22tring\"}",
"signature":"c1hTR2RBNHRSNEIwd25GNk5yOFNocGZOTXRISVNXdXpMcGRLb05Xc2tJZ0Njc3BNVkZGemdrZXo0QnJtdFlYa01xWmgxdHl6LzhzTk5VM0YyVlR1MGZPeCtaUDRDbm1Wak51OGJjaXU0aFR0bnl0QTNZMUdaL3lYQVVEK21WWUdYZXlETzNmSHJxRGRJN2szeFYvUThGQ09kMGN1bFRzTjZSUk14TVpxK29xUjJ4K0VqT1hWb2ZwN0JaSndoUUU4VXM0QWw1NzNGUXo1RUhEdkNMeDM1bHEyaG9NaFhMQ1ZMVkRCSGNwQ2dvdHVZNG1nOTFNWGgvcXFjRkdZL2hRS2hHZFdBYlo5dGNwMlE1czJFU2gzN3JxeG5Pd1pycmVwSzhOQzZ2TUJQVWlTUHhRZWZwZXYybkcwSnpBSE9qUlBiQlhZdzFYQlM2UkJZS0FtdWZaWmlRPT0="
}
Response Parameters
Parameter | Type | Required/optional | Description |
---|
responseCode | string | Required | |
message | string | Required | |
order | object | Required | |
order.id | number | Required | Order identifier |
order.merchantId | number | Required | Merchant identifier which own this order |
order.merchantReference | string | Required | Your reference for the order |
order.currency | string | Required | 3-Letters ISO currency code of the order |
order.amount | number | Required | Order amount |
order.netAmount | number | Required | Net amount of the order |
order.cardType | string | Required | Card type of the order |
order.createTime | dateTime | Required | Timestamp when the order is created. Maintained by the Payment Gateway |
order.updateTime | dateTime | Required | Timestamp when the order is last updated. Maintained by the Payment Gateway |
order.status | string | Required | Status of the order. Maintained by the Payment Gateway |
order.recurring | boolean | Required | Flags the order is a recurring order or not |
responseCode | string | Required | Payment Gateway response code |
message | string | Required | 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
}
}