@ -17,6 +17,9 @@
/ * *
/ * *
* @ apiDefine JSON JSON keys
* @ apiDefine JSON JSON keys
* /
* /
/ * *
* @ apiDefine SUB _JSON JSON child keys
* /
/ * *
/ * *
* @ apiDefine ERROR _CODE Error Code
* @ apiDefine ERROR _CODE Error Code
* /
* /
@ -830,8 +833,8 @@
* @ apiGroup HF _Online _Payment
* @ apiGroup HF _Online _Payment
* @ apiHeader Accept application / json
* @ apiHeader Accept application / json
* @ apiHeader Content - Type application / json
* @ apiHeader Content - Type application / json
* @ apiParam ( PathVariable ) { String } partner _code 必填, 商户编码 , 由4位大写字母或数字构成
* @ apiParam ( PathVariable ) { String } partner _code Required, Partner code
* @ apiParam ( PathVariable ) { String } order _id 必填, 商户支付订单号 , 要求同一商户唯一
* @ apiParam ( PathVariable ) { String } order _id Required, Partner order id
* @ apiUse Sign
* @ apiUse Sign
* @ apiParam ( JSON ) { String } description Required , Order description
* @ apiParam ( JSON ) { String } description Required , Order description
* @ apiParam ( JSON ) { String } mobile Required , Mobile phone
* @ 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 } 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 } operator Note for the operator who created this order .
*
*
* @ apiSuccess { String } return _code 执行结果
* @ apiSuccess { String } return _code Execution result
* @ apiSuccess { String } result _code SUCCESS表示创建订单成功 , EXISTS表示订单已存在
* @ apiSuccess { String } result _code SUCCESS means order created successfully , EXISTS means order has already existed .
* @ apiSuccess { String } partner _code 商户编码
* @ apiSuccess { String } partner _code Partner code
* @ apiSuccess { String } full _name 商户注册全名
* @ apiSuccess { String } full _name Partner ' s full company name when registered
* @ apiSuccess { String } partner _name 商户名称
* @ apiSuccess { String } partner _name Partner ' s name
* @ apiSuccess { String } order _id RoyalPay订单ID , 同时也是微信订单ID , 最终支付成功的订单ID可能不同
* @ 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 商户订单ID
* @ apiSuccess { String } partner _order _id Partner order id
* @ apiSuccess { String } pay _url 跳转URL
* @ 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 Customs _Declaration
* @ 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
* @ apiUse GlobalError
* @ apiError ( ERROR _CODE ) ORDER _MISMATCH 订单号与商户不匹配
* @ apiError ( ERROR _CODE ) ORDER _MISMATCH Order is not belong to this partner
* @ apiError ( ERROR _CODE ) ORDER _PAID 订单已支付
*
* /
/ * *
* @ 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 Customs _Declaration
* @ 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 ( ) {
function apis ( ) {