{"id":427,"date":"2022-03-30T17:13:30","date_gmt":"2022-03-30T09:13:30","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\/%e9%80%80%e6%ac%be-api"},"modified":"2026-02-06T16:47:38","modified_gmt":"2026-02-06T08:47:38","slug":"%e9%80%80%e6%ac%be-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\/%e9%80%80%e6%ac%be-api","title":{"rendered":"\u8a02\u55ae\u9000\u6b3e Refund API"},"content":{"rendered":"\n
\n

Method\uff1aPOST<\/strong>
Domain\uff1a<\/strong>
https:\/\/[Host]\/platform\/refund<\/code><\/em><\/p>\n\n\n\n

\u8aaa\u660e\uff1a<\/strong>
\u96fb\u5546\u5e73\u53f0\u547c\u53eb\u6b64 API\uff0c\u5c07\u8a72\u7b46\u96fb\u5546\u5e73\u53f0\u4ea4\u6613\u5e8f\u865f\u57f7\u884c\u9000\u6b3e\uff0c\u53ef\u652f\u63f4\u5168\u984d\u9000\u6b3e\u3001\u591a\u6b21\u90e8\u5206\u9000\u6b3e\uff0c\u7d2f\u7a4d\u9000\u6b3e\u91d1\u984d\u4e0d\u53ef\u8d85\u904e\u8a02\u55ae\u5be6\u969b\u6d88\u8cbb\u91d1\u984d\u3002<\/p>\nOnline merchant platform merchant calls Refund API to execute refund process. Full refund and partial refunds are supported. Total refund amount cannot exceed final price of per purchase order.<\/cite><\/blockquote>\n\n\n\n

\u6574\u5408\u6d41\u7a0b (Integration Workflow)<\/h2>\n\n\n\n
\"\"
Merchant refund initiation workflow<\/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_id<\/td>string<\/td>60<\/td>Y<\/td>\u539f\u96fb\u5546\u5e73\u53f0\u7aef\u4ea4\u6613\u5e8f\u865f
\u8857\u53e3\u7aef\u9700\u6bd4\u5c0d\u96fb\u5546\u5e73\u53f0\u9000\u6b3e\u55ae\u865f\u662f\u5426
\u6b63\u78ba\u3002<\/strong><\/td>		ID of order saved in the platform. JKOPAY is required to ensure that the platform refund ID matches the corresponding order ID.<\/td><\/tr>
refund_order_id<\/td>string<\/td>60<\/td>Y<\/td>\u96fb\u5546\u7aef\u9000\u6b3e\u55ae\u865f\uff0c\u9808\u70ba\u552f\u4e00\u503c\uff0c\u4e00\u7b46\u9000\u6b3e\u55ae\u865f\u50c5\u80fd\u9000\u6b3e\u4e00\u6b21\uff0c\u82e5\u8981\u518d\u6b21\u767c\u8d77\u9000\u6b3e\u9700\u66f4\u63db\u55ae\u865f\u3002<\/td>ID of order refund saved in the platform.<\/td><\/tr>
refund_amount<\/td>decimal<\/td>20,0<\/td>Y<\/td>\u9000\u6b3e\u91d1\u984d\uff1b\u5141\u8a31\u90e8\u5206\u3001\u591a\u6b21\u90e8\u5206\u9000
\u6b3e\uff0c\u4f46\u8a72\u7b46\u8a02\u55ae\u52a0\u7e3d\u9000\u6b3e\u91d1\u984d\u4e0d\u53ef\u8d85
\u904e\u8a02\u55ae\u5be6\u969b\u6d88\u8cbb\u91d1\u984d\u3002<\/td>		Refund amount with order currency.<\/strong> Full refund and partial refunds are allowed. Total refund amount cannot exceed final price of purchase order.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

\u7bc4\u4f8b (Example)\uff1a<\/h3>\n\n\n\n
POST https:\/\/[HOST]\/platform\/refund
Content-Type: application\/json
api-key: c775e7b757ede630cd0aa1113bd102661ab38829ca52a6422ab782862f268646
digest: 80b9967b29287605e4ef10b45668792f9d5235777ab305bb72217078dec3205a

{
  \"platform_order_id\": \"Kt12345\",
  \"refund_order_id\": \"RKt12345\",
  \"refund_amount\": 100
}<\/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).<\/strong><\/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.refund_tradeNo<\/td>string<\/td>25<\/td>\u8857\u53e3\u7aef\u9000\u6b3e\u4ea4\u6613\u5e8f\u865f\u3002<\/td>JKOPAY refund trade number.<\/td><\/tr>
result_object.debit_amount<\/td>decimal<\/td>20,0<\/td>\u6d88\u8cbb\u8005\u4ed8\u6b3e\u65b9\u5f0f\u9000\u6b3e\u91d1\u984d\u3002<\/td>User payment method refund amount.<\/td><\/tr>
result_object.redeem_amount<\/td>decimal<\/td>20,0<\/td>\u9000\u9084\u6298\u62b5\u91d1\u984d\u3002<\/td>Redeem amount.<\/td><\/tr>
result_object.redeem_detail  fields<\/td><\/td><\/td><\/td><\/td><\/tr>
result_object.redeem_detail.jko_coin_amount<\/td>decimal<\/td><\/td>\u8857\u53e3\u5e63\u6298\u62b5<\/td>JKO coin redeem amount<\/td><\/tr>
result_object.redeem_detail.official_coupon_amount<\/td>decimal<\/td><\/td>\u5b98\u65b9\u8857\u53e3\u5238\u6298\u62b5<\/td>Official coupon redeem amount<\/td><\/tr>
result_object.redeem_detail.store_coupon_amount
<\/td>		decimal<\/td><\/td>\u5e97\u5bb6\u8857\u53e3\u5238\u6298\u62b5<\/td>Store coupon redeem amount<\/td><\/tr>
result_object.refund_time<\/td>string<\/td><\/td>\u9000\u6b3e\u6642\u9593\u3002
\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\": {
    \"refund_tradeNo\": \"K0026910118070413C4001\",
    \"debit_amount\": 70,
    \"redeem_amount\": 30,
    \"redeem_detail\": {
      \"jko_coin_amount\": 20,
      \"official_coupon_amount\": 0,
      \"store_coupon_amount\": 10
    },
    \"refund_time\": \"2018-07-01 12:20:20\"
  }
}<\/code><\/pre>\n\n\n\n
<\/p>\n","protected":false},"featured_media":0,"parent":44,"menu_order":2,"comment_status":"open","ping_status":"closed","template":"","doc_tag":[],"class_list":["post-427","docs","type-docs","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/open-doc.jkos.com\/index.php?rest_route=\/wp\/v2\/docs\/427","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=427"}],"version-history":[{"count":20,"href":"https:\/\/open-doc.jkos.com\/index.php?rest_route=\/wp\/v2\/docs\/427\/revisions"}],"predecessor-version":[{"id":1691,"href":"https:\/\/open-doc.jkos.com\/index.php?rest_route=\/wp\/v2\/docs\/427\/revisions\/1691"}],"up":[{"embeddable":true,"href":"https:\/\/open-doc.jkos.com\/index.php?rest_route=\/wp\/v2\/docs\/44"}],"next":[{"title":"\u8a02\u55ae\u67e5\u8a62 Inquiry 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\/%e6%9f%a5%e8%a9%a2-api","href":"https:\/\/open-doc.jkos.com\/index.php?rest_route=\/wp\/v2\/docs\/428"}],"prev":[{"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=427"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/open-doc.jkos.com\/index.php?rest_route=%2Fwp%2Fv2%2Fdoc_tag&post=427"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}