Skip to content

Online Easy Wallet Pay

Description

線上悠遊付付款。

Resource

POST /v1/payment/online/easy/pay

Authorization

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

Request Body Parameters

Name Type Description
requestDateTime string 商店請求日期時間,yyyyMMddHHmmss
store_id string 門市代碼
callBackUrl string 交易回傳網址(交易完成後,引導使用者回到電商的網頁)
(optional)
notifyUrl string 訂單異步通知網址(交易完成後,電商主機接收結果之網址)
(optional)
imageUrl string 圖像網址
(optional)
order Order 訂單資訊

Request Body Parameters - Order

Name Type Description
merchantOrderNo string 商店訂單編號,需是商店唯一值,不可重複。
currency string 幣別,預設為 TWD
(optional)
orderDesc string 訂單說明
(optional)
orderTitle string 訂單標題
(optional)
tradeType string 訂單類型
ALLOWED VALUES:
  • SAFEKEEPING:價金保管
  • IMMEDIATE:即時到帳

線下POS機預設傳送:IMMEDIATE
orderAmount number 訂單金額
eventCode string 活動代碼
(optional)
rebateNotApplicableAmount number 不適用回饋金額 (例如:菸、酒品項合計金額)
orderItems OrderItems 品項明細

Request Body Parameters - OrderItems

Name Type Description
item string 品項
(optional)
qty number 數量
(optional)
unitPrice number 單價
(optional)
subtotal number 小計,小計 = 數量 * 單價
(optional)
itemDesc string 品項說明
(optional)

Request

{
  "requestDateTime": "20190612153211",
  "store_id": "MTJP02",
  "callBackUrl": "http://ec.com/callback",
  "notifyUrl": "http://ec.com/notify",
  "imageUrl": "http://ec.com/image.png",
  "order": {
    "merchantOrderNo": "108010100201",
    "currency": "TWD",
    "orderTitle": "小明茶舖",
    "orderDesc": "買飲料",
    "tradeType": "IMMEDIATE",
    "orderAmount": 110,
    "eventCode": "EVNEIE",
    "rebateNotApplicableAmount": 0,
    "orderItems": [
      {
        "item": "紅茶",
        "qty": 2,
        "unitPrice": 25,
        "subtotal": 50,
        "itemDesc": "好喝的紅茶"
      },
      {
        "item": "綠茶",
        "qty": 3,
        "unitPrice": 20,
        "subtotal": 60,
        "itemDesc": "健康的綠茶"
      }
    ]
  }
}

Response

{
  "returnCode": "00000",
  "returnMsg": "成功",
  "data": {
    "sellerMemberUid": "1084308382",
    "merchantOrderNo": "108010100201",
    "orderNo": "10806130438932",
    "paymentNo": "18431982394638",
    "orderStatus": "PAYMENT_RECEIVED",
    "orderCreateDateTime": "20190612153250",
    "paymentMethod": "BALANCE",
    "currency": "TWD",
    "orderAmount": 110,
    "point": 20,
    "paymentAmount": 90,
    "eventCode": "EVNEIE",
    "rebateNotApplicableAmount": 0,
    "maskCreditCardNo": "",
    "cobrandedCode": "",
    "redirectPaymentUrl": "http://uupay.com.tw/LAKDJF0943983KDA0D928"
  }
}

Response Body Parameters

Name Type Description
returnCode stringstring 回覆代碼,00000:為成功
returnMsg string 回覆訊息,當 returnCode 不為 00000 時回覆的訊息,供參考使用
data Data 相關資料

Response Body Parameters - Data

Name Type Description
sellerMemberUid string 收款會員編號
merchantOrderNo string 商店訂單編號
orderNo string 訂單編號,悠遊付系統產生之訂單編號
paymentNo string 付款交易編號
orderStatus string 訂單狀態
orderCreateDateTime string 訂單建立日期時間,yyyyMMddHHmmss
paymentMethod string 支付工具
ALLOWED VALUES:
  • CREDIT_CARD:信用卡
  • BALANCE:電子支付帳戶餘額
  • ACCTLINK:約定連結帳戶
currency string 幣別
orderAmount number 訂單金額
point number 使用點數
paymentAmount number 支付金額=訂單金額-使用點數
eventCode string 活動代碼
rebateNotApplicableAmount number 不適用回饋金額 (例如:菸酒品項合計金額)
maskCreditCardNo string 遮罩卡號前六碼與後四碼明碼。若支付工具為信用卡,才回覆
cobrandedCode string 聯名卡代碼。若支付工具為信用卡時,若為聯名卡,才回覆
redirectPaymentUrl string 付款轉導頁