Skip to content

Top-up Stored Value Card

Description

加值儲值卡。

Resource

POST /v1/card/top_up

Authorization

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

Request Body Parameters

Name Type Description
store_id string 門市編號
vip_id string 會員編號
(option)
card_no string 儲值卡號
amount integer 儲值金額
payment Payment 付款資訊
order_id string 儲值單號
client string
(enum)		 客戶端
ALLOWED VALUES:
  • ONLINE: 線上
  • OFFLINE: 線下
mode string
(enum)		 模式
ALLOWED VALUES:
  • TOP_UP: 儲值
  • AMOUNT_DEPOSIT: 儲值金轉入

Request Body Parameters - Payment

Name Type Description
id string
(enum)		 付款方式編號
ALLOWED VALUES:
  • Q005: NCCC PAY
  • Q038: 藍新金流
type string
(enum)		 付款方式類型
ALLOWED VALUES:
  • CASH: 現金
  • CREDIT_CARD: 信用卡
credit_card_info Credit Card Info 信用卡資訊
(option)

Request Body Parameters - Credit Card Info

Name Type Description
first_six_digits string 信用卡號前6碼
last_four_digits string 信用卡號後4碼
auth_code integer 信用卡簽章授權卡

Request Example - NCCC PAY

{
    "store_id": "EC001",
    "vip_id": "VIP0009",
    "card_no": "MO1234567876543",
    "amount": 100,
    "payment": {
        "id": "Q005",
        "type": "CREDIT_CARD",
        "credit_card_info": {
            "first_six_digits": "438045",
            "last_four_digits": "2708",
            "auth_code": "547296"
        }
    },
    "order_id": "00003024111500001",
    "client": "ONLINE",
    "mode": "TOP_UP"
}

Request Example - NCCC PAY

{
    "store_id": "EC001",
    "vip_id": "VIP0009",
    "card_no": "MO1234567876543",
    "amount": 100,
    "payment": {
      "id": "Q038",
      "type": "CREDIT_CARD"
    },
    "order_id": "00003024111500001",
    "client": "ONLINE",
    "mode": "TOP_UP"
}

Response Body Parameters

Name Type Description
code Code 執行結果代碼
message string 執行結果說明
transaction_info Transaction Info 交易資訊
(option，code = 0000 才會回傳)

Response Body Parameters - Code

Status Code Description
0000 執行成功
0001 卡片未開卡
0002 卡片已關卡
0003 卡片已作廢
0004 卡片已開卡
0005 信託額度不足
0006 舊卡號不得等於新卡號
0007 舊卡狀態不符
0008 新卡狀態不符
0009 卡號不得為空
0010 條碼不存在
0011 手機號碼必須相同
0012 會員ID已記名
0013 卡號已存在
1001 禮物卡無法儲值
1002 卡片已超過儲值上限
1003 員工點無法儲值
2001 點數不足請先儲值
2002 該卡無法使用於此消費
3001 補點失敗
4001 查無此訂單
4002 退費金額不符(信託點)
4003 退費金額不符(贈點)
4004 退費金額不符(員工點)
5001 註冊帳號重複
5002 註冊手機重複
5003 註冊Mail重複
5004 查無該號碼的驗證碼請求
5005 驗證碼錯誤
5006 超過驗證時間
5007 帳號或密碼錯誤
5008 超過簡訊發送次數
5009 此卡片已綁定會員
5010 未設定認證發送方式
8001 UID或PID錯誤
8002 資料異常
8003 操作人員異常
9990 AES解密失敗
9992 key格式驗證錯誤
9993 檢查碼驗證失敗
9994 檢查碼不能為空
9995 實際交易加密電文不能為空
9996 模組名稱不能為空
9997 廠商串接專用代碼不能為空
9998 資料格式錯誤
9999 失敗

Response Body Parameters - Transaction Info

Name Type Description
card_no string 儲值卡號
transaction_id string 加值平台交易編號
balance integer 儲值卡餘額

Response

HTTP-Status-Code: 200 

{
    "code": "0000",
    "message": "執行成功",
    "transaction_info": {
        "card_no": "MO1234567876543",
        "transaction_id": "BBBuB20240607135745",
        "balance": 183
    }
}

HTTP-Status-Code: 400 

{
    "code": "WX9999",
    "message": "依全通路回傳"
}