From 934ae97579957a74198f83df0f73bc6fcedf9303 Mon Sep 17 00:00:00 2001 From: luoyang Date: Mon, 10 Feb 2020 17:22:12 +0800 Subject: [PATCH] =?UTF-8?q?fix=20revert=20api=20doc=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/document/cn/apis.js | 212 ---------------------------------------- src/document/en/apis.js | 211 --------------------------------------- 2 files changed, 423 deletions(-) diff --git a/src/document/cn/apis.js b/src/document/cn/apis.js index 2dcd8697f..6d2d28a08 100644 --- a/src/document/cn/apis.js +++ b/src/document/cn/apis.js @@ -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 - * 提交商户信息进件接口。签名详细说明：商户进件签名说明文档 - * - * @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 - *
  • 1:线上支付
    • - *
  • 2:线下支付
    • - * @apiParam (PAY_SUB_JSON) {int[]} client_pay_desc 必填，公司支付场景描述(可多选) 例:101,102,105,202,203,20306 - *
  • 101:PC网站
    • - *
  • 102:手机端网站
    • - *
  • 103:APP
    • - *
  • 104:微信内、支付宝内网站
    • - *
  • 105:小程序
    • - *
  • 201:二维码立牌
    • - *
  • 202:RoyalPay POS
    • - *
  • 203:收银系统
    • - *
  • 204:无人售货机
    • - *
  • 20301:ipos
    • - *
  • 20302:pospal
    • - *
  • 20303:Lotus
    • - *
  • 20304:AoShangBao
    • - *
  • 20305:Infinity
    • - *
  • 20306:EasyCloud
    • - *
  • 20307:Aus Post
    • - *
  • 20308:AoMaiKe
    • - *
  • 20399:其他
    • - * @apiParam (PAY_SUB_JSON) {String(10)} royalpay_industry 必填，RoyalPay行业编码，详情见行业编码对照表：行业编码对照表 - * @apiParam (PAY_SUB_JSON) {String(10)} wechat_industry 必填，微信行业编码，详情见行业编码对照表：行业编码对照表 - * @apiParam (PAY_SUB_JSON) {String(10)} alipay_industry 必填，支付宝行业编码，详情见行业编码对照表：行业编码对照表 - * @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文件的类型 - *
  • passport:护照
    • - *
  • driver_license:驾照
    • - * @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 - * 查询商户审核状态及商户简要信息。签名详细说明：商户进件签名说明文档 - * - * @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、公司照片、店铺照片、银行文件。如图片过大建议压缩后上传，签名详细说明：商户进件签名说明文档 - * - * @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() { } diff --git a/src/document/en/apis.js b/src/document/en/apis.js index 52613f5f6..ed523570b 100644 --- a/src/document/en/apis.js +++ b/src/document/en/apis.js @@ -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 information。Signature details：Merchant signature documentation - * - * @apiVersion 1.0.0 - * @apiGroup Merchant - * @apiHeader Accept application/json - * @apiHeader Content-Type application/json - * @apiParam (PathVariable) {String(14)} gateway_short_id Required，gateway short id，Consists of 10-14 digits of capital letters or Numbers (generated by the RoyalPay) - * - * @apiParam (JSON) {String(50)} apply_id Required，RoyalPay Admin account Username - * @apiParam (JSON) {String(4)} parent_partner_code Optional，parent partner code，After filling in, it will automatically associate the merchant relationship - * @apiParam (JSON) {String(200)} notify_url Optional，System will call the notify url if provided when the merchant audit is complete - * @apiParam (JSON) {JSON} company_info Required，Main information of merchant company - * @apiParam (JSON) {JSON} contact_info Required，Merchant contact information - * @apiParam (JSON) {JSON} legal_info Required，Merchant legal person information - * @apiParam (JSON) {JSON} pay_info Required，Merchant payment information - * @apiParam (JSON) {JSON} settle_info Required，Merchant settlement information - * @apiParam (JSON) {JSON} compliance_file_info Required，Merchant compliance file information - * - * @apiParam (COMPANY_SUB_JSON) {String(100)} company_name Required，Company name - * @apiParam (COMPANY_SUB_JSON) {String(50)} short_name Required，Company short name - * @apiParam (COMPANY_SUB_JSON) {String(15)} store_name Required，Store name - * @apiParam (COMPANY_SUB_JSON) {String(100)} business_name Optional，Business name - * @apiParam (COMPANY_SUB_JSON) {String(100)=Association,Company,Government body,Partnership,Registered body(Sole Trader),Trust} business_structure Required，Business structure - * @apiParam (COMPANY_SUB_JSON) {String(20)} abn Optional，If business_structure is not a Company, this is required - * @apiParam (COMPANY_SUB_JSON) {String(9)} acn Optional，If business_structure is Company, it must be filled in (acn is 9 digits) - * @apiParam (COMPANY_SUB_JSON) {String(15)} company_phone Required，company phone - * @apiParam (COMPANY_SUB_JSON) {String(200)} logo_url Required，Company logo url (the image should be uploaded to the server through the file upload api) - * - * @apiParam (CONTACT_SUB_JSON) {String(50)} contact_person Required，Company contact person - * @apiParam (CONTACT_SUB_JSON) {String(15)} contact_phone Required，Company contact phone - * @apiParam (CONTACT_SUB_JSON) {String(50)} contact_email Required，Company contact email - * @apiParam (CONTACT_SUB_JSON) {String(50)} contact_job Required，Company contact person job - * @apiParam (CONTACT_SUB_JSON) {String(200)} address Required，address - * @apiParam (CONTACT_SUB_JSON) {String(50)} suburb Required，suburb - * @apiParam (CONTACT_SUB_JSON) {String(10)} postcode Required，postcode - * @apiParam (CONTACT_SUB_JSON) {String(20)=ACT,NSW,NT,QLD,SA,TAS,VIC,WA,OTHER} state Required，state - * @apiParam (CONTACT_SUB_JSON) {String(20)} country=AUS Required，country - * @apiParam (CONTACT_SUB_JSON) {String(200)} registered_address Required，Company registered address(It could be the same address) - * @apiParam (CONTACT_SUB_JSON) {String(50)} registered_suburb Required，Company registered suburb(It could be the same suburb) - * @apiParam (CONTACT_SUB_JSON) {String(10)} registered_postcode Required，Company 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 Required，Company 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 Required，timezone - * - * @apiParam (LEGAL_SUB_JSON) {String(50)} legal_representative_person Required，Company legal person(It could be the same contact_person) - * @apiParam (LEGAL_SUB_JSON) {String(15)} legal_representative_phone Required，Company legal person phone(It could be the same contact_phone) - * @apiParam (LEGAL_SUB_JSON) {String(50)} legal_representative_email Required，Company legal person email(It could be the same contact_email) - * @apiParam (LEGAL_SUB_JSON) {String(50)} legal_representative_job Required，Company legal person job(It could be the same contact_job) - * - * @apiParam (PAY_SUB_JSON) {int[]=1,2} client_pay_type Required，Company payment scenario(multi-select) example:1,2 - *
  • 1:The online payment
    • - *
  • 2:The offline payment
    • - * @apiParam (PAY_SUB_JSON) {int[]} client_pay_desc Required，Company payment description(multi-select) example:101,102,105,202,203,20306 - *
  • 101:PC Web
    • - *
  • 102:Mobile website(H5)
    • - *
  • 103:APP
    • - *
  • 104:Wechat/Alipay JSAPI
    • - *
  • 105:Mini Program
    • - *
  • 201:QR Code
    • - *
  • 202:RoyalPay POS
    • - *
  • 203:Cashier system
    • - *
  • 204:Vending machine
    • - *
  • 20301:ipos
    • - *
  • 20302:pospal
    • - *
  • 20303:Lotus
    • - *
  • 20304:AoShangBao
    • - *
  • 20305:Infinity
    • - *
  • 20306:EasyCloud
    • - *
  • 20307:Aus Post
    • - *
  • 20308:AoMaiKe
    • - *
  • 20399:other
    • - * @apiParam (PAY_SUB_JSON) {String(10)} royalpay_industry Required，RoyalPay industry code，See industry code comparison table for details：Industry code comparison table - * @apiParam (PAY_SUB_JSON) {String(10)} wechat_industry Required，Wechat industry code，See industry code comparison table for details：Industry code comparison table - * @apiParam (PAY_SUB_JSON) {String(10)} alipay_industry Required，Alipay industry code，See industry code comparison table for details：Industry code comparison table - * @apiParam (PAY_SUB_JSON) {String(200)} company_photo Optional，Company photo url，If the company payment scenario is required offline - * @apiParam (PAY_SUB_JSON) {String(200)} store_photo Optional，Store photo url，If the company payment scenario is required offline - * @apiParam (PAY_SUB_JSON) {String(200)} company_website Optional，Company website，If the company payment scenario is required online - * - * @apiParam (SETTLE_SUB_JSON) {String(12)} swift_code Required，Swift code - * @apiParam (SETTLE_SUB_JSON) {String(6)} bsb_no Required，BSB No - * @apiParam (SETTLE_SUB_JSON) {String(100)} bank Required，Bank - * @apiParam (SETTLE_SUB_JSON) {String(30)} city Required，City - * @apiParam (SETTLE_SUB_JSON) {String(100)} address Required，Address - * @apiParam (SETTLE_SUB_JSON) {String(20)} system Required，System - * @apiParam (SETTLE_SUB_JSON) {String(20)} postcode Required，Postcode - * @apiParam (SETTLE_SUB_JSON) {String(30)} state Required，State - * @apiParam (SETTLE_SUB_JSON) {String(100)} branch Required，Branch - * @apiParam (SETTLE_SUB_JSON) {String(20)} account_no Required，Account No - * @apiParam (SETTLE_SUB_JSON) {String(50)} account_name Required，Account Name - * @apiParam (SETTLE_SUB_JSON) {int=1,2,3} clean_days Required，Clean days：t+1,t+2,t+3 - * @apiParam (SETTLE_SUB_JSON) {Double} wechat_rate Required，Wechat Rate(2=2%,1.5=1.5%) - * @apiParam (SETTLE_SUB_JSON) {Double} alipay_rate Required，Alipay Rate(2=2%,1.5=1.5%) - * @apiParam (SETTLE_SUB_JSON) {Double} alipay_online_rate Required，Alipay Online Rate(2=2%,1.5=1.5%) - * @apiParam (SETTLE_SUB_JSON) {Double} transaction_fee=0 Required，Transaction fee - * @apiParam (SETTLE_SUB_JSON) {Date} active_time Required，Active Time，format:'yyyy-mm-dd HH:mm:ss' - * @apiParam (SETTLE_SUB_JSON) {Date} expire_time Required，Expire Time，format:'yyyy-mm-dd HH:mm:ss' - * - * @apiParam (COMPLIANCE_SUB_JSON) {String(200)} id_file Required，ID 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 Required，Type of id file to upload - *
  • passport:Passport
    • - *
  • driver_license:Driver License
    • - * @apiParam (COMPLIANCE_SUB_JSON) {String='Ultimate beneficiary owner','CEO','Director','General Manager','Other'} id_title Required，Id file person's position - * @apiParam (COMPLIANCE_SUB_JSON) {String(200)} id_title_description Optional，The reason for not providing the ID file of the direct beneficiary of the company - * @apiParam (COMPLIANCE_SUB_JSON) {String(200)} bank_statement Required，Bank statement file url(files need to be uploaded to the server using file upload api) - * @apiParam (COMPLIANCE_SUB_JSON) {String(200)} certificate_of_registration Required，Company registration file url(files need to be uploaded to the server using file upload api) - * @apiParam (COMPLIANCE_SUB_JSON) {String(200)} utility_bill Optional，Company 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 status：PASS,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：Merchant signature documentation - * - * @apiVersion 1.0.0 - * @apiGroup Merchant - * @apiHeader Accept multipart/form-data - * @apiHeader Content-Type multipart/form-data - * @apiParam (PathVariable) {String(14)} gateway_short_id Required，gateway short id，Consists 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 status：PASS,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 compression，Signature details：Merchant signature documentation - * - * @apiVersion 1.0.0 - * @apiGroup Merchant - * @apiHeader Accept application/json - * @apiHeader Content-Type application/json - * @apiParam (PathVariable) {String(14)} gateway_short_id Required，gateway short id，Consists 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 status：PASS,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() { }