# Query Transaction API

## :white\_check\_mark: API Request Parameters**(HTTP-Request-Body )**

|  Params Name |          Description         | Required |          Notes         |
| :----------: | :--------------------------: | :------: | :--------------------: |
|    action    | Action name (Constant Value) |     Y    |     "CC\_QUERYPAY"     |
|    version   |        Version number        |     Y    |          "2.0"         |
| merchant\_id |          Merchant ID         |     Y    |   Provided by OTT Pay  |
|     data     |  Encrypted Transaction Data  |     Y    | See "Data" table below |
|      md5     |        Message Digest        |     Y    |                        |

:ballot\_box\_with\_check: **Request Example(JSON Data):**

```php
{
    "action":"CC_QUERYPAY",
    "version":"2.0",
    "merchant_id":"QC00005496",
    "data": "zTadPG0YM4gD1WOFqxg7wn3vmU20NjCnCUOOnE9mTTkxYraQDflljA8W3azYG9MuOvOyl3cZhafH+io6PiWdZCwRmi3HGa19BvT215IIxRy2HvYe0Sqs2lxshm9E4y5F1gJ7HHMTqpY0wIA4DsuWA97UC55adB2G86VbanI7B5a3kErApr5mbAoE7wcNbDJfGh4CBbSoRxQyiGZ48SvYuIW/sclT4yu6okjo6CY3xL4=",
    "md5":"6AFB2E94A70D9A208F101723700EB287"
}
```

#### :ballot\_box\_with\_check: Data**(JSON Data, to be encrypted):**

|   Params Name   |        Description       | Required |           Notes          |
| :-------------: | :----------------------: | :------: | :----------------------: |
|     orderId     |         Order ID         |     Y    | The order Id in purchase |
|   merchant\_id  |        Merchant ID       |     N    |                          |
|      shopId     |         Store ID         |     N    |                          |
|      termId     |         Device ID        |     Y    |    String, “CNP\_ECOM”   |
|   channelType   | Payment Channel identity |     Y    |   String, “PORTICOECOM”  |
|     bizType     |       Payment type       |     Y    |  String “portico\_card”  |
| cc\_channelType |     Payment platform     |     N    |    String “GLBPAYMNTS”   |

## :white\_check\_mark: API Response Parameters**(HTTP-Response-Body)**

| Params Name |    Description   | Required |          Notes         |
| :---------: | :--------------: | :------: | :--------------------: |
|  rsp\_code  |   Response code  |     Y    |   refer to Appendix B  |
|   rsp\_msg  | Response message |     Y    |                        |
|     data    |  Encrypted Data  |     Y    | See "Data" table below |
|     md5     |  Message Digest  |     Y    |                        |

:ballot\_box\_with\_check: **Response Example(JSON Data):**

```
{
"rsp_code":"SUCCESS",
"rsp_msg":"success",
"data":"41kiLvjVBO8AW4wTOthI92OQu+8fwac5cIDx0DoZpitLvSJU8WKQbk5Bii5ZYrgLz4hepQ865QZFWqj2PRZ1FjxxipxEy2KoOKchWK09e42Se3CMAxt/+8UGrnAHDJLbU/BBlZLJoLpruSNKBeVfwhI7TtGdP4ciwzKPmv5aS2DWoU4Jl26IAPa8PeGhPNLuT99HwBGXa7aUz5adYk3uAR5Ww9HkBlPrqzJlUQ4zdMgjxaM2bROldcKTK8NxPM7X",
"md5":"32310A0DD3D021A7D0CDF6A5909A1A61"
}
```

#### :ballot\_box\_with\_check: Transaction Data(JSON format, After decrypted)

|     Params Name    |          Description          | Required |                  Notes                  |
| :----------------: | :---------------------------: | :------: | :-------------------------------------: |
|       rspCode      |     Inquiry Response code     |     Y    |                                         |
|       rspMsg       |    Inquiry Response message   |     Y    |                                         |
|    order\_status   |          Order status         |     Y    |                                         |
|     trade\_time    |        Transaction time       |     N    |                                         |
|       orderId      |            Order ID           |     N    |                                         |
|  bizpay\_order\_id | Order Id from payment gateway |     N    | The transaction Id from payment gateway |
|       amount       |       Order total amount      |     N    |              Payment amount             |
|   receipt\_amount  |       Amount on receipt       |     N    |        Payment amount for receipt       |
| buyer\_pay\_amount |        Users pay amount       |     N    |                                         |
|         tip        |           Tip Amount          |     N    |                                         |
|   refund\_amount   |         Refund amount         |     N    |     Only exist for a refunded order     |