客户服务相关

检测客户信息是否存在

post

version=0.0.1 bizType=customer.app.CustomerWebApiService.checkCustomerExist

Header parameters

tracestringRequired

全局链路唯一标志

Example: {{mock_trace}}

companyIdstringRequired

公司ID

Example: {{company}}

versionstringRequired

接口版本号

Example: 0.0.1

Body

typeintegerRequired

注册登录方式：1邮箱，2手机号码，3客户账号

loginNamestringRequired

账号：邮箱/手机号码

phoneAreastringOptional

手机区号，区号默认为+86

emailAreastringOptional

邮箱区号，区号默认为+86

Responses

200Success

application/json

bizCodestringRequired

模块标识码

codestringRequired

状态返回码

msgstringOptional

状态描述

tmstringRequired

处理时长（毫秒）

tracestringOptional

跟踪码

msgParamsstringOptional

返回描述中占位符参数串，多个参数间以,分割

dataintegerOptional

1已存在,2不存在

post/customer.app.CustomerWebApiService.checkCustomerExist

POST /openapi-b/customer.app.CustomerWebApiService.checkCustomerExist HTTP/1.1
Host: pre-api-test.cmfbl.com
trace: text
companyId: text
version: text
Content-Type: application/json
Accept: */*
Content-Length: 93

{
  "type": 2,
  "loginName": "{{mock_phone}}",
  "protocol": "true",
  "emailArea": "+86",
  "phoneArea": "+86"
}

200Success

{
  "bizCode": "text",
  "code": "text",
  "msg": "text",
  "tm": "text",
  "trace": "text",
  "msgParams": "text",
  "data": 1
}

客户注册

post

公司默认客户组资产列表示例：*通过前端H5/PCUI数据提供*
"tradeTypeCurrencyList":
 [
    {
      "allCurrency": "USDT",
      "tradeType": "1",
      "isWallet": "",
      "alias": "",
      "id": "1",
      "name": "合约全仓"
    },
    {
      "allCurrency": "USDT",
      "tradeType": "2",
      "isWallet": "",
      "alias": "",
      "id": "2",
      "name": "合约逐仓"
    },
    {
      "allCurrency": "USDT,USD,BTC,SAND,LINK,AAVE,DOGE,BCH,ETH,BNB,SOL,AVAX,SHIB,UNI,DOT,XRP,ADA,FIL,V10",
      "tradeType": "3",
      "isWallet": "",
      "alias": "",
      "id": "3",
      "name": "杠杆"
    },
    {
      "allCurrency": 
      "USDT,BTC,LINK,ETH,SAND,USD,REEF,ADA,AAVE,DOT,ARX4,BNB,DOGE,ARX10,V10,qa001,qa002,M10,XRP,SHIB,EOS,XEC,FIL,FFT,NFT,QA003,QA004,QA005,QA006,QA007,QA008",
      "tradeType": "5",
      "isWallet": "",
      "alias": "",
      "id": "5",
      "name": "现货"
    }
  ]

邮箱注册示例：*登录密码(pwd)MD5加密*
{
  "email": "16612339304927@qq.com",
  "emailArea": "+86",
  "pwd": "dc483e80a7a0bd9ef71d8cf973673924",
  "country": "CN",
  "customerGroupId": 1,
  "registerSource": 1,
  "tradeTypeCurrencyList": [...]
}

手机注册示例：*登录密码(pwd)MD5加密*
{
  "phone": "15167651757",
  "country": "CN",
  "customerGroupId": 1,
  "registerSource": 1,
  "tradeTypeCurrencyList": [...],
  "phoneArea": "+86",
  "pwd": "dc483e80a7a0bd9ef71d8cf973673924"
}

Header parameters

tracestringRequired

全局链路唯一标志

Example: {{mock_trace}}

tokenstringRequired

鉴权码

Example: {{auto_token}}

versionstringRequired

接口版本号

Example: 0.0.1

companyIdstringRequired

公司ID

Example: {{company}}

Body

phonestringRequired

账号：手机号码

emailstringOptional

账号：邮箱

phoneAreastringOptional

手机区号，区号默认为+86

emailAreastringOptional

邮箱区号，区号默认为+86

pwdstringRequired

登录密码，MD5加密、a123456

countrystringRequired

国家:CN=中国

registerSourceintegerRequired

注册来源:1=移动端web：H5，2=pcweb：PC_Web，3=系统&后台平仓：System，4=安卓原生app：Android，5=苹果原生app：iOS，6=鸿蒙OS：HOS，7=pc windows客户端：PC_Win,8=pc mac客户端：PC_Mac，9=不属于以上的：其他

customerGroupIdnumberRequired

客户组ID:1=默认客户组; customerFroupId与tradeTypeCurrencyList相互对应

remarkstringOptional

备注

registerDevicestringOptional

注册的设备型号

utmSourcestringOptional

广告来源(开户链接参数source)

utmMediumstringOptional

广告媒介(开户链接参数medium)

utmCampaignstringOptional

广告系列(开户链接参数campaign)

utmContentstringOptional

广告组(开户链接参数content)

utmTermstringOptional

关键词(开户链接参数term)

Responses

200Success

application/json

codestringRequired

系统通用返回码。0-成功，其他异常

msgstringRequired

返回信息

bizCodestringRequired

模块标识码

tmnumberRequired

处理时长（毫秒）

tracestringRequired

全局链路标志信息

msgParamsstring · nullableRequired

返回描述中占位符参数串，多个参数间以,分割

datastringRequired

返回结果,客户编号

post/customer.admin.WhiteCustomerAdminApiService.addCusAndOpenAccountAndKyc

POST /openapi-b/customer.admin.WhiteCustomerAdminApiService.addCusAndOpenAccountAndKyc HTTP/1.1
Host: pre-api-test.cmfbl.com
trace: text
token: text
version: text
companyId: text
Content-Type: application/json
Accept: */*
Content-Length: 209

{
  "email": "test439@chixi88.com",
  "emailArea": "+86",
  "pwd": "dc483e80a7a0bd9ef71d8cf973673924",
  "country": "CN",
  "customerGroupId": 1,
  "registerSource": 1,
  "tradeTypeCurrencyList": [
    {
      "allCurrency": "USDT",
      "tradeType": "1"
    }
  ]
}

200Success

{
  "msg": "Success",
  "fail": false,
  "trace": "t-h2jv9x-4to64-9mp4wd7-793nv-1661227305",
  "code": "0",
  "data": "86021976",
  "bizCode": "",
  "tm": 236026513,
  "msgParams": null,
  "ok": true
}

客户基础信息

post

version=0.0.1 bizType=customer.admin.WhiteCustomerAdminApiService.page

Header parameters

tracestringRequired

全局链路唯一标志

Example: {{mock_trace}}

tokenstringRequired

鉴权码

Example: {{auto_token}}

versionstringRequired

接口版本号

Example: 0.0.1

companyIdstringRequired

公司ID

Example: {{company}}

Body

customerNostringRequired

客户编号

sizenumberOptional

每页显示多少行，默认20

currentnumberOptional

当前页，默认1

Responses

200Success

application/json

agentCustomerNostringOptional

代理编号

companyIdinteger · int64Optional

公司

createTimeinteger · int64Optional

创建时间/申请时间

customerGroupIdinteger · int64Optional

客户组Id

customerGroupNamestringOptional

客户组名称

customerNostringOptional

客户账号

customerTypeinteger · int32Optional

客户类型0默认1代理2授信3活动结算

emailstringOptional

邮箱

firstAccountActivateTimeinteger · int64Optional

交易账号首次激活时间

firstNamestringOptional

名

idinteger · int64Optional

idCardstringOptional

证件号码

idCardTypestringOptional

证件类型

lastNamestringOptional

姓

loginTimeinteger · int64Optional

登录时间

namestringOptional

姓名

openAccountTypeinteger · int32Optional

开户类型：0.个人 1.企业

phonestringOptional

手机

phoneAreastringOptional

手机区号

registerSourceinteger · int32Optional

注册来源

remarkstringOptional

备注

statusinteger · int32Optional

状态:1正常、2禁用、3删除，4销户，5锁定，6销户中

tgUserIdstringOptional

tgUserId

tgUserNamestringOptional

tgUserName

thirdAccountNostringOptional

三方账户

thirdLoginSourcestringOptional

thirdLoginSource

thirdUserIdstringOptional

thirdUserId

unitIdinteger · int64Optional

机构id

unitNamestringOptional

机构名称

updateTimeinteger · int64Optional

更新时间

post/customer.admin.WhiteCustomerAdminApiService.page

POST /openapi-b/customer.admin.WhiteCustomerAdminApiService.page HTTP/1.1
Host: pre-api-test.cmfbl.com
trace: text
token: text
version: text
companyId: text
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "customerNo": "86002678",
  "size": 20,
  "current": 1
}

200Success

{
  "bizCode": "",
  "code": "",
  "data": {
    "current": 0,
    "records": [
      {
        "agentCustomerNo": "",
        "companyId": 0,
        "createTime": 0,
        "customerGroupId": 0,
        "customerGroupName": "",
        "customerNo": "",
        "customerType": 0,
        "email": "",
        "firstAccountActivateTime": 0,
        "firstName": "",
        "id": 0,
        "idCard": "",
        "idCardType": "",
        "lastName": "",
        "loginTime": 0,
        "name": "",
        "openAccountType": 0,
        "phone": "",
        "phoneArea": "",
        "registerSource": 0,
        "remark": "",
        "status": 0,
        "tgUserId": "",
        "tgUserName": "",
        "thirdAccountNo": "",
        "thirdLoginSource": "",
        "thirdUserId": "",
        "unitId": 0,
        "unitName": "",
        "updateTime": 0
      }
    ],
    "size": 0,
    "total": 0
  },
  "fail": true,
  "msg": "",
  "msgParams": "",
  "ok": true,
  "tm": 0,
  "trace": ""
}

客户详情

post

version=0.0.1 bizType=customer.admin.WhiteCustomerAdminApiService.detail

Header parameters

tracestringRequired

全局链路唯一标志

Example: {{mock_trace}}

tokenstringRequired

鉴权码

Example: {{auto_token}}

versionstringRequired

接口版本号

Example: 0.0.1

companyIdstringRequired

公司ID

Example: {{company}}

Body

typestringRequired

类型信息，baseInfo=基础信息，tradeAccount=交易账户，kyc=kyc信息，allKyc=详情页面kyc信息，bankList=银行卡列表,walletList=钱包地址，otherInfo=其他

idstringRequired

客户id

customerNostringRequired

客户编号

Responses

200Success

application/json

accountListobjectOptional

交易账户列表

accountRemarkstringOptional

客户是否有交易账户备注

activateStatusinteger · int32Optional

激活状态

activateTimeinteger · int64Optional

激活时间

addressstringOptional

通讯地址

apiCheckRulestringOptional

API 校验规则。1-邮件；2-短信；3-谷歌NFA；同时启用多个校验，以,分割。

apiCheckSwitchbooleanOptional

API 校验开关

assertPassStatusstringOptional

设置资金密码提醒标志，1需要设置密码，2不需要

associationCompanyIdinteger · int64Optional

关联公司Id

companyIdinteger · int64Optional

公司

companyKycStatusinteger · int32Optional

公司KYC开户状态，1开启2未开启

companyTypestringOptional

公司类型

countrystringOptional

国家

createTimeinteger · int64Optional

创建时间

customerAgentMarkstringOptional

客户代理标示

customerGroupIdinteger · int64Optional

客户组

customerNostringOptional

客户账号

customerTypeinteger · int32Optional

客户类型0默认1代理2授信3活动结算

depositinteger · int32Optional

可存款,1可存款

earlyWarningLevelobjectOptional

预警水平

emailstringOptional

邮箱

firstNamestringOptional

名

forceLevelobjectOptional

强平水平

googleIdinteger · int64Optional

是否开启MFA，大于0，开启，其余未开启

idinteger · int64Optional

客户id

idCardstringOptional

证件号码

idCardTypestringOptional

证件类型

isFundinteger · int32Optional

是否为基金经理，1是，默认0否

kycAuditRemarkstringOptional

注册KYC审核备注,审核拒绝不为空

kycAuditStatusinteger · int32Optional

注册KYC审核状态:0未认证跳转到认证页面,1待审核,2审核通过,3审核不通过

kycRemarkstringOptional

KYC状态名称

kycStatusinteger · int32Optional

KYC状态

lastNamestringOptional

姓

loginPassStatusstringOptional

设置密码提醒标志，1需要设置密码，2不需要

loginTimeinteger · int64Optional

登陆时间

namestringOptional

姓名

openAccountTypeinteger · int32Optional

开户类型：0.个人 1.企业

optionalinteger · int32Optional

自选标志0未添加1已添加

payPassStatusstringOptional

支付密码是否存在状态，1不存在，2存在

phonestringOptional

手机

phoneAreastringOptional

手机区号

postalCodestringOptional

邮政编码

registerSourceinteger · int32Optional

注册来源

registerTimeinteger · int64Optional

注册时间

relationCustomerIdinteger · int64Optional

关联账户id

sourcestringOptional

来源

statusinteger · int32Optional

状态:1正常、2禁用、3删除，4销户，5锁定，6销户中

thirdIntactMsgstringOptional

第三方登录完整数据

thirdLoginSourcestringOptional

第三方登录源 google,facebook,twitter

thirdServerCodestringOptional

第三方系统唯一编号

thirdUserIdstringOptional

第三方userId

typeinteger · int32Optional

组类型 <0真实，1模拟，2游客>

unitIdinteger · int64Optional

机构ID

unitNamestringOptional

机构名称

utmSourcestringOptional

广告来源

withdrawinteger · int32Optional

可取款,1可取款

withdrawLevelobjectOptional

取款水平

post/customer.admin.WhiteCustomerAdminApiService.detail

POST /openapi-b/customer.admin.WhiteCustomerAdminApiService.detail HTTP/1.1
Host: pre-api-test.cmfbl.com
trace: text
token: text
version: text
companyId: text
Content-Type: application/json
Accept: */*
Content-Length: 73

{
  "type": "tradeAccount",
  "id": "{{customerId}}",
  "customerNo": "{{customer}}"
}

200Success

{
  "bizCode": "",
  "code": "",
  "data": {
    "accountList": {},
    "accountRemark": "",
    "activateStatus": 0,
    "activateTime": 0,
    "address": "",
    "apiCheckRule": "",
    "apiCheckSwitch": true,
    "assertPassStatus": "",
    "associationCompanyId": 0,
    "companyId": 0,
    "companyKycStatus": 0,
    "companyType": "",
    "country": "",
    "createTime": 0,
    "customerAgentMark": "",
    "customerGroupId": 0,
    "customerNo": "",
    "customerType": 0,
    "deposit": 0,
    "earlyWarningLevel": {},
    "email": "",
    "firstName": "",
    "forceLevel": {},
    "googleId": 0,
    "id": 0,
    "idCard": "",
    "idCardType": "",
    "isFund": 0,
    "kycAuditRemark": "",
    "kycAuditStatus": 0,
    "kycRemark": "",
    "kycStatus": 0,
    "lastName": "",
    "loginPassStatus": "",
    "loginTime": 0,
    "name": "",
    "openAccountType": 0,
    "optional": 0,
    "payPassStatus": "",
    "phone": "",
    "phoneArea": "",
    "postalCode": "",
    "registerSource": 0,
    "registerTime": 0,
    "relationCustomerId": 0,
    "source": "",
    "status": 0,
    "thirdIntactMsg": "",
    "thirdLoginSource": "",
    "thirdServerCode": "",
    "thirdUserId": "",
    "type": 0,
    "unitId": 0,
    "unitName": "",
    "utmSource": "",
    "withdraw": 0,
    "withdrawLevel": {}
  },
  "fail": true,
  "msg": "",
  "msgParams": "",
  "ok": true,
  "tm": 0,
  "trace": ""
}

查询客户组列表

post

version=0.0.1 bizType=customer.admin.CustomerGroupAdminApiService.groupList B端鉴权之后可访问

Header parameters

tracestringRequired

全局链路唯一标志

Example: {{mock_trace}}

companyIdstringRequired

公司ID

Example: {{company}}

tokenstringRequired

B端鉴权后token

Example: {{auto_token}}

versionstringRequired

接口版本号

Example: 0.0.1

Body

objectOptional

Responses

200Success

application/json

bizCodestringOptional

模块标识码

codestringOptional

状态返回码

msgstringOptional

状态描述

tminteger · int64Optional

处理时长（毫秒）

tracestringOptional

跟踪码

msgParamsstringOptional

返回描述中占位符参数串，多个参数间以,分割

okbooleanOptional

failbooleanOptional

post/customer.admin.CustomerGroupAdminApiService.groupList

POST /openapi-b/customer.admin.CustomerGroupAdminApiService.groupList HTTP/1.1
Host: pre-api-test.cmfbl.com
trace: text
companyId: text
token: text
version: text
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "tradeType": 5,
  "customerNo": "86000020"
}

200Success

{
  "bizCode": "text",
  "code": "text",
  "msg": "text",
  "tm": 1,
  "trace": "text",
  "msgParams": "text",
  "data": [
    {
      "name": "text",
      "id": 1,
      "type": 1,
      "openAccountType": 1,
      "tradeType": 1,
      "assets": "text"
    }
  ],
  "ok": true,
  "fail": true
}

Previous资金服务相关

Next消息服务相关

Last updated 11 months ago