自助绑定api

自助绑定

请求参数类型JSON

返回参数类型JSON

boolean isSuccess 是否成功
String msg 响应信息
JSON\JSON数组 data 成功时返回数据

1. 商户基本信息

HINTS

商户属性
CORPORATION、PARTNERSHIP、SOLEPROPRIETORSHIP、PROFESSIONALASSOC、TAXEXEMPTORG、LLC、OTHER

商户类型
INDIVIDUALACCOUNT、COMPANYACCOUNT、GROUP

商户所在城市时区
ETC_GMT_12,US_SAMOA,HST,PACIFIC_MARQUESAS,AST,PST,MST,CST,EST,AMERICA_CARACAS,PRT,CNT,AGT,BET,ETC_GMT_2,AMERICA_SCORESBYSUND,ETC_GREENWICH,UTC,WET,AFRICA_BANGUI,CET,ART,CAT,ISRAEL,EAT,ETC_GMT_3,ASIA_RIYADH87,IRAN,ETC_GMT_4,W_SU,ASIA_KABUL,PLT,IST,ASIA_KATMANDU,ETC_GMT_6,ASIA_RANGOON,INDIAN_COCOS,ETC_GM_7,VST,CTT,AUSTRALIA_RUCLA,JST,ROK,ACT,AET,ETC_GMT_10,AUSTRALIA_LHI,SST,PACIFIC_NORFOLK,NST,NZ_CHAT,MIT,ETC_GMT_14,PACIFIC_KIRITIMATI

行业
Internet / eCommerce
Electronic
Automotive
Education & school
Tourism & travel
Beauty & Health Care
Restaurants & Food
Retail
Jewelry
Baby products & toys
Entertainment , music & games
Sports & outdoors
Fashion
Professional Services
Business Services
Government Services
Other

1.1 商户基本信息保存：

Request URL

POST /merchant/info/save

Request parameter

private String name; // 商户名称
private String website; // 商户网站
private String industry; // 行业
private String abbreviation; // 商户业务名称
private enum merchantProperty; // 商户属性
private enum merchantType; // 商户类型
private String mcc; // MCC
private String federalID; // 税务识别号
private String branchId; // 分公司ID
private String salesId; // 销售ID
private String agentId; // 代理ID
private String pspId; // pspID
private String timeZone; // 商户所在城市时区
private String countryName; // 商户所在国家名称
private String countryCode; // 商户所在国家代码
private String stateName; // 商户所在省份名称
private String stateCode; // 商户所在省份代码
private String cityName; // 商户所在城市名称
private String cityCode; // 商户所在城市代码
private String streetName1; // 商户所在地详细地址
private String streetName2; // 商户所在地备用详细地址
private String effectiveDate; // 合同开始时间(yyyy-MM-dd)
private String terminateDate; // 合同结束时间(yyyy-MM-dd)
private String contactPerson; // 联系人
private String contactPhone; // 联系人电话
private String contactEmail; // 联系人电子邮箱
private String comments; // 商户备注信息

Response parameter

private String merchantCode; // 商户号

1.2 根据商户号查询基本信息：

Request URL

GET /merchant/info/retrieve/{merchantCode}

Request parameter

无

Response parameter（JSON）

1.3 修改商户基本信息：

Request URL

POST /merchant/info/update/{merchantCode}

Request parameter

private String name; // 商户名称
private String website; // 商户网站
private String industry; // 行业
private String abbreviation; // 商户业务名称
private enum merchantProperty; // 商户属性
private enum merchantType; // 商户类型
private String mcc; // MCC
private String federalID; // 税务识别号
private String branchId; // 分公司ID
private String salesId; // 销售ID
private String agentId; // 代理ID
private String pspId; // pspID
private String timeZone; // 商户所在城市时区
private String countryName; // 商户所在国家名称
private String countryCode; // 商户所在国家代码
private String stateName; // 商户所在省份名称
private String stateCode; // 商户所在省份代码
private String cityName; // 商户所在城市名称
private String cityCode; // 商户所在城市代码
private String streetName1; // 商户所在地详细地址
private String streetName2; // 商户所在地备用详细地址
private String effectiveDate; // 合同开始时间(yyyy-MM-dd)
private String terminateDate; // 合同结束时间(yyyy-MM-dd)
private String contactPerson; // 联系人
private String contactPhone; // 联系人电话
private String contactEmail; // 联系人电子邮箱
private String comments; // 商户备注信息

Response parameter（JSON）

2. 产品开通

2.1 产品开通

HINTS

产品类型

UP_EBANK_PAY, UP_EXPRESS_PAY, OFFLINE_QRCODE, OFFLINE_POS

卡组织

UNIONPAY, ALIPAY, WECHAT

币种
USD, JPY, EUR, GBP, CAD, HKD

Request URL

POST /product/open

Request parameter

private String merCode; //
private String products; //json [{"productName":"UP_EBANK_PAY", "settleCycle":"3", "cardOrgs",:"UNIONPAY, WECHAT", "currencys":"JPY,USD"}, {"productName":"UP_EXPRESS_PAY", "settleCycle", "2"}] 

private String refundReturn; //INACTIVE,ACTIVE
private String easyPay; //INACTIVE,ACTIVE
private String subscribe; //INACTIVE,ACTIVE
private String batchPayment; //INACTIVE,ACTIVE
private String offlineTopUp; //INACTIVE,ACTIVE
private String withdrawal; //INACTIVE,ACTIVE

Response parameter

isSuccess true/false
msg --

Example

{
    "merCode":"M001100310",
    "products":"[{'productName':'UP_EBANK_PAY', 'settleCycle':3, 'cardOrgs':'UNIONPAY,WECHAT', 'currencys':'JPY,USD'}]",
    "refundReturn":"INACTIVE",
    "easyPay":"INACTIVE",
    "subscribe":"INACTIVE",
    "batchPayment":"INACTIVE",
    "offlineTopUp":"INACTIVE",
    "withdrawal":"INACTIVE"
}

2.2 根据MerCode获取已开通产品信息

Request URL

GET /product/query/{merCode}

Request parameter

无

Response parameter（JSON数组）

Response

{
    "merCode": "M001100318",
    "products": 
    "[{\"currencys\":\"JPY,USD\",\"settleCycle\":\"3\",\"productName\":\"OFFLINE_QRCODE\",\"cardOrgs\":\"WECHAT\"},
    {\"currencys\":\"JPY,USD\",\"settleCycle\":\"3\",\"productName\":\"UP_EBANK_PAY\",\"cardOrgs\":\"WECHAT,UNIONPAY\"}]",
    "refundReturn": "INACTIVE",
    "easyPay": "INACTIVE",
    "subscribe": "INACTIVE",
    "batchPayment": "INACTIVE",
    "offlineTopUp": "INACTIVE",
    "withdrawal": "INACTIVE"
}

2.3 更新产品

Request URL

POST /product/update

Request parameter

private String merCode; //
private String products; //json [{'productName':'OFFLINE_QRCODE', 'settleCycle':3, 'cardOrgs':'WECHAT', 'currencys':'JPY,USD'},{'productName':'UP_EBANK_PAY', 'settleCycle':3, 'cardOrgs':'WECHAT,UNIONPAY', 'currencys':'JPY,USD'}]

private String refundReturn; //INACTIVE,ACTIVE
private String easyPay; //INACTIVE,ACTIVE
private String subscribe; //INACTIVE,ACTIVE
private String batchPayment; //INACTIVE,ACTIVE
private String offlineTopUp; //INACTIVE,ACTIVE
private String withdrawal; //INACTIVE,ACTIVE

Response parameter

isSuccess true/false
msg --

Example

{
    "merCode":"M001100318",
    "products":"[{'productName':'OFFLINE_QRCODE', 'settleCycle':3, 'cardOrgs':'WECHAT', 'currencys':'JPY,USD'},{'productName':'UP_EBANK_PAY', 'settleCycle':3, 'cardOrgs':'WECHAT,UNIONPAY', 'currencys':'JPY,USD'}]",
    "refundReturn":"INACTIVE",
    "easyPay":"INACTIVE",
    "subscribe":"INACTIVE",
    "batchPayment":"INACTIVE",
    "offlineTopUp":"INACTIVE",
    "withdrawal":"INACTIVE"
}

3. 设置费率

3.1 设置费率

HINTS

RateAlgorithmEnum

PERCENTAGE,FIXED_AMOUNT,PERCENTAGE_PLUS_FIXED_AMOUNT,STEPPED

传PERCENTAGE就可以

Request URL

POST /rate/save

Request parameter

private String merCode;
private String productName; 
private String cardOrg; 
private String currency;
private String txnType;
private String rateAlgorithm; 
private BigDecimal percentage; 2% 传2就可以
private BigDecimal fixedAmount; 0
private BigDecimal minAmount; 0
private BigDecimal maxAmount; 0

Response parameter

isSuccess true/false
msg --

Example

{
    "merCode":"M001100310",
    "productName":"UP_EBANK_PAY", 
    "cardOrg":"WECHAT",
    "currency":"USD",
    "txnType":"PURCHASE",
    "rateAlgorithm":"PERCENTAGE",
    "percentage":"2.9",
    "fixedAmount":"0",
    "minAmount":"0",
    "maxAmount":"0"
}

3.2 根据MerCode获取费率

Request URL

GET /rate/query/{merCode}

Request parameter

无

Response parameter（JSON数组）

Response

[
   {
        "merCode": "M001100318",
        "productName": "OFFLINE_QRCODE",
        "cardOrg": "WECHAT",
        "currency": "USD",
        "rateAlgorithm": "PERCENTAGE",
        "txnType": "PURCHASE",
        "percentage": 3,
        "fixedAmount": 0,
        "minAmount": 0,
        "maxAmount": 0,
        "id": "694efc64ad87423ab7c76803373a44f0"
    }
]

3.3 根据ID删除费率

Request URL

GET /rate/del/{id}

Request parameter

无

Response parameter

isSuccess true/false
msg --

4. 提现设置

4.1 提现设置

Request URL

POST /withdrawal/setting

Request parameter

private String merCode;
private String withdrawalWay; -- AMOUNT,MANUAL,EXPRESSION;
private BigDecimal reserveAmount;
private String cycleDesc;
private String feePayer; -- MERCHANT, NIHAOPAY, AGENT;

Response parameter

isSuccess true/false
msg --

4.2 查询提现设置

HINTS

周期提现表达式
每周两次：W2T1D
每周一次：W1T3D
每月两次：M2T15D
每月一次：M1T15D

Request URL

GET /withdrawal/query/{merCode}

Request parameter

无

Response parameter

{
    "merCode": "M001100318",
    "withdrawalWay": "AMOUNT",
    "reserveAmount": "0",
    "cycleDesc": null,
    "feePayer": "MERCHANT"
}

4.3 更新提现设置

Request URL

POST /withdrawal/update

Request parameter

private String merCode;
private String withdrawalWay; -- AMOUNT,MANUAL,EXPRESSION;
private BigDecimal reserveAmount;
private String cycleDesc;
private String feePayer; -- MERCHANT, NIHAOPAY, AGENT;

Response parameter

isSuccess true/false
msg --

5. 提现账户

5.1 添加提现账户

Request URL

POST /bank/account/save

Request parameter

private String countryName;
private String countryCode;
private String stateName;
private String stateCode;
private String cityName;
private String cityCode;
private String zipCode;
private String streetName1;
private String fullName;
private String phoneNumber;
private BigDecimal minAmount;
private BigDecimal withdrawalFee;
private String withdrawalFeeCurrency;


private String merCode;
private String bankCode;
private String bankName;
private String bankBranch;
private AccountTypeEnum accountType; -- INDIVIDUALACCOUNT,COMPANYACCOUNT,GROUP;
private String accountHolder;
private String accountNumber;
private String swiftCode;
private String routingNumber;
private String accountCurrency;

Response parameter

isSuccess true/false
msg --

Example

{
    "countryName":"China",
    "countryCode":"086",
    "stateName":"Beijing",
    "stateCode":"11",
    "cityName":"Chaoyang",
    "cityCode":"5",
    "zipCode":null,
    "streetName1":"详细地址",
    "fullName":"ZhangXueYou",
    "phoneNumber":"08613888888888",
    "merCode":"M001100310",
    "bankCode":"000",
    "bankName":"中国银行",
    "bankBranch":null,
    "accountType":"COMPANYACCOUNT",
    "accountHolder":"ZhangXueYou",
    "accountNumber":"888888888",
    "swiftCode":"7668",
    "routingNumber":"123456789",
    "accountCurrency":"USD",
    "minAmount":"1000",
    "withdrawalFee":"0.01",
    "withdrawalFeeCurrency":"USD"
}

5.2 查询所有账户：

Request URL

GET /bank/account/query/{merCode}

Request parameter

无

Response parameter（JSON）

[
    {
        "countryName":"China",
        "countryCode":"086",
        "stateName":"Beijing",
        "stateCode":"11",
        "cityName":"Chaoyang",
        "cityCode":"5",
        "zipCode":null,
        "streetName1":"详细地址",
        "fullName":"ZhangXueYou",
        "phoneNumber":"08613888888888",
        "merCode":"M001100310",
        "bankCode":"000",
        "bankName":"中国银行",
        "bankBranch":null,
        "accountType":"COMPANYACCOUNT",
        "accountHolder":"ZhangXueYou",
        "accountNumber":"888888888",
        "swiftCode":"7668",
        "routingNumber":"123456789",
        "accountCurrency":"USD",
        "minAmount":"1000",
        "withdrawalFee":"0.01",
        "withdrawalFeeCurrency":"USD",
        "id":"076322001f10499c84cdf171bb0ad074"
    },
    {
        "countryName":"China",
        "countryCode":"086",
        "stateName":"Beijing",
        "stateCode":"11",
        "cityName":"Chaoyang",
        "cityCode":"5",
        "zipCode":null,
        "streetName1":"详细地址",
        "fullName":"ZhangXueYou",
        "phoneNumber":"08613888888888",
        "merCode":"M001100310",
        "bankCode":"000",
        "bankName":"中国银行",
        "bankBranch":null,
        "accountType":"COMPANYACCOUNT",
        "accountHolder":"ZhangXueYou",
        "accountNumber":"888888888",
        "swiftCode":"7668",
        "routingNumber":"123456789",
        "accountCurrency":"JPY",
        "minAmount":"1000",
        "withdrawalFee":"0.01",
        "withdrawalFeeCurrency":"JPY",
        "id":"076322001f10499c84cdf171bb0ad075"
    }
]

5.3 查询账户详细：

Request URL

GET /bank/account/{id}

Request parameter

无

Response parameter（JSON）

    {
        "countryName":"China",
        "countryCode":"086",
        "stateName":"Beijing",
        "stateCode":"11",
        "cityName":"Chaoyang",
        "cityCode":"5",
        "zipCode":null,
        "streetName1":"详细地址",
        "fullName":"ZhangXueYou",
        "phoneNumber":"08613888888888",
        "merCode":"M001100310",
        "bankCode":"000",
        "bankName":"中国银行",
        "bankBranch":null,
        "accountType":"COMPANYACCOUNT",
        "accountHolder":"ZhangXueYou",
        "accountNumber":"888888888",
        "swiftCode":"7668",
        "routingNumber":"123456789",
        "accountCurrency":"JPY",
        "minAmount":"1000",
        "withdrawalFee":"0.01",
        "withdrawalFeeCurrency":"JPY",
        "id":"076322001f10499c84cdf171bb0ad075"
    }

5.4 更新账户：

Request URL

POST /bank/account/update/{id}

Request parameter

private String countryName;
private String countryCode;
private String stateName;
private String stateCode;
private String cityName;
private String cityCode;
private String zipCode;
private String streetName1;
private String fullName;
private String phoneNumber;
private BigDecimal minAmount;
private BigDecimal withdrawalFee;
private String withdrawalFeeCurrency;

private String merCode;
private String bankCode;
private String bankName;
private String bankBranch;
private AccountTypeEnum accountType; -- INDIVIDUALACCOUNT,COMPANYACCOUNT,GROUP;
private String accountHolder;
private String accountNumber;
private String swiftCode;
private String routingNumber;

private String accountCurrency;

Response parameter

isSuccess true/false
msg --

6.MCC

6.1 获取全部：

Request URL

GET /mcc/retrieveAll

Request parameter

无

Response parameter（JSON数组）

String code 编码
String name 名称
String i18n 国际化文件中对应的属性

7.Branch

7.1 获取全部：

Request URL

GET /branch/retrieveAll

Request parameter

无

Response parameter（JSON数组）

String branchName 分公司名称
String id 分公司ID

7.2 根据id查询：

Request URL

GET /branch/retrieve/{id}

Request parameter

无

Response parameter（JSON）

String branchName 分公司名称
String id 分公司ID

8.Sale

8.1 获取全部：

Request URL

GET /sale/retrieveAll

Request parameter

无

Response parameter（JSON数组）

String id ID
String saleName sale名称
String branchId 对应branch ID
String branchName 对应branch name
String rateConfigId 对应费率ID
String comments 备注
String userId

8.2 根据ID查询：

Request URL

GET /sale/retrieve/{ID}

Request parameter

无

Response parameter（JSON）

8.3 根据BranchID查询：

Request URL

GET /sale/retrieveByBranch/{branchId}

Request parameter

无

Response parameter（JSON数组）

9.Agent

9.1 获取全部：

Request URL

GET /agent/retrieveAll

Request parameter

无

Response parameter（JSON数组）

String id ID
String agentName agent名称
String agentType agent类型（NORMAL、PLATFORM）
String saleId 对应sale ID
String saleName sale名称
String branchId 对应branch ID
String branchName 对应branch name
String rateConfigId 对应费率ID
String comments 备注
String userId

9.2 根据ID查询：

Request URL

GET /agent/retrieve/{ID}

Request parameter

无

Response parameter（JSON）

9.3 根据BranchID查询：

Request URL

GET /agent/retrieveByBranch/{branchId}

Request parameter

无

Response parameter（JSON数组）

9.4 根据SaleID查询：

Request URL

GET /agent/retrieveBySale/{saleId}

Request parameter

无

Response parameter（JSON数组）

9.5 根据SaleID查询一级代理：

Request URL

GET /agent/retrievePrimaryBySale/{saleId}

Request parameter

无

Response parameter（JSON数组）

9.6 根据一级代理ID查询二级代理：

Request URL

GET /agent/retrieveSecondaryByParent/{primaryAgentId}

Request parameter

无

Response parameter（JSON数组）

9.5 根据二级代理ID查询三级代理：

Request URL

GET /agent/retrieveTripleByParent/{tripleAgentId}

Request parameter

无

Response parameter（JSON数组）

10.Psp

10.1 获取全部：

Request URL

GET /psp/retrieveAll

Request parameter

无

Response parameter（JSON数组）

String id ID
String pspName psp名称
String agentId agent ID
String agentName agent名称
String saleId 对应sale ID
String saleName sale名称
String branchId 对应branch ID
String branchName 对应branch name
String rateConfigId 对应费率ID
String comments 备注
String userId

10.2 根据ID查询：

Request URL

GET /psp/retrieve/{ID}

Request parameter

无

Response parameter（JSON）

10.3 根据BranchID查询：

Request URL

GET /psp/retrieveByBranch/{branchId}

Request parameter

无

Response parameter（JSON数组）

10.4 根据SaleID查询：

Request URL

GET /psp/retrieveBySale/{saleId}

Request parameter

无

Response parameter（JSON数组）

10.5 根据AgentID查询：

Request URL

GET /psp/retrieveByAgent/{agentId}

Request parameter

无

Response parameter（JSON数组）

11. 商户联系人

只可以创建和删除，不可以更新。

HINTS

联系人类型
PRINCIPL,ECH,FINANCE,OPERATIONS,BO,OTHER

11.1 商户联系人信息保存：

Request URL

POST /merchant/contact/save/{merchantCode}

Request parameter

private String firstName; // 名字
private String lastName; // 姓
private enum type; // 联系人类型
private String title; // 标题
private String email; // 邮箱
private String address; // 地址
private String mobile; // 联系电话
private String comments; // 备注

Response parameter

11.2 根据商户号查询所有：

Request URL

GET /merchant/contact/retrieveAll/{merchantCode}

Request parameter

无

Response parameter（JSON数组）

11.3 根据ID查询：

Request URL

GET /merchant/contact/retrieve/{id}

Request parameter

无

Response parameter

11.4 根据ID删除：

Request URL

GET /merchant/contact/delete/{id}

Request parameter

无

Response parameter

无

12. 商户网站

HINTS

网站状态
ACTIVE,INACTIVE

12.1 商户网站信息保存：

Request URL

POST /merchant/website/save/{merchantCode}

Request parameter

private String url; // 网站链接
private String urlname; // 网站行业
private String email; // 网站联系邮箱
private enum webSiteType; // 网站类型（WEN、APP）

Response parameter

12.2 商户网站信息修改：

Request URL

POST /merchant/website/update/{ID}

Request parameter

private String url; // 网站链接
private String urlname; // 网站行业
private String email; // 网站联系邮箱
private enum status; // 网站状态
private enum webSiteType; // 网站类型（WEN、APP）

Response parameter

12.3 根据商户号查询所有：

Request URL

GET /merchant/website/retrieveAll/{merchantCode}

Request parameter

无

Response parameter（JSON数组）

12.4 根据ID查询：

Request URL

GET /merchant/website/retrieve/{id}

Request parameter

无

Response parameter

12.5 根据ID删除：

Request URL

GET /merchant/website/delete/{id}

Request parameter

无

Response parameter

无

13. 提交Review

Request URL

GET /merchant/submit/{merCode}

Response parameter

isSuccess true/false
msg --

14. 地址

14.1 获取地址信息：

所有国家、省份、城市信息放在xml文件中，将文件下载并添加到项目中，使用javascript解析即可获得。
xml文件对应项目及路径

HazeRoot/HazeWebParent/HazeConsole/src/main/webapp/assets/js/area/

14.2 根据id获取地址：

Request URL

GET /addressbook/retrieve/{id}

Request parameter

无

Response parameter

15. 代理登录

Request URL

POST /agent/login

Request parameter

{
    "email":"dev.us@aurfy.com",
    "password":"abcd1234"
}

Response parameter

{
    "data": {
        "agent_id": "a3d5edca8760466bb9952af5e592f11d",
        "agent_name": "Normal Agent Test",
        "agent_email": "dev.us@aurfy.com",
        "sale_id": "006654d3ca984d91b856da738d818d8b",
        "branch_id": "a2532b43-cd01-46bf-bbdb-57c3bd16dcb2"
    },
    "isSuccess": true,
    "message": "Login Success"
}