{"id":428,"date":"2022-03-30T17:13:47","date_gmt":"2022-03-30T09:13:47","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\/%e6%9f%a5%e8%a9%a2-api"},"modified":"2026-02-06T16:47:38","modified_gmt":"2026-02-06T08:47:38","slug":"%e6%9f%a5%e8%a9%a2-api","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\/%e6%9f%a5%e8%a9%a2-api","title":{"rendered":"\u8a02\u55ae\u67e5\u8a62 Inquiry API"},"content":{"rendered":"\n
\n

Method\uff1aGET<\/strong>
Domain\uff1a<\/strong>
https:\/\/[Host]\/platform\/inquiry?<\/code><\/em>platform_order_ids={platform_order_id}<\/p>\n\n\n\n

\u8aaa\u660e\uff1a<\/strong>
\u96fb\u5546\u5e73\u53f0\u547c\u53eb\u6b64 API\uff0c\u67e5\u8a62\u8a72\u7b46\u96fb\u5546\u5e73\u53f0\u4ea4\u6613\u5e8f\u865f\u7684\u4ed8\u6b3e\u3001\u9000\u6b3e\u6b77\u7a0b\u3002<\/p>\nPlatform server calls Inquiry API to search platform order transactions\u2019 payment and refund history.<\/cite><\/blockquote>\n\n\n\n

\u6574\u5408\u6d41\u7a0b (Integration Workflow)<\/h2>\n\n\n\n
\"\"
Transaction result inquiry<\/figcaption><\/figure>\n\n\n\n

\u8acb\u6c42\u53c3\u6578 (Request Parameter)<\/h2>\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>
platform_order_ids<\/td>string[]<\/td>60<\/td>Y<\/td>\u96fb\u5546\u5e73\u53f0\u7aef\u4ea4\u6613\u5e8f\u865f
\u6700\u591a\u53ef\u4ee5\u67e5\u8a62 20 \u7b46\u4ea4\u6613\u3002<\/td>		ID of order saved in the platform. Platform can search up to 20 order IDs at a time.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

\u7bc4\u4f8b (Example)\uff1a<\/h3>\n\n\n\n
GET https:\/\/[HOST]\/platform\/inquiry?platform_order_ids=kt12345,kt123456
Content-Type: application\/json
api-key: c775e7b757ede630cd0aa1113bd102661ab38829ca52a6422ab782862f268646
digest: a0836fefb028ea7493118c8b5eb6752113f552ac8ef35f3cb8cda91808c77188<\/code><\/pre>\n\n\n\n
\u8fd4\u56de\u53c3\u6578 (Response JSON Body)<\/h2>\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>		\u8aaa\u660e<\/strong><\/th>Description<\/th><\/tr><\/thead>
result<\/td>string<\/td><\/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>25<\/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><\/td><\/tr>
result_object.transactions fields<\/td><\/td><\/td><\/td><\/td><\/tr>
result_object.transactions.platform_order_id<\/td>string<\/td>60<\/td>\u96fb\u5546\u5e73\u53f0\u7aef\u4ea4\u6613\u5e8f\u865f<\/td>Online merchant platform order ID.<\/td><\/tr>
result_object.transactions.status<\/td>int<\/td><\/td>\u8acb\u53c3\u7167 OrderStatusCode<\/a><\/td>Please refer to orderStatusCode.<\/td><\/tr>
result_object.transactions.tradeNo<\/td>string<\/td>25<\/td>\u8857\u53e3\u7aef\u4ea4\u6613\u5e8f\u865f<\/td>JKOPAY trade number.<\/td><\/tr>
result_object.transactions.trans_time<\/td>string<\/td><\/td>\u8a02\u55ae\u4ea4\u6613\u6642\u9593
\u683c\u5f0f: yyyy-MM-dd HH:mm:ss<\/td>		Time of transaction in UTC+8 time zone<\/strong>.
Format: yyyy-MM-dd HH:mm:ss<\/td><\/tr>
result_object.transactions.final_price<\/td>string<\/td>20<\/td>\u8a02\u55ae\u5be6\u969b\u6d88\u8cbb\u91d1\u984d\u3002<\/td>Final price of order with payment currency.<\/td><\/tr>
result_object.transactions.redeem_amount<\/td>string<\/td>20<\/td>\u6298\u62b5\u91d1\u984d=\u8857\u53e3\u5e63\u6298\u62b5+\u5b98\u65b9\u8857\u53e3
\u5238\u6298\u62b5+\u5e97\u5bb6\u8857\u53e3\u5238\u6298\u62b5<\/td>		Redeemed amount(JKO coins & JKO ticket)<\/td><\/tr>
result_object.transactions.redeem_detail fields<\/td><\/td><\/td><\/td><\/td><\/tr>
result_object.transactions.redeem_detail.jko_coin_amount<\/td>decimal<\/td>20,0<\/td>\u8857\u53e3\u5e63\u6298\u62b5<\/td>JKO coin redeem amount<\/td><\/tr>
result_object.transactions.redeem_detail.official_coupon_amount<\/td>decimal<\/td>20,0<\/td>\u5b98\u65b9\u8857\u53e3\u5238\u6298\u62b5<\/td>Official coupon redeem amount<\/td><\/tr>
result_object.transactions.redeem_detail.store_coupon_amount<\/td>decimal<\/td>20,0<\/td>\u5e97\u5bb6\u8857\u53e3\u5238\u6298\u62b5<\/td>Store coupon redeem amount<\/td><\/tr>
result_object.transactions.debit_amount<\/td>string<\/td>20<\/td>\u4ed8\u6b3e\u65b9\u5f0f\u6263\u6b3e\u91d1\u984d\uff08\u6298\u62b5\u5f8c\u91d1
\u984d\uff09\u3002<\/td>		Payment method debit amount (after deduct JKO coins) with payment currecny.
(final_price = redeem_amount + debit_amount)<\/td><\/tr>
result_object.transactions.invoice_vehicle<\/td>string<\/td>20<\/td>\u8857\u53e3\u5e33\u6236\u767c\u7968\u8f09\u5177<\/td><\/td><\/tr>
result_object.transactions.maskNo<\/td>string<\/td>16<\/td>\u4ed8\u6b3e\u5de5\u5177\u70ba\u4fe1\u7528\u5361\u6642\u63d0\u4f9b\u5361\u865f\u524d
\u516d\u5f8c\u56db\u78bc
\u683c\u5f0f\uff1a222222******3333<\/td>		<\/td><\/tr>
result_object.transactions.channel_type<\/td>string<\/td><\/td>\u652f\u4ed8\u5de5\u5177
“account”: \u5132\u503c\u5e33\u6236
“bank”: \u9280\u884c\u5e33\u6236
“creditcard”: \u4fe1\u7528\u5361<\/td>		Pay tool
account : JKOPay account
bank : bank account
creditcard<\/td><\/tr>
result_object.transactions.refund_history fields<\/td><\/td><\/td>\u5217\u51fa\u9000\u6b3e\u6b77\u7a0b\uff1b\u4f9d JSON \u683c\u5f0f\uff0c
\u9663\u5217\u5e36\u5165\u9000\u6b3e\u8cc7\u8a0a\u3002<\/td>		List refund history; insert refund information according to JSON format.<\/td><\/tr>
result_object.transactions.refund_history.refund_order_id<\/td>string<\/td>60<\/td>\u96fb\u5546\u7aef\u9000\u6b3e\u55ae\u865f<\/td>Online merchant platform order refund ID.<\/td><\/tr>
result_object.transactions.refund_history.refund_tradeNo<\/td>string<\/td>25<\/td>\u8857\u53e3\u7aef\u9000\u6b3e\u4ea4\u6613\u5e8f\u865f<\/td>JKOPAY refund trade number.<\/td><\/tr>
result_object.transactions.refund_history.amount<\/td>string<\/td>20<\/td>\u9000\u6b3e\u91d1\u984d\u3002<\/td>Refund amount.<\/td><\/tr>
result_object.transactions.refund_history.redeem_amount<\/td>string<\/td>20<\/td>\u9000\u9084\u6298\u62b5\u91d1\u984d\u3002<\/td>Refund redeemed amount.<\/td><\/tr>
result_object.transactions.refund_history.debit_amount<\/td>string<\/td>20<\/td>\u6d88\u8cbb\u8005\u4ed8\u6b3e\u65b9\u5f0f\u9000\u6b3e\u91d1\u984d\u3002<\/td>User payment method refund debit amount.<\/td><\/tr>
result_object.transactions.refund_history.time<\/td>string<\/td><\/td>\u9000\u6b3e\u6642\u9593
\u683c\u5f0f: YYYY-mm-dd HH:MM:SS<\/td>		Time of refund in UTC+8 time zone.<\/strong>
Format: YYYY-mm-dd HH:MM:SS<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
\u7bc4\u4f8b (Example)\uff1a<\/h3>\n\n\n\n
{
  \"result\": \"000\",
  \"message\": null,
  \"result_object\": {
    \"transactions\": [
      {
        \"platform_order_id\": \"kt12345\",
        \"status\": 0,
        \"tradeNo\": \"J0026910118070413C4\",
        \"trans_time\": \"2018-07-01 12:00:00\",
        \"final_price\": \"1000\",
        \"redeem_amount\": \"300\",
        \"debit_amount\": \"700\",
        \"redeem_detail\": {
          \"jko_coin_amount\": 200,
          \"official_coupon_amount\": 0,
          \"store_coupon_amount\": 100
        },
        \"refund_history\": [
          {
            \"refund_order_id\": \"TEST26910118070413C4001\",
            \"refund_tradeNo\": \"K0026910118070413C4001\",
            \"time\": \"2018-07-01 12:20:20\",
            \"amount\": \"100\",
            \"debit_amount\": \"70\",
            \"redeem_amount\": \"30\",
            \"redeem_detail\": {
              \"jko_coin_amount\": 20,
              \"official_coupon_amount\": 0,
              \"store_coupon_amount\": 10
            }
          },
          {
            \"refund_tradeNo\": \"K0026910118070413C4002\",
            \"time\": \"2018-07-01 12:30:20\",
            \"amount\": \"200\",
            \"redeem_amount\": \"60\",
            \"debit_amount\": \"140\"
          }
        ]
      },
      {
        \"platform_order_id\": \"kt123456\",
        \"status\": 101
      }
    ]
  }
}<\/code><\/pre>\n\n\n\n
<\/p>\n","protected":false},"featured_media":0,"parent":44,"menu_order":3,"comment_status":"open","ping_status":"closed","template":"","doc_tag":[],"class_list":["post-428","docs","type-docs","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/open-doc.jkos.com\/index.php?rest_route=\/wp\/v2\/docs\/428","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=428"}],"version-history":[{"count":20,"href":"https:\/\/open-doc.jkos.com\/index.php?rest_route=\/wp\/v2\/docs\/428\/revisions"}],"predecessor-version":[{"id":1695,"href":"https:\/\/open-doc.jkos.com\/index.php?rest_route=\/wp\/v2\/docs\/428\/revisions\/1695"}],"up":[{"embeddable":true,"href":"https:\/\/open-doc.jkos.com\/index.php?rest_route=\/wp\/v2\/docs\/44"}],"next":[{"title":"\u4ea4\u6613\u64a5\u6b3e\u6a94 Reimburse File (R File)","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\/%e5%ba%97%e5%ae%b6%e6%92%a5%e6%ac%be%e6%aa%94r%e6%aa%94","href":"https:\/\/open-doc.jkos.com\/index.php?rest_route=\/wp\/v2\/docs\/586"}],"prev":[{"title":"\u8a02\u55ae\u9000\u6b3e Refund 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\/%e9%80%80%e6%ac%be-api","href":"https:\/\/open-doc.jkos.com\/index.php?rest_route=\/wp\/v2\/docs\/427"}],"wp:attachment":[{"href":"https:\/\/open-doc.jkos.com\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=428"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/open-doc.jkos.com\/index.php?rest_route=%2Fwp%2Fv2%2Fdoc_tag&post=428"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}