openapi: 3.1.0 info: title: Defi-ClientAPI-EN description: >- Client H5/PCUI access API, this API can realize the business's custom transaction client version: 1.0.0 tags: - name: Basic - name: Customer - name: Customer/Basic - name: Customer/Social - name: Customer/Auth - name: Customer/Bank Card - name: Customer/Extended - name: Customer/Products - name: Customer/Wallet - name: Customer/Verification - name: Customer/KYC - name: Customer/Open API - name: Message - name: Funds - name: Funds/Deposit - name: Funds/Proposal - name: Funds/Rate - name: Funds/Withdrawal - name: Trade - name: Trade/Full Margin Contract - name: Trade/Isolated Margin Contract - name: Trade/Leveraged - name: Trade/Spot - name: Trade/Stock paths: /: head: summary: Global Unified Request Header deprecated: false description: '' operationId: updateLoginPwd tags: - Basic parameters: - name: companyId in: header description: '' required: true example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: 'Default Value: en-US' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string - name: group in: header description: '' required: false example: '' schema: type: string - name: idempotency-key in: header description: >- Idempotent Processing Logic: If there is an idempotency-key in the request header, the interface return information will be cached, valid for 24 hours. For subsequent requests with the same idempotency-key, same bizType, version, group, companyId, within the valid period, the cached result will be directly obtained. If there are concurrent requests, only one request will be allowed, and the rest will return 'request frequency too fast, please try again later'. required: false example: '' schema: type: string responses: '200': description: '' content: application/json: schema: type: string headers: {} security: [] /geoip/country: get: summary: Get country information based on IP deprecated: false description: IP country query, accessible to visitors tags: - Basic parameters: - name: companyId in: header description: '' required: true example: '{{company}}' schema: type: string - name: trace in: header description: '' required: true example: '{{mock_trace}}' schema: type: string - name: lang in: header description: '' required: true example: zh-CN schema: type: string responses: '200': description: '' content: application/json: schema: type: object properties: code: type: string description: System common return codes. 0-Success, other exceptions msg: type: string description: Return information bizCode: type: string description: Module identifier code tm: type: string description: Processing time (milliseconds) trace: type: string description: Global link flag information msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: object properties: iso_code: type: string description: Country code name: type: string description: Name request_ip: type: string description: Request IP required: - iso_code - name - request_ip description: Country information required: - code - msg - bizCode - tm - trace - msgParams - data headers: {} security: [] /thirdExt/now: post: summary: Get current service time deprecated: false description: Get current service time tags: - Basic parameters: - name: companyId in: header description: '' required: true example: '{{company}}' schema: type: string - name: trace in: header description: '' required: true example: '{{mock_trace}}' schema: type: string - name: lang in: header description: '' required: true example: zh-CN schema: type: string responses: '200': description: '' content: application/json: schema: type: object properties: code: type: string description: System common return codes. 0-Success, other exceptions msg: type: string description: Return information bizCode: type: string description: Module identifier code tm: type: string description: Processing time (milliseconds) trace: type: string description: Global link flag information msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: description: Timestamp, 13 digits type: integer required: - code - msg - bizCode - tm - trace - msgParams - data examples: '1': summary: Success example value: bizCode: '' code: '0' msg: Success tm: 0 trace: '' msgParams: null data: 1678426706212 ok: true fail: false headers: {} security: [] /global/config.app.AppAssetsDubboService.getAssetsList: post: summary: Asset code data deprecated: false description: | bizType=config.app.AppAssetsDubboService.getAssetsList Get all asset list data supported by the platform operationId: getAssetsList tags: - Basic parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string requestBody: content: application/json: schema: type: object properties: type: type: integer format: int32 description: >- Asset type 0, all assets 1, common assets 2, fund assets default 0 example: '' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/BaseResultListAssets' headers: {} security: [] /global/config.app.AppDictDubboService.getListByParentId: post: summary: Dictionary query based on ID deprecated: false description: |- bizType=config.app.AppDictDubboService.getListByParentId Dictionary query based on parentId Accessible to visitors operationId: getListByParentId tags: - Basic parameters: - name: companyId in: header description: '' required: true example: '{{company}}' schema: type: string - name: trace in: header description: '' required: true example: '{{mock_trace}}' schema: type: string - name: lang in: header description: '' required: true example: zh-CN schema: type: string requestBody: content: application/json: schema: type: object properties: parentId: type: integer description: Parent ID required: - parentId example: parentId: '1' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: array description: Data Body items: type: object properties: parentId: type: integer format: int64 description: Superior ID id: type: integer format: int64 description: Primary key id name: type: string description: Dictionary name displayName: type: string description: Display name (display this field on the front end) code: type: string description: Dictionary code parentCode: type: string description: Parent code sort: type: integer format: int32 description: Sort showType: type: string description: Dictionary display type extend: type: string description: Extended attribute status: type: integer format: int32 description: Status 1, 2, 3, enable, disable, delete createTime: type: integer format: int64 description: Creation time updateTime: type: integer format: int64 description: Update Time hasLeaf: type: integer format: int32 description: Whether there are child nodes ok: type: boolean fail: type: boolean examples: '1': summary: Success example value: msg: Success fail: false trace: x-r62nh7-n75987-jljj4-43kv-1677554114 code: '0' data: - code: Blockchain_explorer_txid displayName: Blockchain network address updateTime: 1676458887694 sort: 1 nameEn: null parentId: 0 revision: 1 extend: Blockchain_explorer_txid nameTw: null createBy: admin createTime: 1676450014034 updateBy: admin parentCode: '0' name: Blockchain network address showType: null id: 1274 hasLeaf: 1 status: 1 bizCode: '' tm: 5 msgParams: null ok: true headers: {} security: [] /global/config.app.AppDictDubboService.getListByParentCode: post: summary: Dictionary query based on code deprecated: false description: |- bizType=config.app.AppDictDubboService.getListByParentCode Dictionary query based on code Guest access operationId: getListByParentCode tags: - Basic parameters: - name: companyId in: header description: '' required: true example: '{{company}}' schema: type: string - name: trace in: header description: '' required: true example: '{{mock_trace}}' schema: type: string - name: lang in: header description: '' required: true example: zh-CN schema: type: string requestBody: content: application/json: schema: type: object properties: parentCode: type: string description: Dictionary code required: - parentCode example: parentCode: USDT responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: array description: Data Body items: type: object properties: parentId: type: integer format: int64 description: Superior ID id: type: integer format: int64 description: Primary key id name: type: string description: Dictionary name displayName: type: string description: Display name (frontend display) code: type: string description: Dictionary code parentCode: type: string description: Parent code sort: type: integer format: int32 description: Sort showType: type: string description: Dictionary display type extend: type: string description: Extended attribute status: type: integer format: int32 description: Status 1, 2, 3, enable, disable, delete createTime: type: integer format: int64 description: Creation time updateTime: type: integer format: int64 description: Update Time hasLeaf: type: integer format: int32 description: Whether there are child nodes ok: type: boolean fail: type: boolean examples: '1': summary: Success example value: msg: Success fail: false trace: x-484ynk7-j6o8-t3kglk-yiv7i-1677742871 code: '0' data: - code: Tron(TRC20) displayName: Tron updateTime: 1675995340948 sort: 1 nameEn: null parentId: 469 revision: 5 extend: '' nameTw: null createBy: admin createTime: 1673440493544 parentCode: USDT updateBy: admin name: Tron showType: null id: 1300 hasLeaf: 0 status: 1 bizCode: '' tm: 3 msgParams: null ok: true headers: {} security: [] /global/config.app.AppDictDubboService.getMapByParentCodes: post: summary: Batch query based on Code dictionary deprecated: false description: |- bizType=config.app.AppDictDubboService.getMapByParentCodes Batch get dictionary data operationId: getListByParentId tags: - Basic parameters: - name: companyId in: header description: Company ID, obtained through environment variables required: true example: '{{company}}' schema: type: string - name: trace in: header description: Random Tracking Code UUID required: true example: '{{mock_trace}}' schema: type: string - name: token in: header description: Login Token required: true example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: Language required: true example: zh-CN schema: type: string requestBody: content: application/json: schema: type: object properties: parentCode: description: Dictionary codes, separated by commas type: string required: - parentCode example: parentId: '1' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: object properties: code: type: array items: &ref_4 $ref: '#/components/schemas/DictVO' description: Dictionary item list description: Dictionary code required: - code description: Data Body ok: type: boolean fail: type: boolean required: - data examples: '1': summary: Success example value: msg: Success fail: false trace: x-r62nh7-n75987-jljj4-43kv-1677554114 code: '0' data: - code: Blockchain_explorer_txid displayName: Blockchain network address updateTime: 1676458887694 sort: 1 nameEn: null parentId: 0 revision: 1 extend: Blockchain_explorer_txid nameTw: null createBy: admin createTime: 1676450014034 updateBy: admin parentCode: '0' name: Blockchain network address showType: null id: 1274 hasLeaf: 1 status: 1 bizCode: '' tm: 5 msgParams: null ok: true headers: {} security: [] /global/config.app.AppDictDubboService.getCountryListByParentId: post: summary: Country/Region query based on ID deprecated: false description: |- bizType=config.app.AppDictDubboService.getCountryListByParentId Country/Region query based on ID Accessible to visitors operationId: getCountryListByParentId tags: - Basic parameters: - name: companyId in: header description: '' required: true example: '{{company}}' schema: type: string - name: trace in: header description: '' required: true example: '{{mock_trace}}' schema: type: string - name: lang in: header description: '' required: true example: zh-CN schema: type: string requestBody: content: application/json: schema: type: object properties: parentId: type: string description: Parent ID required: - parentId example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: array description: Data Body items: type: object properties: parentId: type: integer format: int64 description: Superior ID id: type: integer format: int64 description: Primary key id name: type: string description: Country/Region name displayName: type: string description: Display name (frontend display) code: type: string description: Country code parentCode: type: string description: Parent code nationalCode: type: string description: Country abbreviation countryCode: type: string description: Country area code extend: type: string description: Extended attribute sort: type: integer format: int32 description: Sort status: type: integer format: int32 description: Status 1, 2, 3, enable, disable, delete createTime: type: integer format: int64 description: Creation time updateTime: type: integer format: int64 description: Update Time hasLeaf: type: integer format: int32 description: Whether there are child nodes childs: type: array description: Subnode data items: &ref_0 $ref: '#/components/schemas/CountryDictVo' ok: type: boolean fail: type: boolean headers: {} security: [] /global/config.app.AppDictDubboService.getCountryListByParentCode: post: summary: Query country/region based on code deprecated: false description: |- bizType=config.app.AppDictDubboService.getCountryListByParentCode Query country/region based on code Accessible to visitors operationId: getCountryListByParentCode tags: - Basic parameters: - name: companyId in: header description: '' required: true example: '{{company}}' schema: type: string - name: trace in: header description: '' required: true example: '{{mock_trace}}' schema: type: string - name: lang in: header description: '' required: true example: zh-CN schema: type: string requestBody: content: application/json: schema: type: object properties: parentCode: type: string description: Country code name: type: string description: Name, can be searched required: - parentCode example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: array description: Data Body items: type: object properties: parentId: type: integer format: int64 description: Superior ID id: type: integer format: int64 description: Primary key id name: type: string description: Country/Region name displayName: type: string description: Display name (frontend display) code: type: string description: Country code parentCode: type: string description: Parent code nationalCode: type: string description: Country abbreviation countryCode: type: string description: Country area code extend: type: string description: Extended attribute sort: type: integer format: int32 description: Sort status: type: integer format: int32 description: Status 1, 2, 3, enable, disable, delete createTime: type: integer format: int64 description: Creation time updateTime: type: integer format: int64 description: Update Time hasLeaf: type: integer format: int32 description: Whether there are child nodes childs: type: array description: Subnode data items: *ref_0 ok: type: boolean fail: type: boolean headers: {} security: [] /global/config.app.AppSymbolDubboService.getSymbolList: post: summary: Product Basic Data deprecated: false description: >- bizType=config.app.AppSymbolDubboService.getSymbolList Query basic product information, support customer group and product name/code fuzzy query Guest access available operationId: getSymbolList tags: - Basic parameters: - name: companyId in: header description: '' required: true example: '{{company}}' schema: type: string - name: trace in: header description: '' required: true example: '{{mock_trace}}' schema: type: string - name: lang in: header description: '' required: true example: zh-CN schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string requestBody: content: application/json: schema: type: object properties: tradeType: type: integer format: int64 description: Game ID customerGroupId: type: integer format: int64 description: Client group ID name: type: string description: Product Name or Code required: - tradeType - customerGroupId example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: array description: Data Body items: type: object properties: id: type: integer format: int64 description: Primary key id status: type: integer format: int32 description: Status 1, 2, 3, enable, disable, delete name: type: string description: Trading Product Name code: type: string description: Trading Product Code baseCurrency: type: string description: Base Currency profitCurrency: type: string description: Profit Currency sourceId: type: string description: Market Source tradeTypes: type: string description: Support Play Array ok: type: boolean fail: type: boolean examples: '1': summary: Guest_Success_Example value: msg: Success fail: false trace: x-6320jq-ngjyr-99cmjy51-y7q16p-1677564664 code: '0' data: - sourceId: UNISWAP_V3_USDC_WETH code: USDC_WETH tradeTypes: null etf: false name: USDC_WETH profitCurrency: ETH id: 6327 baseCurrency: USDC status: 1 bizCode: '' tm: 4 msgParams: null ok: true headers: {} security: [] /global/config.app.AppSymbolDubboService.getSymbolBaseList: post: summary: Brief Product Data deprecated: false description: >- bizType=config.app.AppSymbolDubboService.getSymbolBaseList Query product information, including basic products and brief trading parameters, such as decimal places, deal modes, etc. Visitors can access operationId: getSymbolBaseList tags: - Basic parameters: - name: companyId in: header description: Company ID, obtained through environment variables required: true example: '{{company}}' schema: type: string - name: trace in: header description: Random Tracking Code UUID required: true example: '{{mock_trace}}' schema: type: string - name: token in: header description: Login Token required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: Language required: true example: zh-CN schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SearchSymbolBaseDto' example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: array description: Data Body items: type: object properties: tradeType: type: integer format: int64 description: Gameplay symbolId: type: integer format: int64 description: Product ID symbolCode: type: string description: Product Code symbolName: type: string description: Product name baseCurrency: type: string description: Base Currency profitCurrency: type: string description: Profit Currency customerGroupIds: type: string description: Client Group Permissions symbolGroupIds: type: string description: Product Group Relationships symbolDigits: type: integer format: int32 description: Decimal Places askSpread: type: string description: askSpread bidSpread: type: string description: bidSpread pointRatio: type: integer format: int32 description: Bigger Point Ratio dealMode: type: integer format: int32 description: Transaction mode etf: type: boolean description: Is it an ETF fundId: type: integer format: int64 description: Associated Fund ID labels: type: string description: Tag sortNum: type: integer format: int32 description: Sort Field enableShortLoan: type: integer format: int32 description: Is Margin Trading Allowed enableLongLoan: type: integer format: int32 description: Is Margin Financing Allowed dividend: type: integer format: int32 description: Is Trading Allowed inHolidayTime: type: integer description: >- Is it a Holiday, 0: Not in a Holiday, 1: In a Holiday inTradeTime: type: integer description: >- Is it Trading Hours, 0: Not in Trading Hours, 1: In Trading Hours holidayTimeList: type: array items: &ref_3 $ref: '#/components/schemas/HolidayTime' description: Holiday Time tradeTimeList: type: array items: &ref_2 $ref: '#/components/schemas/TradeTime' description: Trading Time required: - inHolidayTime - inTradeTime - holidayTimeList - tradeTimeList ok: type: boolean fail: type: boolean examples: '1': summary: Success example value: msg: Success fail: false trace: x-qfx13-8z5850-mf4l657-gkqbn-1677563999 code: '0' data: - symbolId: 1061 pointRatio: 0 customerGroupIds: null dealMode: 4 baseCurrency: DOGE bidSpread: '0' labels: cryptocurrency symbolGroupIds: null enableShortLoan: 0 symbolCode: DOGE/USDT-BN-TG fundId: null etf: false enableLongLoan: 0 dividend: 0 profitCurrency: USDT symbolName: DOGE/USDT-BN-TG sortNum: 292 symbolDigits: 4 askSpread: '0' tradeType: 5 bizCode: '' tm: 955 msgParams: null ok: true headers: {} security: [] /global/config.app.AppSymbolDubboService.getSymbolDetail: post: summary: Product Detailed Data deprecated: false description: >- bizType=config.app.AppSymbolDubboService.getSymbolDetail Get detailed trading parameters for product configuration operationId: getSymbolDetail tags: - Basic parameters: - name: companyId in: header description: Company ID, obtained through environment variables required: true example: '{{company}}' schema: type: string - name: trace in: header description: Random Tracking Code UUID required: true example: '{{mock_trace}}' schema: type: string - name: token in: header description: Login Token required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: Language required: true example: zh-CN schema: type: string - name: version in: header description: '' required: true example: 0.0.2 schema: type: string requestBody: content: application/json: schema: type: object properties: tradeType: type: integer format: int64 description: Game ID symbolId: type: integer format: int64 description: Product ID required: - tradeType - symbolId example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: object properties: tradeType: type: integer format: int64 description: Gameplay symbolId: type: integer format: int64 description: Product Id symbolName: type: string description: Product name symbolCode: type: string description: Product Code baseCurrency: type: string description: Base Currency profitCurrency: type: string description: Profit and Loss Currency symbolDigits: type: integer format: int32 description: Product decimal places numberDigits: type: integer format: int32 description: Quantity Decimal Places priceBreadth: type: integer format: int32 description: Price Depth earlyWarningProportion: type: number description: Warning Ratio askSpread: type: number description: ASK Spread bidSpread: type: number description: BID Spread marginType: type: integer format: int32 description: Margin Calculation Formula marginInfo: description: Margin Information type: object properties: type: type: string description: 'Type (1: Margin Ratio, 2: Leverage Range)' values: type: string description: Value marginVoList: type: array description: Details items: type: object properties: id: type: string description: Margin ID groupId: type: integer format: int64 description: Margin Group ID type: type: string description: >- Type Type (1: Margin Ratio, 2: Leverage Range) values: type: string description: Value rangeLeft: type: number description: Range Start rangeRight: type: number description: Range End percent: type: number description: Per Mille dailyMarginSet: type: array items: &ref_1 $ref: '#/components/schemas/MarginSet' description: Weekday Margin Level holidayMarginSet: type: array items: *ref_1 description: Holiday Margin Level weekendMarginSet: type: array items: *ref_1 description: Weekend Margin Level beforeHolidayMarginSet: type: array items: *ref_1 description: Margin ratio before the holiday beforeWeekendMarginSet: type: array items: *ref_1 description: Margin ratio before the weekend usedMarginSet: type: array items: *ref_1 description: Current margin ratio in use tradeTimeList: type: array items: *ref_2 description: Trading Time quoteTimeList: type: array items: $ref: '#/components/schemas/QuoteTime' description: Market time holidayTimeList: type: array items: *ref_3 description: Holiday Time weekendLeadTime: type: integer format: int64 description: Weekend advance time (minutes) holidayLeadTime: type: integer format: int64 description: Holiday advance time (minutes) contractSize: type: integer format: int32 description: Contract size pointRatio: type: integer format: int64 description: Bigger Point Ratio volumeStep: type: number description: Lot size increment minVolume: type: number description: Minimum lots per side maxVolume: type: number description: Maximum lot size per side stopLossMinPoint: type: integer format: int32 description: Minimum stop loss distance stopLossMaxPoint: type: integer format: int32 description: Maximum stop loss distance buyInterest: type: number description: Overnight interest rate for buying sellInterest: type: number description: Overnight interest rate for selling priceMaxLimit: type: number description: Maximum limit price distance priceMinLimit: type: number description: Minimum limit price distance eodTime: type: string description: Interest settlement time feeMethod: type: string description: Commission collection method feeFormula: type: string description: Commission calculation formula feeRate: type: number description: Commission rate fee: type: number description: Commission fee startTime: type: integer format: int64 description: Product start time endTime: type: integer format: int64 description: Product expiration time leverRatio: type: string description: Leverage ratio borrowingLimitRatio: type: number description: Limit borrowing ratio multipleFreezeRatio: type: number description: Multi-freeze ratio transferLimitRatio: type: number description: Limit asset withdrawal ratio borrowInterestList: type: array items: $ref: '#/components/schemas/BorrowInterest' description: Borrowing interest borrowLimitList: type: array items: $ref: '#/components/schemas/BorrowLimit' description: Borrowing limit borrowStatusList: type: array items: $ref: '#/components/schemas/BorrowStatus' description: Borrowing product totalCredit: type: number description: Total credit dealMode: type: integer format: int32 description: Transaction mode etf: type: boolean description: Is it an ETF fundId: type: integer format: int64 description: Associated Fund ID tradeEnable: type: integer format: int32 description: Is Trading Allowed newShare: type: string description: Latest share labels: type: string description: Tag labelList: type: array items: *ref_4 description: Tag list minTradeUnit: type: integer format: int64 description: Minimum trading unit (shares/per lot) tradeDirection: type: string description: Trading direction wholeYearDays: type: integer format: int64 description: Number of days in a year accountReset: type: string description: Account zeroing accountPositionTotalVolumes: type: integer format: int64 description: Total number of positions held in the account withdrawalRatio: type: number description: Withdrawal ratio enableShortLoan: type: integer format: int32 description: Is Margin Trading Allowed enableLongLoan: type: integer format: int32 description: Is Margin Financing Allowed accountDayLeverageRatio: type: integer format: int64 description: Intraday leverage ratio of the account accountOvernightLeverageRatio: type: integer format: int64 description: Intraday leverage ratio of the account buyMaxPositionVolumes: type: number description: Buy maximum position size sellMaxPositionVolumes: type: number description: Sell maximum position size minFee: type: number description: Minimum commission fee amount maxFee: type: number description: Maximum commission fee amount daytimeBuyInitMarginRatio: *ref_1 daytimeBuyRemainingMarginRatio: *ref_1 daytimeBuyAlarmMarginRatio: *ref_1 daytimeSellInitMarginRatio: *ref_1 daytimeSellRemainingMarginRatio: *ref_1 daytimeSellAlarmMarginRatio: *ref_1 overnightBuyInitMarginRatio: *ref_1 overnightBuyRemainingMarginRatio: *ref_1 overnightBuyAlarmMarginRatio: *ref_1 overnightSellInitMarginRatio: *ref_1 overnightSellRemainingMarginRatio: *ref_1 overnightSellAlarmMarginRatio: *ref_1 overnightInAdvance: type: integer format: int64 description: Overnight advance time (minutes) longLoanYearRatio: type: array items: $ref: '#/components/schemas/BorrowAssetsInterest' description: Margin annual interest rate shortLoanYearRatio: type: number description: Securities borrowing annual interest rate liquidationFormula: type: string description: Liquidation calculation formula netAssetCurrency: type: string description: Net asset currency limitOrderMaxVolume: type: integer format: int64 description: Limit order maximum quantity enableReverseTrade: type: string description: >- Whether to support trading in opposite directions simultaneously dividendFee: type: number description: Dividend distribution cost (proportional) minDividendFee: type: number description: Minimum dividend distribution cost corporateActionCode: type: string description: Company action temporary code dividendFutureInfos: type: array items: &ref_5 $ref: '#/components/schemas/DividendInfo' description: Company future action dividendPastInfos: type: array items: *ref_5 description: Company past action stockStatus: type: string description: Stock status (TRADING/CLOSED) maintainMargin: type: string description: >- Maintenance margin ratio (for isolated margin contracts only) enableDepthTrade: type: string description: MM full position gameplay whether deep transaction required: - enableDepthTrade ok: type: boolean fail: type: boolean examples: '1': summary: Success example value: msg: Success fail: false trace: x-1751c-o767es-mxt8e-23ui-1677565011 code: '0' data: weekendLeadTime: null marginInfo: null longLoanYearRatio: null withdrawalRatio: null maxFee: null accountDayLeverageRatio: 0 eodTime: null tradeEnable: 1 holidayLeadTime: null priceMinLimit: null accountOvernightLeverageRatio: 0 feeMethod: null accountPositionTotalVolumes: 0 askSpread: null sellInterest: null daytimeBuyAlarmMarginRatio: null netAssetCurrency: null daytimeSellInitMarginRatio: null enableReverseTrade: null minFee: null labels: null borrowInterestList: null overnightSellRemainingMarginRatio: null dailyMarginSet: null numberDigits: 2 symbolId: null dealMode: 3 stopLossMinPoint: null wholeYearDays: 0 beforeWeekendMarginSet: null feeRate: 0.01 usedMarginSet: null earlyWarningProportion: 0.002 tradeTimeList: - dayOfWeek: 7 startTime: 0 endTime: 1439 - dayOfWeek: 4 startTime: 0 endTime: 1439 - dayOfWeek: 6 startTime: 0 endTime: 1380 - dayOfWeek: 1 startTime: 0 endTime: 1439 - dayOfWeek: 3 startTime: 0 endTime: 1439 - dayOfWeek: 5 startTime: 0 endTime: 1439 - dayOfWeek: 2 startTime: 0 endTime: 1440 startTime: null contractSize: null tradeType: 5 daytimeSellAlarmMarginRatio: null buyMaxPositionVolumes: null accountReset: null symbolCode: null labelList: null fundId: null volumeStep: 1 holidayTimeList: - startTime: 1629279900334 endTime: 1629280200334 leverRatio: '1' marginType: 0 newShare: null minVolume: 1 endTime: null priceBreadth: 5 corporateActionCode: null minTradeUnit: 0 overnightSellAlarmMarginRatio: null borrowStatusList: null fee: null daytimeBuyRemainingMarginRatio: null borrowingLimitRatio: 0.009 etf: false stockStatus: null dividendFutureInfos: null symbolName: null shortLoanYearRatio: null stopLossMaxPoint: null daytimeBuyInitMarginRatio: null overnightSellInitMarginRatio: null buyInterest: null priceMaxLimit: null sellMaxPositionVolumes: null minDividendFee: null dividendPastInfos: null bidSpread: null liquidationFormula: null multipleFreezeRatio: 0.01 beforeHolidayMarginSet: null overnightBuyRemainingMarginRatio: null overnightInAdvance: 0 profitCurrency: null transferLimitRatio: 0 daytimeSellRemainingMarginRatio: null overnightBuyAlarmMarginRatio: null symbolDigits: 1 limitOrderMaxVolume: 0 overnightBuyInitMarginRatio: null baseCurrency: null enableShortLoan: 0 borrowLimitList: null quoteTimeList: - dayOfWeek: 4 startTime: 0 endTime: 1440 - dayOfWeek: 2 startTime: 0 endTime: 1440 - dayOfWeek: 5 startTime: 0 endTime: 1440 - dayOfWeek: 7 startTime: 0 endTime: 1440 - dayOfWeek: 1 startTime: 0 endTime: 1440 - dayOfWeek: 3 startTime: 0 endTime: 1440 - dayOfWeek: 6 startTime: 0 endTime: 1440 pointRatio: 0 totalCredit: null maxVolume: 1 feeFormula: '1' tradeDirection: null dividendFee: null weekendMarginSet: null enableLongLoan: 0 holidayMarginSet: null bizCode: '' tm: 27 msgParams: null ok: true headers: {} security: [] /global/config.app.AppSymbolDubboService.getFundInfo: post: summary: Fund detailed information deprecated: false description: Get fund detailed information operationId: getFundInfo tags: - Basic parameters: - name: companyId in: header description: '' required: true example: '{{company}}' schema: type: string - name: trace in: header description: '' required: true example: '{{mock_trace}}' schema: type: string - name: lang in: header description: '' required: true example: zh-CN schema: type: string requestBody: content: application/json: schema: type: object properties: fundId: type: integer format: int64 description: Fund ID example: '' responses: '200': description: '' content: application/json: schema: &ref_7 $ref: '#/components/schemas/BaseResultOpenFundsVo' examples: '1': summary: Success example value: msg: Success fail: false trace: x-064821ac-4bcc-48a2-9c56-a5804f7ab766-1677566865076 code: '0' data: canPurchase: 1 yearDays: 365 shareTokenDigits: 6 redemptionCurrencySetting: - minRedemptionAmount: null minRedemptionNum: 3 currencyName: USDT redemptionFeeProportion: 0 currencyCode: USDT - minRedemptionAmount: null minRedemptionNum: 3 currencyName: null redemptionFeeProportion: 0 currencyCode: self settlementCustomerNo: '86000040' shareToken: 64 managerName: null purchaseType: 2 fundType: null operationMode: 2 minRedemptionNum: 500 upDate: '2022-05-10' customerId: 40 preShare: '2000' purchaseCurrencySetting: - currencyName: USDT purchaseFeeProportion: 0 minPurchaseAmount: 5000 minPurchaseNum: 5 currencyCode: USDT - currencyName: null purchaseFeeProportion: 0 minPurchaseAmount: null minPurchaseNum: 5 currencyCode: self introduction: >- V10 index fund contains the top 10 cryptocurrencies, the underlying assets are adjusted by monthly according to their average daily volume within the past 120 days. It reflects the overall trend in cryptocurrency with asset transparency. With V10, you won't miss out on the fast-growing market. fundCurrencyList: - currencyName: MATIC weight: 1.238902% currencyCode: MATIC - currencyName: USDT weight: 0.183337% currencyCode: USDT - currencyName: DOGE weight: 2.001659% currencyCode: DOGE - currencyName: XRP weight: 2.130794% currencyCode: XRP - currencyName: BTC weight: 65.762574% currencyCode: BTC - currencyName: LTC weight: 1.376322% currencyCode: LTC - currencyName: LINK weight: 0.746966% currencyCode: LINK - currencyName: SOL weight: 2.268261% currencyCode: SOL - currencyName: BNB weight: 1.903673% currencyCode: BNB - currencyName: ETH weight: 21.557723% currencyCode: ETH - currencyName: ADA weight: 0.829790% currencyCode: ADA settlementCustomerId: 41 dailySettlementTime: 0 purchaseFeeProportion: 0 canRedemption: 1 trackIndex: 365 settlementCompanyId: 14 shareTokenCode: V10 companyId: 14 fundId: 88 redemptionFeeProportion: 0 managementFee: 0 trackIndexOut: null newShare: '2001.000006' fundName: V10 customerNo: '86000039' bizCode: '' tm: 65 msgParams: null ok: true '2': summary: Exception example value: msg: System error fail: true trace: x-5f15b0-6thqc8q-xh3c2-s79bcxk-1677566752 code: '300' data: config.app.AppSymbolDubboService.getFundInfo bizCode: '' tm: 4 msgParams: null ok: false headers: {} security: [] /global/config.app.AppSymbolDubboService.findFundPage: post: summary: Brief information query for funds deprecated: false description: Pagination query for fund list data operationId: findFundPage tags: - Basic parameters: - name: companyId in: header description: '' required: true example: '{{company}}' schema: type: string - name: trace in: header description: '' required: true example: '{{mock_trace}}' schema: type: string - name: lang in: header description: '' required: true example: zh-CN schema: type: string requestBody: content: application/json: schema: type: object properties: current: description: Current page. Default is 1 type: integer size: description: Number of items per page. Default is 20 type: integer name: type: string description: Search Name example: '' responses: '200': description: '' content: application/json: schema: &ref_6 $ref: '#/components/schemas/BaseResultBasePageVoOpenFundsVo' examples: '1': summary: Success example value: msg: Success fail: false trace: x-96nr82-sv8ir-qc3q-95iw-1677567338 code: '0' data: total: 4 current: 1 size: 20 records: - canPurchase: 1 yearDays: 365 shareTokenDigits: null redemptionCurrencySetting: - minRedemptionAmount: null minRedemptionNum: 0.01 currencyName: USDT redemptionFeeProportion: 0.001 currencyCode: USDT - minRedemptionAmount: null minRedemptionNum: 0.01 currencyName: null redemptionFeeProportion: 0.002 currencyCode: self settlementCustomerNo: '86000336' shareToken: 116 managerName: CATHY purchaseType: 2 fundType: INDEX operationMode: 2 minRedemptionNum: null upDate: '2022-05-10' customerId: 336 preShare: '1000' purchaseCurrencySetting: - currencyName: USDT purchaseFeeProportion: 0.001 minPurchaseAmount: null minPurchaseNum: 0.01 currencyCode: USDT - currencyName: null purchaseFeeProportion: 0.002 minPurchaseAmount: null minPurchaseNum: 0.01 currencyCode: self introduction: >- HAHAHAHHAHAHAHAHAHAHHAHAHAHAHAHAHHAHAHAHAHAHAHHAHAHAHAHAHAHHAHAHA fundCurrencyList: null settlementCustomerId: 337 dailySettlementTime: 335 purchaseFeeProportion: 0 canRedemption: 1 trackIndex: 2672 settlementCompanyId: 360 shareTokenCode: qa001 fundId: 270 companyId: 360 redemptionFeeProportion: 0 trackIndexOut: null managementFee: 0.01 newShare: '380227.580' fundName: QA001 customerNo: '86000335' - canPurchase: 1 yearDays: 365 shareTokenDigits: null redemptionCurrencySetting: - minRedemptionAmount: null minRedemptionNum: 0.1 currencyName: USDT redemptionFeeProportion: 0.01 currencyCode: USDT - minRedemptionAmount: null minRedemptionNum: 0.1 currencyName: null redemptionFeeProportion: 0.02 currencyCode: self settlementCustomerNo: '86000161' shareToken: 111 managerName: CATHY purchaseType: 2 fundType: Index Fund operationMode: 2 minRedemptionNum: 0.1 upDate: '2022-01-01' customerId: 273 preShare: '350000' purchaseCurrencySetting: - currencyName: USDT purchaseFeeProportion: 0.01 minPurchaseAmount: 10 minPurchaseNum: 0.1 currencyCode: USDT - currencyName: null purchaseFeeProportion: 0.02 minPurchaseAmount: null minPurchaseNum: 0.01 currencyCode: self introduction: >- In 2017, our team successfully pioneered the first tokenized crypto-only index fund, which used the seed funding to buy the underlying crypto assets. There are no broker fees, no exit fees, no minimum investment and full control over your assets. Full blockchain transparency. fundCurrencyList: null settlementCustomerId: 162 dailySettlementTime: 232 purchaseFeeProportion: 0 canRedemption: 1 trackIndex: 1563 settlementCompanyId: 360 shareTokenCode: V10 fundId: 80 companyId: 360 redemptionFeeProportion: 0 trackIndexOut: null managementFee: 0.02 newShare: '391365.08' fundName: V10 Index Fund111 customerNo: '86000272' - canPurchase: 1 yearDays: null shareTokenDigits: null redemptionCurrencySetting: - minRedemptionAmount: null minRedemptionNum: null currencyName: USDT redemptionFeeProportion: null currencyCode: USDT settlementCustomerNo: '86001102' shareToken: 127 managerName: CATHY purchaseType: 2 fundType: INDEX operationMode: 2 minRedemptionNum: 1 upDate: '2022-03-01' customerId: 1102 preShare: '300000' purchaseCurrencySetting: - currencyName: USDT purchaseFeeProportion: null minPurchaseAmount: 1 minPurchaseNum: null currencyCode: USDT introduction: '22233311133' fundCurrencyList: null settlementCustomerId: 1103 dailySettlementTime: null purchaseFeeProportion: 0.01 canRedemption: 1 trackIndex: 1563 settlementCompanyId: 360 shareTokenCode: QA004 fundId: 170 companyId: 360 redemptionFeeProportion: 0.01 trackIndexOut: null managementFee: null newShare: '10010176.14' fundName: QA004 FUND customerNo: '86001101' - canPurchase: 1 yearDays: null shareTokenDigits: null redemptionCurrencySetting: - minRedemptionAmount: null minRedemptionNum: null currencyName: USDT redemptionFeeProportion: null currencyCode: USDT settlementCustomerNo: '86001048' shareToken: 126 managerName: CATHY purchaseType: 2 fundType: INDEX operationMode: 2 minRedemptionNum: 5 upDate: '2022-03-01' customerId: 1050 preShare: '350000' purchaseCurrencySetting: - currencyName: USDT purchaseFeeProportion: null minPurchaseAmount: 5 minPurchaseNum: null currencyCode: USDT introduction: >- 1111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111 fundCurrencyList: null settlementCustomerId: 1049 dailySettlementTime: null purchaseFeeProportion: 0.01 canRedemption: 1 trackIndex: 1563 settlementCompanyId: 360 shareTokenCode: QA003 fundId: 168 companyId: 360 redemptionFeeProportion: 0.02 trackIndexOut: null managementFee: null newShare: '350018.47' fundName: QA003-FUND customerNo: '86001049' bizCode: '' tm: 168 msgParams: null ok: true '2': summary: Exception example value: msg: System error fail: true trace: x-n0r2n-8o88keo-72er-deu1-1677567377 code: '300' data: config.app.AppSymbolDubboService.findFundPage bizCode: '' tm: 1 msgParams: null ok: false headers: {} security: [] /global/config.app.AppSymbolDubboService.findFundPageWithRealTimeInfo: post: summary: Fund Detailed Information Query deprecated: false description: Fund Detailed Information Pagination Query (with real-time information) operationId: findFundPageWithRealTimeInfo tags: - Basic parameters: - name: companyId in: header description: '' required: true example: '{{company}}' schema: type: string - name: trace in: header description: '' required: true example: '{{mock_trace}}' schema: type: string - name: lang in: header description: '' required: true example: zh-CN schema: type: string requestBody: content: application/json: schema: type: object properties: current: type: integer format: int64 description: Current page. Default is 1 size: type: integer format: int64 description: Number of items per page. Default is 20 name: description: Product Name. Supports fuzzy matching type: string example: '' responses: '200': description: '' content: application/json: schema: *ref_6 examples: '1': summary: Success example value: msg: Success fail: false trace: x-q72xki8-js43-s6c8dp-j1y3b-1677567565 code: '0' data: total: 4 current: 1 size: 20 records: - canPurchase: 1 marketPrice: '446.3875' yearDays: 365 redemptionCurrencySetting: - minRedemptionAmount: null minRedemptionNum: 0.01 currencyName: USDT redemptionFeeProportion: 0.001 currencyCode: USDT - minRedemptionAmount: null minRedemptionNum: 0.01 currencyName: null redemptionFeeProportion: 0.002 currencyCode: self netValueChangeQuote: 0.00% settlementCustomerNo: '86000336' shareToken: 116 managerName: CATHY purchaseType: 2 fundType: INDEX operationMode: 2 minRedemptionNum: null upDate: '2022-05-10' customerId: 336 preShare: '1000' purchaseCurrencySetting: - currencyName: USDT purchaseFeeProportion: 0.001 minPurchaseAmount: null minPurchaseNum: 0.01 currencyCode: USDT - currencyName: null purchaseFeeProportion: 0.002 minPurchaseAmount: null minPurchaseNum: 0.01 currencyCode: self introduction: >- HAHAHAHHAHAHAHAHAHAHHAHAHAHAHAHAHHAHAHAHAHAHAHHAHAHAHAHAHAHHAHAHA settlementCustomerId: 337 dailySettlementTime: 335 totalBalance: '1664144877.0021' purchaseFeeProportion: 0 netValue: '4376.7074' canRedemption: 1 trackIndex: 2672 settlementCompanyId: 360 shareTokenCode: qa001 fundId: 270 companyId: 360 redemptionFeeProportion: 0 trackIndexOut: null managementFee: 0.01 newShare: '380227.580' fundName: QA001 currencyCode: USDT customerNo: '86000335' marketPriceChangeQuote: 0.00% - canPurchase: 1 marketPrice: '8.6838' yearDays: 365 redemptionCurrencySetting: - minRedemptionAmount: null minRedemptionNum: 0.1 currencyName: USDT redemptionFeeProportion: 0.01 currencyCode: USDT - minRedemptionAmount: null minRedemptionNum: 0.1 currencyName: null redemptionFeeProportion: 0.02 currencyCode: self netValueChangeQuote: '-0.06%' settlementCustomerNo: '86000161' shareToken: 111 managerName: CATHY purchaseType: 2 fundType: Index Fund operationMode: 2 minRedemptionNum: 0.1 upDate: '2022-01-01' customerId: 273 preShare: '350000' purchaseCurrencySetting: - currencyName: USDT purchaseFeeProportion: 0.01 minPurchaseAmount: 10 minPurchaseNum: 0.1 currencyCode: USDT - currencyName: null purchaseFeeProportion: 0.02 minPurchaseAmount: null minPurchaseNum: 0.01 currencyCode: self introduction: >- In 2017, our team successfully pioneered the first tokenized crypto-only index fund, which used the seed funding to buy the underlying crypto assets. There are no broker fees, no exit fees, no minimum investment and full control over your assets. Full blockchain transparency. settlementCustomerId: 162 dailySettlementTime: 232 totalBalance: '6777080.4243' purchaseFeeProportion: 0 netValue: '17.3165' canRedemption: 1 trackIndex: 1563 settlementCompanyId: 360 shareTokenCode: V10 fundId: 80 companyId: 360 redemptionFeeProportion: 0 trackIndexOut: null managementFee: 0.02 newShare: '391365.08' fundName: V10 Index Fund111 currencyCode: USDT customerNo: '86000272' marketPriceChangeQuote: 0.00% - canPurchase: 1 marketPrice: '0' yearDays: null redemptionCurrencySetting: - minRedemptionAmount: null minRedemptionNum: null currencyName: USDT redemptionFeeProportion: null currencyCode: USDT netValueChangeQuote: 0.00% settlementCustomerNo: '86001102' shareToken: 127 managerName: CATHY purchaseType: 2 fundType: INDEX operationMode: 2 minRedemptionNum: 1 upDate: '2022-03-01' customerId: 1102 preShare: '300000' purchaseCurrencySetting: - currencyName: USDT purchaseFeeProportion: null minPurchaseAmount: 1 minPurchaseNum: null currencyCode: USDT introduction: '22233311133' settlementCustomerId: 1103 dailySettlementTime: null totalBalance: '10311481.9211' purchaseFeeProportion: 0.01 netValue: '1.0301' canRedemption: 1 trackIndex: 1563 settlementCompanyId: 360 shareTokenCode: QA004 fundId: 170 companyId: 360 redemptionFeeProportion: 0.01 trackIndexOut: null managementFee: null newShare: '10010176.14' fundName: QA004 FUND currencyCode: USDT customerNo: '86001101' marketPriceChangeQuote: '-' - canPurchase: 1 marketPrice: '0' yearDays: null redemptionCurrencySetting: - minRedemptionAmount: null minRedemptionNum: null currencyName: USDT redemptionFeeProportion: null currencyCode: USDT netValueChangeQuote: 0.00% settlementCustomerNo: '86001048' shareToken: 126 managerName: CATHY purchaseType: 2 fundType: INDEX operationMode: 2 minRedemptionNum: 5 upDate: '2022-03-01' customerId: 1050 preShare: '350000' purchaseCurrencySetting: - currencyName: USDT purchaseFeeProportion: null minPurchaseAmount: 5 minPurchaseNum: null currencyCode: USDT introduction: >- 1111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111 settlementCustomerId: 1049 dailySettlementTime: null totalBalance: '370019.5346' purchaseFeeProportion: 0.01 netValue: '1.0571' canRedemption: 1 trackIndex: 1563 settlementCompanyId: 360 shareTokenCode: QA003 fundId: 168 companyId: 360 redemptionFeeProportion: 0.02 trackIndexOut: null managementFee: null newShare: '350018.47' fundName: QA003-FUND currencyCode: USDT customerNo: '86001049' marketPriceChangeQuote: '-' bizCode: '' tm: 540 msgParams: null ok: true '2': summary: Exception example value: msg: System error fail: true trace: x-533gym-54fb-7k4hax8-57598-1677567631 code: '300' data: >- config.app.AppSymbolDubboService.findFundPageWithRealTimeInfo bizCode: '' tm: 1 msgParams: null ok: false headers: {} security: [] /global/config.app.AppSymbolDubboService.getEquityPremiumRate: post: summary: Fund net asset value and premium rate query deprecated: false description: Query net asset value and premium rate operationId: getEquityPremiumRate tags: - Basic parameters: - name: companyId in: header description: '' required: true example: '{{company}}' schema: type: string - name: trace in: header description: '' required: true example: '{{mock_trace}}' schema: type: string - name: lang in: header description: '' required: true example: zh-CN schema: type: string requestBody: content: application/json: schema: type: object properties: symbolId: type: integer format: int64 description: >- Product ID. Either currencyCode or this field must exist, and if both exist, this field value prevails currencyCode: type: string description: >- Fund token code (Either symbolId or this field must exist, and if both exist, symbolId value prevails) profitCurrency: type: string description: Target asset code example: '' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/BaseResultQueryEquityPremiumRateVo' examples: '1': summary: Success example value: msg: Success fail: false trace: x-6cec0524-405f-4c9b-913a-e0f9a930c74f-1677568429063 code: '0' data: companyId: 14 totalBalance: '1165921.8083' newShare: '2001.000006' premiumRate: '-0.01%' currency: USDT digits: 4 currentNav: '582.6696' markerCustomer: false tradeType: 5 customerNo: '86000039' accountInfoMap: MATIC: accountId: 1001516 companyId: 14 weight: 1.235584% currency: MATIC digits: 6 wholeWarehouseRate: '1.281100' tradeType: 5 customerNo: '86000039' assetsId: 17 wholeWarehouseBalance: '14405.9394' VET: accountId: 1001526 companyId: 14 weight: 0.00% currency: VET digits: 6 wholeWarehouseRate: '0.028540' tradeType: 5 customerNo: '86000039' assetsId: 46 wholeWarehouseBalance: '0.0000' SHIB: accountId: 1001529 companyId: 14 weight: 0.00% currency: SHIB digits: 6 wholeWarehouseRate: '0.00001276' tradeType: 5 customerNo: '86000039' assetsId: 53 wholeWarehouseBalance: '0.0000' USDT: accountId: 1001503 companyId: 14 weight: 0.183531% currency: USDT digits: 4 wholeWarehouseRate: '1' tradeType: 5 customerNo: '86000039' assetsId: 1 wholeWarehouseBalance: '2139.8232' DOGE: accountId: 1001509 companyId: 14 weight: 1.997918% currency: DOGE digits: 6 wholeWarehouseRate: '0.081720' tradeType: 5 customerNo: '86000039' assetsId: 8 wholeWarehouseBalance: '23294.1564' HBAR: accountId: 1001534 companyId: 14 weight: 0.00% currency: HBAR digits: 6 wholeWarehouseRate: '0.0741' tradeType: 5 customerNo: '86000039' assetsId: 60 wholeWarehouseBalance: '0.0000' NEAR: accountId: 1001530 companyId: 14 weight: 0.00% currency: NEAR digits: 6 wholeWarehouseRate: '2.3540' tradeType: 5 customerNo: '86000039' assetsId: 56 wholeWarehouseBalance: '0.0000' DASH: accountId: 1128443 companyId: 14 weight: 0.00% currency: DASH digits: 5 wholeWarehouseRate: '73.80' tradeType: 5 customerNo: '86000039' assetsId: 31 wholeWarehouseBalance: '0.0000' COMP: accountId: 1128447 companyId: 14 weight: 0.00% currency: COMP digits: 4 wholeWarehouseRate: '51.520' tradeType: 5 customerNo: '86000039' assetsId: 86 wholeWarehouseBalance: '0.0000' CHZ: accountId: 1128451 companyId: 14 weight: 0.00% currency: CHZ digits: 6 wholeWarehouseRate: '0.13530' tradeType: 5 customerNo: '86000039' assetsId: 81 wholeWarehouseBalance: '0.0000' SLP: accountId: 1129891 companyId: 14 weight: 0.00% currency: SLP digits: 6 wholeWarehouseRate: '0.003338' tradeType: 5 customerNo: '86000039' assetsId: 80 wholeWarehouseBalance: '0.0000' XRP: accountId: 1001518 companyId: 14 weight: 2.118927% currency: XRP digits: 6 wholeWarehouseRate: '0.376100' tradeType: 5 customerNo: '86000039' assetsId: 20 wholeWarehouseBalance: '24705.0327' TRX: accountId: 1001524 companyId: 14 weight: 0.00% currency: TRX digits: 6 wholeWarehouseRate: '0.069240' tradeType: 5 customerNo: '86000039' assetsId: 44 wholeWarehouseBalance: '0.0000' SAND: accountId: 1001519 companyId: 14 weight: 0.00% currency: SAND digits: 6 wholeWarehouseRate: '0.712400' tradeType: 5 customerNo: '86000039' assetsId: 22 wholeWarehouseBalance: '0.0000' BCH: accountId: 1001508 companyId: 14 weight: 0.00% currency: BCH digits: 6 wholeWarehouseRate: '135.800000' tradeType: 5 customerNo: '86000039' assetsId: 7 wholeWarehouseBalance: '0.0000' CAKE: accountId: 1129892 companyId: 14 weight: 0.00% currency: CAKE digits: 4 wholeWarehouseRate: '4.0360' tradeType: 5 customerNo: '86000039' assetsId: 74 wholeWarehouseBalance: '0.0000' DOT: accountId: 1001510 companyId: 14 weight: 0.00% currency: DOT digits: 6 wholeWarehouseRate: '6.658000' tradeType: 5 customerNo: '86000039' assetsId: 9 wholeWarehouseBalance: '0.0000' BTC: accountId: 1001504 companyId: 14 weight: 65.782504% currency: BTC digits: 8 wholeWarehouseRate: '23515.580000' tradeType: 5 customerNo: '86000039' assetsId: 2 wholeWarehouseBalance: '766972.5651' AVAX: accountId: 1001506 companyId: 14 weight: 0.00% currency: AVAX digits: 6 wholeWarehouseRate: '18.280000' tradeType: 5 customerNo: '86000039' assetsId: 5 wholeWarehouseBalance: '0.0000' TT10: accountId: 1001537 companyId: 14 weight: 0.00% currency: TT10 digits: 6 wholeWarehouseRate: '1.00' tradeType: 5 customerNo: '86000039' assetsId: 63 wholeWarehouseBalance: '0.0000' LTC: accountId: 1001514 companyId: 14 weight: 1.376892% currency: LTC digits: 6 wholeWarehouseRate: '95.140000' tradeType: 5 customerNo: '86000039' assetsId: 15 wholeWarehouseBalance: '16053.4800' USDC: accountId: 1005704 companyId: 14 weight: 0.00% currency: USDC digits: 4 wholeWarehouseRate: '1.0000' tradeType: 5 customerNo: '86000039' assetsId: 66 wholeWarehouseBalance: '0.0000' FTM: accountId: 1001533 companyId: 14 weight: 0.00% currency: FTM digits: 6 wholeWarehouseRate: '0.4705' tradeType: 5 customerNo: '86000039' assetsId: 59 wholeWarehouseBalance: '0.0000' ENJ: accountId: 1128450 companyId: 14 weight: 0.00% currency: ENJ digits: 4 wholeWarehouseRate: '0.4852' tradeType: 5 customerNo: '86000039' assetsId: 83 wholeWarehouseBalance: '0.0000' KNC: accountId: 1128453 companyId: 14 weight: 0.00% currency: KNC digits: 4 wholeWarehouseRate: '0.901' tradeType: 5 customerNo: '86000039' assetsId: 78 wholeWarehouseBalance: '0.0000' FTT: accountId: 1001523 companyId: 14 weight: 0.00% currency: FTT digits: 6 wholeWarehouseRate: '1.548100' tradeType: 5 customerNo: '86000039' assetsId: 40 wholeWarehouseBalance: '0.0000' ONE: accountId: 1128454 companyId: 14 weight: 0.00% currency: ONE digits: 6 wholeWarehouseRate: '0.02188' tradeType: 5 customerNo: '86000039' assetsId: 77 wholeWarehouseBalance: '0.0000' GRT: accountId: 1128445 companyId: 14 weight: 0.00% currency: GRT digits: 6 wholeWarehouseRate: '0.16000' tradeType: 5 customerNo: '86000039' assetsId: 87 wholeWarehouseBalance: '0.0000' SUSHI: accountId: 1128446 companyId: 14 weight: 0.00% currency: SUSHI digits: 4 wholeWarehouseRate: '1.3400' tradeType: 5 customerNo: '86000039' assetsId: 88 wholeWarehouseBalance: '0.0000' ENS: accountId: 1128455 companyId: 14 weight: 0.00% currency: ENS digits: 5 wholeWarehouseRate: '16.340' tradeType: 5 customerNo: '86000039' assetsId: 76 wholeWarehouseBalance: '0.0000' ALGO: accountId: 1001531 companyId: 14 weight: 0.00% currency: ALGO digits: 6 wholeWarehouseRate: '0.2536' tradeType: 5 customerNo: '86000039' assetsId: 57 wholeWarehouseBalance: '0.0000' ATOM: accountId: 1001520 companyId: 14 weight: 0.00% currency: ATOM digits: 5 wholeWarehouseRate: '12.843000' tradeType: 5 customerNo: '86000039' assetsId: 25 wholeWarehouseBalance: '0.0000' SRM: accountId: 1128456 companyId: 14 weight: 0.00% currency: SRM digits: 4 wholeWarehouseRate: '0.32824' tradeType: 5 customerNo: '86000039' assetsId: 75 wholeWarehouseBalance: '0.0000' UNI: accountId: 1001525 companyId: 14 weight: 0.00% currency: UNI digits: 6 wholeWarehouseRate: '6.597000' tradeType: 5 customerNo: '86000039' assetsId: 45 wholeWarehouseBalance: '0.0000' AAVE: accountId: 1128442 companyId: 14 weight: 0.00% currency: AAVE digits: 5 wholeWarehouseRate: '82.200000' tradeType: 5 customerNo: '86000039' assetsId: 24 wholeWarehouseBalance: '0.0000' XLM: accountId: 1001527 companyId: 14 weight: 0.00% currency: XLM digits: 6 wholeWarehouseRate: '0.089100' tradeType: 5 customerNo: '86000039' assetsId: 48 wholeWarehouseBalance: '0.0000' LINK: accountId: 1001513 companyId: 14 weight: 0.748468% currency: LINK digits: 4 wholeWarehouseRate: '7.489000' tradeType: 5 customerNo: '86000039' assetsId: 14 wholeWarehouseBalance: '8726.5523' LUNA: accountId: 1001515 companyId: 14 weight: 0.00% currency: LUNA digits: 6 wholeWarehouseRate: '1.731900' tradeType: 5 customerNo: '86000039' assetsId: 16 wholeWarehouseBalance: '0.0000' XTZ: accountId: 1128441 companyId: 14 weight: 0.00% currency: XTZ digits: 4 wholeWarehouseRate: '1.2080' tradeType: 5 customerNo: '86000039' assetsId: 21 wholeWarehouseBalance: '0.0000' MANA: accountId: 1001528 companyId: 14 weight: 0.00% currency: MANA digits: 6 wholeWarehouseRate: '0.656100' tradeType: 5 customerNo: '86000039' assetsId: 51 wholeWarehouseBalance: '0.0000' EOS: accountId: 1001511 companyId: 14 weight: 0.00% currency: EOS digits: 6 wholeWarehouseRate: '1.124000' tradeType: 5 customerNo: '86000039' assetsId: 11 wholeWarehouseBalance: '0.0000' FIL: accountId: 1001522 companyId: 14 weight: 0.00% currency: FIL digits: 6 wholeWarehouseRate: '6.833000' tradeType: 5 customerNo: '86000039' assetsId: 39 wholeWarehouseBalance: '0.0000' GALA: accountId: 1128444 companyId: 14 weight: 0.00% currency: GALA digits: 6 wholeWarehouseRate: '0.040790' tradeType: 5 customerNo: '86000039' assetsId: 52 wholeWarehouseBalance: '0.0000' SOL: accountId: 1001517 companyId: 14 weight: 2.265571% currency: SOL digits: 6 wholeWarehouseRate: '23.030000' tradeType: 5 customerNo: '86000039' assetsId: 19 wholeWarehouseBalance: '26414.7871' testv10: accountId: 1001536 companyId: 14 weight: 0.00% currency: testv10 digits: 6 wholeWarehouseRate: '1.00' tradeType: 5 customerNo: '86000039' assetsId: 62 wholeWarehouseBalance: '0.0000' V10: accountId: 1003182 companyId: 14 weight: 0.00% currency: V10 digits: 6 wholeWarehouseRate: '587.1769' tradeType: 5 customerNo: '86000039' assetsId: 64 wholeWarehouseBalance: '0.0000' BAT: accountId: 1128448 companyId: 14 weight: 0.00% currency: BAT digits: 6 wholeWarehouseRate: '0.30840' tradeType: 5 customerNo: '86000039' assetsId: 85 wholeWarehouseBalance: '0.0000' MKR: accountId: 1128452 companyId: 14 weight: 0.00% currency: MKR digits: 5 wholeWarehouseRate: '773' tradeType: 5 customerNo: '86000039' assetsId: 79 wholeWarehouseBalance: '0.0000' APE: accountId: 1128449 companyId: 14 weight: 0.00% currency: APE digits: 6 wholeWarehouseRate: '5.21900' tradeType: 5 customerNo: '86000039' assetsId: 84 wholeWarehouseBalance: '0.0000' BNB: accountId: 1001521 companyId: 14 weight: 1.902539% currency: BNB digits: 6 wholeWarehouseRate: '308.400000' tradeType: 5 customerNo: '86000039' assetsId: 28 wholeWarehouseBalance: '22182.1149' ICP: accountId: 1001532 companyId: 14 weight: 0.00% currency: ICP digits: 6 wholeWarehouseRate: '6.2100' tradeType: 5 customerNo: '86000039' assetsId: 58 wholeWarehouseBalance: '0.0000' ETH: accountId: 1001512 companyId: 14 weight: 21.558314% currency: ETH digits: 6 wholeWarehouseRate: '1640.520000' tradeType: 5 customerNo: '86000039' assetsId: 12 wholeWarehouseBalance: '251353.0900' YGG: accountId: 1129890 companyId: 14 weight: 0.00% currency: YGG digits: 6 wholeWarehouseRate: '0.3213' tradeType: 5 customerNo: '86000039' assetsId: 89 wholeWarehouseBalance: '0.0000' TEST10: accountId: 1001535 companyId: 14 weight: 0.00% currency: TEST10 digits: 6 wholeWarehouseRate: '1.00' tradeType: 5 customerNo: '86000039' assetsId: 61 wholeWarehouseBalance: '0.0000' AXS: accountId: 1001507 companyId: 14 weight: 0.00% currency: AXS digits: 5 wholeWarehouseRate: '9.930' tradeType: 5 customerNo: '86000039' assetsId: 6 wholeWarehouseBalance: '0.0000' ADA: accountId: 1001505 companyId: 14 weight: 0.829753% currency: ADA digits: 6 wholeWarehouseRate: '0.366800' tradeType: 5 customerNo: '86000039' assetsId: 4 wholeWarehouseBalance: '9674.2672' bizCode: C tm: 59 msgParams: null ok: true '2': summary: Exception example value: msg: Exception in getting input parameters fail: true trace: x-35n54-1g7tsptm-q80rq7m7-09a856-1677568294 code: '10000' data: config.app.AppSymbolDubboService.getEquityPremiumRate bizCode: C tm: 2 msgParams: null ok: false headers: {} security: [] /global/config.app.AppSymbolDubboService.getFundInfoByCustomerNo: post: summary: Fund detailed information query - Fund manager deprecated: false description: 'Get fund details based on fund manager ' operationId: getFundInfoByCustomerNo tags: - Basic parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string requestBody: content: application/json: schema: type: object properties: customerNo: type: string description: Client number required: - customerNo example: '' responses: '200': description: '' content: application/json: schema: *ref_7 examples: '1': summary: Exception example value: msg: System error fail: true trace: x-o15020-u0jbkce-nb9ubv6-so3hd8v-1677634799 code: '300' data: config.app.AppSymbolDubboService.getFundInfoByCustomerNo bizCode: '' tm: 6 msgParams: null ok: false headers: {} security: [] /global/customer.app.CustomerWebApiService.bindLoginPwd: post: summary: First Time Setting Login Password deprecated: false description: |- version=0.0.1 bizType=customer.app.CustomerWebApiService.bindLoginPwd Accessible after login operationId: bindLoginPwd tags: - Customer/Basic parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: pwd: type: string description: Password, MD5 encryption googleCode: type: string description: Google Verification Code required: - pwd example: '' responses: '200': description: '' content: application/json: schema: &ref_8 $ref: '#/components/schemas/BaseResult1' headers: {} security: [] /global/customer.app.CustomerWebApiService.changeEmail: post: summary: Change Email deprecated: false description: |- version=0.0.1 bizType=customer.app.CustomerWebApiService.changeEmail Accessible after login operationId: changeEmail tags: - Customer/Basic parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: verifyCode: type: string description: New Verification Code email: type: string description: New Email maxLength: 50 sendToken: type: string description: New Verification Code Sending Ticket emailArea: type: string description: New Email Area Code maxLength: 15 required: - verifyCode - email - sendToken - emailArea example: '' responses: '200': description: '' content: application/json: schema: *ref_8 headers: {} security: [] /global/customer.app.CustomerWebApiService.changeEmailV1v1v2: post: summary: Change Email (MFA) deprecated: true description: >- version=0.0.1 bizType=customer.app.CustomerWebApiService.changeEmailV1v1v2 Accessible after login If the customer enables Google Verification Code (MFA), the Google Verification Code (googleCode) in the input parameters is required, and the user does not need to enter the old email operationId: changeEmailV1v1v2 tags: - Customer/Basic parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: verifyCode: type: string description: New Verification Code email: type: string description: New Email sendToken: type: string description: New Verification Code Sending Ticket emailArea: type: string description: New Email Area Code verifyCodeOld: type: string description: Original email verification code sendTokenOld: type: string description: Original email verification code sending ticket googleCode: type: string description: Google Verification Code required: - verifyCode - email - sendToken - emailArea - verifyCodeOld - sendTokenOld example: '' responses: '200': description: '' content: application/json: schema: *ref_8 headers: {} security: [] /global/customer.app.CustomerWebApiService.changePhone: post: summary: Change phone number deprecated: false description: |- version=0.0.1 bizType=customer.app.CustomerWebApiService.changePhone Accessible after login operationId: changePhone tags: - Customer/Basic parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: phoneArea: type: string description: New phone area code maxLength: 15 phone: type: string description: New phone number maxLength: 50 verifyCode: type: string description: Verification code sendToken: type: string description: Verification code sending ticket required: - phoneArea - phone - verifyCode - sendToken example: '' responses: '200': description: '' content: application/json: schema: *ref_8 examples: '1': summary: Exception example - Verification code does not exist value: msg: Verification code is not correct fail: true trace: x-42hi-b8f2ag18-x89u-k23y1r1b-1677738250 code: CUSTOMER_API_0000511 data: customer.app.CustomerWebApiService.changePhone bizCode: US tm: 15861690 msgParams: null ok: false headers: {} security: [] /global/customer.app.CustomerWebApiService.changePhoneV1v1v2: post: summary: Change phone number (MFA) deprecated: true description: >- version=0.0.1 bizType=customer.app.CustomerWebApiService.changePhoneV1v1v2 Accessible after login If the customer enables Google Authenticator (MFA), the Google Authenticator code (googleCode) in the input parameters is required, and the user does not need to enter the old phone number operationId: changePhoneV1v1v2 tags: - Customer/Basic parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: phoneArea: type: string description: New phone number phone: type: string description: New phone number verifyCode: type: string description: New Verification Code sendToken: type: string description: New Verification Code Sending Ticket verifyCodeOld: type: string description: Old phone verification code sendTokenOld: type: string description: Old verification code sending ticket googleCode: type: string description: Google Verification Code required: - phoneArea - phone - verifyCode - sendToken - verifyCodeOld - sendTokenOld example: '' responses: '200': description: '' content: application/json: schema: *ref_8 headers: {} security: [] /global/customer.app.CustomerWebApiService.checkCustomerExist: post: summary: Check if customer information exists deprecated: false description: |- version=0.0.1 bizType=customer.app.CustomerWebApiService.checkCustomerExist Accessible to visitors operationId: checkCustomerExist tags: - Customer/Basic parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: loginName: type: string description: 'Account: Email/Phone Number' type: type: integer format: int32 description: 'Type: 1 Email, 2 Phone Number' minimum: 1 maximum: 3 emailArea: type: string description: Email area code, default area code is +86 phoneArea: type: string description: Phone area code, default area code is +86 required: - type - loginName example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: integer format: int32 description: Data body, 1 exists, 2 does not exist ok: type: boolean fail: type: boolean headers: {} security: [] /global/customer.app.CustomerWebApiService.destroy: post: summary: Customer cancellation deprecated: false description: |- version=0.0.1 bizType=customer.app.CustomerWebApiService.destroy Accessible after login operationId: destroy tags: - Customer/Basic parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: remark: type: string description: Cancellation remarks example: '' responses: '200': description: '' content: application/json: schema: *ref_8 headers: {} security: [] /global/customer.app.CustomerWebApiService.enableOrForbidMFA: post: summary: Google verification code binding and unbinding deprecated: false description: >- version=0.0.1 bizType=customer.app.CustomerWebApiService.enableOrForbidMFA Accessible after login If the user has bound a phone number, verify the phone number; if the user has bound an email, verify the email; if the user has bound both phone number and email, then both must be verified operationId: enableOrForbidMFA tags: - Customer/Basic parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/EnableOrForbidMFADTO' example: '' responses: '200': description: '' content: application/json: schema: *ref_8 headers: {} security: [] /global/customer.app.CustomerWebApiService.findCustomerInfo: post: summary: Query customer information deprecated: false description: |- version=0.0.1 bizType=customer.app.CustomerWebApiService.findCustomerInfo Access after login operationId: findCustomerInfo tags: - Customer/Basic parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: {} example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: object properties: id: type: integer format: int64 description: Customer ID companyId: type: integer format: int64 description: Company customerGroupId: type: integer format: int64 description: Customer group customerNo: type: string description: Customer account kycAuditStatus: type: integer format: int32 description: >- Registration KYC audit status: 0 uncertified, jump to certification page, 1 pending review, 2 review passed, 3 review failed kycAuditRemark: type: string description: Registration KYC audit remarks, not empty if rejected kycStatus: type: integer format: int32 description: >- KYC status, consistent with kycRemark: 1=unverified, 2=under review, 3=authentication failed, 4=authenticated, -1='' kycRemark: type: string description: >- KYC status name (1, "unverified", "KYC configured but not submitted"), (2, "under review", "KYC configured and under review, at least one level under review"), (3, "authentication failed", "KYC configured and submitted KYC rejected, at least one level rejected"), (4, "authenticated", "KYC configured and all levels authenticated"), (-1, "", "KYC configured, multiple levels, partially authenticated") accountList: type: object description: Trading Account List properties: {} accountRemark: type: string description: Whether the customer has a trading account note loginPassStatus: type: string description: >- Set password reminder flag, 1 for password required, 2 for not required payPassStatus: type: string description: >- Payment password existence status, 1 for non-existent, 2 for existent email: type: string description: Email phone: type: string description: Phone phoneArea: type: string description: Phone area code name: type: string description: Name country: type: string description: Country type: type: integer format: int32 description: Group type <0 real, 1 demo, 2 guest> deposit: type: integer format: int32 description: Depositable, 1 for depositable withdraw: type: integer format: int32 description: Withdrawable, 1 for withdrawable optional: type: integer format: int32 description: Customized flag 0 not added 1 added activateStatus: type: integer format: int32 description: Activation status, 0 not activated, 1 activated activateTime: type: integer format: int64 description: Activation time companyKycStatus: type: integer format: int32 description: >- Company KYC account opening status, 1 for opened, 2 for not opened status: type: integer format: int32 description: >- Status: 1 normal, 2 disabled, 3 deleted, 4 closed, 5 locked, 6 closing thirdServerCode: type: string description: Unique identifier from third-party system source: type: string description: Source thirdLoginSource: type: string description: Third-party login sources google, facebook, twitter thirdUserId: type: string description: Third-party userId idCard: type: string description: ID number idCardType: type: string description: ID type thirdIntactMsg: type: string description: Third-party login complete data firstName: type: string description: First name lastName: type: string description: Last name isFund: type: integer format: int32 description: Whether a fund manager, 1 is yes, default 0 is no assertPassStatus: type: string description: >- Set fund password reminder flag, 1 requires setting password, 2 does not require googleId: type: integer format: int64 description: >- Whether to enable MFA, greater than 0, enabled, otherwise not enabled openAccountType: type: integer format: int32 description: 'Account type: 0. Individual 1. Enterprise ' loginTime: type: integer format: int64 description: Login time createTime: type: integer format: int64 description: Creation time relationCustomerId: type: integer format: int64 description: Associated account id companyType: type: string description: Company type registerSource: type: integer format: int32 description: Registration source associationCompanyId: type: integer format: int64 description: Associated company Id registerTime: type: integer format: int64 description: Registration Time utmSource: type: string description: Advertising Source forceLevel: type: object description: Force Liquidation Level properties: {} earlyWarningLevel: type: object description: Warning Level properties: {} withdrawLevel: type: object description: Withdrawal Level properties: {} postalCode: type: string description: Postal Code customerAgentMark: type: string description: Customer Agent Identifier apiCheckSwitch: type: boolean description: API Verification Switch title: API Verification Switch apiCheckRule: type: string description: >- API Verification Rules. 1-Email; 2-SMS; 3-Google NFA; Enable multiple verifications at the same time, separated by commas. title: >- API Verification Rules. 1-Email; 2-SMS; 3-Google NFA; Enable multiple verifications at the same time, separated by commas. ok: type: boolean fail: type: boolean headers: {} security: [] /global/customer.app.CustomerWebApiService.forgetAssertsPwd: post: summary: Forget fund password deprecated: false description: |- version=0.0.1 bizType=customer.app.CustomerWebApiService.forgetAssertsPwd Accessible after login operationId: forgetAssertsPwd tags: - Customer/Basic parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: phoneArea: type: string description: >- Phone area code; when 'type' is 2: mobile phone number, this field is required; not specified, default is +86 loginName: type: string description: 'Account: Email/Phone Number' type: type: integer format: int32 description: 'Type: 1 Email, 2 Phone Number' minimum: 1 maximum: 3 newPwd: type: string description: New password, MD5 encryption minLength: 6 maxLength: 50 verifyCode: type: string description: Verification code sendToken: type: string description: Send ticket verifyCodeToken: type: string description: >- Verify ticket; verify the verification code interface to return token, prioritize checking this field. If the verification passes, then skip the verification of the send verification code interface to return sendToken. If the verification does not pass, then verify the send verification code interface to return sendToken required: - newPwd - type - loginName - verifyCode - sendToken - verifyCodeToken example: newPwd: Aa123456@ type: 1 loginName: 56234161@qq.com verifyCode: '232123' sendToken: asdsadasdasdsadsadsadsadad verifyCodeToken: adczczxczczczxczczxczxczxc responses: '200': description: '' content: application/json: schema: *ref_8 headers: {} security: [] /global/customer.app.CustomerWebApiService.forgetAssertsPwdV1v1v2: post: summary: Forget fund password (MFA) deprecated: false description: >- version=0.0.1 bizType=customer.app.CustomerWebApiService.forgetAssertsPwdV1v1v2 Accessible after login If the customer has enabled Google verification code (MFA), then the Google verification code (googleCode) in the input parameters is required. At the same time, the user does not need to enter the old phone number or old email operationId: forgetAssertsPwdV1v1v2 tags: - Customer/Basic parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: newPwd: type: string description: New password, MD5 encryption minLength: 5 maxLength: 50 verifyCode: type: string description: Verification code sendToken: type: string description: Send ticket type: type: integer format: int32 description: 'Type: 1 Email, 2 Phone Number' minimum: 1 maximum: 3 googleCode: type: string description: Google Verification Code required: - newPwd - type - verifyCode - sendToken example: '' responses: '200': description: '' content: application/json: schema: *ref_8 headers: {} security: [] /global/customer.app.CustomerWebApiService.forgetLoginPwd: post: summary: Forgot Login Password deprecated: false description: |- version=0.0.1 bizType=customer.app.CustomerWebApiService.forgetLoginPwd Guest Accessible operationId: forgetLoginPwd tags: - Customer/Basic parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: loginName: type: string description: 'Account: Email/Phone Number' phoneArea: type: string description: Phone area code, default area code is +86 type: type: integer format: int32 description: 'Type: 1 Email, 2 Phone Number' minimum: 1 maximum: 3 newPwd: type: string description: New password, MD5 encryption verifyCode: type: string description: Verification code sendToken: type: string description: Send ticket verifyCodeToken: type: string description: Validate Ticket googleCode: type: string description: Google Verification Code required: - newPwd - type - loginName - verifyCodeToken - sendToken - verifyCode example: '' responses: '200': description: '' content: application/json: schema: *ref_8 headers: {} security: [] /global/customer.app.CustomerWebApiService.bindAssertsPwd: post: summary: Set Fund Password for the First Time deprecated: false description: |- version=0.0.1 bizType=customer.app.CustomerWebApiService.bindAssertsPwd Accessible after login operationId: bindAssertsPwd tags: - Customer/Basic parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: pwd: type: string description: Password, MD5 encryption googleCode: type: string description: Google Verification Code required: - pwd example: pwd: sunt googleCode: '44' responses: '200': description: '' content: application/json: schema: *ref_8 examples: '1': summary: Exception Example - Fund password already set value: msg: Fund password has been set fail: true trace: x-kwm21-v8951-5vor62ft-006o-1677737070 code: CUSTOMER_API_0000133 data: customer.app.CustomerWebApiService.bindAssertsPwd bizCode: US tm: 3851542 msgParams: null ok: false headers: {} security: [] /global/customer.app.CustomerWebApiService.bindEmail: post: summary: Bind Email deprecated: false description: |- version=0.0.1 bizType=customer.app.CustomerWebApiService.bindEmail Access after login operationId: bindEmail tags: - Customer/Basic parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: verifyCode: type: string description: Verification code email: type: string description: Email maxLength: 50 sendToken: type: string description: Verification code sending ticket emailArea: type: string description: Email Area Code maxLength: 15 googleCode: type: string description: Google Verification Code required: - verifyCode - email - sendToken - emailArea example: '' responses: '200': description: '' content: application/json: schema: *ref_8 examples: '1': summary: Exception example - Verification code does not exist value: msg: Verification code is not correct fail: true trace: x-i2ps6-ol1gv4l4-17tc48-f72xfee-1677737300 code: CUSTOMER_API_0000511 data: customer.app.CustomerWebApiService.bindEmail bizCode: US tm: 19770126 msgParams: null ok: false headers: {} security: [] /global/customer.app.CustomerWebApiService.bindPhone: post: summary: Bind mobile phone number deprecated: false description: |- version=0.0.1 bizType=customer.app.CustomerWebApiService.bindPhone Accessible after login operationId: bindEmail tags: - Customer/Basic parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: verifyCode: type: string description: Verification code sendToken: type: string description: Verification code sending ticket googleCode: type: string description: Google Verification Code phone: type: string description: Phone Number maxLength: 50 phoneArea: type: string description: Phone area code maxLength: 15 required: - verifyCode - phone - sendToken - phoneArea example: '' responses: '200': description: '' content: application/json: schema: *ref_8 examples: '1': summary: Exception example - Verification code does not exist value: msg: Verification code is not correct fail: true trace: x-g82wr3b-3o3236-576oa-1er5di6-1677737445 code: CUSTOMER_API_0000511 data: customer.app.CustomerWebApiService.bindPhone bizCode: US tm: 15425229 msgParams: null ok: false headers: {} security: [] /global/customer.app.CustomerWebApiService.changeLang: post: summary: Switch language deprecated: false description: |- version=0.0.1 bizType=customer.app.CustomerWebApiService.changeLang Accessible after login operationId: changeLang tags: - Customer/Basic parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: newLang: type: string description: Language Information required: - newLang example: '' responses: '200': description: '' content: application/json: schema: *ref_8 examples: '1': summary: Success example value: msg: Success fail: false trace: x-k5l8-b16p6c93-d2glxw5-6z178usp-1677738101 code: '0' data: null bizCode: '' tm: 3818289 msgParams: null ok: true headers: {} security: [] /global/customer.app.CustomerWebApiService.findCustomerLang: post: summary: Query customer language deprecated: false description: |- version=0.0.1 bizType=customer.app.CustomerWebApiService.findCustomerLang Accessible after login operationId: changeLang tags: - Customer/Basic parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: {} example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: object properties: {} description: Language Information ok: type: boolean fail: type: boolean examples: '1': summary: Success example value: msg: Success fail: false trace: x-k5l8-b16p6c93-d2glxw5-6z178usp-1677738101 code: '0' data: null bizCode: '' tm: 3818289 msgParams: null ok: true headers: {} security: [] /global/customer.app.CustomerWebApiService.changeCustomerAddressAndPostalCode: post: summary: Modify Customer Communication Address and Postal Code deprecated: false description: >- version=0.0.1 bizType=customer.app.CustomerWebApiService.changeCustomerAddressAndPostalCode Accessible after login operationId: changeLang tags: - Customer/Basic parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: address: type: string description: Communication Address postalCode: type: string description: Postal Code required: - postalCode - address example: postalCode: '90210' address: Da Dong Men, Wuhan, Hubei, China responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: object properties: {} description: Language Information ok: type: boolean fail: type: boolean examples: '1': summary: Success example value: msg: Success fail: false trace: x-k5l8-b16p6c93-d2glxw5-6z178usp-1677738101 code: '0' data: null bizCode: '' tm: 3818289 msgParams: null ok: true headers: {} security: [] /global/customer.app.CustomerWebApiService.firstSetPhone: post: summary: First set phone number (TG) deprecated: false description: |- version=0.0.1 bizType=customer.app.CustomerWebApiService.firstSetPhone Accessible after login operationId: changeLang tags: - Customer/Basic parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: phoneArea: type: string description: Phone area code maxLength: 15 phone: type: string description: Phone maxLength: 50 verifyCode: type: string description: >- Mobile verification code, send verification code bizType=SMS_COMMON_VERIFICATION_CODE sendToken: type: string description: Mobile verification code sent ticket thirdSource: type: string description: 'Third-party source: telegram' verifyCodeThirdType: type: string description: >- Third-party verification code, used in conjunction with thirdSource, when thirdSource=telegram, the verification code bizType can only be SMS_TELEGRAM_VERIFICATION_CODE title: '' sendTokenThirdType: type: string description: >- Third-party verification code sent ticket, used in conjunction with thirdSource, when thirdSource=telegram, the verification code bizType can only be SMS_TELEGRAM_VERIFICATION_CODE required: - verifyCode - phoneArea - sendToken - verifyCodeThirdType - sendTokenThirdType - thirdSource - phone example: verifyCode: '57' phoneArea: '18127152839' sendToken: occaecat exercitation verifyCodeThirdType: '21' sendTokenThirdType: ad pariatur ut thirdSource: occaecat voluptate sit tempor phone: '18190281711' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: object properties: {} description: Language Information ok: type: boolean fail: type: boolean examples: '1': summary: Success example value: msg: Success fail: false trace: x-k5l8-b16p6c93-d2glxw5-6z178usp-1677738101 code: '0' data: null bizCode: '' tm: 3818289 msgParams: null ok: true headers: {} security: [] /global/customer.app.CustomerWebApiService.firstSetEmail: post: summary: First Time Setting Email (TG) deprecated: false description: |- version=0.0.1 bizType=customer.app.CustomerWebApiService.firstSetEmail Accessible after login operationId: changeLang tags: - Customer/Basic parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: email: type: string description: Email maxLength: 50 verifyCode: type: string description: >- Email verification code, send verification code bizType=SMS_COMMON_VERIFICATION_CODE sendToken: type: string description: Email verification code sending ticket thirdSource: type: string description: 'Third-party source: telegram' verifyCodeThirdType: type: string description: >- Third-party verification code, used in conjunction with thirdSource, when thirdSource=telegram, the verification code bizType can only be SMS_TELEGRAM_VERIFICATION_CODE title: '' sendTokenThirdType: type: string description: >- Third-party verification code sent ticket, used in conjunction with thirdSource, when thirdSource=telegram, the verification code bizType can only be SMS_TELEGRAM_VERIFICATION_CODE required: - verifyCode - sendToken - verifyCodeThirdType - sendTokenThirdType - thirdSource - email example: verifyCode: '57' sendToken: occaecat exercitation verifyCodeThirdType: '21' sendTokenThirdType: ad pariatur ut thirdSource: occaecat voluptate sit tempor email: 18190281711@qq.com responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: object properties: {} description: Language Information ok: type: boolean fail: type: boolean examples: '1': summary: Success example value: msg: Success fail: false trace: x-k5l8-b16p6c93-d2glxw5-6z178usp-1677738101 code: '0' data: null bizCode: '' tm: 3818289 msgParams: null ok: true headers: {} security: [] /global/customer.app.CustomerWebApiService.firstTimeSettingLoginPassword: post: summary: First Time Setting Login Password (TG) deprecated: false description: |- version=0.0.1 bizType=customer.app.CustomerWebApiService.firstTimeSettingLoginPassword Accessible after login operationId: changeLang tags: - Customer/Basic parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: newPwd: type: string description: Password, MD5 encryption minLength: 32 maxLength: 32 googleCode: type: string description: Google Verification Code required: - newPwd example: newPwd: Aa123456@ responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: object properties: {} description: Language Information ok: type: boolean fail: type: boolean examples: '1': summary: Success example value: msg: Success fail: false trace: x-k5l8-b16p6c93-d2glxw5-6z178usp-1677738101 code: '0' data: null bizCode: '' tm: 3818289 msgParams: null ok: true headers: {} security: [] /global/customer.app.CustomerWebApiService.findThirdAccountInfo: post: summary: Query Customer 3rd Party Binding Information deprecated: false description: |- version=0.0.1 bizType=customer.app.CustomerWebApiService.findThirdAccountInfo Access after login operationId: changeLang tags: - Customer/Basic parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: {} example: {} responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: object properties: customerNo: type: string description: Customer account thirdLoginSource: type: string description: >- Third-party sources, multiple comma-separated, google, facebook, twitter thirdUserId: type: string description: >- Third-party userId, multiple comma-separated, in the same order as thirdLoginSource thirdIntactMsg: type: string description: Complete user information obtained from third-party tgStatus: type: string description: >- TG Bot Subscription Status, SUBSCRIBE=Subscribed, UNSUBSCRIBE=Unsubscribed description: Data Body ok: type: boolean fail: type: boolean examples: '1': summary: Success example value: msg: Success fail: false trace: x-k5l8-b16p6c93-d2glxw5-6z178usp-1677738101 code: '0' data: null bizCode: '' tm: 3818289 msgParams: null ok: true headers: {} security: [] /global/customer.app.CustomerWebApiService.checkGoogleMFAStatus: post: summary: Check if the customer has enabled GoogleMFA deprecated: false description: |- version=0.0.1 bizType=customer.app.CustomerWebApiService.checkGoogleMFAStatus Guest access operationId: checkGoogleMFAStatus tags: - Customer/Basic parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: loginName: type: string description: 'Account: Email/Phone Number' phoneArea: type: string description: Area code, default area code is +86 type: type: integer format: int32 description: 'Type: 1 Email, 2 Phone Number' minimum: 1 maximum: 3 required: - type - phoneArea example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: object description: >- Response body, greater than 0 means enabled, otherwise not enabled properties: {} ok: type: boolean fail: type: boolean examples: '1': summary: Success example value: msg: Success fail: false trace: x-b4ypj54-y9t32s7-5757xb-v60725g8-1677740298 code: '0' data: -1 bizCode: '' tm: 19151998 msgParams: null ok: true headers: {} security: [] /global/customer.app.CustomerWebApiService.checkStatus: post: summary: Check customer status deprecated: false description: >- version=0.0.1 bizType=customer.app.CustomerWebApiService.checkStatus Determine customer status: 1 exists, 2 does not exist, -1 customer is disabled This interface requires login operationId: checkStatus tags: - Customer/Basic parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: loginName: type: string description: 'Account: Email/Phone Number' type: type: integer format: int32 description: 'Type: 1 Email, 2 Phone Number' minimum: 1 maximum: 3 required: - type example: '' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/BaseResultCustomerStatusVO' examples: '1': summary: Success example value: msg: Success fail: false trace: x-774phjw-g77e96y-7ogx9r8a-z7831eh-1677740174 code: '0' data: country: CN phoneArea: '+86' status: 1 bizCode: '' tm: 17093534 msgParams: null ok: true headers: {} security: [] /global/customer.app.CustomerWebApiService.queryAccountAssetsInfo: post: summary: Query account asset information (leverage) deprecated: false description: |- version=0.0.1 bizType=customer.app.CustomerWebApiService.queryAccountAssetsInfo Accessible after login operationId: queryAccountAssetsInfo tags: - Customer/Basic parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: tradeType: type: integer format: int64 description: Play Id, 3-CROSS; 5-MATCH; minimum: 1 accountId: type: integer format: int64 description: Account Id, at least one of accountCurrency must exist accountCurrency: type: string description: Account currency and accountCurrency must exist at least one required: - tradeType example: '' responses: '200': description: '' content: application/json: schema: *ref_8 headers: {} security: [] /global/customer.app.CustomerWebApiService.queryAccountById: post: summary: Real-time account fund information deprecated: false description: |- version=0.0.1 bizType=customer.app.CustomerWebApiService.queryAccountById Accessible after login operationId: queryAccountById tags: - Customer/Basic parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: tradeType: type: integer format: int64 description: Play Id, 1-CFD_MM; 2-CFD_WBW; 3-CROSS; 5-MATCH; minimum: 1 accountId: type: integer format: int64 description: Account Id, at least one of currency must exist currency: type: string description: Opening currency, at least one of accountId must exist required: - tradeType example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: object properties: companyId: type: integer description: Company ID tradeType: type: integer description: Game ID customerId: type: integer description: Buyer system unique customer identifier customerNo: type: string description: Buyer company unique customer code accountId: type: integer description: System unique account identifier type: type: integer description: >- Account classification (1-user, 2-merchant, 3-platform) status: type: integer description: Account status (1-not available, 2-available) activateStatus: type: integer description: Activation status (1-not available, 2-available) activateTime: type: integer description: Activation time remark: type: string description: Remarks currency: type: string description: Account currency digits: type: integer description: Funds decimal places withdrawAmount: type: string description: Available amount createTime: type: integer description: Account opening time firstDepositTime: type: integer description: First deposit time firstWithdrawTime: type: integer description: First withdrawal time assetsId: type: integer description: Account currency id balance: type: string description: Balance available: type: string description: Available equity: type: string description: Net Value lockAmount: type: string description: Balance lock profit: type: string description: Real-time profit and loss margin: type: string description: Real-time margin used notWithdrawAmount: type: string description: Frozen withdrawable amount freeMargin: type: string description: Real-time available margin lockMargin: type: string description: Margin in use liabilities: type: string description: Total liabilities liabilitiesPrincipal: type: string description: Liabilities - Principal interest: type: string description: Interest netAssets: type: string description: Net assets frozen: type: string description: Frozen collateralFrozen: type: string description: Collateral frozen availableLoan: type: string description: Available to borrow interestProportion: type: string description: Daily interest rate marginRadio: type: string description: Margin ratio wholeWarehouseBalance: type: string description: Estimated value of account assets wholeWarehouseRate: type: string description: Exchange rate of account assets openAccountStatus: type: boolean description: Account status required: - companyId - tradeType - accountId - customerNo - type - status - activateStatus - activateTime - remark - createTime - firstDepositTime - firstWithdrawTime - assetsId - currency - digits - balance - available - equity - withdrawAmount - lockAmount - profit - margin - notWithdrawAmount - freeMargin - lockMargin - liabilities - liabilitiesPrincipal - interest - netAssets - frozen - collateralFrozen - availableLoan - interestProportion - marginRadio - customerId - wholeWarehouseBalance - wholeWarehouseRate - openAccountStatus description: Data Body ok: type: boolean fail: type: boolean required: - data headers: {} security: [] /global/customer.app.CustomerWebApiService.queryCustomerAssets: post: summary: Query customer assets deprecated: false description: |- version=0.0.1 bizType=customer.app.CustomerWebApiService.queryCustomerAssets Accessible after login operationId: queryCustomerAssets tags: - Customer/Basic parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: tradeType: type: integer format: int64 description: Game ID example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: object properties: assetsId: type: integer description: Asset ID currency: type: string description: Asset code digits: type: integer description: Funds decimal places balance: type: string description: Balance required: - assetsId - currency - digits - balance description: Data Body ok: type: boolean fail: type: boolean required: - data examples: '1': summary: Success example value: msg: Success fail: false trace: x-9q2v3u1-9c89e2-4epa-1w3zd-1677741772 code: '0' data: balance: '109849160.9462' currency: USDT digits: 4 assetsId: 13 bizCode: C tm: 209517656 msgParams: null ok: true headers: {} security: [] /global/customer.app.CustomerWebApiService.queryCustomerAssetsInfo: post: summary: Customer total asset information (does not support contract gameplay) deprecated: false description: |- version=0.0.1 bizType=customer.app.CustomerWebApiService.queryCustomerAssetsInfo Accessible after login operationId: queryCustomerAssetsInfo tags: - Customer/Basic parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: tradeType: type: integer format: int64 description: >- Gameplay ID, 3-CROSS; 5-MATCH; 8-WALLET; (does not support contract gameplay) minimum: 1 accountCurrency: type: string description: >- Account currency, separated by ',' between multiple assets. E.g.: USD, CNY. If not provided, all will be returned by default required: - tradeType example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string data: type: object properties: currency: type: string description: Total account calculation currency digits: type: integer description: Funds decimal places totalAvailable: type: string description: Total available (total assets - total frozen) closeProportion: type: string description: Risk rate (percentage) riskLevel: type: integer description: Risk level totalBalance: type: string description: Total assets totalLiabilities: type: string description: >- Total liabilities (total liabilities - principal + total interest) companyId: type: integer description: Company ID totalNetAssets: type: string description: Total Net Assets (Total Assets - Total Liabilities) totalInterest: type: string description: Total Interest tradeType: type: integer description: Game ID customerNo: type: string description: Client number totalLiabilitiesPrincipal: type: string description: Total Liabilities - Principal accountInfoMap: type: object properties: companyId: type: integer description: Company ID tradeType: type: integer description: Game ID accountId: type: integer description: System unique account identifier customerNo: type: string description: Buyer company unique customer code type: type: integer description: >- Account classification (1-user, 2-merchant, 3-platform) status: type: integer description: Account status (1-not available, 2-available) activateStatus: type: integer description: Activation status (1-not available, 2-available) activateTime: type: integer description: Activation time remark: type: string description: Remarks createTime: type: integer description: Account opening time firstDepositTime: type: integer description: First deposit time firstWithdrawTime: type: integer description: First withdrawal time assetsId: type: integer description: Account currency id currency: type: string description: Account currency digits: type: integer description: Funds decimal places balance: type: string description: Balance available: type: string description: Available equity: type: string description: Net Value withdrawAmount: type: string description: Available amount lockAmount: type: string description: Balance lock profit: type: string description: Real-time profit and loss margin: type: string description: Real-time margin used notWithdrawAmount: type: string description: Frozen withdrawable amount freeMargin: type: string description: Real-time available margin lockMargin: type: string description: Margin in use liabilities: type: string description: Total liabilities liabilitiesPrincipal: type: string description: Liabilities - Principal interest: type: string description: Interest netAssets: type: string description: Net assets frozen: type: string description: Frozen collateralFrozen: type: string description: Collateral frozen availableLoan: type: string description: Available to borrow interestProportion: type: string description: Daily interest rate marginRadio: type: string description: Margin ratio customerId: type: integer description: Buyer system unique customer identifier wholeWarehouseBalance: type: string description: >- Exchange Account Asset Estimated Price. This value only exists in gameplay 5 (added in v2.2.1) wholeWarehouseRate: type: string description: >- Exchange Account Asset Exchange Rate. This value only exists in gameplay 5 (added in v2.2.1) openAccountStatus: type: boolean description: Account status formulaSymbol: type: string title: Exchange Rate Calculation Direction description: >- multiply-Multiply; divide-Divide; This value only exists in gameplay 5 (added in v2.2.1) description: Attached Account Information. Key is Asset Code required: - accountInfoMap - totalAvailable - closeProportion - riskLevel - totalBalance - totalLiabilities - companyId - totalNetAssets - currency - digits - totalInterest - tradeType - customerNo - totalLiabilitiesPrincipal description: Data Body ok: type: boolean fail: type: boolean required: - data - msg - trace - code - bizCode - tm - msgParams examples: '1': summary: Success example value: msg: Success fail: false trace: x-syhv7-d3a53n34-z4k54-458414-1677741850 code: '0' data: totalAvailable: '348191.9105' closeProportion: 26.61% riskLevel: 2 totalBalance: '348191.9105' totalLiabilities: '1308283.6711' companyId: null totalNetAssets: '-960091.7606' currency: USDT digits: 4 totalInterest: '1068275.4978' tradeType: 3 customerNo: null totalLiabilitiesPrincipal: '240008.1733' accountInfoMap: SAND: netAssets: '0.000000' lastOrderId: '0' available: '0.000000' remark: null type: 1 equity: '0.000000' firstDepositTime: null lockMargin: '0.000000' balance: '0.000000' interest: '0.000000' customerId: 1176 liabilities: '0.000000' currency: SAND activateStatus: 2 withdrawAmount: '0.000000' profit: '0' tradeType: 3 wholeWarehouseBalance: null freeMargin: '0' margin: '0' firstWithdrawTime: null activateTime: 1648792208194 weight: null frozen: '0.000000' wholeWarehouseRate: null accountId: 1031752 companyId: 360 liabilitiesPrincipal: '0.000000' interestProportion: '0' createTime: 1648777706190 lockAmount: '0.000000' notWithdrawAmount: '0.000000' digits: 6 customerNo: '86001175' status: 2 assetsId: 29 bizCode: C tm: 171612280 msgParams: null ok: true headers: {} security: [] /global/customer.app.CustomerWebApiService.queryLiabilitiesWaterByPage: post: summary: Borrowing and repayment flow list (leverage) deprecated: false description: |- version=0.0.1 bizType=customer.app.CustomerWebApiService.queryLiabilitiesWaterByPage Accessible after login operationId: queryLiabilitiesWaterByPage tags: - Customer/Basic parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: size: type: integer format: int64 description: Number of Items per Page current: type: integer format: int64 description: Current Page tradeType: type: integer format: int64 description: Game ID minimum: 1 liabilitiesType: type: integer format: int32 description: 1-Loan; 2-Repayment startTime: type: integer format: int64 description: Start Time endTime: type: integer format: int64 description: End Time accountId: type: integer format: int64 description: Account Id assetsId: type: integer format: int64 description: Asset ID required: - tradeType example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: object properties: total: type: integer description: Total size: type: integer description: Number of Items per Page current: type: integer description: Current Page records: type: object properties: id: type: integer description: Flow ID accountId: type: integer description: Account Id remark: type: string description: Remarks createdBy: type: integer description: Creator createTime: type: integer description: Creation date updateBy: type: integer description: Updater updateTime: type: integer description: Update Time businessType: type: integer description: >- Business type. Leverage: 19-Automatic loan; 20-Manual loan; 21-Automatic repayment; 22-Manual repayment; 23-Loan interest; 35-Backend repayment; 40-Force liquidation repayment; ABCC: 29-Automatic loan; 30-Manual loan; 31-Automatic repayment; 32-Manual repayment; 33-Loan interest; 34-Backend repayment; 41-Force liquidation repayment; businessType1: type: integer description: >- Business sub-type. Leverage: 19001-Loan principal; 20001-Loan principal; 21001-Repayment principal; 21002-Repayment interest; 22001-Repayment principal; 22002-Repayment interest; 23001-Loan interest; 35001-Repayment principal; 35002-Repayment interest; 40001-Force liquidation return principal; 40002-Force liquidation return interest; ABCC: 29001-Loan principal; 30001-Loan principal; 31001-Repayment principal; 31002-Repayment interest; 32001-Repayment principal; 32002-Repayment interest; 33001-Loan interest; 34001-Repayment principal; 34002-Repayment interest; 41001-Force liquidation return principal; 41002-Force liquidation return interest; customerNo: type: string description: Customer Code digits: type: integer description: Decimal Places liabilitiesPrincipal: type: string description: Debt_Principal interest: type: string description: Interest interestUpdateTime: type: integer description: Last update time of interest currency: type: string description: Asset code liabilities: type: string description: Debt required: - id - accountId - remark - createdBy - createTime - updateBy - updateTime - businessType - businessType1 - customerNo - digits - liabilitiesPrincipal - interest - interestUpdateTime - currency - liabilities description: List required: - records - total - size - current description: Data Body ok: type: boolean fail: type: boolean required: - data headers: {} security: [] /global/customer.app.CustomerWebApiService.updateAssertsPwd: post: summary: Modify fund password deprecated: false description: |- version=0.0.1 bizType=customer.app.CustomerWebApiService.updateAssertsPwd Accessible after login operationId: updateAssertsPwd tags: - Customer/Basic parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: oldPwd: type: string description: Old password, MD5 encryption newPwd: type: string description: New password, MD5 encryption googleCode: type: string description: Google Verification Code required: - newPwd - oldPwd example: '' responses: '200': description: '' content: application/json: schema: *ref_8 headers: {} security: [] /global/customer.app.CustomerWebApiService.updateAssertsPwdMFA: post: summary: Modify fund password (MFA) deprecated: false description: |- version=0.0.1 bizType=customer.app.CustomerWebApiService.updateAssertsPwdMFA Accessible after login operationId: updateAssertsPwd tags: - Customer/Basic parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: oldPwd: type: string description: Old password, MD5 encryption minLength: 6 maxLength: 50 newPwd: type: string description: New password, MD5 encryption minLength: 6 maxLength: 50 googleCode: type: string description: Google Verification Code verifyCode: type: string description: >- Verification code, send verification code interface bizType=EMAIL_LOGINED_VERIFICATION_CODE (email), SMS_LOGINED_VERIFICATION_CODE (phone) sendToken: type: string description: Send ticket type: type: integer description: 'Type: 1 Email, 2 Phone Number' format: int32 minimum: 1 maximum: 2 required: - newPwd - oldPwd - verifyCode - sendToken - type example: '' responses: '200': description: '' content: application/json: schema: *ref_8 headers: {} security: [] /global/customer.app.CustomerWebApiService.updateLoginPwd: post: summary: Modify login password deprecated: false description: |- version=0.0.1 bizType=customer.app.CustomerWebApiService.updateLoginPwd Accessible after login operationId: updateLoginPwd tags: - Customer/Basic parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: oldPwd: type: string description: Old password, MD5 encryption newPwd: type: string description: New password, MD5 encryption googleCode: type: string description: Google Verification Code required: - newPwd - oldPwd example: '' responses: '200': description: '' content: application/json: schema: *ref_8 headers: {} security: [] /global/customer.app.CustomerWebApiService.updateLoginPwdMFA: post: summary: Modify login password (MFA) deprecated: false description: |- version=0.0.1 bizType=customer.app.CustomerWebApiService.updateLoginPwdMFA Accessible after login operationId: updateAssertsPwd tags: - Customer/Basic parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: oldPwd: type: string description: Old password, MD5 encryption minLength: 6 maxLength: 50 newPwd: type: string description: New password, MD5 encryption minLength: 6 maxLength: 50 googleCode: type: string description: Google Verification Code verifyCode: type: string description: >- Verification code, send verification code interface bizType=EMAIL_LOGINED_VERIFICATION_CODE (email), SMS_LOGINED_VERIFICATION_CODE (phone) sendToken: type: string description: Send ticket type: type: integer description: 'Type: 1 Email, 2 Phone Number' format: int32 minimum: 1 maximum: 2 required: - newPwd - oldPwd - verifyCode - sendToken - type example: '' responses: '200': description: '' content: application/json: schema: *ref_8 examples: '1': summary: Success example value: msg: Success fail: false trace: x-h8hndw-rps6j-bl9q63-7yf0eh5-1679385371 code: '0' data: null bizCode: '' tm: 29515800 msgParams: null ok: true headers: {} security: [] /global/customer.app.CustomerWebApiService.groupList: post: summary: Query customer group list deprecated: false description: |- version=0.0.1 bizType=customer.app.CustomerWebApiService.groupList Accessible to visitors operationId: updateLoginPwd tags: - Customer/Basic parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: {} example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: object description: Data Body properties: id: type: integer description: Customer group ID name: type: string description: Customer Group Name openAccountType: type: integer description: Is it an account opening group, 1 for yes, 0 for no type: type: integer description: >- Customer group type, 0 for real, 1 for test, 2 for guest ok: type: boolean fail: type: boolean headers: {} security: [] /global/customer.app.CustomerWebApiService.changeEmailMFA: post: summary: Modify email (MFA) Copy deprecated: false description: >- version=0.0.1 bizType=customer.app.CustomerWebApiService.changeEmailMFA Accessible after login This interface: can independently choose old credential verification method operationId: updateAssertsPwd tags: - Customer/Basic parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: email: type: string description: New Email maxLength: 50 verifyCodeNew: type: string description: >- New verification code, send verification code bizType=EMAIL_COMMON_VERIFICATION_CODE sendTokenNew: type: string description: New Verification Code Sending Ticket type: type: integer description: 'Type: 1 Email, 2 Phone Number' format: int32 minimum: 1 maximum: 2 verifyCodeOld: type: string description: >- Original verification code, used in conjunction with type, when type=1, send verification code bizType can only be EMAIL_LOGINED_VERIFICATION_CODE, type=2, bizType=SMS_LOGINED_VERIFICATION_CODE title: '' sendTokenOld: type: string description: >- Original verification code sending ticket, used in conjunction with type, when type=1, send verification code bizType can only be EMAIL_LOGINED_VERIFICATION_CODE, type=2, bizType=SMS_LOGINED_VERIFICATION_CODE googleCode: type: string description: Google Verification Code required: - verifyCodeNew - email - sendTokenNew - verifyCodeOld - sendTokenOld - type example: verifyCodeNew: '57' email: k.uogz@qq.com sendTokenNew: non verifyCodeOld: '72' sendTokenOld: velit ut officia minim non type: 1 googleCode: '64' responses: '200': description: '' content: application/json: schema: *ref_8 examples: '1': summary: Success example value: msg: Success fail: false trace: x-h8hndw-rps6j-bl9q63-7yf0eh5-1679385371 code: '0' data: null bizCode: '' tm: 29515800 msgParams: null ok: true headers: {} security: [] /global/customer.app.CustomerWebApiService.changePhoneMFA: post: summary: Modify phone (MFA) Copy deprecated: false description: >- version=0.0.1 bizType=customer.app.CustomerWebApiService.changePhoneMFA Accessible after login This interface: can independently choose old credential verification method operationId: updateAssertsPwd tags: - Customer/Basic parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: phoneArea: type: string description: Phone area code maxLength: 15 phone: type: string description: Phone maxLength: 50 verifyCodeNew: type: string description: >- New verification code, send verification code bizType=SMS_COMMON_VERIFICATION_CODE sendTokenNew: type: string description: New Verification Code Sending Ticket type: type: integer description: 'Type: 1 Email, 2 Phone Number' format: int32 minimum: 1 maximum: 2 verifyCodeOld: type: string description: >- Original verification code, used in conjunction with type, when type=1, send verification code bizType can only be EMAIL_LOGINED_VERIFICATION_CODE, type=2, bizType=SMS_LOGINED_VERIFICATION_CODE title: '' sendTokenOld: type: string description: >- Original verification code sending ticket, used in conjunction with type, when type=1, send verification code bizType can only be EMAIL_LOGINED_VERIFICATION_CODE, type=2, bizType=SMS_LOGINED_VERIFICATION_CODE googleCode: type: string description: Google Verification Code required: - verifyCodeNew - phoneArea - sendTokenNew - verifyCodeOld - sendTokenOld - type - phone example: verifyCodeNew: '12' phoneArea: '19845120732' sendTokenNew: laborum Ut verifyCodeOld: '18' sendTokenOld: enim aute dolor culpa type: 1 phone: '18639656874' googleCode: '97' responses: '200': description: '' content: application/json: schema: *ref_8 examples: '1': summary: Success example value: msg: Success fail: false trace: x-h8hndw-rps6j-bl9q63-7yf0eh5-1679385371 code: '0' data: null bizCode: '' tm: 29515800 msgParams: null ok: true headers: {} security: [] /global/customer.app.CustomerWebApiService.changeCountry: post: summary: Modify country deprecated: false description: >- version=0.0.1 bizType=customer.app.CustomerWebApiService.changeCountry You can access it after logging in. If the customer has an approved KYC, the country change will be rejected. After the change is successful, all the KYCs pending for review in the country where the customer changed before will be rejected. operationId: updateAssertsPwd tags: - Customer/Basic parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: newCountry: type: string description: Country code maxLength: 15 required: - newCountry example: '' responses: '200': description: '' content: application/json: schema: *ref_8 examples: '1': summary: Success example value: msg: Success fail: false trace: x-h8hndw-rps6j-bl9q63-7yf0eh5-1679385371 code: '0' data: null bizCode: '' tm: 29515800 msgParams: null ok: true headers: {} security: [] /global/customer.app.CustomerWebApiService.bindAssertsPwdMFA: post: summary: Set fund password (MFA) deprecated: false description: |- version=0.0.1 bizType=customer.app.CustomerWebApiService.bindAssertsPwdMFA After logging in, you can access it. operationId: bindAssertsPwd tags: - Customer/Basic parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: newPwd: type: string description: Password, MD5 encryption minLength: 6 maxLength: 50 verifyCode: type: string description: >- Verification code, send verification code interface bizType=EMAIL_LOGINED_VERIFICATION_CODE (email), SMS_LOGINED_VERIFICATION_CODE (phone) sendToken6: type: string description: Send ticket type: type: integer format: int32 description: 'Type: 1 Email, 2 Phone Number' minimum: 1 maximum: 3 googleCode: type: string description: Google Verification Code required: - newPwd - type - verifyCode - sendToken6 example: newPwd: eu Ut sint type: 1 verifyCode: '712311' sendToken: '{{sendToken}}' responses: '200': description: '' content: application/json: schema: *ref_8 examples: '1': summary: Exception Example - Fund password already set value: msg: Fund password has been set fail: true trace: x-kwm21-v8951-5vor62ft-006o-1677737070 code: CUSTOMER_API_0000133 data: customer.app.CustomerWebApiService.bindAssertsPwd bizCode: US tm: 3851542 msgParams: null ok: false headers: {} security: [] /global/customer.app.CustomerWebApiService.forgetAssertsPwdMFA: post: summary: Reset fund password (MFA) deprecated: false description: |- version=0.0.1 bizType=customer.app.CustomerWebApiService.forgetAssertsPwdMFA After logging in, you can access it. operationId: bindAssertsPwd tags: - Customer/Basic parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: newPwd: type: string description: Password, MD5 encryption minLength: 6 maxLength: 50 verifyCode: type: string description: >- Verification code, send verification code interface bizType=EMAIL_LOGINED_VERIFICATION_CODE (email), SMS_LOGINED_VERIFICATION_CODE (phone) sendToken: type: string description: Send ticket type: type: integer format: int32 description: 'Type: 1 Email, 2 Phone Number' minimum: 1 maximum: 3 googleCode: type: string description: Google Verification Code required: - newPwd - type - verifyCode - sendToken example: newPwd: eu Ut sint type: 1 verifyCode: '712311' sendToken: '{{sendToken}}' responses: '200': description: '' content: application/json: schema: *ref_8 examples: '1': summary: Exception Example - Fund password already set value: msg: Fund password has been set fail: true trace: x-kwm21-v8951-5vor62ft-006o-1677737070 code: CUSTOMER_API_0000133 data: customer.app.CustomerWebApiService.bindAssertsPwd bizCode: US tm: 3851542 msgParams: null ok: false headers: {} security: [] /global/customer.app.CustomerWebApiService.bindThirdAccount: post: summary: Bind third-party account information deprecated: false description: |- version=0.0.1 bizType=customer.app.CustomerWebApiService.bindThirdAccount After logging in, you can access it. tags: - Customer/Basic parameters: - name: version in: header description: '' required: false example: 0.0.1 schema: type: string - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: lang in: header description: '' required: false example: zh-CN schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string requestBody: content: application/json: schema: type: object properties: thirdLoginSource: type: string maxLength: 10 description: Third-party source, telegram thirdUserId: type: string description: Third-party userId maxLength: 45 thirdIntactMsg: type: string description: >- The complete user information obtained by the third party must be in json format required: - thirdLoginSource - thirdUserId example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: object description: Data Body properties: {} ok: type: boolean fail: type: boolean examples: '1': summary: Success example value: msg: Success fail: false trace: x-w67a-m983h6dw-30535g-x321-1677575540 code: '0' data: null bizCode: '' tm: 46426649 msgParams: null ok: true headers: {} security: [] /global/customer.app.CustomerWebApiService.queryLatestBalanceOfUserAccountInExternalSystem: post: summary: Query the balance of the account in the third-party system deprecated: false description: >- version=0.0.1 bizType=customer.app.CustomerWebApiService.queryLatestBalanceOfUserAccountInExternalSystem Access after login tags: - Customer/Basic parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string requestBody: content: application/json: schema: type: object properties: {} example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: object properties: amount: type: string description: Balance of the third-party account currency: type: string description: Currency amountDigits: type: string description: Decimal places for account balance description: Data Body ok: type: boolean fail: type: boolean headers: {} security: [] /global/customer.app.CustomerWebApiService.findPhoneAndEmail: post: summary: Query customer's phone and email deprecated: false description: |- version=0.0.1 bizType=customer.app.CustomerWebApiService.findPhoneAndEmail Access after login tags: - Customer/Basic parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string requestBody: content: application/json: schema: type: object properties: {} example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: object properties: customerNo: type: string description: Customer account email: type: string description: Email phone: type: string description: Phone phoneArea: type: string description: Phone area code ok: type: boolean fail: type: boolean headers: {} security: [] /global/customer.app.CustomerThirdLoginService.config: post: summary: Get Third-Party Login Configuration Information deprecated: false description: >- version=0.0.1 bizType=customer.app.CustomerThirdLoginService.config Guest Accessible operationId: config tags: - Customer/Social parameters: - name: version in: header description: '' required: true example: 0.0.1 schema: type: string - name: companyId in: header description: '' required: true example: '{{company}}' schema: type: string - name: trace in: header description: '' required: true example: '{{mock_trace}}' schema: type: string - name: lang in: header description: '' required: true example: zh-CN schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string requestBody: content: application/json: schema: type: object properties: thirdSource: type: string description: >- Third-Party Sources: google, facebook, twitter, telegram, apple, metamask example: '' responses: '200': description: '' content: application/json: schema: type: object properties: code: type: string description: >- Status Return Code, code=0 indicates current request operation success, other codes handle exceptions msg: type: string description: Status description bizCode: type: string description: Module identifier code tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: object properties: thirdSource: type: string title: '' description: 'Third-Party Sources: google, facebook, twitter…' clientId: type: string title: '' description: Client ID developerAccount: type: string description: Third-Party Development Account required: - thirdSource - clientId - developerAccount description: Data Body required: - code - data - msgParams - trace - tm - bizCode - msg headers: {} security: [] /h/com.cats.customer.api.app.CustomerThirdLoginService/appleVerify: post: summary: Apple Third-party Login Verification deprecated: false description: |- version=0.0.1 bizType=customer.app.CustomerThirdLoginService.appleVerify Accessible after login operationId: appleVerify tags: - Customer/Social parameters: [] requestBody: content: application/json: schema: type: object properties: companyId: type: integer title: Company ID openId: type: string title: Third-party Open ID description: Required on app end identityToken: type: string title: Identity Token description: Required on app end email: type: integer title: Optional on app end code: type: string title: Authorization Code description: Required on web end idToken: type: string title: token description: Required on web end required: - companyId example: '' responses: '200': description: '' content: application/json: schema: type: object properties: code: type: string title: System General Return Code description: 0-Success, other exceptions msg: type: string title: Return information bizCode: type: string title: Module identifier code tm: title: Processing time (milliseconds) type: integer trace: type: string title: Global link flag information msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: object properties: userId: type: string title: Third-party userId action: type: string title: Next Operation Behavior description: login, bind, register result: title: Validation Result type: boolean failReason: type: string title: Validation Failure Reason thirdSource: type: string title: Third-party Login Source description: google,facebook,twitter… email: type: string title: Email phone: type: string title: Phone Number required: - userId - phone - email - thirdSource - failReason - result - action required: - code - data - msgParams - trace - tm - bizCode - msg headers: {} security: [] /third/login/customer.app.CustomerThirdLoginService.facebookVerify: post: summary: Facebook Third-party Login Verification deprecated: false description: |- version=0.0.1 bizType=customer.app.CustomerThirdLoginService.facebookVerify Access after login operationId: facebookVerify tags: - Customer/Social parameters: [] requestBody: content: application/json: schema: type: object properties: accessToken: type: string description: Verify accessToken example: '' responses: '200': description: '' content: application/json: schema: type: object properties: code: type: string title: System General Return Code description: 0-Success, other exceptions msg: type: string title: Return information bizCode: type: string title: Module identifier code tm: title: Processing time (milliseconds) type: integer trace: type: string title: Global link flag information msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: object properties: userId: type: string title: Third-party userId action: type: string title: Next Operation Behavior description: login, bind, register result: title: Validation Result type: boolean failReason: type: string title: Validation Failure Reason thirdSource: type: string title: Third-party Login Source description: google,facebook,twitter… email: type: string title: Email phone: type: string title: Phone Number required: - userId - phone - email - thirdSource - failReason - result - action required: - code - data - msgParams - trace - tm - bizCode - msg headers: {} security: [] /h/com.cats.customer.api.app.CustomerThirdLoginService/googleVerify: post: summary: Google Third-party Login Verification deprecated: false description: |- version=0.0.1 bizType=customer.app.CustomerThirdLoginService.googleVerify Accessible after login operationId: googleVerify tags: - Customer/Social parameters: [] requestBody: content: application/json: schema: type: object properties: idToken: type: string title: Token verification required for web accessToken: type: string title: Token verification required for app example: '' responses: '200': description: '' content: application/json: schema: type: object properties: code: type: string title: System General Return Code description: 0-Success, other exceptions msg: type: string title: Return information bizCode: type: string title: Module identifier code tm: type: integer title: Processing time (milliseconds) trace: type: string title: Global link flag information data: type: object properties: thirdSource: type: string title: Third-party Login Source description: google,facebook,twitter… result: type: boolean title: Validation Result phone: title: Phone Number type: string action: type: string title: Next Operation Behavior description: login, bind, register failReason: title: Validation Failure Reason type: string userId: type: string title: Third-party userId email: type: string title: Email token: type: string title: Token verification required: - thirdSource - result - phone - action - failReason - userId - email - token title: '' msgParams: title: >- Placeholder parameter string in return description, multiple parameters separated by commas type: string required: - code - msg - bizCode - tm - trace - data - msgParams headers: {} security: [] /third/login/customer.app.CustomerThirdLoginService.telegramVerify: post: summary: Telegram third-party login verification deprecated: false description: >- version=0.0.1 bizType=customer.app.CustomerThirdLoginService.telegramVerify ###Version 0.0.2, used for third-party registration and login (no need for phone or email) version=0.0.2 bizType=customer.app.CustomerThirdLoginService.telegramVerify Access after login operationId: metaMaskVerify tags: - Customer/Social parameters: - name: companyId in: header description: '' required: true example: '{{company}}' schema: type: string - name: lang in: header description: '' required: true example: en-US schema: type: string - name: trace in: header description: '' required: true example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: true example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: userJsonStr: type: string title: User authorization information provided as a JSON string channelSource: type: string title: Channel Source h5, pc required: - userJsonStr - channelSource example: '' responses: '200': description: '' content: application/json: schema: type: object properties: code: type: string title: System General Return Code description: 0-Success, other exceptions msg: type: string title: Return information description: Return information bizCode: type: string title: Module identifier code description: Module identifier code tm: title: Processing time (milliseconds) type: integer description: Processing time (milliseconds) trace: type: string title: Global link flag information description: Global link flag information msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: object properties: userId: type: string title: Third-party userId description: Third-party userId action: type: string title: Next Operation Behavior description: login, bind, register result: title: Validation Result type: boolean description: Validation Result failReason: type: string title: Validation Failure Reason description: Validation Failure Reason thirdSource: type: string title: Third-party Login Source description: Third-party login sources, google, facebook, twitter… email: type: string title: Email description: Email phone: type: string title: Phone Number description: Phone Number authToken: type: string description: >- Third-party authorization credentials (returned version=0.0.2) required: - userId - phone - email - thirdSource - failReason - result - action - authToken required: - code - data - msgParams - trace - tm - bizCode - msg headers: {} security: [] /third/login/customer.app.CustomerThirdLoginService.metaMaskVerify: post: summary: Metamask third-party login verification deprecated: false description: |- version=0.0.1 bizType=customer.app.CustomerThirdLoginService.metaMaskVerify Access after login operationId: telegramVerify tags: - Customer/Social parameters: [] requestBody: content: application/json: schema: type: object properties: web3Signature: type: string title: Signature verification address: type: string title: Wallet account address timestamp: type: integer title: Timestamp required: - web3Signature - address - timestamp example: '' responses: '200': description: '' content: application/json: schema: type: object properties: code: type: string title: System General Return Code description: 0-Success, other exceptions msg: type: string title: Return information bizCode: type: string title: Module identifier code tm: title: Processing time (milliseconds) type: integer trace: type: string title: Global link flag information msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: object properties: userId: type: string title: Third-party userId action: type: string title: Next Operation Behavior description: login, bind, register result: title: Validation Result type: boolean failReason: type: string title: Validation Failure Reason thirdSource: type: string title: Third-party Login Source description: google,facebook,twitter… email: type: string title: Email phone: type: string title: Phone Number required: - userId - phone - email - thirdSource - failReason - result - action required: - code - data - msgParams - trace - tm - bizCode - msg headers: {} security: [] /third/login/customer.app.CustomerThirdLoginService.twitterVerify: post: summary: Twitter third-party login verification deprecated: false description: |- version=0.0.1 bizType=customer.app.CustomerThirdLoginService.twitterVerify Accessible after login operationId: twitterVerify tags: - Customer/Social parameters: [] requestBody: content: application/json: schema: type: object properties: oauth_token: type: string title: '' description: oauth_token oauth_token_secret: type: string title: '' description: oauth_token_secret user_id: type: string title: '' description: user_id screen_name: type: string description: screen_name access_token: type: string description: access_token state: type: string description: state client_id: type: string description: client_id network: type: string description: network display: type: string description: display redirect_uri: type: string description: redirect_uri scope: type: string description: scope oauth_proxy: type: string description: oauth_proxy required: - oauth_token - oauth_token_secret - scope - redirect_uri - display - network - client_id - state - access_token - screen_name - user_id - oauth_proxy example: '' responses: '200': description: '' content: application/json: schema: type: object properties: code: type: string title: System General Return Code description: 0-Success, other exceptions msg: type: string title: Return information bizCode: type: string title: Module identifier code tm: title: Processing time (milliseconds) type: integer trace: type: string title: Global link flag information msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: object properties: userId: type: string title: Third-party userId action: type: string title: Next Operation Behavior description: login, bind, register result: title: Validation Result type: boolean failReason: type: string title: Validation Failure Reason thirdSource: type: string title: Third-party Login Source description: google,facebook,twitter… email: type: string title: Email phone: type: string title: Phone Number required: - userId - phone - email - thirdSource - failReason - result - action required: - code - data - msgParams - trace - tm - bizCode - msg headers: {} security: [] /third/login/customer.app.CustomerThirdLoginService.login: post: summary: Third-party login deprecated: false description: |- version=0.0.1 bizType=customer.app.CustomerThirdLoginService.login Accessible to guests operationId: login tags: - Customer/Social parameters: - name: companyId in: header description: '' required: true example: '{{company}}' schema: type: string - name: lang in: header description: '' required: true example: en-US schema: type: string - name: trace in: header description: '' required: true example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: true example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: thirdSource: type: string description: >- Third-Party Sources: google, facebook, twitter, telegram, apple, metamask userId: type: string description: Third-party userId email: type: string description: Email phone: type: string description: Phone Number required: - thirdSource - userId - email - phone example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: object properties: id: type: integer format: int64 description: Customer ID companyId: type: integer format: int64 description: Company customerGroupId: type: integer format: int64 description: Customer group customerNo: type: string description: Customer account kycAuditStatus: type: integer format: int32 description: >- Registration KYC audit status: 0 uncertified, jump to certification page, 1 pending review, 2 review passed, 3 review failed kycAuditRemark: type: string description: Registration KYC audit remarks, not empty if rejected kycStatus: type: integer format: int32 description: KYC status kycRemark: type: string description: KYC status name accountList: type: object description: Trading Account List properties: {} accountRemark: type: string description: Whether the customer has a trading account note loginPassStatus: type: string description: >- Set password reminder flag, 1 for password required, 2 for not required payPassStatus: type: string description: >- Payment password existence status, 1 for non-existent, 2 for existent email: type: string description: Email phone: type: string description: Phone phoneArea: type: string description: Phone area code name: type: string description: Name country: type: string description: Country type: type: integer format: int32 description: Group type <0 real, 1 demo, 2 guest> deposit: type: integer format: int32 description: Depositable, 1 for depositable withdraw: type: integer format: int32 description: Withdrawable, 1 for withdrawable optional: type: integer format: int32 description: Customized flag 0 not added 1 added activateStatus: type: integer format: int32 description: Activation status, 0 not activated, 1 activated activateTime: type: integer format: int64 description: Activation time companyKycStatus: type: integer format: int32 description: >- Company KYC account opening status, 1 for opened, 2 for not opened status: type: integer format: int32 description: >- Status: 1 normal, 2 disabled, 3 deleted, 4 closed, 5 locked, 6 closing thirdServerCode: type: string description: Unique identifier from third-party system source: type: string description: Source thirdLoginSource: type: string description: Third-party login sources google, facebook, twitter thirdUserId: type: string description: Third-party userId idCard: type: string description: ID number idCardType: type: string description: ID type thirdIntactMsg: type: string description: Third-party login complete data firstName: type: string description: First name lastName: type: string description: Last name isFund: type: integer format: int32 description: Whether a fund manager, 1 is yes, default 0 is no assertPassStatus: type: string description: >- Set fund password reminder flag, 1 requires setting password, 2 does not require googleId: type: integer format: int64 description: >- Whether to enable MFA, greater than 0, enabled, otherwise not enabled openAccountType: type: integer format: int32 description: 'Account type: 0. Individual 1. Enterprise ' loginTime: type: integer format: int64 description: Login time createTime: type: integer format: int64 description: Creation time relationCustomerId: type: integer format: int64 description: Associated account id companyType: type: string description: Company type registerSource: type: integer format: int32 description: Registration source associationCompanyId: type: integer format: int64 description: Associated company Id registerTime: type: integer format: int64 description: Registration Time ok: type: boolean fail: type: boolean headers: {} security: [] /third/login/customer.app.CustomerThirdLoginService.socialLogin: post: summary: Third-party login (no need for phone, email) deprecated: false description: |- version=0.0.1 bizType=customer.app.CustomerThirdLoginService.socialLogin Guest access operationId: login tags: - Customer/Social parameters: - name: companyId in: header description: '' required: true example: '{{company}}' schema: type: string - name: lang in: header description: '' required: true example: en-US schema: type: string - name: trace in: header description: '' required: true example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: true example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: thirdSource: type: string description: Third-party source telegram userId: type: string description: Third-party userId authToken: type: string description: Third-party authorization certificate minLength: 64 maxLength: 64 required: - thirdSource - userId - authToken example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: object properties: id: type: integer format: int64 description: Customer ID companyId: type: integer format: int64 description: Company customerGroupId: type: integer format: int64 description: Customer group customerNo: type: string description: Customer account kycAuditStatus: type: integer format: int32 description: >- Registration KYC audit status: 0 uncertified, jump to certification page, 1 pending review, 2 review passed, 3 review failed kycAuditRemark: type: string description: Registration KYC audit remarks, not empty if rejected kycStatus: type: integer format: int32 description: KYC status kycRemark: type: string description: KYC status name accountList: type: object description: Trading Account List properties: {} accountRemark: type: string description: Whether the customer has a trading account note loginPassStatus: type: string description: >- Set password reminder flag, 1 for password required, 2 for not required payPassStatus: type: string description: >- Payment password existence status, 1 for non-existent, 2 for existent email: type: string description: Email phone: type: string description: Phone phoneArea: type: string description: Phone area code name: type: string description: Name country: type: string description: Country type: type: integer format: int32 description: Group type <0 real, 1 demo, 2 guest> deposit: type: integer format: int32 description: Depositable, 1 for depositable withdraw: type: integer format: int32 description: Withdrawable, 1 for withdrawable optional: type: integer format: int32 description: Customized flag 0 not added 1 added activateStatus: type: integer format: int32 description: Activation status, 0 not activated, 1 activated activateTime: type: integer format: int64 description: Activation time companyKycStatus: type: integer format: int32 description: >- Company KYC account opening status, 1 for opened, 2 for not opened status: type: integer format: int32 description: >- Status: 1 normal, 2 disabled, 3 deleted, 4 closed, 5 locked, 6 closing thirdServerCode: type: string description: Unique identifier from third-party system source: type: string description: Source thirdLoginSource: type: string description: Third-party login source telegram thirdUserId: type: string description: Third-party userId idCard: type: string description: ID number idCardType: type: string description: ID type thirdIntactMsg: type: string description: Third-party login complete data firstName: type: string description: First name lastName: type: string description: Last name isFund: type: integer format: int32 description: Whether a fund manager, 1 is yes, default 0 is no assertPassStatus: type: string description: >- Set fund password reminder flag, 1 requires setting password, 2 does not require googleId: type: integer format: int64 description: >- Whether to enable MFA, greater than 0, enabled, otherwise not enabled openAccountType: type: integer format: int32 description: 'Account type: 0. Individual 1. Enterprise ' loginTime: type: integer format: int64 description: Login time createTime: type: integer format: int64 description: Creation time relationCustomerId: type: integer format: int64 description: Associated account id companyType: type: string description: Company type registerSource: type: integer format: int32 description: Registration source associationCompanyId: type: integer format: int64 description: Associated company Id registerTime: type: integer format: int64 description: Registration Time ok: type: boolean fail: type: boolean headers: {} security: [] /third/login/customer.app.CustomerThirdLoginService.register: post: summary: Third-party registration deprecated: false description: |- version=0.0.1 bizType=customer.app.CustomerThirdLoginService.register Guest access operationId: register tags: - Customer/Social parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: country: type: string description: Country thirdSource: type: string description: >- Third-Party Sources: google, facebook, twitter, telegram, apple, metamask userId: type: string description: Third-party userId customerGroupId: type: integer format: int64 description: Client group ID email: type: string description: Email and phone number must exist one phone: type: string description: Phone Number phoneArea: type: string description: New phone area code verifyCode: type: string description: Verification code sendToken: type: string description: Verification code sending ticket registerSource: type: integer format: int32 minimum: 1 description: >- Registration source: 1=mobile web: H5, 2=pc web: PC_Web, 3=system & backend registration: System, 4=Android native app: Android, 5=iOS native app: iOS, 6=HarmonyOS: HOS, 7=pc windows client: PC_Win, 8=pc mac client: PC_Mac, 9=other utmSource: type: string description: Advertising source (account opening link parameter source) utmMedium: type: string description: Advertising medium (account opening link parameter medium) utmCampaign: type: string description: >- Advertising campaign (account opening link parameter campaign) utmContent: type: string description: Advertising group (account opening link parameter content) utmTerm: type: string description: Keyword (account opening link parameter term) lang: type: string description: Language Information thirdServerCode: type: string description: Unique identifier from third-party system maxLength: 45 thirdServerSource: type: string description: 'Third-party system source, such as: agent=agent' maxLength: 10 registerDevice: type: string description: Registered device model required: - country example: customerGroupId: 1 userId: '5708954114' phoneArea: '18163223782' phone: '18631358776' sendToken: reprehenderit veniam do sit minim verifyCode: '23' country: CN thirdSource: telegram registerSource: 2 thirdServerSource: test thirdServerCode: '10' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: object properties: customerNo: type: string description: Customer account list: type: array description: KYC authentication list information items: &ref_9 $ref: '#/components/schemas/KycAuthVO' companyId: type: integer format: int64 description: Company ID ext1: type: string description: Extension Field (Unused) ext2: type: string description: Extension Field (Unused) email: type: string description: Email phone: type: string description: Phone phoneArea: type: string description: Phone area code name: type: string description: Name loginPassStatus: type: string description: >- Set password reminder flag, 1 for password required, 2 for not required payPassStatus: type: string description: >- Payment password existence status, 1 for non-existent, 2 for existent customerGroupId: type: integer format: int64 description: Customer group country: type: string description: Country id: type: integer format: int64 description: Customer ID optional: type: integer format: int32 description: Customized flag 0 not added 1 added companyKycStatus: type: integer format: int32 description: >- Company KYC account opening status, 1 for opened, 2 for not opened thirdServerCode: type: string description: Unique identifier from third-party system source: type: string description: Source capitalInStatus: type: integer format: int32 description: 'Deposit status: 1. Deposited, 2. Not deposited' openAccountType: type: integer format: int32 description: 'Account type: 0. Individual 1. Enterprise ' companyType: type: string description: Company type associationCompanyId: type: integer format: int64 description: Associated company Id registerTime: type: integer format: int64 description: Registration Time apiCheckSwitch: type: boolean description: API verification switch. true-verification is enabled apiCheckRule: type: string description: >- API Verification Rules. 1-Email; 2-SMS; 3-Google NFA; Enable multiple verifications at the same time, separated by commas. token: type: string description: Login Token ok: type: boolean fail: type: boolean headers: {} security: [] /third/login/customer.app.CustomerThirdLoginService.socialRegister: post: summary: Third-party registration (no need for phone, email) deprecated: false description: |- version=0.0.1 bizType=customer.app.CustomerThirdLoginService.socialRegister Accessible for guests operationId: register tags: - Customer/Social parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: country: type: string description: Country code thirdSource: type: string description: Third-party source telegram userId: type: string description: Third-party userId authToken: type: string description: Third-party authorization certificate minLength: 64 maxLength: 64 registerSource: type: integer format: int32 minimum: 1 description: >- Registration source: 1=mobile web: H5, 2=pc web: PC_Web, 3=system & backend registration: System, 4=Android native app: Android, 5=iOS native app: iOS, 6=HarmonyOS: HOS, 7=pc windows client: PC_Win, 8=pc mac client: PC_Mac, 9=other customerGroupId: type: integer format: int64 description: Client group ID utmSource: type: string description: Advertising source (account opening link parameter source) utmMedium: type: string description: Advertising medium (account opening link parameter medium) utmCampaign: type: string description: >- Advertising campaign (account opening link parameter campaign) utmContent: type: string description: Advertising group (account opening link parameter content) utmTerm: type: string description: Keyword (account opening link parameter term) lang: type: string description: Language Information thirdServerCode: type: string description: Unique identifier from third-party system maxLength: 45 thirdServerSource: type: string description: 'Third-party system source, such as: agent=agent' maxLength: 10 registerDevice: type: string description: Registered device model token: type: string description: Login Token required: - country - thirdSource - userId - registerSource - authToken example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: object properties: customerNo: type: string description: Customer account list: type: array description: KYC authentication list information items: *ref_9 companyId: type: integer format: int64 description: Company ID ext1: type: string description: Extension Field (Unused) ext2: type: string description: Extension Field (Unused) email: type: string description: Email phone: type: string description: Phone phoneArea: type: string description: Phone area code name: type: string description: Name loginPassStatus: type: string description: >- Set password reminder flag, 1 for password required, 2 for not required payPassStatus: type: string description: >- Payment password existence status, 1 for non-existent, 2 for existent customerGroupId: type: integer format: int64 description: Customer group country: type: string description: Country id: type: integer format: int64 description: Customer ID optional: type: integer format: int32 description: Customized flag 0 not added 1 added companyKycStatus: type: integer format: int32 description: >- Company KYC account opening status, 1 for opened, 2 for not opened thirdServerCode: type: string description: Unique identifier from third-party system source: type: string description: Source capitalInStatus: type: integer format: int32 description: 'Deposit status: 1. Deposited, 2. Not deposited' openAccountType: type: integer format: int32 description: 'Account type: 0. Individual 1. Enterprise ' companyType: type: string description: Company type associationCompanyId: type: integer format: int64 description: Associated company Id registerTime: type: integer format: int64 description: Registration Time apiCheckSwitch: type: boolean description: API verification switch. true-verification is enabled apiCheckRule: type: string description: >- API Verification Rules. 1-Email; 2-SMS; 3-Google NFA; Enable multiple verifications at the same time, separated by commas. ok: type: boolean fail: type: boolean headers: {} security: [] /login/customer.app.CustomerWebApiService.login: post: summary: Login deprecated: false description: |- version=0.0.1 bizType=customer.app.CustomerWebApiService.login Guest Accessible tags: - Customer/Auth parameters: - name: version in: header description: Version Number required: true example: 0.0.1 schema: type: string - name: companyId in: header description: Company ID, obtained through environment variables required: true example: '{{company}}' schema: type: string - name: trace in: header description: Random Tracking Code UUID required: true example: '{{mock_trace}}' schema: type: string - name: lang in: header description: Language required: true example: zh-CN schema: type: string requestBody: content: application/json: schema: type: object properties: type: type: integer description: >- Registration and Login Methods: 1 Email, 2 Phone Number, 3 Customer Account phoneArea: type: string description: 'Phone Area Code; Required field when type is 2: Phone Number' loginName: type: string description: 'Account: Email/Phone Number' device: type: integer description: >- Login Device: 1=Mobile Web: H5, 2=PC Web: PC_Web, 3=System & Backend Registration: System, 4=Android Native App: Android, 5=iOS Native App: iOS, 6=HarmonyOS: HOS, 7=PC Windows Client: PC_Win, 8=PC Mac Client: PC_Mac, 9=Others isThird: type: boolean description: Is it a third party verifyCode: type: string description: Verification code sendToken: type: string description: Verification code sending ticket loginPwd: type: string description: Login password bindThirdUserId: type: string description: Bind third-party userId thirdSource: type: string description: 'Third-Party Sources: google, facebook, twitter…' googleCode: type: string description: Google Verification Code required: - type - device - loginName - isThird example: type: 2 device: 1 loginName: '13429837442' isThird: false thirdSource: '' bindThirdUserId: '' loginPwd: dc483e80a7a0bd9ef71d8cf973673924 responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: object properties: id: type: integer format: int64 description: Customer ID companyId: type: integer format: int64 description: Company customerGroupId: type: integer format: int64 description: Customer group customerNo: type: string description: Customer account kycAuditStatus: type: integer format: int32 description: >- Registration KYC audit status: 0 uncertified, jump to certification page, 1 pending review, 2 review passed, 3 review failed kycAuditRemark: type: string description: Registration KYC audit remarks, not empty if rejected kycStatus: type: integer format: int32 description: >- KYC status, consistent with kycRemark: 1=unverified, 2=under review, 3=authentication failed, 4=authenticated, -1='' kycRemark: type: string description: >- KYC status name (1, "unverified", "KYC configured but not submitted"), (2, "under review", "KYC configured and under review, at least one level under review"), (3, "authentication failed", "KYC configured and submitted KYC rejected, at least one level rejected"), (4, "authenticated", "KYC configured and all levels authenticated"), (-1, "", "KYC configured, multiple levels, partially authenticated") accountList: type: object description: Trading Account List properties: {} accountRemark: type: string description: Whether the customer has a trading account note loginPassStatus: type: string description: >- Set password reminder flag, 1 for password required, 2 for not required payPassStatus: type: string description: >- Payment password existence status, 1 for non-existent, 2 for existent email: type: string description: Email phone: type: string description: Phone phoneArea: type: string description: Phone area code name: type: string description: Name country: type: string description: Country type: type: integer format: int32 description: Group type <0 real, 1 demo, 2 guest> deposit: type: integer format: int32 description: Depositable, 1 for depositable withdraw: type: integer format: int32 description: Withdrawable, 1 for withdrawable optional: type: integer format: int32 description: Customized flag 0 not added 1 added activateStatus: type: integer format: int32 description: Activation status, 0 not activated, 1 activated activateTime: type: integer format: int64 description: Activation time companyKycStatus: type: integer format: int32 description: >- Company KYC account opening status, 1 for opened, 2 for not opened status: type: integer format: int32 description: >- Status: 1 normal, 2 disabled, 3 deleted, 4 closed, 5 locked, 6 closing thirdServerCode: type: string description: Unique identifier from third-party system source: type: string description: Source thirdLoginSource: type: string description: Third-party login sources google, facebook, twitter thirdUserId: type: string description: Third-party userId idCard: type: string description: ID number idCardType: type: string description: ID type thirdIntactMsg: type: string description: Third-party login complete data firstName: type: string description: First name lastName: type: string description: Last name isFund: type: integer format: int32 description: Whether a fund manager, 1 is yes, default 0 is no assertPassStatus: type: string description: >- Set fund password reminder flag, 1 requires setting password, 2 does not require googleId: type: integer format: int64 description: >- Whether to enable MFA, greater than 0, enabled, otherwise not enabled openAccountType: type: integer format: int32 description: 'Account type: 0. Individual 1. Enterprise ' loginTime: type: integer format: int64 description: Login time createTime: type: integer format: int64 description: Creation time relationCustomerId: type: integer format: int64 description: Associated account id companyType: type: string description: Company type registerSource: type: integer format: int32 description: Registration source associationCompanyId: type: integer format: int64 description: Associated company Id registerTime: type: integer format: int64 description: Registration Time token: type: string description: Authentication token customerAgentMark: type: string description: Customer Agent Identifier ok: type: boolean fail: type: boolean examples: '1': summary: Success example value: msg: Success fail: false trace: x-31z6g86n-kr01ct-4g1u-ci45-1678377046 code: '0' data: customerGroupId: 1 thirdUserId: null googleId: -1 lastName: null country: CN kycStatus: 1 companyKycStatus: 2 assertPassStatus: '2' idCard: null thirdLoginSource: null payPassStatus: '2' kycAuditRemark: >- The company has not enabled KYC certification, go through directly source: H5 type: 0 registerSource: 1 loginPassStatus: '2' idCardType: null loginTime: 1678360534200 kycRemark: Not verified associationCompanyId: null id: 1176 activateStatus: null email: 22**@qq.com openAccountType: 0 accountRemark: null companyType: real registerTime: 1648777706117 activateTime: null kycAuditStatus: 2 optional: 1 isFund: 0 token: a541f9d5-2507-42b3-b790-59e1f755c380app firstName: null companyId: 360 thirdIntactMsg: null createTime: 1648777706117 phone: 135******9561 relationCustomerId: 0 accountList: - netAssets: '2904318.4696' available: '2904318.4696' remark: null type: 1 equity: '2904318.4696' firstDepositTime: 1648785031654 lockMargin: '0.0000' balance: '2904321.4696' interest: '0.0000' customerId: 1176 liabilities: '0.0000' currency: USDT activateStatus: 2 withdrawAmount: '2904318.4696' profit: '0' tradeType: 5 wholeWarehouseBalance: null collateralFrozen: '0.0000' freeMargin: '0' margin: '0' firstWithdrawTime: 1648792333492 activateTime: 1648792208194 frozen: '3.0000' wholeWarehouseRate: null accountId: 1031717 openAccountStatus: true companyId: 360 liabilitiesPrincipal: '0.0000' interestProportion: null createTime: 1648777706190 lockAmount: '3.0000' marginRadio: null notWithdrawAmount: '0.0000' availableLoan: null digits: 4 customerNo: '86001175' status: 2 assetsId: 13 name: null phoneArea: '+86' deposit: 1 rToken: >- 291e08e4e0af86b3d8af85f2947a02125a1c1746db58b303b06cc1aba389f4cd thirdServerCode: '' customerNo: '86001175' status: 6 withdraw: 1 bizCode: '' tm: 82650853 msgParams: null ok: true headers: {} security: [] /thirdExt/switchAccount: post: summary: Switch Real Simulation Account deprecated: false description: '' tags: - Customer/Auth parameters: - name: companyId in: header description: Company ID, obtained through environment variables required: true example: '{{company}}' schema: type: string - name: trace in: header description: Random Tracking Code UUID required: true example: '{{mock_trace}}' schema: type: string - name: token in: header description: Login Token required: true example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: Language required: true example: zh-CN schema: type: string requestBody: content: application/json: schema: type: object properties: {} example: {} responses: '200': description: '' content: application/json: schema: type: object properties: {} headers: {} security: [] /global/customer.app.CustomerDubboApiService.resetAccount: post: summary: Reset Demo Account deprecated: false description: |- version=0.0.1 bizType=customer.app.CustomerDubboApiService.resetAccount tags: - Customer/Auth parameters: - name: companyId in: header description: Company ID, obtained through environment variables required: true example: '{{company}}' schema: type: string - name: trace in: header description: Random Tracking Code UUID required: true example: '{{mock_trace}}' schema: type: string - name: token in: header description: Login Token required: true example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: Language required: true example: zh-CN schema: type: string - name: version in: header description: Version Number required: true example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: {} example: {} responses: '200': description: '' content: application/json: schema: type: object properties: {} headers: {} security: [] /register/customer.app.CustomerWebApiService.register: post: summary: Customer registration deprecated: false description: |- version=0.0.1 bizType=customer.app.CustomerWebApiService.register Guest access operationId: register tags: - Customer/Auth parameters: - name: version in: header description: Version Number required: true example: 0.0.1 schema: type: string - name: companyId in: header description: Company ID, obtained through environment variables required: true example: '{{company}}' schema: type: string - name: trace in: header description: Random Tracking Code UUID required: true example: '{{mock_trace}}' schema: type: string - name: lang in: header description: Language required: true example: zh-CN schema: type: string - name: X-Forwarded-For in: header description: '' required: true example: '' schema: type: string requestBody: content: application/json: schema: type: object properties: country: type: string description: Country lang: type: string description: Language information, default en-US loginName: type: string description: 'Account: email/phone number, used in conjunction with type' phoneArea: type: string description: >- Mobile area code, used in conjunction with registration method, default +86 type: type: integer format: int32 description: 'Registration method: 1=email, 2=phone number' minimum: 1 maximum: 3 registerDevice: type: string description: Registered device model verifyCode: type: string description: Verification code sendToken: type: string description: Verification code sending ticket registerSource: type: integer format: int32 minimum: 1 description: >- Registration source: 1=mobile web: H5, 2=pc web: PC_Web, 3=system & backend registration: System, 4=Android native app: Android, 5=iOS native app: iOS, 6=HarmonyOS: HOS, 7=pc windows client: PC_Win, 8=pc mac client: PC_Mac, 9=other utmSource: type: string description: Advertising source (account opening link parameter source) utmMedium: type: string description: Advertising medium (account opening link parameter medium) utmCampaign: type: string description: >- Advertising campaign (account opening link parameter campaign) utmContent: type: string description: Advertising group (account opening link parameter content) utmTerm: type: string description: Keyword (account opening link parameter term) customerGroupId: type: integer format: int64 description: Client group ID tradeTypeCurrencyList: type: array description: Game currency information items: type: object properties: allCurrency: type: string description: Asset currency information tradeType: type: string description: Game ID maxItems: 2147483647 minItems: 1 openAccountType: type: integer format: int32 description: >- Account opening type: 0. Individual 1. Enterprise, default individual pwd: type: string description: Password, MD5 encryption thirdServerCode: type: string description: Unique identifier from third-party system thirdServerSource: type: string description: 'Third-party system source, such as: agent=agent' required: - registerSource - type - country - loginName - sendToken - verifyCode example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: object properties: customerNo: type: string description: Customer account list: type: array description: KYC authentication list information items: *ref_9 companyId: type: integer format: int64 description: Company ID email: type: string description: Email phone: type: string description: Phone phoneArea: type: string description: Phone area code name: type: string description: Name loginPassStatus: type: string description: >- Set password reminder flag, 1 for password required, 2 for not required payPassStatus: type: string description: >- Payment password existence status, 1 for non-existent, 2 for existent customerGroupId: type: integer format: int64 description: Client group ID country: type: string description: Country id: type: integer format: int64 description: Customer ID optional: type: integer format: int32 description: Customized flag 0 not added 1 added companyKycStatus: type: integer format: int32 description: >- Company KYC account opening status, 1 for opened, 2 for not opened thirdServerCode: type: string description: Unique identifier from third-party system source: type: string description: Source capitalInStatus: type: integer format: int32 description: 'Deposit status: 1. Deposited, 2. Not deposited' openAccountType: type: integer format: int32 description: 'Account type: 0. Individual 1. Enterprise ' companyType: type: string description: Company type associationCompanyId: type: integer format: int64 description: Associated company Id registerTime: type: integer format: int64 description: Registration Time apiCheckSwitch: type: boolean description: API verification switch. true-verification is enabled apiCheckRule: type: string description: >- API Verification Rules. 1-Email; 2-SMS; 3-Google NFA; Enable multiple verifications at the same time, separated by commas. ok: type: boolean fail: type: boolean headers: {} security: [] /global/thirdExt/randomKey: post: summary: Get access token deprecated: false description: |- /global/thirdExt/randomKey Exchange final access token with a temporary token operationId: getSymbolBaseList tags: - Customer/Auth parameters: - name: companyId in: header description: Company ID, obtained through environment variables required: true example: '{{company}}' schema: type: string - name: trace in: header description: Random Tracking Code UUID required: true example: '{{mock_trace}}' schema: type: string - name: token in: header description: Login Token required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: Language required: true example: zh-CN schema: type: string requestBody: content: application/json: schema: type: object properties: {} example: {} responses: '200': description: '' content: application/json: schema: type: object properties: data: type: string description: Final access token bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas ok: type: boolean description: Success or not fail: type: boolean description: Exception or not required: - data examples: '1': summary: Success example value: msg: Success fail: false trace: x-qfx13-8z5850-mf4l657-gkqbn-1677563999 code: '0' data: qfx13-8z5850-mf4l657-gkqbn-167756399 bizCode: '' tm: 955 msgParams: null ok: true headers: {} security: [] /global/customer.app.WithdrawBankWebApiService.add: post: summary: Add domestic bank card deprecated: false description: |- version=0.0.1 bizType=customer.app.WithdrawBankWebApiService.add Access after login operationId: add tags: - Customer/Bank Card parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: country: type: string maxLength: 50 description: Country bankAccountName: type: string maxLength: 80 description: Account holder's name bankCardNumber: type: string maxLength: 80 description: Bank card number bankCurrency: type: string maxLength: 80 description: Bank currency bankName: type: string maxLength: 80 description: Bank name bankAddress: type: string maxLength: 200 description: Bank account opening address bankBranch: type: string maxLength: 200 description: Bank branch province: type: string maxLength: 50 description: Province city: type: string maxLength: 50 description: City bankCode: type: string maxLength: 50 description: Bank code firstName: type: string description: First name maxLength: 50 lastName: type: string description: Last name maxLength: 50 required: - bankCardNumber - bankCurrency - bankName - bankAddress - bankBranch - province - city - bankCode - firstName - lastName - country example: '' responses: '200': description: '' content: application/json: schema: *ref_8 examples: '1': summary: Success-Add bank card successfully value: msg: Success fail: false trace: x-119n8w-7g776n0t-cl873p-81g4-1677651340 code: '0' data: null bizCode: '' tm: 11140253 msgParams: null ok: true '2': summary: Exception Example - Duplicate Bank Card Addition value: msg: Bank card no exist already fail: true trace: x-5or45-27i1u-8lf22-322qb-1677651390 code: CUSTOMER_API_0000701 data: customer.app.WithdrawBankWebApiService.add bizCode: US tm: 3477734 msgParams: null ok: false headers: {} security: [] /global/customer.app.WithdrawBankWebApiService.addV1v2v8: post: summary: Add International Bank Card deprecated: false description: |- version=0.0.1 bizType=customer.app.WithdrawBankWebApiService.addV1v2v8 Accessible after login operationId: addV1v2v8 tags: - Customer/Bank Card parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: bankCurrency: type: string maxLength: 80 description: Bank currency bankName: type: string maxLength: 80 description: Bank name bankCode: type: string maxLength: 50 description: Bank code firstName: type: string description: First name maxLength: 50 lastName: type: string description: Last name maxLength: 50 bankAccount: type: string maxLength: 32 description: Bank Account Number swiftCode: type: string maxLength: 32 description: swiftCode otherCode: type: string maxLength: 32 description: otherCode province: type: string description: Province Code city: type: string description: City Code phone: type: string description: Reserved Mobile Number ext1: type: string description: ID Number required: - bankCurrency - bankName - bankCode - firstName - lastName example: '' responses: '200': description: '' content: application/json: schema: *ref_8 headers: {} security: [] /global/customer.app.WithdrawBankWebApiService.bankList: post: summary: Get bank card list deprecated: false description: |- version=0.0.1 bizType=customer.app.WithdrawBankWebApiService.bankList Accessible after login operationId: bankList tags: - Customer/Bank Card parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: bankAccount: type: string description: Bank Account Number bankCardNumber: type: string description: Bank card number example: '' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/BaseResultListCustomerWithdrawBankVO' headers: {} security: [] /global/customer.app.WithdrawBankWebApiService.delete: post: summary: Delete bank card information deprecated: false description: |- version=0.0.1 bizType=customer.app.WithdrawBankWebApiService.delete Access after login tags: - Customer/Bank Card parameters: [] requestBody: content: application/json: schema: type: object properties: id: type: integer format: uint64 description: Bank card information record id required: - id example: '' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/BaseResult' headers: {} security: [] /global/customer.app.CustomerExtendWebApiService.findCustomerExtend: post: summary: View Customer Expansion Information deprecated: false description: |- version=0.0.1 bizType=customer.app.CustomerExtendWebApiService.findCustomerExtend Accessible after login operationId: findCustomerExtend tags: - Customer/Extended parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: type: type: integer format: int32 description: Expansion Type, 1=payRedeem required: - type example: '' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/BaseResultObject' examples: '1': summary: Success example value: msg: Success fail: false trace: x-e9c5v-513q-59z1w-ljfvlr1-1677641352 code: '0' data: '343434' bizCode: '' tm: 5925011 msgParams: null ok: true '2': summary: Exception Example - User has not bound extension information value: msg: This type of payout address does not exist fail: true trace: x-jjc3sw-8ul61-46x26inl-o7i5h-1677638896 code: CUSTOMER_API_0000706 data: >- customer.app.CustomerExtendWebApiService.findCustomerExtend bizCode: US tm: 48792747 msgParams: null ok: false headers: {} security: [] /global/customer.app.CustomerExtendWebApiService.saveCustomerExtend: post: summary: Save Customer Extension Information deprecated: false description: |- version=0.0.1 bizType=customer.app.CustomerExtendWebApiService.saveCustomerExtend Accessible after login operationId: saveCustomerExtend tags: - Customer/Extended parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: type: type: integer format: int32 description: Expansion Type, 1=payRedeem value: type: string description: Extension Information required: - type example: '' responses: '200': description: '' content: application/json: schema: *ref_8 examples: '1': summary: Success example value: msg: Success fail: false trace: x-o31dki1-q0rm-7snb-846x4iv-1677641261 code: '0' data: null bizCode: '' tm: 31053212 msgParams: null ok: true '2': summary: Exception Example_Type type is not 1 value: msg: System error fail: true trace: x-4062886q-m7s61so-i9b8yq6-wzp3m4c-1677641406 code: '500' data: >- customer.app.CustomerExtendWebApiService.saveCustomerExtend bizCode: US tm: 735197 msgParams: null ok: false headers: {} security: [] /global/customer.app.CustomerOptionalWebApiService.add: post: summary: Add Optional Products deprecated: false description: |- version=0.0.1 bizType=customer.app.CustomerOptionalWebApiService.add Accessible after login operationId: add tags: - Customer/Products parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: symbolList: type: array description: Product ID Collection items: type: integer format: int64 maxItems: 2147483647 minItems: 1 tradeType: type: integer format: int64 description: >- Game ID, 1-CFD Full Position 2-CFD Isolated Position 3-Leveraged Full Position 5-Spot Game minimum: 1 required: - tradeType - symbolList example: symbolList: - 2717 - 2718 tradeType: 1 responses: '200': description: '' content: application/json: schema: *ref_8 examples: '1': summary: Success example value: msg: Success fail: false trace: x-w67a-m983h6dw-30535g-x321-1677575540 code: '0' data: null bizCode: '' tm: 46426649 msgParams: null ok: true headers: {} security: [] /global/customer.app.CustomerOptionalWebApiService.delete: post: summary: Delete selected products deprecated: false description: |- version=0.0.1 bizType=customer.app.CustomerOptionalWebApiService.delete Access after login operationId: delete tags: - Customer/Products parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: symbolList: type: array description: Product Ids items: type: integer format: int64 maxItems: 2147483647 minItems: 1 tradeType: type: integer format: int64 description: >- 1-CFD Full Position 2-CFD Cross Position 3-Leveraged Full Position 5-Spot Play minimum: 1 required: - tradeType example: '' responses: '200': description: '' content: application/json: schema: *ref_8 examples: '1': summary: Success example value: msg: Success fail: false trace: x-5um9rt4-0pba-3uwtcp-117u3s1-1677576234 code: '0' data: null bizCode: '' tm: 8347683 msgParams: null ok: true '2': summary: Exception example value: msg: 'Data not exist ' fail: true trace: x-8bk4ol42-c0i7517b-54yle4-8w3wup2-1677576065 code: CUSTOMER_API_0000003 data: customer.app.CustomerOptionalWebApiService.delete bizCode: US tm: 7386547 msgParams: null ok: false headers: {} security: [] /global/customer.app.CustomerOptionalWebApiService.optionalList: post: summary: Customized List deprecated: false description: |- version=0.0.1 bizType=customer.app.CustomerOptionalWebApiService.optionalList Accessible after login operationId: optionalList tags: - Customer/Products parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: tradeTypeList: type: array description: >- Game ID collection, 1-CFD full position 2-CFD margin position 3-Leveraged full position 5-Spot game items: type: integer format: int64 maxItems: 2147483647 minItems: 1 required: - tradeTypeList example: tradeTypeList: - 1 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/BaseResultMapLongListCustomerOptionalVO' examples: '1': summary: Success example value: msg: Success fail: false trace: x-20325-5twm-458w4eap-p5x1x8l-1677576194 code: '0' data: '1': - symbolCode: USDJPY symbolId: 1348 pointRatio: 1 symbolName: USDJPY symbolDigits: 3 askSpread: 0.009 bidSpread: 0.007 - symbolCode: BINAN_BTC_USDT symbolId: 706 pointRatio: 1 symbolName: BTC/USDT symbolDigits: 2 askSpread: 32.51 bidSpread: 32.51 - symbolCode: AUDCHF symbolId: 2717 pointRatio: 1 symbolName: AUDCHF symbolDigits: 5 askSpread: 0.00009 bidSpread: 0.00007 - symbolCode: BTC/USDT_PRD symbolId: 969 pointRatio: 10 symbolName: BTC/USDT_PRD symbolDigits: 2 askSpread: 0.9 bidSpread: 0.7 - symbolCode: BINAN_ATOM_USDT symbolId: 695 pointRatio: 3 symbolName: BINAN_ATOM_USDT symbolDigits: 3 askSpread: 0.027 bidSpread: 0.021 bizCode: '' tm: 39231170 msgParams: null ok: true headers: {} security: [] /global/customer.app.CustomerWalletWebApiService.add: post: summary: Add Wallet deprecated: false description: |- version=0.0.1 bizType=customer.app.CustomerWalletWebApiService.add Accessible after login operationId: add tags: - Customer/Wallet parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: currency: type: string description: Wallet Currency chainName: type: string description: Chain Name address: type: string description: Wallet Address maxLength: 150 remark: type: string description: Wallet Note maxLength: 100 verifyCode: type: string description: Verification code sendToken: type: string description: Verification code sending ticket phoneArea: type: string description: Phone area code phone: type: string description: Phone Number required: - currency - chainName - address - remark - verifyCode - phoneArea - phone - sendToken example: '' responses: '200': description: '' content: application/json: schema: *ref_8 headers: {} security: [] /global/customer.app.CustomerWalletWebApiService.addV1v1v2: post: summary: Add Wallet (MFA) deprecated: true description: >- version=0.0.1 bizType=customer.app.CustomerWalletWebApiService.addV1v1v2 Accessible after login If the customer enables Google Authenticator (MFA), the Google Authenticator code (googleCode) in the input parameters is required, At the same time, the user does not need to enter a phone number or email, If both phone and email exist, the phone number is verified first operationId: addV1v1v2 tags: - Customer/Wallet parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: zh-CN schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: currency: type: string description: Wallet Currency chainName: type: string description: Chain Name address: type: string description: Wallet Address maxLength: 150 remark: type: string description: Wallet Note maxLength: 100 verifyCode: type: string description: Verification code sendToken: type: string description: Verification code sending ticket googleCode: type: string description: Google Verification Code required: - currency - chainName - address - remark - verifyCode - sendToken example: '' responses: '200': description: '' content: application/json: schema: *ref_8 headers: {} security: [] /global/customer.app.CustomerWalletWebApiService.delete: post: summary: Delete Wallet deprecated: false description: |- version=0.0.1 bizType=customer.app.CustomerWalletWebApiService.delete Access after login operationId: delete tags: - Customer/Wallet parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: id: type: integer format: int64 description: Wallet Id minimum: 1 example: '' responses: '200': description: '' content: application/json: schema: *ref_8 headers: {} security: [] /global/customer.app.CustomerWalletWebApiService.updateWallet: post: summary: Set default wallet (H5 does not use this interface) deprecated: false description: |- version=0.0.1 bizType=customer.app.CustomerWalletWebApiService.updateWallet Accessible after login operationId: updateWallet tags: - Customer/Wallet parameters: [] requestBody: content: application/json: schema: type: object properties: id: type: integer format: int64 description: Wallet Id minimum: 1 example: '' responses: '200': description: '' content: application/json: schema: *ref_8 headers: {} security: [] /global/customer.app.CustomerWalletWebApiService.walletList: post: summary: Wallet List deprecated: false description: |- version=0.0.1 bizType=customer.app.CustomerWalletWebApiService.walletList Accessible after login operationId: walletList tags: - Customer/Wallet parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: currency: type: string description: Wallet Currency chainName: type: string description: Chain Name example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: array description: Data Body items: type: object properties: id: type: integer format: int64 description: Wallet Id currency: type: string description: Wallet Currency chainName: type: string description: Chain Name address: type: string description: Wallet Address remark: type: string description: Wallet Note defaultType: type: integer format: int32 description: Default wallet flag 1 yes 0 no ok: type: boolean fail: type: boolean examples: '1': summary: Success example value: msg: Success fail: false trace: x-gndw9-43s45-j1x875-59h9d-1677576513 code: '0' data: - chainName: Ethereum(ERC20) address: '234' currency: USDC remark: '' id: 14676 defaultType: 0 bizCode: '' tm: 3021714 msgParams: null ok: true headers: {} security: [] /global/customer.app.CustomerWalletWebApiService.addWithdrawalAddressMFA: post: summary: 'Add Withdrawal Address (MFA) ' deprecated: false description: | version=0.0.1 bizType=customer.app.CustomerWalletWebApiService.addWithdrawalAddressMFA Accessible after login operationId: addV1v1v2 tags: - Customer/Wallet parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: currency: type: string description: Currency chainName: type: string description: Withdrawal Network address: type: string description: Withdrawal Address maxLength: 150 remark: type: string description: Withdrawal Note maxLength: 40 minLength: 4 type: type: integer description: 'Type: 1 Email, 2 Phone Number' format: int32 minimum: 1 maximum: 2 verifyCode: type: string description: >- Verification code, send verification code interface bizType=EMAIL_LOGINED_VERIFICATION_CODE (email), SMS_LOGINED_VERIFICATION_CODE (phone) sendToken: type: string description: Verification code sending ticket googleCode: type: string description: Google Verification Code required: - currency - chainName - address - remark - verifyCode - sendToken example: '' responses: '200': description: '' content: application/json: schema: *ref_8 headers: {} security: [] /global/customer.app.CustomerWalletWebApiService.withdrawalAddressList: post: summary: Query withdrawal address list deprecated: false description: |- version=0.0.1 bizType=customer.app.CustomerWalletWebApiService.withdrawalAddressList Accessible after login operationId: walletList tags: - Customer/Wallet parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: currency: type: string description: Currency chainName: type: string description: Withdrawal Network required: - currency - chainName example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: array description: Data Body items: type: object properties: id: type: integer format: int64 description: id currency: type: string description: Currency chainName: type: string description: Withdrawal Network address: type: string description: Withdrawal Address remark: type: string description: Withdrawal Note withdrawalAddressStatus: type: integer format: int32 description: Withdrawal address status, 1 enabled, 2 disabled withdrawRiskFailTime: type: integer description: >- Withdrawal address time, risk control expiration time ok: type: boolean fail: type: boolean examples: '1': summary: Success example value: msg: Success fail: false trace: x-gndw9-43s45-j1x875-59h9d-1677576513 code: '0' data: - chainName: Ethereum(ERC20) address: '234' currency: USDC remark: '' id: 14676 defaultType: 0 bizCode: '' tm: 3021714 msgParams: null ok: true headers: {} security: [] /global/customer.app.CustomerWalletWebApiService.withdrawalAddressGroupList: post: summary: Query withdrawal address list (grouped) deprecated: false description: >- version=0.0.1 bizType=customer.app.CustomerWalletWebApiService.withdrawalAddressGroupList Accessible after login operationId: walletList tags: - Customer/Wallet parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: currency: type: string description: Currency example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: array items: type: object properties: id: type: integer format: int64 description: id currency: type: string description: Currency chainName: type: string description: Withdrawal Network address: type: string description: Withdrawal Address remark: type: string description: Withdrawal Note createTime: type: integer description: Creation time description: Map description: Data Body ok: type: boolean fail: type: boolean examples: '1': summary: Success example value: msg: Success fail: false trace: x-gndw9-43s45-j1x875-59h9d-1677576513 code: '0' data: - chainName: Ethereum(ERC20) address: '234' currency: USDC remark: '' id: 14676 defaultType: 0 bizCode: '' tm: 3021714 msgParams: null ok: true headers: {} security: [] /global/customer.app.GoogleVerifyApiService.generateGoogleAccount: post: summary: Generate Google verification account deprecated: false description: |- version=0.0.1 bizType=customer.app.GoogleVerifyApiService.generateGoogleAccount Accessible after login operationId: checkGoogleCode tags: - Customer/Verification parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: {} example: '' responses: '200': description: '' content: application/json: schema: &ref_16 $ref: '#/components/schemas/BaseResultBoolean' examples: '1': summary: Success example value: msg: Success fail: false trace: x-e9558c26-a4e5-486b-831c-f53604646396-1677653793570 code: '0' data: code: null createTime: 1659087780437 qrcode: >- otpauth://totp/CTS2(2023-03-01)(86000116)?secret=RAUW2G2WRHKRSV5L updateTime: 1677653793296 secret: RAUW2G2WRHKRSV5L id: 41 customerNo: '86000116' status: 2 bizCode: '' tm: 22789118 msgParams: null ok: true headers: {} security: [] /global/customer.app.GoogleVerifyApiService.checkGoogleCode: post: summary: Check Google verification code status deprecated: false description: |- version=0.0.1 bizType=customer.app.GoogleVerifyApiService.checkGoogleCode Accessible after login operationId: findGoogleVerifyByCustomerNo tags: - Customer/Verification parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: code: type: string description: Google Verification Code required: - code example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: object properties: {} description: Response body. true for pass, false for fail ok: type: boolean fail: type: boolean examples: '1': summary: Success example value: "{\r \"msg\": \"Success\",\r \"fail\": false,\r \"trace\": \"x-2g2cku-47l3ei-kh1y9s4-3ol18a5w-1677637672\",\r \"code\": \"0\",\r \"data\": false,//true for pass, false for fail\r \"bizCode\": \"\",\r \"tm\": 6313035,\r \"msgParams\": null,\r \"ok\": true\r }" '2': summary: Exception example_parameter type mismatch value: msg: System error fail: true trace: x-2725h-355v0-1w8m-50cd65h-1677637790 code: '500' data: customer.app.GoogleVerifyApiService.checkGoogleCode bizCode: US tm: 6344724 msgParams: null ok: false headers: {} security: [] /global/customer.app.KycWebApiService.checkKycApply: post: summary: Is the business scenario KYC approved? deprecated: false description: |- version=0.0.1 bizType=customer.app.KycWebApiService.checkKycApply Can access after login operationId: checkKycApply tags: - Customer/KYC parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: openAccountType: type: integer format: int32 description: 'Account type: 0. Individual 1. Enterprise ' businessCode: type: string description: >- Business scenario code, account opening=open_account, deposit=cashin, withdrawal=withdraw, credit card=apply_credit_card required: - businessCode example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: KYC rejection reason tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: integer description: >- Normal 2=success, abnormal status [0 authentication, 1 under review, 3 review rejection] ok: type: boolean fail: type: boolean examples: '1': summary: Success example value: |- { "msg": "Success", "fail": false, "trace": "x-y87e-cait-r4b6-c135wj-1677641720", "code": "0", "data": 2,//Normal 2=success, abnormal status [0 authentication, 1 under review, 3 review rejection] "bizCode": "", "tm": 6551651, "msgParams": "CUSTOMER_API_0000602", "ok": true } headers: {} security: [] /global/customer.app.KycWebApiService.findAllBizKyc: post: summary: Get KYC authentication information for business scenarios deprecated: false description: |- version=0.0.1 bizType=customer.app.KycWebApiService.findAllBizKyc Accessible after login operationId: findAllBizKyc tags: - Customer/KYC parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: businessCode: type: string description: >- Business scenario code, account opening=open_account, deposit=cashin, withdrawal=withdraw, credit card=apply_credit_card openAccountType: type: integer format: int32 description: 'Account type: 0. Individual 1. Enterprise' required: - businessCode example: '' responses: '200': description: '' content: application/json: schema: &ref_10 $ref: '#/components/schemas/BaseResultListKycAuthVO' examples: '1': summary: Success example value: msg: Success fail: false trace: x-4djg1xe-p9sygx2-1v7k21-y2z1g-1677642057 code: '0' data: [] bizCode: '' tm: 4315987 msgParams: null ok: true headers: {} security: [] /global/customer.app.KycWebApiService.findAllBizKycList: post: summary: Identity authentication list deprecated: false description: |- version=0.0.1 bizType=customer.app.KycWebApiService.findAllBizKycList Accessible after login operationId: findAllBizKycList tags: - Customer/KYC parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: openAccountType: type: integer format: int32 description: 'Account type: 0. Individual 1. Enterprise ' example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: array description: Data Body items: type: object properties: levelCode: type: string description: KYC level code levelName: type: string description: KYC level name status: type: integer format: int32 description: >- Authentication status, 0-authenticated, 1-under review, 2-approved, 3-rejected statusName: type: string description: >- Authentication status name, 0-authenticated, 1-under review, 2-approved, 3-rejected sort: type: integer format: int32 description: Sort preLevelName: type: string description: Preceding Level Information businessNameList: type: array description: Business Scenario Name Collection uniqueItems: true items: type: string businessCodeList: type: array items: type: string description: Business Scenario Code Collection companyType: type: string description: 'Enterprise Type ' openAccountType: type: string description: 'Account type: 0. Individual 1. Enterprise ' pathCode: type: string description: Authentication Path ok: type: boolean fail: type: boolean headers: {} security: [] /global/customer.app.KycWebApiService.findAllCusKycListByBiz: post: summary: Get customer's authenticated information based on business scenarios deprecated: false description: |- version=0.0.1 bizType=customer.app.KycWebApiService.findAllCusKycListByBiz Access after login operationId: findAllCusKycListByBiz tags: - Customer/KYC parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: businessCode: type: string description: >- Business scenario code, account opening=open_account, deposit=cashin, withdrawal=withdraw, credit card=apply_credit_card required: - businessCode example: '' responses: '200': description: '' content: application/json: schema: *ref_10 headers: {} security: [] /global/customer.app.KycWebApiService.findAllLevelKyc: post: summary: Does KYC Level Require KYC Authentication deprecated: false description: |- version=0.0.1 bizType=customer.app.KycWebApiService.findAllLevelKyc Accessible after login operationId: findAllLevelKyc tags: - Customer/KYC parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: lang: type: string description: Language Information levelCode: type: string description: "KYC Level(\tlevel_1,level_2,\tlevel_3)" customerNo: type: string description: >- Customer Account Number (unique within each company, not unique across companies) openAccountType: type: integer format: int32 description: 'Account type: 0. Individual 1. Enterprise ' selectCountry: type: string description: Selected Country selectCompanyType: type: string description: Selected enterprise type example: levelCode: level_1 responses: '200': description: '' content: application/json: schema: *ref_10 headers: {} security: [] /global/customer.app.KycWebApiService.findCompanyCountry: post: summary: Get countries supporting enterprise account opening deprecated: false description: |- version=0.0.1 bizType=customer.app.KycWebApiService.findCompanyCountry Accessible after login operationId: findCompanyCountry tags: - Customer/KYC parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: {} example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: object description: Data Body properties: openCompanyCountry: type: string description: >- Countries supporting enterprise account opening (corresponding country code) required: - openCompanyCountry ok: type: boolean fail: type: boolean examples: '1': summary: Success example value: msg: Success fail: false trace: x-0m1j4g7-9f99i12r-n8f86-ev41-1677649081 code: '0' data: companyId: 360 createTime: 1647485223229 action: manual updateTime: 1675775113871 id: 1504288172189061000 openCompanyCountry: MC,CN bizCode: '' tm: 3817612 msgParams: null ok: true headers: {} security: [] /global/customer.app.KycWebApiService.kycApply: post: summary: KYC business scenario authentication application deprecated: false description: |- version=0.0.1 bizType=customer.app.KycWebApiService.kycApply Access after login operationId: kycApply tags: - Customer/KYC parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: levelCode: type: string description: KYC level Code (level_1, level_2, level_3) businessCode: type: string description: >- Business scenario code, account opening=open_account, deposit=cashin, withdrawal=withdraw, credit card=apply_credit_card openAccountType: type: integer format: int32 description: 'Account type: 0. Individual 1. Enterprise ' elementList: type: array description: KYC element collection items: &ref_11 $ref: '#/components/schemas/KycWebAddInnerDTO' maxItems: 2147483647 minItems: 1 selectCompanyType: type: string description: >- Selected enterprise type, required for enterprise authentication commitTag: type: boolean description: Whether to submit, default submission selectCountry: type: string description: >- Selected country, optional for enterprise authentication, empty value takes registered country cardType: type: string description: Card Type maxLength: 50 required: - elementList example: '' responses: '200': description: '' content: application/json: schema: *ref_8 headers: {} security: [] /global/customer.app.KycWebApiService.kycLevelApply: post: summary: KYC Level Certification Application deprecated: false description: |- version=0.0.1 bizType=customer.app.KycWebApiService.kycLevelApply Accessible after login operationId: kycLevelApply tags: - Customer/KYC parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: levelCode: type: string description: KYC level Code (level_1, level_2, level_3) openAccountType: type: integer format: int32 description: 'Account type: 0. Individual 1. Enterprise ' elementList: type: array description: KYC element collection items: *ref_11 maxItems: 2147483647 minItems: 1 selectCountry: type: string description: >- Selected country, optional for enterprise authentication, empty value takes registered country selectCompanyType: type: string description: >- Selected enterprise type, required for enterprise authentication commitTag: type: boolean description: Whether to submit, default submission required: - elementList example: levelCode: level_1 elementList: - elementCode: applyCurrency elementValue: HKD - elementCode: type elementValue: '1' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: string description: Corresponding KYC pending review proposal ID ok: type: boolean fail: type: boolean examples: '1': summary: Success example value: >- { "msg": "Success", "fail": false, "trace": "x-eb9so-p7qxs-7588-88mm-1677650372", "code": "0", "data": "K683312403240189952",//Corresponding KYC pending review proposal ID "bizCode": "", "tm": 28692396, "msgParams": null, "ok": true } '2': summary: >- Exception example - reapply after level application is approved value: msg: Client's KYC authentication is passed fail: true trace: x-vy13104l-kv1vr-58dm79k-2om9348-1677650302 code: CUSTOMER_API_0000604 data: customer.app.KycWebApiService.kycLevelApply bizCode: US tm: 5871580 msgParams: null ok: false headers: {} security: [] /global/customer.app.CustomerApiWebService.applyApi: post: summary: Apply API deprecated: false description: |- version=0.0.1 bizType=customer.app.CustomerApiWebService.applyApi Accessible after login operationId: applyApi tags: - Customer/Open API parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: tag: type: string description: API tag googleCode: type: string description: Google Verification Code phoneCode: type: string description: >- Mobile verification code, email verification code are required emailCode: type: string description: >- Mobile verification code, email verification code are required phoneSendToken: type: string description: >- Send mobile verification code to return token, phoneCode must be passed when not empty emailSendToken: type: string description: >- Send email verification code to return token, emailCode must be passed when not empty required: - tag example: '' responses: '200': description: '' content: application/json: schema: *ref_8 examples: '1': summary: Success example value: msg: Success fail: false trace: x-8e544ed3-057a-48ed-ade2-27d3998f7411-1677654224398 code: '0' data: customerGroupId: null sources: null apiKey: 47b471e57c394e8fbc18535805e04016 updateTime: 1677654224184 expiredTime: 1685430224184 privateKey: >- MIICdQIBADANBgkqhkiG9w0BAQEFAASCAl8wggJbAgEAAoGBAKvivs7OSD2kYMGjDoOQ6ATsnLV7GMZgJUtDW5N4RS+ZEG/unVSgbBxfVRYvJ3TQ7/bmf24Brs+dqEhWrlXHgdxe2ieQ4IBZb94jScUW2GWBlpz1ULCB1UIYF0sp6fzfadgeCkJrEdtC5xcp0dbg6KzAJOT2Qg6fuELt6M6PQsQlAgMBAAECgYA96ixfJDEjey2bMpgMzkq1U2HTgWbYNlPYu4emJEGPtqwUFbi4fhzTT4e/uPaWfpihsD+gqZyFjr3KaObdYUMmPX2gNVn1qtcTICF4Y0MPFhaGIb8hUzi/xJpOUYinOFzZpE3bt1EUvIlIvDzdqDKD6gEs6kh2ana2JPXzZAZiwQJBAOZ3PbrqDNM239/TvD2yzG6Z35thInH1P4ziShn3saOwU5vNYRt4ArfgNYUnjrlSFOYxAtkxr2GCOIUdfiYwd1UCQQC+7fu1FMWFEKnyg2DR0nkaj461EWNgEUD1nCUDP4d71ccUcf6399faatc3XAqzG7+XApxQpVp+eQIS3QefyHmRAkAJGdRaOTvga15T3GymkxT3mSP3YtKVZXXo/lamx90/9YqXsHiROSACWtxCMdm0/8TLgkv2f7vJQfcxaoS8xVUxAkAQbNzImT7c0bAtIsxDgL3WYR8/yH0qGJHkD0jH3MFFEAEOazgkj3fMXICjTJHHEs4KqbjU30THuJVLFiS/xDlhAkA4L4sl3aFVDFo0CUFjSMxFquaYe8QeS8t1eBpUR7PSJcKS80jKrHk4s8SOSf9/yuU/Kbnki4rUTXpR5fSscOqC whiteIps: null companyId: 368 createTime: 1677654224184 customerId: 117 ipLimit: false tag: '2343' withdrawTime: 1677827024184 secretKeyMd5: 95cfcea9ef853cd519d65858ddc01dfe id: 3 permissionDTOList: - code: ready_only paths: null canEdit: false name: Read status: 1 - code: trade paths: null canEdit: true name: Spot Trade status: 2 - code: contract_trade paths: null canEdit: true name: Contract Trade status: 2 - code: captial_out paths: null canEdit: true name: Withdraw status: 2 customerNo: '86000116' validityDays: 90 pubKey: >- MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCr4r7Ozkg9pGDBow6DkOgE7Jy1exjGYCVLQ1uTeEUvmRBv7p1UoGwcX1UWLyd00O/25n9uAa7PnahIVq5Vx4HcXtonkOCAWW/eI0nFFthlgZac9VCwgdVCGBdLKen832nYHgpCaxHbQucXKdHW4OiswCTk9kIOn7hC7ejOj0LEJQIDAQAB bizCode: '' tm: 87948437 msgParams: null ok: true headers: {} security: [] /global/customer.app.CustomerApiWebService.delApi: post: summary: Delete API deprecated: false description: |- version=0.0.1 bizType=customer.app.CustomerApiWebService.delApi Accessible after login operationId: delApi tags: - Customer/Open API parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: id: type: integer format: int64 description: api id example: '' responses: '200': description: '' content: application/json: schema: *ref_8 examples: '1': summary: Success example value: msg: Success fail: false trace: x-w6oxyoo-4of0261-34mqcj-84djd-1677656237 code: '0' data: null bizCode: '' tm: 15254881 msgParams: null ok: true '2': summary: Exception example - ID does not exist value: msg: 'Data not exist ' fail: true trace: x-o92qm6-67l41f-25m60l-cemws1-1677656280 code: CUSTOMER_API_0000003 data: customer.app.CustomerApiWebService.delApi bizCode: US tm: 2142467 msgParams: null ok: false headers: {} security: [] /global/customer.app.CustomerApiWebService.editApiPermission: post: summary: Allocate permissions deprecated: false description: |- version=0.0.1 bizType=customer.app.CustomerApiWebService.editApiPermission Accessible after login operationId: editApiPermission tags: - Customer/Open API parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: id: type: integer format: int64 description: API ID googleCode: type: string description: Google Verification Code tag: type: string description: API tag, cannot be duplicated permissionList: type: array description: Enable permission items: type: object properties: code: type: string description: Permission code status: type: integer format: int32 description: Whether to enable 1. Enable 2. Disable required: - status whiteIps: type: string description: Whitelist IP, bound IP address, separated by commas phoneCode: type: string description: >- Mobile verification code, email verification code are required emailCode: type: string description: >- Mobile verification code, email verification code are required phoneSendToken: type: string description: >- Send mobile verification code to return token, phoneCode must be passed when not empty emailSendToken: type: string description: >- Send email verification code to return token, emailCode must be passed when not empty example: '' responses: '200': description: '' content: application/json: schema: *ref_8 examples: '1': summary: Success example value: msg: Success fail: false trace: x-ed6d9fab-3efb-4df6-9375-613c0ede13a8-1677655915849 code: '0' data: null bizCode: '' tm: 45611250 msgParams: null ok: true '2': summary: Exception example - incorrect verification code value: msg: Invalid verification code fail: true trace: x-yhi2311h-372n4ygp-8eyz2-80981j5-1677656124 code: P_VERIFY_CODE_ERROR data: customer.app.CustomerApiWebService.editApiPermission bizCode: MS tm: 96624858 msgParams: null ok: false headers: {} security: [] /global/customer.app.CustomerApiWebService.page: post: summary: API list deprecated: false description: |- version=0.0.1 bizType=customer.app.CustomerApiWebService.page Access after login operationId: page tags: - Customer/Open API parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: size: type: integer format: int64 description: Number of Items per Page current: type: integer format: int64 description: Current Page tag: type: string description: API tag example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: object properties: records: type: array description: Result list items: type: object properties: id: type: integer format: int64 description: The unique ID corresponding to this API createTime: type: integer format: int64 description: Creation time / Application time updateTime: type: integer format: int64 description: Update Time apiKey: type: string description: access Key customerNo: type: string description: customerNo customerId: type: integer format: int64 description: Client ID customerGroupId: type: integer format: int64 description: Client group ID companyId: type: integer format: int64 description: companyId secretKeyMd5: type: string description: secretKeyMd5 privateKey: type: string description: secretKey, only returned when applied for pubKey: type: string description: Public key tag: type: string description: Tag permissionDTOList: type: array description: List of permissions items: &ref_42 $ref: '#/components/schemas/CustomerApiPermissionDTO' ipLimit: type: boolean description: Whether IP restriction is enabled whiteIps: type: string description: IP whitelist sources: type: array description: Permission paths allowed to access items: type: string expiredTime: type: integer format: int64 description: Expiration time withdrawTime: type: integer format: int64 validityDays: type: integer format: int32 description: >- Validity period (days) -1 expired null permanently valid, total: type: integer format: int64 description: Total size: type: integer format: int64 description: Number of Items per Page current: type: integer format: int64 description: Current Page ok: type: boolean fail: type: boolean examples: '1': summary: Success example value: msg: Success fail: false trace: x-2qv668o0-2mnuze-s31o-ytm66-1677655713 code: '0' data: total: 1 current: 1 size: 20 records: - customerGroupId: null sources: null apiKey: 24004c947cdf44e7ab9ec8abb952f820 updateTime: 1654081061854 expiredTime: 1661857061854 privateKey: null whiteIps: null companyId: 360 createTime: 1654081061854 customerId: 1176 ipLimit: false tag: '3243' withdrawTime: 1654253861855 secretKeyMd5: 0593fd76760ff274dfcb46f29d1efe0b id: 14 permissionDTOList: null customerNo: '86001175' validityDays: -1 pubKey: >- MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQComVWUCnp7zp6haXIHEVz+W3HABGTc+A+IIZRGnKOyX4ajBr+4nS7c0sWf44AJL14hNA4r/sbMKCoY5Wb4HPjvBt/wServiUgYUlC6bheoB6v8FwjvV3wyWfI93Z+q5VWij28WavcNihi240CDQQrbkgv0S21ySPlRk5O90nV0nwIDAQAB bizCode: '' tm: 7721022 msgParams: null ok: true headers: {} security: [] /global/customer.app.CustomerApiWebService.queryApi: post: summary: API details deprecated: false description: |- version=0.0.1 bizType=customer.app.CustomerApiWebService.queryApi Accessible after login operationId: queryApi tags: - Customer/Open API parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: id: type: integer format: int64 description: API Id example: '' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/BaseResultCustomerApiVO' examples: '1': summary: Success example value: msg: Success fail: false trace: x-6mv1-14cq25x-od831-i33130-1677655760 code: '0' data: customerGroupId: 1 sources: - >- message.app.PlatFormMessageTempApiService.getPlatformTempParentTypeList_0.0.1_ - >- message.app.PlatFormMessageLogApiService.queryPlatFormMessageLogList_0.0.1_ - >- message.app.ChannelMessageLogApiService.queryChannelMessageLogList_0.0.1_ - config.app.ParamDubboService.getPage__ - config.app.AppDictDubboService.getListByParentCode__ - config.app.AppAssetsDubboService.getAssetsList__ - config.app.AppSymbolDubboService.getSymbolBaseList__ - config.app.AppSymbolDubboService.getSymbolDetail__ - config.app.AppSymbolDubboService.getSymbolList__ - config.app.AppSymbolDubboService.getFundInfo__ - >- config.app.AppSymbolDubboService.getEquityPremiumRate__ - config.app.AppSymbolDubboService.findFundPage__ - >- config.app.AppSymbolDubboService.findFundPageWithRealTimeInfo__ - >- customer.app.CustomerOptionalWebApiService.optionalList_0.0.1_ - >- customer.app.CustomerWalletWebApiService.walletList_0.0.1_ - >- customer.app.CustomerWebApiService.queryCustomerAssetsInfo_0.0.1_ - >- customer.app.CustomerWebApiService.queryAccountById_0.0.1_ - >- customer.app.CustomerWebApiService.queryCustomerAssets_0.0.1_ - >- fund.app.DepositAppDubboService.getDepositExchangeRate_0.0.1_ - >- fund.app.WithdrawAppDubboService.getWithdrawMethodList_0.0.1_ - >- fund.app.WithdrawAppDubboService.getWithdrawCurrencyList_0.0.1_ - >- fund.app.WithdrawAppDubboService.getWithdrawExchangeRate_0.0.1_ - >- fund.app.WithdrawAppDubboService.queryWithdrawLimitConfig_0.0.1_ - >- fund.app.WithdrawAppDubboService.getWithdrawAmountLimitInfo_0.0.1_ - >- fund.app.WithdrawAppDubboService.computeWithdrawFee_0.0.1_ - >- fund.app.WithdrawAppDubboService.getAccountMarginRate_0.0.1_ - >- fund.app.WithdrawAppDubboService.getWithdrawTimesIn24Hour_0.0.1_ - >- fund.app.CustomerProposalQueryService.queryWithdrawPageList_0.0.1_ - >- fund.app.WithdrawAppDubboService.withdrawCurrencyList_0.0.1_ - >- fund.app.DepositAppDubboService.capitalTransferRecord_0.0.1_ - >- fund.app.DepositAppDubboService.getCryptoBlockchainInfo_0.0.1_ - >- fund.app.DepositAppDubboService.getBindRechargeAddress_0.0.1_ - >- fund.app.WithdrawAppDubboService.getCoinWithdrawCurrencyList_0.0.1_ - >- fund.app.DepositAppDubboService.getDepositCoinList_0.0.1_ - >- fund.app.WithdrawAppDubboService.getWithdrawAccountCurrencyList_0.0.1_ - >- tradeapi.app.OrderApiService.queryOrderPage_0.0.1_tradeApi - >- tradeapi.app.OrderApiService.queryOrderDetail_0.0.1_tradeApi - >- tradeapi.app.PositionApiService.queryPositionPage_0.0.1_tradeApi - >- tradeapi.app.PositionApiService.queryPositionDetail_0.0.1_tradeApi - >- tradeapi.app.OrderApiService.queryPBOOrderPage_0.0.1_tradeApi - >- tradeapi.app.OrderApiService.queryHistoryCloseOrderList_0.0.1_tradeApi - >- tradeapi.app.OrderApiService.queryCapitalFlowList_0.0.1_tradeApi - >- tradeapi.app.OrderApiService.previewOrder_0.0.1_tradeApi - >- tradeapi.app.OrderApiService.queryTradeRecordPage_0.0.1_tradeApi - >- report.app.ReportDatadDubboService.marketPerformance_0.0.1_ - >- report.app.ReportDatadDubboService.marketPerformanceQuoteChange_0.0.1_ - >- report.app.ReportDatadDubboService.investCombination_0.0.1_ - >- report.app.ReportDatadDubboService.assetPerformance_0.0.1_ - >- report.app.ReportDatadDubboService.fundNetValueChangeQuote_0.0.1_ - report.app.ReportDatadDubboService.indexSample_0.0.1_ - >- report.app.ReportDatadDubboService.indexSimplePerformance_0.0.1_ - >- report.app.ReportDatadDubboService.batchMarketPerformance_0.0.1_ - >- customer.app.CustomerWebApiService.findCustomerInfo_0.0.1_ - order.app.OrderDubboService.queryRequestOrderPage__ apiKey: 24004c947cdf44e7ab9ec8abb952f820 updateTime: 1654081061854 expiredTime: 1661857061854 privateKey: null whiteIps: null companyId: 360 createTime: 1654081061854 customerId: 1176 ipLimit: false tag: '3243' withdrawTime: 1654253861855 secretKeyMd5: 0593fd76760ff274dfcb46f29d1efe0b id: 14 permissionDTOList: - code: ready_only paths: null canEdit: false name: Read status: 1 - code: trade paths: null canEdit: true name: Spot Trade status: 2 - code: contract_trade paths: null canEdit: true name: Contract Trade status: 2 - code: captial_out paths: null canEdit: true name: Withdraw status: 2 customerNo: '86001175' validityDays: -1 pubKey: >- MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQComVWUCnp7zp6haXIHEVz+W3HABGTc+A+IIZRGnKOyX4ajBr+4nS7c0sWf44AJL14hNA4r/sbMKCoY5Wb4HPjvBt/wServiUgYUlC6bheoB6v8FwjvV3wyWfI93Z+q5VWij28WavcNihi240CDQQrbkgv0S21ySPlRk5O90nV0nwIDAQAB bizCode: '' tm: 11271064 msgParams: null ok: true headers: {} security: [] /global/message.app.VerificationApiService.verifyCodeSend: post: summary: Send verification code deprecated: false description: >- Explanation: Send verification code. According to each business type (`bizType`) and sender (`toUser`/`customerNo`), only 5 SMS and 5 email messages are allowed within half an hour version=0.0.1 bizType=message.app.VerificationApiService.verifyCodeSend Enable CAPTCHA version=0.0.2 bizType=message.app.VerificationApiService.verifyCodeSend tags: - Message parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: companyId: type: integer format: long title: Company Id description: Company Id customerId: type: integer format: long title: Client Id description: Client Id bizType: type: string title: Business type description: >- Business type. EMAIL_COMMON_VERIFICATION_CODE-Email common verification code; EMAIL_LOGIN_VERIFICATION_CODE-Email login verification code; EMAIL_REGISTER_VERIFICATION_CODE-Email registration verification code; EMAIL_PASSWORD_VERIFICATION_CODE-Email forget password verification code; EMAIL_LOGINED_VERIFICATION_CODE-Common verification code-logged in-get recipient from client information; SMS_COMMON_VERIFICATION_CODE-SMS common verification code; SMS_LOGIN_VERIFICATION_CODE-SMS login verification code; SMS_REGISTER_VERIFICATION_CODE-SMS registration verification code; SMS_PASSWORD_VERIFICATION_CODE-SMS forget password verification code; SMS_LOGINED_VERIFICATION_CODE-Common verification code-logged in-get recipient from client information; SMS_TELEGRAM_VERIFICATION_CODE-SMS telegram verification code; toUser: type: string title: Recipient description: >- Recipient. `toUser`, `customerNo` must be filled in: if need to get from client information, fill in `customerNo`, if sending telegram verification code, fill in third party userId customerNo: type: string title: Recipient description: >- Recipient. `toUser`, `customerNo` must have one to fill: if you need to get it from customer information, pass `customerNo` country: type: string description: Recipient's country information required: - companyId - bizType example: companyId: 39 bizType: EMAIL_PASSWORD_VERIFICATION_CODE toUser: 4632144@qq.com customerId: 88 responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string title: Module identifier code description: Module identifier code code: type: string title: Status return code description: Status return code msg: type: string title: Status description description: Status description tm: type: integer format: int64 title: Processing time (milliseconds) description: Processing time (milliseconds) trace: type: string title: Tracking code description: Tracking code msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas description: >- Placeholder parameter string in return description, multiple parameters separated by commas ok: type: boolean fail: type: boolean data: type: object properties: token: type: string title: Send ticket description: Send ticket title: Data Body description: Data Body examples: '1': summary: Success example value: msg: Success fail: false trace: x-45c2ptm3-u5p98t3-gf1b2x-9pbyl41-1678691805 code: '0' data: token: 38caf08b-fafd-4cb5-b36c-ebdd1878b974 bizCode: '' tm: 34 msgParams: null ok: true headers: {} security: [] /global/getMsgPushToken: post: summary: get Msg Token deprecated: false description: >- This interface is used by customers to access OpenAPI and apply for the authentication token for message subscription when they need to subscribe to account, position, and transaction push messages. tags: - Message parameters: - name: companyId in: header description: company id required: false example: '{{company}}' schema: type: string - name: trace in: header description: Trace required: false example: '{{mock_trace}}' schema: type: string - name: lang in: header description: language required: false example: zh-CN schema: type: string - name: recvWindow in: header description: Time window required: false example: '5000' schema: type: string - name: apiKey in: header description: apiKey required: false example: '{{apikey}}' schema: type: string - name: signature in: header description: signature required: false example: '{{sign}}' schema: type: string requestBody: content: application/json: schema: type: object properties: {} example: {} responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string title: Module identifier code description: Module identifier code code: type: string title: Status return code description: Status return code msg: type: string title: Status description description: Status description tm: type: integer format: int64 title: Processing time (milliseconds) description: Processing time (milliseconds) trace: type: string title: Tracking code description: Tracking code data: type: string description: Msg Token required: - data examples: '1': summary: Success value: msg: Success fail: false trace: '' code: '0' data: 6230de2c-281a-47fe-9d5d-b5f6ac60f482push bizCode: '' tm: 0 ok: true headers: {} security: [] /global/message.app.VerificationApiService.verifyCodeCheck: post: summary: Verify verification code deprecated: false description: |- Description: Verify verification code version=0.0.1 bizType=message.app.VerificationApiService.verifyCodeCheck tags: - Message parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: companyId: type: integer format: long title: Company Id description: Company Id customerId: type: integer format: long title: Client Id description: Client Id bizType: type: string title: Business type description: >- Business type. EMAIL_COMMON_VERIFICATION_CODE-Email common verification code; EMAIL_LOGIN_VERIFICATION_CODE-Email login verification code; EMAIL_REGISTER_VERIFICATION_CODE-Email registration verification code; EMAIL_PASSWORD_VERIFICATION_CODE-Email forget password verification code; EMAIL_LOGINED_VERIFICATION_CODE-Common verification code-logged in-get recipient from customer information; SMS_COMMON_VERIFICATION_CODE-SMS common verification code; SMS_LOGIN_VERIFICATION_CODE-SMS login verification code; SMS_REGISTER_VERIFICATION_CODE-SMS registration verification code; SMS_PASSWORD_VERIFICATION_CODE-SMS forget password verification code; SMS_LOGINED_VERIFICATION_CODE-Common verification code-logged in-get recipient from customer information; toUser: type: string title: Recipient description: Recipient sendToken: type: string title: Send ticket description: Send ticket code: type: string title: Verification code description: >- Verification code. Can only be used once, and at least one of `verifyCodeToken` must have a value verifyCodeToken: type: string title: Validate Ticket description: >- Verification token. Returned after the first verification of the verification code. (At least one of `code` must have a value. If both `code` and `code` have values, only this field is verified). Note: If there are 5 verification errors, the verification token will be invalidated directly required: - companyId - bizType - toUser - sendToken example: companyId: 12 bizType: sit sint ut sed occaecat toUser: in sendToken: fugiat ipsum occaecat customerId: 49 code: '53' verifyCodeToken: '95' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string title: Module identifier code description: Module identifier code code: type: string title: Status return code description: Status return code msg: type: string title: Status description description: Status description tm: type: integer format: int64 title: Processing time (milliseconds) description: Processing time (milliseconds) trace: type: string title: Tracking code description: Tracking code msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas description: >- Placeholder parameter string in return description, multiple parameters separated by commas ok: type: boolean fail: type: boolean data: type: object properties: token: type: string title: Validate Ticket description: Validate Ticket title: Data Body description: Data Body examples: '1': summary: Success example value: msg: Success fail: false trace: x-71o574-2tn5hk-pkj44361-3612md-1678691829 code: '0' data: token: 647a8a53-b97c-4d4a-b936-ffdce2096ad6 bizCode: '' tm: 10 msgParams: null ok: true headers: {} security: [] /global/message.app.PlatFormMessageTempApiService.getPlatformTempParentTypeList: post: summary: Station message type deprecated: false description: >- Explanation: Get the list of station message types under the specified company version=0.0.1 bizType=message.app.PlatFormMessageTempApiService.getPlatformTempParentTypeList tags: - Message parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: companyId: type: integer format: long title: Company Id required: - companyId example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string title: Module identifier code code: type: string title: Status return code msg: type: string title: Status description tm: type: integer format: int64 title: Processing time (milliseconds) trace: type: string title: Tracking code msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas ok: type: boolean fail: type: boolean data: type: array items: type: object properties: type: type: string title: Type value desc: type: string title: Description required: - desc title: Data Body headers: {} security: [] /global/message.app.PlatFormMessageLogApiService.queryPlatFormMessageLogList: post: summary: Internal message list deprecated: false description: >- Explanation: Get the message list of the specified company version=0.0.1 bizType=message.app.PlatFormMessageLogApiService.queryPlatFormMessageLogList tags: - Message parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: companyId: type: integer format: long title: Company Id bizType: type: string title: Business type status: type: integer format: int32 title: Status description: 1-Unread; 2-Read; 3-Delete; language: type: string title: Language accountId: type: integer format: long title: Account ID customerId: type: integer format: long title: Client ID required: - companyId example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string title: Module identifier code code: type: string title: Status return code msg: type: string title: Status description tm: type: integer format: int64 title: Processing time (milliseconds) trace: type: string title: Tracking code msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas ok: type: boolean fail: type: boolean data: type: array items: type: object properties: bizType: type: string title: Business type status: type: string title: Status description: 1-Unread; 2-Read; 3-Delete; title: type: string title: Title content: type: string title: Content redirectType: type: string title: Jump Type description: '*' redirectUrl: type: string title: Jump Address description: '*' createdBy: type: string title: Creator title: Data Body headers: {} security: [] /global/message.app.PlatFormMessageLogApiService.queryPlatFormMessageLogByPage: post: summary: Paging query station message records deprecated: false description: >- Explanation: Paging query channel message template list version=0.0.1 bizType=message.app.PlatFormMessageLogApiService.queryPlatFormMessageLogByPage tags: - Message parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: companyId: type: integer format: long title: Company Id description: Company Id bizType: type: string title: Business type description: Business type status: type: integer format: int32 title: Status description: Status. 1-Unread; 2-Read; 3-Deleted; language: type: string title: Language description: Language accountId: type: integer format: long title: Account ID description: Account ID type: type: integer format: int32 title: Type description: Type title: type: string title: Title description: Title parentType: type: string title: Total type description: Total type customerId: type: integer format: long title: Client ID description: Client ID startSendTime: type: integer title: Start sending time description: Start sending time format: long endSendTime: type: integer title: End sending time description: End sending time format: long size: type: integer format: long title: Number of Items per Page description: Number of Items per Page current: type: integer format: long title: Current Page description: Current Page required: - companyId example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string title: Module identifier code description: Module identifier code code: type: string title: Status return code description: Status return code msg: type: string title: Status description description: Status description tm: type: integer format: int64 title: Processing time (milliseconds) description: Processing time (milliseconds) trace: type: string title: Tracking code description: Tracking code msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas description: >- Placeholder parameter string in return description, multiple parameters separated by commas ok: type: boolean fail: type: boolean data: type: array items: type: object properties: companyId: type: integer format: long description: Company ID title: Company ID content: type: string title: Content description: Content createdBy: type: string title: Creator description: Creator createTime: type: integer format: long title: Creation time description: Creation time customerId: type: integer format: long title: Client ID description: Client ID readStatus: type: string description: Read status 1-Unread; 2-Read; 3-Deleted; title: Read status 1-Unread; 2-Read; title: type: string title: Title description: Title updateBy: type: string title: Updater description: Updater updateTime: type: string title: Update Time description: Update Time customerNo: type: string title: Client number description: Client number title: Data Body description: Data Body headers: {} security: [] /global/message.app.CompanyNoticeApiService.customerViewNoticePage: post: summary: Announcement list deprecated: false description: |- Explanation: Query announcement list version=0.0.1 bizType=message.app.CompanyNoticeApiService.customerViewNoticePage tags: - Message parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: companyId: type: integer format: long title: Company Id description: Company Id customerNo: type: string title: Client number description: Client number lang: type: string title: Language description: Language size: type: integer format: long title: Number of Items per Page description: Number of Items per Page current: type: integer format: long title: Current page, starting from 1 description: Current page, starting from 1 pubTimeFrom: type: integer title: Release time - start format: long description: Release time - start. 13-digit timestamp pubTimeTo: type: integer title: Release time - end format: long description: Release time - end. 13-digit timestamp required: - companyId - lang - size - current example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string title: Module identifier code description: Module identifier code code: type: string title: Status return code description: Status return code msg: type: string title: Status description description: Status description tm: type: integer format: int64 title: Processing time (milliseconds) description: Processing time (milliseconds) trace: type: string title: Tracking code description: Tracking code msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas description: >- Placeholder parameter string in return description, multiple parameters separated by commas ok: type: boolean fail: type: boolean data: type: array items: type: object properties: name: type: string title: Name description: Name language: type: string title: Language description: Language title: type: string title: Title description: Title content: type: string title: Content description: Content pubTime: type: integer title: Release time format: long description: Release time. 13-digit timestamp id: type: integer title: Primary key id format: long description: Primary key id companyId: type: integer title: Company ID format: long description: Company ID customerNo: type: string title: Client number description: Client number title: Data Body description: Data Body headers: {} security: [] /global/message.app.CompanyNoticeApiService.customerViewMsgPage: post: summary: Message list deprecated: false description: |- Explanation: Customers view message list version=0.0.1 bizType=message.app.CompanyNoticeApiService.customerViewMsgPage tags: - Message parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: companyId: type: integer format: long title: Company Id customerNo: type: string title: Client number lang: type: string title: Language size: type: integer format: long title: Number of Items per Page current: type: integer format: long title: Current page, starting from 1 pubTimeFrom: type: integer title: Release time - start format: long description: 13-digit timestamp pubTimeTo: type: integer title: Release time - end format: long description: 13-digit timestamp required: - companyId - lang - size - current - customerNo example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string title: Module identifier code code: type: string title: Status return code msg: type: string title: Status description tm: type: integer format: int64 title: Processing time (milliseconds) trace: type: string title: Tracking code msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas ok: type: boolean fail: type: boolean data: type: array items: type: object properties: name: type: string title: Name language: type: string title: Language title: type: string title: Title content: type: string title: Content pubTime: type: integer title: Release time format: long description: 13-digit timestamp id: type: integer title: Primary key id format: long companyId: type: integer title: Company ID format: long customerNo: type: string title: Client number readStatus: type: string title: Read status description: 1-Unread; 2-Read; title: Data Body headers: {} security: [] /global/message.app.CompanyNoticeApiService.msgRead: post: summary: Read message deprecated: false description: |- Explanation: Customer reads message version=0.0.1 bizType=message.app.CompanyNoticeApiService.msgRead tags: - Message parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: companyId: type: integer format: long title: Company Id customerNo: type: string title: Client number id: type: integer format: long title: Message ID required: - companyId - customerNo - id example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string title: Module identifier code code: type: string title: Status return code msg: type: string title: Status description tm: type: integer format: int64 title: Processing time (milliseconds) trace: type: string title: Tracking code msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas ok: type: boolean fail: type: boolean data: type: object properties: {} title: Data Body headers: {} security: [] /global/message.app.CompanyNoticeApiService.msgAllRead: post: summary: All messages read deprecated: false description: |- Explanation: All customer messages have been read version=0.0.1 bizType=message.app.CompanyNoticeApiService.msgAllRead tags: - Message parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: companyId: type: integer format: long title: Company Id customerNo: type: string title: Client number required: - companyId - customerNo example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string title: Module identifier code code: type: string title: Status return code msg: type: string title: Status description tm: type: integer format: int64 title: Processing time (milliseconds) trace: type: string title: Tracking code msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas ok: type: boolean fail: type: boolean data: type: object properties: {} title: Data Body headers: {} security: [] /global/messagepush.app.OfflinePushService.clientIdBindCustomer: post: summary: Unipush account binding deprecated: false description: >- Explanation: Unipush account binding clientId bizType=messagepush.app.OfflinePushService.clientIdBindCustomer tags: - Message parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: companyId: type: integer format: long title: Company Id customerId: type: integer title: Customer ID format: long clientId: type: string title: Getui customer id required: - companyId - clientId example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string title: Module identifier code code: type: string title: Status return code msg: type: string title: Status description tm: type: integer format: int64 title: Processing time (milliseconds) trace: type: string title: Tracking code msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas ok: type: boolean fail: type: boolean data: type: boolean title: Data Body description: true-success; false-failure; headers: {} security: [] /global/message.app.CompanyNoticeApiService.sendContactUsMsg: post: summary: Send Contact Us Email Message deprecated: false description: |- Explanation: Send Contact Us Information version=0.0.1 bizType=message.app.CompanyNoticeApiService.sendContactUsMsg tags: - Message parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: companyId: type: integer format: long title: Company Id description: Company Id name: type: string title: Business type description: Name email: type: string title: Recipient description: Email message: type: string title: Recipient description: Content required: - companyId example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string title: Module identifier code description: Module identifier code code: type: string title: Status return code description: Status return code msg: type: string title: Status description description: Status description tm: type: integer format: int64 title: Processing time (milliseconds) description: Processing time (milliseconds) trace: type: string title: Tracking code description: Tracking code headers: {} security: [] /global/fund.app.DepositAppDubboService.applyRechargeBindAddress: post: summary: Apply for Binding Direct Recharge Payment Wallet Address deprecated: false description: |- bizType=fund.app.DepositAppDubboService.applyRechargeBindAddress Apply for Binding Direct Recharge Payment Wallet Address Accessible after login operationId: applyRechargeBindAddress tags: - Funds/Deposit parameters: - name: version in: header description: '' required: true example: 0.0.1 schema: type: string - name: companyId in: header description: '' required: true example: '{{company}}' schema: type: string - name: trace in: header description: '' required: true example: '{{mock_trace}}' schema: type: string - name: lang in: header description: '' required: true example: zh-CN schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string requestBody: content: application/json: schema: &ref_13 $ref: '#/components/schemas/CustomerRechargeWalletAddrReqDto' example: '' responses: '200': description: '' content: application/json: schema: &ref_14 $ref: >- #/components/schemas/BaseResultCustomerRechargeWalletAddrRespDto headers: {} security: [] /global/fund.app.DepositAppDubboService.markOpenCardDepositRate: post: summary: Mark the exchange rate for opening card fee deposit deprecated: false description: |- bizType=fund.app.DepositAppDubboService.markOpenCardDepositRate Mark the exchange rate for opening card fee deposit Login required to access operationId: applyRechargeBindAddress tags: - Funds/Deposit parameters: [] requestBody: content: application/json: schema: type: object properties: depositRateSerialNo: type: string description: Deposit exchange rate serial number paymentCurrency: type: string description: Payment currency blockchainName: type: string description: Chain Name address: type: string description: Receiving address required: - depositRateSerialNo - paymentCurrency - blockchainName example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: boolean description: Data Body ok: type: boolean fail: type: boolean headers: {} security: [] /global/fund.app.DepositAppDubboService.prePaymentOrder: post: summary: Prepayment order information deprecated: false description: >- bizType=fund.app.DepositAppDubboService.prePaymentOrder version=0.0.1 Prepayment order information, the order information will only be saved for 15 minutes, when paying the order, you need to pass the result returned by this interface and enter the orderNo. Access after login operationId: applyRechargeBindAddress tags: - Funds/Deposit parameters: [] requestBody: content: application/json: schema: type: object properties: extend: type: string description: Deposit order extended field information required: - extend example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string description: >- Module identifier code, the service module that the current request will ultimately process, can be empty code: type: string description: >- Status return code, code=0, indicates the current request operation is successful, other codes indicate operation failure msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: >- Global link flag, consistent with the trace in the request header, for easy problem location msgParams: type: string description: >- Placeholder parameter string in the return status description, multiple parameters separated by commas, used to handle variable information in the status description, providing a user-friendly interactive experience data: type: string description: >- Response body, deposit unique identifier, valid for 15 minutes. ok: type: boolean description: Operation success, true=success, false=failure fail: type: boolean description: Operation failure, true=success, false=failure headers: {} security: [] /global/fund.app.DepositAppDubboService.capitalTransfer: post: summary: >- Transfer of assets and funds between different gameplay with the same currency deprecated: false description: >- bizType=fund.app.DepositAppDubboService.capitalTransfer Transfer of funds between different gameplay with the same assets Access after login operationId: capitalTransfer tags: - Funds/Deposit parameters: - name: version in: header description: '' required: true example: 0.0.1 schema: type: string - name: companyId in: header description: '' required: true example: '{{company}}' schema: type: string - name: trace in: header description: '' required: true example: '{{mock_trace}}' schema: type: string - name: lang in: header description: '' required: true example: zh-CN schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CapitalTransferReqDto' example: '' responses: '200': description: '' content: application/json: schema: &ref_12 $ref: '#/components/schemas/BaseResultAmountTransferVo' headers: {} security: [] /global/fund.app.DepositAppDubboService.capitalTransferForAgent: post: summary: >- Transfer assets and funds from the proxy client to the client being represented deprecated: false description: |- bizType=fund.app.DepositAppDubboService.capitalTransferForAgent Transfer of the same assets and funds between different gameplay Accessible after login operationId: capitalTransfer tags: - Funds/Deposit parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: tradeType: type: integer format: int64 description: Account gameplay, fixed value 7 toCustomerNo: type: string description: Transfer to customer number amount: type: number description: Sliding amount currency: type: string description: Transfer out currency required: - tradeType - toCustomerNo - amount - currency example: tradeType: 7 toCustomerNo: '86021560' amount: 100 currency: HKD responses: '200': description: '' content: application/json: schema: *ref_12 headers: {} security: [] /global/fund.app.DepositAppDubboService.capitalTransferRecord: post: summary: Query Fund Transfer Records deprecated: false description: |- bizType=fund.app.DepositAppDubboService.capitalTransferRecord Query capital transfer records Accessible after login operationId: capitalTransferRecord tags: - Funds/Deposit parameters: - name: version in: header description: '' required: true example: 0.0.1 schema: type: string - name: companyId in: header description: '' required: true example: '{{company}}' schema: type: string - name: trace in: header description: '' required: true example: '{{mock_trace}}' schema: type: string - name: lang in: header description: '' required: true example: zh-CN schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CapitalTransferRecordDto' example: '' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/BaseResultCapitalTransferRecordResDto' headers: {} security: [] /global/fund.app.DepositAppDubboService.capitalTransferSupportDiffCurr: post: summary: Asset fund transfer deprecated: false description: |- bizType=fund.app.DepositAppDubboService.capitalTransferSupportDiffCurr Asset fund transfer Accessible after login operationId: capitalTransferSupportDiffCurr tags: - Funds/Deposit parameters: - name: version in: header description: '' required: true example: 0.0.1 schema: type: string - name: companyId in: header description: '' required: true example: '{{company}}' schema: type: string - name: trace in: header description: '' required: true example: '{{mock_trace}}' schema: type: string - name: lang in: header description: '' required: true example: zh-CN schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CapitalTransferDiffCurrReqDto' example: '' responses: '200': description: '' content: application/json: schema: *ref_12 headers: {} security: [] /global/fund.app.DepositAppDubboService.createDepositProposal: post: summary: Create Deposit Proposal deprecated: false description: |- bizType=fund.app.DepositAppDubboService.createDepositProposal Create Deposit Proposal Accessible after login operationId: createDepositProposal tags: - Funds/Deposit parameters: - name: version in: header description: '' required: true example: 0.0.1 schema: type: string - name: companyId in: header description: '' required: true example: '{{company}}' schema: type: string - name: trace in: header description: '' required: true example: '{{mock_trace}}' schema: type: string - name: lang in: header description: '' required: true example: zh-CN schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateCustomerDepositReqDto' example: '' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/BaseResultCreateCustomerDepositRespDto' headers: {} security: [] /global/fund.app.DepositAppDubboService.getBindRechargeAddress: post: summary: Query direct recharge payment wallet address deprecated: false description: |- bizType=fund.app.DepositAppDubboService.getBindRechargeAddress Query direct recharge payment wallet address Accessible after login operationId: getBindRechargeAddress tags: - Funds/Deposit parameters: - name: version in: header description: '' required: true example: 0.0.1 schema: type: string - name: companyId in: header description: '' required: true example: '{{company}}' schema: type: string - name: trace in: header description: '' required: true example: '{{mock_trace}}' schema: type: string - name: lang in: header description: '' required: true example: zh-CN schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string requestBody: content: application/json: schema: *ref_13 example: '' responses: '200': description: '' content: application/json: schema: *ref_14 headers: {} security: [] /global/fund.app.DepositAppDubboService.getCryptoBlockchainInfo: post: summary: Get direct top-up payment channel supported currency information deprecated: false description: |- bizType=fund.app.DepositAppDubboService.getDepositCoinList Get direct top-up payment channel supported currency information Accessible after login operationId: getCryptoBlockchainInfo tags: - Funds/Deposit parameters: - name: version in: header description: '' required: true example: 0.0.1 schema: type: string - name: companyId in: header description: '' required: true example: '{{company}}' schema: type: string - name: trace in: header description: '' required: true example: '{{mock_trace}}' schema: type: string - name: lang in: header description: '' required: true example: zh-CN schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CryptoBlockchainReqDto' example: '' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/BaseResultCryptoBlockchainRespDto' headers: {} security: [] /global/fund.app.DepositAppDubboService.getDepositAccountCurrencyList: post: summary: >- Get the list of account currency information supported by the payment channel deprecated: false description: >- bizType=fund.app.DepositAppDubboService.getDepositAccountCurrencyList Get the list of account currency information supported by the payment channel Accessible after login operationId: getDepositAccountCurrencyList tags: - Funds/Deposit parameters: - name: version in: header description: '' required: true example: 0.0.1 schema: type: string - name: companyId in: header description: '' required: true example: '{{company}}' schema: type: string - name: trace in: header description: '' required: true example: '{{mock_trace}}' schema: type: string - name: lang in: header description: '' required: true example: zh-CN schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/QueryDepositAccountCurrencyListDto' example: '' responses: '200': description: '' content: application/json: schema: $ref: >- #/components/schemas/BaseResultSetDepositAccountCurrencyRespDto headers: {} security: [] /global/fund.app.DepositAppDubboService.getDepositAccountCurrencyListV2: post: summary: >- Query the supported recharge account currency and chain information for payment channels deprecated: false description: >- bizType=fund.app.DepositAppDubboService.getDepositAccountCurrencyListV2 Query the supported recharge account currency and chain information for payment channels Access after login operationId: getDepositAccountCurrencyListV2 tags: - Funds/Deposit parameters: - name: version in: header description: '' required: true example: 0.0.1 schema: type: string - name: companyId in: header description: '' required: true example: '{{company}}' schema: type: string - name: trace in: header description: '' required: true example: '{{mock_trace}}' schema: type: string - name: lang in: header description: '' required: true example: zh-CN schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/QueryDepositAccountCurrencyListV2Dto' example: '' responses: '200': description: '' content: application/json: schema: $ref: >- #/components/schemas/BaseResultListDepositAccountCurrencyRespV2Dto headers: {} security: [] /global/fund.app.DepositAppDubboService.getDepositCoinList: post: summary: Get a list of deposit currencies supported by customers deprecated: false description: |- bizType=fund.app.DepositAppDubboService.getDepositCoinList Get a list of deposit currencies supported by customers Accessible after login operationId: getDepositCoinList tags: - Funds/Deposit parameters: - name: version in: header description: '' required: true example: 0.0.1 schema: type: string - name: companyId in: header description: '' required: true example: '{{company}}' schema: type: string - name: trace in: header description: '' required: true example: '{{mock_trace}}' schema: type: string - name: lang in: header description: '' required: true example: zh-CN schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/QueryDepositCoinListDto' example: '' responses: '200': description: '' content: application/json: schema: &ref_20 $ref: '#/components/schemas/BaseResultSetString' headers: {} security: [] /global/fund.app.DepositAppDubboService.getDepositExchangeRate: post: summary: Get deposit currency exchange rate deprecated: false description: |- bizType=fund.app.DepositAppDubboService.getDepositExchangeRate Get deposit currency exchange rate Access after login operationId: getDepositExchangeRate tags: - Funds/Deposit parameters: - name: version in: header description: '' required: true example: 0.0.1 schema: type: string - name: companyId in: header description: '' required: true example: '{{company}}' schema: type: string - name: trace in: header description: '' required: true example: '{{mock_trace}}' schema: type: string - name: lang in: header description: '' required: true example: zh-CN schema: type: string - name: token in: header description: '' required: true example: '{{LoginResult.data.token}}' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/QueryCustomerDepositExchangeRateDto' example: '' responses: '200': description: '' content: application/json: schema: $ref: >- #/components/schemas/BaseResultQueryCustomerDepositExchangeRateDto headers: {} security: [] /global/fund.app.DepositAppDubboService.getPayChannels: post: summary: Get payment channel information deprecated: false description: >- bizType=fund.app.DepositAppDubboService.getPayChannels Get payment channel information When version=0.0.1, accountCurrency and rechargeType will be used as query filter conditions in the request parameters When version=0.0.2, accountCurrency will be used as query filter conditions in the request parameters Login required to access operationId: getPayChannels tags: - Funds/Deposit parameters: - name: version in: header description: '' required: true example: 0.0.1 schema: type: string - name: companyId in: header description: '' required: true example: '{{company}}' schema: type: string - name: trace in: header description: '' required: true example: '{{mock_trace}}' schema: type: string - name: lang in: header description: '' required: true example: zh-CN schema: type: string - name: token in: header description: '' required: true example: '{{token}}' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/QueryCustomerPaymentChannelReqDto' example: '' responses: '200': description: '' content: application/json: schema: &ref_15 $ref: >- #/components/schemas/BaseResultListQueryCustomerPaymentChannelRespDto headers: {} security: [] /global/fund.app.DepositAppDubboService.getPayChannelsV2: post: summary: >- Get payment channel information without filtering account currency and recharge method deprecated: false description: >- bizType=fund.app.DepositAppDubboService.getPayChannelsV2 Get payment channel information without filtering account currency and recharge method accountCurrency and rechargeType will not be used as query filtering conditions Accessible after login operationId: getPayChannelsV2 tags: - Funds/Deposit parameters: - name: version in: header description: '' required: true example: 0.0.1 schema: type: string - name: companyId in: header description: '' required: true example: '{{company}}' schema: type: string - name: trace in: header description: '' required: true example: '{{mock_trace}}' schema: type: string - name: lang in: header description: '' required: true example: zh-CN schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/QueryCustomerPaymentChannelReqV2Dto' example: '' responses: '200': description: '' content: application/json: schema: *ref_15 headers: {} security: [] /global/fund.app.DepositAppDubboService.getPayChannelsV3: post: summary: >- Get payment channel information filtering account currency and chain name deprecated: false description: >- bizType=fund.app.DepositAppDubboService.getPayChannelsV3 Get payment channel information filtering account currency and chain name Access after login operationId: getPayChannelsV3 tags: - Funds/Deposit parameters: - name: version in: header description: '' required: true example: 0.0.1 schema: type: string - name: companyId in: header description: '' required: true example: '{{company}}' schema: type: string - name: trace in: header description: '' required: true example: '{{mock_trace}}' schema: type: string - name: lang in: header description: '' required: true example: zh-CN schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/QueryCustomerPaymentChannelReqV3Dto' example: '' responses: '200': description: '' content: application/json: schema: $ref: >- #/components/schemas/BaseResultListQueryCustomerPaymentChannelRespV3Dto headers: {} security: [] /global/fund.app.DepositAppDubboService.getPayStatus: post: summary: Query encrypted cryptocurrency payment status deprecated: false description: |- bizType=fund.app.DepositAppDubboService.getPayStatus Query encrypted cryptocurrency payment status Access after login operationId: getPayStatus tags: - Funds/Deposit parameters: - name: version in: header description: '' required: true example: 0.0.1 schema: type: string - name: companyId in: header description: '' required: true example: '{{company}}' schema: type: string - name: trace in: header description: '' required: true example: '{{mock_trace}}' schema: type: string - name: lang in: header description: '' required: true example: zh-CN schema: type: string - name: token in: header description: '' required: true example: '{{LoginResult.data.token}}' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/QueryCoinPayStatusReqDto' example: '' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/BaseResultQueryCoinPayStatusRespDto' headers: {} security: [] /global/fund.app.DepositAppDubboService.judgeIsAlreadyDeposit: post: summary: Determine whether the user has deposited deprecated: false description: |- bizType=fund.app.DepositAppDubboService.judgeIsAlreadyDeposit Determine whether the user has deposited Accessible after login operationId: judgeIsAlreadyDeposit tags: - Funds/Deposit parameters: - name: version in: header description: '' required: true example: 0.0.1 schema: type: string - name: companyId in: header description: '' required: true example: '{{company}}' schema: type: string - name: trace in: header description: '' required: true example: '{{mock_trace}}' schema: type: string - name: lang in: header description: '' required: true example: zh-CN schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string requestBody: content: application/json: schema: type: object properties: {} example: '' responses: '200': description: '' content: application/json: schema: *ref_16 headers: {} security: [] /global/fund.app.DepositAppDubboService.manualLoan: post: summary: Manual loan deprecated: false description: |- bizType=fund.app.DepositAppDubboService.manualLoan Manual loan Accessible after login operationId: manualLoan tags: - Funds/Deposit parameters: - name: version in: header description: '' required: true example: 0.0.1 schema: type: string - name: companyId in: header description: '' required: true example: '{{company}}' schema: type: string - name: trace in: header description: '' required: true example: '{{mock_trace}}' schema: type: string - name: lang in: header description: '' required: true example: zh-CN schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ManualLoanDto' example: '' responses: '200': description: '' content: application/json: schema: *ref_8 headers: {} security: [] /global/fund.app.DepositAppDubboService.manualRepayment: post: summary: Manual Repayment deprecated: false description: |- bizType=fund.app.DepositAppDubboService.manualRepayment Manual Repayment Access after login operationId: manualRepayment tags: - Funds/Deposit parameters: - name: version in: header description: '' required: true example: 0.0.1 schema: type: string - name: companyId in: header description: '' required: true example: '{{company}}' schema: type: string - name: trace in: header description: '' required: true example: '{{mock_trace}}' schema: type: string - name: lang in: header description: '' required: true example: zh-CN schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ManualRepaymentDto' example: '' responses: '200': description: '' content: application/json: schema: *ref_8 headers: {} security: [] /global/fund.app.DepositAppDubboService/queryDepositProposal: post: summary: Query Deposit Proposal deprecated: false description: |- bizType=fund.app.DepositAppDubboService.queryDepositProposal Query Deposit Proposal Access after login operationId: queryDepositProposal tags: - Funds/Deposit parameters: - name: version in: header description: '' required: true example: 0.0.1 schema: type: string - name: companyId in: header description: '' required: true example: '{{company}}' schema: type: string - name: trace in: header description: '' required: true example: '{{mock_trace}}' schema: type: string - name: lang in: header description: '' required: true example: zh-CN schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/QueryCustomerDepositProposalReqDto' example: '' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/BaseResultCustomerDepositProposalDto' headers: {} security: [] /global/fund.app.DepositAppDubboService.queryPayChannelType: post: summary: Query payment types for third-party payment channels deprecated: false description: |- bizType=fund.app.DepositAppDubboService.queryPayChannelType Query payment types for third-party payment channels Access after login operationId: queryPayChannelType tags: - Funds/Deposit parameters: - name: version in: header description: '' required: true example: 0.0.1 schema: type: string - name: companyId in: header description: '' required: true example: '{{company}}' schema: type: string - name: trace in: header description: '' required: true example: '{{mock_trace}}' schema: type: string - name: lang in: header description: '' required: true example: zh-CN schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/QueryPayChannelTypeDto' example: '' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/BaseResultListFundPayChannelTypeDto' headers: {} security: [] /global/fund.app.CustomerProposalQueryService.isHaveUnCompleteProposal: post: summary: Check if the customer has any unfinished proposals deprecated: false description: |- bizType=fund.app.CustomerProposalQueryService.isHaveUnCompleteProposal Check if the customer has any unfinished proposals Accessible after login operationId: isHaveUnCompleteProposal tags: - Funds/Proposal parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/FundBaseDto' example: '' responses: '200': description: '' content: application/json: schema: *ref_16 headers: {} security: [] /global/fund.app.CustomerProposalQueryService.queryDepositAdjustPageList: post: summary: Query customer credit adjustment proposal pagination data deprecated: false description: |- bizType=fund.app.CustomerProposalQueryService.queryDepositAdjustPageList Query customer credit adjustment proposal page data Accessible after login operationId: queryDepositAdjustPageList tags: - Funds/Proposal parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/QueryProposalPageReqDto' example: '' responses: '200': description: '' content: application/json: schema: $ref: >- #/components/schemas/BaseResultBasePageVoCustomerAdjustProposalDto headers: {} security: [] /global/fund.app.CustomerProposalQueryService.queryDepositPageList: post: summary: Query customer deposit proposal pagination data deprecated: false description: |- bizType=fund.app.CustomerProposalQueryService.queryDepositPageList Query customer withdrawal proposal pagination data Access after login operationId: queryDepositPageList tags: - Funds/Proposal parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/QueryDepositProposalPageReqDto' example: '' responses: '200': description: '' content: application/json: schema: $ref: >- #/components/schemas/BaseResultBasePageVoCustomerDepositProposalDto headers: {} security: [] /global/fund.app.CustomerProposalQueryService.queryWithdrawPageList: post: summary: Query customer withdrawal proposal pagination data deprecated: false description: |- bizType=fund.app.CustomerProposalQueryService.queryWithdrawPageList Query customer withdrawal proposal pagination data Accessible after login operationId: queryWithdrawPageList tags: - Funds/Proposal parameters: - name: version in: header description: '' required: true example: 0.0.1 schema: type: string - name: companyId in: header description: '' required: true example: '{{company}}' schema: type: string - name: trace in: header description: '' required: true example: '{{mock_trace}}' schema: type: string - name: lang in: header description: '' required: true example: zh-CN schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/QueryWithdrawProposalPageReqDto' example: '' responses: '200': description: '' content: application/json: schema: $ref: >- #/components/schemas/BaseResultBasePageVoCustomerWithdrawProposalDto headers: {} security: [] /global/fund.app.FundExchangeRateQueryService.getExchangeRateList: post: summary: Batch query deposit and withdrawal exchange rates for currency pairs deprecated: false description: |- bizType=fund.app.FundExchangeRateQueryService.getExchangeRateList Batch query deposit and withdrawal exchange rates for currency pairs Accessible to visitors version: 0.0.1 operationId: getExchangeRateList tags: - Funds/Rate parameters: - name: version in: header description: '' required: true example: 0.0.1 schema: type: string - name: companyId in: header description: '' required: true example: '{{company}}' schema: type: string - name: trace in: header description: '' required: true example: '{{mock_trace}}' schema: type: string - name: lang in: header description: '' required: true example: zh-CN schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FundExchangeRateBatchQueryDto' example: '' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/BaseResultListExchangeRateConvertDto' headers: {} security: [] /global/fund.app.FundExchangeRateQueryService.getTradeExchangeRate: post: summary: Query the Trading Exchange Rate of Currency Pairs deprecated: false description: |- bizType=fund.app.FundExchangeRateQueryService.getTradeExchangeRate Query the Trading Exchange Rate of Currency Pairs version: 0.0.1 operationId: getExchangeRateList tags: - Funds/Rate parameters: - name: version in: header description: '' required: true example: 0.0.1 schema: type: string - name: companyId in: header description: '' required: true example: '{{company}}' schema: type: string - name: trace in: header description: '' required: true example: '{{mock_trace}}' schema: type: string - name: lang in: header description: '' required: true example: zh-CN schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string requestBody: content: application/json: schema: type: object properties: companyId: type: string description: Company ID trace: type: string description: Tracking code ip: type: string description: IP lang: type: string description: Language sourceCurrency: type: string description: Source Currency Code targetCurrency: type: string description: Target Currency Code required: - sourceCurrency - targetCurrency - trace example: '' responses: '200': description: '' content: application/json: schema: type: object properties: code: type: string description: Status return code msg: type: string description: Status description tm: type: string description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: &ref_58 $ref: '#/components/schemas/ExchangeRateConvertDto' ok: type: string fail: type: string headers: {} security: [] /global/fund.app.WithdrawAppDubboService.computeWithdrawFee: post: summary: Get withdrawal fee deprecated: false description: |- bizType=fund.app.WithdrawAppDubboService.computeWithdrawFee Get withdrawal (cash withdrawal/coin withdrawal) fee Login required to access operationId: computeWithdrawFee tags: - Funds/Withdrawal parameters: [] requestBody: content: application/json: schema: &ref_17 $ref: '#/components/schemas/ComputeWithdrawReqDto' example: '' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/BaseResultComputeWithdrawFeeRespDto' headers: {} security: [] /global/fund.app.WithdrawAppDubboService.getWithdrawExchangeRate: post: summary: Get withdrawal currency exchange rate deprecated: false description: |- bizType=fund.app.WithdrawAppDubboService.getWithdrawExchangeRate Get withdrawal currency exchange rate Access after login operationId: getWithdrawExchangeRate tags: - Funds/Withdrawal parameters: [] requestBody: content: application/json: schema: &ref_55 $ref: '#/components/schemas/QueryCustomerWithdrawExchangeRateDto' example: '' responses: '200': description: '' content: application/json: schema: $ref: >- #/components/schemas/BaseResultQueryCustomerWithdrawExchangeRateDto headers: {} security: [] /global/fund.app.WithdrawAppDubboService.createWithdrawProposal: post: summary: Create withdrawal proposal deprecated: false description: |- bizType=fund.app.WithdrawAppDubboService.createWithdrawProposal Create withdrawal (cash withdrawal/coin withdrawal) proposal Accessible after login operationId: createWithdrawProposal tags: - Funds/Withdrawal parameters: - name: version in: header description: '' required: true example: 0.0.1 schema: type: string - name: companyId in: header description: '' required: true example: '{{company}}' schema: type: string - name: trace in: header description: '' required: true example: '{{mock_trace}}' schema: type: string - name: lang in: header description: '' required: true example: zh-CN schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string requestBody: content: application/json: schema: type: object properties: accountId: type: integer format: int64 description: Account ID tradeType: type: integer format: int64 customerGroupId: type: integer format: int64 description: Customer group ID country: type: string description: Country accountCurrency: type: string description: Account currency (trading account currency) withdrawCurrency: type: string description: Withdrawal currency (currency supported by payment channels) amount: type: number description: Withdrawal amount withdrawCoinAmount: type: number description: Coin withdrawal amount withdrawRateSerialNo: type: string description: Withdrawal fee rate serial number rate: type: number description: Withdrawal exchange rate sent to platform CATS2 bankAccountName: type: string description: Bank card holder's name bankName: type: string description: Bank card bank name bankCode: type: string description: Bank card bank code bankCardNo: type: string description: Bank card number remark: type: string description: Remarks withdrawType: type: integer format: int32 description: >- Withdrawal type WithdrawTypeEnum, cash withdrawal: 1 (withdrawal to bank card), coin withdrawal: 2 (withdrawal of digital currency to digital wallet) withdrawMethod: type: string description: >- WithdrawMethodEnum withdrawal method, bank card: bank, digital wallet: digit_wallet, skrill electronic wallet: skrill_wallet, wire transfer: wire, OTC365: otc365 blockchainName: type: string description: >- Chain name, if the payment method is a digital wallet, display the corresponding chain name (also known as transfer network), such as Omin, ERC20, TRC20 extend: type: string description: Extended field - phone number, etc. fundPwd: type: string description: Fund password field, requires md5 encryption googleCode: type: string description: Google Verification Code relationDepositProposalNo: type: string maxLength: 100 description: Related deposit proposal number required: - customerGroupId - tradeType - withdrawMethod example: '' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/BaseResultCustomerWithdrawProposalDto' headers: {} security: [] /global/fund.app.WithdrawAppDubboService.getAccountMarginRate: post: summary: Get the total amount of opening margin/deposit ratio deprecated: false description: |- bizType=fund.app.WithdrawAppDubboService.getAccountMarginRate Get the total amount of opening margin/deposit ratio Accessible after login operationId: getAccountMarginRate tags: - Funds/Withdrawal parameters: [] requestBody: content: application/json: schema: *ref_17 example: '' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/BaseResultString' headers: {} security: [] /global/fund.app.WithdrawAppDubboService.getAllWithdrawCurrencyList: post: summary: Get all withdrawal currency lists deprecated: false description: |- bizType=fund.app.WithdrawAppDubboService.getAllWithdrawCurrencyList Get all withdrawal currency lists Access after login operationId: getAllWithdrawCurrencyList tags: - Funds/Withdrawal parameters: - name: version in: header description: '' required: true example: 0.0.1 schema: type: string - name: companyId in: header description: '' required: true example: '{{company}}' schema: type: string - name: trace in: header description: '' required: true example: '{{mock_trace}}' schema: type: string - name: lang in: header description: '' required: true example: zh-CN schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string requestBody: content: application/json: schema: &ref_18 $ref: '#/components/schemas/WithdrawMethodQueryDto' example: '' responses: '200': description: '' content: application/json: schema: &ref_19 $ref: >- #/components/schemas/BaseResultListCustomerGroupWithdrawCurrencyConfigDto headers: {} security: [] /global/fund.app.WithdrawAppDubboService.getCoinWithdrawCurrencyList: post: summary: Obtain list of client wallet withdrawal currency chain addresses deprecated: false description: |- bizType=fund.app.WithdrawAppDubboService.getCoinWithdrawCurrencyList Obtain list of client wallet withdrawal currency chain addresses Accessible after login operationId: getCoinWithdrawCurrencyList tags: - Funds/Withdrawal parameters: [] requestBody: content: application/json: schema: *ref_18 example: '' responses: '200': description: '' content: application/json: schema: *ref_19 headers: {} security: [] /global/fund.app.WithdrawAppDubboService.getWithdrawAccountCurrencyList: post: summary: Get withdrawal account currency list deprecated: false description: |- bizType=fund.app.WithdrawAppDubboService.getWithdrawAccountCurrencyList Get withdrawal account currency list Accessible after login operationId: getWithdrawAccountCurrencyList tags: - Funds/Withdrawal parameters: [] requestBody: content: application/json: schema: &ref_21 $ref: '#/components/schemas/WithdrawCurrencyListReqDto' example: '' responses: '200': description: '' content: application/json: schema: *ref_20 headers: {} security: [] /global/fund.app.WithdrawAppDubboService.getWithdrawAmountLimitInfo: post: summary: Get withdrawal amount limit information deprecated: false description: |- bizType=fund.app.WithdrawAppDubboService.getWithdrawAmountLimitInfo Get withdrawal amount limit information Result after exchange rate conversion Access after login operationId: getWithdrawAmountLimitInfo tags: - Funds/Withdrawal parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/WithdrawAmountLimitReqDto' example: '' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/BaseResultWithdrawAmountLimitRespDto' headers: {} security: [] /global/fund.app.WithdrawAppDubboService.getWithdrawCurrencyList: post: summary: Get withdrawal currency list deprecated: false description: |- bizType=fund.app.WithdrawAppDubboService.getWithdrawCurrencyList Get withdrawal currency list Accessible after login operationId: getWithdrawCurrencyList tags: - Funds/Withdrawal parameters: - name: version in: header description: '' required: true example: 0.0.1 schema: type: string - name: companyId in: header description: '' required: true example: '{{company}}' schema: type: string - name: trace in: header description: '' required: true example: '{{mock_trace}}' schema: type: string - name: lang in: header description: '' required: true example: zh-CN schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string requestBody: content: application/json: schema: *ref_18 example: '' responses: '200': description: '' content: application/json: schema: *ref_19 headers: {} security: [] /global/fund.app.WithdrawAppDubboService.getWithdrawMethodList: post: summary: Get Withdrawal Method deprecated: false description: |- bizType=fund.app.WithdrawAppDubboService.getWithdrawMethodList Get Withdrawal Method Accessible after login operationId: getWithdrawMethodList tags: - Funds/Withdrawal parameters: - name: version in: header description: '' required: true example: 0.0.1 schema: type: string - name: companyId in: header description: '' required: true example: '{{company}}' schema: type: string - name: trace in: header description: '' required: true example: '{{mock_trace}}' schema: type: string - name: lang in: header description: '' required: true example: zh-CN schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string requestBody: content: application/json: schema: *ref_18 example: '' responses: '200': description: '' content: application/json: schema: &ref_22 $ref: '#/components/schemas/BaseResultListWithdrawMethodQueryDto' headers: {} security: [] /global/fund.app.WithdrawAppDubboService.getWithdrawTimesIn24Hour: post: summary: Get withdrawal times in 24 hours deprecated: false description: |- bizType=fund.app.WithdrawAppDubboService.getWithdrawTimesIn24Hour Get withdrawal method Access after login operationId: getWithdrawTimesIn24Hour tags: - Funds/Withdrawal parameters: [] requestBody: content: application/json: schema: *ref_17 example: '' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/BaseResultInteger' headers: {} security: [] /global/fund.app.WithdrawAppDubboService.queryPayWithdrawBankList: post: summary: Query the list of third-party payment withdrawal banks deprecated: false description: |- bizType=fund.app.WithdrawAppDubboService.queryPayWithdrawBankList Query third-party payment withdrawal bank list Accessible after login operationId: queryPayWithdrawBankList tags: - Funds/Withdrawal parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/QueryWithdrawBankReqDto' example: '' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/BaseResultJSONArray' headers: {} security: [] /global/fund.app.WithdrawAppDubboService.queryWithdrawLimitConfig: post: summary: Query withdrawal limit configuration deprecated: false description: |- bizType=fund.app.WithdrawAppDubboService.queryWithdrawLimitConfig Query withdrawal limit configuration Accessible after login operationId: queryWithdrawLimitConfig tags: - Funds/Withdrawal parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/QueryWithdrawLimitConfigReqDto' example: '' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/BaseResultQueryWithdrawLimitConfigRespDto' headers: {} security: [] /global/fund.app.WithdrawAppDubboService.withdrawCurrencyList: post: summary: Query withdrawal currency and limit condition list deprecated: false description: |- bizType=fund.app.WithdrawAppDubboService.withdrawCurrencyList Query withdrawal currency list Accessible after login operationId: withdrawCurrencyList tags: - Funds/Withdrawal parameters: [] requestBody: content: application/json: schema: *ref_21 example: '' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/BaseResultWithdrawCurrencyResDto' headers: {} security: [] /global/fund.app.WithdrawAppDubboService.getCustomerGroupWithdrawMethodList: post: summary: Get customer group withdrawal methods deprecated: false description: >- bizType=fund.app.WithdrawAppDubboService.getCustomerGroupWithdrawMethodList Get customer group withdrawal methods Accessible after login operationId: getWithdrawMethodList tags: - Funds/Withdrawal parameters: - name: version in: header description: '' required: true example: 0.0.1 schema: type: string - name: companyId in: header description: '' required: true example: '{{company}}' schema: type: string - name: trace in: header description: '' required: true example: '{{mock_trace}}' schema: type: string - name: lang in: header description: '' required: true example: zh-CN schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string requestBody: content: application/json: schema: type: object properties: {} example: '' responses: '200': description: '' content: application/json: schema: *ref_22 headers: {} security: [] /global/fund.app.WithdrawAppDubboService.queryCustomerGroupWithdrawRiskConfig: post: summary: Get customer group withdrawal risk control configuration deprecated: false description: >- bizType=fund.app.WithdrawAppDubboService.queryCustomerGroupWithdrawRiskConfig Get customer group withdrawal risk control configuration Accessible after login operationId: getWithdrawMethodList tags: - Funds/Withdrawal parameters: - name: version in: header description: '' required: true example: 0.0.1 schema: type: string - name: companyId in: header description: '' required: true example: '{{company}}' schema: type: string - name: trace in: header description: '' required: true example: '{{mock_trace}}' schema: type: string - name: lang in: header description: '' required: true example: zh-CN schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string requestBody: content: application/json: schema: type: object properties: customerGroupId: type: integer format: int64 description: Customer group ID withdrawMethod: type: string description: Withdrawal method required: - customerGroupId example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: 'null' data: type: object properties: withdrawTimeConfigList: type: array items: type: object properties: withdrawMethod: type: string weekDay: type: integer description: Week companyTimezone: type: string description: UTC openTime: type: string description: Withdrawal time status: type: 'null' required: - withdrawMethod - weekDay - companyTimezone - openTime - status description: Channel withdrawal time withdrawAmountConfigList: type: array items: type: object properties: singleCheckLowAmount: type: integer description: >- Minimum withdrawal amount for manual review per transaction accountCurrency: type: 'null' description: Account currency blockchainName: type: string description: Chain withdrawMethod: type: string singleHighAmount: type: integer description: Maximum withdrawal amount per transaction maxIn24hourAmount: type: integer description: 24-hour cumulative highest withdrawCurrency: type: string description: Withdrawal currency singleLowAmount: type: number description: Minimum withdrawal amount per transaction status: type: 'null' required: - withdrawMethod - singleHighAmount - maxIn24hourAmount - withdrawCurrency - singleLowAmount - status description: Channel withdrawal amount setting enableWithdraw: type: boolean description: >- Whether withdrawal is allowed, true: allowed, false: not allowed withdrawConditionConfig: type: object properties: maxCount: type: integer description: Number of withdrawals in 24 hours mustActive: type: boolean description: Whether activation is required modifyLoginDisableWithdrawIntervals: type: integer description: >- Time when withdrawal is not allowed after changing phone/email modifyPwdDisableWithdrawIntervals: type: integer description: >- Time when withdrawal is not allowed after changing password status: type: 'null' required: - maxCount - mustActive - modifyLoginDisableWithdrawIntervals - modifyPwdDisableWithdrawIntervals - status description: Channel withdrawal conditions withdrawRiskConfig: type: object properties: customerGroupId: type: integer firstSetLoginPwdDisableWithdrawIntervals: type: integer description: >- Time when withdrawal is not allowed after setting login password for the first time updateTime: type: integer description: Modification time maxCount: type: integer description: Maximum number of withdrawals in 24 hours firstSetFundPwdDisableWithdrawIntervals: type: integer description: >- Time when withdrawal is not allowed after setting fund password for the first time newAddressDisableIntervals: type: integer description: Disable time for newly added withdrawal addresses mustActive: type: boolean description: >- Whether activation is required, true: yes, false: no modifyLoginDisableWithdrawIntervals: type: integer description: >- Time when withdrawal is not allowed after changing phone/email: hours modifyPwdDisableWithdrawIntervals: type: integer description: >- Time when withdrawal is not allowed after changing password status: type: integer description: Status 1, representing backend enablement description: Customer group withdrawal risk control withdrawFeeConfigList: type: 'null' description: Channel withdrawal fee required: - withdrawFeeConfigList ok: type: boolean fail: type: boolean class: type: string examples: '1': summary: Success example value: msg: Success fail: false trace: x-1s331-3wq3-xxhig-98yvi37-1682325786 code: '0' data: withdrawTimeConfigList: null hourIn24Enable: null trace: null withdrawAmountConfigList: null updateBy: null customerId: null enableWithdraw: null withdrawConditionConfig: null id: null lang: null class: >- com.cats.fund.api.dto.app.QueryWithdrawRiskLimitConfigRespDto tradeType: null customerGroupEnable: null amountEnable: null ip: null updateTime: null withdrawRiskConfig: customerGroupId: 1 firstSetLoginPwdDisableWithdrawIntervals: 60 ip: null updateTime: 1682325006727 maxCount: 10 revision: 15 accountId: null firstSetFundPwdDisableWithdrawIntervals: 240 createBy: admin companyId: 1 trace: null newAddressDisableIntervals: 60 mustActive: true modifyLoginDisableWithdrawIntervals: 0 createTime: 1681867998763 updateBy: admin modifyPwdDisableWithdrawIntervals: 360 customerId: null id: 334 lang: null class: com.cats.fund.api.dto.app.WithdrawRiskConfigDto tradeType: null customerNo: null status: 1 accountActiveEnable: null revision: null accountId: null createBy: null companyId: null createTime: null timeEnable: null withdrawFeeConfigList: null customerNo: null status: null bizCode: '' tm: 15 msgParams: null ok: true class: com.cats.common.core.base.vo.BaseResult headers: {} security: [] /global/fund.app.WithdrawAppDubboService.checkWithdrawRiskLimitConfig: post: summary: Check customer's withdrawal limit conditions deprecated: false description: >- bizType=fund.app.WithdrawAppDubboService.checkWithdrawRiskLimitConfig Check customer's withdrawal limit conditions can only be accessed after logging in code ("51021", "Customer group withdrawal configuration, withdrawal not allowed"), code ("51011", "Customer group withdrawal configuration, account must be activated to withdraw"), code ("51012", "Withdrawal not allowed at current time"), code ("51025", "Withdrawal not allowed within {0} minutes after changing password"), code ("51026", "Withdrawal not allowed within {0} minutes after changing phone number or email"), code ("51037", "Withdrawal not allowed within {0} minutes after changing fund password"), code ("51016", "Exceeded maximum withdrawal times within 24 hours"), The placeholder "%s" in the following prompt information is the value of msgParams in the response result, multiple values are concatenated with "," USCUSTOMER_API_0001006=1. We are very sorry, withdrawals are prohibited within %s hours after setting the login password, you can try again later;\ 2. If you have any questions or need help, please contact online customer service. USCUSTOMER_API_0001007=1. I'm sorry, withdrawals are prohibited within %s hours after setting the fund password, you can withdraw later;\n2. If you have any questions or need help, please contact online customer service. USCUSTOMER_API_0001008=1. I'm sorry, withdrawals are prohibited within %s hours after changing the login password, you can withdraw later;\n2. If you have any questions or need help, please contact online customer service. USCUSTOMER_API_0001009=1. I'm sorry, withdrawals are prohibited within %s hours after resetting the login password, you can withdraw later;\n2. If you have any questions or need help, please contact online customer service. USCUSTOMER_API_0001010=1. We are very sorry, withdrawals are prohibited within %s hours after changing the fund password, you can withdraw later;\n2. If you have any questions or need help, please contact online customer service. USCUSTOMER_API_0001011=1. We are very sorry, withdrawals are prohibited within %s hours after resetting the fund password, you can withdraw later;\n2. If you have any questions or need help, please contact online customer service. USCUSTOMER_API_0001012=1. We are very sorry, withdrawals are prohibited within %s hours after changing the email, you can withdraw later;\n2. If you have any questions or need help, please contact online customer service. USCUSTOMER_API_0001013=1. I'm sorry, withdrawals are prohibited within %s hours after changing your phone. You can try again later;\n2. If you have any questions or need help, please contact online customer service. USCUSTOMER_API_0001014=1. I'm sorry, withdrawals are prohibited within %s hours after adding a new withdrawal address. You can try again later;\n2. If you have any questions or need help, please contact online customer service. USCUSTOMER_API_0001016=The current withdrawal address does not exist, please check the data operationId: queryWithdrawLimitConfig tags: - Funds/Withdrawal parameters: - name: version in: header description: '' required: true example: 0.0.1 schema: type: string - name: companyId in: header description: '' required: true example: '{{company}}' schema: type: string - name: trace in: header description: '' required: true example: '{{mock_trace}}' schema: type: string - name: lang in: header description: '' required: true example: zh-CN schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string requestBody: content: application/json: schema: type: object properties: tradeType: type: integer format: int64 accountCurrency: type: string description: Account Currency Code withdrawCurrency: type: string description: Customer receiving currency code withdrawMethod: type: string description: >- Withdrawal method, bank card: bank, digital wallet: digit_wallet withdrawType: type: integer format: int32 description: 'Withdrawal type, bank card: 1, digital wallet: 2' blockchainName: type: string description: >- When witdrawType is 2, it is required. Chain name, data dictionary configuration, payment method is digital wallet, display the corresponding chain name (also known as transfer network), such as Omin, ERC20, TRC20 required: - tradeType - accountCurrency - withdrawCurrency - withdrawType - withdrawMethod example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: boolean ok: type: boolean fail: type: boolean headers: {} security: [] /global/fund.app.WithdrawAppDubboService.queryRemainWithdrawAmount: post: summary: >- Get the remaining withdrawal amount of the withdrawal method + currency + chain deprecated: false description: >- bizType=fund.app.WithdrawAppDubboService.queryRemainWithdrawAmount Get the remaining withdrawal amount of the withdrawal method + currency + chain Access after login operationId: queryWithdrawLimitConfig tags: - Funds/Withdrawal parameters: - name: version in: header description: '' required: true example: 0.0.1 schema: type: string - name: companyId in: header description: '' required: true example: '{{company}}' schema: type: string - name: trace in: header description: '' required: true example: '{{mock_trace}}' schema: type: string - name: lang in: header description: '' required: true example: zh-CN schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/QueryRemainWithdrawAmountReqDto' example: '' responses: '200': description: '' content: application/json: schema: $ref: >- #/components/schemas/BaseResultQueryRemainWithdrawAmountRespDto headers: {} security: [] /global/tradeapi.app.CfdMMOrderApiService.addMarketOrder: post: summary: Place an order deprecated: false description: >- Description: Contract full position trading order group=tradeApi version=0.0.1 bizType=tradeapi.app.OrderApiService.addMarketOrder tags: - Trade/Full Margin Contract parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: group in: header description: '' required: false example: tradeApi schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: tradeType: type: integer title: Game ID description: Game ID, should be filled with 1 for this game format: long accountId: type: integer title: Account ID description: >- Account ID, optional. If filled, trading will be conducted with this account format: long bizType: type: integer title: Business type description: >- Business type, 1-Market price open; 2-Market price close; 10-Limit price pending order; 11-Stop loss pending order; 12-Limit price open format: int32 direction: type: integer title: Order buy/sell direction description: Order buy/sell direction, 1-Buy; 2-Sell; format: int32 symbolId: type: integer title: Product ID format: long description: Product ID, product ID positionId: type: integer title: Position ID description: Position ID, required when placing a closing order format: long requestTime: type: integer title: Order request time description: Order request time, 13-digit timestamp format: long requestPrice: type: string title: Order price at the time of placing description: >- Price at the time of order placement, needs to be multiplied by 10 to the power of 'product price decimal places', converted to an integer for input. Only for order recording, not the actual transaction price. requestNum: type: string title: Order quantity description: Order quantity stopLoss: type: string title: Stop loss unit price description: >- Stop loss unit price, need to multiply by 10 to the power of 'product quote decimal places', and process it as an integer input. takeProfit: type: string title: Take profit unit price description: >- Take profit unit price, need to multiply by 10 to the power of 'product quote decimal places', and process it as an integer input. expireType: type: integer title: Expiration type description: >- Expiration type, only valid for pending orders. 1-Valid for the day; 2-Valid for the week； 3-30 days; 4-90 days; Default 2 format: int32 remark: type: string title: Remarks description: Remarks accountCurrency: type: string title: Account currency description: Account currency accountDigits: type: integer title: Account Decimal Places format: int32 description: Account Decimal Places crossLevelNum: type: integer title: Leverage ratio format: int32 description: >- Leverage ratio, only valid for opening positions, there should only be one leverage ratio for the same product source: type: string description: >- H5: mobile web; PC_Web: pcweb; System: system; Android: Android native app; iOS: Apple native app; HOS: Hongmeng OS; PC_Win: pcwindows client; PC_Mac: pcmac client; default is the same as login source. (limited to 255 characters, enumeration is for reference only,Only letters, numbers, and underscores can be used) thirdPartyOrder: type: string description: >- (limited to 255 characters,Only letters, numbers, and underscores can be used) slippage: type: string description: >- Only market orders are valid. It can be a percentage (only supports 2 decimal places, rounding off any excess) or a floating-point type that only supports 4 decimal places, rounding off any excess). Other formats are not supported. required: - tradeType - bizType - direction - symbolId - requestTime - requestPrice - requestNum - accountCurrency - accountDigits example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string title: Module identifier code description: Module identifier code code: type: string title: Status return code description: Status return code msg: type: string title: Status description description: Status description tm: type: integer format: int64 title: Processing time (milliseconds) description: Processing time (milliseconds) trace: type: string title: Tracking code description: Tracking code msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas description: >- Placeholder parameter string in return description, multiple parameters separated by commas ok: type: boolean description: Whether the response is successful fail: type: boolean description: Whether the response is failed data: type: object properties: orderId: type: integer title: Order number format: long description: Order number positionId: type: integer title: Position number format: long description: Position number tradeVolume: type: string title: Trading volume description: Trading volume openPrice: type: string title: Opening price description: Opening price executePrice: type: string title: Execution price description: Execution price openDirection: type: integer title: Buy/sell direction at the time of opening description: >- Buy/sell direction when opening a position, 1-Buy; 2-Sell; format: int32 direction: type: integer title: Buy/sell direction for this order description: Buy/sell direction for this order, 1-Buy; 2-Sell; format: int32 openOrClose: type: integer title: Open/close type for this order description: >- Open/close type for this order, 1-Open position; 2-Close position; format: int32 symbolName: type: string title: Product name description: Product name symbolId: type: integer title: Product Id format: long description: Product Id stopLoss: type: string title: Stop loss price description: Stop-loss price, consistent with the input parameters takeProfit: type: string title: Take profit price description: >- Take-profit price, consistent with the input parameters digits: type: integer title: Product decimal places format: int32 description: Product decimal places fee: type: string title: Placing Order Handling Fee description: Placing Order Handling Fee interest: type: string title: Interest description: Interest, only exists when closing a position profit: type: string title: Profit and Loss description: Profit and loss, only exists when closing a position title: Data Body description: Data Body examples: '1': summary: Success example value: msg: Success fail: false trace: x-dqxq8-qu20y7y-dq58lhn-39i483-1677570581 code: '0' data: tradeVolume: '0.1' symbolId: 720 orderId: 14460002 fee: '-0.0668' openOrClose: 1 openPrice: '22.25' takeProfit: '0' positionId: 2023022819810 interest: '0' openDirection: 1 stopLoss: '0' executePrice: '22.25' digits: 2 symbolName: BINAN_SOL_USDT profit: '0' direction: 1 bizCode: '' tm: 162 msgParams: null ok: true headers: {} security: [] /global/tradeapi.app.OrderApiService.updatePboOrder: post: summary: Modify Pending Order deprecated: false description: |- group=tradeApi version=0.0.1 bizType=tradeapi.app.OrderApiService.updatePboOrder tags: - Trade/Full Margin Contract parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: group in: header description: '' required: false example: tradeApi schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: tradeType: type: integer title: Game ID description: Should be filled with 1 under this gameplay format: long accountId: type: integer title: Account ID description: >- Optional. If filled, trading will be conducted with this account format: long pboId: type: string title: Pending Order ID stopLoss: type: number title: Stop loss unit price description: >- Needs to be multiplied by 10 to the power of 'product quote decimal places', processed as an integer and passed in. takeProfit: type: number title: Take profit unit price description: >- Needs to be multiplied by 10 to the power of 'product quote decimal places', processed as an integer and passed in. requestNum: type: number title: Request Quantity/Amount requestPrice: type: number title: Request Price required: - tradeType - pboId example: tradeType: 22 pboId: '63' requestPrice: 16 takeProfit: 57 accountId: 98 stopLoss: 18 requestNum: 35 responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string title: Module identifier code code: type: string title: Status return code msg: type: string title: Status description tm: type: integer format: int64 title: Processing time (milliseconds) trace: type: string title: Tracking code msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas ok: type: boolean fail: type: boolean data: type: object properties: orderId: type: integer title: Order number format: long positionId: type: integer title: Position number format: long tradeVolume: type: string title: Trading volume openPrice: type: string title: Opening price executePrice: type: string title: Execution price openDirection: type: integer title: Buy/sell direction at the time of opening description: 1-Buy; 2-Sell; format: int32 direction: type: integer title: Buy/sell direction for this order description: 1-Buy; 2-Sell; format: int32 openOrClose: type: integer title: Open/close type for this order description: 1- Opening; 2- Closing; format: int32 symbolName: type: string title: Product name symbolId: type: integer title: Product Id format: long stopLoss: type: string title: Stop loss price description: Consistent with the input parameters takeProfit: type: string title: Take profit price description: Consistent with the input parameters digits: type: integer title: Product decimal places format: int32 fee: type: string title: Placing Order Handling Fee interest: type: string title: Interest description: Only Closing Exists profit: type: string title: Profit and Loss description: Only Closing Exists title: Data Body examples: '1': summary: Success example value: msg: Success fail: false trace: x-dqxq8-qu20y7y-dq58lhn-39i483-1677570581 code: '0' data: tradeVolume: '0.1' symbolId: 720 orderId: 14460002 fee: '-0.0668' openOrClose: 1 openPrice: '22.25' takeProfit: '0' positionId: 2023022819810 interest: '0' openDirection: 1 stopLoss: '0' executePrice: '22.25' digits: 2 symbolName: BINAN_SOL_USDT profit: '0' direction: 1 bizCode: '' tm: 162 msgParams: null ok: true headers: {} security: [] /global/tradeapi.app.CfdMMOrderApiService.updateOrder: post: summary: Set position stop loss and take profit deprecated: false description: >- Explanation: Set position stop loss and take profit group=tradeApi version=0.0.1 bizType=tradeapi.app.OrderApiService.updateOrder tags: - Trade/Full Margin Contract parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: group in: header description: '' required: false example: tradeApi schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: tradeType: type: integer title: Game ID description: Should be filled with 1 under this gameplay format: long accountId: type: integer title: Account ID format: long description: Account ID, must fill in either account currency accountCurrency: type: string title: Account currency description: Account currency, must fill in either account ID orderId: type: integer title: Order ID format: long description: Order ID positionId: type: integer title: Position ID format: long description: Position ID accountDigits: type: integer title: Account Decimal Places format: long description: Account Decimal Places stopLoss: type: string title: Stop loss unit price description: >- Stop loss unit price, need to multiply by 10 to the power of 'product quote decimal places', and process it as an integer input. takeProfit: type: string title: Take profit unit price description: >- Take profit unit price, need to multiply by 10 to the power of 'product quote decimal places', and process it as an integer input. remark: type: string title: Remarks description: Remarks required: - tradeType - orderId - positionId - accountDigits example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string title: Module identifier code code: type: string title: Status return code msg: type: string title: Status description tm: type: integer format: int64 title: Processing time (milliseconds) trace: type: string title: Tracking code msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas ok: type: boolean fail: type: boolean data: type: object properties: positionId: type: integer title: Position ID format: long orderId: type: integer title: Order ID format: long dealId: type: integer title: Deal ID format: long status: type: string title: Position status description: >- 0-Initialization; 1-Position holding; 2-Completed; 3-Partial closing; direction: type: integer format: int32 title: Buy/Sell Direction description: 1-Buy; 2-Sell; symbolId: type: integer title: Product ID format: long symbolName: type: string title: Product name openAccountDigits: type: integer title: Account decimal places for opening format: int32 openSymbolDigits: type: integer format: int32 title: Product decimal places for opening openContractSize: type: integer format: int32 title: Contract size openPrice: type: string title: Opening unit price openNum: type: string title: Opening quantity closeAccountDigits: type: integer title: Account decimal places for closing format: int32 closeSymbolDigits: type: integer title: Product decimal places for closing format: int32 closePrice: type: string title: Closing unit price closeFreeDigits: type: string title: Closing commission decimal places profit: type: string title: Profit and Loss openMargin: type: string title: Opening margin used stopLoss: type: string title: Stop loss unit price description: Original registered value, untreated takeProfit: type: string title: Take profit unit price description: Original registered value, untreated remark: type: string title: Remarks margin: type: string title: Real-time margin used openTime: type: integer format: long title: Opening time description: 13-digit timestamp closeTime: type: integer format: long title: Closing time description: 13-digit timestamp openFee: type: string title: Opening commission closeFee: type: string title: Closing commission closeNum: type: string title: Closing quantity openVolume: type: string title: Opening lots closeVolume: type: string title: Closing lots minVolume: type: string title: Minimum lots per side volume: type: string title: Lots marginSetType: type: string title: Margin type description: 1-Ratio; 2-Range; examples: '1': summary: Exception example value: msg: Account balance is 0 fail: true trace: x-0ei175a-x4dh9u2-1g8s95r-m2708212-1677570735 code: E000031 data: tradeapi.app.OrderApiService.updateOrder bizCode: CFD tm: 7 msgParams: null ok: false headers: {} security: [] /global/tradeapi.app.CfdMMOrderApiService.queryHistoryCloseOrderList: post: summary: Closing record deprecated: false description: |- Explanation: Query historical closing records group=tradeApi version=0.0.1 bizType=tradeapi.app.OrderApiService.queryHistoryCloseOrderList tags: - Trade/Full Margin Contract parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: group in: header description: '' required: false example: tradeApi schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: tradeType: type: integer title: Game ID description: Should be filled with 1 under this gameplay format: long accountId: type: integer title: Account ID format: long sortFieldName: type: string title: Sort field name description: >- pnl-Profit; openTime-Opening time; closeTime-Closing time; orderId-Order ID; symbolId-Product ID; sortType: type: string title: Sort type description: desc-Descending order; asc-Ascending order; symbolId: type: integer title: Product ID format: long openStartTime: type: integer title: Opening start time description: 13-digit timestamp format: long openEndTime: type: integer title: Opening end time description: 13-digit timestamp format: long closeStartTime: type: integer title: Closing start time description: 13-digit timestamp format: long closeEndTime: type: integer title: Closing end time description: 13-digit timestamp format: long current: type: integer title: Page number description: Default 1 format: int32 size: type: integer title: Data quantity per page description: Default 20 format: int32 querySource: type: string description: >- H5: mobile web; PC_Web: pcweb; System: system; Android: Android native app; iOS: Apple native app; HOS: Hongmeng OS; PC_Win: pcwindows client; PC_Mac: pcmac client; default is the same as login source. (The enumeration is for reference only) thirdPartyOrder: type: string required: - tradeType - sortFieldName - sortType example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string title: Module identifier code code: type: string title: Status return code msg: type: string title: Status description tm: type: integer format: int64 title: Processing time (milliseconds) trace: type: string title: Tracking code msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas ok: type: boolean fail: type: boolean data: type: object properties: current: type: integer title: Current page number format: int32 totalPnl: type: number title: Total profit format: double size: type: integer title: Data quantity per page format: int32 totalPage: type: integer title: Total number of pages format: int32 list: type: array items: type: object properties: symbolId: type: integer format: long title: Product ID bizType: type: integer format: int32 title: Closing type description: >- 2-Market price closing; 3-Stop loss closing; 4-Take profit closing; 5-Liquidation forced closing; 6-Product expiration forced closing; 7-Account closure closing; 8-Manual forced closing; orderId: type: integer format: long title: Order ID openVolume: type: string title: Opening lots openPrice: type: string title: Opening price closeVolume: type: string title: Closing lots closePrice: type: string title: Closing price takeProfit: type: string title: Take profit price description: Display as '-' if not set stopLoss: type: string title: Stop loss price description: Display as '-' if not set closeTime: type: integer title: Closing time format: long description: 13-digit timestamp commission: type: string title: Commission fee symbolName: type: string title: Product name openTime: type: integer format: long title: Opening time description: 13-digit timestamp profit: type: string title: Profit interest: type: string title: Position interest openDirection: type: integer title: Opening direction description: 1-Buy; 2-Sell; format: int32 closeDirection: type: integer format: int32 description: 1-Buy; 2-Sell; title: Closing direction source: type: string description: >- H5: mobile web; PC_Web: pcweb; System: system; Android: Android native app; iOS: Apple native app; HOS: Hongmeng OS; PC_Win: pcwindows client; PC_Mac: pcmac client; default is the same as login source. (The enumeration is for reference only) thirdPartyOrder: type: string title: Closing List Collection title: Data Body examples: '1': summary: Success example value: msg: Success fail: false trace: x-77q3ivej-u4wi1d3a-5pbl5v-ypwj0-1677573497 code: '0' data: accountId: null trace: x-77q3ivej-u4wi1d3a-5pbl5v-ypwj0-1677573497 companyId: 360 current: 1 size: 20 totalPage: 0 ip: 47.242.92.158 customerId: 1176 list: [] lang: en-US totalPnl: 0 customerNo: '86001175' bizCode: '' tm: 6 msgParams: null ok: true headers: {} security: [] /global/tradeapi.app.CfdMMOrderApiService.setCrossLevelNum: post: summary: Set leverage multiplier deprecated: false description: >- Description: Contract-full position gameplay, set the customer's leverage multiplier for the product, affecting all positions of the product group=tradeApi version=0.0.1 bizType=tradeapi.app.OrderApiService.setCrossLevelNum tags: - Trade/Full Margin Contract parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: group in: header description: '' required: false example: tradeApi schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: tradeType: type: integer title: Game ID description: Should be filled with 1 under this gameplay format: long companyId: type: integer title: Company ID format: long customerId: type: integer title: Client ID format: long customerNo: type: string title: Client number customerGroupId: type: integer title: Client group ID format: long symbolId: type: integer title: Product ID format: long requestTime: type: integer title: Leverage ratio format: int32 trace: type: string title: Tracking code required: - tradeType - customerId - customerNo - customerGroupId - requestTime - companyId - symbolId example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string title: Module identifier code code: type: string title: Status return code msg: type: string title: Status description tm: type: integer format: int64 title: Processing time (milliseconds) trace: type: string title: Tracking code msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas ok: type: boolean fail: type: boolean data: type: object properties: crossLevelNum: type: integer title: Leverage ratio format: int32 title: Data Body examples: '1': summary: Success example value: msg: Success fail: false trace: x-6s8tc-2v65-i8270878-1727-1677574098 code: '0' data: crossLevelNum: 11 bizCode: '' tm: 17 msgParams: null ok: true headers: {} security: [] /global/tradeapi.app.CfdMMOrderApiService.calculateMarketOrder: post: summary: Order Trial Calculation deprecated: false description: >- Explanation: Calculate margin and commission for placing orders group=tradeApi version=0.0.1 bizType=tradeapi.app.OrderApiService.calculateMarketOrder tags: - Trade/Full Margin Contract parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: group in: header description: '' required: false example: tradeApi schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: tradeType: type: integer title: Game ID description: Should be filled with 1 under this gameplay format: long accountId: type: integer title: Account ID description: >- Optional. If filled, trading will be conducted with this account format: long bizType: type: integer title: Business type description: >- 1-Market price open; 2-Market price close; 10-Limit price pending order; 11-Stop loss pending order; 12-Limit price open format: int32 direction: type: integer title: Order buy/sell direction description: 1-Buy; 2-Sell; format: int32 symbolId: type: integer title: Product ID format: long positionId: type: integer title: Position ID description: Required when placing a closing order format: long requestTime: type: integer title: Order request time description: 13-digit timestamp format: long requestPrice: type: string title: Order price at the time of placing description: For order record only, not the actual transaction price* requestNum: type: string title: Order quantity expireType: type: integer title: Expiration type description: >- Only valid for pending orders. 1-Valid for the day; 2-Valid for the week; format: int32 remark: type: string title: Remarks accountCurrency: type: string title: Account currency accountDigits: type: integer title: Account Decimal Places format: int32 crossLevelNum: type: integer title: Leverage ratio format: int32 description: >- Only valid for opening positions, only one leverage ratio should be set for the same product required: - tradeType - bizType - direction - symbolId - requestTime - requestPrice - requestNum - accountCurrency - accountDigits example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string title: Module identifier code code: type: string title: Status return code msg: type: string title: Status description tm: type: integer format: int64 title: Processing time (milliseconds) trace: type: string title: Tracking code msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas ok: type: boolean fail: type: boolean data: type: object properties: fee: type: string title: Commission fee margin: type: string title: Margin calculatePrice: type: string title: Calculation price title: Data Body examples: '1': summary: Success example value: msg: Success fail: false trace: x-7rf727-m64d8ar-72dn4ij-23o3vt-1677574738 code: '0' data: margin: '10000.6584' calculatePrice: '136.719' fee: '0.0000' bizCode: '' tm: 31 msgParams: null ok: true headers: {} security: [] /global/tradeapi.app.CfdMMPositionApiService.queryPositionDetail: post: summary: Position Details deprecated: false description: |- Description: Query position details group=tradeApi version=0.0.1 bizType=tradeapi.app.PositionApiService.queryPositionDetail tags: - Trade/Full Margin Contract parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: group in: header description: '' required: false example: tradeApi schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: tradeType: type: integer title: Game ID description: Should be filled with 1 under this gameplay format: long accountId: type: integer title: Account ID format: long positionId: type: integer title: Position ID format: long required: - tradeType - positionId example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string title: Module identifier code code: type: string title: Status return code msg: type: string title: Status description tm: type: integer format: int64 title: Processing time (milliseconds) trace: type: string title: Tracking code msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas ok: type: boolean fail: type: boolean data: type: object properties: positionId: type: integer title: Position ID format: long orderId: type: integer title: Order ID format: long dealId: type: integer title: Deal ID format: long status: type: string title: Position status description: >- 0-Initialization; 1-Position holding; 2-Completed; 3-Partial closing; direction: type: integer format: int32 title: Buy/Sell Direction description: 1-Buy; 2-Sell; symbolId: type: integer title: Product ID format: long symbolName: type: string title: Product name openAccountDigits: type: integer title: Account decimal places for opening format: int32 openSymbolDigits: type: integer format: int32 title: Product decimal places for opening openContractSize: type: integer format: int32 title: Contract size openPrice: type: string title: Opening unit price openNum: type: string title: Opening quantity closeAccountDigits: type: integer title: Account decimal places for closing format: int32 closeSymbolDigits: type: integer title: Product decimal places for closing format: int32 closePrice: type: string title: Closing unit price closeFreeDigits: type: string title: Closing commission decimal places profit: type: string title: Profit and Loss openMargin: type: string title: Opening margin used stopLoss: type: string title: Stop loss unit price description: Original registered value, untreated takeProfit: type: string title: Take profit unit price description: Original registered value, untreated remark: type: string title: Remarks margin: type: string title: Real-time margin used openTime: type: integer format: long title: Opening time description: 13-digit timestamp closeTime: type: integer format: long title: Closing time description: 13-digit timestamp openFee: type: string title: Opening commission closeFee: type: string title: Closing commission closeNum: type: string title: Closing quantity openVolume: type: string title: Opening lots closeVolume: type: string title: Closing lots minVolume: type: string title: Minimum lots per side stopLossDecimal: type: string title: Stop loss unit price description: >- `stopLoss` processed based on `closeSymbolDigits`. Used for direct display on the frontend takeProfitDecimal: type: string title: Take profit unit price description: >- `takeProfit` processed based on `closeSymbolDigits`. Used for direct display on the frontend volume: type: string title: Lots marginSetType: type: string title: Margin type description: 1-Ratio; 2-Range; source: type: string description: >- H5: mobile web; PC_Web: pcweb; System: system; Android: Android native app; iOS: Apple native app; HOS: Hongmeng OS; PC_Win: pcwindows client; PC_Mac: pcmac client; default is the same as login source. (The enumeration is for reference only) thirdPartyOrder: type: string title: Data Body examples: '1': summary: Success example value: msg: Success fail: false trace: x-11wdkt-kg9i-ld2y-53mz854-1677571927 code: '0' data: symbolId: 720 orderId: 14460003 dealId: 94870543 canReduceMargin: '0.0000' openPrice: '22.18' remark: null takeProfitDecimal: '0.00' closeNum: 0 closeFee: '0.0000' takeProfit: '0' occupyTheMargin: '0.0000' interest: '0.0000' maintenanceMargin: '0.0000' closeVolume: 0 openVolume: 0.1 closeTime: 0 closeAccountDigits: 4 symbolName: BINAN_SOL_USDT openTime: 1677571033093 profit: null tradeType: 1 direction: 1 singleMargin: null margin: null openContractSize: 1 resp: null openMargin: '0.2209' openNum: 0.1 openFee: '0.0665' closeSymbolDigits: 2 warningMargin: '0.0000' stopLossDecimal: '0.00' adjustCrossLevel: 1-100 openSymbolDigits: 2 volume: 0.1 accountId: 1031767 companyId: 360 positionId: 2023022819827 closeFreeDigits: null stopLoss: '0' minVolume: null marginSetType: '2' crossLevelNum: 10 openAccountDigits: 4 closePrice: '0.0000' status: '1' bizCode: C tm: 27 msgParams: null ok: true headers: {} security: [] /global/tradeapi.app.CfdMMOrderApiService.queryCapitalFlowList: post: summary: Fund Flow deprecated: false description: >- Explanation: Pagination query account capital flow group=tradeApi version=0.0.1 bizType=tradeapi.app.OrderApiService.queryCapitalFlowList tags: - Trade/Full Margin Contract parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: group in: header description: '' required: false example: tradeApi schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: tradeType: type: integer title: Game ID description: Should be filled with 1 under this gameplay format: long accountId: type: integer format: long title: Account ID size: type: integer title: Number of data entries per page format: long current: type: integer title: Current Page format: long businessType: type: integer format: int32 title: Business type description: >- 0-Unrestricted; 1-Deposit; 2-Withdrawal; 3-System reset; 4-Limit adjustment; 5-Freeze; 6-Transaction; 36-Transfer; 42-Reward; status: type: integer format: int32 title: Status description: >- 0-Unrestricted; 1-Initialization; 2-Processing successful; 3-Processing failed; startTime: type: integer format: long description: 13-digit timestamp title: Start time endTime: type: integer format: long description: 13-digit timestamp title: End Time operate: type: integer format: int32 title: Capital flow description: 0-Unrestricted; 1-Increase; 2-Decrease; assetsId: type: integer format: long title: Asset ID lang: type: string title: Language required: - tradeType example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string title: Module identifier code description: Module identifier code code: type: string title: Status return code description: Status return code, 0 success, others fail msg: type: string title: Status description description: Status description tm: type: integer format: int64 title: Processing time (milliseconds) description: Processing time (milliseconds) trace: type: string title: Tracking code description: Tracking code msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas description: >- Placeholder parameter string in return description, multiple parameters separated by commas ok: type: boolean description: Success flag fail: type: boolean description: Failure flag data: type: object properties: total: type: integer title: Total format: long description: Total size: type: integer format: long title: Number of Items per Page description: Number of Items per Page current: type: integer format: long title: Current Page description: Current Page records: type: array items: type: object properties: remark: type: string title: Remarks description: Remarks createTime: type: integer title: Creation date description: Creation date, 13-digit timestamp format: long updateTime: type: integer format: long title: Update Time description: Update time, 13-digit timestamp subjectId: type: integer format: long title: Subject ID description: Subject ID bookkeepId: type: integer format: long title: Voucher ID description: Voucher ID amountIn: type: string title: Increase amount description: Increase amount amountOut: type: string title: Decrease amount description: Decrease amount status: type: integer format: int32 title: Status description: >- Status, 1-Initialization; 2-Processing successful; 3-Processing failed; amountAfter: type: string title: Balance after change description: Balance after change businessType: type: integer title: Business type format: int32 description: >- Business type, 1-Deposit; 2-Withdrawal; 3-System reset; 4-Limit adjustment; 5-Freeze; 6-Transaction; 36-Transfer; 42-Reward; businessType1: type: integer format: int32 description: >- Business sub-type, 1001-Front-end deposit; 1002-Deposit fee; 2001-Front-end withdrawal; 2002-Cancel withdrawal; 2003-Withdrawal fee; 2004-Cancel fee; 2005-Confirm transfer; 3001-System reset; 4001-Limit adjustment_deposit; 4002-Limit adjustment_withdrawal; 4003-Limit adjustment_other; 4004-Limit adjustment_bonus; 4005-Limit adjustment_release non-withdrawable; 4006-Limit adjustment_non-withdrawable; 4007-Limit adjustment_transfer rebate; 5001-Freeze; 5002-Unfreeze; 6001-Open position fee; 6002-Close position fee; 6003-Overnight interest; 6004-Market close profit and loss; 6005-Stop loss close profit and loss; 6006-Take profit close profit and loss; 6007-System forced close profit and loss; 6008-Expiration forced close profit and loss; 6009-Manual forced close profit and loss; 36001-Transfer in amount; 36002-Transfer out amount; 42001-Issue reward; 42002-Deduct reward; 42003-Issue rebate; 42004-Deduct rebate; title: Business Subtype customerNo: type: string title: Client number description: Client number digits: type: string title: Decimal Places description: Decimal Places currency: type: string title: Currency description: Currency businessTypeName: type: string title: Business Type Name description: >- Business type name, confirm language by passing in `lang` businessType1Name: type: string title: Business Subtype Name description: >- Business sub-type name, confirm language by passing in `lang` accountId: type: integer title: Account Id format: long description: Account Id orderId: type: integer format: long description: Order ID dealId: type: integer format: long description: Deal ID title: Data Body description: Data Body title: Transaction Collection description: Transaction Collection description: Data Body examples: '1': summary: Exception example value: msg: System error fail: true trace: x-q7pj-8jiln-310518-4l0c69-1677572511 code: '500' data: tradeapi.app.OrderApiService.queryCapitalFlowList bizCode: TA tm: 0 msgParams: null ok: false headers: {} security: [] /global/tradeapi.app.OrderApiService.addMarketOrder: post: summary: Place an order deprecated: false description: |- Explanation: Contract isolated trading order group=tradeApi version=0.0.1 bizType=tradeapi.app.OrderApiService.addMarketOrder tags: - Trade/Isolated Margin Contract parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: group in: header description: '' required: false example: tradeApi schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: tradeType: type: integer title: Game ID description: Game ID, should be filled with 2 for this game format: long accountId: type: integer title: Account ID description: >- Account ID, optional. If filled, trading will be conducted with this account format: long bizType: type: integer title: Business type description: >- Business type, 1-market price open; 2-market price close; 10-limit price pending order; 11-stop loss pending order; 13-aggregate limit price open order; 14-aggregate limit price close order format: int32 direction: type: integer title: Order buy/sell direction description: Order buy/sell direction, 1-Buy; 2-Sell; format: int32 symbolId: type: integer title: Product ID format: long description: Product ID positionId: type: integer title: Position ID description: Position ID, required when placing a closing order format: long requestTime: type: integer title: Order request time description: Order request time, 13-digit timestamp format: long requestPrice: type: string title: Order price at the time of placing description: >- Price at the time of order placement, needs to be multiplied by 10 to the power of 'product price decimal places', converted to an integer for input. Only for order recording, not the actual transaction price. requestNum: type: string title: Order quantity description: >- Order quantity or order amount, used in conjunction with entryType stopLoss: type: string title: Stop loss unit price description: >- Stop loss unit price, need to multiply by 10 to the power of 'product quote decimal places', and process it as an integer input. takeProfit: type: string title: Take profit unit price description: >- Take profit unit price, need to multiply by 10 to the power of 'product quote decimal places', and process it as an integer input. expireType: type: integer title: Expiration type description: >- Expiration type, only valid for pending orders. 1-Valid for the day; 2-Valid for the week； 3-30 days; 4-90 days; Default 2 format: int32 remark: type: string title: Remarks description: Remarks accountCurrency: type: string title: Account currency description: Account currency accountDigits: type: integer title: Account Decimal Places format: int32 description: Account Decimal Places crossLevelNum: type: integer title: Leverage ratio format: int32 description: >- Leverage ratio, this parameter needs to be consistent for the product. If not consistent, the order will not be successful entryType: type: integer description: Order type 1 by quantity, 2 by amount blacklist: type: boolean title: Blacklist customer orders description: Blacklist customer orders (default false) source: type: string title: Order source description: >- H5: mobile web; PC_Web: pcweb; System: system; Android: Android native app; iOS: Apple native app; HOS: Hongmeng OS; PC_Win: pcwindows client; PC_Mac: pcmac client; default is the same as login source. (limited to 255 characters, enumeration is for reference only,Only letters, numbers, and underscores can be used) thirdPartyOrder: type: string description: >- (limited to 255 characters,Only letters, numbers, and underscores can be used) slippage: type: string description: >- Only market orders are valid. It can be a percentage (only supports 2 decimal places, rounding off any excess) or a floating-point type that only supports 4 decimal places, rounding off any excess). Other formats are not supported. required: - tradeType - bizType - direction - symbolId - requestTime - requestPrice - requestNum - accountCurrency - accountDigits - entryType example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string title: Module identifier code description: Module identifier code code: type: string title: Status return code description: Status return code msg: type: string title: Status description description: Status description tm: type: integer title: Processing time (milliseconds) description: Processing time (milliseconds) trace: type: string title: Tracking code description: Tracking code msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas description: >- Placeholder parameter string in return description, multiple parameters separated by commas ok: type: boolean description: Whether the response is successful fail: type: boolean description: Whether the response is failed data: type: object properties: orderId: type: integer title: Order number format: long description: Order number positionId: type: integer title: Position number format: long description: Position number tradeVolume: type: string title: Trading volume description: Trading volume openPrice: type: string title: Opening price description: Opening price executePrice: type: string title: Execution price description: Execution price openDirection: type: integer title: Buy/sell direction at the time of opening description: >- Buy/sell direction when opening a position, 1-Buy; 2-Sell; format: int32 direction: type: integer title: Buy/sell direction for this order description: Buy/sell direction for this order, 1-Buy; 2-Sell; format: int32 openOrClose: type: integer title: Open/close type for this order description: >- Open/close type for this order, 1-Open position; 2-Close position; format: int32 symbolName: type: string title: Product name description: Product name symbolId: type: integer title: Product Id format: long description: Product Id stopLoss: type: string title: Stop loss price description: Stop-loss price, consistent with the input parameters takeProfit: type: string title: Take profit price description: >- Take-profit price, consistent with the input parameters digits: type: integer title: Product decimal places format: int32 description: Product decimal places fee: type: string title: Placing Order Handling Fee description: Placing Order Handling Fee interest: type: string title: Interest description: Interest, only exists when closing a position profit: type: string title: Profit and Loss description: Profit and loss, only exists when closing a position source: type: string title: Order source description: H5、Android、IOS、MT5 title: Data Body description: Data Body required: - source examples: '1': summary: Success example value: msg: Success fail: false trace: x-dqxq8-qu20y7y-dq58lhn-39i483-1677570581 code: '0' data: tradeVolume: '0.1' symbolId: 720 orderId: 14460002 fee: '-0.0668' openOrClose: 1 openPrice: '22.25' takeProfit: '0' positionId: 2023022819810 interest: '0' openDirection: 1 stopLoss: '0' executePrice: '22.25' digits: 2 symbolName: BINAN_SOL_USDT profit: '0' direction: 1 bizCode: '' tm: 162 msgParams: null ok: true headers: {} security: [] /global/tradeapi.app.CfdWBWOrderApiService.queryPBOOrderPage: post: summary: Pending Order List deprecated: false description: |- group=tradeApi version=0.0.1 bizType=tradeapi.app.OrderApiService.queryPBOOrderPage tags: - Trade/Isolated Margin Contract parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: group in: header description: '' required: false example: tradeApi schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: tradeType: type: integer title: Game ID description: Should be filled with 2 for this game format: long accountId: type: integer title: Account ID description: >- Optional. If filled, trading will be conducted with this account format: long accountCurrency: type: string title: Account currency sortFieldName: type: string title: Sort Field description: >- Sort Field Name orderTime(openTime,orderId),symbolId,symbolCode sortType: type: string title: '' description: Sort Type desc Descending; asc Ascending querySource: type: string description: Query Source thirdPartyOrder: type: string description: Third Party Order required: - tradeType - querySource - thirdPartyOrder example: tradeType: 59 accountCurrency: aliqua fugiat laboris accountId: 85 sortType: eu ut enim Ut consequat sortFieldName: Shao Ke County De responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string title: Module identifier code code: type: string title: Status return code msg: type: string title: Status description tm: type: integer format: int64 title: Processing time (milliseconds) trace: type: string title: Tracking code msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas ok: type: boolean fail: type: boolean data: type: object properties: id: type: string title: Pending Order ID symbolId: type: integer title: Product Id format: long type: type: integer title: >- Order Type: 9: Pending Order, 10: Delayed Order 11: Stop Loss and Take Profit Order 0: Market Order format: long direction: type: integer title: Buy/sell direction for this order description: 1-Buy; 2-Sell; format: int32 state: type: integer title: 'Whether to Convert to Market Order 0: No, 1: Yes;' format: int32 requestPrice: type: integer title: Request Price openPrice: type: string title: Requested Price (Decimal Places Handled) digits: type: integer title: Product decimal places format: int32 orderTime: type: integer title: Pending Order and Delayed Order Generation Time delayTime: type: string title: >- Delay Interval Start Time, in milliseconds, for Delayed Orders delayEndTime: type: string title: >- Delay Interval End Time, in milliseconds, for Delayed Orders exchangeTime: type: string title: Convert to market order generation time reserve: type: string title: Reserved field customerGroupId: type: string title: Client group ID contractSize: type: integer title: Open/close type for this order description: 1- Opening; 2- Closing; format: int32 requestVolume: type: integer title: Request Quantity stopLoss: type: integer title: Stop loss price stopLossTarget: type: integer title: Stop loss price (decimal places processed) takeProfit: type: integer title: Take profit unit price takeProfitTarget: type: integer title: Take profit price (decimal places processed) tradeType: type: integer title: Placing Order Handling Fee expireType: type: string title: >- Expiration type 1. Valid on the same day 2. Valid for the week remark: type: string title: Remarks loanAmount: type: integer title: Borrowing amount (leveraged full position) tradeModel: type: integer title: Transaction mode crossLevelNum: type: integer title: Leverage ratio title: Data Body examples: '1': summary: Success example value: msg: Success fail: false trace: x-dqxq8-qu20y7y-dq58lhn-39i483-1677570581 code: '0' data: tradeVolume: '0.1' symbolId: 720 orderId: 14460002 fee: '-0.0668' openOrClose: 1 openPrice: '22.25' takeProfit: '0' positionId: 2023022819810 interest: '0' openDirection: 1 stopLoss: '0' executePrice: '22.25' digits: 2 symbolName: BINAN_SOL_USDT profit: '0' direction: 1 bizCode: '' tm: 162 msgParams: null ok: true headers: {} security: [] /global/tradeapi.app.CfdWBWOrderApiService.updateOrder: post: summary: Set position stop loss and take profit deprecated: false description: >- Explanation: Set position stop loss and take profit group=tradeApi version=0.0.1 bizType=tradeapi.app.OrderApiService.updateOrder tags: - Trade/Isolated Margin Contract parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: group in: header description: '' required: false example: tradeApi schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: tradeType: type: integer title: Game ID description: Should be filled with 2 for this game format: long accountId: type: integer title: Account ID format: long description: Account ID, must fill in either account currency accountCurrency: type: string title: Account currency description: Account currency, must fill in either account ID orderId: type: integer title: Order ID format: long description: Order ID positionId: type: integer title: Position ID format: long description: Position ID accountDigits: type: integer title: Account Decimal Places format: long description: Account Decimal Places stopLoss: type: string title: Stop loss unit price description: >- Stop loss unit price, need to multiply by 10 to the power of 'product quote decimal places', and process it as an integer input. takeProfit: type: string title: Take profit unit price description: >- Take profit unit price, need to multiply by 10 to the power of 'product quote decimal places', and process it as an integer input. remark: type: string title: Remarks description: Remarks required: - tradeType - orderId - positionId - accountDigits example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string title: Module identifier code code: type: string title: Status return code msg: type: string title: Status description tm: type: integer format: int64 title: Processing time (milliseconds) trace: type: string title: Tracking code msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas ok: type: boolean fail: type: boolean data: type: object properties: {} title: Data Body description: '*' examples: '1': summary: Exception example value: msg: Account balance is 0 fail: true trace: x-0ei175a-x4dh9u2-1g8s95r-m2708212-1677570735 code: E000031 data: tradeapi.app.OrderApiService.updateOrder bizCode: CFD tm: 7 msgParams: null ok: false headers: {} security: [] /global/tradeapi.app.CfdWBWOrderApiService.queryOrderDetail: post: summary: Order details deprecated: false description: >- Explanation: View order details group=tradeApi version=0.0.1 bizType=tradeapi.app.OrderApiService.queryOrderDetail tags: - Trade/Isolated Margin Contract parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: group in: header description: '' required: false example: tradeApi schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: tradeType: type: integer title: Game ID description: Should be filled with 2 for this game format: long accountId: type: integer title: Account ID description: '*' format: long accountCurrency: type: string title: Account currency description: '*' orderId: type: integer title: Order ID format: long required: - tradeType - orderId example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string title: Module identifier code code: type: string title: Status return code msg: type: string title: Status description tm: type: integer format: int64 title: Processing time (milliseconds) trace: type: string title: Tracking code msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas ok: type: boolean fail: type: boolean data: type: object properties: orderId: type: integer title: Order ID format: long busiiType: type: integer title: Order business type description: >- 1-Market open; 2-Market close; 3-Stop loss close order; 4-Take profit close order; 5-Liquidation force close order; 6-Expiration close order; 7-Account closure order; 8-Manual force close order; 9-Delayed order; 10-Limit price pending order; 11-Stop loss pending order; format: int32 direction: type: integer title: Order buy/sell direction description: 1-Buy; 2-Sell; format: int32 status: type: integer title: Order status description: >- 1-Received order; 2-Order executed; 3-Partially executed order; 4-Cancelled order; 5-Partially cancelled order; 6-Rejected order; 7-Expired order; format: int32 userGroupId: type: integer title: Client group ID format: long accountId: type: integer title: Account ID format: long symbolId: type: integer title: Product ID format: long digits: type: integer title: Product decimal places format: long contractSize: type: integer title: Product contract size format: int32 requestPrice: type: string title: Request Price description: '*' requestNum: type: string title: Request Quantity description: '*' requestTime: type: integer title: Request time description: 13-digit timestamp format: long executeMarginRate: type: integer title: Execution margin ratio description: '*' format: int32 executeMarginRateDigits: type: integer title: Execution margin ratio decimal places description: '*' format: int32 spread: type: integer title: Execution spread description: '*' format: int32 pointRatio: type: integer title: Execution spread percentage description: '*' format: int32 executePrice: type: string title: Execution price description: '*' executeRate: type: integer title: Execution exchange rate description: '*' format: long rateDigits: type: integer title: Exchange rate decimal places format: long fee: type: string title: Execution transaction fee description: '*' feeDigits: type: integer title: Execution transaction fee decimal places format: long executeTime: type: integer title: Transaction time description: 13-digit timestamp format: long createTime: type: integer title: Creation time description: 13-digit timestamp format: long updateTime: type: integer title: Last update time description: 13-digit timestamp format: long positionId: type: integer title: Position ID format: long stopLoss: type: string title: Stop loss unit price description: '*' takeProfit: type: string title: Take profit unit price description: '*' remark: type: string title: Remarks source: type: string description: >- H5: mobile web; PC_Web: pcweb; System: system; Android: Android native app; iOS: Apple native app; HOS: Hongmeng OS; PC_Win: pcwindows client; PC_Mac: pcmac client; default is the same as login source. (The enumeration is for reference only) thirdPartyOrder: type: string title: Data Body headers: {} security: [] /global/tradeapi.app.OrderApiService.queryOrderPage: post: summary: Order list deprecated: false description: |- Explanation: View order list group=tradeApi version=0.0.1 bizType=tradeapi.app.OrderApiService.queryOrderPage tags: - Trade/Isolated Margin Contract parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: group in: header description: '' required: false example: tradeApi schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: tradeType: type: integer title: Game ID description: Game ID, should be filled with 2 for this game format: long accountId: type: integer title: Account ID description: Account ID format: long accountCurrency: type: string title: Account currency description: Account currency bizType: type: integer title: Business type description: >- Business type, 1-market price open; 2-market price close; 3-stop loss close order; 4-stop profit close order; 5-forced liquidation order; 6-expiration close order; 7-account closure order; 8-manual forced liquidation order; 9-delayed order; 10-limit price pending order; 11-stop loss pending order; 13-matching limit price open order; 14-matching limit price close order format: int32 direction: type: integer title: Order buy/sell direction description: Order buy/sell direction, 1-Buy; 2-Sell; format: int32 status: type: integer title: Order status description: >- Order status, 1-Order received; 2-Order executed; 3-Partial order executed; 4-Order canceled; 5-Partial order canceled; 6-Order rejected; 7-Order expired; format: long symbolId: type: integer title: Product ID format: int32 description: Product ID orderIds: type: string title: Order ID string description: Order ID string, multiple order IDs separated by commas positionId: type: integer title: Position ID format: long description: Position ID size: type: integer format: long title: Number of Items per Page description: Number of items per page, default 20 current: type: integer title: Current page number description: Current page number querySource: type: string description: >- H5: mobile web; PC_Web: pcweb; System: system; Android: Android native app; iOS: Apple native app; HOS: Hongmeng OS; PC_Win: pcwindows client; PC_Mac: pcmac client; default is the same as login source. (The enumeration is for reference only) thirdPartyOrder: type: string required: - tradeType example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string title: Module identifier code code: type: string title: Status return code msg: type: string title: Status description tm: type: integer format: int64 title: Processing time (milliseconds) trace: type: string title: Tracking code msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas ok: type: boolean fail: type: boolean data: type: object properties: current: type: integer title: Current page number format: int32 size: type: integer title: Data quantity per page format: int32 total: type: integer title: Total number of data format: int32 records: type: array items: type: object properties: id: type: integer title: Primary key format: long dealId: type: integer title: Deal ID format: long bizType: type: integer title: Order business type description: >- 1-Market open; 2-Market close; 3-Stop loss close order; 4-Take profit close order; 5-Liquidation force close order; 6-Expiration close order; 7-Account closure order; 8-Manual force close order; 9-Delayed order; 10-Limit price pending order; 11-Stop loss pending order; format: int32 direction: type: integer title: Order buy/sell direction description: 1-Buy; 2-Sell; format: int32 status: type: integer title: Order status description: >- 1-Received order; 2-Order executed; 3-Partially executed order; 4-Cancelled order; 5-Partially cancelled order; 6-Rejected order; 7-Expired order; format: int32 customerGroupId: type: integer title: Client group ID format: long symbolId: type: integer title: Product ID format: long digits: type: integer title: Product decimal places format: long symbolName: type: string title: Product name requestPrice: type: string title: Request Price description: '*' requestNum: type: string title: Request Quantity description: '*' contractSize: type: integer title: Product contract size format: int32 executePrice: type: string title: Execution price description: '*' requestTime: type: integer title: Request time description: 13-digit timestamp format: long executeTime: type: integer title: Transaction time description: 13-digit timestamp format: long fee: type: string title: Execution transaction fee description: '*' executeMargin: type: integer title: Execution margin description: '*' format: int32 accountDigits: type: integer title: Account Decimal Places format: int32 executeNum: type: string title: Filled quantity cancelNum: type: string title: Number of orders canceled positionId: type: integer title: Position ID format: long stopLoss: type: string title: Stop loss unit price description: '*' takeProfit: type: string title: Take profit unit price description: '*' remark: type: string title: Remarks createTime: type: integer title: Creation time description: 13-digit timestamp format: long updateTime: type: integer title: Last update time description: 13-digit timestamp format: long seq: type: integer title: Quote number format: long interest: type: integer title: Position interest format: long pnl: type: integer title: Profit and Loss format: long source: type: string description: >- H5: mobile web; PC_Web: pcweb; System: system; Android: Android native app; iOS: Apple native app; HOS: Hongmeng OS; PC_Win: pcwindows client; PC_Mac: pcmac client; default is the same as login source. (The enumeration is for reference only) thirdPartyOrder: type: string title: Order collection title: Data Body examples: '1': summary: Success example value: msg: Success fail: false trace: x-11w38izu-238ws9-maphaym-1f261yz-1677573205 code: '0' data: [] bizCode: '' tm: 7 msgParams: null ok: true '2': summary: Exception example value: msg: System error fail: true trace: x-6c5e5-162tc21-ri3151-6m634-1677573324 code: '500' data: tradeapi.app.OrderApiService.queryOrderPage bizCode: TA tm: 0 msgParams: null ok: false headers: {} security: [] /global/tradeapi.app.CfdWBWOrderApiService.queryHistoryCloseOrderList: post: summary: Closing record deprecated: false description: |- Explanation: Query historical closing records group=tradeApi version=0.0.1 bizType=tradeapi.app.OrderApiService.queryHistoryCloseOrderList tags: - Trade/Isolated Margin Contract parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: group in: header description: '' required: false example: tradeApi schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: tradeType: type: integer title: Game ID description: Should be filled with 2 for this game format: long accountId: type: integer title: Account ID description: '*' format: long accountCurrency: type: string title: Account currency description: '*' sortFieldName: type: string title: Sort field name description: >- pnl-Profit; openTime-Opening time; closeTime-Closing time; orderId-Order ID; symbolId-Product ID; sortType: type: string title: Sort type description: desc-Descending order; asc-Ascending order; symbolId: type: integer title: Product ID format: long openStartTime: type: integer title: Opening start time description: 13-digit timestamp format: long openEndTime: type: integer title: Opening end time description: 13-digit timestamp format: long closeStartTime: type: integer title: Closing start time description: 13-digit timestamp format: long closeEndTime: type: integer title: Closing end time description: 13-digit timestamp format: long current: type: integer title: Page number description: Default 1 format: int32 size: type: integer title: Data quantity per page description: Default 20 format: int32 querySource: type: string description: >- H5: mobile web; PC_Web: pcweb; System: system; Android: Android native app; iOS: Apple native app; HOS: Hongmeng OS; PC_Win: pcwindows client; PC_Mac: pcmac client; default is the same as login source. (The enumeration is for reference only) thirdPartyOrder: type: string required: - tradeType - sortFieldName - sortType example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string title: Module identifier code code: type: string title: Status return code msg: type: string title: Status description tm: type: integer format: int64 title: Processing time (milliseconds) trace: type: string title: Tracking code msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas ok: type: boolean fail: type: boolean data: type: object properties: current: type: integer title: Current page number format: int32 totalPnl: type: number title: Total profit description: '*' format: double size: type: integer title: Data quantity per page format: int32 totalPage: type: integer title: Total number of pages format: int32 list: type: array items: type: object properties: symbolId: type: integer format: long title: Product ID bizType: type: integer format: int32 title: Closing type description: >- 2-Market price closing; 3-Stop loss closing; 4-Take profit closing; 5-Liquidation forced closing; 6-Product expiration forced closing; 7-Account closure closing; 8-Manual forced closing; orderId: type: integer format: long title: Order ID openVolume: type: string title: Opening lots openPrice: type: string title: Opening price closeVolume: type: string title: Closing lots closePrice: type: string title: Closing price takeProfit: type: string title: Take profit price description: Display as '-' if not set stopLoss: type: string title: Stop loss price description: Display as '-' if not set closeTime: type: integer title: Closing time format: long description: 13-digit timestamp commission: type: string title: Commission fee symbolName: type: string title: Product name openTime: type: integer format: long title: Opening time description: 13-digit timestamp profit: type: string title: Profit interest: type: string title: Position interest openDirection: type: integer title: Opening direction description: 1-Buy; 2-Sell; format: int32 closeDirection: type: integer format: int32 description: 1-Buy; 2-Sell; title: Closing direction source: type: string description: >- H5: mobile web; PC_Web: pcweb; System: system; Android: Android native app; iOS: Apple native app; HOS: Hongmeng OS; PC_Win: pcwindows client; PC_Mac: pcmac client; default is the same as login source. (The enumeration is for reference only) thirdPartyOrder: type: string title: Closing List Collection title: Data Body examples: '1': summary: Success example value: msg: Success fail: false trace: x-77q3ivej-u4wi1d3a-5pbl5v-ypwj0-1677573497 code: '0' data: accountId: null trace: x-77q3ivej-u4wi1d3a-5pbl5v-ypwj0-1677573497 companyId: 360 current: 1 size: 20 totalPage: 0 ip: 47.242.92.158 customerId: 1176 list: [] lang: en-US totalPnl: 0 customerNo: '86001175' bizCode: '' tm: 6 msgParams: null ok: true '2': summary: Exception example_sortType not desc, asc value value: msg: Only allow sequential or reverse sorting fail: true trace: x-4zhomd-v593q7m-vh94y-5e815-1677573516 code: E000014 data: tradeapi.app.OrderApiService.queryHistoryCloseOrderList bizCode: CFD tm: 13 msgParams: null ok: false headers: {} security: [] /global/tradeapi.app.OrderApiService.queryTradeRecordPage: post: summary: Transaction records deprecated: false description: |- Explanation: Query transaction record list group=tradeApi version=0.0.1 bizType=tradeapi.app.OrderApiService.queryTradeRecordPage tags: - Trade/Isolated Margin Contract parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: group in: header description: '' required: false example: tradeApi schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: tradeType: type: integer title: Game ID description: Should be filled with 2 for this game format: int32 accountIds: type: string title: Account ID description: Multiple separated by commas sortFieldName: type: string title: Sort field name description: >- Sorting field names, executeTime-transaction time; direction-direction; symbolId-product id; sortType: type: string title: Sort type description: Sorting type, desc-descending order; asc-ascending order; symbolId: type: integer title: Product ID format: long description: Product ID direction: type: integer title: Buy/Sell Direction description: Buy/sell direction, -1-all; 1-buy; 2-sell; format: int32 orderType: type: integer title: Order type description: >- Order type, -1-all; 1-open; 2-close; 3-market price; 4-limit price; format: int32 executeStartTime: type: integer title: Transaction start time description: Transaction start time, 13-digit timestamp format: long executeEndTime: type: integer title: Transaction end time description: Transaction end time, 13-digit timestamp format: long current: type: integer title: Page number description: Page number, default 1 format: int32 size: type: integer title: Data quantity per page description: Number of data per page, default 20 format: int32 querySource: type: string description: >- H5: mobile web; PC_Web: pcweb; System: system; Android: Android native app; iOS: Apple native app; HOS: Hongmeng OS; PC_Win: pcwindows client; PC_Mac: pcmac client; default is the same as login source. (The enumeration is for reference only) thirdPartyOrder: type: string required: - tradeType - sortFieldName - sortType example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string title: Module identifier code description: Module identifier code code: type: string title: Status return code description: Status return code, 0 success, others fail msg: type: string title: Status description description: Status description tm: type: integer format: int64 title: Processing time (milliseconds) description: Processing time (milliseconds) trace: type: string title: Tracking code description: Tracking code msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas description: >- Placeholder parameter string in return description, multiple parameters separated by commas ok: type: boolean description: Success flag fail: type: boolean description: Failure flag data: type: object properties: accountId: type: integer title: Account ID format: long description: Account ID companyId: type: integer title: Company ID format: long description: Company ID customerId: type: integer title: Customer ID format: long description: Customer ID customerNo: type: string title: Client number description: Client number current: type: integer format: int32 title: Current page number description: Current page number size: type: integer format: int32 title: Data quantity per page description: Data quantity per page totalPage: type: integer title: Total number of pages format: int32 description: Total number of pages bizTypeText: type: object properties: {} title: Transaction type mapping description: Transaction type mapping list: type: array items: type: object properties: symbolId: type: integer title: Product ID format: long description: Product ID orderId: type: integer title: Order number format: long description: Order number bizType: type: integer format: long title: Order type description: Order type symbolName: type: string title: Product name description: Product name direction: type: integer format: int32 title: Transaction direction description: Transaction direction, 1-buy; 2-sell; requestPrice: type: string title: Request Price/Open Price description: Request Price executePrice: type: string title: Execution price description: Execution price executeNum: type: string title: Number of Deals (Lots) description: Number of Deals (Lots) loanAmount: type: string title: Loan Amount description: Loan Amount executeTime: type: integer format: long title: Transaction time description: Deal Time, 13-digit Timestamp outCurrency: type: string title: Loan Currency description: Loan Currency stopLoss: type: string title: Stop loss price description: Stop loss price takeProfit: type: string title: Take profit price description: Take profit price commission: type: string title: Commission fee description: Commission fee profitLoss: type: string title: Profit and Loss description: Profit and Loss overnightInterest: type: string title: Overnight interest description: Overnight interest numberStatisticMode: type: string title: Quantity Statistical Method description: 1-By Quantity; 2-By Amount; accountCurrency: type: string title: Account currency description: Account currency dealId: type: integer format: long title: Deal Number description: Deal Number positionId: type: integer format: long description: Position ID originalRequestPrice: type: string title: Request Price realExecuteNum: type: string title: Deal Quantity (Returned Quantity, not Lots) description: Deal Quantity (Returned Quantity, not Lots) executeMargin: type: string title: Deal Margin description: Deal Margin executeAmount: type: string title: Deal amount description: Deal amount occupyMargin: type: string title: Margin in use description: Margin in use source: type: string description: >- H5: mobile web; PC_Web: pcweb; System: system; Android: Android native app; iOS: Apple native app; HOS: Hongmeng OS; PC_Win: pcwindows client; PC_Mac: pcmac client; default is the same as login source. (The enumeration is for reference only) thirdPartyOrder: type: string required: - executePrice - executeNum - loanAmount - executeTime - outCurrency - stopLoss - takeProfit - commission - profitLoss - overnightInterest - numberStatisticMode - accountCurrency - dealId title: Deal List Collection description: Deal List Collection title: Data Body description: Data Body examples: '1': summary: Success example value: msg: Success fail: false trace: x-w864w4d-7143je-n2w23-0124-1677573722 code: '0' data: accountId: null current: 1 trace: x-w864w4d-7143je-n2w23-0124-1677573722 companyId: 360 size: 20 totalPage: 0 ip: 47.242.92.158 customerId: 1176 bizTypeText: '1': Market Open '2': Pre-set Limit Open '3': Pre-set Stop Loss Open '4': Market Close '5': Stop profit Close '6': Stop Loss Close '7': System Close '8': Expiry Close '9': Limit Open list: [] lang: en-US customerNo: '86001175' bizCode: '' tm: 7 msgParams: null ok: true '2': summary: Exception example value: msg: System error fail: true trace: x-n9et4-yp4g8q3-0t31r-lopx-1677573670 code: E00003 data: tradeapi.app.OrderApiService.queryTradeRecordPage bizCode: O tm: 3 msgParams: null ok: false headers: {} security: [] /global/tradeapi.app.PositionApiService.updateCrossLevelNum: post: summary: Set position leverage multiplier deprecated: false description: |- ``` group=tradeApi version=0.0.1 bizType=tradeapi.app.PositionApiService.updateCrossLevelNum ``` tags: - Trade/Isolated Margin Contract parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: group in: header description: '' required: false example: tradeApi schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: tradeType: type: integer title: Game ID description: Should be filled with 2 for this game format: long symbolId: type: integer title: Product ID format: long description: Product ID requestTime: type: integer title: Leverage ratio format: int32 description: Leverage ratio required: - tradeType - requestTime - symbolId example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string title: Module identifier code code: type: string title: Status return code msg: type: string title: Status description tm: type: integer format: int64 title: Processing time (milliseconds) trace: type: string title: Tracking code msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas ok: type: boolean fail: type: boolean data: type: object properties: crossLevelNum: type: integer title: Leverage ratio format: int32 title: Data Body examples: '1': summary: Success example value: msg: Success fail: false trace: x-6s8tc-2v65-i8270878-1727-1677574098 code: '0' data: crossLevelNum: 11 bizCode: '' tm: 17 msgParams: null ok: true '2': summary: >- Exception Example - Invalid modification of leverage multiplier value: msg: >- Selected leverage ratio is not within the range, please select again fail: true trace: x-k246k-s7g2ze-e4b4ned3-2781-1677574116 code: E000030 data: tradeapi.app.OrderApiService.setCrossLevelNum bizCode: CFD tm: 3 msgParams: null ok: false headers: {} security: [] /global/tradeapi.app.PositionApiService.updateOccupyTheMargin: post: summary: Modify position margin deprecated: false description: >- Note: Contract - full position gameplay, set the leverage multiple of customers on products, affecting all positions of the product group=tradeApi version=0.0.1 bizType=tradeapi.app.PositionApiService.updateOccupyTheMargin tags: - Trade/Isolated Margin Contract parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: group in: header description: '' required: false example: tradeApi schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: tradeType: type: integer title: Game ID description: Should be filled with 2 for this game format: long accountId: type: integer title: Account ID format: long description: Account ID accountCurrency: type: string title: Account currency description: Account currency positionId: type: integer title: Position ID description: Position ID accountDigits: type: string title: Account Decimal Places description: Account Decimal Places occupyTheMargin: type: string title: Modify the amount of margin occupied description: Modify the amount of margin occupied, can be negative orderId: type: integer title: Order Id description: Order ID remark: type: string title: Remarks description: Remarks required: - tradeType - accountId - accountDigits - occupyTheMargin - orderId - remark example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string title: Module identifier code code: type: string title: Status return code msg: type: string title: Status description tm: type: integer format: int64 title: Processing time (milliseconds) trace: type: string title: Tracking code msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas ok: type: boolean fail: type: boolean data: type: object properties: crossLevelNum: type: integer title: Leverage ratio format: int32 title: Data Body examples: '1': summary: Success example value: msg: Success fail: false trace: x-6s8tc-2v65-i8270878-1727-1677574098 code: '0' data: crossLevelNum: 11 bizCode: '' tm: 17 msgParams: null ok: true '2': summary: >- Exception Example - Invalid modification of leverage multiplier value: msg: >- Selected leverage ratio is not within the range, please select again fail: true trace: x-k246k-s7g2ze-e4b4ned3-2781-1677574116 code: E000030 data: tradeapi.app.OrderApiService.setCrossLevelNum bizCode: CFD tm: 3 msgParams: null ok: false headers: {} security: [] /global/tradeapi.app.OrderApiService.calculateMarketOrder: post: summary: Order Trial Calculation deprecated: false description: >- Explanation: Calculate margin and commission for placing orders group=tradeApi version=0.0.1 bizType=tradeapi.app.OrderApiService.calculateMarketOrder tags: - Trade/Isolated Margin Contract parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: group in: header description: '' required: false example: tradeApi schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: tradeType: type: integer title: Game ID description: Should be filled with 2 for this game format: long accountId: type: integer title: Account ID description: >- Optional. If filled, trading will be conducted with this account format: long bizType: type: integer title: Business type description: >- Business type, 1-market price open; 2-market price close; 10-limit price pending order; 11-stop loss pending order; 13-aggregate limit price open order; 14-aggregate limit price close order format: int32 direction: type: integer title: Order buy/sell direction description: 1-Buy; 2-Sell; format: int32 symbolId: type: integer title: Product ID format: long positionId: type: integer title: Position ID description: Required when placing a closing order format: long requestTime: type: integer title: Order request time description: 13-digit timestamp format: long requestPrice: type: string title: Order price at the time of placing description: For order record only, not the actual transaction price* requestNum: type: string title: Order quantity expireType: type: integer title: Expiration type description: >- Only valid for pending orders. 1-Valid for the day; 2-Valid for the week; format: int32 remark: type: string title: Remarks accountCurrency: type: string title: Account currency accountDigits: type: integer title: Account Decimal Places format: int32 crossLevelNum: type: integer title: Leverage ratio format: int32 description: >- Only valid for opening positions, only one leverage ratio should be set for the same product stopLoss: type: number title: Stop loss unit price description: >- Stop loss unit price, need to multiply by 10 to the power of 'product quote decimal places', and process it as an integer input. format: double takeProfit: type: number title: Take profit unit price description: >- Take profit unit price, need to multiply by 10 to the power of 'product quote decimal places', and process it as an integer input. format: double required: - tradeType - bizType - direction - symbolId - requestTime - requestPrice - requestNum - accountCurrency - accountDigits example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string title: Module identifier code code: type: string title: Status return code description: Status Return Code Module Identifier msg: type: string title: Status description description: Status description tm: type: integer format: int64 title: Processing time (milliseconds) description: Processing time (milliseconds) trace: type: string title: Tracking code description: Tracking code msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas description: >- Placeholder parameter string in return description, multiple parameters separated by commas ok: type: boolean fail: type: boolean data: type: object properties: fee: type: string title: Commission fee description: Commission fee margin: type: string title: Margin description: Margin calculatePrice: type: string title: Calculation price description: Calculation price maintainMargin: type: string title: Maintenance Margin Ratio description: Maintenance Margin Ratio calculateNum: type: string title: Calculate Trading Quantity description: Calculate Trading Quantity evaluateProfit: type: string title: Expected Profit description: >- Expected Profit. Only valid when opening a position and `takeProfit` is filled evaluateLoss: type: string title: Expected Loss description: >- Expected Loss. Only valid when opening a position and `stopLoss` is filled evaluateClosePrice: type: string title: Expected Liquidation Price description: >- Expected Liquidation Price. Only valid when opening a position title: Data Body description: Data Body examples: '1': summary: Success example value: msg: Success fail: false trace: x-7rf727-m64d8ar-72dn4ij-23o3vt-1677574738 code: '0' data: margin: '10000.6584' calculatePrice: '136.719' fee: '0.0000' bizCode: '' tm: 31 msgParams: null ok: true headers: {} security: [] /global/tradeapi.app.OrderApiService.calculationBurstPrice: post: summary: Calculate Liquidation Price deprecated: false description: |- Explanation: Calculate Liquidation Price group=tradeApi version=0.0.1 bizType=tradeapi.app.OrderApiService.calculationBurstPrice tags: - Trade/Isolated Margin Contract parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: group in: header description: '' required: false example: tradeApi schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: tradeType: type: integer title: Game ID description: Should be filled with 2 for this game format: long accountId: type: integer title: Account ID description: Optional format: long positionId: type: integer title: Position ID format: long adjustMargin: type: number title: Adjust Margin description: >- Positive number to increase margin amount; negative number to decrease margin amount format: double required: - tradeType - adjustMargin - positionId example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string title: Module identifier code code: type: string title: Status return code description: Status Return Code Module Identifier msg: type: string title: Status description description: Status description tm: type: integer format: int64 title: Processing time (milliseconds) description: Processing time (milliseconds) trace: type: string title: Tracking code description: Tracking code msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas description: >- Placeholder parameter string in return description, multiple parameters separated by commas ok: type: boolean fail: type: boolean data: type: object properties: evaluateClosePrice: type: string title: Expected Liquidation Price description: Expected Liquidation Price evaluateProfit: type: string title: Expected Profit description: Expected Profit evaluateLoss: type: string title: Expected Loss description: Expected Loss evaluateNetPnl: type: string title: Expected Net Profit and Loss description: Expected Net Profit and Loss title: Data Body description: Data Body examples: '1': summary: Success example value: msg: Success fail: false trace: x-7rf727-m64d8ar-72dn4ij-23o3vt-1677574738 code: '0' data: evaluateClosePrice: '136.719' bizCode: '' tm: 31 msgParams: null ok: true headers: {} security: [] /global/tradeapi.app.PositionApiService.queryPositionDetail: post: summary: Position Details deprecated: false description: |- Description: Query position details group=tradeApi version=0.0.1 bizType=tradeapi.app.PositionApiService.queryPositionDetail tags: - Trade/Isolated Margin Contract parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: group in: header description: '' required: false example: tradeApi schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: tradeType: type: integer title: Game ID description: Should be filled with 2 for this game format: long accountId: type: integer title: Account ID description: '*' format: long accountCurrency: type: string title: Account currency description: '*' positionId: type: integer title: Position ID format: long required: - tradeType - positionId example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string title: Module identifier code code: type: string title: Status return code msg: type: string title: Status description tm: type: integer format: int64 title: Processing time (milliseconds) trace: type: string title: Tracking code msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas ok: type: boolean fail: type: boolean data: type: object properties: positionId: type: integer title: Position ID format: long orderId: type: integer title: Order ID format: long dealId: type: integer title: Deal ID format: long status: type: string title: Position status description: >- 0-Initialization; 1-Position holding; 2-Completed; 3-Partial closing; direction: type: integer format: int32 title: Buy/Sell Direction description: 1-Buy; 2-Sell; symbolId: type: integer title: Product ID format: long symbolName: type: string title: Product name openAccountDigits: type: integer title: Account decimal places for opening format: int32 openSymbolDigits: type: integer format: int32 title: Product decimal places for opening openContractSize: type: integer format: int32 title: Contract size openPrice: type: string title: Opening unit price openNum: type: string title: Opening quantity closeAccountDigits: type: integer title: Account decimal places for closing format: int32 closeSymbolDigits: type: integer title: Product decimal places for closing format: int32 closePrice: type: string title: Closing unit price closeFreeDigits: type: string title: Closing commission decimal places profit: type: string title: Profit and Loss openMargin: type: string title: Opening margin used stopLoss: type: string title: Stop loss unit price description: Original registered value, untreated takeProfit: type: string title: Take profit unit price description: Original registered value, untreated remark: type: string title: Remarks margin: type: string title: Real-time margin used openTime: type: integer format: long title: Opening time description: 13-digit timestamp closeTime: type: integer format: long title: Closing time description: 13-digit timestamp openFee: type: string title: Opening commission closeFee: type: string title: Closing commission closeNum: type: string title: Closing quantity description: '*' openVolume: type: string title: Opening lots description: '*' closeVolume: type: string title: Closing lots description: '*' minVolume: type: string title: Minimum lots per side description: '*' stopLossDecimal: type: string title: Stop loss unit price description: >- `stopLoss` processed based on `closeSymbolDigits`. Used for direct display on the frontend takeProfitDecimal: type: string title: Take profit unit price description: >- `takeProfit` processed based on `closeSymbolDigits`. Used for direct display on the frontend volume: type: string title: Lots marginSetType: type: string title: Margin type description: 1-Ratio; 2-Range; source: type: string description: >- H5: mobile web; PC_Web: pcweb; System: system; Android: Android native app; iOS: Apple native app; HOS: Hongmeng OS; PC_Win: pcwindows client; PC_Mac: pcmac client; default is the same as login source. (The enumeration is for reference only) thirdPartyOrder: type: string title: Data Body examples: '1': summary: Success example value: msg: Success fail: false trace: x-11wdkt-kg9i-ld2y-53mz854-1677571927 code: '0' data: symbolId: 720 orderId: 14460003 dealId: 94870543 canReduceMargin: '0.0000' openPrice: '22.18' remark: null takeProfitDecimal: '0.00' closeNum: 0 closeFee: '0.0000' takeProfit: '0' occupyTheMargin: '0.0000' interest: '0.0000' maintenanceMargin: '0.0000' closeVolume: 0 openVolume: 0.1 closeTime: 0 closeAccountDigits: 4 symbolName: BINAN_SOL_USDT openTime: 1677571033093 profit: null tradeType: 1 direction: 1 singleMargin: null margin: null openContractSize: 1 resp: null openMargin: '0.2209' openNum: 0.1 openFee: '0.0665' closeSymbolDigits: 2 warningMargin: '0.0000' stopLossDecimal: '0.00' adjustCrossLevel: 1-100 openSymbolDigits: 2 volume: 0.1 accountId: 1031767 companyId: 360 positionId: 2023022819827 closeFreeDigits: null stopLoss: '0' minVolume: null marginSetType: '2' crossLevelNum: 10 openAccountDigits: 4 closePrice: '0.0000' status: '1' bizCode: C tm: 27 msgParams: null ok: true '2': summary: Exception example value: msg: Close position fail fail: true trace: x-pw16m-so77fl71-x21ucw-sh0wz4-1677571968 code: '30001' data: tradeapi.app.PositionApiService.queryPositionDetail bizCode: C tm: 93 msgParams: null ok: false headers: {} security: [] /global/tradeapi.app.PositionApiService.queryPositionPage: post: summary: Position List deprecated: false description: |- Description: Query position list group=tradeApi version=0.0.1 bizType=tradeapi.app.PositionApiService.queryPositionPage tags: - Trade/Isolated Margin Contract parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: group in: header description: '' required: false example: tradeApi schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: tradeType: type: integer title: Game ID description: Should be filled with 2 for this game format: long accountId: type: integer title: Account ID description: Account ID format: long accountCurrency: type: string title: Account currency description: Account currency status: type: integer format: int32 title: Position status description: 1-Position Holding; 3-Partial Closing; orderId: type: integer title: Order ID format: long description: Order ID dealId: type: integer format: long title: Deal ID description: Deal ID symbolId: type: integer format: long title: Product ID description: Product ID startTime: type: integer title: Start Time format: long description: 13-digit timestamp endTime: type: integer format: long title: End Time description: 13-digit timestamp sortFieldName: type: string title: Sort field name description: >- orderId-Order Id; openTime-Execution Time; symbolId-Product Id; pnl-Profit and Loss; sortType: type: string title: Sort method description: asc-Ascending Order; desc-Descending Order; (default desc) size: type: integer title: Number of Items per Page description: Default 20 format: long current: type: integer title: Current Page description: Default 1 format: long querySource: type: string description: >- H5: mobile web; PC_Web: pcweb; System: system; Android: Android native app; iOS: Apple native app; HOS: Hongmeng OS; PC_Win: pcwindows client; PC_Mac: pcmac client; default is the same as login source. (The enumeration is for reference only) thirdPartyOrder: type: string required: - tradeType example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string title: Module identifier code code: type: string title: Status return code msg: type: string title: Status description tm: type: integer format: int64 title: Processing time (milliseconds) trace: type: string title: Tracking code msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas ok: type: boolean fail: type: boolean data: type: array items: type: object properties: positionId: type: integer title: Position ID format: long orderId: type: integer title: Order ID format: long dealId: type: integer title: Deal ID format: long status: type: string title: Position status description: >- 0-Initialization; 1-Position holding; 2-Completed; 3-Partial closing; direction: type: integer format: int32 title: Buy/Sell Direction description: 1-Buy; 2-Sell; symbolId: type: integer title: Product ID format: long symbolName: type: string title: Product name openAccountDigits: type: integer title: Account decimal places for opening format: int32 openSymbolDigits: type: integer format: int32 title: Product decimal places for opening openContractSize: type: integer format: int32 title: Contract size openPrice: type: string title: Opening unit price openNum: type: string title: Opening quantity closeAccountDigits: type: integer title: Account decimal places for closing format: int32 closeSymbolDigits: type: integer title: Product decimal places for closing format: int32 closePrice: type: string title: Closing unit price closeFreeDigits: type: string title: Closing commission decimal places profit: type: string title: Profit and Loss openMargin: type: string title: Opening margin used stopLoss: type: string title: Stop loss unit price description: Original registered value, untreated takeProfit: type: string title: Take profit unit price description: Original registered value, untreated remark: type: string title: Remarks margin: type: string title: Real-time margin used openTime: type: integer format: long title: Opening time description: 13-digit timestamp closeTime: type: integer format: long title: Closing time description: 13-digit timestamp openFee: type: string title: Opening commission closeFee: type: string title: Closing commission closeNum: type: string title: Closing quantity description: '*' openVolume: type: string title: Opening lots description: '*' closeVolume: type: string title: Closing lots description: '*' minVolume: type: string title: Minimum lots per side description: '*' stopLossDecimal: type: string title: Stop loss unit price description: >- `stopLoss` processed based on `closeSymbolDigits`. Used for direct display on the frontend takeProfitDecimal: type: string title: Take profit unit price description: >- `takeProfit` processed based on `closeSymbolDigits`. Used for direct display on the frontend volume: type: string title: Lots marginSetType: type: string title: Margin type description: 1-Ratio; 2-Range; source: type: string description: >- H5: mobile web; PC_Web: pcweb; System: system; Android: Android native app; iOS: Apple native app; HOS: Hongmeng OS; PC_Win: pcwindows client; PC_Mac: pcmac client; default is the same as login source. (The enumeration is for reference only) thirdPartyOrder: type: string title: Data Body examples: '1': summary: Success example value: msg: Success fail: false trace: x-6d6k11o7-00ve031-d863o8-4hk417e-1677572056 code: '0' data: - symbolId: 967 orderId: 24153319 dealId: 13394059 canReduceMargin: '0.0000' openPrice: '7.05' remark: null takeProfitDecimal: '0.00' closeNum: 0 closeFee: '0.0000' takeProfit: '0' occupyTheMargin: '0.0000' interest: '0.0000' maintenanceMargin: '0.0000' closeVolume: 0 openVolume: 1 closeTime: 0 closeAccountDigits: 4 symbolName: AXS/USDT_PRD openTime: 1672023552024 profit: null tradeType: 1 direction: 1 singleMargin: null margin: null openContractSize: 1 resp: null openMargin: '0.3480' openNum: 1 openFee: '0.3525' closeSymbolDigits: 2 warningMargin: '0.0000' stopLossDecimal: '0.00' adjustCrossLevel: 1-100 openSymbolDigits: 2 volume: 1 accountId: 1031767 companyId: 360 positionId: 2022122620993 closeFreeDigits: null stopLoss: '0' minVolume: null marginSetType: '2' crossLevelNum: 20 openAccountDigits: 4 closePrice: '0.0000' status: '1' bizCode: C tm: 21 msgParams: null ok: true '2': summary: Exception example value: msg: System error fail: true trace: x-7u8qq26-71c412-yi4pce4-n1u574-1677572101 code: '500' data: tradeapi.app.PositionApiService.queryPositionPage bizCode: TA tm: 1 msgParams: null ok: false headers: {} security: [] /global/tradeapi.app.OrderApiService.queryCapitalFlowList: post: summary: Fund Flow deprecated: false description: >- Explanation: Pagination query account capital flow group=tradeApi version=0.0.1 bizType=tradeapi.app.OrderApiService.queryCapitalFlowList tags: - Trade/Isolated Margin Contract parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: group in: header description: '' required: false example: tradeApi schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: tradeType: type: integer title: Game ID description: Should be filled with 2 for this game format: long accountId: type: integer format: long title: Account ID description: Account ID size: type: integer title: Number of data entries per page format: long description: Number of data entries per page current: type: integer title: Current Page format: long description: Current Page businessType: type: integer format: int32 title: Business type description: >- Business type, 0-unrestricted; 1-deposit; 2-withdrawal; 3-system reset; 4-credit adjustment; 5-freeze; 6-transaction; 36-transfer; 42-reward; status: type: integer format: int32 title: Status description: >- Status, 0-Unrestricted; 1-Initialization; 2-Processing successful; 3-Processing failed; startTime: type: integer format: long description: Start time, 13-digit timestamp title: Start time endTime: type: integer format: long description: End time, 13-digit timestamp title: End Time operate: type: integer format: int32 title: Capital flow description: >- Capital flow direction, 0-Unrestricted; 1-Increase; 2-Decrease; required: - tradeType example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string title: Module identifier code description: Module identifier code code: type: string title: Status return code description: Status return code, 0 success, others fail msg: type: string title: Status description description: Status description tm: type: integer format: int64 title: Processing time (milliseconds) description: Processing time (milliseconds) trace: type: string title: Tracking code description: Tracking code msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas description: >- Placeholder parameter string in return description, multiple parameters separated by commas ok: type: boolean description: Success flag fail: type: boolean description: Failure flag data: type: object properties: total: type: integer title: Total format: long description: Total size: type: integer format: long title: Number of Items per Page description: Number of Items per Page current: type: integer format: long title: Current Page description: Current Page records: type: array items: type: object properties: remark: type: string title: Remarks description: Remarks createTime: type: integer title: Creation date description: Creation date, 13-digit timestamp format: long updateTime: type: integer format: long title: Update Time description: Update time, 13-digit timestamp subjectId: type: integer format: long title: Subject ID description: Subject ID bookkeepId: type: integer format: long title: Voucher ID description: Voucher ID amountIn: type: string title: Increase amount description: Increase amount amountOut: type: string title: Decrease amount description: Decrease amount status: type: integer format: int32 title: Status description: >- Status, 1-Initialization; 2-Processing successful; 3-Processing failed; amountAfter: type: string title: Balance after change description: Balance after change businessType: type: integer title: Business type format: int32 description: >- Business type, 1-Deposit; 2-Withdrawal; 3-System reset; 4-Limit adjustment; 5-Freeze; 6-Transaction; 36-Transfer; 42-Reward; businessType1: type: integer format: int32 description: >- Business sub-type, 1001-Front-end deposit; 1002-Deposit fee; 2001-Front-end withdrawal; 2002-Cancel withdrawal; 2003-Withdrawal fee; 2004-Cancel fee; 2005-Confirm transfer; 3001-System reset; 4001-Limit adjustment_deposit; 4002-Limit adjustment_withdrawal; 4003-Limit adjustment_other; 4004-Limit adjustment_bonus; 4005-Limit adjustment_release non-withdrawable; 4006-Limit adjustment_non-withdrawable; 4007-Limit adjustment_transfer rebate; 5001-Freeze; 5002-Unfreeze; 6001-Open position fee; 6002-Close position fee; 6003-Overnight interest; 6004-Market close profit and loss; 6005-Stop loss close profit and loss; 6006-Take profit close profit and loss; 6007-System forced close profit and loss; 6008-Expiration forced close profit and loss; 6009-Manual forced close profit and loss; 36001-Transfer in amount; 36002-Transfer out amount; 42001-Issue reward; 42002-Deduct reward; 42003-Issue rebate; 42004-Deduct rebate; title: Business Subtype customerNo: type: string title: Client number description: Client number digits: type: string title: Decimal Places description: Decimal Places currency: type: string title: Currency description: Currency businessTypeName: type: string title: Business Type Name description: >- Business type name, confirm language by passing in `lang` businessType1Name: type: string title: Business Subtype Name description: >- Business sub-type name, confirm language by passing in `lang` accountId: type: integer title: Account Id format: long description: Account Id orderId: type: integer format: long description: Order ID dealId: type: integer format: long description: Deal ID title: Data Body description: Data Body title: Transaction Collection description: Transaction Collection description: Data Body examples: '1': summary: Success example value: msg: Success fail: false trace: x-n72ql-snasw1-ts561r-31e7q-1677572540 code: '0' data: total: 40 current: 1 size: 20 records: - amount: '-0.0665' businessType1: 6001 amountAfter: '109849175.3769' businessType1Name: Open position fee updateTime: 1677571033166 remark: null version: 0 subjectId: 1504110734228991000 accountId: 1031767 createTime: 1677571033151 businessTypeName: transaction createdBy: null updateBy: null bookkeepId: 2023022819827 currency: USDT digits: 4 amountIn: '0.0000' amountOut: '0.0665' id: 238603703 businessType: 6 customerNo: '86001175' status: 2 bizCode: A tm: 13 msgParams: null ok: true '2': summary: Exception example value: msg: System error fail: true trace: x-q7pj-8jiln-310518-4l0c69-1677572511 code: '500' data: tradeapi.app.OrderApiService.queryCapitalFlowList bizCode: TA tm: 0 msgParams: null ok: false headers: {} security: [] /global/tradeapi.app.OrderApiService.closeTradePboOrder: post: summary: Cancel limit order(For aggregation mode only) deprecated: false description: |- Explanation: Cancel limit order(For aggregation mode only) group=tradeApi version=0.0.1 bizType=tradeapi.app.OrderApiService.closeTradePboOrder tags: - Trade/Isolated Margin Contract parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: group in: header description: '' required: false example: tradeApi schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: tradeType: type: integer title: '' description: Game ID, should be filled with 2 for this game format: long orderId: type: integer format: int32 title: '' description: Order ID required: - tradeType - orderId example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string title: Module identifier code description: Module identifier code code: type: string title: Status return code description: Status return code, 0 success, others fail msg: type: string title: Status description description: Status description tm: type: integer format: int64 title: Processing time (milliseconds) description: Processing time (milliseconds) trace: type: string title: Tracking code description: Tracking code msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas description: >- Placeholder parameter string in return description, multiple parameters separated by commas ok: type: boolean description: Success flag fail: type: boolean description: Failure flag data: type: object properties: leftover: type: string description: Cancel quantity description: Data Body examples: '1': summary: Success example value: msg: ut ok: false msgParams: aute trace: deserunt commodo cillum bizCode: '34' code: '60' fail: true tm: 67 data: {} '2': summary: Exception example value: msg: System error fail: true trace: x-q7pj-8jiln-310518-4l0c69-1677572511 code: '500' data: tradeapi.app.OrderApiService.queryCapitalFlowList bizCode: TA tm: 0 msgParams: null ok: false headers: {} security: [] /global/tradeapi.app.OrderApiService.checkOrderStatus: post: summary: Check Order Status deprecated: false description: |- Description: Check Order Status group=tradeApi version=0.0.1 bizType=tradeapi.app.OrderApiService.checkOrderStatus tags: - Trade/Isolated Margin Contract parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: group in: header description: '' required: false example: tradeApi schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: tradeType: type: integer title: '' description: Game ID, should be filled with 2 for this game format: long orderId: type: integer description: Order ID format: long title: '' operatorType: type: integer description: >- 1=Adjust leverage ratio, 2=Adjust margin, 3=Order execution status minimum: 1 maximum: 2 required: - tradeType - orderId - operatorType example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string title: Module identifier code description: Module identifier code code: type: string title: Status return code description: Status return code, 0 success, others fail msg: type: string title: Status description description: Status description tm: type: integer format: int64 title: Processing time (milliseconds) description: Processing time (milliseconds) trace: type: string title: Tracking code description: Tracking code msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas description: >- Placeholder parameter string in return description, multiple parameters separated by commas ok: type: boolean description: Success flag fail: type: boolean description: Failure flag data: type: object properties: {} description: >- Return results, when operatorType=3, 0=Not executed, 1=Executed examples: '1': summary: Success example value: msg: ut ok: false msgParams: aute trace: deserunt commodo cillum bizCode: '34' code: '60' fail: true tm: 67 data: {} '2': summary: Exception example value: msg: System error fail: true trace: x-q7pj-8jiln-310518-4l0c69-1677572511 code: '500' data: tradeapi.app.OrderApiService.queryCapitalFlowList bizCode: TA tm: 0 msgParams: null ok: false headers: {} security: [] /global/tradeapi.app.OrderApiService.addOrder: post: summary: Place an order deprecated: false description: >- Description: Contract margin trading order group=tradeApi version=0.0.1 bizType=tradeapi.app.OrderApiService.addOrder tags: - Trade/Leveraged parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: group in: header description: '' required: false example: tradeApi schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: tradeType: type: integer title: Game ID description: Should be filled with 2 for this game format: long accountId: type: integer title: Account ID description: >- Optional. If filled, trading will be conducted with this account format: long bizType: type: integer title: Business type format: int32 description: >- Business type. 1-Market order; 12-Market by amount order; 13-Limit order direction: type: integer title: Order buy/sell direction description: 1-Buy; 2-Sell; format: int32 symbolId: type: integer title: Product ID format: long requestTime: type: integer title: Order request time description: 13-digit timestamp format: long requestPrice: type: string title: Order price at the time of placing description: >- Needs to be multiplied by 10 to the power of 'product price decimal places' and passed as an integer. Only for order recording, not the actual transaction price. requestNum: type: string title: Order quantity remark: type: string title: Remarks accountCurrency: type: string title: Account currency accountDigits: type: integer title: Account Decimal Places format: int32 operationType: type: integer description: >- Operation type. 1- Normal; 2- Automatic borrowing; 3- Automatic repayment expireType: type: string description: >- Required for pending orders, expiration type 1. Valid on the same day 2. Valid for the same week required: - tradeType - bizType - direction - symbolId - requestTime - requestPrice - requestNum - accountCurrency - accountDigits - operationType - expireType example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string title: Module identifier code code: type: string title: Status return code msg: type: string title: Status description tm: type: integer format: int64 title: Processing time (milliseconds) trace: type: string title: Tracking code msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas ok: type: boolean fail: type: boolean data: type: object properties: orderId: type: integer title: Order number format: long positionId: type: integer title: Position number format: long tradeVolume: type: string title: Trading volume openPrice: type: string title: Opening price executePrice: type: string title: Execution price openDirection: type: integer title: Buy/sell direction at the time of opening description: 1-Buy; 2-Sell; format: int32 direction: type: integer title: Buy/sell direction for this order description: 1-Buy; 2-Sell; format: int32 openOrClose: type: integer title: Open/close type for this order description: 1- Opening; 2- Closing; format: int32 symbolName: type: string title: Product name symbolId: type: integer title: Product Id format: long stopLoss: type: string title: Stop loss price description: Consistent with the input parameters takeProfit: type: string title: Take profit price description: Consistent with the input parameters digits: type: integer title: Product decimal places format: int32 fee: type: string title: Placing Order Handling Fee interest: type: string title: Interest description: Only Closing Exists profit: type: string title: Profit and Loss description: Only Closing Exists title: Data Body examples: '1': summary: Success example value: msg: Success fail: false trace: x-dqxq8-qu20y7y-dq58lhn-39i483-1677570581 code: '0' data: tradeVolume: '0.1' symbolId: 720 orderId: 14460002 fee: '-0.0668' openOrClose: 1 openPrice: '22.25' takeProfit: '0' positionId: 2023022819810 interest: '0' openDirection: 1 stopLoss: '0' executePrice: '22.25' digits: 2 symbolName: BINAN_SOL_USDT profit: '0' direction: 1 bizCode: '' tm: 162 msgParams: null ok: true headers: {} security: [] /global/tradeapi.app.CrossLeverOrderApiService.updateOrder: post: summary: Set position stop loss and take profit deprecated: false description: >- Explanation: Set position stop loss and take profit group=tradeApi version=0.0.1 bizType=tradeapi.app.OrderApiService.updateOrder tags: - Trade/Leveraged parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: group in: header description: '' required: false example: tradeApi schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: tradeType: type: integer title: Game ID description: Fill in 3 for this gameplay format: long accountId: type: integer title: Account ID description: '*' format: long accountCurrency: type: string title: Account currency description: '*' orderId: type: integer title: Order ID format: long positionId: type: integer title: Position ID format: long accountDigits: type: integer title: Account Decimal Places format: long stopLoss: type: string title: Stop loss unit price description: >- Needs to be multiplied by 10 to the power of 'product quote decimal places', processed as an integer and passed in. takeProfit: type: string title: Take profit unit price description: >- Needs to be multiplied by 10 to the power of 'product quote decimal places', processed as an integer and passed in. remark: type: string title: Remarks required: - tradeType - orderId - positionId - accountDigits - stopLoss - takeProfit - remark example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string title: Module identifier code code: type: string title: Status return code msg: type: string title: Status description tm: type: integer format: int64 title: Processing time (milliseconds) trace: type: string title: Tracking code msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas ok: type: boolean fail: type: boolean data: type: object properties: {} title: Data Body description: '*' examples: '1': summary: Exception example value: msg: Account balance is 0 fail: true trace: x-0ei175a-x4dh9u2-1g8s95r-m2708212-1677570735 code: E000031 data: tradeapi.app.OrderApiService.updateOrder bizCode: CFD tm: 7 msgParams: null ok: false headers: {} security: [] /global/tradeapi.app.CrossLeverOrderApiService.queryTradeRecordPage: post: summary: Transaction records deprecated: false description: |- Explanation: Query transaction record list group=tradeApi version=0.0.1 bizType=tradeapi.app.OrderApiService.queryTradeRecordPage tags: - Trade/Leveraged parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: group in: header description: '' required: false example: tradeApi schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: tradeType: type: integer title: Game ID description: Should be filled with 2 for this game format: int32 accountIds: type: string title: Account ID description: Multiple separated by commas sortFieldName: type: string title: Sort field name description: >- executeTime-transaction time; direction-direction; symbolId-product id; sortType: type: string title: Sort type description: desc-Descending order; asc-Ascending order; symbolId: type: integer title: Product ID format: long direction: type: integer title: Buy/Sell Direction description: '-1-all; 1-buy; 2-sell;' format: int32 orderType: type: integer title: Order type description: '-1-all; 1-open; 2-close; 3-market price; 4-limit price;' format: int32 executeStartTime: type: integer title: Transaction start time description: 13-digit timestamp format: long executeEndTime: type: integer title: Transaction end time description: 13-digit timestamp format: long current: type: integer title: Page number description: Default 1 format: int32 size: type: integer title: Data quantity per page description: Default 20 format: int32 required: - tradeType - sortFieldName - sortType example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string title: Module identifier code code: type: string title: Status return code msg: type: string title: Status description tm: type: integer format: int64 title: Processing time (milliseconds) trace: type: string title: Tracking code msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas ok: type: boolean fail: type: boolean data: type: object properties: accountId: type: integer title: Account ID format: long companyId: type: integer title: Company ID format: long customerId: type: integer title: Customer ID format: long customerNo: type: string title: Client number current: type: integer format: int32 title: Current page number size: type: integer format: int32 title: Data quantity per page totalPage: type: integer title: Total number of pages format: int32 bizTypeText: type: object properties: {} title: Transaction type mapping list: type: array items: type: object properties: symbolId: type: integer title: Product ID format: long orderId: type: integer title: Order number format: long bizType: type: integer format: long title: Order type symbolName: type: string title: Product name direction: type: integer format: int32 title: Transaction direction description: 1-Buy; 2-Sell; requestPrice: type: string title: Request Price description: '*' executePrice: type: string title: Execution price executeNum: type: string title: Number of Deals (Lots) description: '*' loanAmount: type: string title: Loan Amount description: '*' executeTime: type: integer format: long title: Transaction time description: 13-digit timestamp outCurrency: type: string title: Loan Currency description: '*' stopLoss: type: string title: Stop loss price takeProfit: type: string title: Take profit price commission: type: string title: Commission fee profitLoss: type: string title: Profit and Loss overnightInterest: type: string title: Overnight interest numberStatisticMode: type: string title: Quantity Statistical Method description: 1-By Quantity; 2-By Amount; accountCurrency: type: string title: Account currency dealId: type: integer format: long title: Deal Number required: - executePrice - executeNum - loanAmount - executeTime - outCurrency - stopLoss - takeProfit - commission - profitLoss - overnightInterest - numberStatisticMode - accountCurrency - dealId title: Deal List Collection title: Data Body examples: '1': summary: Success example value: msg: Success fail: false trace: x-w864w4d-7143je-n2w23-0124-1677573722 code: '0' data: accountId: null current: 1 trace: x-w864w4d-7143je-n2w23-0124-1677573722 companyId: 360 size: 20 totalPage: 0 ip: 47.242.92.158 customerId: 1176 bizTypeText: '1': Market Open '2': Pre-set Limit Open '3': Pre-set Stop Loss Open '4': Market Close '5': Stop profit Close '6': Stop Loss Close '7': System Close '8': Expiry Close '9': Limit Open list: [] lang: en-US customerNo: '86001175' bizCode: '' tm: 7 msgParams: null ok: true '2': summary: Exception example value: msg: System error fail: true trace: x-n9et4-yp4g8q3-0t31r-lopx-1677573670 code: E00003 data: tradeapi.app.OrderApiService.queryTradeRecordPage bizCode: O tm: 3 msgParams: null ok: false headers: {} security: [] /global/tradeapi.app.CrossLeverOrderApiService.previewOrder: post: summary: Get cross-currency repayment exchange rate deprecated: false description: |- group=tradeApi version=0.0.1 bizType=tradeapi.app.OrderApiService.previewOrder tags: - Trade/Leveraged parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: group in: header description: '' required: false example: tradeApi schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: tradeType: type: integer title: Game ID description: Should be filled with 2 for this game format: long sourceCurrency: type: string title: '' description: Source currency targetCurrency: type: string description: Target currency customerCurrency: type: string description: Total asset currency requestNum: type: number title: '' description: Request Quantity requestTime: type: integer description: Order request time remark: type: string description: Remarks required: - tradeType - requestNum - targetCurrency - customerCurrency - requestTime - remark - sourceCurrency example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string title: Module identifier code code: type: string title: Status return code msg: type: string title: Status description tm: type: integer format: int64 title: Processing time (milliseconds) trace: type: string title: Tracking code msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas ok: type: boolean fail: type: boolean data: type: object properties: positionId: type: integer title: Position ID format: long orderId: type: integer title: Order ID format: long dealId: type: integer title: Deal ID format: long status: type: string title: Position status description: >- 0-Initialization; 1-Position holding; 2-Completed; 3-Partial closing; direction: type: integer format: int32 title: Buy/Sell Direction description: 1-Buy; 2-Sell; symbolId: type: integer title: Product ID format: long symbolName: type: string title: Product name openAccountDigits: type: integer title: Account decimal places for opening format: int32 openSymbolDigits: type: integer format: int32 title: Product decimal places for opening openContractSize: type: integer format: int32 title: Contract size openPrice: type: string title: Opening unit price openNum: type: string title: Opening quantity closeAccountDigits: type: integer title: Account decimal places for closing format: int32 closeSymbolDigits: type: integer title: Product decimal places for closing format: int32 closePrice: type: string title: Closing unit price closeFreeDigits: type: string title: Closing commission decimal places profit: type: string title: Profit and Loss openMargin: type: string title: Opening margin used stopLoss: type: string title: Stop loss unit price description: Original registered value, untreated takeProfit: type: string title: Take profit unit price description: Original registered value, untreated remark: type: string title: Remarks margin: type: string title: Real-time margin used openTime: type: integer format: long title: Opening time description: 13-digit timestamp closeTime: type: integer format: long title: Closing time description: 13-digit timestamp openFee: type: string title: Opening commission closeFee: type: string title: Closing commission closeNum: type: string title: Closing quantity description: '*' openVolume: type: string title: Opening lots description: '*' closeVolume: type: string title: Closing lots description: '*' minVolume: type: string title: Minimum lots per side description: '*' stopLossDecimal: type: string title: Stop loss unit price description: >- `stopLoss` processed based on `closeSymbolDigits`. Used for direct display on the frontend takeProfitDecimal: type: string title: Take profit unit price description: >- `takeProfit` processed based on `closeSymbolDigits`. Used for direct display on the frontend volume: type: string title: Lots marginSetType: type: string title: Margin type description: 1-Ratio; 2-Range; title: Data Body examples: '1': summary: Success example value: msg: Success fail: false trace: x-11wdkt-kg9i-ld2y-53mz854-1677571927 code: '0' data: symbolId: 720 orderId: 14460003 dealId: 94870543 canReduceMargin: '0.0000' openPrice: '22.18' remark: null takeProfitDecimal: '0.00' closeNum: 0 closeFee: '0.0000' takeProfit: '0' occupyTheMargin: '0.0000' interest: '0.0000' maintenanceMargin: '0.0000' closeVolume: 0 openVolume: 0.1 closeTime: 0 closeAccountDigits: 4 symbolName: BINAN_SOL_USDT openTime: 1677571033093 profit: null tradeType: 1 direction: 1 singleMargin: null margin: null openContractSize: 1 resp: null openMargin: '0.2209' openNum: 0.1 openFee: '0.0665' closeSymbolDigits: 2 warningMargin: '0.0000' stopLossDecimal: '0.00' adjustCrossLevel: 1-100 openSymbolDigits: 2 volume: 0.1 accountId: 1031767 companyId: 360 positionId: 2023022819827 closeFreeDigits: null stopLoss: '0' minVolume: null marginSetType: '2' crossLevelNum: 10 openAccountDigits: 4 closePrice: '0.0000' status: '1' bizCode: C tm: 27 msgParams: null ok: true '2': summary: Exception example value: msg: Close position fail fail: true trace: x-pw16m-so77fl71-x21ucw-sh0wz4-1677571968 code: '30001' data: tradeapi.app.PositionApiService.queryPositionDetail bizCode: C tm: 93 msgParams: null ok: false headers: {} security: [] /global/tradeapi.app.CrossLeverOrderApiService.addRepaymentOrder: post: summary: Cross-currency repayment deprecated: false description: |- group=tradeApi version=0.0.1 bizType=tradeapi.app.OrderApiService.addRepaymentOrder tags: - Trade/Leveraged parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: group in: header description: '' required: false example: tradeApi schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: tradeType: type: integer title: Game ID description: Should be filled with 2 for this game format: long sourceCurrency: type: string title: '' description: Source currency targetCurrency: type: string description: Target currency customerCurrency: type: string description: Total asset currency requestNum: type: number title: '' description: Request Quantity requestTime: type: integer description: Order request time remark: type: string description: Remarks required: - tradeType - requestNum - targetCurrency - customerCurrency - requestTime - remark - sourceCurrency example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string title: Module identifier code code: type: string title: Status return code msg: type: string title: Status description tm: type: integer format: int64 title: Processing time (milliseconds) trace: type: string title: Tracking code msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas ok: type: boolean fail: type: boolean data: type: object properties: positionId: type: integer title: Position ID format: long orderId: type: integer title: Order ID format: long dealId: type: integer title: Deal ID format: long status: type: string title: Position status description: >- 0-Initialization; 1-Position holding; 2-Completed; 3-Partial closing; direction: type: integer format: int32 title: Buy/Sell Direction description: 1-Buy; 2-Sell; symbolId: type: integer title: Product ID format: long symbolName: type: string title: Product name openAccountDigits: type: integer title: Account decimal places for opening format: int32 openSymbolDigits: type: integer format: int32 title: Product decimal places for opening openContractSize: type: integer format: int32 title: Contract size openPrice: type: string title: Opening unit price openNum: type: string title: Opening quantity closeAccountDigits: type: integer title: Account decimal places for closing format: int32 closeSymbolDigits: type: integer title: Product decimal places for closing format: int32 closePrice: type: string title: Closing unit price closeFreeDigits: type: string title: Closing commission decimal places profit: type: string title: Profit and Loss openMargin: type: string title: Opening margin used stopLoss: type: string title: Stop loss unit price description: Original registered value, untreated takeProfit: type: string title: Take profit unit price description: Original registered value, untreated remark: type: string title: Remarks margin: type: string title: Real-time margin used openTime: type: integer format: long title: Opening time description: 13-digit timestamp closeTime: type: integer format: long title: Closing time description: 13-digit timestamp openFee: type: string title: Opening commission closeFee: type: string title: Closing commission closeNum: type: string title: Closing quantity description: '*' openVolume: type: string title: Opening lots description: '*' closeVolume: type: string title: Closing lots description: '*' minVolume: type: string title: Minimum lots per side description: '*' stopLossDecimal: type: string title: Stop loss unit price description: >- `stopLoss` processed based on `closeSymbolDigits`. Used for direct display on the frontend takeProfitDecimal: type: string title: Take profit unit price description: >- `takeProfit` processed based on `closeSymbolDigits`. Used for direct display on the frontend volume: type: string title: Lots marginSetType: type: string title: Margin type description: 1-Ratio; 2-Range; title: Data Body examples: '1': summary: Success example value: msg: Success fail: false trace: x-11wdkt-kg9i-ld2y-53mz854-1677571927 code: '0' data: symbolId: 720 orderId: 14460003 dealId: 94870543 canReduceMargin: '0.0000' openPrice: '22.18' remark: null takeProfitDecimal: '0.00' closeNum: 0 closeFee: '0.0000' takeProfit: '0' occupyTheMargin: '0.0000' interest: '0.0000' maintenanceMargin: '0.0000' closeVolume: 0 openVolume: 0.1 closeTime: 0 closeAccountDigits: 4 symbolName: BINAN_SOL_USDT openTime: 1677571033093 profit: null tradeType: 1 direction: 1 singleMargin: null margin: null openContractSize: 1 resp: null openMargin: '0.2209' openNum: 0.1 openFee: '0.0665' closeSymbolDigits: 2 warningMargin: '0.0000' stopLossDecimal: '0.00' adjustCrossLevel: 1-100 openSymbolDigits: 2 volume: 0.1 accountId: 1031767 companyId: 360 positionId: 2023022819827 closeFreeDigits: null stopLoss: '0' minVolume: null marginSetType: '2' crossLevelNum: 10 openAccountDigits: 4 closePrice: '0.0000' status: '1' bizCode: C tm: 27 msgParams: null ok: true '2': summary: Exception example value: msg: Close position fail fail: true trace: x-pw16m-so77fl71-x21ucw-sh0wz4-1677571968 code: '30001' data: tradeapi.app.PositionApiService.queryPositionDetail bizCode: C tm: 93 msgParams: null ok: false headers: {} security: [] /global/tradeapi.app.CrossLeverOrderApiService.queryCapitalFlowList: post: summary: Fund Flow deprecated: false description: >- Explanation: Pagination query account capital flow group=tradeApi version=0.0.1 bizType=tradeapi.app.OrderApiService.queryCapitalFlowList tags: - Trade/Leveraged parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: group in: header description: '' required: false example: tradeApi schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: tradeType: type: integer title: Game ID description: Should be filled with 2 for this game format: long accountId: type: integer format: long title: Account ID size: type: integer title: Number of data entries per page format: long current: type: integer title: Current Page format: long businessType: type: integer format: int32 title: Business type description: >- 0-Unrestricted; 1-Deposit; 2-Withdrawal; 3-System reset; 4-Limit adjustment; 5-Freeze; 6-Transaction; 36-Transfer; 42-Reward; status: type: integer format: int32 title: Status description: >- 0-Unrestricted; 1-Initialization; 2-Processing successful; 3-Processing failed; startTime: type: integer format: long description: 13-digit timestamp title: Start time endTime: type: integer format: long description: 13-digit timestamp title: End Time operate: type: integer format: int32 title: Capital flow description: 0-Unrestricted; 1-Increase; 2-Decrease; assetsId: type: integer format: long title: Asset ID lang: type: string title: Language required: - tradeType example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string title: Module identifier code code: type: string title: Status return code msg: type: string title: Status description tm: type: integer format: int64 title: Processing time (milliseconds) trace: type: string title: Tracking code msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas ok: type: boolean fail: type: boolean data: type: object properties: total: type: integer title: Total format: long size: type: integer format: long title: Number of Items per Page current: type: integer format: long title: Current Page records: type: array items: type: object properties: remark: type: string title: Remarks createTime: type: integer title: Creation date description: 13-digit timestamp format: long updateTime: type: integer format: long title: Update Time description: 13-digit timestamp subjectId: type: integer format: long title: Subject ID bookkeepId: type: integer format: long title: Voucher ID amountIn: type: string title: Increase amount amountOut: type: string title: Decrease amount status: type: integer format: int32 title: Status description: >- 1-Initialization; 2-Processing successful; 3-Processing failed; amountAfter: type: string title: Balance after change businessType: type: integer title: Business type format: int32 description: >- 1-Deposit; 2-Withdrawal; 3-System reset; 4-Limit adjustment; 5-Freeze; 6-Trade; 36-Transfer; 42-Reward; businessType1: type: integer format: int32 description: >- 1001-Front-end deposit; 1002-Deposit fee; 2001-Front-end withdrawal; 2002-Cancel withdrawal; 2003-Withdrawal fee; 2004-Cancel fee; 2005-Confirm transfer; 3001-System reset; 4001-Limit adjustment_deposit; 4002-Limit adjustment_withdrawal; 4003-Limit adjustment_other; 4004-Limit adjustment_bonus; 4005-Limit adjustment_release non-withdrawable; 4006-Limit adjustment_non-withdrawable; 4007-Limit adjustment_transfer commission; 5001-Freeze; 5002-Unfreeze; 6001-Open position fee; 6002-Close position fee; 6003-Overnight interest; 6004-Market close profit and loss; 6005-Stop loss close profit and loss; 6006-Take profit close profit and loss; 6007-System forced close profit and loss; 6008-Expiration forced close profit and loss; 6009-Manual forced close profit and loss; 36001-Transfer in amount; 36002-Transfer out amount; 42001-Issue reward; 42002-Deduct reward; 42003-Issue commission; 42004-Deduct commission; title: Business Subtype customerNo: type: string title: Client number digits: type: string title: Decimal Places currency: type: string title: Currency businessTypeName: type: string title: Business Type Name description: Confirm language by passing in `lang` businessType1Name: type: string title: Business Subtype Name description: Confirm language by passing in `lang` accountId: type: integer title: Account Id format: long title: Data Body title: Transaction Collection examples: '1': summary: Success example value: msg: Success fail: false trace: x-n72ql-snasw1-ts561r-31e7q-1677572540 code: '0' data: total: 40 current: 1 size: 20 records: - amount: '-0.0665' businessType1: 6001 amountAfter: '109849175.3769' businessType1Name: Open position fee updateTime: 1677571033166 remark: null version: 0 subjectId: 1504110734228991000 accountId: 1031767 createTime: 1677571033151 businessTypeName: transaction createdBy: null updateBy: null bookkeepId: 2023022819827 currency: USDT digits: 4 amountIn: '0.0000' amountOut: '0.0665' id: 238603703 businessType: 6 customerNo: '86001175' status: 2 bizCode: A tm: 13 msgParams: null ok: true '2': summary: Exception example value: msg: System error fail: true trace: x-q7pj-8jiln-310518-4l0c69-1677572511 code: '500' data: tradeapi.app.OrderApiService.queryCapitalFlowList bizCode: TA tm: 0 msgParams: null ok: false headers: {} security: [] /global/tradeapi.app.SpotOrderApiService.queryCapitalFlowList: post: summary: Fund Flow deprecated: false description: >- Explanation: Pagination query of account fund flow Accessible after login group=tradeApi version=0.0.1 bizType=tradeapi.app.SpotOrderApiService.queryCapitalFlowList operationId: queryWaterByPage tags: - Trade/Spot parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/SpotQueryWaterPageDto' example: '' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/BaseResultBasePageVoSpotSubjectWaterVo' headers: {} security: [] /global/tradeapi.app.SpotOrderApiService.closeTradePboOrder: post: summary: Cancel limit order deprecated: false description: >- Explanation: Cancel limit order for spot trading. Access after login group=tradeApi version=0.0.1 bizType=tradeapi.app.SpotOrderApiService.closeTradePboOrder operationId: cancelPendingOrder tags: - Trade/Spot parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/SpotOrderUpdateDto' example: '' responses: '200': description: '' content: application/json: schema: &ref_23 $ref: '#/components/schemas/BaseResultSpotQueryOrderVo' headers: {} security: [] /global/tradeapi.app.SpotOrderApiService.queryOrderPage: post: summary: View Order List deprecated: false description: >- Explanation: View Order List group=tradeApi version=0.0.1 bizType=tradeapi.app.SpotOrderApiService.queryOrderPage operationId: queryOrderPage tags: - Trade/Spot parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: group in: header description: '' required: false example: tradeApi schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SpotQueryOrderPageDto' example: '' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/BaseResultSpotQueryOrderPageVo' headers: {} security: [] /global/tradeapi.app.SpotOrderApiService.queryOrderDetail: post: summary: View Order Details deprecated: false description: >- Explanation: View order details for spot game, accessible after login group=tradeApi version=0.0.1 bizType=tradeapi.app.SpotOrderApiService.queryOrderDetail operationId: queryOrder tags: - Trade/Spot parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/SpotQueryOrderDto' example: '' responses: '200': description: '' content: application/json: schema: *ref_23 headers: {} security: [] /global/tradeapi.app.SpotOrderApiService.queryTradeRecordPage: post: summary: Query transaction record list deprecated: false description: >- Explanation: Query transaction record list group=tradeApi version=0.0.1 bizType=tradeapi.app.SpotOrderApiService.queryTradeRecordPage operationId: queryTradeRecordPage tags: - Trade/Spot parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/SpotQueryOrderRecordPageDto' example: '' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/BaseResultSpotTradeRecordVo' headers: {} security: [] /global/tradeapi.app.StockOrderApiService.placeOrder: post: summary: Place an order deprecated: false description: >- Explanation: Place stock trading orders group=tradeApi version=0.0.1 bizType=tradeapi.app.OrderApiService.placeOrder tags: - Trade/Stock parameters: [] requestBody: content: application/json: schema: type: object properties: tradeType: type: integer format: long title: Game ID description: Should be filled in as 6 for this gameplay accountCurrency: type: string title: Account currency accountDigits: type: integer format: int32 title: Account Decimal Places bizType: type: integer format: int32 title: Order business type description: >- 1-Market buy; 2-Market sell; 5-Liquidation forced order; 8-Manual forced order; 12-Limit buy; 13-Limit sell; direction: type: integer title: Buy/Sell Direction description: 1-Buy; 2-Sell; format: int32 symbolId: type: integer format: long title: Product ID digits: type: integer format: int32 title: Product Quote Decimal Places requestTime: type: integer format: long title: Order request time requestPrice: type: integer format: long title: Request Price description: >- Needs to be processed as an integer according to the decimal places of the product quote. For limit order placement, use this field as the limit price. requestNum: type: string title: Request Quantity remark: type: string title: Remarks required: - tradeType - accountCurrency - accountDigits - bizType - direction - symbolId - digits - requestTime - requestPrice - requestNum example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string title: Module identifier code code: type: string title: Status return code msg: type: string title: Status description tm: type: integer format: int64 title: Processing time (milliseconds) trace: type: string title: Tracking code msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas ok: type: boolean fail: type: boolean data: type: object properties: orderId: type: integer title: Order number format: long title: Data Body headers: {} security: [] /global/tradeapi.app.StockOrderApiService.cancelOrder: post: summary: Cancel order deprecated: false description: |- Explanation: Cancel unexecuted orders group=tradeApi version=0.0.1 bizType=tradeapi.app.OrderApiService.cancelOrder tags: - Trade/Stock parameters: [] requestBody: content: application/json: schema: type: object properties: tradeType: type: integer format: long title: Game ID description: Should be filled in as 6 for this gameplay bizType: type: integer format: int32 title: Order business type description: >- 14-User cancels pending order; 15-Backend cancels pending order; 16-Automatic liquidation cancels pending order; orderId: type: integer format: long title: Order ID remark: type: string title: Remarks required: - tradeType - bizType - orderId example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string title: Module identifier code code: type: string title: Status return code msg: type: string title: Status description tm: type: integer format: int64 title: Processing time (milliseconds) trace: type: string title: Tracking code msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas ok: type: boolean fail: type: boolean headers: {} security: [] /global/tradeapi.app.StockOrderApiService.queryOrderDetail: post: summary: Order information deprecated: false description: |- Note: Query order information group=tradeApi version=0.0.1 bizType=tradeapi.app.OrderApiService.queryOrderDetail tags: - Trade/Stock parameters: [] requestBody: content: application/json: schema: type: object properties: tradeType: type: integer format: long title: Game ID description: Should be filled in as 6 for this gameplay orderId: type: integer format: long title: Order ID required: - tradeType - orderId example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string title: Module identifier code code: type: string title: Status return code msg: type: string title: Status description tm: type: integer format: int64 title: Processing time (milliseconds) trace: type: string title: Tracking code msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas ok: type: boolean fail: type: boolean data: type: object properties: orderId: type: integer title: Order ID format: long bizType: type: integer format: int32 title: Order business type description: >- 1-Market buy; 2-Market sell; 5-Liquidation forced order; 8-Manual forced order; 12-Limit buy; 13-Limit sell; 14-User cancel pending order; 15-Backend cancel pending order; 16-Liquidation automatic cancel pending order; direction: type: integer format: int32 title: Order buy/sell direction description: 1-Buy; 2-Sell; status: type: integer format: int32 title: Order status description: >- 0-Submitted; 1-Partial filled; 2-All filled; 3-Cancelled; 4-Failed; 5-Pending fill; 6-Order failed; symbolId: type: integer format: long title: Product ID symbolName: type: string title: Product name symbolCode: type: string title: Product code requestNum: type: string title: Request Quantity requestPrice: type: string title: Request Price requestTime: type: integer title: Request time format: long executeNum: type: string title: Filled quantity title: Data Body headers: {} security: [] /global/tradeapi.app.StockOrderApiService.queryOrderPage: post: summary: Entrustment order list deprecated: false description: |- Note: Paginate query entrustment order list group=tradeApi version=0.0.1 bizType=tradeapi.app.OrderApiService.queryOrderPage tags: - Trade/Stock parameters: [] requestBody: content: application/json: schema: type: object properties: tradeType: type: integer format: long title: Game ID description: Should be filled in as 6 for this gameplay orderIds: type: string title: Order ID string description: Separate multiple order IDs with commas symbolId: type: integer title: Product ID format: long direction: type: integer format: long title: Order buy/sell direction description: 1-Buy; 2-Sell; status: type: integer format: int32 title: Order status description: >- 0-Submitted; 1-Partially filled; 2-All filled; 3-Cancelled; 4-Failed; current: type: integer title: Page number format: int32 description: Default 1 size: type: integer format: int32 title: Data quantity per page description: Default 20 executeStartTime: type: integer format: long title: Start time description: 13-digit timestamp executeEndTime: type: integer format: long title: End Time description: 13-digit timestamp sortFieldName: type: string title: Sort Field description: >- request_time-Entrust time; id-Order Id; symbol_id-Product Id; status-Status; create_time-Order creation time; (default request_time) sortType: type: string title: Sort method description: desc-Descending order; asc-Ascending order; (default desc) required: - tradeType - size - executeStartTime - executeEndTime - sortFieldName - sortType example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string title: Module identifier code code: type: string title: Status return code msg: type: string title: Status description tm: type: integer format: int64 title: Processing time (milliseconds) trace: type: string title: Tracking code msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas ok: type: boolean fail: type: boolean data: type: object properties: total: type: integer title: Total format: long size: type: integer format: long title: Number of Items per Page current: type: integer format: long title: Current Page records: type: array items: type: object properties: orderId: type: integer title: Order ID format: long bizType: type: integer format: int32 title: Order business type description: >- 1-Market buy; 2-Market sell; 5-Liquidation forced order; 8-Manual forced order; 12-Limit buy; 13-Limit sell; 14-User cancel pending order; 15-Backend cancel pending order; 16-Liquidation automatic cancel pending order; direction: type: integer format: int32 title: Order buy/sell direction description: 1-Buy; 2-Sell; status: type: integer format: int32 title: Order status description: >- 0-Submitted; 1-Partial filled; 2-All filled; 3-Cancelled; 4-Failed; 5-Pending fill; 6-Order failed; symbolId: type: integer format: long title: Product ID symbolName: type: string title: Product name symbolCode: type: string title: Product code requestNum: type: string title: Request Quantity requestPrice: type: string title: Request Price requestTime: type: integer title: Request time format: long executeNum: type: string title: Filled quantity title: Data Body title: Entrust list headers: {} security: [] /global/tradeapi.app.StockOrderApiService.queryPendingOrderList: post: summary: Customer entrustment list deprecated: false description: >- Explanation: Query the current customer entrustment list group=tradeApi version=0.0.1 bizType=tradeapi.app.OrderApiService.queryPendingOrderList tags: - Trade/Stock parameters: [] requestBody: content: application/json: schema: type: object properties: tradeType: type: integer format: long title: Game ID description: Should be filled in as 6 for this gameplay required: - tradeType example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string title: Module identifier code code: type: string title: Status return code msg: type: string title: Status description tm: type: integer format: int64 title: Processing time (milliseconds) trace: type: string title: Tracking code msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas ok: type: boolean fail: type: boolean data: type: array items: type: object properties: orderId: type: integer title: Order ID format: long bizType: type: integer format: int32 title: Order business type description: >- 1-Market buy; 2-Market sell; 5-Liquidation forced order; 8-Manual forced order; 12-Limit buy; 13-Limit sell; 14-User cancel pending order; 15-Backend cancel pending order; 16-Liquidation automatic cancel pending order; direction: type: integer title: Order buy/sell direction format: int32 description: 1-Buy; 2-Sell; status: type: integer format: int32 title: Order status description: >- 0-Submitted; 1-Partial filled; 2-All filled; 3-Cancelled; 4-Failed; 5-Pending fill; 6-Order failed; symbolId: type: integer format: long title: Product ID symbolName: type: string title: Product name symbolCode: type: string title: Product code requestNum: type: string title: Request Quantity requestPrice: type: string title: Request Price requestTime: type: integer title: Request time format: long description: 13-digit timestamp executeNum: type: string title: Filled quantity headers: {} security: [] /global/tradeapi.app.StockOrderApiService.checkOrder: post: summary: Place an order verification deprecated: false description: |- Explanation: Verify the result of this order group=tradeApi version=0.0.1 bizType=tradeapi.app.OrderApiService.checkOrder tags: - Trade/Stock parameters: [] requestBody: content: application/json: schema: type: object properties: tradeType: type: integer format: long title: Game ID description: Should be filled in as 6 for this gameplay accountCurrency: type: string title: Account currency accountDigits: type: integer format: int32 title: Account Decimal Places bizType: type: integer format: int32 title: Order business type description: >- 1-Market buy; 2-Market sell; 5-Liquidation forced order; 8-Manual forced order; 12-Limit buy; 13-Limit sell; direction: type: integer title: Buy/Sell Direction description: 1-Buy; 2-Sell; format: int32 symbolId: type: integer format: long title: Product ID digits: type: integer format: int32 title: Product Quote Decimal Places requestTime: type: integer format: long title: Order request time requestPrice: type: integer format: long title: Request Price description: >- Needs to be processed as an integer according to the decimal places of the product quote. For limit order placement, use this field as the limit price. requestNum: type: string title: Request Quantity remark: type: string title: Remarks required: - tradeType - accountCurrency - accountDigits - bizType - direction - symbolId - digits - requestTime - requestPrice - requestNum example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string title: Module identifier code code: type: string title: Status return code msg: type: string title: Status description tm: type: integer format: int64 title: Processing time (milliseconds) trace: type: string title: Tracking code msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas ok: type: boolean fail: type: boolean data: type: object properties: direction: type: integer format: int32 title: Buy/Sell Direction description: 1-Buy; 2-Sell; beforePositionNum: type: string title: >- Number of shares in the position before this transaction afterPositionNum: type: string title: >- Number of shares in the position after this transaction loanAmount: type: string title: Amount of loan required for this transaction title: Data Body headers: {} security: [] /global/tradeapi.app.StockOrderApiService.calculateOrder: post: summary: Trading trial calculation deprecated: false description: >- Explanation: Trial calculation can buy and sell shares group=tradeApi version=0.0.1 bizType=tradeapi.app.OrderApiService.calculateOrder tags: - Trade/Stock parameters: [] requestBody: content: application/json: schema: type: object properties: tradeType: type: integer format: long title: Game ID description: Should be filled in as 6 for this gameplay accountCurrency: type: string title: Account currency accountDigits: type: integer format: int32 title: Account Decimal Places direction: type: integer title: Buy/Sell Direction description: 1-Buy; 2-Sell; format: int32 symbolId: type: integer format: long title: Product ID digits: type: integer format: int32 title: Product Quote Decimal Places required: - tradeType - accountCurrency - accountDigits - direction - symbolId - digits example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string title: Module identifier code code: type: string title: Status return code msg: type: string title: Status description tm: type: integer format: int64 title: Processing time (milliseconds) trace: type: string title: Tracking code msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas ok: type: boolean fail: type: boolean data: type: object properties: canClosePositionNum: type: string title: Number of shares that can be closed canSellNum: type: string title: Number of shares that can be sold on margin canBuyNum: type: string title: Number of shares that can be bought with cash canLoanBuyNum: type: string title: Number of shares that can be bought with a loan title: Data Body headers: {} security: [] /global/tradeapi.app.StockOrderApiService.queryDealPage: post: summary: Deal list deprecated: false description: >- Note: Query deal list group=tradeApi version=0.0.1 bizType=tradeapi.app.OrderApiService.queryDealPage tags: - Trade/Stock parameters: [] requestBody: content: application/json: schema: type: object properties: tradeType: type: integer format: long title: Game ID description: Should be filled in as 6 for this gameplay symbolId: type: integer format: long title: Product ID bizType: type: integer format: int32 title: Order business type description: >- 1-Market buy; 2-Market sell; 5-Liquidation forced order; 8-Manual forced order; 12-Limit buy; 13-Limit sell; direction: type: integer title: Buy/Sell Direction description: 1-Buy; 2-Sell; format: int32 current: type: integer format: int32 title: Page number description: Default 1 size: type: integer format: int32 title: Data quantity per page description: Default 20 executeStartTime: type: integer title: Start time format: long description: 13-digit timestamp executeEndTime: type: integer format: long title: End Time description: 13-digit timestamp sortFieldName: type: string title: Sort Field description: >- execute_time-Deal time; id-Deal ID; symbol_id-Product ID; (default execute_time) sortType: type: string title: Sort method description: desc-Descending order; asc-Ascending order; (default desc) required: - tradeType example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string title: Module identifier code code: type: string title: Status return code msg: type: string title: Status description tm: type: integer format: int64 title: Processing time (milliseconds) trace: type: string title: Tracking code msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas ok: type: boolean fail: type: boolean data: type: object properties: accountId: type: integer title: Account ID format: long companyId: type: integer title: Company ID format: long customerId: type: integer title: Customer ID format: long customerNo: type: string title: Client number current: type: integer title: Current page number format: int32 size: type: integer format: int32 title: Data quantity per page totalPage: type: integer format: int32 title: Total number of pages list: type: array items: type: object properties: dealId: type: integer title: Deal ID format: long orderId: type: integer format: long title: Order ID bizType: type: integer format: int32 title: Order business type description: >- 1-Market buy; 2-Market sell; 5-Liquidation forced order; 8-Manual forced order; 12-Limit buy; 13-Limit sell; 14-User cancel pending order; 15-Backend cancel pending order; 16-Liquidation automatic cancel pending order; direction: type: integer format: int32 title: Order buy/sell direction description: 1-Buy; 2-Sell; symbolId: type: integer title: Product ID format: long symbolName: type: string title: Product name symbolCode: type: string title: Product code executeNum: type: string title: Volume executePrice: type: string title: Deal price tradeAmount: type: string title: Deal amount commission: type: string title: Commission fee executeTime: type: integer format: long title: Transaction time description: 13-digit timestamp title: Deal list collection title: Data Body headers: {} security: [] /global/tradeapi.app.StockOrderApiService.getPositionDealDetailList: post: summary: Position transaction list deprecated: false description: |- Description: Query the list of position-related transaction orders group=tradeApi version=0.0.1 bizType=tradeapi.app.OrderApiService.getPositionDealDetailList tags: - Trade/Stock parameters: [] requestBody: content: application/json: schema: type: object properties: tradeType: type: integer format: long title: Game ID description: Should be filled in as 6 for this gameplay positionId: type: integer format: long title: Position ID required: - tradeType - positionId example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string title: Module identifier code code: type: string title: Status return code msg: type: string title: Status description tm: type: integer format: int64 title: Processing time (milliseconds) trace: type: string title: Tracking code msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas ok: type: boolean fail: type: boolean data: type: object properties: direction: type: integer title: Order buy/sell direction format: int32 description: 1-Buy; 2-Sell; executeTime: type: integer format: long title: Transaction time description: 13-digit timestamp executePrice: type: string title: Average transaction price executeNumber: type: string title: Transaction Quantity executeAmount: type: string title: Deal amount title: Data Body headers: {} security: [] /global/tradeapi.app.StockPositionApiService.queryPositionDetail: post: summary: Position Details deprecated: false description: |- Description: Query position details group=tradeApi version=0.0.1 bizType=tradeapi.app.PositionApiService.queryPositionDetail tags: - Trade/Stock parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: group in: header description: '' required: false example: tradeApi schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: tradeType: type: integer title: Game ID description: Should be filled in as 6 for this gameplay format: long accountId: type: integer title: Account ID format: long positionId: type: integer title: Position ID format: long required: - tradeType - positionId example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string title: Module identifier code code: type: string title: Status return code msg: type: string title: Status description tm: type: integer format: int64 title: Processing time (milliseconds) trace: type: string title: Tracking code msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas ok: type: boolean fail: type: boolean data: type: object properties: positionId: type: integer title: Position ID format: long orderId: type: integer title: Order ID format: long dealId: type: integer title: Deal ID format: long status: type: string title: Position status description: >- 0-Initialization; 1-Position holding; 2-Completed; 3-Partial closing; direction: type: integer format: int32 title: Buy/Sell Direction description: 1-Buy; 2-Sell; symbolId: type: integer title: Product ID format: long symbolName: type: string title: Product name openAccountDigits: type: integer title: Account decimal places for opening format: int32 openSymbolDigits: type: integer format: int32 title: Product decimal places for opening openContractSize: type: integer format: int32 title: Contract size openPrice: type: string title: Opening unit price openNum: type: string title: Opening quantity closeAccountDigits: type: integer title: Account decimal places for closing format: int32 closeSymbolDigits: type: integer title: Product decimal places for closing format: int32 closePrice: type: string title: Closing unit price closeFreeDigits: type: string title: Closing commission decimal places profit: type: string title: Profit and Loss openMargin: type: string title: Opening margin used stopLoss: type: string title: Stop loss unit price description: Original registered value, untreated takeProfit: type: string title: Take profit unit price description: Original registered value, untreated remark: type: string title: Remarks margin: type: string title: Real-time margin used openTime: type: integer format: long title: Opening time description: 13-digit timestamp closeTime: type: integer format: long title: Closing time description: 13-digit timestamp openFee: type: string title: Opening commission closeFee: type: string title: Closing commission closeNum: type: string title: Closing quantity openVolume: type: string title: Opening lots closeVolume: type: string title: Closing lots minVolume: type: string title: Minimum lots per side stopLossDecimal: type: string title: Stop loss unit price description: >- `stopLoss` processed based on `closeSymbolDigits`. Used for direct display on the frontend takeProfitDecimal: type: string title: Take profit unit price description: >- `takeProfit` processed based on `closeSymbolDigits`. Used for direct display on the frontend volume: type: string title: Lots marginSetType: type: string title: Margin type description: 1-Ratio; 2-Range; title: Data Body headers: {} security: [] /global/tradeapi.app.StockPositionApiService.queryPositionPage: post: summary: Position List deprecated: false description: |- Description: Query position list group=tradeApi version=0.0.1 bizType=tradeapi.app.PositionApiService.queryPositionPage tags: - Trade/Stock parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: group in: header description: '' required: false example: tradeApi schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: tradeType: type: integer title: Game ID description: Should be filled in as 6 for this gameplay format: long accountId: type: integer title: Account ID format: long status: type: integer format: int32 title: Position status description: 1-Position Holding; 3-Partial Closing; orderId: type: integer title: Order ID format: long dealId: type: integer format: long title: Deal ID symbolId: type: integer format: long title: Product ID startTime: type: integer title: Start Time format: long description: 13-digit timestamp endTime: type: integer format: long title: End Time description: 13-digit timestamp sortFieldName: type: string title: Sort field name description: >- orderId-Order Id; openTime-Execution Time; symbolId-Product Id; pnl-Profit and Loss; sortType: type: string title: Sort method description: asc-Ascending Order; desc-Descending Order; (default desc) required: - tradeType example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string title: Module identifier code code: type: string title: Status return code msg: type: string title: Status description tm: type: integer format: int64 title: Processing time (milliseconds) trace: type: string title: Tracking code msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas ok: type: boolean fail: type: boolean data: type: array items: type: object properties: positionId: type: integer title: Position ID format: long orderId: type: integer title: Order ID format: long dealId: type: integer title: Deal ID format: long status: type: string title: Position status description: >- 0-Initialization; 1-Position holding; 2-Completed; 3-Partial closing; direction: type: integer format: int32 title: Buy/Sell Direction description: 1-Buy; 2-Sell; symbolId: type: integer title: Product ID format: long symbolName: type: string title: Product name openAccountDigits: type: integer title: Account decimal places for opening format: int32 openSymbolDigits: type: integer format: int32 title: Product decimal places for opening openContractSize: type: integer format: int32 title: Contract size openPrice: type: string title: Opening unit price openNum: type: string title: Opening quantity closeAccountDigits: type: integer title: Account decimal places for closing format: int32 closeSymbolDigits: type: integer title: Product decimal places for closing format: int32 closePrice: type: string title: Closing unit price closeFreeDigits: type: string title: Closing commission decimal places profit: type: string title: Profit and Loss openMargin: type: string title: Opening margin used stopLoss: type: string title: Stop loss unit price description: Original registered value, untreated takeProfit: type: string title: Take profit unit price description: Original registered value, untreated remark: type: string title: Remarks margin: type: string title: Real-time margin used openTime: type: integer format: long title: Opening time description: 13-digit timestamp closeTime: type: integer format: long title: Closing time description: 13-digit timestamp openFee: type: string title: Opening commission closeFee: type: string title: Closing commission closeNum: type: string title: Closing quantity openVolume: type: string title: Opening lots closeVolume: type: string title: Closing lots minVolume: type: string title: Minimum lots per side stopLossDecimal: type: string title: Stop loss unit price description: >- `stopLoss` processed based on `closeSymbolDigits`. Used for direct display on the frontend takeProfitDecimal: type: string title: Take profit unit price description: >- `takeProfit` processed based on `closeSymbolDigits`. Used for direct display on the frontend volume: type: string title: Lots marginSetType: type: string title: Margin type description: 1-Ratio; 2-Range; title: Data Body headers: {} security: [] /global/tradeapi.app.StockOrderApiService.queryCapitalFlowList: post: summary: Fund Flow deprecated: false description: >- Explanation: Pagination query account capital flow group=tradeApi version=0.0.1 bizType=tradeapi.app.OrderApiService.queryCapitalFlowList tags: - Trade/Stock parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: group in: header description: '' required: false example: tradeApi schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: tradeType: type: integer title: Game ID description: Should be filled in as 6 for this gameplay format: long accountId: type: integer format: long title: Account ID size: type: integer title: Number of data entries per page format: long current: type: integer title: Current Page format: long businessType: type: integer format: int32 title: Business type description: >- 0-Unlimited; 601-Deposit; 602-Withdrawal; 603-Limit Adjustment; 604-Freeze; 605-Collateral; 606-Trade; 607-Borrow; 608-Repayment; 609-Transfer; 610-Interest Calculation; 611-Interest Settlement; 612-Reward; 613-System Clearing; 614-Company Action; status: type: integer format: int32 title: Status description: >- 0-Unrestricted; 1-Initialization; 2-Processing successful; 3-Processing failed; startTime: type: integer format: long description: 13-digit timestamp title: Start time endTime: type: integer format: long description: 13-digit timestamp title: End Time operate: type: integer format: int32 title: Capital flow description: 0-Unrestricted; 1-Increase; 2-Decrease; assetsId: type: integer format: long title: Asset ID lang: type: string title: Language required: - tradeType example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string title: Module identifier code code: type: string title: Status return code msg: type: string title: Status description tm: type: integer format: int64 title: Processing time (milliseconds) trace: type: string title: Tracking code msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas ok: type: boolean fail: type: boolean data: type: object properties: total: type: integer title: Total format: long size: type: integer format: long title: Number of Items per Page current: type: integer format: long title: Current Page records: type: array items: type: object properties: remark: type: string title: Remarks createTime: type: integer title: Creation date description: 13-digit timestamp format: long updateTime: type: integer format: long title: Update Time description: 13-digit timestamp subjectId: type: integer format: long title: Subject ID bookkeepId: type: integer format: long title: Voucher ID amountIn: type: string title: Increase amount amountOut: type: string title: Decrease amount status: type: integer format: int32 title: Status description: >- 1-Initialization; 2-Processing successful; 3-Processing failed; amountAfter: type: string title: Balance after change businessType: type: integer title: Business type format: int32 description: >- 601-Deposit; 602-Withdrawal; 603-Limit adjustment; 604-Freeze; 605-Collateral; 606-Transaction; 607-Borrowing; 608-Repayment; 609-Transfer; 610-Interest calculation; 611-Interest settlement; 612-Reward; 613-System reset; 614-Company action; businessType1: type: integer format: int32 description: >- 60101-Front-end deposit; 60102-Deposit fee; 60201-Front-end withdrawal; 60202-Cancel withdrawal; 60203-Withdrawal fee; 60204-Cancel fee; 60205-Transfer confirmation; 60301-Limit adjustment_deposit; 60302-Limit adjustment_withdrawal; 60303-Limit adjustment_other; 60304-Limit adjustment_bonus; 60305-Limit adjustment_release non-withdrawable; 60306-Limit adjustment_non-withdrawable; 60307-Commission transfer in; 60401-Freeze; 60402-Unfreeze; 60501-Collateral freeze; 60502-Collateral unfreeze; 60601-Transaction credit amount; 60602-Transaction debit amount; 60603-Transaction fee; 60701-Automatic borrowing; 60801-Automatic repayment; 60802-Force liquidation repayment; 60901-Transfer in amount; 60902-Transfer out amount; 61001-Margin financing interest calculation; 61101-Margin financing interest settlement; 61201-Reward distribution; 61202-Reward deduction; 61203-Commission distribution; 61204-Commission deduction; 61301-System reset; 61401-Dividend amount; 61402-Dividend fee; title: Business Subtype customerNo: type: string title: Client number digits: type: string title: Decimal Places currency: type: string title: Currency businessTypeName: type: string title: Business Type Name description: Confirm language by passing in `lang` businessType1Name: type: string title: Business Subtype Name description: Confirm language by passing in `lang` accountId: type: integer title: Account Id format: long title: Data Body title: Transaction Collection headers: {} security: [] /global/tradeapi.app.StockAccountApiService.queryAccountAssetsInfo: post: summary: Asset information deprecated: false description: |- Explanation: Query account asset information group=tradeApi version=0.0.1 bizType=tradeapi.app.AccountApiService.queryAccountAssetsInfo tags: - Trade/Stock parameters: - name: companyId in: header description: '' required: false example: '{{company}}' schema: type: string - name: token in: header description: '' required: false example: '{{LoginResult.data.token}}' schema: type: string - name: lang in: header description: '' required: false example: en-US schema: type: string - name: group in: header description: '' required: false example: tradeApi schema: type: string - name: trace in: header description: '' required: false example: '{{mock_trace}}' schema: type: string - name: version in: header description: '' required: false example: 0.0.1 schema: type: string requestBody: content: application/json: schema: type: object properties: tradeType: type: integer title: Game ID description: Should be filled in as 6 for this gameplay format: long currencyCode: type: string title: Asset code required: - tradeType - currencyCode example: '' responses: '200': description: '' content: application/json: schema: type: object properties: bizCode: type: string title: Module identifier code code: type: string title: Status return code msg: type: string title: Status description tm: type: integer format: int64 title: Processing time (milliseconds) trace: type: string title: Tracking code msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas ok: type: boolean fail: type: boolean data: type: object properties: companyId: type: integer title: Company Id format: long tradeType: type: integer format: long title: Game ID accountId: type: integer format: long title: Account Id customerNo: type: string title: Client number customerId: type: integer format: long title: Client ID digits: type: integer format: int32 title: Account Decimal Places assetsId: type: integer format: long title: Asset ID currency: type: string title: Account currency balance: type: string title: Account balance lockAmount: type: string title: Locked amount positionMarketValue: type: string title: Position Market Value positionBuyMarketValue: type: string title: Buy Position Market Value positionSellMarketValue: type: string title: Sell Position Market Value equity: type: string title: Net Value pnl: type: string title: Account Profit and Loss liabilitiesPrincipal: type: string title: Debt Principal margin: type: string title: Initial Margin warningMargin: type: string title: Warning Margin maintainMargin: type: string title: Maintenance Margin maxDayPurchasePower: type: string title: Maximum Intraday Buying Power maxNightPurchasePower: type: string title: Maximum Overnight Buying Power withdrawAmount: type: string title: Cash Withdrawal residualLiquidity: type: string title: Remaining Liquidity riskLevel: type: integer format: int32 title: Risk Control Status description: 1-Safe; 2-Warning; 3-Danger; crossLevel: type: string title: Leverage ratio headers: {} security: [] components: schemas: BaseResultBasePageVoAmmSymbolInfoVo: &ref_40 type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: $ref: '#/components/schemas/BasePageVoAmmSymbolInfoVo' ok: type: boolean fail: type: boolean BasePageVoAmmSymbolInfoVo: type: object properties: records: type: array description: Result list items: &ref_38 $ref: '#/components/schemas/AmmSymbolAmountVo' total: type: integer format: int64 description: Total size: type: integer format: int64 description: Number of Items per Page current: type: integer format: int64 description: Current Page AmmSymbolAmountVo: type: object properties: symbolId: type: integer format: uint64 description: Product ID symbolSourceCode: type: string description: Product quote sourceId baseCurrency: type: string description: Base Currency profitCurrency: type: string description: Profit and Loss Currency symbolDigits: type: integer format: uint64 description: Number of decimal places for product quotes marketMaker: type: object properties: companyId: type: integer format: uint64 description: Company ID customerNo: type: string description: Maker customer number customerId: type: integer format: uint64 description: Maker customer id customerGroupId: type: integer format: uint64 description: Maker customer group id accountId: type: integer format: uint64 description: Maker account id lastPriceAsBid: type: boolean description: >- Whether to use the latest transaction price in the bid as the first level lastPrice: type: string description: >- Latest transaction price, empty indicates that the market maker account is newly added for the second time maxLimitPrice: type: string description: Highest price minLimitPrice: type: string description: Lowest price priceInterval: type: string description: Price interval minVolume: type: string description: Minimum trading volume contractSize: type: integer format: uint64 description: Contract size, used to calculate order quantity overHeightSize: type: integer format: uint32 description: Threshold for canceling orders exceeding the number of levels amount: type: string description: Market-making fund amount currency: type: string description: Market-making fund currency digits: type: integer format: uint32 description: Market-making fund account decimal places perHeightAmount: type: string description: Market-making strategy amount per tier createTime: type: integer format: uint64 description: Creation time updateTime: type: integer format: uint64 description: Update Time status: type: integer format: uint32 description: 'Status, 0: Stop, 1: Running, 2: Pause' description: Market maker configuration information required: - customerNo - customerId - customerGroupId - accountId - maxLimitPrice - minLimitPrice - priceInterval - minVolume - contractSize - overHeightSize - amount - currency - digits - perHeightAmount - createTime - status bidTotalAmount: type: string description: Long fund amount (account currency) askTotalAmount: type: string description: Short fund amount (account currency) bids: type: array items: type: object properties: price: type: string description: Price amount: type: string description: Amount (account currency) quantity: type: string description: Quantity required: - price - amount - quantity description: Buy tier price and fund amount details asks: type: array items: type: object properties: price: type: string description: Price amount: type: string description: Amount (account currency) quantity: type: string description: Quantity required: - price - amount - quantity description: Sell tier price and fund amount details required: - symbolId - symbolSourceCode - baseCurrency - profitCurrency - symbolDigits - marketMaker - bidTotalAmount - askTotalAmount - bids - asks MarketMakerInfoVo2: type: object properties: companyId: type: integer format: uint64 description: Company ID customerNo: type: string description: Maker customer number customerId: type: integer format: uint64 description: Maker customer id customerGroupId: type: integer format: uint64 description: Maker customer group id accountId: type: integer format: uint64 description: Maker account id lastPriceAsBid: type: boolean description: >- Whether to use the latest transaction price in the bid as the first level lastPrice: type: string description: >- Latest transaction price, empty indicates that the market maker account is newly added for the second time maxLimitPrice: type: string description: Highest price minLimitPrice: type: string description: Lowest price priceInterval: type: string description: Price interval minVolume: type: string description: Minimum trading volume contractSize: type: integer format: uint64 description: Contract size, used to calculate order quantity overHeightSize: type: integer format: uint32 description: Threshold for canceling orders exceeding the number of levels amount: type: string description: Market-making fund amount currency: type: string description: Market-making fund currency digits: type: integer format: uint32 description: Market-making fund account decimal places perHeightAmount: type: string description: Market-making strategy amount per tier createTime: type: integer format: uint64 description: Creation time updateTime: type: integer format: uint64 description: Update Time status: type: integer format: uint32 description: 'Status, 0: Stop, 1: Running, 2: Pause' required: - priceInterval - minVolume - maxLimitPrice - minLimitPrice - amount - currency - digits - perHeightAmount - createTime - status - customerNo - customerId - customerGroupId - accountId - contractSize - overHeightSize BaseResultAmmSymbolAmountVo: type: object properties: bizCode: type: string title: Module identifier code code: type: string title: Status return code msg: type: string title: Status description tm: type: integer format: int64 title: Processing time (milliseconds) trace: type: string title: Tracking code msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas ok: type: boolean fail: type: boolean data: *ref_38 title: '' BaseResultListFundPayChannelTypeDto: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: array description: Data Body items: $ref: '#/components/schemas/FundPayChannelTypeDto' ok: type: boolean fail: type: boolean FundPayChannelTypeDto: type: object properties: name: type: string description: name code: type: string description: code QueryPayChannelTypeDto: type: object properties: country: type: string description: Country Code paymentChannelCode: type: string description: Payment channel code paymentChannelType: type: string description: Payment channel type paymentMerchantNo: type: string description: Payment merchant number paymentChannelClientType: type: string description: Payment channel client type pc, mobile required: - country - paymentChannelCode - paymentChannelType - paymentMerchantNo - paymentChannelClientType BaseResultCustomerStatusVO: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: $ref: '#/components/schemas/CustomerStatusVO' ok: type: boolean fail: type: boolean CustomerStatusVO: type: object properties: status: type: integer format: int32 description: Whether the customer exists, 1 exists, 2 does not exist, -1 disabled country: type: string description: Country phoneArea: type: string description: Phone area code BaseResultCustomerDepositProposalDto: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: &ref_48 $ref: '#/components/schemas/CustomerDepositProposalDto' ok: type: boolean fail: type: boolean CustomerDepositProposalDto: type: object required: - tradeType properties: companyId: type: integer format: int64 description: Company ID customerId: type: integer format: int64 description: Client ID customerNo: type: string description: Client number accountId: type: integer format: int64 description: Account ID status: type: integer format: int32 description: Status 1, 2, 3, enable, disable, delete createBy: type: string description: Creator createTime: type: integer format: int64 description: Creation time updateBy: type: string description: Updater updateTime: type: integer format: int64 description: Update Time tradeType: type: integer format: int64 proposalNo: type: string description: Proposal number country: type: string description: Country (Country where the customer account is opened) depositCurrency: type: string description: Account currency (trading account currency) paymentCurrency: type: string description: Deposit currency (Currency supported by the payment channel) blockchainName: type: string description: >- Chain name, data dictionary configuration, payment method is digital wallet, display the corresponding chain name (also known as transfer network), such as Omin, ERC20, TRC20 intendAmount: type: string description: Proposal amount (amount received by the platform) toPaymentRate: type: string description: Deposit exchange rate used for payment platform toPaymentAmount: type: string description: >- Amount sent to the payment platform (amount received by the payment channel) fromPaymentAmount: type: string description: >- Amount received from the payment platform (amount notified by the payment channel callback) paymentRate: type: string description: >- Deposit exchange rate submitted when generating the deposit proposal, the exchange rate should be changed to the rate at the time of payment notification after the customer pays actualAmount: type: string description: Actual deposit amount depositFee: type: string description: Deposit fee finalAmount: type: string description: Final credited amount paymentCode: type: string description: Payment channel code paymentType: type: string description: Payment channel type clientType: type: string description: >- Deposit source (terminal types H5_Android, H5_IOS, PCUI_Windows, PCUI_Mac, APP_Android, APP_IOS) channelCode: type: string description: Advertising Source (Customer Account Opening Channel Code) checkBy: type: string description: Approver remark: type: string description: Remarks checkStatus: type: integer format: int32 description: >- Proposal Status, Pending Approval: 1, Approval Successful: 2, Approval Failed: 3, Proposal Invalid: 4 depositStatus: type: integer format: int32 description: >- Deposit Status, Pending Deposit: 1, Deposit Successful: 2, Deposit Failed: 3 paymentStatus: type: integer format: int32 description: >- Payment Status, Pending Payment: 1, Payment Successful: 2, Payment Failed: 3 amlRet: type: integer format: int32 description: 'AML Verification Result AmlCheckRetEnum: Passed 1, Failed 2' amlFailReasion: type: string description: Reasons for AML Verification Failure refundRet: type: integer format: int32 description: >- Refund to Payment Channel: Pending Refund 1, Submission Successful 2, Submission Return Failed 3, Call Exception 4, Refund Successful 5, Refund Failed 6 notifyStatus: type: boolean description: 'Payment Notification Status 0: Not Notified, 1: Notified' queryCount: type: integer format: int32 description: Number of Times Reconciliation has been Queried queryMaxCount: type: integer format: int32 description: Maximum Number of Times Reconciliation can be Queried txid: type: string description: txid rechargeType: type: string description: 'Recharge Method, 1: Direct Recharge, 2: Remittance' address: type: string description: Receiving address thirdId: type: string description: Third-party record id callbackUrl: type: string description: Front-end callback address refundToAddr: type: string description: Refund entry address customerGroupId: type: integer format: int64 description: Customer group ID thirdAccount: type: string description: Third-party account QueryCustomerDepositProposalReqDto: type: object required: - tradeType properties: tradeType: type: integer format: int64 description: Game type proposalNo: type: string description: Proposal number AddAmmAmountDto: type: object properties: symbolId: type: integer description: Product ID format: uint64 amount: type: string description: Market making funds accountId: type: integer description: Account ID format: int64 required: - symbolId - amount - accountId ManualRepaymentDto: &ref_39 type: object required: - accountCurrency - amount - tradeType properties: tradeType: type: integer format: int64 description: Game type accountCurrency: type: string description: Account currency amount: type: number description: Amount AddAmmMakerDto: type: object properties: symbolId: type: integer description: Product ID format: uint64 strategy: type: string const: fix_total_amount description: Strategy code, currently fixed value fix_total_amount maxLimitPrice: type: string description: Highest price minLimitPrice: type: string description: Lowest price priceInterval: type: string description: Price interval per tier amount: type: string description: Market making funds accountId: type: integer format: int64 description: Account ID required: - symbolId - strategy - maxLimitPrice - minLimitPrice - priceInterval - amount - accountId ManualLoanDto: *ref_39 BaseResultAmmSymbolInfoVo: type: object properties: bizCode: type: string title: Module identifier code code: type: string title: Status return code msg: type: string title: Status description tm: type: integer format: int64 title: Processing time (milliseconds) trace: type: string title: Tracking code msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas ok: type: boolean fail: type: boolean data: title: Data Body $ref: '#/components/schemas/AmmSymbolInfoVo' title: '' AmmSymbolInfoVo: type: object properties: symbolId: type: integer format: uint64 description: Product ID symbolSourceCode: type: string description: Product quote sourceId baseCurrency: type: string description: Base Currency profitCurrency: type: string description: Profit and Loss Currency symbolDigits: type: integer format: uint64 description: Number of decimal places for product quotes marketMaker: $ref: '#/components/schemas/MarketMakerInfoVo2' required: - symbolId - symbolSourceCode - baseCurrency - profitCurrency - symbolDigits - marketMaker BaseResultBasePageVoMMBotConfVo: *ref_40 BaseResultQueryCoinPayStatusRespDto: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: $ref: '#/components/schemas/QueryCoinPayStatusRespDto' ok: type: boolean fail: type: boolean QueryCoinPayStatusRespDto: type: object properties: accountCurrency: type: string description: Account Currency Code channelCode: type: string description: Channel code blockchainName: type: string description: Chain Name address: type: string description: Payment address tradeStatus: type: integer format: int32 description: >- Transaction status 0:Pending, 1:In progress, 2:Completed, 3:Payment failed txId: type: string description: Transaction id amount: type: string description: Transaction Amount proposalNo: type: string description: Deposit proposal number QueryCoinPayStatusReqDto: type: object required: - accountCurrency - blockchainName - channelCode properties: accountCurrency: type: string description: Account Currency Code channelCode: type: string description: Channel code blockchainName: type: string description: Chain Name address: type: string description: Payment address BaseResultMMBotConfVo: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: $ref: '#/components/schemas/MMBotConfVo' ok: type: boolean fail: type: boolean MMBotConfVo: type: object properties: symbolId: type: integer format: int64 description: Product ID symbolSourceCode: type: string description: Product quote source code strategy: type: string description: Market-making strategy baseCurrency: type: string description: Product base currency code profitCurrency: type: string description: Product profit and loss currency code lastPriceAsBid: type: boolean description: >- Whether to use the latest transaction price in the bid as the first level lastPrice: type: number description: Latest transaction price maxLimitPrice: type: number description: High price minLimitPrice: type: number description: High and low grid priceInterval: type: number description: Price interval value minVolume: type: number description: Minimum transaction volume contractSize: type: integer format: int64 description: Contract size symbolDigits: type: string description: Product Quote Decimal Places supplyHeight: type: string description: Minimum number of offer levels cancelHeight: type: string description: Maximum number of withdrawal levels marketMaker: $ref: '#/components/schemas/MarketMakerInfoVo' description: Market maker account information required: - symbolId - symbolSourceCode - strategy - baseCurrency - profitCurrency - lastPriceAsBid - lastPrice - maxLimitPrice - minLimitPrice - priceInterval - minVolume - contractSize - symbolDigits - supplyHeight - cancelHeight - marketMaker MarketMakerInfoVo: type: object properties: companyId: type: integer description: Company ID format: int64 customerNo: type: string description: Market maker client number customerId: type: integer description: Market maker client ID format: int64 customerGroupId: type: integer description: Market maker client group ID format: int64 accountId: type: integer description: Market maker account ID format: int64 amount: type: number description: Market making amount currency: type: string description: Account asset currency digits: type: integer description: Account asset decimal places format: int32 createTime: type: integer format: uint64 description: Creation time paused: type: boolean description: Whether to pause required: - companyId - customerNo - customerId - customerGroupId - accountId - amount - currency - digits - createTime - paused BaseResultListQueryCustomerPaymentChannelRespV3Dto: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: array description: Data Body items: $ref: '#/components/schemas/QueryCustomerPaymentChannelRespV3Dto' ok: type: boolean fail: type: boolean QueryCustomerPaymentChannelRespV3Dto: type: object required: - tradeType properties: tradeType: type: integer format: int64 description: Game type customerGroupId: type: integer format: int64 description: Customer group ID paymentCode: type: string description: Payment channel code paymentType: type: string description: Payment channel type paymentTypeAlias: type: string description: Payment channel type alias clientType: type: string description: Payment channel supports terminal types pc, mobile paymentCurrency: type: string description: Payment currency code merchantNo: type: string description: Channel merchant number channelConvertRate: type: boolean description: Payment channel completion exchange rate conversion openTime: type: string description: Deposit time, format is 01:00-12:00,13:00-18:00,19:00-22:00 sort: type: integer format: int32 description: Sort extend: type: object description: Expand data additionalProperties: type: object additionalProperties: type: string properties: {} rechargeType: type: string description: >- Multiple recharge methods separated by commas, 1: Direct recharge, 2: Exchange limitConfigList: type: array items: $ref: '#/components/schemas/CustomerGroupDepositLimitConfigV3Vo' CustomerGroupDepositLimitConfigV3Vo: type: object properties: id: type: integer format: int64 description: Primary key id companyId: type: integer format: int64 description: Company ID depositBaseConfigId: type: integer format: int64 description: >- Basic configuration ID of the company customer group deposit payment channel accountCurrency: type: string description: Account currency singleLowAmount: type: string description: Minimum deposit amount per transaction singleHighAmount: type: string description: Maximum deposit amount per transaction singleCheckLowAmount: type: string description: Minimum deposit amount per transaction for manual review feeType: type: integer format: int32 description: Fee type, fixed amount 'fix', percentage rate 'rate' fee: type: string description: Commission fee rechargeType: type: string description: >- Recharge methods, connected by commas, 1: Direct recharge, 2: Exchange QueryCustomerPaymentChannelReqV3Dto: type: object required: - customerGroupId - tradeType properties: tradeType: type: integer format: int64 description: Game type customerGroupId: type: integer format: int64 description: Customer group ID clientType: type: string description: Payment channel supports terminal types pc, mobile accountCurrency: type: string description: Account currency code blockchainName: type: string description: Connection name country: type: string description: Customer opening country code BaseResultQueryRemainWithdrawAmountRespDto: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: $ref: '#/components/schemas/QueryRemainWithdrawAmountRespDto' ok: type: boolean fail: type: boolean QueryRemainWithdrawAmountRespDto: type: object required: - tradeType - remainAmount - limitAmount - withdrawAmount properties: tradeType: type: integer format: int64 customerGroupId: type: integer format: int64 description: Customer group ID country: type: string description: Country Code accountCurrency: type: string description: Account Currency Code withdrawCurrency: type: string description: Customer receiving currency code withdrawMethod: type: string description: 'Withdrawal method, bank card: bank, digital wallet: digit_wallet' withdrawType: type: integer format: int32 description: 'Withdrawal type, bank card: 1, digital wallet: 2' blockchainName: type: string description: >- Chain name, data dictionary configuration, payment method is digital wallet, display the corresponding chain name (also known as transfer network), such as Omin, ERC20, TRC20 remainAmount: type: string description: 24-hour cumulative remaining withdrawal amount limitAmount: type: string description: 24-hour cumulative maximum amount withdrawAmount: type: string description: 24-hour cumulative amount already withdrawn QueryRemainWithdrawAmountReqDto: type: object required: - withdrawType - withdrawMethod - accountCurrency properties: withdrawType: type: integer format: int32 description: 'Withdrawal type, bank card: 1, digital wallet: 2' withdrawMethod: type: string description: Withdrawal method, coin_blockatmpay, coin_mdpay, etc. accountCurrency: type: string description: Account Currency Code withdrawCurrency: type: string description: Required when witdrawType is 2, customer receiving currency code blockchainName: type: string description: >- When witdrawType is 2, it is required. Chain name, data dictionary configuration, payment method is digital wallet, display the corresponding chain name (also known as transfer network), such as Omin, ERC20, TRC20 BaseResultQueryEquityPremiumRateVo: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: $ref: '#/components/schemas/QueryEquityPremiumRateVo' ok: type: boolean fail: type: boolean QueryEquityPremiumRateVo: type: object properties: companyId: type: integer format: int64 description: Company ID tradeType: type: integer format: int64 description: Game ID customerNo: type: string description: Client number currency: type: string description: Currency digits: type: integer format: int32 description: Funds decimal places currentNav: type: string description: Real-time Net Asset Value totalBalance: type: string description: Total assets premiumRate: type: string description: Premium Rate accountInfoMap: type: object description: With Account Information additionalProperties: $ref: '#/components/schemas/PremiumRate' properties: {} newShare: type: string description: Latest share markerCustomer: type: boolean description: Marker Account PremiumRate: type: object properties: companyId: type: integer format: int64 description: Company ID tradeType: type: integer format: int64 description: Game ID accountId: type: integer format: int64 description: System unique account identifier customerNo: type: string description: Client number assetsId: type: integer format: int64 description: Asset ID currency: type: string description: Account currency digits: type: integer format: int32 description: Funds decimal places wholeWarehouseBalance: type: string description: Current Account to Full Position Account Currency wholeWarehouseRate: type: string description: Current Account to Full Position Account Exchange Rate weight: type: string description: Weight QueryWithdrawRiskConfigReqDto: type: object properties: customerGroupId: type: integer format: int64 description: Customer group ID required: - customerGroupId BaseResultWithdrawCurrencyResDto: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: $ref: '#/components/schemas/WithdrawCurrencyResDto' ok: type: boolean fail: type: boolean WithdrawCurrencyResDto: type: object properties: list: type: array items: $ref: '#/components/schemas/WithdrawCurrencyListResDto' map: type: object additionalProperties: type: object additionalProperties: type: string properties: {} WithdrawCurrencyListResDto: type: object properties: currency: type: string withdrawMethod: type: string QueryCustomerPaymentChannelReqV2Dto: type: object required: - clientType - country - customerGroupId - tradeType properties: tradeType: type: integer format: int64 description: Game type customerGroupId: type: integer format: int64 description: Customer group ID paymentCode: type: string description: Payment channel code clientType: type: string description: Payment channel supports terminal types pc, mobile paymentCurrency: type: string description: Payment currency code accountCurrency: type: string description: Account currency code country: type: string description: Customer opening country code rechargeType: type: string description: 'Recharge Method, 1: Direct Recharge, 2: Remittance' BaseResultQueryWithdrawLimitConfigRespDto: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: $ref: '#/components/schemas/QueryWithdrawLimitConfigRespDto' ok: type: boolean fail: type: boolean QueryWithdrawLimitConfigRespDto: type: object properties: enableWithdraw: type: boolean description: Allow Withdrawal withdrawAmount: type: string description: Account Withdrawable Amount digit: type: integer format: int32 withdrawConditionConfig: $ref: '#/components/schemas/CustomerGroupWithdrawConditionConfigDto' withdrawTimeConfigList: type: array description: Withdrawal Time Limit Configuration items: $ref: '#/components/schemas/CustomerGroupWithdrawTimeConfigDto' withdrawAmountConfig: $ref: '#/components/schemas/CustomerGroupWithdrawAmountConfigDto' withdrawFeeConfigList: type: array description: Withdrawal Fee Configuration items: $ref: '#/components/schemas/CustomerGroupWithdrawFeeConfigDto' customerGroupEnable: type: boolean description: Customer Group Allow Withdrawal timeEnable: type: boolean description: Withdrawal Time Allow Withdrawal accountActiveEnable: type: boolean description: Account Must Be Activated Allow Withdrawal amountEnable: type: boolean description: Customer Account Balance Allow Withdrawal hourIn24Enable: type: boolean description: Within 24 Hours Number Allow Withdrawal walletEnable: type: boolean description: Allow Withdrawal of Coins pwdModifyEnable: type: boolean description: Interval After Changing Password Allow Withdrawal loginModifyEnable: type: boolean description: >- Is the interval time allowed for withdrawal after changing phone number/email? CustomerGroupWithdrawFeeConfigDto: type: object properties: customerGroupId: type: integer format: int64 description: Company client group id accountCurrency: type: string description: Account currency withdrawCurrency: type: string description: Withdrawal currency blockchainName: type: string description: Blockchain name valueType: type: string description: >- Value type, single withdrawal amount: single_amount, total open margin/deposit amount (ratio): open_margin_rate, number of withdrawals within 24 hours: with24hour_times leftOpenValue: type: number description: Interval left value rightCloseValue: type: number description: Interval right value feeType: type: integer format: int32 description: 'Fee type, fixed amount: 1, percentage rate: 2' feeValue: type: number description: Fee fixed amount value/ratio value withdrawMethod: type: string description: 'Withdrawal method, bank card: bank, digital wallet: digit_wallet' CustomerGroupWithdrawAmountConfigDto: type: object properties: customerGroupId: type: integer format: int64 description: Company client group id accountCurrency: type: string description: Account currency withdrawCurrency: type: string description: Withdrawal currency (currency supported by payment channels) blockchainName: type: string description: >- Chain name, data dictionary configuration, payment method is digital wallet, display the corresponding chain name (also known as transfer network), such as Omin, ERC20, TRC20 singleLowAmount: type: number description: Minimum withdrawal amount per transaction singleHighAmount: type: number description: Maximum single withdrawal amount singleCheckLowAmount: type: number description: Minimum withdrawal amount requiring manual review maxIn24hourAmount: type: number description: Maximum withdrawal amount within 24 hours withdrawMethod: type: string description: 'Withdrawal method, bank card: bank, digital wallet: digit_wallet' CustomerGroupWithdrawTimeConfigDto: type: object properties: customerGroupId: type: integer format: int64 description: Company client group id companyTimezone: type: string description: Company operating time zone weekDay: type: integer format: int32 description: Day of the week openTime: type: string description: Withdrawal time, format as 01:00-12:00, 13:00-18:00, 19:00-22:59 withdrawMethod: type: string description: 'Withdrawal method, bank card: bank, digital wallet: digit_wallet' CustomerGroupWithdrawConditionConfigDto: type: object properties: customerGroupId: type: integer format: int64 description: Company client group id mustActive: type: boolean description: Is it necessary for customers to activate before withdrawal? maxCount: type: integer format: int32 description: Number of withdrawals in 24 hours modifyPwdDisableWithdrawIntervals: type: integer format: int64 description: >- Time after changing password when withdrawal is not allowed: in minutes modifyLoginDisableWithdrawIntervals: type: integer format: int64 description: >- Time after changing phone/email when withdrawal is not allowed: in minutes withdrawMethod: type: string description: 'Withdrawal method, bank card: bank, digital wallet: digit_wallet' QueryWithdrawLimitConfigReqDto: type: object required: - tradeType properties: tradeType: type: integer format: int64 customerGroupId: type: integer format: int64 description: Customer group ID country: type: string description: Country Code accountCurrency: type: string description: Account Currency Code withdrawCurrency: type: string description: Customer receiving currency code withdrawMethod: type: string description: 'Withdrawal method, bank card: bank, digital wallet: digit_wallet' withdrawType: type: integer format: int32 description: 'Withdrawal type, bank card: 1, digital wallet: 2' blockchainName: type: string description: >- Chain name, data dictionary configuration, payment method is digital wallet, display the corresponding chain name (also known as transfer network), such as Omin, ERC20, TRC20 BaseResultJSONArray: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: array description: Data Body items: type: object properties: {} ok: type: boolean fail: type: boolean QueryWithdrawBankReqDto: type: object properties: withdrawMethod: type: string description: Withdrawal method withdrawCurrency: type: string description: Withdrawal currency BaseResultListQueryCustomerPaymentChannelRespDto: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: array description: Data Body items: $ref: '#/components/schemas/QueryCustomerPaymentChannelRespDto' ok: type: boolean fail: type: boolean QueryCustomerPaymentChannelRespDto: type: object required: - tradeType properties: tradeType: type: integer format: int64 customerGroupId: type: integer format: int64 description: Customer group ID paymentCode: type: string description: Payment channel code paymentType: type: string description: Payment channel type paymentTypeAlias: type: string description: Payment channel type alias clientType: type: string description: Payment channel supports terminal types pc, mobile paymentCurrency: type: string description: Payment currency code merchantNo: type: string description: Channel merchant number channelConvertRate: type: boolean description: Payment channel completion exchange rate conversion openTime: type: string description: Deposit time, format is 01:00-12:00,13:00-18:00,19:00-22:00 accountCurrency: type: string description: Account currency accountCurrencyDigit: type: integer format: int32 description: Decimal places for account currency assets singleLowAmount: type: number description: Minimum deposit amount per transaction singleHighAmount: type: number description: Maximum deposit amount per transaction singleCheckLowAmount: type: number description: Minimum deposit amount per transaction for manual review feeType: type: integer format: int32 description: Fee type, fixed amount 'fix', percentage rate 'rate' fee: type: number description: Commission fee sort: type: integer format: int32 description: Sort extend: type: object description: Expand data additionalProperties: type: object additionalProperties: type: string properties: {} rechargeType: type: string description: >- Multiple recharge methods separated by commas, 1: Direct recharge, 2: Exchange limitConfigList: type: array items: $ref: '#/components/schemas/CustomerGroupDepositLimitConfigVo' CustomerGroupDepositLimitConfigVo: type: object properties: id: type: integer format: int64 description: Primary key id companyId: type: integer format: int64 description: Company ID depositBaseConfigId: type: integer format: int64 description: >- Basic configuration ID of the company customer group deposit payment channel accountCurrency: type: string description: Account currency singleLowAmount: type: number description: Minimum deposit amount per transaction singleHighAmount: type: number description: Maximum deposit amount per transaction singleCheckLowAmount: type: number description: Minimum deposit amount per transaction for manual review feeType: type: integer format: int32 description: Fee type, fixed amount 'fix', percentage rate 'rate' fee: type: number description: Commission fee rechargeType: type: string description: >- Recharge methods, connected by commas, 1: Direct recharge, 2: Exchange QueryCustomerPaymentChannelReqDto: type: object required: - accountCurrency - clientType - country - customerGroupId - tradeType properties: tradeType: type: integer format: int64 description: Game type customerGroupId: type: integer format: int64 description: Customer group ID paymentCode: type: string description: Payment channel code clientType: type: string description: Payment channel supports terminal types pc, mobile paymentCurrency: type: string description: Payment currency code accountCurrency: type: string description: Account currency code country: type: string description: Customer opening country code rechargeType: type: string description: 'Recharge Method, 1: Direct Recharge, 2: Remittance' BaseResultBasePageVoOpenFundsVo: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: $ref: '#/components/schemas/BasePageVoOpenFundsVo' ok: type: boolean fail: type: boolean BasePageVoOpenFundsVo: type: object properties: records: type: array description: Result list items: &ref_41 $ref: '#/components/schemas/OpenFundsVo' total: type: integer format: int64 description: Total size: type: integer format: int64 description: Number of Items per Page current: type: integer format: int64 description: Current Page OpenFundsVo: type: object properties: fundId: type: integer format: int64 description: Fund ID fundName: type: string description: Fund name fundType: type: string description: Fund type managerName: type: string description: Manager name preShare: type: string description: Issued shares upDate: type: string description: Establishment date shareToken: type: integer format: int64 description: Fund share token shareTokenCode: type: string description: Fund share token code operationMode: type: integer format: int64 description: Operation mode trackIndex: type: integer format: int64 description: Tracking index trackIndexOut: type: string description: External tracking index companyId: type: integer format: int64 description: Fund company ID customerNo: type: string description: Bind fund net worth account settlementCompanyId: type: integer format: int64 description: Fund settlement company ID settlementCustomerNo: type: string description: Bind fund settlement account introduction: type: string description: Fund introduction canPurchase: type: integer format: int32 description: Can it be subscribed. 1-Yes; 2-No; purchaseFeeProportion: type: number description: Subscription fee rate (decimal. One percent = 0.01) purchaseCurrencySetting: type: array description: Subscription asset settings. JSON format items: $ref: '#/components/schemas/PurchaseAssetsSet' canRedemption: type: integer format: int32 description: Can it be redeemed. 1-Yes; 2-No; redemptionFeeProportion: type: number description: Redemption fee rate (decimal. One percent = 0.01) redemptionCurrencySetting: type: array description: Redemption optional currency list items: $ref: '#/components/schemas/RedemptionAssetsSet' minRedemptionNum: type: number description: Minimum redemption share number newShare: type: string description: Latest share managementFee: type: number description: Fund management fee (annual. Decimal. One percent = 0.01) dailySettlementTime: type: integer format: int32 description: Management fee daily settlement time (UTC. Minutes) yearDays: type: integer format: int32 description: Number of days in a year customerId: type: integer format: int64 description: Bind fund net worth account ID settlementCustomerId: type: integer format: int64 description: Bind fund settlement account ID purchaseType: type: integer format: int32 description: >- Subscription method. 1-Subscription by amount; 2-Subscription by share; fundCurrencyList: type: array description: Underlying Asset List items: $ref: '#/components/schemas/BaseAssets' shareTokenDigits: type: integer format: int32 description: Fund Share Token Decimal Places BaseAssets: type: object properties: currencyCode: type: string description: Currency Code currencyName: type: string description: Currency Name weight: type: string description: Weight RedemptionAssetsSet: type: object properties: currencyCode: type: string description: Currency Code currencyName: type: string description: Currency Name minRedemptionAmount: type: number description: Minimum Redemption Amount per Transaction minRedemptionNum: type: number description: Minimum Purchase Share per Transaction redemptionFeeProportion: type: number description: Redemption Fee Rate PurchaseAssetsSet: type: object properties: currencyCode: type: string description: Currency Code currencyName: type: string description: Currency Name minPurchaseAmount: type: number description: Minimum Purchase Amount per Transaction minPurchaseNum: type: number description: Minimum Purchase Share per Transaction purchaseFeeProportion: type: number description: Purchase Fee Rate BaseResultInteger: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: integer format: int32 description: Data Body ok: type: boolean fail: type: boolean BaseResultQueryCustomerDepositExchangeRateDto: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: $ref: '#/components/schemas/QueryCustomerDepositExchangeRateDtoResp' ok: type: boolean fail: type: boolean QueryCustomerDepositExchangeRateDtoResp: type: object properties: paymentCurrency: type: string description: Payment Currency Code accountCurrency: type: string description: Account Currency Code channelCode: type: string description: Payment channel code depositRateSerialNo: type: string description: Serial Number exchangeRate: type: string description: Exchange Rate formulaSymbol: type: string description: Exchange Rate Direction sourceDigits: type: string description: Original Currency Asset Decimal Places targetDigits: type: string description: Target Currency Asset Decimal Places required: - depositRateSerialNo - exchangeRate - formulaSymbol - sourceDigits - targetDigits QueryCustomerDepositExchangeRateDto: type: object properties: paymentCurrency: type: string description: Payment Currency Code accountCurrency: type: string description: Account Currency Code channelCode: type: string description: Payment channel code BaseResultOpenFundsVo: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: *ref_41 ok: type: boolean fail: type: boolean BaseResultListWithdrawMethodQueryDto: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: array description: Data Body items: *ref_18 ok: type: boolean fail: type: boolean WithdrawMethodQueryDto: type: object required: - tradeType properties: tradeType: type: integer format: int64 customerGroupId: type: integer format: int64 description: Customer group ID country: type: string description: Country Code withdrawCurrency: type: string description: Supported Currencies withdrawMethod: type: string description: Withdrawal Method Code channelName: type: string description: Channel Name QueryDepositCoinListDto: type: object required: - clientType - country - customerGroupId - tradeType properties: tradeType: type: integer format: int64 description: Game type customerGroupId: type: integer format: int64 description: Customer group ID clientType: type: string description: Payment channel supports terminal types pc, mobile country: type: string description: Customer opening country code DividendInfo: type: object properties: dividendSymbolName: type: string description: Dividend Stock Name dividendCurrency: type: string description: Dividend Currency dividendDate: type: integer format: int64 description: Action Date dividendLeft: type: string description: Action Type Parameter Value dividendRight: type: string description: Action Type Parameter Value dividendActionType: type: integer format: int32 description: Action Type actionInfo: type: string description: Action Information description: Company Action BorrowAssetsInterest: type: object properties: id: type: integer format: int64 description: ID borrowInterestGroupId: type: integer format: int64 description: Loan Interest Group ID assetsId: type: integer format: int64 description: Asset ID value: type: number description: Loan Interest Rate assetCode: type: string description: Asset CODE description: Loan Interest Rate BorrowStatus: type: object properties: id: type: integer format: int64 description: ID borrowStatusGroupId: type: integer format: int64 description: Asset Borrowable Group ID assetsId: type: integer format: int64 description: Asset ID value: type: integer format: int32 description: Asset Borrowable 1,2, Yes, No description: Asset Borrowable BorrowLimit: type: object properties: id: type: integer format: int64 description: ID borrowListGroupId: type: integer format: int64 description: Loan Interest Group ID assetsId: type: integer format: int64 description: Asset ID value: type: number description: Maximum Loan Limit description: Maximum Loan Limit BorrowInterest: type: object properties: id: type: integer format: int64 description: ID borrowInterestGroupId: type: integer format: int64 description: Loan Interest Group ID assetsId: type: integer format: int64 description: Asset ID value: type: number description: Loan Interest Rate description: Loan Interest Rate QuoteTime: type: object properties: dayOfWeek: type: integer format: int32 description: Day of the Week, 1-7 Monday to Sunday startTime: type: integer format: int64 description: Start Time, in seconds endTime: type: integer format: int64 description: End Time, in seconds description: Market time MarginSet: type: object properties: id: type: string description: Margin ID groupId: type: integer format: int64 description: Margin Group ID rangeLeft: type: number description: Range Start rangeRight: type: number description: Range End percent: type: number description: Per Mille type: type: string description: Type values: type: string description: Value MarginInfo: type: object properties: id: type: string description: Margin ID groupId: type: integer format: int64 description: Margin Group ID type: type: string description: Type values: type: string description: Value rangeLeft: type: number description: Range Start rangeRight: type: number description: Range End percent: type: number description: Per Mille CustomerLoginVO: type: object properties: id: type: integer format: int64 description: Customer ID companyId: type: integer format: int64 description: Company customerGroupId: type: integer format: int64 description: Customer group customerNo: type: string description: Customer account kycAuditStatus: type: integer format: int32 description: >- Registration KYC audit status: 0 uncertified, jump to certification page, 1 pending review, 2 review passed, 3 review failed kycAuditRemark: type: string description: Registration KYC audit remarks, not empty if rejected kycStatus: type: integer format: int32 description: KYC status kycRemark: type: string description: KYC status name accountList: type: object description: Trading Account List properties: {} accountRemark: type: string description: Whether the customer has a trading account note loginPassStatus: type: string description: >- Set password reminder flag, 1 for password required, 2 for not required payPassStatus: type: string description: >- Payment password existence status, 1 for non-existent, 2 for existent email: type: string description: Email phone: type: string description: Phone phoneArea: type: string description: Phone area code name: type: string description: Name country: type: string description: Country type: type: integer format: int32 description: Group type <0 real, 1 demo, 2 guest> deposit: type: integer format: int32 description: Depositable, 1 for depositable withdraw: type: integer format: int32 description: Withdrawable, 1 for withdrawable optional: type: integer format: int32 description: Customized flag 0 not added 1 added activateStatus: type: integer format: int32 description: Activation Status activateTime: type: integer format: int64 description: Activation time companyKycStatus: type: integer format: int32 description: Company KYC account opening status, 1 for opened, 2 for not opened status: type: integer format: int32 description: >- Status: 1 normal, 2 disabled, 3 deleted, 4 closed, 5 locked, 6 closing thirdServerCode: type: string description: Unique identifier from third-party system source: type: string description: Source thirdLoginSource: type: string description: Third-party login sources google, facebook, twitter thirdUserId: type: string description: Third-party userId idCard: type: string description: ID number idCardType: type: string description: ID type thirdIntactMsg: type: string description: Third-party login complete data firstName: type: string description: First name lastName: type: string description: Last name isFund: type: integer format: int32 description: Whether a fund manager, 1 is yes, default 0 is no assertPassStatus: type: string description: >- Set fund password reminder flag, 1 requires setting password, 2 does not require googleId: type: integer format: int64 description: >- Whether to enable MFA, greater than 0, enabled, otherwise not enabled openAccountType: type: integer format: int32 description: 'Account type: 0. Individual 1. Enterprise ' loginTime: type: integer format: int64 description: Login time createTime: type: integer format: int64 description: Creation time relationCustomerId: type: integer format: int64 description: Associated account id companyType: type: string description: Company type registerSource: type: integer format: int32 description: Registration source associationCompanyId: type: integer format: int64 description: Associated company Id registerTime: type: integer format: int64 description: Registration Time SaveOrderExecuteStandardConfigReqDto: type: object required: - configDtoList - customerGroupId properties: customerGroupId: type: integer format: int64 description: Customer group ID configDtoList: type: array description: Order Execution Standard Configuration Array items: &ref_43 $ref: '#/components/schemas/OrderExecuteStandardConfigDto' OrderExecuteStandardConfigDto: &ref_44 type: object required: - baseCurrency - profitCurrency - rate - symbolId properties: baseCurrency: type: string description: Base Currency profitCurrency: type: string description: Profit Currency rate: type: number description: Order Percentage symbolId: type: integer format: int64 description: Product ID symbolName: type: string description: Product name BaseResultListDepositAccountCurrencyRespV2Dto: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: array description: Data Body items: $ref: '#/components/schemas/DepositAccountCurrencyRespV2Dto' ok: type: boolean fail: type: boolean DepositAccountCurrencyRespV2Dto: type: object properties: clientType: type: string description: Payment channel supports terminal types pc, mobile accountCurrency: type: string description: Account currency blockchainNameList: type: array description: Account currency items: type: string QueryDepositAccountCurrencyListV2Dto: type: object required: - clientType - country - customerGroupId - tradeType properties: tradeType: type: integer format: int64 description: Game type customerGroupId: type: integer format: int64 description: Customer group ID clientType: type: string description: Payment channel supports terminal types pc, mobile country: type: string description: Customer opening country code paymentCodes: type: string description: Payment Channel Code, multiple channel codes paymentTypes: type: string description: Payment channel type, multiple type codes TradeTime: type: object properties: dayOfWeek: type: integer format: int32 description: Day of the Week, 1-7 Monday to Sunday startTime: type: integer format: int64 description: Start Time, in seconds endTime: type: integer format: int64 description: End Time, in seconds description: Trading Time HolidayTime: type: object properties: startTime: type: integer format: int64 description: Start time, 13-digit timestamp endTime: type: integer format: int64 description: End time, 13-digit timestamp description: Holiday Time SearchSymbolBaseDto: type: object properties: customerGroupId: type: integer format: int64 description: Client group ID required: - customerGroupId BaseResultCustomerApiVO: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: $ref: '#/components/schemas/CustomerApiVO' ok: type: boolean fail: type: boolean CustomerApiVO: type: object properties: id: type: integer format: int64 description: id createTime: type: integer format: int64 description: Creation time / Application time updateTime: type: integer format: int64 description: Update Time apiKey: type: string description: access Key customerNo: type: string description: customerNo customerId: type: integer format: int64 description: Client ID customerGroupId: type: integer format: int64 description: Client group ID companyId: type: integer format: int64 description: companyId secretKeyMd5: type: string description: secretKeyMd5 privateKey: type: string description: secretKey, only returned when applied for pubKey: type: string description: Public key tag: type: string description: Tag permissionDTOList: type: array description: List of permissions items: *ref_42 ipLimit: type: boolean description: Whether IP restriction is enabled whiteIps: type: string description: IP whitelist sources: type: array description: Permission paths allowed to access items: type: string expiredTime: type: integer format: int64 description: Expiration time withdrawTime: type: integer format: int64 validityDays: type: integer format: int32 description: Validity period (days) -1 expired null permanently valid, CustomerApiPermissionDTO: type: object required: - status properties: code: type: string description: Permission code name: type: string description: Permission name status: type: integer format: int32 description: Whether to enable 1. Enable 2. Disable canEdit: type: boolean description: Can it be edited paths: type: array description: Permission path items: type: string BaseResultLong: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: integer format: int64 description: Data Body ok: type: boolean fail: type: boolean BaseResultListOrderExecuteStandardConfigDto: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: array description: Data Body items: *ref_43 ok: type: boolean fail: type: boolean QueryOrderExecuteStandardConfigReqDto: type: object required: - customerGroupId properties: customerGroupId: type: integer format: int64 description: Customer group ID BaseResultSetDepositAccountCurrencyRespDto: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: array description: Data Body uniqueItems: true items: $ref: '#/components/schemas/DepositAccountCurrencyRespDto' ok: type: boolean fail: type: boolean DepositAccountCurrencyRespDto: type: object properties: customerGroupId: type: integer format: int64 description: Customer group ID paymentCode: type: string description: Payment channel code paymentType: type: string description: Payment channel type paymentTypeAlias: type: string description: Payment channel type alias clientType: type: string description: Payment channel supports terminal types pc, mobile accountCurrency: type: string description: Account currency singleLowAmount: type: number description: Minimum deposit amount per transaction singleHighAmount: type: number description: Maximum deposit amount per transaction singleCheckLowAmount: type: number description: Minimum deposit amount per transaction for manual review feeType: type: integer format: int32 description: Fee type, fixed amount 'fix', percentage rate 'rate' fee: type: number description: Commission fee rechargeType: type: string description: >- Multiple recharge methods separated by commas, 1: Direct recharge, 2: Exchange QueryDepositAccountCurrencyListDto: type: object required: - clientType - country - customerGroupId - paymentCode - rechargeType - tradeType properties: tradeType: type: integer format: int64 description: Game type customerGroupId: type: integer format: int64 description: Customer group ID clientType: type: string description: Payment channel supports terminal types pc, mobile country: type: string description: Customer opening country code paymentCode: type: string description: Payment channel code rechargeType: type: string description: Recharge method FundMarketPerfQuoteChangeChartVo: &ref_54 type: object properties: symbolId: type: integer format: int64 title: Fund ID description: Choose either symbolId or fundId fundId: type: integer format: int64 description: Choose either fundId or symbolId title: Product ID days: type: integer title: Days type: type: integer title: Type description: ' 1-Statistical by day 2-Statistical by hour' required: - days - type title: '' BaseResultWithdrawAmountLimitRespDto: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: $ref: '#/components/schemas/WithdrawAmountLimitRespDto' ok: type: boolean fail: type: boolean WithdrawAmountLimitRespDto: type: object required: - tradeType properties: tradeType: type: integer format: int64 singleLowAmount: type: string description: Minimum withdrawal amount per transaction singleHighAmount: type: string description: Maximum single withdrawal amount withdrawAmount: type: string description: Available amount withdrawCurrency: type: string description: Withdrawal currency WithdrawAmountLimitReqDto: type: object properties: customerGroupId: type: integer format: int64 description: Customer group ID country: type: string description: Country accountCurrency: type: string description: Account currency (trading account currency) withdrawCurrency: type: string description: Withdrawal currency (currency supported by payment channels) withdrawType: type: integer format: int32 description: >- Withdrawal type, Withdrawal: 1 (Withdraw to bank card), Withdrawal: 2 (Withdraw digital currency to digital wallet) withdrawMethod: type: string description: >- Withdrawal method, Bank card: bank, Digital wallet: digit_wallet, Skrill e-wallet: skrill_wallet, Telegraphic transfer: wire blockchainName: type: string description: >- Chain name, data dictionary configuration, payment method is digital wallet, display the corresponding chain name (also known as transfer network), such as Omin, ERC20, TRC20 KycWebAddInnerDTO: type: object required: - elementCode - elementValue properties: elementValue: type: string description: KYC element value elementCode: type: string description: KYC element BaseResultListOrderExecuteStandardConfigSymbolDto: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: array description: Data Body items: $ref: '#/components/schemas/OrderExecuteStandardConfigSymbolDto' ok: type: boolean fail: type: boolean OrderExecuteStandardConfigSymbolDto: *ref_44 QueryOrderExecuteStandardConfigSymbolListReqDto: &ref_51 type: object properties: {} BaseResultCryptoBlockchainRespDto: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: $ref: '#/components/schemas/CryptoBlockchainRespDto' ok: type: boolean fail: type: boolean CryptoBlockchainRespDto: type: object properties: paymentCode: type: string description: Payment channel code currency: type: string description: Payment currency blockchainList: type: array description: Payment currency chain list items: type: string CryptoBlockchainReqDto: type: object required: - currency - paymentCode - tradeType properties: tradeType: type: integer format: int64 paymentCode: type: string description: Payment channel code currency: type: string description: Payment currency BaseResultMapStringListFundTrendChartDto: type: object properties: bizCode: type: string title: Module identifier code code: type: string title: Status return code msg: type: string title: Status description tm: type: integer format: int64 description: 'Unit: milliseconds' title: Processing time trace: type: string title: Tracking code msgParams: type: string description: Multiple parameters are separated by commas title: Return description with placeholder parameter string data: type: object properties: key: type: string value: type: array items: &ref_53 $ref: '#/components/schemas/FundTrendChartDto' title: Data Body required: - key - value fail: type: boolean ok: type: boolean title: '' FundTrendChartDto: type: object properties: time: type: string title: Date value: type: string title: Y-coordinate value required: - time - value FundMarketPerfChartVo: type: object properties: symbolId: type: integer format: int64 title: Product ID description: Choose either fundId or symbolId fundId: type: integer format: int64 title: Fund ID description: Choose either symbolId or fundId days: type: integer title: Days type: type: integer title: Type description: ' 1-Statistical by day 2-Statistical by hour' required: - days - type title: '' BaseResult: type: object properties: bizCode: type: string title: Module identifier code code: type: string title: Status return code msg: type: string title: Status description tm: type: integer format: int64 title: Processing time (milliseconds) trace: type: string title: Tracking code msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas ok: type: boolean fail: type: boolean data: type: object properties: {} title: Data Body title: BaseResult BaseResultSetString: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: array description: Data Body uniqueItems: true items: type: string ok: type: boolean fail: type: boolean WithdrawCurrencyListReqDto: type: object required: - tradeType properties: tradeType: type: integer format: int64 customerGroupId: type: integer format: int64 country: type: string description: Country Code BaseResultBasePageVoCustomerFundRedeemDto: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: $ref: '#/components/schemas/BasePageVoCustomerFundRedeemDto' ok: type: boolean fail: type: boolean BasePageVoCustomerFundRedeemDto: type: object properties: records: type: array description: Result list items: &ref_57 $ref: '#/components/schemas/CustomerFundRedeemDto' total: type: integer format: int64 description: Total size: type: integer format: int64 description: Number of Items per Page current: type: integer format: int64 description: Current Page CustomerFundRedeemDto: type: object properties: id: type: integer format: int64 description: Primary key id status: type: integer format: int32 description: Status 1, 2, 3, enable, disable, delete createBy: type: string description: Creator createTime: type: integer format: int64 description: Creation time updateBy: type: string description: Updater updateTime: type: integer format: int64 description: Update Time proposalNo: type: string description: Press according to the number companyName: type: string description: Company name customerNoFun: type: string description: Customer number corresponding to the fund manager fundId: type: integer format: int64 description: Redemption fund ID currencyRedeem: type: string description: Redemption currency currencyShares: type: string description: Fund currency currencyNet: type: string description: Net asset value currency fees: type: string description: Commission fee amountRedeem: type: string description: Redemption amount shares: type: string description: Number of shares sharesNet: type: string description: Net asset value of shares sharesStatus: type: integer format: int32 description: >- Share confirmation status: 0: pending confirmation 1. confirmed 2. confirmation failed fundName: type: string description: Fund name basketTag: type: boolean FundRedeemQueryReqDto: type: object properties: username: type: string size: type: integer format: int64 description: Number of Items per Page current: type: integer format: int64 description: Current Page downloadType: type: integer format: int32 description: 'Download type 1: direct download, 2: asynchronous download' orders: type: array description: Sorting field list items: &ref_46 $ref: '#/components/schemas/FieldOrderDto' proposalNoList: type: array description: Redemption number items: type: string currencyRedeem: type: string description: Assets accepted by the customer customerCompanyId: type: integer format: int64 description: Client White Label Company ID customerNoList: type: array description: Client's Number items: type: string sharesStatus: type: integer format: int32 description: >- Share confirmation status: 0: pending confirmation 1. confirmed 2. confirmation failed startTime: type: integer format: int64 description: Application Start Time endTime: type: integer format: int64 description: Application End Time updateStartTime: type: integer format: int64 description: Last Update - Application Start Time updateEndTime: type: integer format: int64 description: Last Start - Application End Time currencyShares: type: string description: Share Token FieldOrderDto: type: object properties: column: type: string description: Sorting Field Column asc: type: boolean description: Order Method BaseResultFundsApplyExecuteInfoDto: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: *ref_45 ok: type: boolean fail: type: boolean FundsApplyExecuteInfoDto: type: object required: - fundsApplyExecuteRecordDto properties: applyIds: type: array description: Fund Product Subscription Record ID List items: type: integer format: int64 fundsApplyExecuteRecordDto: $ref: '#/components/schemas/FundsApplyExecuteRecordDto' fundsApplyExecuteRecordDetailDtoList: type: array description: Fund Product Subscription Execution Detail Record List items: &ref_47 $ref: '#/components/schemas/FundsApplyExecuteRecordDetailDto' FundsApplyExecuteRecordDetailDto: type: object properties: id: type: integer format: int64 description: Primary key id status: type: integer format: int32 description: Status 1, 2, 3, enable, disable, delete createBy: type: string description: Creator createTime: type: integer format: int64 description: Creation time updateBy: type: string description: Updater updateTime: type: integer format: int64 description: Update Time amount: type: number description: Profit Currency Amount baseCurrency: type: string description: Base Currency profitCurrency: type: string description: Profit Currency rate: type: number description: Order Percentage symbolId: type: integer format: int64 description: Product ID symbolName: type: string description: Product name FundsApplyExecuteRecordDto: type: object properties: amount: type: number description: Profit Currency Amount profitCurrency: type: string description: Profit Currency QueryFundsApplyExecuteRecordDetailReqDto: type: object required: - applyIds properties: applyIds: type: array description: Fund Product Subscription Record ID List items: type: integer format: int64 BaseResultSpotTradeRecordVo: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: $ref: '#/components/schemas/SpotTradeRecordVo' ok: type: boolean fail: type: boolean SpotTradeRecordVo: type: object properties: companyId: type: integer format: int64 description: Company ID customerId: type: integer format: int64 description: Client ID customerNo: type: string description: Client number accountId: type: integer format: int64 description: Account ID trace: type: string description: Tracking code ip: type: string description: Operation IP lang: type: string description: Request Language size: type: integer format: int64 current: type: integer format: int64 totalPage: type: integer format: int64 list: type: array items: $ref: '#/components/schemas/SpotTradeRecordList' bizTypeText: type: object additionalProperties: type: string properties: {} SpotTradeRecordList: type: object properties: symbolId: type: integer format: int64 orderId: type: integer format: int64 dealId: type: integer format: int64 bizType: type: integer format: int32 symbolName: type: string direction: type: integer format: int32 requestPrice: type: string executePrice: type: string requestNum: type: string executeNum: type: string loanAmount: type: string executeTime: type: integer format: int64 outCurrency: type: string inCurrency: type: string stopLoss: type: string takeProfit: type: string commission: type: string profitLoss: type: string overnightInterest: type: string numberStatisticMode: type: integer format: int32 accountCurrency: type: string moneyAmountCurrency: type: string symbolCode: type: string tradeAmount: type: string source: type: string description: >- H5: mobile web; PC_Web: pcweb; System: system; Android: Android native app; iOS: Apple native app; HOS: Hongmeng OS; PC_Win: pcwindows client; PC_Mac: pcmac client; default is the same as login source. (The enumeration is for reference only) thirdPartyOrder: type: string SpotQueryOrderRecordPageDto: type: object properties: username: type: string size: type: integer format: int64 description: Number of Items per Page current: type: integer format: int64 description: Current Page downloadType: type: integer format: int32 description: 'Download type 1: direct download, 2: asynchronous download' sortFieldName: type: string sortType: type: string tradeType: type: string orderType: type: string symbolId: type: integer format: int64 executeStartTime: type: integer format: int64 executeEndTime: type: integer format: int64 direction: type: string accountIds: type: string querySource: type: string description: >- H5: mobile web; PC_Web: pcweb; System: system; Android: Android native app; iOS: Apple native app; HOS: Hongmeng OS; PC_Win: pcwindows client; PC_Mac: pcmac client; default is the same as login source. (The enumeration is for reference only) thirdPartyOrder: type: string BaseResultListRealTimeInvestCombinationDto: type: object properties: bizCode: type: string title: Module identifier code code: type: string title: Status return code msg: type: string title: Status description tm: type: integer format: int64 description: 'Unit: milliseconds' title: Processing time trace: type: string title: Tracking code msgParams: type: string description: Multiple parameters are separated by commas title: Return description with placeholder parameter string data: type: array items: $ref: '#/components/schemas/RealTimeInvestCombinationDto' title: Data Body fail: type: boolean ok: type: boolean title: '' RealTimeInvestCombinationDto: type: object properties: asset: type: string title: Asset range: type: string title: Ranking weight: type: string title: Weight weightRealValue: type: string title: Weight Real Value previousPeriodRangeCompare: type: string title: Change in Ranking from Previous Period previousPeriodWeightCompare: type: string title: Change in Weight from Previous Period title: '' FundInvestCombChartVo: &ref_49 type: object properties: symbolId: type: integer format: int64 title: Product ID description: Choose either fundId or symbolId fundId: type: integer format: int64 title: Fund ID description: Choose either symbolId or fundId title: '' CountryDictVo: type: object properties: parentId: type: integer format: int64 description: Superior ID id: type: integer format: int64 description: Primary key id name: type: string description: Country/Region name displayName: type: string description: Display Name nameTw: type: string description: Country/Region Name TW nameEn: type: string description: Country/Region Name EN code: type: string description: Country code parentCode: type: string description: Parent code nationalCode: type: string description: Country abbreviation countryCode: type: string description: Phone Area Code extend: type: string description: Extended attribute sort: type: integer format: int32 description: Sort status: type: integer format: int32 description: Status 1, 2, 3, enable, disable, delete revision: type: integer format: int32 description: Optimistic lock createBy: type: string description: Creator createTime: type: integer format: int64 description: Creation time updateBy: type: string description: Updater updateTime: type: integer format: int64 description: Update Time hasLeaf: type: integer format: int32 description: Whether there are child nodes childs: type: array description: Subnode data items: *ref_0 SpotQueryOrderDto: type: object properties: orderId: type: integer format: int64 BaseResultCreateCustomerDepositRespDto: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: $ref: '#/components/schemas/CreateCustomerDepositRespDto' ok: type: boolean fail: type: boolean CreateCustomerDepositRespDto: type: object properties: submitType: type: string description: >- Data Submission Method post_data,inner_browser_open,outer_browser_open url: type: string description: Request Address contentType: type: string description: Data Type Content-Type text/plain or application/json data: type: string description: HTTP Request Parameters for Redirecting to Payment Platform proposalNo: type: string description: Proposal number browserOpenUrl: type: string description: Directly Redirect to Payment Channel Address amount: type: string description: Payment amount, returned only when paymentChannelCode is blockatm_qr currency: type: string description: >- Payment currency, only returned when paymentChannelCode is blockatm_qr toAddress: type: string description: >- Payment address, only returned when paymentChannelCode is blockatm_qr expireTime: type: integer format: long description: >- Expiration time, only returned when paymentChannelCode is blockatm_qr apiKey: type: string description: apiKey, only returned when paymentChannelCode is blockatm_qr paymentChannelCode: type: string description: >- Payment channel code, only returned when paymentChannelCode is blockatm_qr CreateCustomerDepositReqDto: type: object required: - customerGroupId - paymentChannelCode - paymentChannelType - paymentMerchantNo - tradeType - paymentCurrency - accountCurrency - paymentChannelClientType properties: accountId: type: integer format: int64 description: Account ID tradeType: type: integer format: int64 description: Game type customerGroupId: type: integer format: int64 description: Customer group ID depositRateSerialNo: type: string description: Deposit Fee Rate Serial Number paymentCurrency: type: string description: Deposit Currency Code blockchainName: type: string description: >- Chain name, data dictionary configuration, payment method is digital wallet, display the corresponding chain name (also known as transfer network), such as Omin, ERC20, TRC20 accountCurrency: type: string description: Account Currency Code exchangeRate: type: number description: Exchange Rate paymentChannelCode: type: string description: Payment Channel Code paymentChannelType: type: string description: Payment Channel Type paymentMerchantNo: type: string description: Payment merchant number paymentChannelClientType: type: string description: Payment channel client type pc, mobile depositAmount: type: number description: Account Deposit Amount thirdAmount: type: number description: >- Request Amount to Third Party, some payment channels require: PayRedeem country: type: string description: Country (Country where the customer account is opened) channelCode: type: string description: Advertising Source (Customer Account Opening Channel Code) depositFrom: type: string description: >- Deposit Source, values: H5, H5_Android, H5_IOS, PCUI_Windows, PCUI_Mac, APP_Android, APP_IOS callbackUrl: type: string description: Front-end callback address showUrl: type: string description: YUL1 Address extend: type: string description: Extended Fields bankCode: type: string description: Withdrawal Bank Code paymentChannelPayType: type: string description: Payment Channel Payment Type thirdAccount: type: string description: Third-party account remark: type: string description: Remarks chainId: type: string description: Network Chain ID BaseResultMapLongListCustomerOptionalVO: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: object description: Data Body additionalProperties: type: array items: $ref: '#/components/schemas/CustomerOptionalVO' properties: {} ok: type: boolean fail: type: boolean CustomerOptionalVO: type: object properties: askSpread: type: number description: ASK Spread bidSpread: type: number description: BID Spread pointRatio: type: integer format: int32 description: Bigger Point Ratio symbolDigits: type: integer format: int32 description: Product decimal places symbolCode: type: string description: Product Code symbolName: type: string description: Product name symbolId: type: integer format: int64 description: Product Id DictVO: type: object properties: parentId: type: integer format: int64 description: Superior ID id: type: integer format: int64 description: Primary key id name: type: string description: Dictionary name displayName: type: string description: Display Name nameTw: type: string description: Dictionary Name TW nameEn: type: string description: Dictionary Name EN code: type: string description: Dictionary code parentCode: type: string description: Parent code sort: type: integer format: int32 description: Sort showType: type: string description: Dictionary display type extend: type: string description: Extended attribute status: type: integer format: int32 description: Status 1, 2, 3, enable, disable, delete revision: type: integer format: int32 description: Optimistic lock createBy: type: string description: Creator createTime: type: integer format: int64 description: Creation time updateBy: type: string description: Updater updateTime: type: integer format: int64 description: Update Time hasLeaf: type: integer format: int32 description: Whether there are child nodes BaseResultListCustomerGroupWithdrawCurrencyConfigDto: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: array description: Data Body items: $ref: '#/components/schemas/CustomerGroupWithdrawCurrencyConfigDto' ok: type: boolean fail: type: boolean CustomerGroupWithdrawCurrencyConfigDto: type: object required: - tradeType properties: tradeType: type: integer format: int64 customerGroupId: type: integer format: int64 description: Company client group id country: type: string description: Country Code withdrawCurrency: type: string description: Withdrawal currency blockchainName: type: string description: Blockchain name withdrawMethod: type: string description: 'Withdrawal method, bank card: bank, digital wallet: digit_wallet' BaseResultBasePageVoFundManagementFeesDto: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: $ref: '#/components/schemas/BasePageVoFundManagementFeesDto' ok: type: boolean fail: type: boolean BasePageVoFundManagementFeesDto: type: object properties: records: type: array description: Result list items: $ref: '#/components/schemas/FundManagementFeesDto' total: type: integer format: int64 description: Total size: type: integer format: int64 description: Number of Items per Page current: type: integer format: int64 description: Current Page FundManagementFeesDto: type: object properties: id: type: integer format: int64 description: Primary key id status: type: integer format: int32 description: Status 1, 2, 3, enable, disable, delete createBy: type: string description: Creator createTime: type: integer format: int64 description: Creation time updateBy: type: string description: Updater updateTime: type: integer format: int64 description: Update Time deductDate: type: integer format: int64 description: Deduction Date deductExcuteTime: type: integer format: int64 description: Deduction Execution Time fees: type: string description: Deduction Amount currencyFees: type: string description: Deduction Currency deductStatus: type: integer format: int32 description: 'Deduction Status: 1. Deduction Success 2. Deduction Failure' FundManagementFeesRecordDto: type: object properties: username: type: string size: type: integer format: int64 description: Number of Items per Page current: type: integer format: int64 description: Current Page downloadType: type: integer format: int32 description: 'Download type 1: direct download, 2: asynchronous download' deductDate: type: integer format: int64 deductStatus: type: integer format: int32 BaseResultListCustomerFundCurrencyDto: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: array description: Data Body items: &ref_52 $ref: '#/components/schemas/CustomerFundCurrencyDto' ok: type: boolean fail: type: boolean CustomerFundCurrencyDto: type: object properties: id: type: integer format: int64 description: Primary key id status: type: integer format: int32 description: Status 1, 2, 3, enable, disable, delete createBy: type: string description: Creator createTime: type: integer format: int64 description: Creation time updateBy: type: string description: Updater updateTime: type: integer format: int64 description: Update Time proposalNo: type: string description: Proposal number fundId: type: integer format: int64 description: Fund ID currency: type: string description: Currency digits: type: integer format: int32 description: Asset Decimal Places amount: type: string description: Final Subscription/Redemption Amount fees: type: string description: Commission fee total: type: string description: Total Payment Amount FundCurrencyQueryReqDto: type: object required: - proposalNo properties: proposalNo: type: string description: Proposal number BaseResultBasePageVoCustomerWithdrawProposalDto: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: $ref: '#/components/schemas/BasePageVoCustomerWithdrawProposalDto' ok: type: boolean fail: type: boolean BasePageVoCustomerWithdrawProposalDto: type: object properties: records: type: array description: Result list items: &ref_50 $ref: '#/components/schemas/CustomerWithdrawProposalDto' total: type: integer format: int64 description: Total size: type: integer format: int64 description: Number of Items per Page current: type: integer format: int64 description: Current Page CustomerWithdrawProposalDto: type: object required: - tradeType - withdrawViewStatus properties: companyId: type: integer format: int64 description: Company ID customerId: type: integer format: int64 description: Client ID customerNo: type: string description: Client number accountId: type: integer format: int64 description: Account ID id: type: integer format: int64 description: Primary key id status: type: integer format: int32 description: Status 1, 2, 3, enable, disable, delete createBy: type: string description: Creator createTime: type: integer format: int64 description: Creation time updateBy: type: string description: Updater updateTime: type: integer format: int64 description: Update Time tradeType: type: integer format: int64 proposalNo: type: string description: Proposal number country: type: string description: Country accountCurrency: type: string description: Account currency (trading account currency) withdrawCurrency: type: string description: Withdrawal currency (currency supported by payment channels) amount: type: string description: Proposal Amount rate: type: string description: Withdrawal exchange rate sent to platform CATS2 withdrawFee: type: string description: Withdrawal Fee finalAmount: type: string description: Final Withdrawal Amount accountDeductAmount: type: string description: Account Deduction bankAccountName: type: string description: Bank card holder's name bankName: type: string description: Bank card bank name displayBankName: type: string description: Bank Card Bank Name Translation bankCardNo: type: string description: Bank card number checkBy: type: string description: Approver checkStatus: type: integer format: int32 description: >- Proposal status, waiting for manual approval: 1, approval successful: 2, approval failed: 3 transferStatus: type: integer format: int32 description: >- Transfer status, pending transfer: 1, transfer successful: 2, transfer failed: 3 amlRet: type: integer format: int32 description: 'AML Verification Result AmlCheckRetEnum: Passed 1, Failed 2' amlFailReasion: type: string description: Reasons for AML Verification Failure remark: type: string description: Remarks withdrawType: type: integer format: int32 description: >- Withdrawal type, Withdrawal: 1 (Withdraw to bank card), Withdrawal: 2 (Withdraw digital currency to digital wallet) withdrawCoinStatus: type: integer format: int32 description: >- Withdrawal status, pending withdrawal: 1, withdrawal successful: 2, withdrawal failed: 3, submission failed: 4 withdrawMethod: type: string description: >- Payment method, data dictionary configuration, such as bank card, digital wallet, skill, PayPal, etc., currently only bank card and digital wallet, withdrawal: bank (corresponding to bank card), withdrawal: coin (corresponding to digital wallet) blockchainName: type: string description: >- Chain name, data dictionary configuration, payment method is digital wallet, display the corresponding chain name (also known as transfer network), such as Omin, ERC20, TRC20 txid: type: string description: txid customerGroupId: type: integer format: int64 description: Customer group ID thirdMessage: type: string description: Call third-party response message withdrawViewStatus: type: integer description: >- Withdrawal status code, pending approval: 1, approval failed: 2, failed: 3, completed: 4, in progress: 5 transferRejectReason: type: string description: Transfer rejection reason QueryWithdrawProposalPageReqDto: type: object properties: size: type: integer format: int64 description: Number of Items per Page current: type: integer format: int64 description: Current Page orders: type: array description: Sorting field list items: *ref_46 startTime: type: integer format: int64 endTime: type: integer format: int64 withdrawType: type: integer format: int32 description: >- Withdrawal type, Withdrawal: 1 (Withdraw to bank card), Withdrawal: 2 (Withdraw digital currency to digital wallet) accountCurrency: type: string description: Account Currency (Customer Debit Currency) withdrawCurrency: type: string description: Withdrawal Currency (Customer Credit Currency) txid: type: string description: Transaction id CapitalTransferDiffCurrReqDto: type: object required: - amount - currency - toCurrency - toCustomerNo - toTradeType - tradeType properties: tradeType: type: integer format: int64 description: Transfer to Account Gameplay accountDigit: type: integer format: int32 description: Transfer out Account Decimal Places toTradeType: type: integer format: int64 description: Transfer out Account Gameplay toAccountId: type: integer format: int64 description: Transfer to Account ID toCustomerNo: type: string description: Transfer to customer number toAccountDigit: type: integer format: int32 description: Transfer to Account Decimal Places amount: type: number description: Sliding amount currency: type: string description: Transfer out currency toCurrency: type: string description: Transfer to Currency BaseResultString: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: string description: Data Body ok: type: boolean fail: type: boolean BaseResultBasePageVoCustomerFundApplyDto: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: $ref: '#/components/schemas/BasePageVoCustomerFundApplyDto' ok: type: boolean fail: type: boolean BasePageVoCustomerFundApplyDto: type: object properties: records: type: array description: Result list items: &ref_59 $ref: '#/components/schemas/CustomerFundApplyDto' total: type: integer format: int64 description: Total size: type: integer format: int64 description: Number of Items per Page current: type: integer format: int64 description: Current Page CustomerFundApplyDto: type: object properties: id: type: integer format: int64 description: Primary key id status: type: integer format: int32 description: Status 1, 2, 3, enable, disable, delete createBy: type: string description: Creator createTime: type: integer format: int64 description: Creation time updateBy: type: string description: Updater updateTime: type: integer format: int64 description: Update Time proposalNo: type: string description: Proposal number companyName: type: string description: White Label Company Name customerNoFun: type: string description: Customer number corresponding to the fund manager fundId: type: integer format: int64 description: Fund ID currencyPay: type: string description: Payment Currency currencyShares: type: string description: Fund currency fees: type: string description: Payment Handling Fee amountPay: type: string description: Payment Amount finalAmount: type: string description: Final Subscription Amount shares: type: string description: Confirmed Share Quantity sharesNet: type: string description: Net asset value of shares sharesStatus: type: integer format: int32 description: >- Share confirmation status: 0: pending confirmation 1. confirmed 2. confirmation failed executeStatus: type: integer format: int32 description: >- Subscription Execution Status: 0. Unconfirmed 1. Pending Execution 2. Execution Successful 3. Execution Failed executeId: type: string description: Batch Execution ID currencyNet: type: string description: Net Asset Value Currency fundName: type: string description: Fund name executeList: type: array description: Execution Standard List items: *ref_47 FundApplyRecordDto: type: object required: - customerGroupId properties: username: type: string size: type: integer format: int64 description: Number of Items per Page current: type: integer format: int64 description: Current Page downloadType: type: integer format: int32 description: 'Download type 1: direct download, 2: asynchronous download' startTime: type: integer format: int64 endTime: type: integer format: int64 currencyPay: type: string customerCompanyId: type: integer format: int64 proposalNo: type: array items: type: string customerSelfNo: type: array items: type: string executeId: type: array items: type: string executeStatus: type: integer format: int32 currencyShares: type: string type: type: integer format: int32 customerGroupId: type: integer format: int64 description: Customer group ID BaseResultBasePageVoCustomerDepositProposalDto: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: $ref: '#/components/schemas/BasePageVoCustomerDepositProposalDto' ok: type: boolean fail: type: boolean BasePageVoCustomerDepositProposalDto: type: object properties: records: type: array description: Result list items: *ref_48 total: type: integer format: int64 description: Total size: type: integer format: int64 description: Number of Items per Page current: type: integer format: int64 description: Current Page QueryDepositProposalPageReqDto: type: object properties: size: type: integer format: int64 description: Number of Items per Page current: type: integer format: int64 description: Current Page orders: type: array description: Sorting field list items: *ref_46 startTime: type: integer format: int64 endTime: type: integer format: int64 depositCurrency: type: string description: Deposit Currency paymentCurrency: type: string description: Payment currency rechargeType: type: string description: 'Recharge Method, 1: Direct Recharge, 2: Remittance' txid: type: string description: Transaction id depositStatus: type: string description: Deposit Status paymentStatus: type: string description: Payment Status BaseResultCapitalTransferRecordResDto: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: description: Data Body $ref: '#/components/schemas/BasePageVoCapitalTransferRecordResDto' ok: type: boolean fail: type: boolean BasePageVoCapitalTransferRecordResDto: type: object properties: records: type: array description: Result list items: $ref: '#/components/schemas/CapitalTransferRecordResDto' total: type: integer format: int64 description: Total size: type: integer format: int64 description: Number of Items per Page current: type: integer format: int64 description: Current Page CapitalTransferRecordResDto: type: object properties: outAccountId: type: integer description: Debit Account Id outCurrencyCode: type: string description: Debit Account Currency outTradeType: type: integer description: Debit Account Play Type outAmount: type: string description: Debit Amount inAccountId: type: integer description: Credit Account Id inCurrencyCode: type: string description: Credit Account Currency inTradeType: type: integer description: Credit Account Play Type inAmount: type: string description: Credit Amount createTime: type: string description: Creation time required: - outAccountId - outCurrencyCode - outTradeType - outAmount - inAccountId - inCurrencyCode - inTradeType - inAmount - createTime CapitalTransferRecordDto: type: object properties: size: type: integer format: int64 description: Number of Items per Page current: type: integer format: int64 description: Current Page downloadType: type: integer format: int32 description: 'Download type 1: direct download, 2: asynchronous download' startTime: type: integer format: int64 description: Start Time endTime: type: integer format: int64 description: End Time tradeType: type: integer format: int64 description: Play Type Identifier assetsId: type: integer format: int64 description: Asset Id BaseResultFundNetValueCompareDto: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: $ref: '#/components/schemas/FundNetValueCompareDto' fail: type: boolean ok: type: boolean title: '' FundNetValueCompareDto: type: object properties: netValue: type: string marketPrice: type: string netValueChangeQuote: type: string marketPriceChangeQuote: type: string totalBalance: type: string currency: type: string latestShare: type: string title: '' FundNetValueChangeQuoteChartVo: *ref_49 BaseResultListCustomerWithdrawBankVO: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: array description: Data Body items: $ref: '#/components/schemas/CustomerWithdrawBankVO' ok: type: boolean fail: type: boolean CustomerWithdrawBankVO: type: object properties: companyId: type: integer format: int64 customerNo: type: string bankAccountName: type: string bankCardNumber: type: string bankCurrency: type: string bankName: type: string bankCode: type: string bankAddress: type: string bankBranch: type: string country: type: string province: type: string city: type: string firstName: type: string description: First name lastName: type: string description: Last name bankAccount: type: string swiftCode: type: string otherCode: type: string KycAuthVO: type: object properties: levelCode: type: string description: Level Code openAccountType: type: integer format: int32 description: 'Account type: 0. Individual 1. Enterprise ' levelName: type: string description: Level Name pathName: type: string description: KYC Path Name pathCode: type: string description: KYC Path Code elementList: type: array description: KYC Information List items: $ref: '#/components/schemas/KycAuthElementVO' KycAuthElementVO: type: object properties: elementCode: type: string description: KYC element code elementName: type: string description: KYC element name showType: type: string description: KYC element display type extend: type: string description: KYC element extended attribute elementValue: type: string description: KYC element value elementValueInputGroup: type: string description: KYC element value, combination elementCodeInputGroup: type: string description: KYC element code, combination CapitalTransferForAgentReqDto: type: object required: - amount - currency - toCustomerNo - tradeType properties: tradeType: type: integer format: int64 description: Account gameplay, fixed value 7 toCustomerNo: type: string description: Transfer to customer number amount: type: number description: Sliding amount currency: type: string description: Transfer out currency BaseResultListAssets: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: array description: Data Body items: $ref: '#/components/schemas/Assets' ok: type: boolean fail: type: boolean Assets: type: object properties: id: type: integer format: int64 description: Primary key id status: type: integer format: int32 description: Status 1, 2, 3, enable, disable, delete revision: type: integer format: int32 description: Optimistic lock createBy: type: string description: Creator createTime: type: integer format: int64 description: Creation time updateBy: type: string description: Updater updateTime: type: integer format: int64 description: Update Time name: type: string description: Asset name displayName: type: string description: Display Name code: type: string description: Asset code digits: type: integer format: int32 description: Decimal Places initState: type: integer format: int32 description: >- Initialization status 1, 2, initialization in progress, initialization completed type: type: integer format: int32 description: Asset type fundId: type: integer format: int64 description: Related fund BaseResultCustomerWithdrawProposalDto: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: *ref_50 ok: type: boolean fail: type: boolean BaseResultFundRedeemSharesCheckRespDto: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: $ref: '#/components/schemas/FundRedeemSharesCheckRespDto' ok: type: boolean fail: type: boolean FundRedeemSharesCheckRespDto: type: object properties: sharesTotal: type: string description: Total redemption shares currencyShares: type: string description: Share token currency sharesNetValue: type: string description: Current share net value currencyNet: type: string description: Net asset value currency redeemAssetMap: type: object description: Redeemed asset list additionalProperties: type: string properties: {} FundRedeemSharesCheckReqDto: type: object required: - fundIdList properties: fundIdList: type: array description: Fund ID items: type: integer format: int64 checkTag: type: boolean description: Preview false, confirm shares true BaseResultListKycAuthVO: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: array description: Data Body items: *ref_9 ok: type: boolean fail: type: boolean BaseResultVoid: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: $ref: '#/components/schemas/Void' ok: type: boolean fail: type: boolean Void: *ref_51 BaseResultFundApplyCalcDto: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: $ref: '#/components/schemas/FundApplyCalcDto' ok: type: boolean fail: type: boolean FundApplyCalcDto: type: object properties: fees: type: string description: Commission fee shares: type: string description: Expected shares to receive sharesNet: type: string description: Net Value rate: type: string description: Exchange Rate currencyNet: type: string description: Net Asset Value Currency currencyPay: type: string description: Currency of the fee amountPay: type: string description: Amount of assets to be paid list: type: array description: List of assets in a basket items: *ref_52 BaseResultBasePageVoCustomerAdjustProposalDto: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: $ref: '#/components/schemas/BasePageVoCustomerAdjustProposalDto' ok: type: boolean fail: type: boolean BasePageVoCustomerAdjustProposalDto: type: object properties: records: type: array description: Result list items: $ref: '#/components/schemas/CustomerAdjustProposalDto' total: type: integer format: int64 description: Total size: type: integer format: int64 description: Number of Items per Page current: type: integer format: int64 description: Current Page CustomerAdjustProposalDto: type: object required: - tradeType properties: companyId: type: integer format: int64 description: Company ID customerId: type: integer format: int64 description: Client ID customerNo: type: string description: Client number accountId: type: integer format: int64 description: Account ID id: type: integer format: int64 description: Primary key id status: type: integer format: int32 description: Status 1, 2, 3, enable, disable, delete createBy: type: string description: Creator createTime: type: integer format: int64 description: Creation time updateBy: type: string description: Updater updateTime: type: integer format: int64 description: Update Time tradeType: type: integer format: int64 proposalNo: type: string description: Proposal number businessType: type: integer format: int32 description: Business type code accountCurrency: type: string description: Account currency (trading account currency) amount: type: number description: Proposal Amount withdraw: type: boolean description: Whether withdrawal is allowed operatorPassword: type: string description: Operator's fund password checkBy: type: string description: Approver checkStatus: type: integer format: int32 description: >- Proposal status, waiting for manual approval: 1, approval successful: 2, approval failed: 3 remark: type: string description: Remarks thirdOrderId: type: string description: Third-party order ID resetAccount: type: boolean description: Whether to clear to zero businessTypeText: type: string thirdAccount: type: string description: Third-party account QueryProposalPageReqDto: type: object properties: size: type: integer format: int64 description: Number of Items per Page current: type: integer format: int64 description: Current Page downloadType: type: integer format: int32 description: 'Download type 1: direct download, 2: asynchronous download' orders: type: array description: Sorting field list items: *ref_46 startTime: type: integer format: int64 endTime: type: integer format: int64 withdrawType: type: integer format: int32 description: >- Withdrawal type, Withdrawal: 1 (Withdraw to bank card), Withdrawal: 2 (Withdraw digital currency to digital wallet) depositCurrency: type: string description: Deposit Currency paymentCurrency: type: string description: Payment currency accountCurrency: type: string description: Account Currency (Customer Debit Currency) withdrawCurrency: type: string description: Withdrawal Currency (Customer Credit Currency) rechargeType: type: string description: 'Recharge Method, 1: Direct Recharge, 2: Remittance' txid: type: string description: Transaction id depositStatus: type: string description: Deposit Status paymentStatus: type: string description: Payment Status businessType: type: string BaseResultSpotQueryOrderPageVo: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: description: Data Body $ref: '#/components/schemas/BasePageVoSpotQueryOrderVo' ok: type: boolean fail: type: boolean BasePageVoSpotQueryOrderVo: type: object properties: records: type: array description: Result list items: &ref_56 $ref: '#/components/schemas/SpotQueryOrderVo' total: type: integer format: int64 description: Total size: type: integer format: int64 description: Number of Items per Page current: type: integer format: int64 description: Current Page SpotQueryOrderVo: type: object properties: busiiType: type: integer format: int32 direction: type: integer format: int32 status: type: integer format: int32 userGroupId: type: integer format: int64 symbolId: type: integer format: int64 digits: type: integer format: int64 contractSize: type: integer format: int32 requestPrice: type: number requestNum: type: number requestTime: type: integer format: int64 executeMarginRate: type: integer format: int32 executeMarginRateDigits: type: integer format: int32 spread: type: integer format: int32 pointRatio: type: integer format: int32 executePrice: type: number executeRate: type: integer format: int64 rateDigits: type: integer format: int64 fee: type: number feeDigits: type: integer format: int64 executeTime: type: integer format: int64 createTime: type: integer format: int64 updateTime: type: integer format: int64 positionId: type: integer format: int64 stopLoss: type: number takeProfit: type: number remark: type: string source: type: string description: >- H5: mobile web; PC_Web: pcweb; System: system; Android: Android native app; iOS: Apple native app; HOS: Hongmeng OS; PC_Win: pcwindows client; PC_Mac: pcmac client; default is the same as login source. (The enumeration is for reference only) thirdPartyOrder: type: string SpotQueryOrderPageDto: type: object required: - customerGroupId - tradeType properties: tradeType: type: integer format: int64 minimum: 1 customerGroupId: type: integer format: int64 description: Client group ID size: type: integer format: int64 description: Number of Items per Page current: type: integer format: int64 description: Current Page sortFieldName: type: string sortType: type: string orderIds: type: string symbolId: type: integer format: int64 bizType: type: integer format: int64 direction: type: integer format: int64 status: type: integer format: int64 positionId: type: integer format: int64 querySource: type: string description: >- H5: mobile web; PC_Web: pcweb; System: system; Android: Android native app; iOS: Apple native app; HOS: Hongmeng OS; PC_Win: pcwindows client; PC_Mac: pcmac client; default is the same as login source. (The enumeration is for reference only) thirdPartyOrder: type: string BaseResultAmountTransferVo: type: object properties: bizCode: type: string title: Module identifier code code: type: string title: Status return code msg: type: string title: Status description tm: type: integer format: int64 title: Processing time (milliseconds) trace: type: string title: Tracking code msgParams: type: string title: >- Placeholder parameter string in return description, multiple parameters separated by commas ok: type: boolean fail: type: boolean data: title: Data Body $ref: '#/components/schemas/AmountTransferVo' title: BaseResultAmountTransferVo AmountTransferVo: type: object properties: surplusAmount: type: string description: Amount of change required: - surplusAmount CapitalTransferReqDto: type: object required: - amount - toCustomerNo - toTradeType properties: accountId: type: integer format: int64 description: Account ID accountDigit: type: integer format: int32 description: Account Decimal Places toTradeType: type: integer format: int64 description: Transfer to Account Gameplay toAccountId: type: integer format: int64 description: Transfer to Account ID toCustomerNo: type: string description: Transfer to customer number toAccountDigit: type: integer format: int32 description: Transfer to Account Decimal Places amount: type: number description: amount currency: type: string description: Currency for transfer BaseResultMapLongListFundTrendChartTypeDto: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: object description: Data Body additionalProperties: type: array items: type: object properties: {} properties: key: type: integer value: type: array items: $ref: '#/components/schemas/FundTrendChartTypeDto' required: - key - value fail: type: boolean ok: type: boolean title: '' FundTrendChartTypeDto: type: object properties: name: type: string title: Name type: type: integer title: Type description: '1: Market price 2: Net value' columnList: type: array items: *ref_53 required: - name - columnList FundBatchMarketPerfChartVo: *ref_54 ExchangeRateConvertDto: type: object properties: rate: type: string description: Exchange rate formulaSymbol: type: string description: Calculation rule multiply or divide, value is multiply or divide sourceDigits: type: integer format: int32 description: Decimal places of source currency targetDigits: type: integer format: int32 description: Decimal places of target currency sourceCurrency: type: string description: Source Currency Code targetCurrency: type: string description: Target Currency Code BaseResultQueryCustomerWithdrawExchangeRateDto: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: *ref_55 ok: type: boolean fail: type: boolean QueryCustomerWithdrawExchangeRateDto: type: object properties: accountId: type: integer format: int64 description: Account ID customerGroupId: type: integer format: int64 description: Customer group ID withdrawCurrency: type: string description: Customer receiving currency code accountCurrency: type: string description: Account Currency Code exchangeRate: type: number description: Exchange Rate withdrawType: type: integer format: int32 description: >- Withdrawal type, Withdrawal: 1 (Withdraw to bank card), Withdrawal: 2 (Withdraw digital currency to digital wallet) withdrawMethod: type: string description: 'Withdrawal method, bank card: bank, digital wallet: digit_wallet' blockchainName: type: string description: >- Chain name, data dictionary configuration, payment method is digital wallet, display the corresponding chain name (also known as transfer network), such as Omin, ERC20, TRC20 BaseResultSpotQueryOrderVo: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: *ref_56 ok: type: boolean fail: type: boolean SpotOrderUpdateDto: type: object required: - customerGroupId - orderId - tradeType properties: tradeType: type: integer format: int64 minimum: 1 customerGroupId: type: integer format: int64 description: Client group ID orderId: type: integer format: int64 remark: type: string MarkOpenCardDepositRateDto: type: object required: - paymentCurrency - blockchainName - depositRateSerialNo properties: depositRateSerialNo: type: string description: Deposit exchange rate serial number paymentCurrency: type: string description: Payment currency blockchainName: type: string description: Chain Name address: type: string description: Receiving address BaseResultComputeWithdrawFeeRespDto: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: $ref: '#/components/schemas/ComputeWithdrawFeeRespDto' ok: type: boolean fail: type: boolean ComputeWithdrawFeeRespDto: type: object required: - tradeType properties: tradeType: type: integer format: int64 finalAmount: type: string description: Expected receipt (receiving currency) withdrawFee: type: string description: Withdrawal fee (account currency) coinFee: type: string description: Withdrawal fee (withdrawal currency) coinFinalAmount: type: string description: Expected receipt (withdrawal currency) amount: type: string description: Account deduction limit (account currency) ComputeWithdrawReqDto: type: object required: - amount - tradeType - withdrawRateSerialNo - withdrawType properties: tradeType: type: integer format: int64 customerGroupId: type: integer format: int64 description: Customer group ID country: type: string description: Country accountCurrency: type: string description: Account currency (trading account currency) withdrawCurrency: type: string description: Withdrawal currency (currency supported by payment channels) amount: type: string description: Withdrawal/Withdrawal amount withdrawRateSerialNo: type: string description: Withdrawal fee rate serial number rate: type: string description: Withdrawal exchange rate sent to platform CATS2 withdrawType: type: integer format: int32 description: >- Withdrawal type, Withdrawal: 1 (Withdraw to bank card), Withdrawal: 2 (Withdraw digital currency to digital wallet) withdrawMethod: type: string description: >- Withdrawal method, Bank card: bank, Digital wallet: digit_wallet, Skrill e-wallet: skrill_wallet, Telegraphic transfer: wire blockchainName: type: string description: >- Chain name, data dictionary configuration, payment method is digital wallet, display the corresponding chain name (also known as transfer network), such as Omin, ERC20, TRC20 BaseResultCustomerFundRedeemDto: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: *ref_57 ok: type: boolean fail: type: boolean CreateFundRedeemReqDto: type: object required: - currencyCode - fundId - shares properties: fundId: type: integer format: int64 description: Fund ID shares: type: number description: Number of redeemed shares currencyCode: type: string description: Redeemed asset Code BaseResultFundOperationInfoDto: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: $ref: '#/components/schemas/FundOperationInfoDto' ok: type: boolean fail: type: boolean FundOperationInfoDto: type: object properties: id: type: integer format: int64 description: Primary key id status: type: integer format: int32 description: Status 1, 2, 3, enable, disable, delete revision: type: integer format: int32 description: Optimistic lock createBy: type: string description: Creator createTime: type: integer format: int64 description: Creation time updateBy: type: string description: Updater updateTime: type: integer format: int64 description: Update Time fundId: type: integer format: int64 description: Fund ID sharesIssued: type: number description: Total issued shares sharesApply: type: number description: Total subscription shares sharesConfirm: type: number description: Total confirmed shares sharesRedeem: type: number description: Total redeemed shares sharesCurrent: type: number description: Current latest shares FundInfoQueryReqDto: type: object required: - fundId properties: fundId: type: integer format: int64 description: Fund ID BaseResultFundManagementFeesCalcDto: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: $ref: '#/components/schemas/FundManagementFeesCalcDto' ok: type: boolean fail: type: boolean FundManagementFeesCalcDto: type: object properties: amount: type: string description: Total amount currency: type: string description: Currency FundManagementFeesDeductDto: type: object properties: idList: type: array items: type: integer format: int64 BaseResultListExchangeRateConvertDto: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: array description: Data Body items: *ref_58 ok: type: boolean fail: type: boolean BaseResult1: &ref_60 type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: object description: Data Body properties: {} ok: type: boolean fail: type: boolean FundExchangeRateBatchQueryDto: type: object required: - companyId - currencies properties: companyId: type: integer format: int64 description: Company ID trace: type: string description: Tracking code ip: type: string description: Operation IP lang: type: string description: Request Language currencies: type: array description: Exchange currency pair list, non-empty, maximum length of list is 50 items: $ref: '#/components/schemas/CurrencyPair' maxItems: 50 minItems: 1 CurrencyPair: type: object properties: source: type: string description: Source Currency Code target: type: string description: Target Currency Code BaseResultCustomerFundApplyDto: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: *ref_59 ok: type: boolean fail: type: boolean CreateFundApplyReqDto: type: object required: - amountPay - fundId properties: customerNo: type: string title: Client number currencyPay: type: string description: Payment currency, or a basket title: Payment currency amountPay: type: number description: 'By amount: payment amount, by shares: subscription shares' title: Payment limit applyType: type: integer format: int32 description: 1. By amount, 2. By shares title: Subscription type fundId: type: integer title: Fund ID FundBaseDto: *ref_51 BaseResultBoolean: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: boolean description: Data Body ok: type: boolean fail: type: boolean BaseResultBasePageVoSpotSubjectWaterVo: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: $ref: '#/components/schemas/BasePageVoSubjectWaterVo' ok: type: boolean fail: type: boolean BasePageVoSubjectWaterVo: type: object properties: records: type: array description: Result list items: $ref: '#/components/schemas/SpotSubjectWaterVo' total: type: integer format: int64 description: Total size: type: integer format: int64 description: Number of Items per Page current: type: integer format: int64 description: Current Page SpotSubjectWaterVo: type: object properties: id: type: integer format: int64 remark: type: string createdBy: type: integer format: int64 createTime: type: integer format: int64 updateBy: type: integer format: int64 updateTime: type: integer format: int64 subjectId: type: integer format: int64 version: type: integer format: int64 bookkeepId: type: integer format: int64 amountIn: type: string amountOut: type: string status: type: integer format: int32 amountAfter: type: string businessType: type: integer format: int32 businessType1: type: integer format: int32 customerNo: type: string amount: type: string digits: type: integer format: int32 currency: type: string businessTypeName: type: string businessType1Name: type: string orderId: type: string description: Order ID dealId: type: string description: Transaction order Id SpotQueryWaterPageDto: type: object required: - customerGroupId - tradeType properties: tradeType: type: integer format: int64 minimum: 1 description: Game type customerGroupId: type: integer format: int64 description: Client group ID size: type: integer format: int64 description: Number of Items per Page current: type: integer format: int64 description: Current Page sortFieldName: type: string sortType: type: string businessType: type: integer format: int32 status: type: integer format: int32 customerNoStr: type: string startTime: type: integer format: int64 endTime: type: integer format: int64 operate: type: integer format: int32 BaseResultCustomerRechargeWalletAddrRespDto: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: $ref: '#/components/schemas/CustomerRechargeWalletAddrRespDto' ok: type: boolean fail: type: boolean CustomerRechargeWalletAddrRespDto: type: object properties: paymentCode: type: string description: Payment channel code currency: type: string description: Payment currency blockchainName: type: string description: Chain Name address: type: string description: Payment address expireTime: type: integer description: Address expiration time CustomerRechargeWalletAddrReqDto: type: object required: - accountCurrency - blockchainName - country - customerGroupId - paymentChannelClientType - paymentChannelCode - paymentChannelType - paymentMerchantNo properties: customerGroupId: type: integer format: int64 description: Customer group ID paymentChannelCode: type: string description: Payment Channel Code paymentChannelType: type: string description: Payment Channel Type paymentMerchantNo: type: string description: Payment merchant number paymentChannelClientType: type: string description: Payment channel client type pc, mobile accountCurrency: type: string description: Account Currency Code blockchainName: type: string description: Chain Name country: type: string description: Country (Country where the customer account is opened) extend: type: string description: Extended Fields BaseResultListSingleAssetPerformanceDto: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: type: array description: Data Body items: $ref: '#/components/schemas/SingleAssetPerformanceDto' fail: type: boolean ok: type: boolean title: '' SingleAssetPerformanceDto: type: object properties: type: type: integer format: int32 quoteChange: type: string xaxisName: type: string title: '' SingeAssetPerformanceChartVo: type: object properties: symbolId: type: integer format: int64 title: Product ID description: Choose either fundId or symbolId fundId: type: integer format: int64 title: Fund ID description: Choose either symbolId or fundId statisticType: type: integer description: 1:Day 2:Week 3:Month title: Statistical Type required: - statisticType title: '' BaseResultObject: *ref_60 BaseResultSpotOrderAddVo: type: object properties: bizCode: type: string description: Module identifier code code: type: string description: Status return code msg: type: string description: Status description tm: type: integer format: int64 description: Processing time (milliseconds) trace: type: string description: Tracking code msgParams: type: string description: >- Placeholder parameter string in return description, multiple parameters separated by commas data: $ref: '#/components/schemas/SpotOrderAddVo' ok: type: boolean fail: type: boolean SpotOrderAddVo: type: object properties: orderId: type: integer format: int64 tradeVolume: type: string executePrice: type: string openDirection: type: integer format: int32 direction: type: integer format: int32 symbolName: type: string symbolId: type: integer format: int64 digits: type: integer format: int32 fee: type: string lockToken: type: string inCurrency: type: string inDigits: type: integer format: int32 inAmount: type: number SpotOrderAddDto: type: object required: - bizType - direction - requestPrice - symbolId - tradeType - requestNum properties: tradeType: type: integer format: int64 minimum: 1 description: Game Type, fixed value 5 bizType: type: integer format: int32 description: 'Order Business Type (Market Price: 12, Limit Price: 13)' direction: type: integer format: int32 description: 'Order Buy/Sell Direction (Buy Direction: 1; Sell Direction: 2)' symbolId: type: integer format: int64 description: Product ID accountCurrency: type: string requestTime: type: integer format: int64 requestPrice: type: number description: Request Price requestNum: type: number description: >- Request Quantity (Buy Direction, when requesting amount; Sell Direction, when requesting quantity) accountDigits: type: integer format: int32 remark: type: string entryType: type: integer format: int32 description: >- Order Type. 1-By Quantity; 2-By Amount; (if not passed, default Buy By Amount, Sell By Quantity) expiryType: type: string description: Expiration Type. 1-1 Day; 2-7 Days; 3-30 Days; 4-90 Days. Default 4 BaseResultListIndexSingleAssetPerformanceVo: type: object properties: bizCode: type: string title: Module identifier code code: type: string title: Status return code msg: type: string title: Status description tm: type: integer format: int64 title: Processing time description: 'Unit: milliseconds' trace: type: string title: Tracking code msgParams: type: string description: Multiple parameters are separated by commas title: Return description with placeholder parameter string data: type: array items: $ref: '#/components/schemas/IndexSingleAssetPerformanceVo' title: Data Body fail: type: boolean ok: type: boolean title: '' IndexSingleAssetPerformanceVo: type: object properties: xaxisName: type: string title: X-Axis Name quoteChange: type: string title: Price Change Percentage title: '' BaseResultListIndexSymbolCombinationVo: type: object properties: bizCode: type: string title: Module identifier code code: type: string title: Status return code msg: type: string title: Status description tm: type: integer format: int64 description: 'Unit: milliseconds' title: Processing time trace: type: string title: Tracking code msgParams: type: string description: Multiple parameters are separated by commas title: Return description with placeholder parameter string data: type: array items: $ref: '#/components/schemas/IndexSymbolCombinationVo' title: Data Body fail: type: boolean ok: type: boolean title: '' IndexSymbolCombinationVo: type: object properties: asset: type: string title: Product Base Currency range: type: integer format: int32 title: Ranking weight: type: string title: Weight previousPeriodRangeCompare: type: string title: Change in Ranking from Previous Period previousPeriodWeightCompare: type: string title: Change in Weight from Previous Period title: '' IndexChartDto: type: object properties: indexId: type: integer format: int64 title: Index ID required: - indexId title: '' EnableOrForbidMFADTO: type: object required: - googleId - type properties: lang: type: string description: Language Information customerNo: type: string description: Client number id: type: integer format: int64 description: Client Id verifyCodeSMS: type: string description: Email Verification Code sendTokenSMS: type: string description: Email verification code sending ticket verifyCodeEmail: type: string description: Mobile Verification Code sendTokenEmail: type: string description: Mobile verification code sent ticket googleCode: type: string description: Google Verification Code type: type: integer format: int32 description: Type, 1 Enable 2 Disable minimum: 1 maximum: 2 googleId: type: integer format: int64 description: Google ID minimum: 1 securitySchemes: {} servers: - url: https://prepc-utgl.cmfbl.com/api description: PRE-UTGL-Defi-Staking