add hf apidoc

src/document/cn/apidoc.json

@@ -26,6 +26,7 @@
     "RetailQRCode",
     "JD_Online_Payment",
     "Alipay_Online_Payment",
+    "HFPayment",
     "SDKPayment",
     "CommonApi",
     "GetExchange",

src/document/cn/apis.js

@@ -687,7 +687,7 @@
  * @apiDescription
  * 接入微信小程序需完成海外主体认证，并且认证主体需要与在RoyalPay开通的商户主体一致。具体如何认证请查看微信公众平台相关文档。
  * 用于小程序中发起支付，创建订单后返回小程序支付所需参数，该接口现仅支持微信小程序。
- *  <a href="https://www.royalpay.com.au/downloads/MiniProgram_WechatPay.pdf"> 接入参考文档</a>
+ *  <a href="https://www.royalpay.com.au/downloads/ProductIdList.xlsx"> 接入参考文档</a>
  * <br>
  *     <img src="img/microapp_cn.png">
  * @apiVersion 1.0.0
@@ -797,6 +797,45 @@
  * @apiError (ERROR_CODE) ORDER_PAID 订单已支付
  *
  */
+
+/**
+ * @api {PUT} /api/v1.0/hf_gateway/partners/{partner_code}/orders/{orderId} 创建汇付Web订单
+ * @apiName hfapi
+ * @apiDescription
+ * 用于PC端汇付通支付，创建订单后跳转到返回的pay_url，随后进入汇付通支付页面完成支付
+ * 该接口仅现仅支持汇付通支付。<br>
+ *
+ * @apiVersion 1.0.0
+ * @apiGroup HFPayment
+ * @apiHeader Accept application/json
+ * @apiHeader Content-Type application/json
+ * @apiParam (PathVariable) {String} partner_code 必填，商户编码，由4位大写字母或数字构成
+ * @apiParam (PathVariable) {String} order_id 必填，商户支付订单号，要求同一商户唯一
+ * @apiUse Sign
+ * @apiParam (JSON) {String} description 必填，订单标题（最大长度128字符，超出自动截取）
+ * @apiParam (JSON) {String} mobile 必填，商户平台用户的手机号
+ * @apiParam (JSON) {int} price 必填，金额，单位为货币最小单位，例如使用100表示AUD1.00
+ * @apiParam (JSON) {String} product_id 必填，商品类别代码 *  <a href="https://www.royalpay.com.au/downloads/ProductIdList.xlsx">商品类别代码</a>
+ * @apiParam (JSON) {String} product_name 必填 商品名称
+ * @apiParam (JSON) {String} product_count 商品数量
+ * @apiParam (JSON) {String=AUD} currency=AUD 币种代码(当前仅支持AUD)
+ * @apiParam (JSON) {String} notify_url 支付通知url，详见支付通知api，不填则不会推送支付通知
+ * @apiParam (JSON) {String} operator 操作人员标识
+ *
+ * @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} partner_order_id 商户订单ID
+ * @apiSuccess {String} pay_url 跳转URL
+ *
+ * @apiUse GlobalError
+ * @apiError (ERROR_CODE) ORDER_MISMATCH 订单号与商户不匹配
+ * @apiError (ERROR_CODE) ORDER_PAID 订单已支付
+ *
+ */
 function apis() {
 
 }

src/document/en/apidoc.json

@@ -26,6 +26,7 @@
     "RetailQRCode",
     "JD_Online_Payment",
     "Alipay_Online_Payment",
+    "HFPayment",
     "SDKPayment",
     "CommonApi",
     "GetExchange",

src/document/en/apis.js

@@ -811,6 +811,47 @@
  * @apiError (ERROR_CODE) ORDER_PAID Order has already been paid
  *
  */
+
+
+
+/**
+ * @api {PUT} /api/v1.0/hf_gateway/partners/{partner_code}/orders/{orderId} Create HF Web Order
+ * @apiName hfapi
+ * @apiDescription
+ * Use for HF Payment in PC Website. After create order, jump to the pay_url returned and attach sign params and redirect param.
+ * Then enter HF Pay page to finish payment.<br>
+ *
+ * @apiVersion 1.0.0
+ * @apiGroup HFPayment
+ * @apiHeader Accept application/json
+ * @apiHeader Content-Type application/json
+ * @apiParam (PathVariable) {String} partner_code 必填，商户编码，由4位大写字母或数字构成
+ * @apiParam (PathVariable) {String} order_id 必填，商户支付订单号，要求同一商户唯一
+ * @apiUse Sign
+ * @apiParam (JSON) {String} description Required, Order description
+ * @apiParam (JSON) {String} mobile Required，Mobile phone
+ * @apiParam (JSON) {int} price Required, Price of the order. Use the base unit of the currency.
+ * @apiParam (JSON) {String} product_id Product code Required *  <a href="https://www.royalpay.com.au/downloads/ProductIdList.xlsx">Product Code List</a>
+ * @apiParam (JSON) {String} product_name Product name Required
+ * @apiParam (JSON) {String} product_count Product count
+ * @apiParam (JSON) {String=AUD} currency=AUD Currency (only AUD)
+ * @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.
+ *
+ * @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} partner_order_id 商户订单ID
+ * @apiSuccess {String} pay_url 跳转URL
+ *
+ * @apiUse GlobalError
+ * @apiError (ERROR_CODE) ORDER_MISMATCH 订单号与商户不匹配
+ * @apiError (ERROR_CODE) ORDER_PAID 订单已支付
+ *
+ */
 function apis() {
 
 }