![\"avatar\"](\"https://demo.motionpay.org/images/AuthcodeFlowDiagram.png\")
This document is the official manual for MotionPay`s payment APIs. It is the tutorial for technical architects, R&D engineers, testing engineers and service engineers for the integrated WeChatPay and Alipay system, which includes vendors' systems such as online shopping platforms, cashier systems, or POS systems.
\nThe Customer shows their barcode/QR Code on WeChat's or Alipay app to the Vendor to scan in order to pay directly. This mode applies to in-store payment scenarios.
\nThe Merchant generates a transaction QR Code according to the MotionPay Protocol on their POS terminal and the Customer scan QR Code from their app in order to complete the payment. This mode is applicable to payments made on websites, physical stores, media advertising, or other scenarios.
\nPlease use HTTP 'POST' method to access the URL, both the request data and response data are in JSON format
\nAll data encoding is using 'UTF-8'
\nThis is the API URL format. The '{actionPath}' is the function name. For example 'pay/order'. http[s]://host/payment/{actionPath}
\nThe Test API URL : https://api.motionpay.org/payment/{actionPath}
\nThe test merchant ID : 100122220000005
\nThe test App ID : 5005642019001
\nThe test App Secure : ae26b1841a7291379db606e41bfa4417
\nPut all the data in the 'param' into a set M. Remove the parameters which have empty/null value. Order the param set M by the parameter names using 'ASCII' code (increasing). Put all the parameters (names and values) into a string A in this format (\"key1=value1&key2=value2…\"). It is the same format as the HTTP get method.
\n- Only the data in 'param' needs to be there\n- Order by parameter names by ASCII code increasing\n- Parameters which have Empty or Null value need to be removed\n- Parameter names and values are case sensitive\nAppend 'appid={appid}&appsecret={appsecret}' to the end of the StringA you get from step 1 to get stringSignTemp. Use SHA1 method to encrypt stringSignTemp. Then you will get the signValue for the sign parameter.
\n- {appid} and {appsecret} are provided by MotionPay\n- signValue is the signature value for the sign parameter\n- signValue need to be in small case.\nSample of stringSignTemp:
\namount=1&authcode=284773369684066898&merchantorderno=2018080974810084&paramjsonobject={"goods\\_info":"Test\\_Product","spbill\\_create\\_ip":"192.168.2.253","store\\_id":"","terminal\\_no":"WP15461Q00001350"}&paychannel=U&appid=5005642017008&appsecret=cd3f5e88a1ec1df2351cdca75d7ce94a\nSample of signValue generated by SHA1:
\n85171774a62ce5806abd0f1417dcc059dbfbebb7\n\n\n\n
The currency type for transaction is CAD (Canadian Dollar) by default. The unit used in payment amount is 【cent】 and must be an integer.
\nThe order number has to be generated manually, javascript example:
\nfunction pad2(n) { return n < 10 ? '0' + n : n }\n\nvar date = new Date();\n\norderNo = date.getFullYear().toString() + pad2(date.getMonth() + 1) + pad2( date.getDate()) + pad2( date.getHours() ) + pad2( date.getMinutes() ) + pad2( date.getSeconds() ) ;\n\norderNo = orderNo.toString();\n\n// orderNo: 20190112151250\nAuth code is used in Merchant Scan Customer Mobile and displayed by a customer in Wechat or Alipay APP.
\nThis solution, Merchant Scan Customer Mobile, enables merchants to collect money by scanning the barcode/QR code (Auth code) displayed on a customer's payment APP. Payment rails is unnecessary to be specified, which can be distinguished by Motion Pay Host.
\nSequence Chart
\n
Endpoint
\npay/order
\nHttp Method
\nPOST
\nHttp Header
\nContent-Type:application/json
\nAPI POST Action URL:
\nhttps://api.motionpay.org/payment/pay/order
\nMerchant Request Parameters:
\nResponse parameters:
\nSample of stringSignTemp for Scan Mobile (paychannel is U):
\namount=1&authcode=134583657133882637&merchantorderno=2018081106176844¶mjsonobject={\"goods_info\":\"Test_Product\",\"spbill_create_ip\":\"192.168.2.253\",\"store_id\":\"\",\"terminal_no\":\"MyPosT00001\"}&paychannel=U&appid=5005642017008&appsecret=cd3f5e88a1ec1df2351cdca75d7ce94a\nSample of signValue generated by SHA1:
\n57351cedc47a8aa71b5405606148f96b6b44974e\nA customer uses payment APP to scan a dynamic transaction QR code displayed by a merchant and authorizes the payment with/without keying a payment password in the payment APP.
\nSequence Chart
\n![\"avatar\"](\"https://demo.motionpay.org/images/QRcodeFlowDiagram.png\")
Endpoint
\npay/order
\nHttp Method
\nPOST
\nHttp Header
\nContent-Type:application/json
\nAPI POST Action URL:
\nhttps://api.motionpay.org/payment/pay/order
\nMerchant Request Parameters:
\nResponse parameters:
\nSample of stringSignTemp for Mobile Scan AliPay QR code (paychannel is A):
\namount=1&flag=alipay_native&merchantorderno=2018081176531634¶mjsonobject={\"goods_info\":\"Test_Product\",\"spbill_create_ip\":\"192.168.2.253\",\"store_id\":\"\",\"terminal_no\":\"MyPosT00001\"}&paychannel=A&appid=5005642017008&appsecret=cd3f5e88a1ec1df2351cdca75d7ce94a\nSample of signValue generated by SHA1:
\nd602f9b35316144a52b9b9774313d0a486071997\nSample of the JSON string request for Mobile Scan AliPay QR code (paychannel is A):
\n{\n \"param\": {\n \"amount\": 1,\n \"flag\": \"alipay_native\",\n \"merchantOrderNo\": \"{{mobileScanOrderNo}}\",\n \"paramJsonObject\": {\n \"goods_info\": \"Test_Product\",\n \"spbill_create_ip\": \"192.168.2.253\",\n \"store_id\": \"\",\n \"terminal_no\": \"MyPosT00001\"\n },\n \"payChannel\": \"A\"\n },\n \"signature\": \"{{mobileScanSignature}}\",\n \"suffix\": {\n \"mid\": \"100100010000010\"\n }\n}\nSample of stringSignTemp for Mobile Scan WeChat QR code (paychannel is W):
\namount=1&flag=weixin_native&merchantorderno=2018081127868566¶mjsonobject={\"goods_info\":\"Test_Product\",\"spbill_create_ip\":\"192.168.2.253\",\"store_id\":\"\",\"terminal_no\":\"MyPosT00001\"}&paychannel=W&appid=5005642017008&appsecret=cd3f5e88a1ec1df2351cdca75d7ce94a\nSample of signValue generated by SHA1:
\ncd170836360065a739952e257dbc3bb8e2710747 \nSample of the JSON string request for Mobile Scan WeChat QR code (paychannel is W):
\n{\n \"param\": {\n \"amount\": 1,\n \"flag\": \"weixin_native\",\n \"merchantOrderNo\": \"{{mobileScanOrderNo}}\",\n \"paramJsonObject\": {\n \"goods_info\": \"Test_Product\",\n \"spbill_create_ip\": \"192.168.2.253\",\n \"store_id\": \"\",\n \"terminal_no\": \"MyPosT00001\"\n },\n \"payChannel\": \"W\"\n },\n \"signature\": \"{{mobileScanSignature}}\",\n \"suffix\": {\n \"mid\": \"100100010000010\"\n }\n}\nInquire merchant's order status and details by order number.
\nEndpoint
\npay/queryOrder
\nHttp Method
\nPOST
\nHttp Header
\nContent-Type:application/json
\nAPI POST Action URL:
\nhttps://api.motionpay.org/payment/pay/queryOrder
\nMerchant Request Parameters:
\nResponse parameters:
\nSample of stringSignTemp for query function:
\nmerchantorderno=2018081127868566&appid=5005642017008&appsecret=cd3f5e88a1ec1df2351cdca75d7ce94a\nSample of signValue generated by SHA1:
\n21264fcf4127bdf77984042456e0c96c6353a5a3 \nSample of merchant request：
\n{\n \"param\": {\n \"merchantOrderNo\": \"20190112155859\"\n },\n \"suffix\": {\n \"mid\": \"100100010000010\"\n },\n \"signature\": \"{{signature}}\"\n}\nThe refund interface can request a full/partial refund.
\nEndpoint
\npay/revoke
\nHttp Method
\nPOST
\nHttp Header
\nContent-Type:application/json
\nAPI POST Action URL:
\nhttps://api.motionpay.org/payment/pay/revoke
\nMerchant Request Parameters:
\nResponse parameters:
\nSample of stringSignTemp for refund function:
\norderno=02100100010000010201808110014&refundamount=1&trancode=814&tranlogid=P100100010000010201808110019&appid=5005642017008&appsecret=cd3f5e88a1ec1df2351cdca75d7ce94a \nSample of signValue generated by SHA1:
\n74bb2155f74b11f9a235b09ba2011961423ce7af \nSample of merchant request：
\n{\n \"param\": {\n \"orderNo\": \"02100100010000010201901130004\",\n \"refundAmount\": 1,\n \"tranCode\": \"814\",\n \"tranLogId\": \"P100100010000010201901130004\"\n },\n \"suffix\": {\n \"mid\": \"100100010000010\"\n },\n \"signature\": \"{{refundSignature}}\"\n}\nDuring the purchase process, merchants can reverse/cancel the transaction.
\nEndpoint
\npay/cancel
\nHttp Method
\nPOST
\nHttp Header
\nContent-Type:application/json
\nAPI POST Action URL:
\nhttps://api.motionpay.org/payment/pay/cancel
\nMerchant Request Parameters:
\nServer response parameters:
\nSample of stringSignTemp for cancel function:
\norderno=01100100010000010201808300022&trancode=813&tranlogid=P100100010000010201808300025&appid=5005642017008&appsecret=cd3f5e88a1ec1df2351cdca75d7ce94a\nSample of signValue generated by SHA1:
\n43ab88146b14534d35f6ea40bc64a9cb9b408e67 \nSample of merchant request：
\n{\n \"param\": {\n \"tranCode\": \"814\",\n \"orderNo\": \"02100100010000010201901130010\",\n \"tranLogId\": \"P100100010000010201901130008\"\n },\n \"suffix\": {\n \"mid\": \"100100010000010\",\n \"lang\": \"en\"\n \n },\n \"signature\": \"{{cancelSignature}}\"\n}\n