CB BankPay Api

src/document/cn/apidoc.json

@@ -27,6 +27,7 @@
     "JD_Online_Payment",
     "Alipay_Online_Payment",
     "HF_Online_Payment",
+    "CB_BankPay",
     "SDKPayment",
     "CommonApi",
     "GetExchange",
@@ -41,4 +42,4 @@
   "template":{
     "forceLanguage":"zh_cn"
   }
-}
+}

src/document/cn/apis.js

@@ -839,6 +839,41 @@
  * @apiError (ERROR_CODE) ORDER_PAID 订单已支付
  *
  */
+/**
+ * @api {PUT} /api/v1.0/yeepay/partners/{partner_code}/orders/{orderId} 创建网银快捷支付订单
+ * @apiName cbbankpayapi
+ * @apiDescription
+ * 用于PC端网银快捷支付，创建订单后跳转到返回的pay_url，随后进入网银快捷支付页面完成支付
+ *
+ * @apiVersion 1.0.0
+ * @apiGroup CB_BankPay
+ * @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) {int} price 必填，金额，单位为货币最小单位，例如使用100表示AUD1.00
+ * @apiParam (JSON) {String} product_name 必填 商品名称
+ * @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可能不同
+ * @apiSuccess {String} partner_order_id 商户订单ID
+ * @apiSuccess {String} channel 支付渠道
+ * @apiSuccess {String} pay_url 跳转URL
+ *
+ * @apiUse GlobalError
+ * @apiError (ERROR_CODE) ORDER_MISMATCH 订单号与商户不匹配
+ * @apiError (ERROR_CODE) ORDER_PAID 订单已支付
+ *
+ */
 function apis() {
 
-}
+}

src/document/en/apidoc.json

@@ -27,6 +27,7 @@
     "JD_Online_Payment",
     "Alipay_Online_Payment",
     "HF_Online_Payment",
+    "CB_BankPay",
     "SDKPayment",
     "CommonApi",
     "GetExchange",
@@ -41,4 +42,4 @@
   "template":{
     "forceLanguage":"en"
   }
-}
+}

src/document/en/apis.js

@@ -830,8 +830,8 @@
  * @apiGroup HF_Online_Payment
  * @apiHeader Accept application/json
  * @apiHeader Content-Type application/json
- * @apiParam (PathVariable) {String} partner_code 必填，商户编码，由4位大写字母或数字构成
- * @apiParam (PathVariable) {String} order_id 必填，商户支付订单号，要求同一商户唯一
+ * @apiParam (PathVariable) {String} partner_code Required, Partner code
+ * @apiParam (PathVariable) {String} order_id Required, Partner order id
  * @apiUse Sign
  * @apiParam (JSON) {String} description Required, Order description
  * @apiParam (JSON) {String} mobile Required，Mobile phone
@@ -843,18 +843,52 @@
  * @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
+ * @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. 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.
+ *
+ * @apiUse GlobalError
+ * @apiError (ERROR_CODE) ORDER_MISMATCH Order is not belong to this partner
+ * @apiError (ERROR_CODE) ORDER_PAID Order has already been paid
+ *
+ */
+/**
+ * @api {PUT} /api/v1.0/yeepay/partners/{partner_code}/orders/{orderId}  Create CB BankPay Order
+ * @apiName cbbankpayapi
+ * @apiDescription
+ * Use for CB BankPay in PC Website. After create order, jump to the pay_url returned and attach sign params and redirect param.
+ *
+ * @apiVersion 1.0.0
+ * @apiGroup CB_BankPay
+ * @apiHeader Accept application/json
+ * @apiHeader Content-Type application/json
+ * @apiParam (PathVariable) {String} partner_code Required, Partner code
+ * @apiParam (PathVariable) {String} order_id Required, Partner order id
+ * @apiUse Sign
+ * @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} product_name Product name Required
+ * @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 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. 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.
  *
  * @apiUse GlobalError
- * @apiError (ERROR_CODE) ORDER_MISMATCH 订单号与商户不匹配
- * @apiError (ERROR_CODE) ORDER_PAID 订单已支付
+ * @apiError (ERROR_CODE) ORDER_MISMATCH Order is not belong to this partner
+ * @apiError (ERROR_CODE) ORDER_PAID Order has already been paid
  *
  */
 function apis() {