授權終止 Cancellation on Authorization
授權終止 Cancellation API
Method:POST
Domain:https://[Host]/platform/authpay/cancel
說明:
電商平台呼叫此API,解除該筆平台授權序號的授權綁定
請求參數 (Request Parameter)
參數名稱 Parameter | 資料型態 Data Type | 最大長度 Maximum | 必要的 Required | 說明 | Description |
---|---|---|---|---|---|
auth_no | string | 30 | Y | 街口端授權編號 | JKOPay authorization number |
範例 (Example):
授權終止 API Request:
POST https://{街口路徑}/platform/authpay/cancel
Content-Type: application/json
api-key: f355331eb4e1d23c00cfab0af5c67830f065214da827a910cfc0ee27e1a03d2b
digest: 3b05694dcd586b9221b7cd62aa1e9e3d1a2fcd517c9a0251e1b41c0b271853ec
{
"auth_no": "955886860685246464"
}
返回參數 (Response JSON Body)
參數名稱 Parameter | 資料型態 Data Type | 說明 | Description |
---|---|---|---|
result | string | 請參照 API 回覆代碼(ResponseCode)。 | Please refer to API response code (ResponseCode). |
message | string | 結果訊息或失敗理由。 | Result message or reason of error. |
result_object fields | 回覆物件 |
範例 (Example):
授權終止 API Response (成功):
{
"result": "000",
"message": null,
"result_object": null
}
授權終止 API Response (失敗):
{
"result": "200",
"message": "Ungranted authPay cannot be canceled",
"result_object": null
}