{"id":816,"date":"2022-07-04T18:05:58","date_gmt":"2022-07-04T10:05:58","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%e6%89%a3%e6%ac%be%e7%99%bc%e5%8b%95-merchant-platform-authorization-request"},"modified":"2026-02-06T16:35:37","modified_gmt":"2026-02-06T08:35:37","slug":"%e6%8e%88%e6%ac%8a%e6%89%a3%e6%ac%be%e7%99%bc%e5%8b%95-merchant-platform-authorization-request","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%e6%89%a3%e6%ac%be%e7%99%bc%e5%8b%95-merchant-platform-authorization-request","title":{"rendered":"\u6388\u6b0a\u6263\u6b3e Authorization deduction request"},"content":{"rendered":"\n
\n

\u6388\u6b0a\u6263\u6b3e transaction<\/em><\/strong> API<\/strong><\/p>\n\n\n\n

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

\n

\u8aaa\u660e\uff1a<\/strong>
\u96fb\u5546\u5e73\u53f0\u547c\u53eb\u6b64API\uff0c\u767c\u52d5\u8a72\u7b46\u5e73\u53f0\u6388\u6b0a\u5e8f\u865f\u7684\u6388\u6b0a\u6263\u6b3e\u3002<\/p>\n<\/blockquote>\n\n\n\n

<\/p>\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>
order fields<\/td><\/td><\/td><\/td><\/td><\/td><\/tr>
order.platform_order_id<\/td>string<\/td>60<\/td>Y<\/td>\u96fb\u5546\u5e73\u53f0\u7aef\u4ea4\u6613\u5e8f\u865f
\u9700\u70ba\u552f\u4e00\u503c\uff0c\u4e0d\u53ef\u91cd\u8907\u3002<\/strong><\/td>		The ID of the order is saved on the platform.
This ID needs to be unique and unrepeated.<\/strong><\/td><\/tr>
order.trade_name<\/td>string<\/td>30<\/td>Y<\/td>\u4ea4\u6613\u540d\u7a31
\uff08\u6703\u986f\u793a\u65bcapp\u4e2d\u6388\u6b0a\u4ea4\u6613\u8a18\u9304\u9801\uff09<\/td>		Transaction name
(shown in the authorization record page in the JKOPay app).<\/td><\/tr>
order.currency<\/td>string<\/td>3<\/td>Y<\/td>\u4ed8\u6b3e\u8ca8\u5e63[ISO 4217]\uff0c\u8acb\u5e36\u5165
\u201cTWD\u201d<\/td>		Platform\u2019s order currency [ISO 4217]. Please use \u201cTWD\u201d.<\/td><\/tr>
order.total_price<\/td>decimal<\/td>20,0<\/td>Y<\/td>\u8a02\u55ae\u50f9\u683c\uff08\u539f\u59cb\u5e63\u5225\uff09<\/td>Total price (original currency).<\/td><\/tr>
order.final_price<\/td>decimal<\/td>20,0<\/td>Y<\/td>\u8a02\u55ae\u61c9\u4ed8\u50f9\u683c\uff08\u539f\u59cb\u5e63\u5225\uff09<\/td>Final price would be paid (original currency).<\/td><\/tr>
order.unredeem<\/td>decimal<\/td>20,0<\/td>N<\/td>\u8a02\u55ae\u4e0d\u53ef\u6298\u62b5\u56de\u994b\u91d1\u984d\uff08\u539f\u59cb\u5e63\u5225\uff09\u9810\u8a2d\u70ba0<\/td>The amount that cannot be discounted or not qualified for reward (original currency)
Default is 0.<\/td><\/tr>
order.remark<\/td>string<\/td>500<\/td>N<\/td>\u5099\u8a3b<\/td>Memo.<\/td><\/tr>
order.products fields<\/td><\/td><\/td><\/td><\/td><\/td><\/tr>
order.products.name<\/td>string<\/td>60<\/td>N<\/td>\u5546\u54c1\u540d\u7a31\uff08charset=utf-8\uff09<\/td><\/td><\/tr>
order.products.img<\/td>string<\/td>500<\/td>N<\/td>\u5546\u54c1\u7db2\u5740<\/td><\/td><\/tr>
order.products.unit_count<\/td>int<\/td><\/td>N<\/td>\u5546\u54c1\u6578\u91cf<\/td><\/td><\/tr>
order.products.unit_price<\/td>decimal<\/td>20,0<\/td>N<\/td>\u5546\u54c1\u55ae\u50f9\uff08\u539f\u50f9\uff09<\/td><\/td><\/tr>
order.products.unit_final_price<\/td>decimal<\/td>20,0<\/td>N<\/td>\u5546\u54c1\u55ae\u50f9\uff08\u4ed8\u6b3e\u50f9\u683c\uff09<\/td><\/td><\/tr>
order.products.category_path<\/td>string[]<\/td><\/td>N<\/td><\/td><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

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

\u6388\u6b0a\u6263\u6b3e API Request\uff1a<\/strong><\/p>\n\n\n\n

POST https:\/\/{\u8857\u53e3\u8def\u5f91}\/platform\/authpay\/transaction
Content-Type: application\/json
api-key: 0038ff51693e2f44cbf8d2075835029b3c9bb0a863373b947e4c1f6c8742a095
digest: 795ca21ca75064da4d361bbc5120171e46251785891540dbf2f3af94699ae428

{
  \"auth_no\": \"605495635344494592\",
  \"order\": {
    \"platform_order_id\": \"authpay_order_id_001\",
    \"trade_name\": \"\u7b2cn\u6b21\u6263\u6b3e\",
    \"currency\": \"TWD\",
    \"total_price\": 50,
    \"final_price\": 50,
    \"unredeem\": 0,
    \"remark\": \"\u5099\u8a3b\",
    \"products\": [
      {
        \"name\": \"\u5546\u54c11\",
        \"img\": null,
        \"unit_count\": 1,
        \"unit_price\": 50,
        \"unit_final_price\": 50,
        \"category_path\": []
      }
    ]
  }
}<\/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<\/td>Please refer to API response code (ResponseCode).<\/td><\/tr>
message<\/td>string<\/td>\u7d50\u679c\u8a0a\u606f\u6216\u5931\u6557\u7406\u7531<\/td>Result message or reason of error.<\/td><\/tr>
result_object fields<\/td><\/td>\u56de\u8986\u7269\u4ef6<\/td><\/td><\/tr>
result_object.platform_order_id<\/td>string<\/td>\u96fb\u5546\u5e73\u53f0\u7aef\u4ea4\u6613\u5e8f\u865f
<\/td>		The ID of the order is saved on the platform.<\/td><\/tr>
result_object.status<\/td>int<\/td>\uff08Status\u975e0\u6642\uff0c\u4ee5\u4e0b\u6b04\u4f4d\u4e0d\u56de\u8986\uff09<\/td>(When the status does not equal 0, the following parameters will not be returned).<\/td><\/tr>
result_object.tradeNo<\/td>string<\/td>\u8857\u53e3\u7aef\u4ea4\u6613\u5e8f\u865f<\/td>JKOPay transaction number.<\/td><\/tr>
result_object.trans_time<\/td>string<\/td>\u4ea4\u6613\u6642\u9593
\u683c\u5f0f : yyyy-MM-dd HH:mm:ss<\/strong><\/td>		Transaction time.
format: yyyy-MM-dd HH:mm:ss<\/strong><\/td><\/tr>
result_object.currency<\/td>string<\/td>\u539f\u59cb\u5e63\u5225 [ISO 4217]\uff08TWD\uff09<\/td>Currency [ISO 4217](TWD).<\/td><\/tr>
result_object.final_price<\/td>decimal<\/td>\u8a02\u55ae\u61c9\u4ed8\u50f9\u683c\uff08\u539f\u59cb\u5e63\u5225\uff09<\/td>The final price would be paid (original currency).<\/td><\/tr>
result_object.redeem_amount<\/td>decimal<\/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>Discounted amount = amount of JKO coin + JKO official coupon + store coupon<\/td><\/tr>
result_object.debit_amount<\/td>decimal<\/td>\u4ed8\u6b3e\u65b9\u5f0f\u6263\u6b3e\u91d1\u984d\uff08\u6298\u62b5\u5f8c\u91d1\u984d\uff09<\/td>Amount paid (after discount).<\/td><\/tr>
result_object.invoice_vehicle<\/td>string<\/td>\u8857\u53e3\u5e33\u6236\u767c\u7968\u8f09\u5177<\/td>Jkopay account invoice carrier.<\/td><\/tr>
result_object.maskNo<\/td>string<\/td>\u4ed8\u6b3e\u5de5\u5177\u4f7f\u7528\u4fe1\u7528\u5361\u6642\u63d0\u4f9b\u5361\u865f\u524d\u516d\u5f8c\u56db\u78bc
\u683c\u5f0f\uff1a222222******3333<\/td>		When channel_type is \u201ccredit card\u201d then the JKOPay server will reply with the card number(The first six numbers and last four numbers).
Format: 222222******3333<\/td><\/tr>
result_object.channel_type<\/td>string<\/td>\u652f\u4ed8\u5de5\u5177
account: \u5132\u503c\u5e33\u6236
bank: \u9280\u884c\u5e33\u6236
creditcard: \u4fe1\u7528\u5361<\/td>		User\u2019s payment method
account: JKOPay balance
bank: bank account
creditcard: credit card (not available for crossborder payment).<\/td><\/tr>
result_object.redeem_detail fields<\/td><\/td><\/td><\/td><\/tr>
result_object.redeem_detail.jko_coin_amount<\/td>decimal<\/td>\u8857\u53e3\u5e63\u6298\u62b5\u91d1\u984d<\/td>JKO coin redeem amount.<\/td><\/tr>
result_object.redeem_detail.official_coupon_amount<\/td>decimal<\/td>\u5b98\u65b9\u8857\u53e3\u5238\u6298\u62b5\u91d1\u984d<\/td>official coupon redeem amount.<\/td><\/tr>
result_object.redeem_detail.store_coupon_amount<\/td>decimal<\/td>\u5e97\u5bb6\u8857\u53e3\u5238\u6298\u62b5\u91d1\u984d<\/td>store coupon redeem amount.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
<\/p>\n\n\n\n
\u7bc4\u4f8b (Example)\uff1a<\/h3>\n\n\n\n
\u6388\u6b0a\u6263\u6b3e transaction API Response (\u6210\u529f)\uff1a<\/h4>\n\n\n\n
{
  \"result\": \"000\",
  \"message\": null,
  \"result_object\": {
    \"platform_order_id\": \"authpay_order_id_001\",
    \"status\": 0,
    \"tradeNo\": \"J0153402025021300123\",
    \"trans_time\": \"2025-02-13 16:03:01\",
    \"currency\": \"TWD\",
    \"final_price\": 50,
    \"redeem_amount\": 0,
    \"debit_amount\": 50,
    \"invoice_vehicle\": \"\/JURT123\",
    \"maskNo\": null,
    \"channel_type\": \"creditcard\",
    \"redeem_detail\": {
      \"jko_coin_amount\": 0,
      \"official_coupon_amount\": 0,
      \"store_coupon_amount\": 0
    }
  }
}<\/code><\/pre>\n\n\n\n
\u6388\u6b0a\u6263\u6b3e transaction API Response (\u5931\u6557)\uff1a<\/h4>\n\n\n\n
{
  \"result\": \"121\",
  \"message\": \"Insufficient bank account balance.\",
  \"result_object\": null
}<\/code><\/pre>\n","protected":false},"featured_media":0,"parent":756,"menu_order":4,"comment_status":"open","ping_status":"closed","template":"","doc_tag":[],"class_list":["post-816","docs","type-docs","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/open-doc.jkos.com\/index.php?rest_route=\/wp\/v2\/docs\/816","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=816"}],"version-history":[{"count":12,"href":"https:\/\/open-doc.jkos.com\/index.php?rest_route=\/wp\/v2\/docs\/816\/revisions"}],"predecessor-version":[{"id":1358,"href":"https:\/\/open-doc.jkos.com\/index.php?rest_route=\/wp\/v2\/docs\/816\/revisions\/1358"}],"up":[{"embeddable":true,"href":"https:\/\/open-doc.jkos.com\/index.php?rest_route=\/wp\/v2\/docs\/756"}],"next":[{"title":"\u6388\u6b0a\u72c0\u614b\u67e5\u8a62 Inquiry on Authorization Status","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","href":"https:\/\/open-doc.jkos.com\/index.php?rest_route=\/wp\/v2\/docs\/798"}],"prev":[{"title":"\u6388\u6b0a\u5275\u5efa Authorization Binding","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","href":"https:\/\/open-doc.jkos.com\/index.php?rest_route=\/wp\/v2\/docs\/780"}],"wp:attachment":[{"href":"https:\/\/open-doc.jkos.com\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=816"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/open-doc.jkos.com\/index.php?rest_route=%2Fwp%2Fv2%2Fdoc_tag&post=816"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}