1. Home
  2. Docs
  3. 授權扣款 Authorized Payment
  4. API列表 (API Lists)
  5. 授權狀態查詢 Inquiry on Authorization Status

授權狀態查詢 Inquiry on Authorization Status

Domain:https://{Please update according to test/production path provided by JKOPAY}/platform/authpay/detail

Method:GET

說明:電商平台呼叫此API,可利用街口端授權編號來查詢此筆授權狀態。

Merchant platform calls this API to confirm user’s Authorization Status.

整合流程 (Integration Workflow)

Merchant platform inquiry workflow on authorization status

請求參數 (Request Parameter)

參數名稱
Parameter
資料型態
Data Type
最大長度
Maximum
必要
Required
說明Description
auth_noString30Y街口端授權編號Jkopay authorization number

範例 (Example):

https://{domain}/platform/authpay/detail?auth_no=02412421xxxx

返回參數 (Response JSON Body)

參數名稱
Parameter
資料型態
Data Type
說明Description
authpay[]GrantedAuthPay授權資料Granted authpay information

範例 (Example):

{
	"result": "000",
	"message": null,
	"result_object": {
		"authpay": {
			"type": "regular",
			"auth_no": "591692855148417025",
			"status": "granted",
			"platform_authpay_id": "AUTHPAY_002",
			"jkos_account": "9xxxxxxxx",
			"billing_cycle":{
				"period": "month",
				"times": 1
			},
			"billing_amount": 100,
			"billing_currency": "TWD"
		}
	}
}