{"id":780,"date":"2022-07-04T16:55:55","date_gmt":"2022-07-04T08:55:55","guid":{"rendered":"https:\/\/open-doc.jkos.com\/?docs=%e6%8e%88%e6%ac%8a%e6%89%a3%e6%ac%be-authorized-payment\/api%e5%88%97%e8%a1%a8-api-lists\/%e6%8e%88%e6%ac%8a%e7%b6%81%e5%ae%9a%e5%89%b5%e5%bb%ba-authorization-binding"},"modified":"2026-02-06T16:35:37","modified_gmt":"2026-02-06T08:35:37","slug":"%e6%8e%88%e6%ac%8a%e7%b6%81%e5%ae%9a%e5%89%b5%e5%bb%ba-authorization-binding","status":"publish","type":"docs","link":"https:\/\/open-doc.jkos.com\/?docs=%e6%8e%88%e6%ac%8a%e6%89%a3%e6%ac%be-authorized-payment\/api%e5%88%97%e8%a1%a8-api-lists\/%e6%8e%88%e6%ac%8a%e7%b6%81%e5%ae%9a%e5%89%b5%e5%bb%ba-authorization-binding","title":{"rendered":"\u6388\u6b0a\u5275\u5efa Authorization Binding"},"content":{"rendered":"\n

\u6388\u6b0a\u6263\u6b3e:
\u5b9a\u671f\u5b9a\u984d (Authorized Payment-regular)
\u4e0d\u5b9a\u671f\u4e0d\u5b9a\u984d (Authorized Payment-limited)<\/h2>\n\n\n\n
\n
\n
\n
\n
\n

\u5b9a\u671f\u5b9a\u984d regular API<\/strong><\/p>\n\n\n\n

\u5b9a\u671f\u5b9a\u984d (Authorized Payment – Regular)<\/strong>
\u9069\u7528\u65bc \u8a02\u95b1\u5236<\/strong> \u6216 \u56fa\u5b9a\u91d1\u984d\u65b9\u6848<\/strong> \u7684\u4ed8\u6b3e\u6a21\u5f0f\uff0c\u4f8b\u5982\u5f71\u97f3\u4e32\u6d41\u5e73\u53f0\u3001\u6703\u54e1\u8a02\u95b1\u670d\u52d9\u7b49\u3002\u7528\u6236\u6388\u6b0a\u5f8c\uff0c\u7cfb\u7d71\u6703\u6309\u7167\u7d04\u5b9a\u7684\u9031\u671f\u8207\u91d1\u984d\u81ea\u52d5\u6263\u6b3e\u3002<\/em><\/p>\n\n\n\n

Method\uff1a<\/strong>POST<\/em>
Domain\uff1a<\/strong>
https:\/\/[Host]\/platform\/authpay\/regular<\/em><\/code><\/p>\n<\/blockquote>\n<\/div>\n\n\n\n

\n
\n

\u4e0d\u5b9a\u671f\u4e0d\u5b9a\u984d limited API<\/strong><\/p>\n\n\n\n

\u4e0d\u5b9a\u671f\u4e0d\u5b9a\u984d (Authorized Payment – Limited)<\/strong>
\u9069\u7528\u65bc \u55ae\u6b21\u6027\u8cfc\u8cb7<\/strong> \u6216 \u8b8a\u52d5\u91d1\u984d\u652f\u4ed8<\/strong>\uff0c\u4f8b\u5982\u8ab2\u91d1\u5132\u503c\u3001\u6309\u4f7f\u7528\u91cf\u8a08\u8cbb\u7684\u670d\u52d9\u7b49\u3002\u7528\u6236\u6388\u6b0a\u5f8c\uff0c\u5546\u6236\u53ef\u5728\u6388\u6b0a\u7bc4\u570d\u5167\u9032\u884c\u6263\u6b3e\uff0c\u4f46\u6263\u6b3e\u6642\u9593\u8207\u91d1\u984d\u4e0d\u56fa\u5b9a\u3002<\/em><\/p>\n\n\n\n

Method\uff1a<\/strong>POST<\/em>
Domain\uff1a<\/strong>
https:\/\/[Host]\/platform\/authpay\/limited<\/code><\/em><\/p>\n<\/blockquote>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n\n\n\n

\n

\u8aaa\u660e\uff1a<\/strong>
\u5e73\u53f0\u4f9d\u7167\u9700\u6c42\u64c7\u4e00\u547c\u53ebAPI\u53d6\u5f97\u8857\u53e3\u4ed8\u6b3e\u7684URL(authpay_url)\u7b49\u8cc7\u8a0a<\/p>\n\n\n\n

\u6ce8\u610f\u4e8b\u9805\uff1a<\/strong>
1. \u5e73\u53f0\u6388\u6b0a\u7d81\u5b9a\u7de8\u865f\u70ba\u552f\u4e00\u503c\u4e0d\u53ef\u91cd\u8907
2. \u7576\u6388\u6b0a\u7d81\u5b9a\u672a\u5b8c\u6210\u524d\uff0c\u91cd\u8907\u547c\u53eb\u6b64API\u6703\u56de\u8986\u540c\u4e00\u8857\u53e3\u7d81\u5b9a\u7db2\u5740
3. \u5b9a\u671f\u5b9a\u984dAPI\u8207\u4e0d\u5b9a\u671f\u4e0d\u5b9a\u984dAPI Request\/Response\u898f\u683c\u76f8\u540c<\/p>\n<\/blockquote>\n\n\n\n

\u8acb\u6c42\u53c3\u6578 (Request Parameter)<\/h3>\n\n\n\n
\u53c3\u6578\u540d\u7a31<\/strong>
Parameter<\/th>		\u8cc7\u6599\u578b\u614b<\/strong>
Data Type<\/th>		\u6700\u5927\u9577\u5ea6<\/strong>
Maximum<\/th>		\u5fc5\u8981<\/strong>\u7684
Required<\/th>		\u8aaa\u660e<\/strong><\/th>Description<\/th><\/tr><\/thead>
authpay_name<\/td>string<\/td>60<\/td>Y<\/td>\u6388\u6b0a\u6263\u6b3e\u9805\u76ee<\/td>Authorization payment name.<\/td><\/tr>
store_id<\/td>string<\/td>36<\/td>Y<\/td>\u5546\u5e97\u7de8\u865f
\u8acb\u4f9d\u8857\u53e3\u63d0\u4f9b\u7684\u6e2c\u8a66\/\u6b63\u5f0f\u5546\u5e97
\u4ee3\u78bc\u66f4\u65b0\u3002<\/td>		Store ID. Please update according to the test and production environment ID provided by JKOPAY.<\/td><\/tr>
platform_authpay_id <\/td>string<\/td>60<\/td>N<\/td>\u5e73\u53f0\u6388\u6263\u7de8\u865f\uff08\u7559\u5b58\u7528\uff09<\/td>Platform\u2019s authorization ID (for record-keeping).<\/td><\/tr>
identities<\/td>string[]<\/td><\/td>N<\/td>\u6388\u6263\u6388\u6b0a\u7d81\u5b9a\u4eba\u9a57\u8b49<\/td>The ID of the authorized person.<\/td><\/tr>
billing_amount<\/td>decimal<\/td>20,0<\/td>Y<\/td>\u539f\u59cb\u6263\u6b3e\u91d1\u984d<\/td>Original deduction amount; required for recurring fixed amount payment.<\/td><\/tr>
billing_currency<\/td>string<\/td><\/td>N<\/td>\u539f\u59cb\u6263\u6b3e\u5e63\u5225\uff0c\u9810\u8a2dTWD<\/td>Original currency deducted, default = TWD.<\/td><\/tr>
billing_cycle fields<\/td><\/td><\/td>\u5b9a\u671f\u5b9a\u984d: Y
\u4e0d\u5b9a\u671f\u4e0d\u5b9a\u984d: N<\/td>		\u5b9a\u671f\u5b9a\u984d\u6263\u6b3e\u9031\u671f\u8207\u6b21\u6578\u5b9a\u7fa9<\/td>Deduction cycle and times (For type is regular).<\/td><\/tr>
billing_cycle.period<\/td>string<\/td><\/td><\/td>\u6263\u6b3e\u9031\u671f\uff0c\u6642\u5340\u9650\u5236\u70baUTC+8\uff0c\u9650\u5e36\u5165\u4ee5\u4e0b\u5b57\u4e32(e.g.week)
week: \u9031\uff08Sun\uff5eMon\uff09
month: \u6708
quarter: \u5b63
year: \u5e74<\/td>		Deduction cycle period, timezone is UTC+8, and input the following string only (e.g.week)
week: (from Sunday to Monday).
month
quarter
year<\/td><\/tr>
billing_cycle.times<\/td>int<\/td><\/td><\/td>\u6bcf\u9031\u671f\u5167\uff0c\u6263\u6b3e\u6b21\u6578\u3002
\uff08\u9650\u5e36\u5165\u6574\u6578\uff0c\u5982\u672a\u5e36\u6b64\u53c3\u6578\uff0c\u7cfb\u7d71\u9810\u8a2d\u70ba1\u6b21\uff09
Week <= 7\u6b21
Month <= 7\u6b21
Quarter <= 7\u6b21
Year <= 12\u6b21<\/td>		The deduction time in regular period (input int only, default = 1).
If the period is a week, then the times-limit <= 7
If the period is a month, then the times-limit <= 7
If period is a quarter, then the times-limit <= 7
If the period is a year, then the times-limit <= 12<\/td><\/tr>
result_url<\/td>string<\/td>500<\/td>Y<\/td>\u7531\u5e73\u53f0\u5be6\u4f5c\u6b64callback URL ( \u5fc5\u9808 https<\/strong> )\u3002
\u6d88\u8cbb\u8005\u7d81\u5b9a\u5b8c\u6210\u5f8c\uff0c\u8857\u53e3\u670d\u52d9\u5668\u8a2a\u554f\u6b64\u5e73\u53f0\u670d\u52d9\u5668\u7db2\u5740\uff0c\u4e26\u5728\u53c3\u6578\u4e2d\u63d0\u4f9b\u6388\u6263\u7de8\u865f\u8207\u7d81\u5b9a\u4ea4\u6613\u72c0\u614b\u4ee3\u78bc\u3002<\/td>		Callback URL (https) implemented by the merchant platform.
After the user has completed authorization binding, JKO calls the platform\u2019s server and provides the authorization ID and binding status code.<\/td><\/tr>
result_display_url<\/td>string<\/td>500<\/td>N <\/td>\u7531\u5e73\u53f0\u5be6\u4f5c\u6b64\u5ba2\u6236\u7aef ( \u53ef\u4ee5\u662f http\/https
url )\u3002
\u6d88\u8cbb\u8005\u6388\u6b0a\u540c\u610f\u5f8c\uff0c\u6d88\u8cbb\u8005\u6703\u88ab\u5c0e\u5411\u7684\u5e73\u53f0\u5ba2\u6236\u7aef\u7d50\u679c\u7db2\u9801\u3002<\/td>		Client http\/https url implemented by the platform.
After the user has granted authorization, the user will be directed to the merchant platform\u2019s result page.<\/td><\/tr>
custom_items fields<\/td><\/td><\/td>N<\/td><\/td><\/td><\/tr>
custom_items.name<\/td>string<\/td><\/td><\/td>\u5ba2\u88fd\u5316\u9805\u76ee\u540d<\/td>Custom items\u2019 name.<\/td><\/tr>
custom_items.value<\/td>string<\/td><\/td><\/td>\u5ba2\u88fd\u5316\u9805\u76ee\u5167\u5bb9<\/td>The description of custom items.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

\u7bc4\u4f8b (Example)\uff1a<\/strong><\/h2>\n\n\n\n

\u5b9a\u671f\u5b9a\u984d regular API Request\uff1a<\/strong><\/p>\n\n\n\n

POST https:\/\/{\u8857\u53e3\u8def\u5f91}\/platform\/authpay\/regular
Content-Type: application\/json
api-key: 054e3b308708370ea029dc2ebd1646c498d59d7203c9e1a44cf0484df98e581a
digest: e5efae3b79817a2469df9403ae7b8ef3b67feafe414b8a4837c10712ace8629e

{
  \"authpay_name\": \"regular authorized payment\",
  \"store_id\": \"35f12dff-1581-11e9-a054-00505684fd45\",
  \"platform_authpay_id\": \"authpay_001\",
  \"billing_amount\": 1000,
  \"billing_currency\": \"TWD\",
  \"result_url\": \"https:\/\/test-platform\/authpay\/result\",
  \"billing_cycle\": {
    \"period\": \"month\",
    \"times\": 2
  }
}<\/code><\/pre>\n\n\n\n
\u4e0d\u5b9a\u671f\u4e0d\u5b9a\u984d limited API Request\uff1a<\/strong><\/p>\n\n\n\n
POST https:\/\/{\u8857\u53e3\u8def\u5f91}\/platform\/authpay\/limited
Content-Type: application\/json
api-key: 28c42b4854360183b2ffa2e0d116026de7aa5deeaeed24eb0cd11c38a6e3c3c4
digest: a10901aa0a69a3fdafe517794ca2cd552490aabe856f1a5e2590175c02066f97

{
  \"authpay_name\": \"limited authorized payment\",
  \"store_id\": \"8a392ff5-69c4-11ef-94d5-005056b665e9\",
  \"platform_authpay_id\": \"authpay_002\",
  \"result_url\": \"https:\/\/test-platform\/authpay\/result\"
}<\/code><\/pre>\n\n\n\n
\u8fd4\u56de\u53c3\u6578 (Response JSON Body)<\/h3>\n\n\n\n
\u53c3\u6578\u540d\u7a31<\/strong>
Parameter<\/th>		\u8cc7\u6599\u578b\u614b<\/strong>
Data Type<\/th>		\u8aaa\u660e<\/strong><\/th>Description<\/th><\/tr><\/thead>
result<\/td>string<\/td>\u8acb\u53c3\u7167 API \u56de\u8986\u4ee3\u78bc\uff08ResponseCode\uff09\u3002<\/td>Please refer to API response code (ResponseCode).<\/td><\/tr>
message<\/td>string<\/td>\u7d50\u679c\u8a0a\u606f\u6216\u5931\u6557\u7406\u7531\u3002<\/td>Result message or reason of error.<\/td><\/tr>
result_object fields<\/td><\/td><\/td><\/td><\/tr>
result_object.auth_no<\/td>string<\/td>\u8857\u53e3\u7aef\u6388\u6b0a\u7de8\u865f<\/td>JKOPay authorization number.<\/td><\/tr>
result_object.authpay_url<\/td>string<\/td>\u6388\u6b0a\u7d81\u5b9a\u5c0e\u5411\u7db2\u5740\uff0c\u8857\u53e3 Server \u5224\u65b7 :
– \u96fb\u8166\u6216\u5e73\u677f\u7db2\u9801\u4ea4\u6613\u74b0\u5883\uff0c\u63d0\u4f9b\u8857\u53e3\u4ed8\u6b3eQRCode\u5c0e\u5411\u7db2\u5740\u3002
– \u884c\u52d5\u88dd\u7f6e\u652f\u4ed8\u74b0\u5883\uff0c\u5f9e\u6d88\u8cbb\u8005\u624b\u6a5f\u91cd\u65b0\u5c0e\u5411\u5230\u8857\u53e3App\u4ed8\u6b3e\u9801\u9762\u3002<\/td>		Authorization binding URL where users will be directed to. JKO Server will systematically determine whether the user is on :
 — Personal computer or notebook device payment environment, will provide JKOPAY payment QRCode web URL.
 — Mobile device payment environment and directs users to JKOPAY app\u2019s payment interface.<\/td><\/tr>
result_object.qr_img<\/td>string<\/td>QRCode \u5716\u6a94\uff0c\u5e73\u53f0\u53ef\u5c07 QRCode \u5d4c\u5165\u5e73\u53f0\u7db2\u9801\u3002<\/td>QRCode image – an online merchant platform may integrate QRCode image into its own payment flow according to web page style.<\/td><\/tr>
result_object.qr_timeout<\/td>timestamp<\/td>QRCode\/authpay_url \u5931\u6548\u6642\u9593\u3002\u56de\u8986\u7684 authpay_url\u8207
QRCode \u53ef\u5728 20 \u5206\u9418\u5167\u4f7f\u7528\u3002<\/td>		QRCode\/authpay_url timeout time.
The returned authpay_url and QRCode are valid within 20 minutes.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
\u7bc4\u4f8b (Example)\uff1a<\/h3>\n\n\n\n
\u6210\u529f success response\uff1a<\/h4>\n\n\n\n
{
  \"result\": \"000\",
  \"message\": null,
  \"result_object\": {
    \"auth_no\": \"650660555924205568\",
    \"authpay_url\": \"https:\/\/test-authpay.jkopay.app\/web\/authpay\/url?j=cDpxcl90aW1lb3V0PTE2MzUyOTcyMjk3MjksYXV0aF9ubz02NTA2NjA1NTU5MjQyMDU1Njg7czo3MWEwYjIyOTkxMDEwZGRkY2FmNThhNDgwYTgxMTQyNzJhYmIzMTU1YWU5ZDJjMDQ5NGNhYjRmNjZhNjY2ODI5\",
    \"qr_img\": \"https:\/\/test-authpay.jkopay.app\/web\/authpay\/url?j=cDpxcl90aW1lb3V0PTE2MzUyOTcyMjk3MjksYXV0aF9ubz02NTA2NjA1NTU5MjQyMDU1Njg7czo3MWEwYjIyOTkxMDEwZGRkY2FmNThhNDgwYTgxMTQyNzJhYmIzMTU1YWU5ZDJjMDQ5NGNhYjRmNjZhNjY2ODI5\",
    \"qr_timeout\": 1635297229729
  }
}<\/code><\/pre>\n\n\n\n
\u5931\u6557 failure response\uff1a<\/h4>\n\n\n\n
{
  \"result\": \"200\",
  \"message\": \"Bad request\",
  \"result_object\": null
}<\/code><\/pre>\n\n\n\n
<\/h2>\n","protected":false},"featured_media":0,"parent":756,"menu_order":3,"comment_status":"open","ping_status":"closed","template":"","doc_tag":[],"class_list":["post-780","docs","type-docs","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/open-doc.jkos.com\/index.php?rest_route=\/wp\/v2\/docs\/780","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/open-doc.jkos.com\/index.php?rest_route=\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/open-doc.jkos.com\/index.php?rest_route=\/wp\/v2\/types\/docs"}],"replies":[{"embeddable":true,"href":"https:\/\/open-doc.jkos.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=780"}],"version-history":[{"count":17,"href":"https:\/\/open-doc.jkos.com\/index.php?rest_route=\/wp\/v2\/docs\/780\/revisions"}],"predecessor-version":[{"id":1608,"href":"https:\/\/open-doc.jkos.com\/index.php?rest_route=\/wp\/v2\/docs\/780\/revisions\/1608"}],"up":[{"embeddable":true,"href":"https:\/\/open-doc.jkos.com\/index.php?rest_route=\/wp\/v2\/docs\/756"}],"next":[{"title":"\u6388\u6b0a\u6263\u6b3e Authorization deduction request","link":"https:\/\/open-doc.jkos.com\/?docs=%e6%8e%88%e6%ac%8a%e6%89%a3%e6%ac%be-authorized-payment\/api%e5%88%97%e8%a1%a8-api-lists\/%e6%8e%88%e6%ac%8a%e6%89%a3%e6%ac%be%e7%99%bc%e5%8b%95-merchant-platform-authorization-request","href":"https:\/\/open-doc.jkos.com\/index.php?rest_route=\/wp\/v2\/docs\/816"}],"prev":[{"title":"\u6388\u6b0a\u7d81\u5b9a\u7d50\u679c\u901a\u77e5 Authorization CallBack","link":"https:\/\/open-doc.jkos.com\/?docs=%e6%8e%88%e6%ac%8a%e6%89%a3%e6%ac%be-authorized-payment\/api%e5%88%97%e8%a1%a8-api-lists\/%e6%8e%88%e6%ac%8a%e7%b6%81%e5%ae%9a%e7%b5%90%e6%9e%9c%e9%80%9a%e7%9f%a5-authorization-callback","href":"https:\/\/open-doc.jkos.com\/index.php?rest_route=\/wp\/v2\/docs\/1267"}],"wp:attachment":[{"href":"https:\/\/open-doc.jkos.com\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=780"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/open-doc.jkos.com\/index.php?rest_route=%2Fwp%2Fv2%2Fdoc_tag&post=780"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}