Skip to content

Ipass Search

Description

IPASS 線下支付 已請款交易紀錄查詢
IPASS 金流參數：iPass-MerchantId(IPASS特店代號)、KEY(IPASS提供)、IV(IPASS定義為隨機碼)
情境：

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

Resource

POST /v1/payment/ipass/offline/search

Authorization

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

Request Body Parameters

Name Type Description
request Request 請求參數
store_id string 門市代碼
(optional)
is_test boolean 是否為測試模式，預設為 false
(optional)

Request Body Parameters - Request

Name Type Description
merchantid string Ipass特店代號
(optional)
key string Ipass特店金鑰
(optional)
iv string Ipass偏移植產生一組 16 個 Byte 的陣列，將 16 個 Byte 各自隨機填入 0~255 數值，將結果轉換成16進制字串。
每次請求皆不同
(optional)
req_id string 序列號,為唯一值 (使用UUID) 長度限制 36
orderNumber string 訂單編號(商家交易的唯一 ID)

Request

{
  "store_id": "0",
  "request": {
    "req_id": "3815D6AE-9349-40CF-8990-0000E42AC591",
    "orderNumber": "IXN20231011000001"
  }
}

Response Body Parameters

Name Type Description
message string 錯誤訊息 (OMNI)
(optional)
return_code string 結果代碼，0000為成功 (IPASS)
(optional)
return_msg string 結果訊息或失敗理由 (IPASS)
(optional)
req_id string 同 request req_id
(optional)
transaction_date_time string 一卡通交易序號
(optional)
original_transactionId string 依 UTC+8 時區。格式 : YYYY-mm-dd HH:mm:ss
(optional)
pay_status string 若消費者有綁定電子發票載具即回傳，若無回傳空值
(optional)
product_desc string
(enum)		 付款方式 1: 電支餘額 2: 信用卡
(optional)
payment_type string
(enum)		 錯誤訊息來源
ALLOWED VALUES:
  • OMNI
  • IPASS

(optional)
amount string 一卡通交易序號
(optional)
refund_list ReFundList 兌換
order_number string 訂單編號 長度限制 100
(optional)
electronic_invoice_carrier string 若消費者有綁定電子發票載具即回傳，若無回傳空值
(optional)

Request Body Parameters - ReFundList

Name Type Description
refund_transaction_id string 一卡通端退費交易序號
refund_transaction_date_time string 依 UTC+8 時區。 格式 : YYYY-mm-dd HH:mm:ss
refund_amount integer 退費金額

Response

查詢成功

200 

{
    "return_code": "0000",
    "return_msg": "success",
    "req_id": "3815D6AE-9349-40CF-8990-0000E42AC591",
    "transaction_date_time": "2022-08-24 08:30:10",
    "original_transaction_id": "IPY202208250340004",
    "pay_status": "3",
    "payment_type": "1",
    "amount": 229,
    "refund_list": [
        {
            "refund_transaction_id": "IPY202208250340004",
            "refund_transaction_date_time": "2023-10-11 08:30:10",
            "refund_amount": 10
        }, {
            "refund_transaction_id": "IPY202208250340005",
            "refund_transaction_date_time": "2023-10-11 08:45:10",
            "refund_amount": 20
        }
    ]
}

200 

{
  "transaction_date_time": "2024-09-03 15:04:55",
  "original_transaction_id": "e2458984869626",
  "pay_status": "1",
  "product_desc": "XX防曬乳*1(149元)、XX菸品*1(80)",
  "payment_type": "1",
  "amount": 2,
  "order_number": "IXN20240827000005",
  "electronic_invoice_carrier": "",
  "refund_list": [],
  "return_code": "0000",
  "return_msg": "成功",
  "req_id": "3815D6AE-9349-40CF-8100-0000E42AC591"
}

查詢失敗

200 

{
  "return_code": "9999",
  "return_msg": "發生未預期錯誤",
  "message_from": "IPASS"
}

200 

{
  "return_code": "9999",
  "return_msg": "發生未預期錯誤",
  "message_from": "IPASS"
}

400 

{
  "message": "呼叫IPASS API錯誤",
  "message_from": "OMNI"
}