Skip to content

Integrate Easy QRCode Pay

Description

Easy Pay 條碼支付。
Easy Pay 金流參數:商店手續費合約編號、收款會員編號、安全碼
情境:

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

Resource

POST /v1/payment/integrate/pay

Authorization

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

Request Body Parameters

Name Type Description
type string 付款方式,請輸入 EASY_QRCODE_PAY
request Request 請求參數
store_id string 門市代碼
(optional)
is_test boolean 是否為測試環境
  • 在全通路正式環境預設為 false
  • 在全通路測試環境預設為 true
(optional)

Request Body Parameters - Request

Name Type Description
requestDateTime string 商店請求日期時間,yyyyMMddHHmmss
merchantOrderNo string 商店訂單編號,需是商店唯一值,不可重複
contractNo string 商店手續費合約編號
(optional)
sellerMemberUid string 收款會員編號
(optional)
securityCode string 安全碼
(optional)
currency string 幣別,預設為 TWD,詳 ISO 4217-字母代碼
(optional)
orderDesc string 訂單說明
(optional)
orderTitle string 訂單標題
(optional)
tradeType string 訂單類型
  • SAFEKEEPING:價金保管
  • IMMEDIATE:即時到帳

線下 POS 機預設傳送 IMMEDIATE
orderAmount integer 訂單金額
eventCode string 活動代碼
(optional)
rebateNotApplicableAmount integer 不適用回饋金額 (例如:菸、酒品項合計金額)
paymentBarCode string 付款條碼,前兩碼為固定值
branchCode string 分店代碼
(optional)
branchName string 分店名稱
(optional)
posSN string POS 機台序號
(optional)
orderItems Order Item 訂單品項明細

Request Body Parameters - Order Item

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

Request

{
  "type": "EASY_QRCODE_PAY",
  "request": {
    "requestDateTime": "20190612154311",
    "merchantOrderNo": "108010100202",
    "contractNo": "3542365357",
    "sellerMemberUid": "1201911010000005",
    "securityCode": "70314e48724e716962586b50416674524b554a3141545a36783269463973396d",
    "currency": "TWD",
    "orderDesc": "6-TEN 南港南園店",
    "orderTitle": "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": "健康的綠茶"
      }
    ]
  },
  "store_id": "0",
  "is_test": false
}

Response Body Parameters

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

Response Body Parameters - Data

Name Type Description
sellerMemberUid string 收款會員編號
merchantOrderNo string 商店訂單編號
orderNo string 訂單編號,悠遊付系統產生之訂單編號
paymentNo string 付款交易編號
orderStatus Order Status 訂單狀態
orderCreateDateTime string 訂單建立日期時間,yyyyMMddHHmmss
paymentMethod string 支付工具
  • CREDIT_CARD:信用卡
  • BALANCE:電子支付帳戶餘額
  • ACCTLINK:約定連結帳戶
currency string 幣別,詳 ISO 4217-字母代碼
orderAmount integer 訂單金額
point integer 使用點數
paymentAmount integer 支付金額 = 訂單金額 - 使用點數
eventCode string 活動代碼
rebateNotApplicableAmount integer 不適用回饋金額 (例如:菸酒品項合計金額)
isDuplicatedPaymentRequest boolean 是否為重覆付款請求
  • true:是
  • false:否
einvoiceCarrier EInvoice Carrier 電子發票載具

Response Body Parameters - EInvoice Carrier

Name Type Description
einvoiceCarrierType string 載具類型
  • 3J0002:手機條碼
  • CQ0001:自然人憑證條碼
einvoiceCarrierNo string 載具編號
dntFlag string 是否捐贈
  • Y:是
  • N:否
dntNo string 愛心碼

Response Body Parameters - Return Code

Return Code Description
00000 成功
10001 付款會員電子支付帳戶不正確
10002 收款會員編號不存在
10003 合約編號不正確
10004 支付工具不支援
10005 交易模式不支援
10006 商店訂單編號已存在,不可重複
20001 訂單資訊不正確
20002 訂單不存在
20003 超過付款額度
20004 超過收款額度
20005 交易失敗
20006 餘額不足
20007 訂單已付款
30001 驗證碼錯誤
30002 請求資料結構不正確
30003 特店編號不正確
90000 系統繁忙

Response Body Parameters - Order Status

Order Status Description
PREORDER 預定單
PREORDER_VOID 預定單已逾期作廢
ORDER_VOID 訂單逾期
TRADE_FAIL 交易失敗
PAYMENT_PENDING 待付款
PAYMENT_PROCESSING 付款處理中
PAYMENT_RECEIVED 已付款
COMPLETED 已完成
PAYMENT_SAFEKEEPING 價金保管中
PAYMENT_SAFEKEEPING_EXTENDED 價金保管期延長中
PAYMENT_POSTPONED 價金暫停付款中
SELLER_CANCEL_PROCESSING 賣家取消交易處理中
SELLER_CANCELLED 賣家已取消

Response

{
  "returnCode": "0000",
  "returnMsg": "成功",
  "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": ""
    }
  }
}