Skip to content

Ocard Check Redeem

Description

Ocard 票券核銷前置驗證。KIOSK 呼叫此 API 確認 Ocard 票券是否可核銷;全通路內部自動取得 shop-level Ocard auth,KIOSK 不需傳入 uid/token。Ocard token 過期(code=305)時系統自動重試一次。

Resource

POST /v2/ticket/ocard/check_redeem

Authorization

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

Request Body Parameters

Name Type Description
store_id string 門市代碼(用於內部查詢 Ocard shop-level auth)
code string Ocard 票券 pos_code(= coupon_list[].pos_code,來自 Ocard Login 回傳)
count integer 票券數量(optional)
transDetail object 交易明細(optional)
checkSpend number 消費金額確認(optional)

Request Example

POST /v2/ticket/ocard/check_redeem

{
    "store_id": "000030",
    "code": "0PM202512160001"
}

Response Body Parameters

Name Type Description
usable boolean 票券是否可核銷。Ocard response.code=500(成功)→ true;其他 → false
message string Ocard 回傳訊息;305 認證失敗時固定回傳「Ocard 認證失敗,請重新登入」

Response Example — 可核銷

{
    "usable": true,
    "message": ""
}

Response Example — 不可核銷

{
    "usable": false,
    "message": "此票券已使用"
}

Response Example — Ocard 認證失敗(重試後仍 305)

{
    "usable": false,
    "message": "Ocard 認證失敗,請重新登入"
}

Notes

  • Ocard response.code 語意:500 = 成功(可核銷);305 = token 過期(不可核銷)
  • 此 API 永遠回傳 HTTP 200,usable 欄位才是判斷依據
  • store_id 供全通路內部取得 Ocard 認證資訊,不會直接傳給 Ocard API