wlink (v1)

Download OpenAPI specification:

crm saas

公共接口(28)

修改密码-认证接口

修改密码

Request Body schema: application/json

email_code	string 邮箱验证码
new_password required	string 新密码
old_password required	string 原密码

Responses

Request samples

Payload

Content type

application/json

{"email_code": "string",
"new_password": "string",
"old_password": "string"
}

Response samples

200

Content type

application/json

{ }

登录-认证接口

登录

header Parameters

Captcha-Token	string
Captcha-Action	string
Captcha-Randstr	string

Request Body schema: application/json

email required	string
password required	string

Responses

Request samples

Payload

Content type

application/json

{"email": "string",
"password": "string"
}

Response samples

200

Content type

application/json

{"token": "string",
"user_info": {"email": "string",
"first_name": "string",
"full_name": "string",
"id": 0,
"last_name": "string",
"user_type": "string"
}
}

登出-认证接口

登出

Responses

Response samples

200

Content type

application/json

{ }

重置密码-认证接口

重置密码

Request Body schema: application/json

password required	string
token required	string

Responses

Request samples

Payload

Content type

application/json

{"password": "string",
"token": "string"
}

Response samples

200

Content type

application/json

{ }

重置密码发送邮件-认证接口

重置密码发送邮件

Request Body schema: application/json

email

required

string

Responses

Request samples

Payload

Content type

application/json

{"email": "string"
}

Response samples

200

Content type

application/json

{ }

重置密码Token是否过期-认证接口

重置密码Token是否过期

query Parameters

token

required

string

Responses

Response samples

200

Content type

application/json

{"expired": true
}

获取用户安全设置-认证接口

获取用户安全设置

Responses

Response samples

200

Content type

application/json

{"email": "string",
"password": "string",
"required_password": "string"
}

获取登陆用户的按钮权限-权限管理模块

获取登陆用户的按钮权限

Responses

Response samples

200

Content type

application/json

{"actions": {"property1": {"methods": {"property1": true,
"property2": true
},
"path": "string",
"title": "string",
"url": "string"
},
"property2": {"methods": {"property1": true,
"property2": true
},
"path": "string",
"title": "string",
"url": "string"
}
},
"menus": [{"action": "string",
"children": [{"action": "string",
"children": [{ }
],
"desc": "string",
"icon": "string",
"id": 0,
"key": "string",
"parent_id": 0,
"path": "string",
"sort_order": 0,
"status": 0,
"title": "string",
"user_type": "string"
}
],
"desc": "string",
"icon": "string",
"id": 0,
"key": "string",
"parent_id": 0,
"path": "string",
"sort_order": 0,
"status": 0,
"title": "string",
"user_type": "string"
}
]
}

获取所有的菜单以及button列表用户的菜单列表-权限管理模块

获取所有的菜单以及button列表用户的菜单列表

Responses

Response samples

200

Content type

application/json

{"list": [{"action": "string",
"children": [{"action": "string",
"children": [{ }
],
"desc": "string",
"icon": "string",
"id": 0,
"key": "string",
"parent_id": 0,
"path": "string",
"sort_order": 0,
"status": 0,
"title": "string",
"user_type": "string"
}
],
"desc": "string",
"icon": "string",
"id": 0,
"key": "string",
"parent_id": 0,
"path": "string",
"sort_order": 0,
"status": 0,
"title": "string",
"user_type": "string"
}
]
}

获取投放列表-投放管理

获取投放列表（Client/IB端）

header Parameters

X-Language

string

Default: zh-CN

国际化语言，默认为zh-CN

Responses

Response samples

200

Content type

application/json

{"list": [{"id": 0,
"image_url": "string",
"redirect_url": "string",
"title": "string"
}
]
}

屏蔽弹窗（不再展示）-弹窗管理

屏蔽弹窗（不再展示）

Request Body schema: application/json

ids

required

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"ids": [0
]
}

Response samples

200

Content type

application/json

{ }

获取弹窗列表-弹窗管理

获取弹窗列表（Client/IB端）

header Parameters

X-Language

string

Default: zh-CN

国际化语言，默认为zh-CN

Responses

Response samples

200

Content type

application/json

{"list": [{"allow_close": true,
"content": "string",
"id": 0,
"is_enabled": true,
"title": "string"
}
]
}

腾讯验证码验证-公共服务

腾讯验证码验证

Request Body schema: application/json

app_id required	integer
rand_str required	string
ticket required	string
user_ip required	string

Responses

Request samples

Payload

Content type

application/json

{"app_id": 0,
"rand_str": "string",
"ticket": "string",
"user_ip": "string"
}

Response samples

200

Content type

application/json

{"is_valid": true
}

发送邮箱验证码-验证码接口

发送邮箱验证码

Request Body schema: application/json

email	string 邮箱地址
received_at required	integer 接收时间戳（Unix时间戳，单位：秒）
scene required	string Enum: "register" "withdrawal" "transfer" "password_change" 使用场景

Responses

Request samples

Payload

Content type

application/json

{"email": "string",
"received_at": 0,
"scene": "register"
}

Response samples

200

Content type

application/json

{"can_resend_at": 0,
"expired_at": 0
}

校验邮箱是否已注册-验证码接口

校验邮箱是否已注册

Request Body schema: application/json

email

required

string

邮箱地址

Responses

Request samples

Payload

Content type

application/json

{"email": "string"
}

Response samples

200

Content type

application/json

{"is_registered": true
}

获取AliyunOss临时访问凭证-公共服务

获取AliyunOss临时访问凭证

Responses

Response samples

200

Content type

application/json

{"access_key_id": "string",
"access_key_secret": "string",
"bucket_dir": "string",
"bucket_name": "string",
"bucket_region": "string",
"expiration": "string",
"security_token": "string"
}

查询APP key配置-公开设置接口

查询APP key配置

Responses

Response samples

200

Content type

application/json

{"recaptcha_android_key": "string",
"recaptcha_web_key": "string",
"tencent_android_app_id": 0,
"tencent_ios_app_id": 0,
"tencent_web_app_id": 0
}

获取外观设置-公开设置接口

获取外观设置

Responses

Response samples

200

Content type

application/json

{"admin_login_bg_image_url": "string",
"admin_login_copy_i18n": {"en": "string",
"zh-CN": "string",
"zh-TW": "string"
},
"admin_login_layout": "string",
"client_login_bg_image_url": "string",
"client_login_copy_i18n": {"en": "string",
"zh-CN": "string",
"zh-TW": "string"
},
"client_login_layout": "string",
"ib_login_bg_image_url": "string",
"ib_login_copy_i18n": {"en": "string",
"zh-CN": "string",
"zh-TW": "string"
},
"ib_login_layout": "string"
}

获取公司设置-公开设置接口

获取公司设置

Responses

Response samples

200

Content type

application/json

{"broker_name_i18n": {"en": "string",
"zh-CN": "string",
"zh-TW": "string"
},
"company_logo_url": "string",
"email": "string",
"login_page_logo_url": "string",
"support_phone": "string",
"timezone": "string",
"watermark_logo_url": "string"
}

获取国家-公开设置接口

获取国家

Responses

Response samples

200

Content type

application/json

{"list": [{"code": "string",
"flag": "string",
"name": {"en": "string",
"zh-CN": "string",
"zh-TW": "string"
},
"phone_code": "string"
}
]
}

获取所有可用的货币-公开设置接口

获取所有可用的货币

query Parameters

method

string

Enum: "all" "bank_transfer" "international_wire_transfer" "cryptocurrency"

出入金方式: normal为全部，bank_transfer为银行转账，international_wire_transfer为国际电汇，cryptocurrency为加密货币

Responses

Response samples

200

Content type

application/json

{"list": [{"code": "string",
"name": {"en": "string",
"zh": "string"
}
}
],
"total": 0
}

查询全局杠杆列表-公开设置接口

查询全局杠杆列表

query Parameters

page required	integer Default: 1 页码
size required	integer Default: 20 每页数量

Responses

Response samples

200

Content type

application/json

{"list": [{"id": 0,
"value": 0
}
],
"total": 0
}

获取语言设置-公开设置接口

获取语言设置

Responses

Response samples

200

Content type

application/json

{"language": [{"code": "string",
"name": "string"
}
]
}

获取安全设置-公开设置接口

获取安全设置

Responses

Response samples

200

Content type

application/json

{"email_verification_scenarios": ["string"
],
"google_two_factor_enabled": true,
"re_captcha_enabled": true,
"required_password_strength": "string",
"tencent_two_factor_enabled": true
}

获取当前租户版本号-公开设置接口

获取当前租户版本号

Responses

Response samples

200

Content type

application/json

{"version": "string"
}

出金报表导出-报表接口

出金报表导出

Request Body schema: application/json

end_time	string 自定义结束时间（格式：YYYY-MM-DD HH:MM:SS）
method required	string Enum: "all" "bank_transfer" "international_wire_transfer" "cryptocurrency" 出金方式: all为全部，bank_transfer为银行转账，international_wire_transfer为国际电汇，cryptocurrency为加密货币
start_time	string 自定义开始时间（格式：YYYY-MM-DD HH:MM:SS）
status required	string Enum: "all" "auditing" "approved" "disapproved" 状态：all为全部（包含审核中和批准，不批准），auditing为审核中，approved为同意，disapproved为拒绝

Responses

Request samples

Payload

Content type

application/json

{"end_time": "string",
"method": "all",
"start_time": "string",
"status": "all"
}

Response samples

200

Content type

application/json

{"download_url": "string"
}

出金报表-报表接口

出金报表

query Parameters

page required	integer Default: 1 页码
size required	integer Default: 20 每页数量
start_time	string 自定义开始时间（格式：YYYY-MM-DD HH:MM:SS）
end_time	string 自定义结束时间（格式：YYYY-MM-DD HH:MM:SS）
status required	string Enum: "all" "auditing" "approved" "disapproved" 状态：all为全部（包含审核中和批准，不批准），auditing为审核中，approved为批准，disapproved为拒绝
method required	string Enum: "all" "bank_transfer" "international_wire_transfer" "cryptocurrency" 出金方式: all为全部，bank_transfer为银行转账，international_wire_transfer为国际电汇，cryptocurrency为加密货币

Responses

Response samples

200

Content type

application/json

{"list": [{"account": "string",
"amount": "string",
"auditor_name": "string",
"currency": "string",
"fee": "string",
"id": 0,
"method": "string",
"order_number": "string",
"server_name": "string",
"server_type": "string",
"status": "pending",
"submit_time": "string",
"user_name": "string"
}
],
"total": 0
}

获取当前登录用户的菜单权限（自动区分IB）-权限验证

获取当前登录用户的菜单权限（自动区分IB/Client）

Responses

Response samples

200

Content type

application/json

{"actions": {"property1": {"methods": {"property1": true,
"property2": true
},
"path": "string",
"title": "string",
"url": "string"
},
"property2": {"methods": {"property1": true,
"property2": true
},
"path": "string",
"title": "string",
"url": "string"
}
},
"menus": [{"action": "string",
"children": [{"action": "string",
"children": [{ }
],
"desc": "string",
"icon": "string",
"id": 0,
"key": "string",
"parent_id": 0,
"path": "string",
"sort_order": 0,
"status": 0,
"title": "string",
"user_type": "string"
}
],
"desc": "string",
"icon": "string",
"id": 0,
"key": "string",
"parent_id": 0,
"path": "string",
"sort_order": 0,
"status": 0,
"title": "string",
"user_type": "string"
}
]
}

Client接口(65)

查询所持账户的余额-申请接口

查询所持账户的余额

query Parameters

type

required

Array of strings

记录类型：只能入金(deposit_only)、只能出金(withdrawal_only),入金出金都可以(normal)，入金传入deposit_only和normal，出金传入withdrawal_only和normal

Responses

Response samples

200

Content type

application/json

{"list": [{"balance": "string",
"server_name": "string",
"server_type": "string",
"trading_account": "string",
"trading_account_id": 0
}
],
"total": 0
}

创建开户申请-申请接口

创建开户申请-Client端接口

Request Body schema: application/json

currency required	string Value: "USD" 账户货币，目前只支持USD
leverage required	integer 账户杠杆
observe_password	string 观摩密码
password required	string 交易密码
trading_account_type_id required	integer 交易账号类型ID
trading_platform required	string Enum: "MT4" "MT5" 交易平台，目前仅支持MT4

Responses

Request samples

Payload

Content type

application/json

{"currency": "USD",
"leverage": 0,
"observe_password": "string",
"password": "string",
"trading_account_type_id": 0,
"trading_platform": "MT4"
}

Response samples

200

Content type

application/json

{"application_account_id": 0
}

创建转账申请-申请接口

创建转账申请

Request Body schema: application/json

amount required	string 转账金额
email_code	string 邮箱验证码
remark required	string 注释
source_trading_account_id required	integer 转出交易账户ID
target_trading_account_id required	integer 转入交易账户ID

Responses

Request samples

Payload

Content type

application/json

{"amount": "string",
"email_code": "string",
"remark": "string",
"source_trading_account_id": 0,
"target_trading_account_id": 0
}

Response samples

200

Content type

application/json

{"audit_id": 0,
"audit_status": "string"
}

查询转账历史列表-申请接口

查询转账历史列表

query Parameters

page required	integer Default: 1 页码
size required	integer Default: 20 每页数量
start_time	string 自定义开始时间（格式：YYYY-MM-DD HH:MM:SS）
end_time	string 自定义结束时间（格式：YYYY-MM-DD HH:MM:SS）

Responses

Response samples

200

Content type

application/json

{"list": [{"amount": "string",
"currency": "string",
"id": 0,
"order_number": "string",
"remark": "string",
"source_trading_account": {"account": "string",
"id": 0,
"server_name": "string",
"server_type": "MT4-Live"
},
"status": "pending",
"submit_time": "string",
"target_trading_account": {"account": "string",
"id": 0,
"server_name": "string",
"server_type": "MT4-Live"
}
}
],
"total": 0
}

创建电子认证会话-电子认证

创建电子认证会话

Request Body schema: application/json

failed_url required	string 认证失败跳转URL
success_url required	string 认证成功跳转URL

Responses

Request samples

Payload

Content type

application/json

{"failed_url": "string",
"success_url": "string"
}

Response samples

200

Content type

application/json

{"expire_at": "string",
"redirect_url": "string",
"session_id": "string"
}

查询电子认证结果-电子认证

查询电子认证结果

query Parameters

session_id

required

string

会话ID

Responses

Response samples

200

Content type

application/json

{"attempt_times": 0,
"reason_code": "string",
"reason_msg": "string",
"retry_times": 0,
"status": "string"
}

消息详情-消息中心

消息详情

query Parameters

id

required

integer

消息ID

Responses

Response samples

200

Content type

application/json

{"content": "string",
"created_at": "string",
"id": 0,
"sender": "string",
"title": "string"
}

隐藏消息-消息中心

隐藏消息

Request Body schema: application/json

id

required

integer

消息ID

Responses

Request samples

Payload

Content type

application/json

{"id": 0
}

Response samples

200

Content type

application/json

{ }

消息列表-消息中心

消息列表

query Parameters

page required	integer Default: 1 页码
size required	integer Default: 20 每页数量

Responses

Response samples

200

Content type

application/json

{"list": [{"created_at": "string",
"id": 0,
"is_read": true,
"sender": "string",
"title": "string"
}
],
"total": 0
}

标记消息已读-消息中心

标记消息已读

Request Body schema: application/json

id

required

integer

消息ID

Responses

Request samples

Payload

Content type

application/json

{"id": 0
}

Response samples

200

Content type

application/json

{ }

获取未读消息数量-消息中心

获取未读消息数量

Responses

Response samples

200

Content type

application/json

{"count": 0
}

查询Client用户问卷答案-客户接口

查询Client用户问卷答案

query Parameters

id

required

integer

答卷记录ID

Responses

Response samples

200

Content type

application/json

{"id": 0,
"items": [{"answer": null,
"question": "string",
"type": "radio"
}
],
"name": "string"
}

保存Client用户问卷答案-客户接口

保存Client用户问卷答案

Request Body schema: application/json

required	Array of objects 答案列表
questionnaire_id required	integer 问卷ID

Responses

Request samples

Payload

Content type

application/json

{"answers": [{"answer": null,
"component_type": "string",
"key": "string",
"question": "string",
"question_id": 0,
"questionnaire_id": 0,
"questionnaire_name": "string"
}
],
"questionnaire_id": 0
}

Response samples

200

Content type

application/json

{ }

获取软件下载工具列表-客户接口

获取软件下载工具列表

Responses

Response samples

200

Content type

application/json

{"list": [{"android_download_url": "string",
"created_at": "string",
"description": "string",
"icon_url": "string",
"id": 0,
"ios_download_url": "string",
"logo_url": "string",
"macos_download_url": "string",
"name": "string",
"updated_at": "string",
"windows_download_url": "string"
}
],
"total": 0
}

获取交易工具栏目多语言详情-交易工具

获取交易工具栏目多语言详情

query Parameters

column_id

required

integer

主表column_id

Responses

Response samples

200

Content type

application/json

{"column_id": 0,
"id": 0,
"iframe_link": "string",
"is_read": true,
"language": "string",
"popup_content": "string",
"popup_title": "string",
"title": "string"
}

检查弹框是否已读-交易工具

检查弹框是否已读

query Parameters

column_id

required

integer

栏目ID

Responses

Response samples

200

Content type

application/json

{"is_read": true
}

标记弹框已读-交易工具

标记弹框已读

Request Body schema: application/json

column_id

required

integer

栏目ID

Responses

Request samples

Payload

Content type

application/json

{"column_id": 0
}

Response samples

200

Content type

application/json

{ }

获取加密货币USDT可用网络-申请接口

获取加密货币USDT可用网络

query Parameters

page required	integer Default: 1 页码
size required	integer Default: 20 每页数量

Responses

Response samples

200

Content type

application/json

{"list": [{"network": "string"
}
],
"total": 0
}

基于货币对返回汇率-申请接口

基于货币对返回汇率

query Parameters

from_currency required	string 源货币
to_currency required	string 目标货币

Responses

Response samples

200

Content type

application/json

{"exchange_rate": "string"
}

获取可用货币列表-申请接口

获取可用货币列表

query Parameters

remittance_id required	integer 汇款方式ID
page required	integer Default: 1 页码
size required	integer Default: 20 每页数量

Responses

Response samples

200

Content type

application/json

{"list": [{"code": "string",
"name": "string"
}
],
"total": 0
}

虚拟账户入金-申请接口

虚拟账户入金

Request Body schema: application/json

amount required	string 金额
trading_account_id required	integer 交易账号ID

Responses

Request samples

Payload

Content type

application/json

{"amount": "string",
"trading_account_id": 0
}

Response samples

200

Content type

application/json

{ }

取消入金申请-申请接口

取消入金申请

Request Body schema: application/json

order_number

required

string

入金订单号

Responses

Request samples

Payload

Content type

application/json

{"order_number": "string"
}

Response samples

200

Content type

application/json

{"order_number": "string",
"status": "string"
}

获取可用的入金渠道-申请接口

获取可用的入金渠道

query Parameters

page required	integer Default: 1 页码
size required	integer Default: 20 每页数量

Responses

Response samples

200

Content type

application/json

{"list": [{"account_info": "string",
"allowed_countries": ["string"
],
"allowed_currencies": ["string"
],
"fee": "string",
"icon_url": "string",
"id": 0,
"max_amount": "string",
"method": "string",
"min_amount": "string",
"name": "string"
}
],
"total": 0
}

创建入金申请草稿-申请接口

创建入金申请草稿

Request Body schema: application/json

deposit_amount required	string 入金金额
remark	string 备注，可选
remittance_id required	integer 汇款方式id
trading_account_id required	integer 入金交易账号id（用户关联的交易账号ID（多选一））

Responses

Request samples

Payload

Content type

application/json

{"deposit_amount": "string",
"remark": "string",
"remittance_id": 0,
"trading_account_id": 0
}

Response samples

200

Content type

application/json

{"order_number": "string",
"pay_data": "string",
"pay_type": "string",
"pay_url": "string",
"status": "string"
}

获取未提交入金申请草稿-申请接口

获取未提交入金申请草稿

query Parameters

order_number

required

string

入金订单号

Responses

Response samples

200

Content type

application/json

{"account_info": "string",
"deposit_amount": "string",
"order_number": "string",
"receipt_url": "string"
}

获取未处理入金申请订单的数量-申请接口

获取未处理入金申请订单的数量

query Parameters

page required	integer Default: 1 页码
size required	integer Default: 20 每页数量

Responses

Response samples

200

Content type

application/json

{"count": 0
}

提交入金申请（支付确认）-申请接口

提交入金申请（支付确认）

Request Body schema: application/json

order_number required	string 入金订单号
receipt_url required	string 收据图片地址

Responses

Request samples

Payload

Content type

application/json

{"order_number": "string",
"receipt_url": "string"
}

Response samples

200

Content type

application/json

{"order_number": "string",
"status": "string"
}

查询入金历史记录-申请接口

查询入金历史记录

query Parameters

start_time	string 自定义开始时间（格式：YYYY-MM-DD HH:MM:SS）
end_time	string 自定义结束时间（格式：YYYY-MM-DD HH:MM:SS）
page required	integer Default: 1 页码
size required	integer Default: 20 每页数量

Responses

Response samples

200

Content type

application/json

{"list": [{"amount": "string",
"client_remark": "string",
"currency": "string",
"icon": "string",
"id": 0,
"order_number": "string",
"pay_url": "string",
"remark": "string",
"remittance_name": "string",
"server_name": "string",
"server_type": "string",
"status": "string",
"submit_time": "string",
"target_trading_account": {"account": "string",
"id": 0,
"server_name": "string",
"server_type": "string"
}
}
],
"total": 0
}

查询出金历史记录-申请接口

查询出金历史记录

query Parameters

start_time	string 自定义开始时间（格式：YYYY-MM-DD HH:MM:SS）
end_time	string 自定义结束时间（格式：YYYY-MM-DD HH:MM:SS）
page required	integer Default: 1 页码
size required	integer Default: 20 每页数量

Responses

Response samples

200

Content type

application/json

{"list": [{"amount": "string",
"client_remark": "string",
"currency": "string",
"icon": "string",
"id": 0,
"order_number": "string",
"remark": "string",
"remittance_name": "string",
"source_trading_account": {"account": "string",
"id": 0,
"server_name": "string",
"server_type": "string"
},
"status": "string",
"submit_time": "string"
}
],
"total": 0
}

获取可用的汇率列表-申请接口

获取可用的汇率列表

query Parameters

page required	integer Default: 1 页码
size required	integer Default: 20 每页数量

Responses

Response samples

200

Content type

application/json

{"list": [{"base_currency": "string",
"exchange_rate": "string",
"quote_currency": "string"
}
],
"total": 0
}

获取可用的出金渠道-申请接口

获取可用的出金渠道

query Parameters

page required	integer Default: 1 页码
size required	integer Default: 20 每页数量

Responses

Response samples

200

Content type

application/json

{"list": [{"account_info": "string",
"allowed_currencies": ["string"
],
"fee": "string",
"icon_url": "string",
"id": 0,
"max_amount": "string",
"method": "string",
"min_amount": "string",
"name": "string"
}
],
"total": 0
}

创建出金申请-申请接口

创建出金申请

Request Body schema: application/json

	object 银行转账信息
	object 加密货币信息
currency required	string 交易货币类型
email_code	string 邮箱验证码
exchange_rate required	string 汇率
fee required	string 手续费
	object 国际电汇信息
method required	string 汇款方式
remark	string 备注
remittance_amount required	string 汇款金额
remittance_id required	integer 汇款id 获取支付方式、最高最低出金，手续费等信息
trading_account_id required	integer 出金交易账号id
withdrawal_amount required	string 出金金额

Responses

Request samples

Payload

Content type

application/json

{"bank_transfer_info": {"account_holder_name": "string",
"bank_country": "string",
"bank_name": "string",
"bank_no": "string",
"branch_name": "string",
"bsc_code": "string"
},
"cryptocurrency_info": {"currency": "string",
"network": "string",
"wallet_address": "string"
},
"currency": "string",
"email_code": "string",
"exchange_rate": "string",
"fee": "string",
"international_wire_info": {"account_holder_name": "string",
"bank_country": "string",
"bank_name": "string",
"bank_no": "string",
"beneficiary_address": "string",
"swift_code": "string"
},
"method": "string",
"remark": "string",
"remittance_amount": "string",
"remittance_id": 0,
"trading_account_id": 0,
"withdrawal_amount": "string"
}

Response samples

200

Content type

application/json

{"order_number": "string"
}

Client用户信息-客户接口

Client用户信息

Responses

Response samples

200

Content type

application/json

{"agreement_status": "filling",
"apply_status": "filling",
"completed_module": ["string"
],
"identity_status": "filling",
"kyc_approved_at": "string",
"kyc_data": {"agreement": [{"key": "string",
"name": "string",
"url": "string"
}
],
"authentication": {"driver_license_back": "string",
"driver_license_front": "string",
"identification_type": "string",
"identity_back": "string",
"identity_front": "string",
"medical_insurance_card": "string",
"passport": "string",
"permanent_card_back": "string",
"permanent_card_front": "string",
"residence_permit_back": "string",
"residence_permit_front": "string"
},
"authentication_accessory": {"address_proof": "string",
"bank_statement": "string",
"selfie": "string"
},
"contact": {"contact_phone": "string",
"mailing_address": "string",
"postal_code": "string",
"residence_province": "string",
"residential_address": "string"
},
"e_verify": {"provider": "string",
"reason_code": "string",
"reason_msg": "string",
"session_id": "string",
"status": "string",
"verified_at": "string"
},
"family": {"emergency_contact_name": "string",
"emergency_contact_phone": "string",
"emergency_contact_relationship": "string",
"home_phone": "string",
"marital_status": "string"
},
"identity": {"birthday": "string",
"country": "string",
"first_name": "string",
"full_name": "string",
"gender": "male",
"last_name": "string"
},
"job": {"company_address": "string",
"company_name": "string",
"industry_attributes": "string",
"position": "string"
},
"questionnaire": [{"answer": null,
"component_type": "string",
"key": "string",
"question": "string",
"question_id": 0,
"questionnaire_id": 0,
"questionnaire_name": "string"
}
]
},
"kyc_status": "filling",
"kyc_way": "string",
"register_datetime": "string"
}

获取Client用户注册模板-客户接口

获取Client用户注册模板

Responses

Response samples

200

Content type

application/json

{"agreement": {"modules": [{"fields": [{"component_type": "string",
"description": "string",
"is_enabled": true,
"is_required": true,
"key": "string",
"name": "string",
"options": [{"label": "string",
"value": "string"
}
],
"sort": 0,
"type": "string",
"value": "string"
}
],
"module": {"key": "identity",
"name": "string"
}
}
],
"status": "filling"
},
"apply_status": "pending",
"e_verify": {"attempt_times": 0,
"code": "string",
"provider": "string",
"retry_times": 0,
"status": "rejected"
},
"identity": {"modules": [{"fields": [{"component_type": "string",
"description": "string",
"is_enabled": true,
"is_required": true,
"key": "string",
"name": "string",
"options": [{"label": "string",
"value": "string"
}
],
"sort": 0,
"type": "string",
"value": "string"
}
],
"module": {"key": "identity",
"name": "string"
}
}
],
"status": "filling"
},
"kyc": {"modules": [{"fields": [{"component_type": "string",
"description": "string",
"is_enabled": true,
"is_required": true,
"key": "string",
"name": "string",
"options": [{"label": "string",
"value": "string"
}
],
"sort": 0,
"type": "string",
"value": "string"
}
],
"module": {"key": "identity",
"name": "string"
}
}
],
"status": "filling"
},
"remark": "string"
}

注册Client用户-客户接口

注册Client用户(Client端接口)

Request Body schema: application/json

email required	string
email_code	string 邮箱验证码
invite_code	string
password required	string

Responses

Request samples

Payload

Content type

application/json

{"email": "string",
"email_code": "string",
"invite_code": "string",
"password": "string"
}

Response samples

200

Content type

application/json

{"token": "string",
"user_info": {"email": "string",
"first_name": "string",
"full_name": "string",
"id": 0,
"last_name": "string",
"user_type": "string"
}
}

保存Client用户身份信息-客户接口

保存Client用户身份信息

Request Body schema: application/json

current_module required	string Enum: "identity" "questionnaire" "family" "contact" "job" "authentication_accessory" "authentication" "agreement" "e_verify" "all" 当前模块: identity: 身份信息, questionnaire: 问卷调查, family: 家庭信息, contact: 联络信息, job: 工作信息, authentication_accessory: 证明文件, authentication: 认证信息, e_verify: 电子验证, all: 全部
required	object 当前需要提交保存的KYC数据, key1: {module_key}, key2: {field_key}

Responses

Request samples

Payload

Content type

application/json

{"current_module": "identity",
"kyc_data": {"property1": {"property1": null,
"property2": null
},
"property2": {"property1": null,
"property2": null
}
}
}

Response samples

200

Content type

application/json

{ }

创建收款账户-申请接口

创建收款账户

Request Body schema: application/json

	object 银行转账信息
	object 加密货币信息
	object 国际电汇信息
payment_method required	string 必填：支付方式 international_wire_transfer\|bank_transfer\|cryptocurrency
remark	string 选填：备注

Responses

Request samples

Payload

Content type

application/json

{"bank_transfer_info": {"bank_country": "string",
"bank_name": "string",
"bank_no": "string",
"branch_name": "string",
"bsc_code": "string"
},
"cryptocurrency_info": {"network": "string",
"wallet_address": "string"
},
"international_wire_info": {"bank_country": "string",
"bank_name": "string",
"bank_no": "string",
"beneficiary_address": "string",
"swift_code": "string"
},
"payment_method": "string",
"remark": "string"
}

Response samples

200

Content type

application/json

{"id": 0
}

删除收款账户-申请接口

删除收款账户

Request Body schema: application/json

id

required

integer

账户ID

Responses

Request samples

Payload

Content type

application/json

{"id": 0
}

Response samples

200

Content type

application/json

{ }

获取收款账户详情-申请接口

获取收款账户详情

query Parameters

id

required

integer

账户ID

Responses

Response samples

200

Content type

application/json

{"account_holder_name": "string",
"bank_transfer_info": {"bank_country": "string",
"bank_name": "string",
"bank_no": "string",
"branch_name": "string",
"bsc_code": "string"
},
"created_at": "string",
"cryptocurrency_info": {"network": "string",
"wallet_address": "string"
},
"id": 0,
"international_wire_info": {"bank_country": "string",
"bank_name": "string",
"bank_no": "string",
"beneficiary_address": "string",
"swift_code": "string"
},
"payment_method": "string",
"remark": "string",
"updated_at": "string"
}

获取收款账户列表-申请接口

获取收款账户列表

query Parameters

payment_method	string 选填：筛选支付方式（international_wire_transfer\|bank_transfer\|cryptocurrency）
start_time	string 选填：创建开始时间（格式：YYYY-MM-DD HH:MM:SS）
end_time	string 选填：创建结束时间（格式：YYYY-MM-DD HH:MM:SS）

Responses

Response samples

200

Content type

application/json

{"bank_transfer": [{"bank_country": "string",
"bank_name": "string",
"bank_no": "string",
"branch_name": "string",
"bsc_code": "string",
"created_at": "string",
"id": 0,
"is_default": true,
"remark": "string"
}
],
"cryptocurrency": [{"created_at": "string",
"id": 0,
"is_default": true,
"network": "string",
"remark": "string",
"wallet_address": "string"
}
],
"international_wire_transfer": [{"bank_country": "string",
"bank_name": "string",
"bank_no": "string",
"beneficiary_address": "string",
"created_at": "string",
"id": 0,
"is_default": true,
"remark": "string",
"swift_code": "string"
}
],
"total": 0
}

更新收款账户-申请接口

更新收款账户

Request Body schema: application/json

	object 银行转账信息（更新时提供）
	object 加密货币信息（更新时提供）
id required	integer 账户ID
	object 国际电汇信息（更新时提供）
is_default	boolean 是否设置为默认账户（true-设为默认，false-取消默认，不传-不修改）
remark	string 备注

Responses

Request samples

Payload

Content type

application/json

{"bank_transfer_info": {"bank_country": "string",
"bank_name": "string",
"bank_no": "string",
"branch_name": "string",
"bsc_code": "string"
},
"cryptocurrency_info": {"network": "string",
"wallet_address": "string"
},
"id": 0,
"international_wire_info": {"bank_country": "string",
"bank_name": "string",
"bank_no": "string",
"beneficiary_address": "string",
"swift_code": "string"
},
"is_default": true,
"remark": "string"
}

Response samples

200

Content type

application/json

{ }

入金报表导出-报表接口

入金报表导出

Request Body schema: application/json

end_time	string 自定义结束时间（格式：YYYY-MM-DD HH:MM:SS）
start_time	string 自定义开始时间（格式：YYYY-MM-DD HH:MM:SS）
status required	string Enum: "all" "auditing" "approved" "disapproved" 状态：all为全部（包含审核中和批准，不批准），auditing为审核中，approved为同意，disapproved为拒绝

Responses

Request samples

Payload

Content type

application/json

{"end_time": "string",
"start_time": "string",
"status": "all"
}

Response samples

200

Content type

application/json

{"download_url": "string"
}

入金报表-报表接口

入金报表

query Parameters

page required	integer Default: 1 页码
size required	integer Default: 20 每页数量
start_time	string 自定义开始时间（格式：YYYY-MM-DD HH:MM:SS）
end_time	string 自定义结束时间（格式：YYYY-MM-DD HH:MM:SS）
status required	string Enum: "all" "auditing" "approved" "disapproved" 状态：all为全部（包含审核中和批准，不批准），auditing为审核中，approved为批准，disapproved为拒绝

Responses

Response samples

200

Content type

application/json

{"list": [{"account": "string",
"amount": "string",
"auditor_name": "string",
"currency": "string",
"fee": "string",
"id": 0,
"method": "string",
"order_number": "string",
"server_name": "string",
"server_type": "string",
"status": "pending",
"submit_time": "string",
"user_name": "string"
}
],
"total": 0
}

导出历史订单报表-报表接口

导出历史订单报表

Request Body schema: application/json

account	string 交易账号
end_time	string 自定义结束时间（格式：YYYY-MM-DD HH:MM:SS）
order_number	string 订单号
page required	integer Default: 1 页码
server_id	integer 交易服务器ID
size required	integer Default: 20 每页数量
start_time	string 自定义开始时间（格式：YYYY-MM-DD HH:MM:SS）
symbol	string 交易品种
time_type	string Default: "open" Enum: "open" "close" 时间类型，open为开仓时间，close为闭仓时间
trading_account_id	integer 交易账号的业务ID
trading_type required	string Enum: "all" "BUY" "SELL" 交易类型

Responses

Request samples

Payload

Content type

application/json

{"account": "string",
"end_time": "string",
"order_number": "string",
"page": 1,
"server_id": 0,
"size": 20,
"start_time": "string",
"symbol": "string",
"time_type": "open",
"trading_account_id": 0,
"trading_type": "all"
}

Response samples

200

Content type

application/json

{"download_url": "string"
}

查询历史订单报表-报表接口

查询历史订单报表

query Parameters

page required	integer Default: 1 页码
size required	integer Default: 20 每页数量
start_time	string 自定义开始时间（格式：YYYY-MM-DD HH:MM:SS）
end_time	string 自定义结束时间（格式：YYYY-MM-DD HH:MM:SS）
time_type	string Default: "open" Enum: "open" "close" 时间类型，open为开仓时间，close为闭仓时间
order_number	string 订单号
account	string 交易账号
trading_type required	string Enum: "all" "BUY" "SELL" 交易类型
symbol	string 交易品种
server_id	integer 交易服务器ID
trading_account_id	integer 交易账号的业务ID

Responses

Response samples

200

Content type

application/json

{"list": [{"close_price": "string",
"close_time": "string",
"commission": "string",
"currency": "USD",
"open_price": "string",
"open_time": "string",
"order_number": "string",
"profit": "string",
"sl": "string",
"swap": "string",
"symbol": "string",
"tp": "string",
"trading_account": {"account": "string",
"id": 0,
"server_name": "string",
"server_type": "MT4-Live"
},
"trading_type": "BUY",
"user_name": "string",
"volume": "string"
}
],
"total": 0
}

导出持仓报表-报表接口

导出持仓报表

Request Body schema: application/json

account	string 交易账号
end_time	string 自定义结束时间（格式：YYYY-MM-DD HH:MM:SS）
order_number	string 订单号
page required	integer Default: 1 页码
server_id	integer 交易服务器ID
size required	integer Default: 20 每页数量
start_time	string 自定义开始时间（格式：YYYY-MM-DD HH:MM:SS）
symbol	string 交易品种
trading_account_id	integer 交易账号的业务ID
trading_type required	string Enum: "all" "BUY" "SELL" 交易类型

Responses

Request samples

Payload

Content type

application/json

{"account": "string",
"end_time": "string",
"order_number": "string",
"page": 1,
"server_id": 0,
"size": 20,
"start_time": "string",
"symbol": "string",
"trading_account_id": 0,
"trading_type": "all"
}

Response samples

200

Content type

application/json

{"download_url": "string"
}

查询持仓报表-报表接口

查询持仓报表

query Parameters

page required	integer Default: 1 页码
size required	integer Default: 20 每页数量
start_time	string 自定义开始时间（格式：YYYY-MM-DD HH:MM:SS）
end_time	string 自定义结束时间（格式：YYYY-MM-DD HH:MM:SS）
order_number	string 订单号
account	string 交易账号
trading_type required	string Enum: "all" "BUY" "SELL" 交易类型
symbol	string 交易品种
server_id	integer 交易服务器ID
trading_account_id	integer 交易账号的业务ID

Responses

Response samples

200

Content type

application/json

{"list": [{"close_price": "string",
"commission": "string",
"currency": "USD",
"leverage": 0,
"open_price": "string",
"open_time": "string",
"order_number": "string",
"profit": "string",
"sl": "string",
"swap": "string",
"symbol": "string",
"tp": "string",
"trading_account": {"account": "string",
"id": 0,
"server_name": "string",
"server_type": "MT4-Live"
},
"trading_type": "BUY",
"user_name": "string",
"volume": "string"
}
],
"total": 0
}

导出挂单报表-报表接口

导出挂单报表

Request Body schema: application/json

account	string 交易账号
end_time	string 自定义结束时间（格式：YYYY-MM-DD HH:MM:SS）
order_number	string 订单号
page required	integer Default: 1 页码
server_id	integer 交易服务器ID
size required	integer Default: 20 每页数量
start_time	string 自定义开始时间（格式：YYYY-MM-DD HH:MM:SS）
symbol	string 交易品种
trading_account_id	integer 交易账号的业务ID
trading_type required	string Enum: "all" "BUY_LIMIT" "SELL_LIMIT" "BUY_STOP" "SELL_STOP" "BUY_STOP_LIMIT" "SELL_STOP_LIMIT" 交易类型

Responses

Request samples

Payload

Content type

application/json

{"account": "string",
"end_time": "string",
"order_number": "string",
"page": 1,
"server_id": 0,
"size": 20,
"start_time": "string",
"symbol": "string",
"trading_account_id": 0,
"trading_type": "all"
}

Response samples

200

Content type

application/json

{"download_url": "string"
}

查询挂单报表-报表接口

查询挂单报表

query Parameters

page required	integer Default: 1 页码
size required	integer Default: 20 每页数量
start_time	string 自定义开始时间（格式：YYYY-MM-DD HH:MM:SS）
end_time	string 自定义结束时间（格式：YYYY-MM-DD HH:MM:SS）
order_number	string 订单号
account	string 交易账号
trading_type required	string Enum: "all" "BUY_LIMIT" "SELL_LIMIT" "BUY_STOP" "SELL_STOP" "BUY_STOP_LIMIT" "SELL_STOP_LIMIT" 交易类型
symbol	string 交易品种
server_id	integer 交易服务器ID
trading_account_id	integer 交易账号的业务ID

Responses

Response samples

200

Content type

application/json

{"list": [{"currency": "USD",
"order_number": "string",
"pending_price": "string",
"pending_time": "string",
"sl": "string",
"symbol": "string",
"tp": "string",
"trading_account": {"account": "string",
"id": 0,
"server_name": "string",
"server_type": "MT4-Live"
},
"trading_type": "all",
"user_name": "string",
"volume": "string"
}
],
"total": 0
}

获取交易服务器选项列表-报表接口

获取交易服务器选项列表

query Parameters

order_type

required

string

Enum: "holding" "history" "pending"

订单类型

Responses

Response samples

200

Content type

application/json

{"list": [{"connect_status": "pending",
"id": 0,
"name": "string",
"type": "MT4-Demo"
}
],
"total": 0
}

查询用户交易过的品种列表-报表接口

查询用户交易过的品种列表

query Parameters

order_type required	string Enum: "holding" "history" "pending" 订单类型
server_id	integer

Responses

Response samples

200

Content type

application/json

{"list": ["string"
],
"total": 0
}

导出转账报表-报表接口

导出转账报表

Request Body schema: application/json

end_time	string 自定义结束时间（格式：YYYY-MM-DD HH:MM:SS）
order_number	string 订单号
page required	integer Default: 1 页码
size required	integer Default: 20 每页数量
start_time	string 自定义开始时间（格式：YYYY-MM-DD HH:MM:SS）
status required	string Enum: "all" "pending" "auditing" "approved" "disapproved" 审核状态：all为全部，pending为待审核，auditing为审核中，approved为批准，disapproved为拒绝

Responses

Request samples

Payload

Content type

application/json

{"end_time": "string",
"order_number": "string",
"page": 1,
"size": 20,
"start_time": "string",
"status": "all"
}

Response samples

200

Content type

application/json

{"download_url": "string"
}

查询转账报表-报表接口

查询转账报表

query Parameters

page required	integer Default: 1 页码
size required	integer Default: 20 每页数量
start_time	string 自定义开始时间（格式：YYYY-MM-DD HH:MM:SS）
end_time	string 自定义结束时间（格式：YYYY-MM-DD HH:MM:SS）
order_number	string 订单号
status required	string Enum: "all" "pending" "auditing" "approved" "disapproved" 审核状态：all为全部，pending为待审核，auditing为审核中，approved为批准，disapproved为拒绝

Responses

Response samples

200

Content type

application/json

{"list": [{"amount": "string",
"currency": "string",
"order_number": "string",
"source_trading_account": {"account": "string",
"id": 0,
"server_name": "string",
"server_type": "MT4-Live"
},
"status": "pending",
"submit_time": "string",
"target_trading_account": {"account": "string",
"id": 0,
"server_name": "string",
"server_type": "MT4-Live"
},
"user_name": "string"
}
],
"total": 0
}

申请交易账号-用户ID从token获取-交易接口

申请交易账号-用户ID从token获取

Request Body schema: application/json

currency required	string Value: "USD" 账户货币，目前只支持USD
is_demo required	boolean 是否为模拟账户
leverage required	integer 账户杠杆
observe_password	string 观摩密码
password required	string 交易密码
trading_account_type_id required	integer 交易账号类型ID
trading_platform required	string Enum: "MT4" "MT5" 交易平台，目前仅支持MT4

Responses

Request samples

Payload

Content type

application/json

{"currency": "USD",
"is_demo": true,
"leverage": 0,
"observe_password": "string",
"password": "string",
"trading_account_type_id": 0,
"trading_platform": "MT4"
}

Response samples

200

Content type

application/json

{"id": 0
}

查询交易账号-交易接口

查询交易账号

query Parameters

id

required

integer

交易账户的业务ID

Responses

Response samples

200

Content type

application/json

{"account": "string",
"balance": "string",
"credit": "string",
"currency": "USD",
"equity": "string",
"id": 0,
"is_demo": true,
"leverage": 0,
"observe_password": "string",
"password": "string",
"server_name": "string",
"trading_account_type_name": "string",
"trading_platform": "MT4"
}

查询是否允许开通模拟账户-交易接口

查询是否允许开通模拟账户

Responses

Response samples

200

Content type

application/json

{"enabled": true
}

查询交易账户可用杠杆-交易接口

查询交易账户可用杠杆

query Parameters

id

required

integer

交易账户的业务ID

Responses

Response samples

200

Content type

application/json

{"leverage_options": [0
]
}

查询交易账号杠杆更新状态-交易接口

查询交易账号杠杆更新状态

query Parameters

id

required

integer

交易账号的业务ID

Responses

Response samples

200

Content type

application/json

{"audit_id": 0,
"audit_status": "string"
}

查询可用交易账号类型列表-通过token获取用户ID匹配注册流程再查询-交易接口

查询可用交易账号类型列表-通过token获取用户ID匹配注册流程再查询

query Parameters

page required	integer Default: 1 页码
size required	integer Default: 20 每页数量
is_demo	boolean
trading_platform required	string Enum: "MT4" "MT5" 交易平台

Responses

Response samples

200

Content type

application/json

{"list": [{"id": 0,
"leverage_options": [{"id": 0,
"value": 0
}
],
"name": "string"
}
],
"total": 0
}

查询交易账号列表-交易接口

查询交易账号列表

query Parameters

page required	integer Default: 1 页码
size required	integer Default: 20 每页数量
is_demo	boolean 是否为模拟账户

Responses

Response samples

200

Content type

application/json

{"list": [{"account": "string",
"balance": "string",
"credit": "string",
"currency": "USD",
"equity": "string",
"id": 0,
"is_demo": true,
"leverage": 0,
"observe_password": "string",
"password": "string",
"server_name": "string",
"trading_account_type_name": "string",
"trading_platform": "MT4"
}
],
"total": 0
}

查询交易账号选项列表-交易接口

查询交易账号选项列表

Responses

Response samples

200

Content type

application/json

{"list": [{"account": "string",
"id": 0,
"server_name": "string",
"server_type": "MT4-Live"
}
],
"total": 0
}

获取可用交易平台选项列表-交易接口

获取可用交易平台选项列表

Responses

Response samples

200

Content type

application/json

{"list": ["string"
],
"total": 0
}

更新交易账号杠杆-交易接口

更新交易账号杠杆

Request Body schema: application/json

id required	integer 交易账号的业务ID
leverage required	integer 杠杆
remark required	string 注释

Responses

Request samples

Payload

Content type

application/json

{"id": 0,
"leverage": 0,
"remark": "string"
}

Response samples

200

Content type

application/json

{ }

更新交易账号密码-交易接口

更新交易账号密码

Request Body schema: application/json

id required	integer 交易账号的业务ID
password required	string 密码
type required	string Enum: "observe" "trade" 密码类型：observe表示只读密码，trade表示交易密码

Responses

Request samples

Payload

Content type

application/json

{"id": 0,
"password": "string",
"type": "observe"
}

Response samples

200

Content type

application/json

{ }

检查当前用户是否有待审核的出金订单-交易接口

检查当前用户是否有待审核的出金订单

Responses

Response samples

200

Content type

application/json

{"has_pending": true
}

IB接口(19)

IB的Client详情-代理接口

IB的Client详情

query Parameters

client_user_id

required

integer

客户用户id

Responses

Response samples

200

Content type

application/json

{"agreement_status": "filling",
"apply_status": "filling",
"completed_module": ["string"
],
"identity_status": "filling",
"kyc_approved_at": "string",
"kyc_data": {"agreement": [{"key": "string",
"name": "string",
"url": "string"
}
],
"authentication": {"driver_license_back": "string",
"driver_license_front": "string",
"identification_type": "string",
"identity_back": "string",
"identity_front": "string",
"medical_insurance_card": "string",
"passport": "string",
"permanent_card_back": "string",
"permanent_card_front": "string",
"residence_permit_back": "string",
"residence_permit_front": "string"
},
"authentication_accessory": {"address_proof": "string",
"bank_statement": "string",
"selfie": "string"
},
"contact": {"contact_phone": "string",
"mailing_address": "string",
"postal_code": "string",
"residence_province": "string",
"residential_address": "string"
},
"e_verify": {"provider": "string",
"reason_code": "string",
"reason_msg": "string",
"session_id": "string",
"status": "string",
"verified_at": "string"
},
"family": {"emergency_contact_name": "string",
"emergency_contact_phone": "string",
"emergency_contact_relationship": "string",
"home_phone": "string",
"marital_status": "string"
},
"identity": {"birthday": "string",
"country": "string",
"first_name": "string",
"full_name": "string",
"gender": "male",
"last_name": "string"
},
"job": {"company_address": "string",
"company_name": "string",
"industry_attributes": "string",
"position": "string"
},
"questionnaire": [{"answer": null,
"component_type": "string",
"key": "string",
"question": "string",
"question_id": 0,
"questionnaire_id": 0,
"questionnaire_name": "string"
}
]
},
"kyc_status": "filling",
"kyc_way": "string",
"register_datetime": "string"
}

IB的Client列表-代理接口

IB的Client列表

query Parameters

page required	integer Default: 1 页码
size required	integer Default: 20 每页数量
client_user_id	integer 客户用户ID
kyc_status	string Enum: "approved" "disapproved" KYC认证状态: approved: 已验证, disapproved: 未验证
status	string Enum: "enabled" "disabled" 用户状态: enabled: 启用, disabled: 禁用
email	string 邮箱（模糊查询）
client_name	string 姓名（模糊查询）

Responses

Response samples

200

Content type

application/json

{"list": [{"account": "string",
"client_id": 0,
"client_user_id": 0,
"created_at": "string",
"email": "string",
"first_name": "string",
"full_name": "string",
"kyc_status": "string",
"last_name": "string",
"latest_trade_time": "string",
"source": "string",
"status": "string",
"updated_at": "string"
}
],
"total": 0
}

IB端-面板数据-仪表盘接口

IB端-面板数据

query Parameters

date_type

string

日期类型

Responses

Response samples

200

Content type

application/json

{"cards": {"property1": null,
"property2": null
}
}

IB端-面板数据-获取最后更新时间-仪表盘接口

IB端-面板数据-获取最后更新时间

Responses

Response samples

200

Content type

application/json

{"last_update_time": "string"
}

ib查看返佣记录-资金接口

ib查看返佣记录

query Parameters

page required	integer Default: 1 页码
size required	integer Default: 20 每页数量

Responses

Response samples

200

Content type

application/json

{"list": [{"client_user_id": 0,
"client_user_name": 0,
"ib_user_id": 0,
"ib_user_name": 0,
"open_time": "string",
"payment_time": "string",
"rebate_id": 0,
"rebate_type": "string",
"settlement_time": "string",
"symbol": "string",
"trade_profit": 0
}
],
"total": 0
}

消息详情-消息中心

消息详情

query Parameters

id

required

integer

消息ID

Responses

Response samples

200

Content type

application/json

{"content": "string",
"created_at": "string",
"id": 0,
"sender": "string",
"title": "string"
}

隐藏消息-消息中心

隐藏消息

Request Body schema: application/json

id

required

integer

消息ID

Responses

Request samples

Payload

Content type

application/json

{"id": 0
}

Response samples

200

Content type

application/json

{ }

消息列表-消息中心

消息列表

query Parameters

page required	integer Default: 1 页码
size required	integer Default: 20 每页数量

Responses

Response samples

200

Content type

application/json

{"list": [{"created_at": "string",
"id": 0,
"is_read": true,
"sender": "string",
"title": "string"
}
],
"total": 0
}

标记消息已读-消息中心

标记消息已读

Request Body schema: application/json

id

required

integer

消息ID

Responses

Request samples

Payload

Content type

application/json

{"id": 0
}

Response samples

200

Content type

application/json

{ }

获取未读消息数量-消息中心

获取未读消息数量

Responses

Response samples

200

Content type

application/json

{"count": 0
}

查询返佣账号列表-代理接口

查询返佣账号列表

query Parameters

page required	integer Default: 1 页码
size required	integer Default: 20 每页数量
account_id	string 交易账户在MT4的ID

Responses

Response samples

200

Content type

application/json

{"list": [{"account_id": "string",
"balance": "string",
"enabled": true,
"id": 0
}
],
"total": 0
}

更改返佣账户权限-代理接口

更改返佣账户权限

Request Body schema: application/json

enabled required	boolean 是否启用权限
id required	integer 交易账户的业务ID

Responses

Request samples

Payload

Content type

application/json

{"enabled": true,
"id": 0
}

Response samples

200

Content type

application/json

{"account": "string"
}

获取软件下载工具列表-代理接口

获取软件下载工具列表

Responses

Response samples

200

Content type

application/json

{"list": [{"android_download_url": "string",
"created_at": "string",
"description": "string",
"icon_url": "string",
"id": 0,
"ios_download_url": "string",
"logo_url": "string",
"macos_download_url": "string",
"name": "string",
"updated_at": "string",
"windows_download_url": "string"
}
],
"total": 0
}

查询客户交易账户列表-代理接口

查询客户交易账户列表

query Parameters

page required	integer Default: 1 页码
size required	integer Default: 20 每页数量
user_name	string 姓名
account_id	string 交易账户在MT4的ID
trading_account_type_name	string 交易账号类型名称

Responses

Response samples

200

Content type

application/json

{"list": [{"account_id": "string",
"balance": "string",
"credit": "string",
"equity": "string",
"id": 0,
"leverage": 0,
"margin_level": "string",
"trading_account_type_name": "string",
"trading_platform": "string",
"trading_server_name": "string",
"user_name": "string"
}
],
"total": 0
}

获取IB用户信息-代理接口

获取IB用户信息

Responses

Response samples

200

Content type

application/json

{"QRCodeURL": "string",
"ReferralCode": "string",
"ReferralLink": "string",
"agreement_status": "filling",
"apply_status": "filling",
"completed_module": ["string"
],
"identity_status": "filling",
"kyc_approved_at": "string",
"kyc_data": {"agreement": [{"key": "string",
"name": "string",
"url": "string"
}
],
"authentication": {"driver_license_back": "string",
"driver_license_front": "string",
"identification_type": "string",
"identity_back": "string",
"identity_front": "string",
"medical_insurance_card": "string",
"passport": "string",
"permanent_card_back": "string",
"permanent_card_front": "string",
"residence_permit_back": "string",
"residence_permit_front": "string"
},
"authentication_accessory": {"address_proof": "string",
"bank_statement": "string",
"selfie": "string"
},
"contact": {"contact_phone": "string",
"mailing_address": "string",
"postal_code": "string",
"residence_province": "string",
"residential_address": "string"
},
"e_verify": {"provider": "string",
"reason_code": "string",
"reason_msg": "string",
"session_id": "string",
"status": "string",
"verified_at": "string"
},
"family": {"emergency_contact_name": "string",
"emergency_contact_phone": "string",
"emergency_contact_relationship": "string",
"home_phone": "string",
"marital_status": "string"
},
"identity": {"birthday": "string",
"country": "string",
"first_name": "string",
"full_name": "string",
"gender": "male",
"last_name": "string"
},
"job": {"company_address": "string",
"company_name": "string",
"industry_attributes": "string",
"position": "string"
},
"questionnaire": [{"answer": null,
"component_type": "string",
"key": "string",
"question": "string",
"question_id": 0,
"questionnaire_id": 0,
"questionnaire_name": "string"
}
]
},
"kyc_status": "filling",
"kyc_way": "string",
"register_datetime": "string"
}

导出佣金明细报表-报表接口

导出佣金明细报表

Request Body schema: application/json

client_user_name	string 客户用户名
end_time	string 结束日期 (格式: YYYY-MM-DD)
rebate_aggregation_id	string
start_time	string 开始日期 (格式: YYYY-MM-DD)
time_search_type	string Enum: "calculate_at" "grant_at"

Responses

Request samples

Payload

Content type

application/json

{"client_user_name": "string",
"end_time": "string",
"rebate_aggregation_id": "string",
"start_time": "string",
"time_search_type": "calculate_at"
}

Response samples

200

Content type

application/json

{"download_url": "string"
}

查询佣金明细报表-报表接口

查询佣金明细报表

query Parameters

page required	integer Default: 1 页码
size required	integer Default: 20 每页数量
rebate_aggregation_id	integer
time_search_type	string Enum: "calculate_at" "grant_at"
start_time	string 开始日期 (格式: YYYY-MM-DD)
end_time	string 结束日期 (格式: YYYY-MM-DD)
client_user_name	string 客户用户名

Responses

Response samples

200

Content type

application/json

{"list": [{"amount": "string",
"calculate_at": "string",
"client_user_name": "string",
"close_price": "string",
"currency": "string",
"grant_at": "string",
"ib_user_name": "string",
"mt_order_number": "string",
"open_price": "string",
"order_number": "string",
"profit": "string",
"sub_ib_user_name": "string",
"symbol": "string",
"trigger_event": "string",
"volume": 0
}
],
"total": 0
}

导出佣金报表-报表接口

导出佣金报表

Request Body schema: application/json

end_time	string 自定义结束时间 (格式: YYYY-MM-DD HH:MM:SS)
start_time	string 自定义开始时间 (格式: YYYY-MM-DD HH:MM:SS)
time_search_type	string Enum: "calculate_at" "grant_at"

Responses

Request samples

Payload

Content type

application/json

{"end_time": "string",
"start_time": "string",
"time_search_type": "calculate_at"
}

Response samples

200

Content type

application/json

{"download_url": "string"
}

查询佣金报表-报表接口

查询佣金报表

query Parameters

page required	integer Default: 1 页码
size required	integer Default: 20 每页数量
time_search_type	string Enum: "calculate_at" "grant_at"
start_time	string 自定义开始时间 (格式: YYYY-MM-DD HH:MM:SS)
end_time	string 自定义结束时间 (格式: YYYY-MM-DD HH:MM:SS)

Responses

Response samples

200

Content type

application/json

{"list": [{"calculate_at": "string",
"currency": "string",
"grant_at": "string",
"id": 0,
"login_id": "string",
"order_number": "string",
"total_amount": "string",
"total_orders": 0,
"user_email": "string",
"user_name": "string"
}
],
"total": 0
}