授權終止 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
}

由街口發動 – 商家會收到由街口發送的結果通知URL

終止授權綁定結果通知Callback URL實作規格

Method：POST

說明：
由平台實作此接收通知 URL (https)，並將 URL （測試環境與正式環境）提供給街口，街口發起解綁成功後，會呼叫此 API 通知電商平台解綁成功。

街口認定HTTP Status Code 200 為成功，HTTP Status Code 500 認定失敗

連線規則：
Connection timeout：5 秒
Read timeout：10 秒

請求參數 (Request Parameter)

參數名稱 Parameter	資料型態 Data Type	最大長度 Maximum	必要的 Required	說明	Description
auth_no	string	30	Y	街口端授權編號	JKOPay authorization number
platform_authpay_id	String	60	N	平台授扣編號（留存⽤）	Platform’s authorization ID (for record-keeping).
cancal_time	datetime string		Y	授權終⽌時間 YYYY-mm-dd HH:MM:SS	Time of Cancellation

範例 (Example)：

{
"auth_no": "609469846329102336",
"platform_authpay_id": "AUTHPAY_001",
"cancel_time": "2021-10-27 09:04:51"
}

HTTP Response

HTTP 200