跳至主要內容

撤銷

Easylink2026/3/26大約 7 分鐘

統一撤銷

商戶通過該接口撤銷訂單，支付網關會對已完成的當日訂單進行撤銷處理。

下圖展示了撤銷訂單的完整流程：

流程說明：

  1. 商戶調用撤銷接口提交撤銷請求
  2. 支付網關向渠道發起撤銷操作
  3. 渠道返回撤銷處理結果
  4. 支付網關將結果返回給商戶
  5. 如有配置異步通知地址，支付網關會額外發送異步通知

接口說明

請求URL：/api/pay/cancel

請求方式：POST

請求類型：application/json 或 application/x-www-form-urlencoded

請求參數

字段名變量名必填類型示例值描述
商戶號mchNo是String(30)M1621873433953商戶號
應用IDappId是String(24)60cc09bce4b0f1c0b83761c9應用ID
支付訂單號payOrderId是String(30)P20160427210604000490支付中心生成的訂單號，與mchOrderNo二者傳一即可
商戶訂單號mchOrderNo是String(30)20160427210604000490商戶生成的訂單號，與payOrderId二者傳一即可
客戶端IPclientIp否String(32)210.73.10.148客戶端IPV4地址
異步通知地址notifyUrl否String(128)https://www.gnete.com.hk/notify.htm撤銷完成後回調該URL,只有傳了該值才會發起回調
渠道參數channelExtra否String(256){"auth_code", "13920933111042"}特定渠道發起的額外參數,json格式字符串.詳見渠道參數說明
擴展參數extParam否String(512)134586944573118714商戶擴展參數,回調時會原樣返回
請求時間reqTime是long1622016572190請求接口時間,13位時間戳
接口版本version是String(3)1.0接口版本號，固定：1.0
簽名sign是String(32)C380BEC2BFD727A4B6845133519F3AD6簽名值，詳見簽名算法
簽名類型signType是String(32)MD5簽名類型，目前只支持MD5方式

請求示例數據

{
  "mchNo": "M1623984572",
  "appId": "60cc09bce4b0f1c0b83761c9",
  "payOrderId": "P202106181104177050002",
  "mchOrderNo": "20160427210604000490",
  "clientIp": "192.166.1.132",
  "notifyUrl": "https://www.gnete.com.hk/notify.htm",
  "channelExtra": "",
  "extParam": "",
  "reqTime": "1624006009",
  "version": "1.0",
  "sign": "46940C58B2F3AE426B77A297ABF4D31E",
  "signType": "MD5"
}

返回參數

字段名變量名必填類型示例值描述
返回狀態code是int00-處理成功，其他-處理有誤，詳見錯誤碼
返回信息msg否String(128)簽名失敗具體錯誤原因，例如：簽名失敗、參數格式校驗錯誤
簽名信息sign否String(32)CCD9083A6DAD9A2DA9F668C3D4517A84對data內數據簽名,如data為空則不返回
返回數據data否String(512){}返回下單數據,json格式數據

data數據格式

字段名變量名必填類型示例值描述
撤銷訂單號cancelOrderId是String(30)C202106181104177050002返回撤銷訂單號
撤銷狀態state是int2撤銷狀態
0-訂單生成
1-撤銷中
2-撤銷成功
3-撤銷失敗
4-撤銷關閉
渠道退款單號channelOrderNo否String20160427210604000490對應渠道的退款單號
渠道錯誤碼errCode否String1002渠道撤銷返回錯誤碼
渠道錯誤描述errMsg否String關閉異常渠道撤銷返回錯誤描述

返回示例數據

{
  "code": 0,
  "data": {
    "cancelOrderId": "C202106181104177050002",
    "state": 2,
    "channelOrderNo": "2021061822001423031419593035",
    "errCode": "",
    "errMsg": ""
  },
  "msg": "SUCCESS",
  "sign": "9548145EA12D0CD8C1628BCF44E19E0D"
}

查詢訂單

商戶通過該接口查詢訂單，支付網關會返回訂單最新的數據

接口說明

請求URL：/api/cancel/query

請求方式：POST

請求類型：application/json 或 application/x-www-form-urlencoded

請求參數

字段名變量名必填類型示例值描述
商戶號mchNo是String(30)M1621873433953商戶號
應用IDappId是String(24)60cc09bce4b0f1c0b83761c9應用ID
撤銷訂單號cancelOrderId是String(30)C20160427210604000490撤銷訂單號
請求時間reqTime是long1622016572190請求接口時間,13位時間戳
接口版本version是String(3)1.0接口版本號，固定：1.0
簽名sign是String(32)C380BEC2BFD727A4B6845133519F3AD6簽名值，詳見簽名算法
簽名類型signType是String(32)MD5簽名類型，目前只支持MD5方式

請求示例數據

{
  "cancelOrderId": "C202106181104177050002",
  "appId": "60cc09bce4b0f1c0b83761c9",
  "sign": "46940C58B2F3AE426B77A297ABF4D31E",
  "signType": "MD5",
  "reqTime": "1624006009",
  "mchNo": "M1623984572",
  "version": "1.0"
}
字段名變量名必填類型示例值描述
返回狀態code是int00-處理成功，其他-處理有誤，詳見錯誤碼
返回信息msg否String(128)簽名失敗具體錯誤原因，例如：簽名失敗、參數格式校驗錯誤
簽名信息sign否String(32)CCD9083A6DAD9A2DA9F668C3D4517A84對data內數據簽名,如data為空則不返回
返回數據data否String(512){}返回下單數據,json格式數據

data數據格式

字段名變量名必填類型示例值描述
撤銷訂單號cancelOrderId是String(30)C202106181104177050002撤銷訂單號
支付訂單號payOrderId是String(30)P12021022311124442600支付訂單號
商戶號mchNo是String(30)M1621873433953商戶號
應用IDappId是String(24)60cc09bce4b0f1c0b83761c9應用ID
支付金額payAmount是long100支付金額,單位分
貨幣代碼currency是String(3)HKD三位貨幣代碼,港幣:HKD
撤銷狀態state是int2撤銷狀態
0-訂單生成
1-撤銷中
2-撤銷成功
3-撤銷失敗
4-撤銷關閉
渠道訂單號channelOrderNo否String20160427210604000490渠道訂單號
渠道錯誤碼errCode否String1002渠道錯誤碼
渠道錯誤描述errMsg否String業務異常錯誤渠道錯誤描述
擴展參數extraParam否String(512)134586944573118714擴展參數
訂單撤銷成功時間successTime否long1622016572190訂單撤銷成功時間,13位時間戳
創建時間createdAt是long1622016572190創建時間,13位時間戳

返回示例數據

{
  "code": 0,
  "data": {
    "cancelOrderId": "C202106181104177050002",
    "payOrderId": "P202106181104177050002",
    "mchNo": "M1621873433953",
    "appId": "60cc09bce4b0f1c0b83761c9",
    "payAmount": 58,
    "currency": "HKD",
    "state": 2,
    "channelOrderNo": "2021061822001423031419593035",
    "errCode": "",
    "errMsg": "",
    "extraParam": "",
    "successTime": 1623985554000,
    "createdAt": 1623985552769
  },
  "msg": "SUCCESS",
  "sign": "9548145EA12D0CD8C1628BCF44E19E0D"
}

撤銷通知

當訂單撤銷成功時，支付網關會向商戶系統發起回調通知。如果商戶系統沒有正確返回，支付網關會延遲再次通知。

接口說明

請求URL：該鏈接是通過撤銷訂單接口提交的參數notifyUrl設置，如果無法訪問鏈接，商戶系統將無法接收到支付中心的通知。

請求方式：POST

請求類型：application/x-www-form-urlencoded

通知參數

字段名變量名必填類型示例值描述
撤銷訂單號cancelOrderId是String(30)C202106181104177050002支付中心生成的撤銷單號
支付訂單號payOrderId是String(30)P12021022311124442600返回支付系統訂單號
商戶號mchNo是String(30)M1621873433953商戶號
應用IDappId是String(24)60cc09bce4b0f1c0b83761c9應用ID
支付金額payAmount是int100支付金額,單位分
貨幣代碼currency是String(3)HKD三位貨幣代碼,港幣:HKD
撤銷狀態state是int2撤銷狀態
0-訂單生成
1-撤銷中
2-撤銷成功
3-撤銷失敗
4-撤銷關閉
渠道訂單號channelOrderNo否String20160427210604000490對應渠道的訂單號
渠道錯誤碼errCode否String1002渠道返回錯誤碼
渠道錯誤描述errMsg否String134586944573118714渠道返回錯誤描述
擴展參數extraParam否String(512)134586944573118714商戶擴展參數,回調時會原樣返回
創建時間createdAt是long1622016572190訂單創建時間,13位時間戳
成功時間successTime否long1622016572190訂單支付成功時間,13位時間戳
通知請求時間reqTime是String(30)1622016572190通知請求時間，13位時間戳
簽名sign是String(32)C380BEC2BFD727A4B6845133519F3AD6簽名值，詳見簽名算法

返回結果

業務系統處理後同步返回給支付中心，返回字符串 success 則表示成功，返回非success則表示處理失敗，支付中心會再次通知業務系統。（通知頻率為0/30/60/90/120/150,單位：秒）

注意：返回的字符串必須是小寫，且前後不能有空格和換行符。

通知示例數據

{
  "appId": "60cc09bce4b0f1c0b83761c9",
  "channelOrderNo": "2021061822001423031419593035",
  "createdAt": 1623985552769,
  "currency": "HKD",
  "extraParam": "",
  "mchNo": "M1621873433953",
  "cancelOrderId": "C202106181104177050002",
  "payOrderId": "P202106181104177050002",
  "payAmount": 5,
  "state": 2,
  "successTime": 1623985554000,
  "sign": "C380BEC2BFD727A4B6845133519F3AD6"
}
最近更新:
貢獻者: CN
默認頁腳
Copyright © 2026 Easylink