Skip to content

Integrate Ipass QRCode Refund

Description

IPASS 線下支付 退款請求
IPASS 金流參數：iPass-MerchantId(IPASS特店代號)、KEY(IPASS提供)、IV(IPASS定義為隨機碼, 由系統自行產生)
情境：

  • 依廠商金流參數設定進行付款：金流參數(merchant_id、key)為必填、門市代碼不需要填
  • 依全通路金流參數設定進行付款：門市代碼為必填、金流參數(merchant_id、key)不需要填

Resource

POST /v1/payment/integrate/refund

Authorization

採用 OAuth 2.0 Bearer Token，詳細使用流程請參考 Auth Login。

Request Body Parameters

Name Type Description
type string 付款方式，請輸入 IPASS_QRCODE_PAY
request Request 請求參數
store_id string 門市代碼
(optional)

Request Body Parameters - Request

Name Type Description
merchantid string Ipass特店代號
(optional)
key string Ipass特店金鑰
(optional)
req_id string 序列號,為唯一值 (使用UUID) 長度限制 36
transaction_id string 一卡通交易序號
amount integer 支付取消金額(未帶金額全退)

Request

{
  "type": "IPASS_QRCODE_PAY",
  "store_id": "000030",
  "request": {
    "req_id": "ddb720f3-ae7b-4c1a-ab8c-6c0f332fa8a2",
    "transaction_id": "e3041851969147",
    "amount": 30
  }
}

Response Body Parameters

Name Type Description
Data Data 資料物件
IV string 該次請求回覆使用的IV
MAC string 該次請求回覆安控物件

Response Body Parameters Data

Name Type Description
returnCode string 結果代碼，0000為成功 (IPASS)
(optional)
returnMsg string 結果訊息或失敗理由 (IPASS)
(optional)
reqId string 同 request req_id
(optional)
cancelTransactionId string 一卡通交易序號
(optional)
cancelDateTime string 依 UTC+8 時區。格式 : YYYY-mm-dd HH:mm:ss
(optional)
orderNumber string 訂單編號 長度限制 100

Response

退款成功

200 

{
  "Data": {
    "cancelTransactionId": "R266820251013093430837",
    "cancelDateTime": "2025-10-13 09:34:30",
    "orderNumber": "00003025101300002",
    "returnCode": "0000",
    "returnMsg": "成功",
    "reqId": "ddb720f3-ae7b-4c1a-ab8c-6c0f332fa8a2"
  },
  "IV": "FA7A599CCEACCAEB2530B6D741C85236",
  "MAC": "8A7231FB921AF8CA361B52042EEBC2DB"
}

退款失敗

200 

{
  "Data": {
    "returnCode": "0019",
    "returnMsg": "transactionId可退金額不足",
    "reqId": "ddb720f3-ae7b-4c1b-ab8c-6c0f332fa8a2"
  },
  "IV": "0E5CA39F2F7AAD49C98899D885C45D22",
  "MAC": "1DA2E49EC6B22E573BF4DB5AE8AFFCD6"
}

錯誤代碼

錯誤代碼 描述
9992 MerchantId 異常
9993 ReqId 重複
9994 輸入格式異常
9995 商店代碼檢核異常 (不回傳物件結構)
9996 系統維護中，請稍後再試。
9997 MAC 檢核異常
9999 發生未預期錯誤 (不回傳物件結構)
0000 成功
0001 ReqId 檢核異常
0002 QRCode/BarCode 已失效
0003 PostDateTime 異常
0004 TradeDateTime 異常
0005 金額異常 (小於等於 0)
0012 此商家不支援
0013 transactionId 不存在
0018 orderNumber 不存在
0019 transactionId 可退金額不足
0020 交易狀態非可退款
0021 信用卡退款須整筆退款
0023 交易處理中