Skip to content

Easy Wallet Pay

Description

線下悠遊付付款。

Resource

POST /v2/payment/easy/pay

Authorization

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

Request Body Parameters

Name Type Description
requestDateTime string 商店請求日期時間,yyyyMMddHHmmss
order Order 訂單資訊
retry_time int 重試序號(若有進行重新請求付款的重試次數)
(optional)

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 不適用回饋金額 (例如:菸、酒品項合計金額)
paymentBarCode string 付款條碼,前兩碼為固定值。
branchCode string 分店代碼
branchName string 分店名稱
(optional)
posSN string POS 機台序號
(optional)
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 Example

{
  "requestDateTime": "20190612154311",
  "order": {
    "merchantOrderNo": "108010100202",
    "currency": "TWD",
    "orderTitle": "6-TEN",
    "orderDesc": "6-TEN 南港南園店",
    "tradeType": "IMMEDIATE",
    "orderAmount": 110,
    "eventCode": "EF3293",
    "rebateNotApplicableAmount": 0,
    "paymentBarCode": "94300293390140",
    "branchCode": "14313",
    "branchName": "南港南園店",
    "posSN": "A03",
    "orderItems": [
      {
        "item": "紅茶",
        "qty": 2,
        "unitPrice": 25,
        "subtotal": 50,
        "itemDesc": "好喝的紅茶"
      },
      {
        "item": "綠茶",
        "qty": 3,
        "unitPrice": 20,
        "subtotal": 60,
        "itemDesc": "健康的綠茶"
      }
    ]
  }
}

Response Body

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 不適用回饋金額 (例如:菸酒品項合計金額)
isDuplicatedPaymentRequest bool 是否為重覆付款請求
einvoiceCarrier EInvoiceCarrier 電子發票載具

Response Body Parameters - EInvoiceCarrier

Name Type Description
einvoiceCarrierType string 載具類型

ALLOWED VALUES:
  • 3J0002:手機條碼
  • CQ0001:自然人憑證條碼
einvoiceCarrierNo string 載具編號
dntFlag string 是否贈送

ALLOWED VALUES:
  • Y:是
  • N:否
dntNo string 愛心碼

Response Example

{
  "returnCode": "00000",
  "returnMsg": "SUCCESS",
  "data": {
    "sellerMemberUid": "1084308382",
    "merchantOrderNo": "108010100202",
    "orderNo": "10806130321433",
    "paymentNo": "14334434434417",
    "orderStatus": "PAYMENT_RECEIVED",
    "orderCreateDateTime": "20190612154330",
    "paymentMethod": "BALANCE",
    "currency": "TWD",
    "orderAmount": 110,
    "point": 10,
    "paymentAmount": 100,
    "eventCode": "EF3293",
    "rebateNotApplicableAmount": 0,
    "einvoiceCarrier": {
      "einvoiceCarrierType": "3J0002",
      "einvoiceCarrierNo": "/QER3DEW",
      "dntFlag": "N",
      "dntNo": ""
    }
  }
}