Jkos Online Pay Refund
Description
街口線上支付退款。
Resource
POST /v1/payment/jkos/online/refund
Authorization
採用 OAuth 2.0 Bearer Token，詳細使用流程請參考 Auth Login。
Request Body Parameters
| Name | Type | Description |
|---|---|---|
| store_id | string | 門市編號 |
| order_id | string | 訂單編號 |
| use_self_jkos_params | boolean | 使用自己帶的金流參數 (option) |
| jkos_store_id | string | 街口線上支付商店編號 (option) |
| jkos_api_key | string | 街口線上支付API金鑰 (option) |
| jkos_secret_key | string | 街口線上支付加密金鑰 (option) |
Request Example
{
"store_id": "MYYJ01",
"order_id": "MYYJ01250505004",
"use_self_jkos_params": true,
"jkos_store_id": "2166480e-15ab-11f0-94d5-005056b665e9",
"jkos_api_key": "TJxSPLd78-AUTG8bisnaAAdduAwzJyEM",
"jkos_secret_key": "cAel-zb6Nd75Jj3tdddIYXE8kAXKJnWLRSFpEINRgLqddS_cCPLf63YeLFw8Y0N78_QTshvl6JlxEOhBQCevlg"
}
Response Body Parameters
| Name | Type | Description |
|---|---|---|
| result | Result | 請參照 API 回覆代碼 |
| message | string | 結果訊息或失敗理由 |
| result_object | Result Object | 細節 |
Response Body Parameters - Result Object
| Name | Type | Description |
|---|---|---|
| refund_tradeNo | string | 街口端退款交易序號 |
| debit_amount | integer | 消費者付款方式退款金額 |
| redeem_amount | integer | 退還折抵金額 |
| redeem_detail | Refund Redeem Detail | 折抵明細 |
| refund_time | string | 退款時間 |
Response Body Parameters - Refund Redeem Detail
| Name | Type | Description |
|---|---|---|
| jko_coin_amount | integer | 街口幣折抵金額 |
| official_coupon_amount | integer | 官方街口券折抵金額 |
| store_coupon_amount | integer | 店家街口券折抵金額 |
Response Body Parameters - Status Code
| Status Code | Description |
|---|---|
| 000 | 交易成功 |
| 100 | 訂單不存在 |
| 101 | 此訂單號已付款 |
| 103 | 退款金額錯誤 |
| 105 | 1. remain_amount 金額不正確 2. refund_amount 金額不一致（當refund_amount與先前同refund_order_id請求不一致） |
| 108 | 1. 店家收款額度已達上限 2. 用戶在該店家每日交易已達限額 |
| 113 | 因退款金額大於店家累計未請款金額，故退款失敗 |
| 200 | 失敗；參數錯誤 |
| 201 | 失敗；參數錯誤 |
| 922 | 退款總金額超過原訂單金額 |
| 999 | 其他 |
Response Example - Http Code 200
{
"result": "000",
"message": null,
"result_object": {
"refund_tradeNo": "K0081521125050500006",
"refund_time": "2025-05-05 16:49:49",
"debit_amount": 100,
"redeem_amount": 0,
"transaction_seq": null,
"redeem_detail": {
"jko_coin_amount": 0,
"official_coupon_amount": 0,
"store_coupon_amount": 0
}
}
}