Query Transaction
To check the status of an order
Info
After you receive access credentials (merchant id, login name, merchant key). You can step through the demo Query Order which may help you when going through the documentation.
Endpoint
https://ccapi.iotpaycloud.com/v3/cc_query
Method
POST
Header
Content-Type: application/json;charset=UTF-8
Request
| name | required | type | sample | description |
|---|---|---|---|---|
| mchId | y | String(30) | 10000701 | assigned by IOTPay |
| mchOrderNo | y | String(30) | 1234567890abc | assigned by merchant |
| payOrderId | y | String(30) | PC20240101231256043886634219 | generated by IOTPay |
| sign | y | String(32) | C380BEC2BFD727A4B6845133519F3AD6 | Sign algorithm |
Note
Only one of mchOrderNo and payOrderId is need for querying.
Response
| name | required | type | sample | description |
|---|---|---|---|---|
| retCode | y | String | SUCCESS or FAIL | |
| retMsg | y | String | ||
| retData | y | JSON | if retCode=SUCCESS, order detailed info returned |
retData contains order information:
| name | required | type | sample | description |
|---|---|---|---|---|
| payOrderId | y | String | PC20240101231256043886634219 | generated by IOTPay |
| mchId | y | String | 10000701 | assigned by IOTPay |
| mchOrderNo | y | String | 604567999 | assigned by merchant |
| originalOrderId | n | String | original pay order id for refund | |
| currency | y | String | CAD | only 'CAD' supported |
| amount | y | Int | 1500 | in cents |
| payType | y | String | pay or refund | |
| refundable | y | Int | 1500 | amount that can be refunded from this order in cents |
| status | y | Int | 0,1,2,9 | 0 = pending order, 1 = unknown, 2 = success, 9 = fail |
| paySuccTime | y | String | 2021-04-07 19:44:51 | time stamp for the moment when the payment succeeded |
| cardNum | y | String | 432567******2266 | card number of the card used for the purchase |
| expiryDate | y | String | 0725 | expiry date of the card used for the purchase |
| invoiceNum | y | String | ||
| authNum | y | String | ||
| transNum | y | String | ||
| channel | y | String | PF_CC | PF_CC or UPI_EX |