Skip to content

Integrate PX QRCode Pay Search

Description

PX Pay 條碼支付查詢。
PX Pay 金流參數：加密金鑰、特店門市代號、特店英文名稱
情境：

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

Resource

GET /v1/payment/integrate/search

Authorization

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

Query Parameters

Name Type Description
type string 付款方式，請輸入 PX_QRCODE_PAY
request Request 請求參數(json格式)
store_id string 門市代碼
(optional)
is_test string 是否為測試環境
  • 在全通路正式環境預設為FALSE
  • 在全通路測試環境預設為TRUE
(optional)

Query Parameters - Request

Name Type Description
verify_code string 加密金鑰
(optional)
store_id string 特店門市代號
(optional)
store_english_name string 特店英文名稱
(optional)
order_no_type integer 訂單查詢單號類型
1：使用特店交易序號查詢
2：使用 Gateway 平台交易序號查詢
3：使用全支付或錢包交易序號查詢
trade_no string 欲查詢訂單號，依 order_no_type 類型需填入相對應的訂單號
order_no_type：1，特店交易序號(mer_trade_no)
order_no_type：2，Gateway 平台退款交易序號(gate_trade_no)
order_no_type：3，錢包付款交易序號(px_trade_no)
req_time string 發送日期時間(yyyyMMddHHmmss)
ex：20210101120901

Request

GET /v1/payment/integrate/search?type=PX_QRCODE_PAY&request={"verify_code":"0BD5507B08D44058AA9E560F859B98E8CED0C5AF2F9D4A6AB22EAAAEDB4755C0","store_id":"M0000043","store_english_name":"lafresh","order_no_type":1,"trade_no":"202101230000001","req_time":"20180301230111"}&store_id=0&is_test=FALSE

Response Body Parameters

Name Type Description
status_code string 查詢結果代碼
若非回覆 0000(成功) trade_info 為null
  • 0000：查詢成功
  • PT0001：付款/退款處理中
  • 其它：查詢失敗
status_message string 交易結果訊息
order_type integer 訂單類型
0：查無訂單
1：付款訂單
2：退款訂單
trade_info TradeInfo 訂單交易資訊，依的 order_type 不同，回覆的資料結也不同，若查無訂單回覆 null
(optional)

Response Body Parameters - Trade Info

Name Type Description
mer_trade_no string 付款特店序號
gate_trade_no string 付款 Gateway 平台序號
(optional)
px_trade_no string 全支付或錢包交易序號
amount integer 訂單金額
trade_amount integer 支付金額
訂單金額扣除折抵金額後之金額
discount_amount integer 折抵金額
無折抵回覆 0
px_trade_time string 全支付交易日期時間(yyyyMMddHHmmss)
invo_carrier string 手機條碼載具，若會員於全支付綁定條碼載具必回覆
(optional)
mem_card_no string 特店會員 token
若全支付會員未綁定商戶會員此欄位回覆空值
(optional)
pay_tool_info Pay Tool Info 付款工具資訊
若付款交易成功(status_code = 0000)必回覆此欄位資料
marketing Marketing 共同行銷活動折抵結果

Response Body Parameters - Pay Tool Info

Name Type Description
pay_tool integer 支付工具
ALLOWED VALUES:
  • 1：信用卡
  • 2：AccountLink
  • 4：全支付或錢包儲值帳戶
tool_name string 支付工具名稱
identity string 支付工具識別碼
(optional)

Response Body Parameters - Marketing

Name Type Description
marketing_code string 共同行銷活動代碼
(optional)
discount integer 折扣金額，若無法折抵回覆 0
若活動定義為折數折扣，計算結果四捨五入至整數
(optional)

Response - Order Not Found

{
  "status_code": "xxxx",
  "status_message": "查無訂單",
  "order_type": 0,
  "trade_info": null
}

Response - Payment Successful

{
  "status_code": "0000",
  "status_message": "查詢成功",
  "order_type": 1,
  "trade_info": {
    "mer_trade_no": "202101230000001",
    "gate_trade_no": null,
    "px_trade_no": "PXO023892398239",
    "status_code": "0000",
    "status_message": "交易成功",
    "amount": 300,
    "trade_amount": 290,
    "discount_amount": 10,
    "px_trade_time": "20210710143259",
    "pay_tool_info": {
      "pay_tool": 1,
      "tool_name ": "華泰銀行",
      "identity": "123456******7890"
    },
    "marketing": [
      {
        "marketing_code": "aaaaaabbbbbbcccccc",
        "discount": 10
      },
      {
        "marketing_code": "aaaaaabbbbbbcccccc",
        "discount": 0
      },
      {
        "marketing_code": "ffffff777777dddddd",
        "discount": 3
      }
    ],
    "invo_carrier": "/NFVIAZP",
    "mem_card_no": "wisjnf3282o102"
  }
}

Response - Refund Successful

{
  "status_code": "0000",
  "status_message": "查詢成功",
  "order_type": 2,
  "trade_info": {
    "mer_trade_no": "202101230000002",
    "gate_trade_no": null,
    "px_trade_no": "PXO023892398240",
    "status_code": "0000",
    "status_message": "交易成功",
    "amount": 300,
    "trade_amount": 290,
    "discount_amount": 10,
    "px_trade_time": "20210710143259",
    "invo_carrier": "/NFVIAZP",
    "marketing": [
      {
        "marketing_code": "aaaaaabbbbbbcccccc",
        "discount": 10
      },
      {
        "marketing_code": "ffffff777777dddddd",
        "discount": 3
      }
    ]
  }
}