Query Refund

This endpoint is for WeChatPay, Alipay and UnionPay only, and it query refund orders based on payOrderId.

API Request

Endpoint

https://api.iotpaycloud.com/v1/query_order_with_refundlist

Method

POST

Header

Content-Type: application/x-www-form-urlencoded

Parameters

Name	Required	Type	Sample	Description
mchId	y	String(30)	20001222	merchant id assigned by IOTPay
payOrderId	y	String(64)	U00180918065500913991007022	order id must be the same with original order id
sign	y	String(32)	C380BEC2BFD727A4B6845133519F3AD6	signature

Note

Due to backwards compatibility requirements, we require the parameters to be wrapped like the following:

params={"mchId":"10000576","payOrderId":"AQ20200506080632053874668653","sign":"744E740B3CD0F02A0A2ACC4C4D65D1DE"}

Return Result Example

{
  "resCode": "SUCCESS",
  "retCode": "SUCCESS",
  "retParams": "",
  "payOrderId": "AQ20200506080632053874668653",
  "mchOrderNo": "1588795591785",
  "retDetail": {
    "payOrderId": "AQ20200506080632053874668653",
    "mchId": "10000576",
    "mchOrderNo": "1588795591785",
    "channelId": "ALIPAY_QR",
    "currency": "CAD",
    "amount": 1,
    "tip": 0,
    "clientIp": "192.168.0.29",
    "deviceId": "V1s-G",
    "deviceType": "",
    "notifyUrl": "jg_push",
    "subject": "IOTPay",
    "body": "IOTPay",
    "param1": "",
    "param2": "",
    "extra": "{\"pos_flag\":\"yes\",\"productId\":\"10000576_null\"}",
    "paySuccTime": 1588795600,
    "channelOrderNo": "2020050722001478601416214647",
    "status": 2,
    "createDate": 1588795592,
    "updateDate": 1588795860,
    "userName": "abcde",
    "storeId": "34448062501",
    "rate": 0,
    "remarks": "",
    "rateValue": 0,
    "originalOrderId": "",
    "payType": "pay",
    "refundList": [
      {
        "payOrderId": "RA20200506081058939207564276",
        "mchId": "10000576",
        "mchOrderNo": "1588795858585",
        "channelId": "ALIPAY_QR",
        "currency": "CAD",
        "amount": 1,
        "tip": 0,
        "clientIp": "210.73.10.148",
        "deviceId": "VS34197B60717",
        "deviceType": "",
        "notifyUrl": "jg_push",
        "subject": "abcde",
        "body": "",
        "param1": "",
        "param2": "",
        "extra": "",
        "paySuccTime": "",
        "channelOrderNo": "2020050722001478601416214647",
        "status": 3,
        "createDate": 1588795858,
        "updateDate": 1588795860,
        "userName": "abcde",
        "storeId": "34448062501",
        "rate": 1.1,
        "remarks": "abcde",
        "rateValue": 0,
        "originalOrderId": "AQ20200506080632053874668653",
        "payType": "refund"
      }
    ]
  },
  "result": {
    "payOrderId": "AQ20200506080632053874668653",
    "mchId": "10000576",
    "mchOrderNo": "1588795591785",
    "channelId": "ALIPAY_QR",
    "currency": "CAD",
    "amount": 1,
    "tip": 0,
    "clientIp": "192.168.0.29",
    "deviceId": "V1s-G",
    "deviceType": "",
    "notifyUrl": "jg_push",
    "subject": "IOTPay",
    "body": "IOTPay",
    "param1": "",
    "param2": "",
    "extra": "{\"pos_flag\":\"yes\",\"productId\":\"10000576_null\"}",
    "paySuccTime": 1588795600,
    "channelOrderNo": "2020050722001478601416214647",
    "status": 2,
    "createDate": 1588795592,
    "updateDate": 1588795860,
    "userName": "abcde",
    "storeId": "34448062501",
    "rate": 0,
    "remarks": "",
    "rateValue": 0,
    "originalOrderId": "",
    "payType": "pay",
    "refundList": [
      {
        "payOrderId": "RA20200506081058939207564276",
        "mchId": "10000576",
        "mchOrderNo": "1588795858585",
        "channelId": "ALIPAY_QR",
        "currency": "CAD",
        "amount": 1,
        "tip": 0,
        "clientIp": "210.73.10.148",
        "deviceId": "VS34197B60717",
        "deviceType": "",
        "notifyUrl": "jg_push",
        "subject": "abcde",
        "body": "",
        "param1": "",
        "param2": "",
        "extra": "",
        "paySuccTime": "",
        "channelOrderNo": "2020050722001478601416214647",
        "status": 3,
        "createDate": 1588795858,
        "updateDate": 1588795860,
        "userName": "abcde",
        "storeId": "34448062501",
        "rate": 1.1,
        "remarks": "abcde",
        "rateValue": 0,
        "originalOrderId": "AQ20200506080632053874668653",
        "payType": "refund"
      }
    ]
  },
  "sign": "0D7EB672A43D653F45DF25E0208F2D82"
}