msb_52843
/
dalong_mall
1
0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

document update

Browse Source
master
yixian 5 years ago
parent ef6e45caa4
commit b2c07291ac
2 changed files with 31 additions and 29 deletions
Show Stats Download Patch File Download Diff File

29
src/document/cn/apis.js
Unescape View File

@ -82,7 +82,7 @@
* @apiSuccess {String} partner_code 商户编码
* @apiSuccess {String} full_name 商户注册全名
* @apiSuccess {String} partner_name 商户名称
* @apiSuccess {String} order_id RoyalPay订单ID，同时也是微信订单ID，最终支付成功的订单ID可能不同
* @apiSuccess {String} order_id RoyalPay订单ID，同时也是支付渠道订单ID，最终支付成功的订单ID可能不同
* @apiSuccess {String} partner_order_id 商户订单ID
* @apiSuccess {String} code_url 支付码字符串，商户可以据此自行生产二维码
* @apiSuccess {String} qrcode_img Base64封装的二维码图片，可直接作为img的src属性
@ -121,7 +121,7 @@
* @apiSuccess {String} partner_code 商户编码
* @apiSuccess {String} full_name 商户注册全名
* @apiSuccess {String} partner_name 商户名称
* @apiSuccess {String} order_id GlobalFreePay订单ID，同时也是微信订单ID，最终支付成功的订单ID可能不同
* @apiSuccess {String} order_id GlobalFreePay订单ID，同时也是支付渠道订单ID，最终支付成功的订单ID可能不同
* @apiSuccess {String} partner_order_id 商户订单ID
* @apiSuccess {String} code_url 支付码字符串，商户可以据此自行生产二维码
* @apiSuccess {String} qrcode_img Base64封装的二维码图片，可直接作为img的src属性
@ -177,7 +177,7 @@
* @apiSuccess {String} channel 支付渠道
* @apiSuccess {String} full_name 商户注册全名
* @apiSuccess {String} partner_name 商户名称
* @apiSuccess {String} order_id RoyalPay订单ID，同时也是微信订单ID，最终支付成功的订单ID可能不同
* @apiSuccess {String} order_id RoyalPay订单ID，同时也是支付渠道订单ID，最终支付成功的订单ID可能不同
* @apiSuccess {String} partner_order_id 商户订单ID
* @apiSuccess {String} pay_url 跳转URL
*
@ -231,7 +231,7 @@
* @apiSuccess {String} channel 支付渠道
* @apiSuccess {String} full_name 商户注册全名
* @apiSuccess {String} partner_name 商户名称
* @apiSuccess {String} order_id RoyalPay订单ID，同时也是微信订单ID，最终支付成功的订单ID可能不同
* @apiSuccess {String} order_id RoyalPay订单ID，同时也是支付渠道订单ID，最终支付成功的订单ID可能不同
* @apiSuccess {String} partner_order_id 商户订单ID
* @apiSuccess {String} pay_url 跳转URL
*
@ -301,7 +301,7 @@
* <li>PAY_FAIL:支付失败</li>
* <li>PAY_SUCCESS:支付成功</li>
* </ul>
* @apiSuccess {String} order_id RoyalPay订单ID，同时也是微信订单ID
* @apiSuccess {String} order_id RoyalPay订单ID，同时也是支付渠道订单ID
* @apiSuccess {String} partner_order_id 商户订单ID
* @apiSuccess {int} total_fee 订单金额，单位是货币最小面值单位
* @apiSuccess {int} real_fee 实际支付金额，单位是货币最小面值单位(目前等于订单金额，为卡券预留)
@ -346,7 +346,7 @@
* @apiSuccess {String} partner_code 商户编码
* @apiSuccess {String} full_name 商户注册全名
* @apiSuccess {String} partner_name 商户名称
* @apiSuccess {String} order_id RoyalPay订单ID，同时也是微信订单ID，最终支付成功的订单ID可能不同
* @apiSuccess {String} order_id RoyalPay订单ID，同时也是支付渠道订单ID，最终支付成功的订单ID可能不同
* @apiSuccess {String} partner_order_id 商户订单ID
* @apiSuccess {String} code_url 支付码字符串，商户可以据此自行生产二维码
*
@ -378,7 +378,7 @@
* <li>FULL_REFUND:全额退款</li>
* </ul>
* 如果需要可以用相同订单号再次发起支付单，支付成功或支付中的无法重复发起订单
* @apiSuccess {String} order_id RoyalPay订单ID，同时也是微信订单ID，最终支付成功的订单ID可能不同
* @apiSuccess {String} order_id RoyalPay订单ID，同时也是支付渠道订单ID，最终支付成功的订单ID可能不同
* @apiSuccess {String} partner_order_id 商户订单ID
* @apiSuccess {String} channel_order_id 渠道方(支付宝、微信)交易流水号
* @apiSuccess {int} total_fee 订单金额，单位是货币最小面值单位
@ -715,7 +715,7 @@
* @apiSuccess {String} partner_code 商户编码
* @apiSuccess {String} full_name 商户注册全名
* @apiSuccess {String} partner_name 商户名称
* @apiSuccess {String} order_id RoyalPay订单ID，同时也是微信订单ID，最终支付成功的订单ID可能不同
* @apiSuccess {String} order_id RoyalPay订单ID，同时也是支付渠道订单ID，最终支付成功的订单ID可能不同
* @apiSuccess {String} partner_order_id 商户订单ID
* @apiSuccess {String} pay_url 跳转URL
*
@ -744,17 +744,18 @@
* @apiParam (JSON) {String} description 必填，订单标题（最大长度128字符，超出自动截取）
* @apiParam (JSON) {int} price 必填，金额，单位为货币最小单位，例如使用100表示AUD1.00
* @apiParam (JSON) {String=AUD,CNY} currency=AUD 币种代码
* @apiParam (JSON) {String=Alipay,Wechat} channel=Wechat 支付通道，微信小程序只能调用微信渠道，支付宝小程序只能调用支付宝渠道
* @apiParam (JSON) {String} notify_url 支付通知url，详见支付通知api，不填则不会推送支付通知
* @apiParam (JSON) {String} operator 操作人员标识
* @apiParam (JSON) {String} appid 小程序appid
* @apiParam (JSON) {String} customer_id 小程序openid
* @apiParam (JSON) {String} appid 小程序appid(接入微信小程序必填，支付宝不需要)
* @apiParam (JSON) {String} customer_id 小程序获取的用户id(微信为openid，支付宝为userid)
*
* @apiSuccess {String} return_code 执行结果
* @apiSuccess {String} result_code SUCCESS表示创建订单成功，EXISTS表示订单已存在
* @apiSuccess {String} partner_code 商户编码
* @apiSuccess {String} full_name 商户注册全名
* @apiSuccess {String} partner_name 商户名称
* @apiSuccess {String} order_id RoyalPay订单ID，同时也是微信订单ID，最终支付成功的订单ID可能不同
* @apiSuccess {String} order_id RoyalPay订单ID，同时也是支付渠道订单ID，最终支付成功的订单ID可能不同
* @apiSuccess {String} partner_order_id 商户订单ID
* @apiSuccess {String} sdk_params 小程序支付所需参数(Json字符串)
*
@ -790,7 +791,7 @@
* @apiSuccess {String} partner_code 商户编码
* @apiSuccess {String} full_name 商户注册全名
* @apiSuccess {String} partner_name 商户名称
* @apiSuccess {String} order_id RoyalPay订单ID，同时也是微信订单ID，最终支付成功的订单ID可能不同
* @apiSuccess {String} order_id RoyalPay订单ID，同时也是支付渠道订单ID，最终支付成功的订单ID可能不同
* @apiSuccess {String} partner_order_id 商户订单ID
* @apiSuccess {String} pay_url 跳转URL
*
@ -835,7 +836,7 @@
* @apiSuccess {String} partner_code 商户编码
* @apiSuccess {String} full_name 商户注册全名
* @apiSuccess {String} partner_name 商户名称
* @apiSuccess {String} order_id RoyalPay订单ID，同时也是微信订单ID，最终支付成功的订单ID可能不同
* @apiSuccess {String} order_id RoyalPay订单ID，同时也是支付渠道订单ID，最终支付成功的订单ID可能不同
* @apiSuccess {String} partner_order_id 商户订单ID
* @apiSuccess {String} sdk_params 调用SDK的参数字符串
*
@ -874,7 +875,7 @@
* @apiSuccess {String} partner_code 商户编码
* @apiSuccess {String} full_name 商户注册全名
* @apiSuccess {String} partner_name 商户名称
* @apiSuccess {String} order_id RoyalPay订单ID，同时也是微信订单ID，最终支付成功的订单ID可能不同
* @apiSuccess {String} order_id RoyalPay订单ID，同时也是支付渠道订单ID，最终支付成功的订单ID可能不同
* @apiSuccess {String} partner_order_id 商户订单ID
* @apiSuccess {String} pay_url 跳转URL
*

31
src/document/en/apis.js
Unescape View File

@ -84,7 +84,7 @@
* @apiSuccess {String} partner_code Partner code
* @apiSuccess {String} full_name Partner's full company name when registered
* @apiSuccess {String} partner_name Partner's name
* @apiSuccess {String} order_id Order id in RoyalPay, which is also WeChat order id. The final order id which is paid may be different from this one.
* @apiSuccess {String} order_id Order id in RoyalPay, which is also payment channel(Wechat/Alipay) order id. The final order id which is paid may be different from this one.
* @apiSuccess {String} partner_order_id Partner order id
* @apiSuccess {String} code_url QR Code string. Partners can create the payment QR Code according to this value.
* @apiSuccess {String} qrcode_img QR Code image formatted in Base64. Can be used as the src attribute on img element
@ -124,7 +124,7 @@
* @apiSuccess {String} partner_code Partner code
* @apiSuccess {String} full_name Partner's full company name when registered
* @apiSuccess {String} partner_name Partner's name
* @apiSuccess {String} order_id Order id in GlobalFreePay, which is also WeChat order id. The final order id which is paid may be different from this one.
* @apiSuccess {String} order_id Order id in GlobalFreePay, which is also payment channel(Wechat/Alipay) order id. The final order id which is paid may be different from this one.
* @apiSuccess {String} partner_order_id Partner order id
* @apiSuccess {String} code_url QR Code string. Partners can create the payment QR Code according to this value.
* @apiSuccess {String} qrcode_img QR Code image formatted in Base64. Can be used as the src attribute on img element
@ -183,7 +183,7 @@
* @apiSuccess {String} channel Payment channel
* @apiSuccess {String} full_name Partner's full company name when registered
* @apiSuccess {String} partner_name Partner's name
* @apiSuccess {String} order_id Order id in RoyalPay, which is also WeChat order id.
* @apiSuccess {String} order_id Order id in RoyalPay, which is also payment channel(Wechat/Alipay) order id.
* @apiSuccess {String} partner_order_id Partner order id
* @apiSuccess {String} pay_url Payment page in RoyalPay.
*
@ -239,7 +239,7 @@
* @apiSuccess {String} channel Payment Channel
* @apiSuccess {String} full_name Partner's full company name when registered
* @apiSuccess {String} partner_name Partner's name
* @apiSuccess {String} order_id Order id in RoyalPay, which is also WeChat order id. The final order id which is paid may be different from this one
* @apiSuccess {String} order_id Order id in RoyalPay, which is also payment channel(Wechat/Alipay) order id. The final order id which is paid may be different from this one
* @apiSuccess {String} partner_order_id Partner order id
* @apiSuccess {String} pay_url Payment page in RoyalPay. Can only be accessed through WeChat
*
@ -310,7 +310,7 @@
* <li>PAY_FAIL:Payment failed</li>
* <li>PAY_SUCCESS:Payment succeeded</li>
* </ul>
* @apiSuccess {String} order_id Order id in RoyalPay, which is also WeChat order id.
* @apiSuccess {String} order_id Order id in RoyalPay, which is also payment channel(Wechat/Alipay) order id.
* @apiSuccess {String} partner_order_id Partner order id
* @apiSuccess {int} total_fee Order amount, which uses the base unit of current currency
* @apiSuccess {int} real_fee Actual paid amount.(The same as total fee at the moment. After coupon feature is finished, this may be different.)
@ -356,7 +356,7 @@
* @apiSuccess {String} partner_code Partner code
* @apiSuccess {String} full_name Partner's full company name when registered
* @apiSuccess {String} partner_name Partner's name
* @apiSuccess {String} order_id Order id in RoyalPay, which is also WeChat order id. The final order id which is paid may be different from this one
* @apiSuccess {String} order_id Order id in RoyalPay, which is also payment channel(Wechat/Alipay) order id. The final order id which is paid may be different from this one
* @apiSuccess {String} partner_order_id Partner order id
* @apiSuccess {String} code_url QR Code string. Partners can create the payment QR Code according to this value.
*
@ -390,7 +390,7 @@
* <li>Full_REFUND: Full refunded</li>
* </ul>
* Use the same order id to call create order API can renew the order. PAYING, PAY_SUCCESS orders cannot be renewed.
* @apiSuccess {String} order_id Order id in RoyalPay, which is also WeChat order id. The final order id which is paid may be different from this one
* @apiSuccess {String} order_id Order id in RoyalPay, which is also payment channel(Wechat/Alipay) order id. The final order id which is paid may be different from this one
* @apiSuccess {String} partner_order_id Partner order id
* @apiSuccess {String} channel_order_id PayChannel(Alipay、Wechat) Transaction Trade No
* @apiSuccess {int} total_fee Order amount, which uses the base unit of current currency
@ -728,7 +728,7 @@
* @apiSuccess {String} partner_code Partner code
* @apiSuccess {String} full_name Partner's full company name when registered
* @apiSuccess {String} partner_name Partner's name
* @apiSuccess {String} order_id Order id in RoyalPay, which is also WeChat order id. The final order id which is paid may be different from this one
* @apiSuccess {String} order_id Order id in RoyalPay, which is also payment channel(Wechat/Alipay) order id. The final order id which is paid may be different from this one
* @apiSuccess {String} partner_order_id Partner order id
* @apiSuccess {String} pay_url Payment page in RoyalPay. Can only be accessed through WeChat
*
@ -742,8 +742,8 @@
* @api {PUT} /api/v1.0/gateway/partners/{partner_code}/microapp_orders/{order_id} Create Miniprogram Order
* @apiName microapp
* @apiDescription
Use for wechat Payment in miniprogram. After create order, returned and redirect param.
* wechat Channel Only.<br> * <br>
Use for call Payment in Wechat/Alipay miniprogram. After create order, returned and redirect param.
* * <br>
* <a href="https://www.royalpay.com.au/downloads/MiniProgram_WechatPay.pdf"> MiniProgram_WechatPay doc</a>
* <img src="img/microapp_en.png">
* @apiVersion 1.0.0
@ -756,17 +756,18 @@
* @apiParam (JSON) {String} description Required, Order description
* @apiParam (JSON) {int} price Required, Price of the order. Use the base unit of the currency.
* @apiParam (JSON) {String=AUD,CNY} currency=AUD Currency
* @apiParam (JSON) {String=Wechat,Alipay} channel=Wechat Payment channel. Wechat for Wechat miniprogram and Alipay for Alipay miniprogram
* @apiParam (JSON) {String} notify_url System will call the notify url if provided when the payment succeeds
* @apiParam (JSON) {String} operator Note for the operator who created this order.
* @apiParam (JSON) {String} appid wechat app app_id
* @apiParam (JSON) {String} customer_id wechat app open_id
* @apiParam (JSON) {String} appid Wechat channel required, miniprogram app_id
* @apiParam (JSON) {String} customer_id wechat miniprogram open_id or alipay miniprogram userid
*
* @apiSuccess {String} return_code Execution result
* @apiSuccess {String} result_code SUCCESS means order created successfully, EXISTS means order has already existed.
* @apiSuccess {String} partner_code Partner code
* @apiSuccess {String} full_name Partner's full company name when registered
* @apiSuccess {String} partner_name Partner's name
* @apiSuccess {String} order_id Order id in RoyalPay, which is also WeChat order id. The final order id which is paid may be different from this one
* @apiSuccess {String} order_id Order id in RoyalPay, which is also payment channel(Wechat/Alipay) order id. The final order id which is paid may be different from this one
* @apiSuccess {String} partner_order_id Partner order id
* @apiSuccess {String} pay_url Payment page in RoyalPay. Can only be accessed through WeChat
* @apiSuccess {String} sdk_params The required parameters for payment.(Json String)
@ -805,7 +806,7 @@
* @apiSuccess {String} partner_code Partner code
* @apiSuccess {String} full_name Partner's full company name when registered
* @apiSuccess {String} partner_name Partner's name
* @apiSuccess {String} order_id Order id in RoyalPay, which is also WeChat order id. The final order id which is paid may be different from this one
* @apiSuccess {String} order_id Order id in RoyalPay, which is also payment channel(Wechat/Alipay) order id. The final order id which is paid may be different from this one
* @apiSuccess {String} partner_order_id Partner order id
* @apiSuccess {String} pay_url Payment page in RoyalPay. Can only be accessed through WeChat
*
@ -852,7 +853,7 @@
* @apiSuccess {String} partner_code Partner code
* @apiSuccess {String} full_name Partner's full company name when registered
* @apiSuccess {String} partner_name Partner's name
* @apiSuccess {String} order_id Order id in RoyalPay, which is also WeChat order id. The final order id which is paid may be different from this one
* @apiSuccess {String} order_id Order id in RoyalPay, which is also payment channel(Wechat/Alipay) order id. The final order id which is paid may be different from this one
* @apiSuccess {String} partner_order_id Partner order id
* @apiSuccess {String} sdk_params param string for calling SDK
*

Write Preview
Loading…
Cancel
Save