fix revert api doc文档

master
luoyang 5 years ago
parent 44e44af0bb
commit 934ae97579

@ -1099,218 +1099,6 @@
* @apiError (ERROR_CODE) ORDER_MISMATCH 订单号与商户不匹配
*
*/
/**
* @api {POST} /api/v1.0/gateway/partners/{gateway_short_id}/merchant/application 商户进件接口
* @apiName application_merchant
* @apiDescription
* 提交商户信息进件接口签名详细说明<a href="https://file.royalpay.com.au/open/2020/02/10/1581317569835_qgvzSc4a3dHX8RP5HZITN9K7fUsGtj.pdf" target="_blank">商户进件签名说明文档</a>
*
* @apiVersion 1.0.0
* @apiGroup Merchant
* @apiHeader Accept application/json
* @apiHeader Content-Type application/json
* @apiParam (PathVariable) {String(14)} gateway_short_id 必填代理网关编码由10-14位大写字母或数字构成(RoyalPay代理后台生成)
*
* @apiParam (JSON) {String(50)} apply_id 必填RoyalPay管理账号用户名Username
* @apiParam (JSON) {String(4)} parent_partner_code 选填父商户编码填写后会自动关联商户关系
* @apiParam (JSON) {String(200)} notify_url 选填审核结果通知url详见审核通知api不填则不会推送审核通知
* @apiParam (JSON) {JSON} company_info 必填商户公司主体信息
* @apiParam (JSON) {JSON} contact_info 必填商户联系人信息
* @apiParam (JSON) {JSON} legal_info 必填商户法人信息
* @apiParam (JSON) {JSON} pay_info 必填商户支付信息
* @apiParam (JSON) {JSON} settle_info 必填商户清算信息
* @apiParam (JSON) {JSON} compliance_file_info 必填商户合规文件信息
*
* @apiParam (COMPANY_SUB_JSON) {String(100)} company_name 必填公司名称
* @apiParam (COMPANY_SUB_JSON) {String(50)} short_name 必填公司简称
* @apiParam (COMPANY_SUB_JSON) {String(15)} store_name 必填店铺名称
* @apiParam (COMPANY_SUB_JSON) {String(100)} business_name 选填企业名称
* @apiParam (COMPANY_SUB_JSON) {String(100)=Association,Company,Government body,Partnership,Registered body(Sole Trader),Trust} business_structure 必填企业结构类型
* @apiParam (COMPANY_SUB_JSON) {String(20)} abn 选填如果business_structure非Company时必填
* @apiParam (COMPANY_SUB_JSON) {String(9)} acn 选填如果business_structure为Company时必填(acn为9位数字)
* @apiParam (COMPANY_SUB_JSON) {String(15)} company_phone 必填公司服务电话
* @apiParam (COMPANY_SUB_JSON) {String(200)} logo_url 必填公司logo图片url(图片需使用文件上传接口上传至服务器)
*
* @apiParam (CONTACT_SUB_JSON) {String(50)} contact_person 必填公司联系人姓名
* @apiParam (CONTACT_SUB_JSON) {String(15)} contact_phone 必填公司联系人电话
* @apiParam (CONTACT_SUB_JSON) {String(50)} contact_email 必填公司联系人邮箱
* @apiParam (CONTACT_SUB_JSON) {String(50)} contact_job 必填公司联系人工作职位
* @apiParam (CONTACT_SUB_JSON) {String(200)} address 必填公司所在地址
* @apiParam (CONTACT_SUB_JSON) {String(50)} suburb 必填公司所在区域
* @apiParam (CONTACT_SUB_JSON) {String(10)} postcode 必填公司所在区域邮编
* @apiParam (CONTACT_SUB_JSON) {String(20)=ACT,NSW,NT,QLD,SA,TAS,VIC,WA,OTHER} state 必填公司所在州
* @apiParam (CONTACT_SUB_JSON) {String(20)} country=AUS 必填公司所在国家
* @apiParam (CONTACT_SUB_JSON) {String(200)} registered_address 必填公司注册地址(可与公司所在地址相同)
* @apiParam (CONTACT_SUB_JSON) {String(50)} registered_suburb 必填公司注册区域(可与公司所在区域相同)
* @apiParam (CONTACT_SUB_JSON) {String(10)} registered_postcode 必填公司注册所在区域邮编(可与公司所在区域邮编相同)
* @apiParam (CONTACT_SUB_JSON) {String(20)=ACT,NSW,NT,QLD,SA,TAS,VIC,WA,OTHER} registered_state 必填公司注册所在州(可与公司所在州相同)
* @apiParam (CONTACT_SUB_JSON) {String(30)=Australia/West,Australia/Eucla,Australia/North,Australia/South,Australia/Brisbane,Australia/Melbourne,Australia/LHI} timezone 必填公司所在时区
*
* @apiParam (LEGAL_SUB_JSON) {String(50)} legal_representative_person 必填公司法人姓名(可与公司联系人相同)
* @apiParam (LEGAL_SUB_JSON) {String(15)} legal_representative_phone 必填公司法人联系电话(可与公司联系人电话相同)
* @apiParam (LEGAL_SUB_JSON) {String(50)} legal_representative_email 必填公司法人联系邮件(可与公司联系人邮件相同)
* @apiParam (LEGAL_SUB_JSON) {String(50)} legal_representative_job 必填公司法人职位(可与公司联系人工作职位相同)
*
* @apiParam (PAY_SUB_JSON) {int[]=1,2} client_pay_type 必填公司支付场景(可多选) :1,2
* <li>1:线上支付</li>
* <li>2:线下支付</li>
* @apiParam (PAY_SUB_JSON) {int[]} client_pay_desc 必填公司支付场景描述(可多选) :101,102,105,202,203,20306
* <li>101:PC网站</li>
* <li>102:手机端网站</li>
* <li>103:APP</li>
* <li>104:微信内支付宝内网站</li>
* <li>105:小程序</li>
* <li>201:二维码立牌</li>
* <li>202:RoyalPay POS</li>
* <li>203:收银系统</li>
* <li>204:无人售货机</li>
* <li>20301:ipos</li>
* <li>20302:pospal</li>
* <li>20303:Lotus</li>
* <li>20304:AoShangBao</li>
* <li>20305:Infinity</li>
* <li>20306:EasyCloud</li>
* <li>20307:Aus Post</li>
* <li>20308:AoMaiKe</li>
* <li>20399:其他</li>
* @apiParam (PAY_SUB_JSON) {String(10)} royalpay_industry 必填RoyalPay行业编码详情见行业编码对照表<a href="https://file.royalpay.com.au/open/2020/02/10/1581319347677_y7aY7KZ7SUnwCWUab3hImxjAwuM3dQ.xlsx">行业编码对照表</a>
* @apiParam (PAY_SUB_JSON) {String(10)} wechat_industry 必填微信行业编码详情见行业编码对照表<a href="https://file.royalpay.com.au/open/2020/02/10/1581319347677_y7aY7KZ7SUnwCWUab3hImxjAwuM3dQ.xlsx">行业编码对照表</a>
* @apiParam (PAY_SUB_JSON) {String(10)} alipay_industry 必填支付宝行业编码详情见行业编码对照表<a href="https://file.royalpay.com.au/open/2020/02/10/1581319347677_y7aY7KZ7SUnwCWUab3hImxjAwuM3dQ.xlsx">行业编码对照表</a>
* @apiParam (PAY_SUB_JSON) {String(200)} company_photo 选填公司照片url如果支付场景为线下必填
* @apiParam (PAY_SUB_JSON) {String(200)} store_photo 选填门店照片url如果支付场景为线下必填
* @apiParam (PAY_SUB_JSON) {String(200)} company_website 选填公司网站url如果支付场景为线上必填
*
* @apiParam (SETTLE_SUB_JSON) {String(12)} swift_code 必填银行代码
* @apiParam (SETTLE_SUB_JSON) {String(6)} bsb_no 必填BSB号码
* @apiParam (SETTLE_SUB_JSON) {String(100)} bank 必填银行编码
* @apiParam (SETTLE_SUB_JSON) {String(30)} city 必填银行所在城市
* @apiParam (SETTLE_SUB_JSON) {String(100)} address 必填银行所在地址
* @apiParam (SETTLE_SUB_JSON) {String(20)} system 必填银行系统
* @apiParam (SETTLE_SUB_JSON) {String(20)} postcode 必填银行邮编
* @apiParam (SETTLE_SUB_JSON) {String(30)} state 必填银行所在州
* @apiParam (SETTLE_SUB_JSON) {String(100)} branch 必填银行分行
* @apiParam (SETTLE_SUB_JSON) {String(20)} account_no 必填银行账户编号
* @apiParam (SETTLE_SUB_JSON) {String(50)} account_name 必填银行账户名称
* @apiParam (SETTLE_SUB_JSON) {int=1,2,3} clean_days 必填清算周期t+1,t+2,t+3
* @apiParam (SETTLE_SUB_JSON) {Double} wechat_rate 必填微信清算费率(2=2%,1.5=1.5%)
* @apiParam (SETTLE_SUB_JSON) {Double} alipay_rate 必填支付宝清算费率(2=2%,1.5=1.5%)
* @apiParam (SETTLE_SUB_JSON) {Double} alipay_online_rate 必填支付宝线上清算费率(2=2%,1.5=1.5%)
* @apiParam (SETTLE_SUB_JSON) {Double} transaction_fee=0 必填交易手续费
* @apiParam (SETTLE_SUB_JSON) {Date} active_time 必填生效时间必须早于当日格式化:'yyyy-mm-dd HH:mm:ss'
* @apiParam (SETTLE_SUB_JSON) {Date} expire_time 必填过期时间格式化:'yyyy-mm-dd HH:mm:ss'
*
* @apiParam (COMPLIANCE_SUB_JSON) {String(200)} id_file 必填公司负责人ID文件上传驾照或护照推荐上传公司直接受益人ID文件如提供公司其他负责人ID文件需要描述原因(文件需使用文件上传接口上传至服务器)
* * @apiParam (COMPLIANCE_SUB_JSON) {String=passport,driver_license} id_type 必填上传id文件的类型
* <li>passport:护照</li>
* <li>driver_license:驾照</li>
* @apiParam (COMPLIANCE_SUB_JSON) {String='Ultimate beneficiary owner','CEO','Director','General Manager','Other'} id_title 必填id文件人的职位
* @apiParam (COMPLIANCE_SUB_JSON) {String(200)} id_title_description 选填未提供公司直接受益人ID文件的原因
* @apiParam (COMPLIANCE_SUB_JSON) {String(200)} bank_statement 必填银行结单文件url(文件需使用文件上传接口上传至服务器)
* @apiParam (COMPLIANCE_SUB_JSON) {String(200)} certificate_of_registration 必填公司注册文件url(文件需使用文件上传接口上传至服务器)
* @apiParam (COMPLIANCE_SUB_JSON) {String(200)} utility_bill 选填公司水电煤账单文件url(文件需使用文件上传接口上传至服务器)
*
* @apiSuccess {JSON} data 返回参数
* @apiSuccess {String} sign 返回签名
*
* @apiSuccess (SUB_JSON) {String} partner_code 商户编码
* @apiSuccess (SUB_JSON) {String='PASS','PROCESSING','REFUSED'} partner_status 商户审核状态PASS,PROCESSING,REFUSED
* @apiSuccess (SUB_JSON) {String} company_name 商户企业名称
* @apiSuccess (SUB_JSON) {String} credential_code 商户开发者密钥
* @apiSuccess (SUB_JSON) {String} short_name 商户简称
* @apiSuccess (SUB_JSON) {String} sign_type=RSA2 签名加密方式
* @apiSuccess (SUB_JSON) {String} nonce_str 随机字符串
* @apiSuccess (SUB_JSON) {String} url 接口url
*
* @apiError (ERROR) return_code Error Code
* @apiError (ERROR) return_msg Error Description
* @apiUse MerchantError
* @apiError (ERROR_CODE) PARAM_INVALID 参数不符合要求具体细节可参考return_msg字段
*
*/
/**
* @api {GET} /api/v1.0/gateway/partners/{gateway_short_id}/merchant/{partner_code}/status 商户状态查询接口
* @apiName query_merchant
* @apiDescription
* 查询商户审核状态及商户简要信息签名详细说明<a href="https://file.royalpay.com.au/open/2020/02/10/1581317569835_qgvzSc4a3dHX8RP5HZITN9K7fUsGtj.pdf" target="_blank">商户进件签名说明文档</a>
*
* @apiVersion 1.0.0
* @apiGroup Merchant
* @apiHeader Accept multipart/form-data
* @apiHeader Content-Type multipart/form-data
* @apiParam (PathVariable) {String(14)} gateway_short_id 必填代理网关编码由10-14位大写字母或数字构成(RoyalPay代理后台生成)
*
* @apiSuccess {JSON} data 返回参数
* @apiSuccess {String} sign 返回签名
*
* @apiSuccess (SUB_JSON) {String} partner_code 商户编码
* @apiSuccess (SUB_JSON) {String='PASS','PROCESSING','REFUSED'} partner_status 商户审核状态PASS,PROCESSING,REFUSED
* @apiSuccess (SUB_JSON) {String} company_name 商户企业名称
* @apiSuccess (SUB_JSON) {String} credential_code 商户开发者密钥
* @apiSuccess (SUB_JSON) {String} short_name 商户简称
* @apiSuccess (SUB_JSON) {String} sign_type=RSA2 签名加密方式
* @apiSuccess (SUB_JSON) {String} nonce_str 随机字符串
* @apiSuccess (SUB_JSON) {String} url 接口url
*
* @apiError (ERROR) return_code Error Code
* @apiError (ERROR) return_msg Error Description
* @apiUse MerchantError
* @apiError (ERROR_CODE) INVALID_SHORT_ID 商户编码不合法或没有对应商户
*
*/
/**
* @api {POST} /api/v1.0/gateway/partners/{gateway_short_id}/attachment/files 图片文件上传
* @apiName update_file
* @apiDescription
* 上传图片文件接口可用于上传商户logo公司照片店铺照片银行文件如图片过大建议压缩后上传签名详细说明<a href="https://file.royalpay.com.au/open/2020/02/10/1581317569835_qgvzSc4a3dHX8RP5HZITN9K7fUsGtj.pdf" target="_blank">商户进件签名说明文档</a>
*
* @apiVersion 1.0.0
* @apiGroup Merchant
* @apiHeader Accept application/json
* @apiHeader Content-Type application/json
* @apiParam (PathVariable) {String(14)} gateway_short_id 必填代理网关编码由10-14位大写字母或数字构成(RoyalPay代理后台生成)
*
* @apiParam (BINARY) {binary} file 文件数据流
*
* @apiSuccess {JSON} data 返回参数
* @apiSuccess {String} sign 返回签名
*
* @apiSuccess (SUB_JSON) {String} file_type 文件类型
* @apiSuccess (SUB_JSON) {String} file_url 文件网络url
* @apiSuccess (SUB_JSON) {String} original_filename 文件原名称
* @apiSuccess (SUB_JSON) {String} sign_type=RSA2 签名加密方式
* @apiSuccess (SUB_JSON) {String} nonce_str 随机字符串
* @apiSuccess (SUB_JSON) {String} url 接口url
*
* @apiError (ERROR) return_code Error Code
* @apiError (ERROR) return_msg Error Description
* @apiUse MerchantError
*
*/
/**
* @api {POST} /notify_url 商户审核状态通知
* @apiName merchant_notice
* @apiGroup Merchant
* @apiVersion 1.0.0
* @apiDescription
* 若商户进件时提供了notify_url系统会在商户审核状态改变后向这个地址主动发送商户审核结束状态推送请求方式为POST
* 与服务器API不同推送校验参数会包含在json内商户系统应该验证校验参数确定来源正确后再进行后续操作
* @apiHeader Accept application/json
* @apiHeader Content-Type application/json
* @apiSuccess {JSON} data 返回参数
* @apiSuccess {String} sign 返回签名
*
* @apiSuccess (SUB_JSON) {String} partner_code 商户编码
* @apiSuccess (SUB_JSON) {String='PASS','PROCESSING','REFUSED'} partner_status 商户审核状态PASS,PROCESSING,REFUSED
* @apiSuccess (SUB_JSON) {String} company_name 商户企业名称
* @apiSuccess (SUB_JSON) {String} credential_code 商户开发者密钥
* @apiSuccess (SUB_JSON) {String} short_name 商户简称
* @apiSuccess (SUB_JSON) {String} sign_type=RSA2 签名加密方式
* @apiSuccess (SUB_JSON) {String} nonce_str 随机字符串
* @apiSuccess (SUB_JSON) {String} url 商户进件notify_url
*
* @apiSuccess {String} return_code SUCCESS
*/
function apis() {
}

@ -1116,217 +1116,6 @@
* @apiError (ERROR_CODE) ORDER_MISMATCH Order is not belong to this partner
*
*/
/**
* @api {POST} /api/v1.0/gateway/partners/{gateway_short_id}/merchant/application Merchant Application
* @apiName application_merchant
* @apiDescription
* Submit merchant informationSignature details<a href="https://file.royalpay.com.au/open/2020/02/10/1581317569835_qgvzSc4a3dHX8RP5HZITN9K7fUsGtj.pdf" target="_blank">Merchant signature documentation</a>
*
* @apiVersion 1.0.0
* @apiGroup Merchant
* @apiHeader Accept application/json
* @apiHeader Content-Type application/json
* @apiParam (PathVariable) {String(14)} gateway_short_id Requiredgateway short idConsists of 10-14 digits of capital letters or Numbers (generated by the RoyalPay)
*
* @apiParam (JSON) {String(50)} apply_id RequiredRoyalPay Admin account Username
* @apiParam (JSON) {String(4)} parent_partner_code Optionalparent partner codeAfter filling in, it will automatically associate the merchant relationship
* @apiParam (JSON) {String(200)} notify_url OptionalSystem will call the notify url if provided when the merchant audit is complete
* @apiParam (JSON) {JSON} company_info RequiredMain information of merchant company
* @apiParam (JSON) {JSON} contact_info RequiredMerchant contact information
* @apiParam (JSON) {JSON} legal_info RequiredMerchant legal person information
* @apiParam (JSON) {JSON} pay_info RequiredMerchant payment information
* @apiParam (JSON) {JSON} settle_info RequiredMerchant settlement information
* @apiParam (JSON) {JSON} compliance_file_info RequiredMerchant compliance file information
*
* @apiParam (COMPANY_SUB_JSON) {String(100)} company_name RequiredCompany name
* @apiParam (COMPANY_SUB_JSON) {String(50)} short_name RequiredCompany short name
* @apiParam (COMPANY_SUB_JSON) {String(15)} store_name RequiredStore name
* @apiParam (COMPANY_SUB_JSON) {String(100)} business_name OptionalBusiness name
* @apiParam (COMPANY_SUB_JSON) {String(100)=Association,Company,Government body,Partnership,Registered body(Sole Trader),Trust} business_structure RequiredBusiness structure
* @apiParam (COMPANY_SUB_JSON) {String(20)} abn OptionalIf business_structure is not a Company, this is required
* @apiParam (COMPANY_SUB_JSON) {String(9)} acn OptionalIf business_structure is Company, it must be filled in (acn is 9 digits)
* @apiParam (COMPANY_SUB_JSON) {String(15)} company_phone Requiredcompany phone
* @apiParam (COMPANY_SUB_JSON) {String(200)} logo_url RequiredCompany logo url (the image should be uploaded to the server through the file upload api)
*
* @apiParam (CONTACT_SUB_JSON) {String(50)} contact_person RequiredCompany contact person
* @apiParam (CONTACT_SUB_JSON) {String(15)} contact_phone RequiredCompany contact phone
* @apiParam (CONTACT_SUB_JSON) {String(50)} contact_email RequiredCompany contact email
* @apiParam (CONTACT_SUB_JSON) {String(50)} contact_job RequiredCompany contact person job
* @apiParam (CONTACT_SUB_JSON) {String(200)} address Requiredaddress
* @apiParam (CONTACT_SUB_JSON) {String(50)} suburb Requiredsuburb
* @apiParam (CONTACT_SUB_JSON) {String(10)} postcode Requiredpostcode
* @apiParam (CONTACT_SUB_JSON) {String(20)=ACT,NSW,NT,QLD,SA,TAS,VIC,WA,OTHER} state Requiredstate
* @apiParam (CONTACT_SUB_JSON) {String(20)} country=AUS Requiredcountry
* @apiParam (CONTACT_SUB_JSON) {String(200)} registered_address RequiredCompany registered address(It could be the same address)
* @apiParam (CONTACT_SUB_JSON) {String(50)} registered_suburb RequiredCompany registered suburb(It could be the same suburb)
* @apiParam (CONTACT_SUB_JSON) {String(10)} registered_postcode RequiredCompany registered postcode(It could be the same postcode)
* @apiParam (CONTACT_SUB_JSON) {String(20)=ACT,NSW,NT,QLD,SA,TAS,VIC,WA,OTHER} registered_state RequiredCompany registered state(It could be the same state)
* @apiParam (CONTACT_SUB_JSON) {String(30)=Australia/West,Australia/Eucla,Australia/North,Australia/South,Australia/Brisbane,Australia/Melbourne,Australia/LHI} timezone Requiredtimezone
*
* @apiParam (LEGAL_SUB_JSON) {String(50)} legal_representative_person RequiredCompany legal person(It could be the same contact_person)
* @apiParam (LEGAL_SUB_JSON) {String(15)} legal_representative_phone RequiredCompany legal person phone(It could be the same contact_phone)
* @apiParam (LEGAL_SUB_JSON) {String(50)} legal_representative_email RequiredCompany legal person email(It could be the same contact_email)
* @apiParam (LEGAL_SUB_JSON) {String(50)} legal_representative_job RequiredCompany legal person job(It could be the same contact_job)
*
* @apiParam (PAY_SUB_JSON) {int[]=1,2} client_pay_type RequiredCompany payment scenario(multi-select) example:1,2
* <li>1:The online payment</li>
* <li>2:The offline payment</li>
* @apiParam (PAY_SUB_JSON) {int[]} client_pay_desc RequiredCompany payment description(multi-select) example:101,102,105,202,203,20306
* <li>101:PC Web</li>
* <li>102:Mobile website(H5)</li>
* <li>103:APP</li>
* <li>104:Wechat/Alipay JSAPI</li>
* <li>105:Mini Program</li>
* <li>201:QR Code</li>
* <li>202:RoyalPay POS</li>
* <li>203:Cashier system</li>
* <li>204:Vending machine</li>
* <li>20301:ipos</li>
* <li>20302:pospal</li>
* <li>20303:Lotus</li>
* <li>20304:AoShangBao</li>
* <li>20305:Infinity</li>
* <li>20306:EasyCloud</li>
* <li>20307:Aus Post</li>
* <li>20308:AoMaiKe</li>
* <li>20399:other</li>
* @apiParam (PAY_SUB_JSON) {String(10)} royalpay_industry RequiredRoyalPay industry codeSee industry code comparison table for details<a href="https://file.royalpay.com.au/open/2020/02/10/1581319347677_y7aY7KZ7SUnwCWUab3hImxjAwuM3dQ.xlsx">Industry code comparison table</a>
* @apiParam (PAY_SUB_JSON) {String(10)} wechat_industry RequiredWechat industry codeSee industry code comparison table for details<a href="https://file.royalpay.com.au/open/2020/02/10/1581319347677_y7aY7KZ7SUnwCWUab3hImxjAwuM3dQ.xlsx">Industry code comparison table</a>
* @apiParam (PAY_SUB_JSON) {String(10)} alipay_industry RequiredAlipay industry codeSee industry code comparison table for details<a href="https://file.royalpay.com.au/open/2020/02/10/1581319347677_y7aY7KZ7SUnwCWUab3hImxjAwuM3dQ.xlsx">Industry code comparison table</a>
* @apiParam (PAY_SUB_JSON) {String(200)} company_photo OptionalCompany photo urlIf the company payment scenario is required offline
* @apiParam (PAY_SUB_JSON) {String(200)} store_photo OptionalStore photo urlIf the company payment scenario is required offline
* @apiParam (PAY_SUB_JSON) {String(200)} company_website OptionalCompany websiteIf the company payment scenario is required online
*
* @apiParam (SETTLE_SUB_JSON) {String(12)} swift_code RequiredSwift code
* @apiParam (SETTLE_SUB_JSON) {String(6)} bsb_no RequiredBSB No
* @apiParam (SETTLE_SUB_JSON) {String(100)} bank RequiredBank
* @apiParam (SETTLE_SUB_JSON) {String(30)} city RequiredCity
* @apiParam (SETTLE_SUB_JSON) {String(100)} address RequiredAddress
* @apiParam (SETTLE_SUB_JSON) {String(20)} system RequiredSystem
* @apiParam (SETTLE_SUB_JSON) {String(20)} postcode RequiredPostcode
* @apiParam (SETTLE_SUB_JSON) {String(30)} state RequiredState
* @apiParam (SETTLE_SUB_JSON) {String(100)} branch RequiredBranch
* @apiParam (SETTLE_SUB_JSON) {String(20)} account_no RequiredAccount No
* @apiParam (SETTLE_SUB_JSON) {String(50)} account_name RequiredAccount Name
* @apiParam (SETTLE_SUB_JSON) {int=1,2,3} clean_days RequiredClean dayst+1,t+2,t+3
* @apiParam (SETTLE_SUB_JSON) {Double} wechat_rate RequiredWechat Rate(2=2%,1.5=1.5%)
* @apiParam (SETTLE_SUB_JSON) {Double} alipay_rate RequiredAlipay Rate(2=2%,1.5=1.5%)
* @apiParam (SETTLE_SUB_JSON) {Double} alipay_online_rate RequiredAlipay Online Rate(2=2%,1.5=1.5%)
* @apiParam (SETTLE_SUB_JSON) {Double} transaction_fee=0 RequiredTransaction fee
* @apiParam (SETTLE_SUB_JSON) {Date} active_time RequiredActive Timeformat:'yyyy-mm-dd HH:mm:ss'
* @apiParam (SETTLE_SUB_JSON) {Date} expire_time RequiredExpire Timeformat:'yyyy-mm-dd HH:mm:ss'
*
* @apiParam (COMPLIANCE_SUB_JSON) {String(200)} id_file RequiredID file of company leader, upload driver's license or passport, recommend uploading ID file of direct beneficiary of the company, if you provide ID file of other company leader, please describe the reason (the file should be uploaded to the server through file upload api)
* @apiParam (COMPLIANCE_SUB_JSON) {String=passport,driver_license} id_type RequiredType of id file to upload
* <li>passport:Passport</li>
* <li>driver_license:Driver License</li>
* @apiParam (COMPLIANCE_SUB_JSON) {String='Ultimate beneficiary owner','CEO','Director','General Manager','Other'} id_title RequiredId file person's position
* @apiParam (COMPLIANCE_SUB_JSON) {String(200)} id_title_description OptionalThe reason for not providing the ID file of the direct beneficiary of the company
* @apiParam (COMPLIANCE_SUB_JSON) {String(200)} bank_statement RequiredBank statement file url(files need to be uploaded to the server using file upload api)
* @apiParam (COMPLIANCE_SUB_JSON) {String(200)} certificate_of_registration RequiredCompany registration file url(files need to be uploaded to the server using file upload api)
* @apiParam (COMPLIANCE_SUB_JSON) {String(200)} utility_bill OptionalCompany utility bill file url(files need to be uploaded to the server using file upload api)
*
* @apiSuccess {JSON} data Returns the parameter
* @apiSuccess {String} sign Returns the signature
*
* @apiSuccess (SUB_JSON) {String} partner_code Partner code
* @apiSuccess (SUB_JSON) {String='PASS','PROCESSING','REFUSED'} partner_status Merchant audit statusPASS,PROCESSING,REFUSED
* @apiSuccess (SUB_JSON) {String} company_name Company name
* @apiSuccess (SUB_JSON) {String} credential_code Credential code
* @apiSuccess (SUB_JSON) {String} short_name Company Short name
* @apiSuccess (SUB_JSON) {String} sign_type=RSA2 Signature encryption
* @apiSuccess (SUB_JSON) {String} nonce_str nonce string
* @apiSuccess (SUB_JSON) {String} url api url
*
* @apiError (ERROR) return_code Error Code
* @apiError (ERROR) return_msg Error Description
* @apiUse MerchantError
* @apiError (ERROR_CODE) PARAM_INVALID Parameters are invalid. See return_msg for more details.
*
*/
/**
* @api {GET} /api/v1.0/gateway/partners/{gateway_short_id}/merchant/{partner_code}/status Merchant status query
* @apiName query_merchant
* @apiDescription
* Inquire merchant audit status and merchant brief information. Signature details<a href="https://file.royalpay.com.au/open/2020/02/10/1581317569835_qgvzSc4a3dHX8RP5HZITN9K7fUsGtj.pdf" target="_blank">Merchant signature documentation</a>
*
* @apiVersion 1.0.0
* @apiGroup Merchant
* @apiHeader Accept multipart/form-data
* @apiHeader Content-Type multipart/form-data
* @apiParam (PathVariable) {String(14)} gateway_short_id Requiredgateway short idConsists of 10-14 digits of capital letters or Numbers (generated by the RoyalPay)
*
* @apiSuccess {JSON} data Returns the parameter
* @apiSuccess {String} sign Returns the signature
*
* @apiSuccess (SUB_JSON) {String} partner_code Partner code
* @apiSuccess (SUB_JSON) {String='PASS','PROCESSING','REFUSED'} partner_status Merchant audit statusPASS,PROCESSING,REFUSED
* @apiSuccess (SUB_JSON) {String} company_name Company name
* @apiSuccess (SUB_JSON) {String} credential_code Credential code
* @apiSuccess (SUB_JSON) {String} short_name Short name
* @apiSuccess (SUB_JSON) {String} sign_type=RSA2 Signature encryption
* @apiSuccess (SUB_JSON) {String} nonce_str nonce string
* @apiSuccess (SUB_JSON) {String} url api url
*
* @apiError (ERROR) return_code Error Code
* @apiError (ERROR) return_msg Error Description
* @apiUse MerchantError
* @apiError (ERROR_CODE) INVALID_SHORT_ID Partner code is invalid or there is no partner associated with this code
*
*/
/**
* @api {POST} /api/v1.0/gateway/partners/{gateway_short_id}/attachment/files Upload pictures and files
* @apiName update_file
* @apiDescription
* Upload picture and file api, which can be used to upload merchant logo, company photo, store photo and bank file. If the picture is too large, it is suggested to upload after compressionSignature details<a href="https://file.royalpay.com.au/open/2020/02/10/1581317569835_qgvzSc4a3dHX8RP5HZITN9K7fUsGtj.pdf" target="_blank">Merchant signature documentation</a>
*
* @apiVersion 1.0.0
* @apiGroup Merchant
* @apiHeader Accept application/json
* @apiHeader Content-Type application/json
* @apiParam (PathVariable) {String(14)} gateway_short_id Requiredgateway short idConsists of 10-14 digits of capital letters or Numbers (generated by the RoyalPay)
*
* @apiParam (BINARY) {binary} file File data stream
*
* @apiSuccess {JSON} data Returns the parameter
* @apiSuccess {String} sign Returns the signature
*
* @apiSuccess (SUB_JSON) {String} file_type File type
* @apiSuccess (SUB_JSON) {String} file_url File url
* @apiSuccess (SUB_JSON) {String} original_filename Original file name
* @apiSuccess (SUB_JSON) {String} sign_type=RSA2 Signature encryption
* @apiSuccess (SUB_JSON) {String} nonce_str nonce string
* @apiSuccess (SUB_JSON) {String} url api url
*
* @apiError (ERROR) return_code Error Code
* @apiError (ERROR) return_msg Error Description
* @apiUse MerchantError
*
*/
/**
* @api {POST} /notify_url Notification of merchant audit status
* @apiName merchant_notice
* @apiGroup Merchant
* @apiVersion 1.0.0
* @apiDescription
* If notify_url is provided when the merchant audit status is complete. System will post request to this url when the merchant audit status is complete. Request method is POST.
* Different from Server APIs, sign parameters will be included in json entity. Partner system shall valid them to prevent fake requests.
* @apiHeader Accept application/json
* @apiHeader Content-Type application/json
* @apiSuccess {JSON} data Returns the parameter
* @apiSuccess {String} sign Returns the signature
*
* @apiSuccess (SUB_JSON) {String} partner_code Partner code
* @apiSuccess (SUB_JSON) {String='PASS','PROCESSING','REFUSED'} partner_status Merchant audit statusPASS,PROCESSING,REFUSED
* @apiSuccess (SUB_JSON) {String} company_name Company name
* @apiSuccess (SUB_JSON) {String} credential_code Credential code
* @apiSuccess (SUB_JSON) {String} short_name Company short name
* @apiSuccess (SUB_JSON) {String} sign_type=RSA2 Signature encryption
* @apiSuccess (SUB_JSON) {String} nonce_str nonce string
* @apiSuccess (SUB_JSON) {String} url notify_url
*
* @apiSuccess {String} return_code SUCCESS
*/
function apis() {
}

Loading…
Cancel
Save