{"id":466,"date":"2022-03-31T17:24:50","date_gmt":"2022-03-31T09:24:50","guid":{"rendered":"https:\/\/sit-open-doc.jkos.app\/?docs=%e7%b7%9a%e4%b8%8a%e6%94%af%e4%bb%98onlinepay\/api%e5%88%97%e8%a1%a8\/%e4%bb%a3%e7%a2%bc%e6%84%8f%e7%be%a9"},"modified":"2026-02-06T16:47:38","modified_gmt":"2026-02-06T08:47:38","slug":"%e4%bb%a3%e7%a2%bc%e6%84%8f%e7%be%a9","status":"publish","type":"docs","link":"https:\/\/open-doc.jkos.com\/?docs=%e7%b7%9a%e4%b8%8a%e6%94%af%e4%bb%98onlinepay\/api%e5%88%97%e8%a1%a8\/%e4%bb%a3%e7%a2%bc%e6%84%8f%e7%be%a9","title":{"rendered":"\u4ee3\u78bc\u610f\u7fa9 API Response Code"},"content":{"rendered":"\n

\ud83d\udccb \u91cd\u8981\u8aaa\u660e\uff1a\u6b04\u4f4d\u5927\u5c0f\u5beb\u5dee\u7570<\/h2>\n\n\n\n
API \u985e\u578b<\/strong><\/th>result \u6b04\u4f4d<\/strong><\/th>message \u6b04\u4f4d<\/strong><\/th>result_object \u6b04\u4f4d<\/strong><\/th>Result Code \u985e\u578b<\/strong><\/th><\/tr><\/thead>
Platform APIs<\/strong><\/td>result<\/code> (\u5c0f\u5beb)<\/td>message<\/code> (\u5c0f\u5beb)<\/td>result_object<\/code> (\u5c0f\u5beb)<\/td>\u5b57\u4e32 (“000”, “999”)<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

<\/p>\n\n\n\n

Platform APIs<\/h2>\n\n\n\n

\u91cd\u8981<\/strong>: \u6240\u6709 Platform APIs \u4f7f\u7528\u4ee5\u4e0b Response \u683c\u5f0f\uff1a(\u5c0f\u5beb\u6b04\u4f4d: result<\/code>, message<\/code>, result_object<\/code>)<\/p>\n\n\n\n

{
  \"result\": \"string\",
  \"message\": \"string or null\",
  \"result_object\": object or null
}<\/code><\/pre>\n\n\n\n
1.1 POST \/platform\/entry<\/h3>\n\n\n\n
\u529f\u80fd<\/strong>\uff1a\u8a02\u55ae\u5efa\u7acb<\/p>\n\n\n\n
\u6240\u6709\u53ef\u80fd\u7684 Response<\/strong>\uff1a<\/p>\n\n\n\n
result<\/strong><\/th>message<\/strong><\/th>result_object<\/strong><\/th>\u89f8\u767c\u689d\u4ef6<\/strong><\/th><\/tr><\/thead>
\"000\"<\/code><\/td>null<\/code><\/td>{payment_url, qr_img, qr_timeout}<\/code><\/td>\u6210\u529f\u5efa\u7acb\u4ed8\u6b3e\u9023\u7d50<\/td><\/tr>
\"101\"<\/code><\/td>\"Order is paid\"<\/code><\/td>null<\/code><\/td>\u8a02\u55ae\u5df2\u4ed8\u6b3e<\/td><\/tr>
\"200\"<\/code><\/td>\"Bad request\"<\/code><\/td>{\u52d5\u614b\u8a0a\u606f\uff1a\u6703\u8aaa\u660e\u54ea\u4e9b\u6b04\u4f4d\u8cc7\u6599\u932f\u8aa4\u539f\u56e0}<\/code><\/td>BadParams (\u53c3\u6578\u932f\u8aa4)<\/td><\/tr>
\"200\"<\/code><\/td>\"Store not found\"<\/code><\/td>null<\/code><\/td>BadParams (\u53c3\u6578\u932f\u8aa4)
store_id \u8cc7\u6599\u932f\u8aa4<\/td><\/tr>
\"200\"<\/code><\/td>\"Using the currency unsupported by the Store\"<\/code><\/td>null<\/code><\/td>BadParams (\u53c3\u6578\u932f\u8aa4)
currency<\/code> \u8cc7\u6599\u932f\u8aa4<\/td><\/tr>
\"200\"<\/code><\/td>\"Entry of this store needs identity verification\"<\/code><\/td>null<\/code><\/td>BadParams (\u53c3\u6578\u932f\u8aa4)
\u8a72 store \u8a02\u55ae\u9700\u8981\u9a57\u8b49 identities<\/code> \u8cc7\u6599<\/td><\/tr>
\"200\"<\/code><\/td>\"Order has been used as entry but they do not match with each others\"<\/code><\/td>null<\/code><\/td>BadParams (\u53c3\u6578\u932f\u8aa4)
\u540c\u4e00 platform_order_id<\/code> \u865f\u78bc\uff0c\u4f46\u662f\u591a\u6b21 request \u7684 store_id<\/code>, currency<\/code>, total_price<\/code> , final_price<\/code> \u8cc7\u6599\u4e0d\u4e00\u81f4\u6642\u6703\u89f8\u767c<\/td><\/tr>
\"200\"<\/code><\/td>\"Invalid number of digits for the order currency amount\"<\/code><\/td>null<\/code><\/td>BadParams (\u53c3\u6578\u932f\u8aa4)
\u4f9d\u64da currency<\/code> \u8207 total_price<\/code>, final_price<\/code> \u5c0f\u6578\u9ede\u6aa2\u6838\u7570\u5e38\u6642\u89f8\u767c<\/td><\/tr>
\"200\"<\/code><\/td>\"Order price below limit for this currency\"<\/code><\/td>null<\/code><\/td>BadParams (\u53c3\u6578\u932f\u8aa4)
\u7576 total_price<\/code>, final_price<\/code> \u5c0f\u65bc\u8a72\u5916\u5e63 currency<\/code> \u6700\u4f4e\u91d1\u984d\u6642\u6642\u89f8\u767c
JPY = 5<\/code>
USD = 0.02<\/code>
CNY = 0.11<\/code>
HKD = 0.13<\/code><\/td><\/tr>
\"999\"<\/code><\/td>\"Internal Error\"<\/code><\/td>null<\/code><\/td>\u8857\u53e3\u65b9\u7cfb\u7d71\u51fa\u73fe\u975e\u9810\u671f\u932f\u8aa4<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
\u6210\u529f result_object \u7d50\u69cb<\/strong>\uff1a<\/p>\n\n\n\n
{
  \"payment_url\": \"https:\/\/...\",
  \"qr_img\": \"https:\/\/...qr_code.png\",
  \"qr_timeout\": 600
}<\/code><\/pre>\n\n\n\n
1.2 POST \/platform\/refund<\/h3>\n\n\n\n
\u529f\u80fd<\/strong>\uff1a\u8a02\u55ae\u9000\u6b3e<\/p>\n\n\n\n
\u6240\u6709\u53ef\u80fd\u7684 Response<\/strong>\uff1a<\/p>\n\n\n\n
result<\/strong><\/th>message<\/strong><\/th>result_object<\/strong><\/th>\u89f8\u767c\u689d\u4ef6<\/strong><\/th><\/tr><\/thead>
\"000\"<\/code><\/td>null<\/code><\/td>\u9000\u6b3e\u8cc7\u8a0a\u7269\u4ef6<\/td>\u6210\u529f\u5efa\u7acb\u9000\u6b3e<\/td><\/tr>
\"100\"<\/code><\/td>\"Invaid Order ID\"<\/code><\/td>null<\/code><\/td>\u8a02\u55ae\u4e0d\u5b58\u5728<\/td><\/tr>
\"102\"<\/code><\/td>\"Order has excessed 180 days cannot be refunded\"<\/code><\/td>null<\/code><\/td>\u8d85\u904e\u9000\u6b3e\u671f\u9650<\/td><\/tr>
\"105\"<\/code><\/td>\"Inconsistent remain amount\"<\/code><\/td>null<\/code><\/td>\u5269\u9918\u91d1\u984d\u4e0d\u4e00\u81f4<\/td><\/tr>
\"105\"<\/code><\/td>\"Inconsistent refund amount\"<\/code><\/td>null<\/code><\/td>\u9000\u6b3e\u91d1\u984d\u4e0d\u4e00\u81f4\uff0c\u5169\u6b21 request \u4f7f\u7528\u540c\u4e00\u500b refund_order_id<\/code> \u4f46 refund_amount<\/code> \u4e0d\u540c\u6642\u89f8\u767c<\/td><\/tr>
\"111\"<\/code><\/td>\"Transaction has been closed\"<\/code><\/td>null<\/code><\/td>\u4ea4\u6613\u5df2\u95dc\u9589 (\u5df2\u95dc\u5e33)<\/td><\/tr>
\"113\"<\/code><\/td>\"Refund reject due to refund amount exceeds total unreimbursed amount.\"<\/code><\/td>null<\/code><\/td>\u5546\u5bb6\u9918\u984d\u4e0d\u8db3<\/td><\/tr>
\"116\"<\/code><\/td>\"JKOPAY coupon reimbursement failed, please contact JKOPAY for assistance in refund\"<\/code><\/td>null<\/code><\/td>\u9000\u6b3e\u5931\u6557 (Coupon)<\/td><\/tr>
\"117\"<\/code><\/td>\"JKOPAY Coupon is used in this transaction, and we will only accept full refund\"<\/code><\/td>null<\/code><\/td>\u4f7f\u7528 Coupon \u7684\u8a02\u55ae\u50c5\u63a5\u53d7\u5168\u984d\u9000\u6b3e<\/td><\/tr>
\"200\"<\/code><\/td>\"Invalid number of digits for the order currency amount\"<\/code><\/td>null<\/code><\/td>BadParams (\u53c3\u6578\u932f\u8aa4)
\u4f9d\u64da currency<\/code> \u8207 total_price<\/code>, final_price<\/code> \u5c0f\u6578\u9ede\u6aa2\u6838\u7570\u5e38\u6642\u89f8\u767c<\/td><\/tr>
\"922\"<\/code><\/td>\"Refund amount exceeds order final price\"<\/code><\/td>null<\/code><\/td>\u9000\u6b3e\u91d1\u984d\u8d85\u904e\u53ef\u9000\u6b3e\u91d1\u984d<\/td><\/tr>
\"922\"<\/code><\/td>{\u52d5\u614b\u8a0a\u606f}<\/code><\/td>null<\/code><\/td>\u9000\u6b3e\u5931\u6557
\u932f\u8aa4\u8a0a\u606f\u53c3\u8003 message<\/code> \u56de\u50b3\u8cc7\u8a0a<\/td><\/tr>
\"978\"<\/code><\/td>\"Closed account can't use JKOPay's service, please contact the JKOPay's customer service.\"<\/code><\/td>null<\/code><\/td>\u5e33\u6236\u7121\u6cd5\u4f7f\u7528\u8857\u53e3\u670d\u52d9<\/td><\/tr>
\"999\"<\/code><\/td>\"Internal Error\"<\/code><\/td>null<\/code><\/td>\u8857\u53e3\u65b9\u7cfb\u7d71\u51fa\u73fe\u975e\u9810\u671f\u932f\u8aa4<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
1.3 GET \/platform\/inquiry<\/h3>\n\n\n\n
\u529f\u80fd<\/strong>\uff1a\u8a02\u55ae\u67e5\u8a62<\/p>\n\n\n\n
\u6240\u6709\u53ef\u80fd\u7684 Response<\/strong>\uff1a<\/p>\n\n\n\n
result<\/strong><\/th>message<\/strong><\/strong><\/th>result_object<\/strong><\/th>\u89f8\u767c\u689d\u4ef6<\/strong><\/th><\/tr><\/thead>
\"000\"<\/code><\/td>null<\/code><\/td>{transactions: [...]}<\/code><\/td>\u6210\u529f\u67e5\u8a62 (\u542b\u6240\u6709\u8a02\u55ae\u72c0\u614b)<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
transactions \u9663\u5217\u4e2d\u6bcf\u7b46\u8a02\u55ae\u7684 status<\/strong>\uff1a<\/p>\n\n\n\n
    \n
  • 0<\/code> – \u4ea4\u6613\u6210\u529f (transaction success)<\/li>\n\n\n\n
  • 100<\/code> – \u4ed8\u6b3e\u5931\u6557 (payment fail)<\/li>\n\n\n\n
  • 101<\/code> – \u8a02\u55ae\u5c1a\u672a\u4ed8\u6b3e (order has not been paid)<\/li>\n\n\n\n
  • 102<\/code> – \u8a02\u55ae\u7de8\u865f\u4e0d\u5b58\u5728 (order number does not exist)<\/li>\n<\/ul>\n\n\n\n
    result_object \u7d50\u69cb (TWD \u8a02\u55ae)<\/strong>\uff1a<\/p>\n\n\n\n
    {
      \"transactions\": [
        {
          \"platform_order_id\": \"ORDER_001\",
          \"status\": 0,
          \"tradeNo\": \"J2025010100000000001\",
          \"trans_time\": \"2025-01-15 14:30:00\",
          \"currency\": \"TWD\",
          \"final_price\": \"1000\",
          \"redeem_amount\": \"0\",
          \"redeem_detail\": {
            \"jko_coin_amount\": 0,
            \"official_coupon_amount\": 0,
            \"store_coupon_amount\": 0
          },
          \"debit_amount\": \"1000\",
          \"invoice_vehicle\": \"\/ABCDABC\",
          \"channel_type\": \"bank\",
          \"refund_history\": [...]
        }
      ]
    }<\/code><\/pre>\n\n\n\n
    result_object \u7d50\u69cb (\u975e TWD \u8a02\u55ae)<\/strong>\uff1a<\/p>\n\n\n\n
    {
      \"transactions\": [
        {
          \"platform_order_id\": \"ORDER_002\",
          \"status\": 0,
          \"tradeNo\": \"J2025010100000000002\",
          \"trans_time\": \"2025-01-15 14:30:00\",
          \"currency\": \"JPY\",
          \"final_price\": \"1230\",
          \"redeem_amount\": \"0\",
          \"redeem_detail\": {
              \"jko_coin_amount\": 0,
              \"official_coupon_amount\": 0,
              \"store_coupon_amount\": 0
          },
          \"debit_amount\": \"249\",
          \"invoice_vehicle\": \"\",
          \"channel_type\": \"bank\",
          \"refund_history\": [...]
        }
      ]
    }<\/code><\/pre>\n\n\n\n
    <\/p>\n","protected":false},"featured_media":0,"parent":44,"menu_order":0,"comment_status":"open","ping_status":"closed","template":"","doc_tag":[],"class_list":["post-466","docs","type-docs","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/open-doc.jkos.com\/index.php?rest_route=\/wp\/v2\/docs\/466","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=466"}],"version-history":[{"count":14,"href":"https:\/\/open-doc.jkos.com\/index.php?rest_route=\/wp\/v2\/docs\/466\/revisions"}],"predecessor-version":[{"id":1708,"href":"https:\/\/open-doc.jkos.com\/index.php?rest_route=\/wp\/v2\/docs\/466\/revisions\/1708"}],"up":[{"embeddable":true,"href":"https:\/\/open-doc.jkos.com\/index.php?rest_route=\/wp\/v2\/docs\/44"}],"next":[{"title":"\u8a02\u55ae\u5275\u5efa Entry API","link":"https:\/\/open-doc.jkos.com\/?docs=%e7%b7%9a%e4%b8%8a%e6%94%af%e4%bb%98onlinepay\/api%e5%88%97%e8%a1%a8\/%e8%a8%82%e5%96%ae%e5%89%b5%e5%bb%ba-api","href":"https:\/\/open-doc.jkos.com\/index.php?rest_route=\/wp\/v2\/docs\/426"}],"wp:attachment":[{"href":"https:\/\/open-doc.jkos.com\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=466"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/open-doc.jkos.com\/index.php?rest_route=%2Fwp%2Fv2%2Fdoc_tag&post=466"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}