|
|
|
@ -17,6 +17,9 @@
|
|
|
|
|
/**
|
|
|
|
|
* @apiDefine JSON JSON keys
|
|
|
|
|
*/
|
|
|
|
|
/**
|
|
|
|
|
* @apiDefine SUB_JSON JSON child keys
|
|
|
|
|
*/
|
|
|
|
|
/**
|
|
|
|
|
* @apiDefine ERROR_CODE Error Code
|
|
|
|
|
*/
|
|
|
|
@ -830,8 +833,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 +846,121 @@
|
|
|
|
|
* @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/{order_id} 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 Order is not belong to this partner
|
|
|
|
|
* @apiError (ERROR_CODE) ORDER_PAID Order has already been paid
|
|
|
|
|
*
|
|
|
|
|
*/
|
|
|
|
|
/**
|
|
|
|
|
* @api {PUT} /api/v1.0/customs/partners/{partner_code}/declare/query/{client_report_id} Create Declare No.
|
|
|
|
|
* @apiName declare_report
|
|
|
|
|
* @apiDescription
|
|
|
|
|
* Used to submit the attachment information of the order required by the merchant. WeChat and Alipay are only supported. WeChat only supports payment orders within one month for customs declaration.
|
|
|
|
|
*
|
|
|
|
|
* @apiVersion 1.0.0
|
|
|
|
|
* @apiGroup Custom
|
|
|
|
|
* @apiHeader Accept application/json
|
|
|
|
|
* @apiHeader Content-Type application/json
|
|
|
|
|
* @apiParam (PathVariable) {String} partner_code Required, Partner code
|
|
|
|
|
* @apiParam (PathVariable) {String} client_report_id Required, Client declare ID
|
|
|
|
|
* @apiUse Sign
|
|
|
|
|
* @apiParam (JSON) {String} order_id Required, Partner order id
|
|
|
|
|
* @apiParam (JSON) {String} custom Required, Customs No. * <a href="https://www.royalpay.com.au/downloads/CustomsNO.xlsx">Customs No.</a>
|
|
|
|
|
* @apiParam (JSON) {String} mch_custom_id Required, Customs record id
|
|
|
|
|
* @apiParam (JSON) {String} mch_custom_name Required, Customs record name
|
|
|
|
|
* @apiParam (JSON) {JSONArray} sub_order Child orders
|
|
|
|
|
*
|
|
|
|
|
* @apiParam (SUB_JSON) {String} sub_order_no Child order ID
|
|
|
|
|
* @apiParam (SUB_JSON) {String=CNY} fee_type=CNY Currency
|
|
|
|
|
* @apiParam (SUB_JSON) {Double} order_fee Child Order Amount
|
|
|
|
|
* @apiParam (SUB_JSON) {Double} transport_fee Child Order Logistics Amount
|
|
|
|
|
*
|
|
|
|
|
* @apiSuccess {String} report_id RoyalPay declare ID
|
|
|
|
|
* @apiSuccess {String} client_report_id Client declare ID
|
|
|
|
|
* @apiSuccess {int} report_status 0:PROCCESSING,1:SUBMITED,2:FAIL,3:SUCCESS
|
|
|
|
|
* @apiSuccess {String} channel Channel
|
|
|
|
|
* @apiSuccess {String} custom Customs No.
|
|
|
|
|
* @apiSuccess {String} mch_custom_no Customs record ID
|
|
|
|
|
* @apiSuccess {String} mch_custom_name Customs record name
|
|
|
|
|
* @apiSuccess {String} order_id Royalpay Order ID
|
|
|
|
|
* @apiSuccess {String} transaction_id Channel Order ID
|
|
|
|
|
* @apiSuccess {String} order_currency Currency
|
|
|
|
|
* @apiSuccess {Double} order_amount Order Amount
|
|
|
|
|
* @apiSuccess {String} report_time Declare Time
|
|
|
|
|
* @apiSuccess {String} creation_date Create Time
|
|
|
|
|
* @apiSuccess {String} last_update_date Update Time
|
|
|
|
|
* @apiSuccess {String} error_code Error Code
|
|
|
|
|
* @apiSuccess {String} error_msg Error Description
|
|
|
|
|
*
|
|
|
|
|
* @apiUse GlobalError
|
|
|
|
|
* @apiError (ERROR_CODE) ORDER_MISMATCH 订单号与商户不匹配
|
|
|
|
|
* @apiError (ERROR_CODE) ORDER_PAID 订单已支付
|
|
|
|
|
* @apiError (ERROR_CODE) ORDER_MISMATCH Order is not belong to this partner
|
|
|
|
|
*
|
|
|
|
|
*/
|
|
|
|
|
/**
|
|
|
|
|
* @api {GET} /api/v1.0/customs/partners/{partner_code}/declare/query/{report_id} Query Declare ID
|
|
|
|
|
* @apiName declare_query
|
|
|
|
|
* @apiDescription
|
|
|
|
|
* Used by the merchant to check the status of the customs declaration number.
|
|
|
|
|
*
|
|
|
|
|
* @apiVersion 1.0.0
|
|
|
|
|
* @apiGroup Custom
|
|
|
|
|
* @apiHeader Accept application/json
|
|
|
|
|
* @apiHeader Content-Type application/json
|
|
|
|
|
* @apiParam (PathVariable) {String} partner_code Required, Partner code
|
|
|
|
|
* @apiParam (PathVariable) {String} report_id Required,RoyalPay Declare ID
|
|
|
|
|
* @apiUse Sign
|
|
|
|
|
*
|
|
|
|
|
* @apiSuccess {String} return_code Execution result
|
|
|
|
|
* @apiSuccess {String} report_status Result status
|
|
|
|
|
* @apiSuccess {String} report_id Client declare ID
|
|
|
|
|
* @apiSuccess {String} return_msg Error Description
|
|
|
|
|
* @apiSuccess {String} order_id RoyalPay Order
|
|
|
|
|
*
|
|
|
|
|
* @apiUse GlobalError
|
|
|
|
|
* @apiError (ERROR_CODE) ORDER_MISMATCH Order is not belong to this partner
|
|
|
|
|
*
|
|
|
|
|
*/
|
|
|
|
|
function apis() {
|
|
|
|
|