{"id":798,"date":"2022-07-04T17:40:36","date_gmt":"2022-07-04T09:40:36","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%8b%80%e6%85%8b%e6%9f%a5%e8%a9%a2-inquiry-on-authorization-status"},"modified":"2026-02-06T16:35:37","modified_gmt":"2026-02-06T08:35:37","slug":"%e6%8e%88%e6%ac%8a%e7%8b%80%e6%85%8b%e6%9f%a5%e8%a9%a2-inquiry-on-authorization-status","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%8b%80%e6%85%8b%e6%9f%a5%e8%a9%a2-inquiry-on-authorization-status","title":{"rendered":"\u6388\u6b0a\u72c0\u614b\u67e5\u8a62 Inquiry on Authorization Status"},"content":{"rendered":"\n
\n

\u6388\u6b0a\u72c0\u614b\u67e5\u8a62 Inquiry API<\/strong><\/p>\n\n\n\n

Method\uff1a<\/strong>GET<\/em>
Domain\uff1a<\/strong>
https:\/\/[Host]\/platform\/authpay\/detail<\/em><\/code>?auth_no<\/span>={auth_no<\/span>}<\/p>\n<\/blockquote>\n\n\n\n

\n

\u8aaa\u660e\uff1a<\/strong>
\u5e73\u53f0\u53ef\u547c\u53eb\u6b64API\uff0c\u5229\u7528\u8857\u53e3\u7aef\u6388\u6b0a\u7de8\u865f\u4f86\u67e5\u8a62\u6b64\u7b46\u6388\u6b0a\u72c0\u614b\u3002<\/p>\n<\/blockquote>\n\n\n\n

\u8acb\u6c42\u53c3\u6578 (Request Parameter)<\/h3>\n\n\n\n
\u53c3\u6578\u540d\u7a31<\/strong>
Parameter<\/strong><\/th>		\u8cc7\u6599\u578b\u614b<\/strong>
Data Type<\/strong><\/th>		\u6700\u5927\u9577\u5ea6<\/strong>
Maximum<\/strong><\/th>		\u5fc5\u8981<\/strong>\u7684
Required<\/strong><\/th>		\u8aaa\u660e<\/strong><\/th>Description<\/th><\/tr><\/thead>
auth_no<\/td>string<\/td>30<\/td>Y<\/td>\u8857\u53e3\u7aef\u6388\u6b0a\u7de8\u865f<\/td>jkopay authorization number<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

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

\u6388\u6b0a\u72c0\u614b\u67e5\u8a62 API Request\uff1a<\/strong><\/p>\n\n\n\n

GET https:\/\/[HOST]\/platform\/authpay\/detail<\/em>?auth_no=650660555924205568<\/span>
Content-Type: application\/json
api-key: 795ca21ca75064da4d361bbc5120171e46251785891540dbf2f3af94699ae428
digest: a9fe45682ff7be3d3f13910e02776b32c70886571f8421c81c390d7fcdd717dd<\/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><\/td><\/tr>
message<\/td>string<\/td>\u7d50\u679c\u8a0a\u606f\u6216\u5931\u6557\u7406\u7531<\/td><\/td><\/tr>
result_object fields<\/td><\/td><\/td><\/td><\/tr>
result_object.authpay fields<\/td><\/td><\/td><\/td><\/tr>
result_object.authpay.type<\/td>string<\/td>\u6388\u6b0a\u985e\u578b
regular: \u5b9a\u671f\u5b9a\u984d\u6388\u6b0a\u6263\u6b3e
limited: \u4e0d\u5b9a\u671f\u4e0d\u5b9a\u984d\u6388\u6b0a\u6263\u6b3e<\/td>		Authorization type
regular: recurring payment (fixed amount)<\/td><\/tr>
result_object.authpay.auth_no<\/td>string<\/td>\u8857\u53e3\u7aef\u6388\u6b0a\u7de8\u865f<\/td>jkopay authorization number<\/td><\/tr>
result_object.authpay.status<\/td>string<\/td>\u6388\u6b0a\u72c0\u614b
ungranted: \u672a\u6388\u6b0a
granted: \u5df2\u6388\u6b0a
cancel: \u5df2\u53d6\u6d88<\/td>		Authorization status
ungranted: not yet authorized
granted: authorized
cancel: authorization canceled<\/td><\/tr>
result_object.authpay.platform_authpay_id<\/td>string<\/td>\u5e73\u53f0\u6388\u6263\u7de8\u865f\uff08\u7559\u5b58\u7528\uff09<\/td>Merchant platform authorization number(for record-keeping)<\/td><\/tr>
result_object.authpay.jkos_account<\/td>string<\/td>\u8857\u53e3\u5e33\u865f<\/td>jkopay user\u2019s account<\/td><\/tr>
result_object.authpay.billing_amount<\/td>decimal<\/td>\u539f\u59cb\u6263\u6b3e\u91d1\u984d<\/td>Original amount<\/td><\/tr>
result_object.authpay.billing_currency<\/td>string<\/td>\u539f\u59cb\u6263\u6b3e\u5e63\u5225\uff0c\u9810\u8a2d TWD<\/td>Original currency, default is TWD<\/td><\/tr>
result_object.authpay.billing_cycle fields<\/td><\/td><\/td><\/td><\/tr>
result_object.authpay.billing_cycle.period<\/td>string<\/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:\uff08From Sun to Mon\uff09
month
quarter
year<\/td><\/tr>
result_object.authpay.billing_cycle.times<\/td>int<\/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\uff09
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><\/tbody><\/table><\/figure>\n\n\n\n
\u7bc4\u4f8b (Example)\uff1a<\/h3>\n\n\n\n
\u6388\u6b0a\u72c0\u614b\u67e5\u8a62<\/strong> API Response\uff1a<\/h4>\n\n\n\n
{
  \"result\": \"000\",
  \"message\": null,
  \"result_object\": {
    \"authpay\": {
      \"type\": \"regular\",
      \"auth_no\": \"650660555924205568\",
      \"status\": \"granted\",
      \"platform_authpay_id\": \"platform_authpay_id_001\",
      \"jkos_account\": \"9xxxxxxxx\",
      \"billing_amount\": 100,
      \"billing_currency\": \"TWD\",
      \"billing_cycle\": {
        \"period\": \"month\",
        \"times\": 1
      }
    }
  }
}<\/code><\/pre>\n\n\n\n
<\/p>\n","protected":false},"featured_media":0,"parent":756,"menu_order":5,"comment_status":"open","ping_status":"closed","template":"","doc_tag":[],"class_list":["post-798","docs","type-docs","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/open-doc.jkos.com\/index.php?rest_route=\/wp\/v2\/docs\/798","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=798"}],"version-history":[{"count":9,"href":"https:\/\/open-doc.jkos.com\/index.php?rest_route=\/wp\/v2\/docs\/798\/revisions"}],"predecessor-version":[{"id":1685,"href":"https:\/\/open-doc.jkos.com\/index.php?rest_route=\/wp\/v2\/docs\/798\/revisions\/1685"}],"up":[{"embeddable":true,"href":"https:\/\/open-doc.jkos.com\/index.php?rest_route=\/wp\/v2\/docs\/756"}],"next":[{"title":"\u6388\u6b0a\u6263\u6b3e\u8a02\u55ae\u9000\u6b3e Refund API","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%e8%a8%82%e5%96%ae%e9%80%80%e6%ac%be-refund-api","href":"https:\/\/open-doc.jkos.com\/index.php?rest_route=\/wp\/v2\/docs\/1688"}],"prev":[{"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"}],"wp:attachment":[{"href":"https:\/\/open-doc.jkos.com\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=798"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/open-doc.jkos.com\/index.php?rest_route=%2Fwp%2Fv2%2Fdoc_tag&post=798"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}