# Overview ## Welcome Welcome to the MultiMarkets API documentation. We provide complete REST and WebSocket APIs to meet your trading needs. ​ ## What is MultiMarkets It is a white label solution for exchange systems that can quickly build your financial system, foreign exchange trading, stock quotation system, hedging transaction and cryptocurrency quotation system. Supports multiple trading strategies: contract, spot, risk hedging (single transaction mode) Rich open interfaces, convenient and quick access to mainstream payment systems, and rapid business promotion activities Multi-client support (H5, PC, APP), rich market icons, multiple indicators Powerful backend management supports mainstream white label models and enables the simultaneous development of multiple business models. Flexible parameter configuration capability, various transaction parameter configurations take effect in real time ## Main feature Full interface coverage: rich open interface capabilities, supporting white label API, client API and external settlement API, etc. Stable data push: Supports real-time subscription and push of white label business data to ensure data accuracy and realize customized services. Real-time transaction data: REST API and WebSocket access ensure low latency and high reliability of transaction data. ## Scenes to be used Customized client: When you need a white label customized client, you need to refer to this API for client development. External settlement of funds: When the white label has its own wallet account, it can achieve wallet settlement during transactions by accessing this API, without going through a MultiMarkets account. Implement promotion activities: When the white label needs to promote activities, it can access this API to obtain user registration, recharge, and transaction data, and issue bonuses. Personal quantification system: Personal quantification users can apply for apikey through this API and use automated procedures to achieve quantitative transactions. Three-party messaging system: When the white label has its own messaging channel, it can access the white label user’s messages through the open messaging interface and push them to the user terminal through its own channel.\
## API Architecture
# Status Get the status of system upgrade events. Temporary unavailability and WebSocket disconnections (users can reconnect immediately) caused by planned system maintenance will not be announced. Such maintenance will only be performed during periods of low market volatility. [Check the service status online](https://api-status.multimarkets.org/) # Overview Based on this API, white label businesses can develop their own trading clients, such as H5, APP, etc. For a detailed API list, you can directly jump to the online address: [Online API documentation](https://multimarkets-c-api-en.apidocumentation.com) # Access # Sign ### Signature Rules 1\. Connector Rule: > In the signature, an & represents a connector and not an operator. > > The signature rule states that the “signature” in the body is not part of the signature calculation. However, the “timestamp” in the header must be part of the body signature. 2\. Parameter Sorting: > Sort the remaining parameters by their names in ascending dictionary order (ascending ASCII order). > > Only parameters with non-empty values and of number or string type are considered for the signature. > > Concatenate the key-value pairs in the format “key=value”. Link multiple parameters with an & to obtain a string A. Parameters with empty values are not included in the signature. 3\. Timestamp Inclusion: > Add timestamp=TIMESTAMP\_VALUE to obtain string B. > > Concatenate B & A to get string C. 4\. MD5 Encryption: > Encrypt string C using MD5 and convert all resulting letters to uppercase to obtain the final value D, which is the “signature” value. 5\. Signature Addition and Encoding: > Add the “signature” to the body. > > Convert the body to JSON and then encode it to get string E. 6\. RSA Encryption: > Encrypt string E using the company’s public key to obtain string F. > > If the length of F exceeds 100, encrypt F in segments of 100 using RSA and join the encrypted segments with a comma to get the final encrypted string F. 7\. Final Request Structure: > The final request parameters should be structured as follows: ```json //header { "timestamp": 11111131331, "trace": "xxxxxx" } //body { "data": F } ``` ### Signature Example： 1\. Concatenation: > Concatenate the parameters in ascending order: a=1\&b=2\&c=3\×tamp=11111131331 to get string A. 2\. Timestamp: > Add timestamp: timestamp=11111131331 to get string B. 3\. Final Concatenation: > Concatenate A and B to get string C: timestamp=11111131331\&a=1\&b=2\&c=3\×tamp=11111131331. 4\. MD5 Encryption: > Encrypt string C using MD5 and convert the result to uppercase to get the final signature key. 5\. JSON Encoding: > Convert all body parameters to JSON and then encode to get string E. 6\. RSA Encryption: > Encrypt string E using the company’s public key to get string F. > > If string E has a length greater than 100, segment E and encrypt each segment: RSA(E\[0-100])=E1, RSA(E\[remaining length])=E2, then concatenate E1 and E2 with a comma to obtain the final encrypted string F (F = E1,E2). ```json //header { "timestamp": 11111131331, "trace": "xxxxxx" } //body { "a": 1, "b": 2, "c": "3", "signature": "44b3a042-dd5d-4796-92e1-651927b6ada9" } ``` ### JAVA DEMO # Request ## 1.Interface address=>HTTP ``` http://ip:port/path/ ``` DEMO如下： ```http POST http://127.0.0.1:9008/login/{bizType} # login POST http://127.0.0.1:9008/register/{bizType} # register POST http://127.0.0.1:9008/logout # logout POST http://127.0.0.1:9008/global/{bizType} # other request ... ``` Request method: POST ### 1.2 Request ``` Request header information Request body information, transmitted in the form of content-type=application/json ``` #### 1.2.1 Header Request Parameters | parameter | type | required | describe | | --------- | ------ | ------------ | -------------------------------------------- | | companyId | long | Required | System unique company identifier | | trace | String | Required | Global link unique identifier | | timestamp | long | Required | Timestamp, milliseconds | | version | String | Not required | Interface version number | | group | String | Not required | Interface Grouping | | lang | String | Not required | Language information, default is zh-CN | | token | String | Not required | Token information, required after logging in | #### 1.2.2 Request Body Parameters | parameter | type | required | describe | | --------- | ---- | -------- | ------------------------- | | bizBody | JSON | Required | Request message body，JSON | ## 1.2 Interface address=>websocket ``` ws://ip:port/path/ws ``` The DEMO is as follows: ``` ws://127.0.0.1:9008/ws ``` Pass in parameters: | parameter | type | required | describe | | --------- | ---- | -------- | -------------------- | | header | JSON | Required | Consistent with http | | body | JSON | Required | Consistent with http | The DEMO is as follows: ``` { "header": { "trace": "trace", "token": "token", "bizType": "customer.CustomerWebApiService.login", "version": "0.0.1", "group": "", "companyId": 11, "timestamp": 11111131331, "lang":"zh-CN" }, "body": { "type": 3, "loginName": "139" } } ``` The heartbeat format is as follows: bizType is fixed to ping ``` { "header": { "trace": "trace", "token": "token", "bizType": "ping", "sendTime":1617246557505, "lang":"zh-CN"， "timestamp": 11111131331 } } ``` The format of the heartbeat return message body is as follows: bizType is fixed to pong ``` { "trace": "Original parameters returned", "token": "Original parameters returned", "bizType": "pong", "sendTime": 1617678792458, "lang": "zh-CN" } ``` Return parameter: | parameter | | type | describe | | --------- | - | ------ | ---------------------------------------------------------------------------------------------------- | | code | | String | System general return code. 0-success, other exceptions | | msg | | String | returned messages | | bizCode | | String | Module identification code | | tm | | Long | Processing time (milliseconds) | | trace | | String | Global link flag information | | msgParams | | String | Returns the placeholder parameter string in the description. Multiple parameters are separated by , | | data | | Object | Data body, unified return of each business response information, return bizType in case of exception | # Limit ## Speed ​​Limit MultiMarkets aims to provide a stable and secure platform for all users at all times. Therefore, all parties continuously monitor traffic to identify patterns that could negatively impact the network. If the traffic from a single account is identified as too high and the rate limit is reached, MultiMarkets may temporarily throttle or restrict that account. You have a rate limit on a per API endpoint and per minute basis. If your rate limit is reached, you will see an HTTP 429 error response letting you know that your rate limit has been temporarily exceeded. Partners should handle HTTP 429 status codes gracefully and drop and/or retry requests accordingly. The following headers are returned with every request. If a less restrictive rate limit is required, please contact your implementation manager to determine your use case. Please note that increasing the rate limit may incur additional charges. ## Parameters The response header returned by the interface will include the following three fields, which respectively represent: x-ratelimit-limit represents the total number of calls that can be made in the current cycle, x-ratelimit-remairing represents the number of remaining calls in the current cycle, and x-ratelimit-reset represents the cycle time in seconds. > x-ratelimit-limit: 300 > > x-ratelimit-remairing: 299 > > x-ratelimit-reset: 60 The above example: indicates that the interface can be called 300 times per minute, and currently there are 299 remaining calls that can be called # Error Code The error code returned by the interface exception can be found by referring to the error code to locate the problem ``` G500=System abnormality GGATEWAY_CODE_001=TOKEN information is empty GGATEWAY_CODE_002=Invalid business type GGATEWAY_CODE_003=Company id cannot be empty GGATEWAY_CODE_004=Global link flag cannot be empty GGATEWAY_CODE_005=Login information has expired, please log in again GGATEWAY_CODE_006=Request parameter is empty GGATEWAY_CODE_008=Business type cannot be empty GGATEWAY_CODE_009=Request header cannot be empty GGATEWAY_CODE_010=Downstream interface does not exist GGATEWAY_CODE_011=Downstream service abnormality, please contact customer service GGATEWAY_ CODE_012=Downstream service is unavailable GGATEWAY_CODE_013=Downstream service returns empty result GGATEWAY_CODE_014=Request expired GGATEWAY_CODE_015=Request parameters are illegal GGATEWAY_CODE_016=The current interface does not support this request type GGATEWAY_CODE_017=Login information has expired, please log in again GGATEWAY_CODE_101=Invalid account information GGATEWAY_CODE_102=Data abnormal, please try again later GGATEWAY_CODE_103=The current upload file format is not supported, please upload a file in %s format GGATEWAY_CODE_104=The current interface parameters are abnormal, please check and try again GGATEWAY_CODE_016=The current interface parameters are abnormal, please check and try again GGATEWAY_CODE_017=Login information has expired, please log in again GGATEWAY_CODE_011=Invalid account information ... AY_CODE_902=Service timeout, please contact customer service GGATEWAY_CODE_201=Current interface is not open, please contact customer service US500=System abnormality USCUSTOMER_API_0000002=System abnormality, interface has been abandoned USCUSTOMER_API_0000003=Data does not exist USCUSTOMER_API_0000004=Service is being processed, current operation is prohibited USCUSTOMER_API_0000005=Data abnormality, please try again later USCUSTOMER_API_0000006=Your current APP version is too low, please download and install the latest version on the official website USCUSTOMER_API_0000007=Simulated companies cannot register and open accounts USCUSTOMER_ API_0000008=Real account cannot reset account information USCUSTOMER_API_0000009=Resetting demo account, please try again after %s minutes or contact customer service USCUSTOMER_API_0000101=Customer information already exists USCUSTOMER_API_0000102=Account or password is incorrect USCUSTOMER_API_0000103=Login is prohibited, please contact customer service USCUSTOMER_API_0000104=Customer details data is abnormal USCUSTOMER_API_0000105=At least one of the mobile phone number or email address cannot be empty USCUSTOMER_API_0000106=The mobile phone number already exists USCUSTOMER_API_00001 07=The email already exists USCUSTOMER_API_0000108=An exception occurred while getting the customer number USCUSTOMER_API_0000109=An exception occurred while getting the company customer number range USCUSTOMER_API_0000110=The company customer number exceeds the specified range USCUSTOMER_API_0000111=The company does not exist or the operation is prohibited USCUSTOMER_API_0000112=The account or password is incorrect USCUSTOMER_API_0000113=The account is locked and login is prohibited USCUSTOMER_API_0000114=The company asset information does not exist USCUSTOMER_API_0000115=The company asset information does not match USCUSTOMER_API_0000116=The company asset information does not match USCUSTOMER_API_0000117=The company asset information does not match USCUSTOMER_API_0000118=The company asset information does not match USCUSTOMER_API_0000119=The company asset information does not match USCUSTOMER_API_0000111 R_API_0000116=The customer account asset information does not match the new customer group, and the group cannot be transferred USCUSTOMER_API_0000117=The customer account has positions, and the account cannot be closed USCUSTOMER_API_0000118=The customer account has a balance, and the account cannot be closed USCUSTOMER_API_0000119=The customer has an unfinished proposal, and the account cannot be closed USCUSTOMER_API_0000120=The new customer group does not have the position product authority, and the group cannot be transferred USCUSTOMER_API_0000121=This mobile phone number has been bound, please change the mobile phone USCUSTOMER_API_0000122=This email has been bound, please change the email USCUSTOMER_API_0000123=The new password cannot be the same as the old password Same USCUSTOMER_API_0000124=Old password is incorrect USCUSTOMER_API_0000125=Password cannot be empty USCUSTOMER_API_0000126=The corresponding gameplay information of the customer group does not match, and the group cannot be transferred USCUSTOMER_API_0000127=The customer has debts and cannot close the account USCUSTOMER_API_0000132=The fund password is incorrect. If you enter the wrong password %s times in a row, you cannot withdraw cash within %s hours USCUSTOMER_API_0000133=The fund password has been set USCUSTOMER_API_0000134=The fund password has been entered incorrectly %s times in a row. Please try again after %s hours or contact customer service USCUSTOMER_API_0000135=Has been The login password has been set USCUSTOMER_API_0000136=Please enter the correct mobile phone number USCUSTOMER_API_0000137=Please enter the correct email address USCUSTOMER_API_0000138=The customer has enabled MFA authentication USCUSTOMER_API_0000139=The password strength requirement is too low, please reset it USCUSTOMER_API_0000141=Your email address has been bound to another %s account, please change the email address and try again USCUSTOMER_API_0000301=The customer group information does not exist USCUSTOMER_API_0000302=The default customer group cannot be deleted USCUSTOMER_API_0000303=The customer corresponding customer group information does not exist USCUSTOMER_API_0000304=The default customer group cannot be deleted USCUSTOMER_API_0000305=The customer corresponding customer group information does not exist USCUSTOMER_API_0000306=The default customer group cannot be deleted USCUSTOMER_API_0000307=The customer corresponding customer group information does not exist USCUSTOMER_API_0000308=The default customer group cannot be deleted USCUSTOMER_API_0000309=The customer corresponding customer group information does not exist USCUSTOMER_API_0000301=The customer group information does not exist USCUSTOMER_API_0000302=The default customer group cannot be deleted USCUSTOMER_API_0000303=The customer corresponding customer group information does not exist USCUSTOMER_API_0000308=The customer corresponding customer group information does not exist USCUSTOMER_API_0000309=The customer corresponding customer group information does not exist USCUSTOMER_API_0000 USTOMER_API_0000304=There are customers under the customer group, and it cannot be deleted USCUSTOMER_API_0000305=There is an exception when deleting products under the customer group USCUSTOMER_API_0000306=The company has not configured an account opening group, and cannot register USCUSTOMER_API_0000307=The customer group name cannot be repeated USCUSTOMER_API_0000308=There is at least one account opening group in the customer group USCUSTOMER_API_0000309=The account opening group cannot be deleted USCUSTOMER_API_0000310=The asset information of the account opening group is empty USCUSTOMER_API_0000311=The company's account opening group information is abnormal USCUSTOMER_API_0000312=Company The asset information of the account opening group does not match USCUSTOMER_API_0000313=The gameplay information of the company account opening group is empty USCUSTOMER_API_0000314=The gameplay information of the company account opening group does not match USCUSTOMER_API_0000315=The gameplay asset information of the company customer group does not match USCUSTOMER_API_0000501=Required parameters cannot be empty USCUSTOMER_API_0000502=Mobile phone number cannot be empty USCUSTOMER_API_0000503=The length of the mobile phone number is illegal USCUSTOMER_API_0000504=The format of the mobile phone number is illegal USCUSTOMER_API_0000505=The mobile phone area code cannot be empty USCUSTOMER_API _0000506=The length of the mobile phone area code is illegal USCUSTOMER_API_0000507=The mobile phone area code is illegal USCUSTOMER_API_0000508=The email address cannot be empty USCUSTOMER_API_0000509=The email address length is illegal USCUSTOMER_API_0000510=The email address format is illegal USCUSTOMER_API_0000511=The verification code is incorrect USCUSTOMER_API_0000512=Too many verification code errors, try again later USCUSTOMER_API_0000513=The new mobile phone verification code is incorrect USCUSTOMER_API_0000514=The original mobile phone verification code is incorrect USCUSTOMER_API_00005 15=New email verification code is incorrect USCUSTOMER_API_0000516=Original email verification code is incorrect USCUSTOMER_API_0000517=Email verification code is incorrect USCUSTOMER_API_0000518=Mobile verification code is incorrect USCUSTOMER_API_0000519=Google verification code is incorrect USCUSTOMER_API_0000520=Google verification code cannot be empty USCUSTOMER_API_0000521=At least one of the email and mobile verification code cannot be empty USCUSTOMER_API_0000601=KYC has been submitted and is under review, please wait USCUSTOMER_API_0000602=The company has not configured KYC certification information USCUS TOMER_API_0000603=The KYC certification information of this customer was not found USCUSTOMER_API_0000604=The KYC certification of this business customer passed USCUSTOMER_API_0000605=KYC has been submitted and is under review. Please wait USCUSTOMER_API_0000606=The KYC certification of this business customer was rejected USCUSTOMER_API_0000607=The customer KYC certification information is empty USCUSTOMER_API_0000608=The data has been approved. Please do not repeat the operation USCUSTOMER_API_0000609=The current business KYC certification result information USCUSTOMER_API_0000610=KYC review failed USCUSTOMER _API_0000611=KYC audit information does not exist USCUSTOMER_API_0000612=KYC information does not exist USCUSTOMER_API_0000613=KYC information failed to save USCUSTOMER_API_0000614=KYC element already exists in this KYC level USCUSTOMER_API_0000615=KYC corresponding level information is empty or the sort is empty USCUSTOMER_API_0000616=KYC cannot cross level settings USCUSTOMER_API_0000617=Business scenario already exists in other KYC levels USCUSTOMER_API_0000618=KYC element already exists in other KYC levels USCUSTOMER_API_ 0000619=Please delete the high-level KYC first USCUSTOMER_API_0000620=KYC element format is abnormal USCUSTOMER_API_0000624=This country does not support corporate account opening USCUSTOMER_API_0000632=The mobile phone number you entered has been used USCUSTOMER_API_0000633=The ID number you entered has been used USCUSTOMER_API_0000701=The bank card number already exists USCUSTOMER_API_0000702=Add up to 5 wallets of the same currency USCUSTOMER_API_0000703=The wallet of this currency already exists USCUSTOMER_API_0000705=There are multiple payment addresses of this type USCUSTOMER_API_0000706=This type of payment address does not exist USCUSTOMER_API_0000707=This bank account already exists USCUSTOMER_API_0000801=Account cancellation information does not exist USCUSTOMER_API_0000802=Account cancellation review failed USCUSTOMER_API_0000803=The customer account has positions, and the review failed USCUSTOMER_API_0000804=The customer account has a balance, and the review failed USCUSTOMER_API_0000805=The customer has an unfinished proposal, and the review failed USCUSTOMER_API_0000807=Your account cancellation application has been successfully submitted, and this application will be processed within 1-2 working days. USCUSTOMER_API_0000901=Failed to decrypt the agent ID information USCUSTOMER_API_0000902=Invalid third-party service operation information USCUSTOMER_API_0000903=The upper agent number is empty USCUSTOMER_API_00010001=Your account opening application has been received. We will process it as soon as possible. If you have any questions, please contact customer service USCUSTOMER_API_00010002=Sorry, account opening failed. If you have any questions, please contact customer service USCUSTOMER_API_00011001=The current application permission is invalid USCUSTOMER_API_00011002=The number of API applications has exceeded the upper limit Limited USCUSTOMER_API_00011003=The API tag already exists USCUSTOMER_API_0000142=Your mobile number has been bound to another %s account, please change your mobile number and try again USCUSTOMER_API_0001025=The current interface parameters are abnormal, please check and try again USCUSTOMER_API_0001029=No permission, access denied ``` # API Address ## PRE test environment address ## PRD official environment address # API Code ## Postman Collections The Postman collection is now available. Recommended for new users looking to quickly and easily get started with APIs. ## Swagger Below is a YAML file containing the OpenAPI specification of the RESTful API, as well as a Swagger UI page for reference. ## Contact us * [API Telegram Group](https://t.me/Multi_Markets_Greet) * Ask questions about API or Websockets performance. * Consult API questions not covered in the documentation. * [Developer Community](https://t.me/Multi_Markets_Greet) * Consult about API/Websockets code implementation, or any API/Websockets issues. * [Telegram Customer Service](https://t.me/Nana_support) * Consulting about accounts, wallets, 2FA, etc. # Login Trading client login authorization ## Introduction This interface is used to log in to the trading system when customizing the client, and to subscribe to quotes and place trading orders. ## Interface ### Email/Mobile phone number login {% openapi src="/files/5GLLyQq34kkKHu3xlElj" path="/login/customer.app.CustomerWebApiService.login" method="post" %} [MultiMarkets-ClientAPI.openapi.en.yaml](https://3404072034-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FvilfBi544sqSg2yLNueg%2Fuploads%2FSs3fEdIXpRTn0mqBDkuQ%2FMultiMarkets-ClientAPI.openapi.en.yaml?alt=media\&token=e5badae2-4fd4-4801-93ed-5a2e30a5a0a9) {% endopenapi %} ### Login with social account {% openapi src="/files/5GLLyQq34kkKHu3xlElj" path="/global/customer.app.CustomerThirdLoginService.config" method="post" %} [MultiMarkets-ClientAPI.openapi.en.yaml](https://3404072034-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FvilfBi544sqSg2yLNueg%2Fuploads%2FSs3fEdIXpRTn0mqBDkuQ%2FMultiMarkets-ClientAPI.openapi.en.yaml?alt=media\&token=e5badae2-4fd4-4801-93ed-5a2e30a5a0a9) {% endopenapi %} {% openapi src="/files/5GLLyQq34kkKHu3xlElj" path="/h/com.cats.customer.api.app.CustomerThirdLoginService/googleVerify" method="post" %} [MultiMarkets-ClientAPI.openapi.en.yaml](https://3404072034-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FvilfBi544sqSg2yLNueg%2Fuploads%2FSs3fEdIXpRTn0mqBDkuQ%2FMultiMarkets-ClientAPI.openapi.en.yaml?alt=media\&token=e5badae2-4fd4-4801-93ed-5a2e30a5a0a9) {% endopenapi %} # Captcha Captcha In terms of interface security control, human-machine verification can play a key protective role, especially in complex network environments, to ensure system security and data integrity. The following method provides how to access human-machine verification in the MultiMarket system: ## Verification access > This function is connected to Google's official reCAPTCHA, ## Involved interfaces login/customer.app.CustomerWebApiService.login global/message.app.VerificationApiService.verifyCodeSend register/customer.app.CustomerWebApiService.register ``` headrs: { // Add google captcha to request header captcha: zxksjkdjskdjsd } ``` ## Access steps > For detailed access documents, see: ### Register Google reCAPTCHA and get the key * Register a new website in the management platform , fill in the form and select the reCAPTCHA version (v2 or v3) suitable for your website * After completing the registration, you will get a "Site Key" and a "Secret Key". The site key is used for the front-end, and the secret key is used for back-end verification. ### Front-end page integration (V3 version) Official example: 1. Add the following code to your HTML page, usually in the tag ``` ``` Replace your\_site\_key with the site key you obtained in the Admin console. 2. According to the needs, when the user submits the form (login, registration, get verification code, etc.), call the grecaptcha.execute method to obtain the parameters required for the interface request `captcha` ``` ``` 3. Add the request header when requesting the interface and pass it to the backend for verification ``` headrs: { // Add google captcha to the request header captcha: zxksjkdjskdjsd } ``` 4. Initiate an interface request Pass verification: Request content is returned normally Failed: `{"msg":"Illegal request parameters","code":"F999999","bizCode":"G"}` ### Front-end Vue integration (V3 version) Example: 1. Download and import vue-recaptcha-v3 ```javascript npm i vue-recaptcha-v3 --save // main.js import { VueReCaptcha } from 'vue-recaptcha-v3' app.use(VueReCaptcha, { // Replace with the site key you obtained in the management console siteKey: '6LcNvBUqAAAAABz2_ieWJEtdmyK_-oUUEk04Y1z4', loaderOptions: { // Due to restrictions in some countries, there is an option to enable the use // of recaptcha.net instead of google.com. useRecaptchaNet: true } }) ``` 2. Create the useRecaptcha.js file ```` import { useReCaptcha } from 'vue-recaptcha-v3' import { reactive, onMounted, toRefs } from 'vue' import { useStore } from 'vuex' export default function useRecaptcha () { const { executeRecaptcha: _executeRecaptcha, recaptchaLoaded } = useReCaptcha() const store = useStore() const state = reactive({ // SDK loading loading: false, // SDK loading completed loaded: false }) onMounted(async () => { try { state.loading = true // Initialize Google reCAPTCHA SDK const res = await recaptchaLoaded() if (res) { state.loaded = true } } catch (error) { console.log('🚀 ~ onMounted ~ error:', error) } finally { state.loading = false } }) // Get Google reCAPTCHA verification code const executeRecaptcha = async () => { try { const captcha = await _executeRecaptcha('verifyCodeSend') await store.commit('_base/UPDATE_captcha', captcha) return captcha // Update global captcha data } catch (error) { console.log('🚀 ~ executeRecaptcha ~ error:', error) } } return { ...toRefs(state), executeRecaptcha, recaptchaLoaded } } ``` 3. Define captcha global data in vuex store ``` // src/store/modules/base.js export default { state: { // Google human-machine verification captcha captcha: '' }, mutations: { // Update Google human-machine verification captcha UPDATE_captcha (state, data) { state.captcha = data }, } } ``` 4. Add error prompt to axios interceptor ``` service.interceptors.response.use( response => { const { data } = response if (data.code === 'F999999') { // Prompt text needs to be processed in multiple languages Toast('Illegal request parameters') return data } return response }, error => { return Promise.reject(error) } ) ``` 5. Usage example ``` /** Step 1: Introduce useRecaptcha hook **/ const { executeRecaptcha } = useRecaptcha() /** Step 2: Add captcha parameter to the header of the verification code sending interface **/ // Send verification code export function verifyCodeSendRequest (data) { return request({ url: '/global/message.app.VerificationApiService.verifyCodeSend', method: 'post', headers: { version: '0.0.1', // Add Google verification code to request header captcha: window.store.state._base.captcha }, data }) } /** Step 3: Execute executeRecaptcha in front of the interface that needs to add captcha parameters **/ // Send verification code message.app.VerificationApiService.verifyCodeSend const verifyCodeSend = async () =>{ await executeRecaptcha('verifyCodeSend') await verifyCodeSendRequest() } // Login login/customer.app.CustomerWebApiService.login const login= async () =>{ await executeRecaptcha('login') await loginRequest() } // Registration interface: register/customer.app.CustomerWebApiService.register const register = async () =>{ await executeRecaptcha('register') await registerRequest() } ``` ```` # Customer Customer # Customer registration {% openapi src="/files/5GLLyQq34kkKHu3xlElj" path="/register/customer.app.CustomerWebApiService.register" method="post" %} [MultiMarkets-ClientAPI.openapi.en.yaml](https://3404072034-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FvilfBi544sqSg2yLNueg%2Fuploads%2FSs3fEdIXpRTn0mqBDkuQ%2FMultiMarkets-ClientAPI.openapi.en.yaml?alt=media\&token=e5badae2-4fd4-4801-93ed-5a2e30a5a0a9) {% endopenapi %} # Replacement Token {% openapi src="/files/5GLLyQq34kkKHu3xlElj" path="/global/thirdExt/randomKey" method="post" %} [MultiMarkets-ClientAPI.openapi.en.yaml](https://3404072034-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FvilfBi544sqSg2yLNueg%2Fuploads%2FSs3fEdIXpRTn0mqBDkuQ%2FMultiMarkets-ClientAPI.openapi.en.yaml?alt=media\&token=e5badae2-4fd4-4801-93ed-5a2e30a5a0a9) {% endopenapi %} # API Management # Apply API {% openapi src="/files/5GLLyQq34kkKHu3xlElj" path="/global/customer.app.CustomerApiWebService.applyApi" method="post" %} [MultiMarkets-ClientAPI.openapi.en.yaml](https://3404072034-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FvilfBi544sqSg2yLNueg%2Fuploads%2FSs3fEdIXpRTn0mqBDkuQ%2FMultiMarkets-ClientAPI.openapi.en.yaml?alt=media\&token=e5badae2-4fd4-4801-93ed-5a2e30a5a0a9) {% endopenapi %} # Set permissions {% openapi src="/files/5GLLyQq34kkKHu3xlElj" path="/global/customer.app.CustomerApiWebService.editApiPermission" method="post" %} [MultiMarkets-ClientAPI.openapi.en.yaml](https://3404072034-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FvilfBi544sqSg2yLNueg%2Fuploads%2FSs3fEdIXpRTn0mqBDkuQ%2FMultiMarkets-ClientAPI.openapi.en.yaml?alt=media\&token=e5badae2-4fd4-4801-93ed-5a2e30a5a0a9) {% endopenapi %} # Delete API {% openapi src="/files/5GLLyQq34kkKHu3xlElj" path="/global/customer.app.CustomerApiWebService.delApi" method="post" %} [MultiMarkets-ClientAPI.openapi.en.yaml](https://3404072034-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FvilfBi544sqSg2yLNueg%2Fuploads%2FSs3fEdIXpRTn0mqBDkuQ%2FMultiMarkets-ClientAPI.openapi.en.yaml?alt=media\&token=e5badae2-4fd4-4801-93ed-5a2e30a5a0a9) {% endopenapi %} # Market Data # Introduction ### Communication via websocket protocol ### Market Address Description /quote Registered users in the Cryptocurrency Forex area /quote\_guest Visitors to the Cryptocurrency Forex area /quote\_stock Registered users in the stock area Assume the provided url is wss\://prewppc-3.cmfbl.com/apiQuote If you want to register users in the digital currency foreign exchange area or the stock area, you need to add the token query string in the URL. No token is required to access the visitor market. Example: wss\://prewppc.trade.com/apiQuote/quote\_guest wss\://prewppc.trade.com/apiQuote/quote?token=02d40878-3627-42bd-a61c-657fb4a3be55app wss\://prewppc.trade.com/apiQuote/quote\_stock?token=02d40878-3627-42bd-a61c-657fb4a3be55app ### Introduction to Common Standard Request Headers For the specific request message format, refer to the request examples in each interface. | Fields | name | type | Required fields | illustrate | | ------- | ----------------------- | ------ | ----------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | | cmd\_id | Protocol Number | uint32 | See the individual interface definitions for details. | | | seq\_id | Serial Number | uint32 | yes | The requester generates a unique value, and the response will be consistent with the request | | ext | Tracking number (trace) | string | yes | The requester generates a unique field. The response will be consistent with the request. The maximum length is 64. | | data | Data body | object | yes | For specific data formats, see the definitions of each interface. | ### Introduction to Common Standard Response Headers For the specific response message format, refer to the response examples in each interface. | Fields | name | type | illustrate | | ------- | ----------------------- | ------ | ------------------------------------------------------------------------------------------------------------------- | | right | Return Value | int32 | Error code description | | msg | information | string | A detailed description of success or failure | | cmd\_id | Protocol Number | uint32 | See the individual interface definitions for details. | | seq\_id | Serial Number | uint32 | The requester generates a unique value, and the response will be consistent with the request | | ext | Tracking number (trace) | string | The requester generates a unique field. The response will be consistent with the request. The maximum length is 64. | | data | Data body | object | For specific data formats, see the definitions of each interface. | # Limit Limit For each connection, all interface calls are currently limited to 50 times/second. For market product subscription, a connection can subscribe to a maximum of 100 products. For market K-line query, you can query only one product at a time, and you can query a maximum of 1,000 K-lines at a time. For batch K-line query, you can query a maximum of 100 products at a time, and you can query a maximum of 1,000 K-lines at a time for one product. # Error Code Code ### Error code description | Error Code | meaning | | ---------- | ----------------------------- | | 200 | OK or partially OK | | 201 | request header param invalid | | 202 | request data param invalid | | 203 | client\_ip\_port is not exist | | 500 | failed | [PreviousLimitations](https://docs-cn.multimarkets.org/client-api/bao-jia-jie-kou/xian-zhi-shuo-ming)[
](https://docs-cn.multimarkets.org/client-api/bao-jia-jie-kou/ding-yue-jie-kou) # Subscribe # Ticker ### Interface Description The interface feature is that for each websocket connection, each time the request is sent, the backend will overwrite the previous subscription request by default. After the subscription is successful, data will be pushed. ### Request-Protocol Number: 14000 #### Data format:json #### Data Structure **data definition** | Fields | name | type | Required fields | illustrate | | ------------ | ------------ | ----- | --------------- | ------------------------------------------------------- | | symbol\_list | Product List | array | yes | See the symbol definition below for the specific format | **Symbol definition** | Fields | name | type | Required fields | illustrate | | ----------- | ---------------- | ------ | --------------- | ---------------------------------------------------------------------------------------- | | symbol\_id | Product ID | uint64 | yes | | | trade\_type | Transaction Type | uint32 | yes | 1: Full position contract, 2: Isolated position contract, 3: Leverage, 5: Spot, 6: Stock | | trade\_mode | Trading Model | uint32 | yes | 1:MM, 2:ButterflyMM, 3:Matchmaking, 4:Aggregation | #### Request Example Copy ``` { "cmd_id":14000, "seq_id":123, "ext":"3baaa938-f92c-4a74-a228-fd49d5e2f8bc-1678419657806", "data":{ "symbol_list": [ { "symbol_id": 112312, "trade_type": 1, "trade_mode": 1, } ], } } ``` ### Response-Protocol Number: 14001 #### Data format:json #### Data Structure **data definition** | Fields | name | type | illustrate | | ---------- | ------------------ | ----- | ----------------------------------------------------- | | tick\_list | tick snapshot data | array | See the tick definition below for the specific format | **Tick ​​definition** | Fields | name | type | illustrate | | ----------------------- | ----------------------------------------------------- | ------ | ---------------------------------------------------------------------------------------------- | | symbol\_id | Product ID | uint64 | | | trade\_type | Transaction Type | uint32 | 1: Full position contract, 2: Isolated position contract, 3: Leverage, 5: Spot, 6: Stock | | trade\_mode | Trading Model | uint32 | 1:MM, 2:ButterflyMM, 3:Matchmaking, 4:Aggregation | | seq | Quotation number | uint64 | | | tick\_time | Quote timestamp | uint64 | | | price\_digits | Price decimal places | uint32 | | | price | Latest transaction price | string | | | tick\_deep | Depth Quote | array | This depth will only bring one level of quote information, see the tick\_deep definition below | | open\_price | The opening price of the latest day | string | | | close\_price | The closing price of the latest day | string | | | high\_price | The highest price of K in the last day | string | | | low\_price | The lowest price of K in the last day | string | | | yesterday\_close\_price | The most recent day's daily K closing price yesterday | string | | **tick\_deep definition** | Fields | name | type | illustrate | | ----------- | ------------------------------ | ------ | ---------- | | price\_bid | Buy price, buy price | string | | | price\_ask | Selling price, selling price | string | | | volume\_bid | Buy one volume, buy volume | string | | | volume\_ask | Selling volume, selling volume | string | | #### Example Response Copy ``` { "ret":200, "msg":"ok", "cmd_id":14001, "seq_id":123, "ext":"3baaa938-f92c-4a74-a228-fd49d5e2f8bc-1678419657806", "data":{ "tick_list":[ { "symbol_id": 123, "trade_type": 1, "trade_mode": 0, "seq": 1605509068000001, "tick_time": 1605509068, "price_digits": 2, "price": "651.12", "tick_deep": [ { "price_bid": "9.12", "price_ask": "147.12", "volume_bid": "9.12", "volume_ask": "147.12", }, ], "open_price": "651.12", "close_price": "623.12", "high_price": "674.12", "low_price": "619.12", "yesterday_close_price": "623.12", }, ] } } ``` ### Push data #### illustrate This quote push mainly includes transaction and one-level depth quotes. It is a comprehensive quote push. The data content is a string. Currently, one quote is pushed at a time. The backend service will push the data to the requester who sends a real-time quote subscription request. #### Field Explanation p(product ID, quote transaction type, transaction mode, quote sequence number, quote timestamp, current price, first tier bid price, first tier ask price, first tier bid volume, first tier ask volume); “p(symbol\_id,trade\_type,trade\_mode,seq,tick\_time,price,price\_bid1,price\_ask1,volume\_bid1,volume\_ask1);” trade\_type value meaning 1: full position contract, 2: single position contract, 3: leverage, 5: spot, 6: stock trade\_mode value meaning 1: MM, 2: butterfly MM, 3: matching, 4: aggregation #### Push data example p(1123,1,0,1232312,34545435345,6.23,6.23,6.24,123,234); # Market MarketQuoteMarket ### Interface Description The interface feature is that for each websocket connection, each time the request is sent, the backend will overwrite the previous subscription request by default. After the subscription is successful, data will be pushed. ### Request-Protocol Number: 14010 #### Data format:json #### Data Structure **data definition** | Fields | name | type | Required fields | illustrate | | ------------ | ------------ | ----- | --------------- | ------------------------------------------------------- | | symbol\_list | Product List | array | yes | See the symbol definition below for the specific format | **Symbol definition** | Fields | name | type | Required fields | illustrate | | ------------------ | --------------------------------- | ------ | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | symbol\_id | Product ID | uint64 | yes | | | trade\_type | Transaction Type | uint32 | yes | 1: Full position contract, 2: Isolated position contract, 3: Leverage, 5: Spot, 6: Stock | | trade\_mode | Trading Model | uint32 | yes | 1:MM, 2:ButterflyMM, 3:Matchmaking, 4:Aggregation | | depth\_level | Depth level | uint32 | no | If there is no depth\_level field, the backend will only provide a quote for one level. The requested level is greater than the actual quote level. If there is no depth\_level field, the backend will provide a quote for as many levels as the actual quote level has. | | merge\_accuracy | Merge precision | string | yes | If the value is 10, it means the quotation will be combined according to the tenth digit; if it is 1, it means the quotation will be combined according to each decimal place; if it is 0.001, it means the quotation will be combined according to the third decimal place, and so on. | | trade\_info\_count | Number of transaction information | uint32 | yes | Indicates how many transaction quotes you want to receive in response to your subscription. | #### Request Example Copy ``` { "cmd_id":14010, "seq_id":123, "ext":"3baaa938-f92c-4a74-a228-fd49d5e2f8bc-1678419657806", "data":{ "symbol_list": [ { "symbol_id": 112312, "trade_type": 1, "trade_mode": 0, "depth_level": 5, "merge_accuracy":"0.001", "trade_info_count": 5, }, ], } } ``` ### Response-Protocol Number: 14011 #### Data format:json #### Data Structure **data definition** | Fields | name | type | illustrate | | ---------- | ------------------ | ----- | ----------------------------------------------------- | | tick\_list | tick snapshot data | array | See the tick definition below for the specific format | **Tick ​​definition** | Fields | name | type | illustrate | | ------------- | ----------------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------- | | symbol\_id | Product ID | uint64 | | | trade\_type | Transaction Type | uint32 | 1: Full position contract, 2: Isolated position contract, 3: Leverage, 5: Spot, 6: Stock | | trade\_mode | Trading Model | uint32 | 1:MM, 2:ButterflyMM, 3:Matchmaking, 4:Aggregation | | seq | Quotation number | uint64 | | | tick\_time | Quote timestamp | uint64 | | | price\_digits | Price decimal places | uint32 | | | bid\_deep | bid depth | array | See the definition of bid\_deep below. The number of depths will vary depending on the depth\_level and merge\_accuracy in the request. | | ask\_deep | askDepth | array | See the definition of ask\_deep below. The number of depths will vary depending on the depth\_level and merge\_accuracy in the request. | | trade\_info | Transaction information | array | See trade\_info definition below | **bid\_deep definition** | Fields | name | type | illustrate | | ----------- | -------------------------- | ------ | ---------- | | price\_bid | Buy price, buy price | string | | | volume\_bid | Buy one volume, buy volume | string | | **ask\_deep definition** | Fields | name | type | illustrate | | ----------- | ------------------------------ | ------ | ---------- | | price\_ask | Selling price, selling price | string | | | volume\_ask | Selling volume, selling volume | string | | **trade\_info definition** | Fields | name | type | illustrate | | ---------------- | --------------------- | ------ | ------------------------------------------- | | price | Sold Price | string | | | volume | Volume | string | | | trade\_direction | Trading direction | uint32 | 0 is the default value, 1 is BUY, 2 is SELL | | trade\_time | Transaction timestamp | uint64 | Unit: Seconds | #### Example Response Copy ``` { "ret":200, "msg":"ok", "cmd_id":14011, "seq_id":123, "ext":"3baaa938-f92c-4a74-a228-fd49d5e2f8bc-1678419657806", "data":{ "tick_list":[ { "symbol_id": 123, "trade_type": 1, "trade_mode": 0, "seq": 1605509068000001, "tick_time": 1605509068, "price_digits": 2, "bid_deep": [ { "price_bid": "9.12", "volume_bid": "9.12", }, ], "ask_deep": [ { "price_ask": "147.12", "volume_ask": "147.12", }, ], "trade_info": [ { "price": "651.12", "volume": "100", "trade_direction": 1, "trade_time": 1605509068, }, ] }, ] } } ``` ### Push data - real-time transaction quotation push #### illustrate The quotation push mainly reflects the transaction information. The push data content is a string. Currently, one quotation is pushed at a time. The backend service will push the data to the requester only after the requester sends a quotation subscription request. #### Field Explanation pt(product ID, quote transaction type, transaction mode, quote sequence number, quote timestamp, current price, transaction volume, transaction direction); "pt(symbol\_id,trade\_type,trade\_mode,seq,tick\_time,price,volume,trade\_direction);" trade\_type value meaning 1: full position contract, 2: single position contract, 3: leverage, 5: spot, 6: stock trade\_mode value meaning 1: MM, 2: butterfly MM, 3: matching, 4: aggregation #### Push data example "pt(1123,1,0,1232312,34545435345,6.23,1000,1);" ### Push data-market quote push #### illustrate The quote push mainly reflects the market information, and will merge the deep quotes according to the merge precision field in the subscription request. The push data content is a string, and currently one quote is pushed at a time. The backend service will push the data to the requester only after the requester sends a market transaction quote subscription request. #### Field Explanation pd(product ID, quotation transaction type, transaction mode, quotation sequence number, quotation timestamp);(1st tier bid price, 1st tier bid volume)(2nd tier bid price, 2nd tier bid volume);(1st tier ask price, 1st tier ask volume)(2nd tier ask price, 2nd tier ask volume); "pd(symbol\_id,trade\_type,trade\_mode,seq,tick\_time);(price\_bid1,volume\_bid1)(price\_bid2,volume\_bid2);(price\_ask1,volume\_ask1)(price\_ask2,volume\_ask2);" trade\_type value meaning 1: full position contract, 2: single position contract, 3: leverage, 5: spot, 6: stock trade\_mode value meaning 1: MM, 2: butterfly MM, 3: matching, 4: aggregation #### Push data example "pd(1123,1,0,1232312,34545435345);(6.23,123)(6.22,256);(6.24,111)(6.25,222);" "pd(1123,1,0,1232312,34545435345) ;(6.23,123)(6.22,256);(6.24,111)(6.25,222)(6.25,333);" "pd(1123,1,0,1232312,34545435345);;(6.24,111)( 6.25,222)(6.25,333);" # Cancel ### Interface Description ### Request-Protocol Number: 14006 #### Data format:json #### Data Structure **data definition** | Fields | name | type | Required fields | illustrate | | ------------ | ----------------- | ------ | --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | | cancel\_type | Cancellation Type | uint32 | yes | 0: Clear all subscriptions, 1: Unsubscribe from real-time quote push, 2: Unsubscribe from market price quote push, 3: Unsubscribe from 24-hour rolling quote push | #### Request Example Copy ``` { "cmd_id":14006, "seq_id":123, "ext":"3baaa938-f92c-4a74-a228-fd49d5e2f8bc-1678419657806", "data":{ "cancel_type": 1, } } ``` ### Response-Protocol Number: 14007 #### Data format:json #### Data Structure **data definition** #### Example Response Copy ``` { "ret":200, "msg":"ok", "cmd_id":14007, "seq_id":123, "ext":"3baaa938-f92c-4a74-a228-fd49d5e2f8bc-1678419657806", "data":{ } } ``` # Query # Heartbeat ### Interface Description The requester is required to send a heartbeat request every 10 seconds. If no heartbeat request is received within 30 seconds, it will be considered a timeout and the requester's websocket connection will be disconnected. ### Request-Protocol Number: 14008 #### Data format:json #### Data Structure **data definition** #### Request Example Copy ``` { "cmd_id":14008, "seq_id":123, "ext":"3baaa938-f92c-4a74-a228-fd49d5e2f8bc-1678419657806", "data":{ } } ``` ### Response-Protocol Number: 14009 #### Data format:json #### Data Structure **data definition** #### Example Response Copy ``` { "ret":200, "msg":"ok", "cmd_id":14009, "seq_id":123, "ext":"3baaa938-f92c-4a74-a228-fd49d5e2f8bc-1678419657806", "data":{ } } ``` [
](https://docs-cn.multimarkets.org/client-api/bao-jia-jie-kou/cha-xun-jie-kou) # Historical K-line ### Interface Description Note: The server performs libz compression on the entire packet. ### Request-Protocol Number: 14012 #### Data format:json #### Data Structure **data definition** | Fields | name | type | Required fields | illustrate | | --------------------- | --------------------------- | ------ | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | symbol\_id | Product ID | uint64 | yes | | | trade\_type | Transaction Type | uint32 | yes | 1: Full position contract, 2: Isolated position contract, 3: Leverage, 5: Spot, 6: Stock | | trade\_mode | Trading Model | uint32 | yes | 1:MM, 2:ButterflyMM, 3:Matchmaking, 4:Aggregation | | kline\_type | K-line type | uint32 | yes | 1 minute K, 2 is 5 minute K, 3 is 15 minute K, 4 is 30 minute K, 5 is hour K, 6 is 2 hour K, 7 is 4 hour K, 8 is daily K, 9 is weekly K, 10 is monthly K | | kline\_timestamp\_end | Line end timestamp | uint64 | no | Unit: Seconds | | query\_kline\_num | Query the number of K lines | uint32 | yes | kline\_timestamp\_end is 0, query\_kline\_num is not 0, query the latest query\_kline\_num K-lines (including the current K-line) kline\_timestamp\_end is not 0, query\_kline\_num is not 0, query the query\_kline\_num K-lines from kline\_timestamp\_end to the previous query\_kline\_num K-lines In other cases, the interface directly returns an error, indicating that the query service is not supported | #### Request Example Copy ``` { "cmd_id":14012, "seq_id":123, "ext":"3baaa938-f92c-4a74-a228-fd49d5e2f8bc-1678419657806", "data":{ "symbol_id": 1, "trade_type": 1, "trade_mode": 0, "kline_type": 1, "kline_timestamp_end": 1605509068, "query_kline_num": 100, } } ``` ### Response-Protocol Number: 14013 #### Data format:json #### Data Structure **data definition** | Fields | name | type | illustrate | | ------------- | -------------------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------- | | symbol\_id | Product ID | uint64 | | | trade\_type | Transaction Type | uint32 | 1: Full position contract, 2: Isolated position contract, 3: Leverage, 5: Spot, 6: Stock | | trade\_mode | Trading Model | uint32 | 1:MM, 2:ButterflyMM, 3:Matchmaking, 4:Aggregation | | kline\_type | K-line type | uint32 | 1 minute K, 2 is 5 minute K, 3 is 15 minute K, 4 is 30 minute K, 5 is hour K, 6 is 2 hour K, 7 is 4 hour K, 8 is daily K, 9 is weekly K, 10 is monthly K | | price\_digits | Price decimal places | uint32 | | | kline\_list | K-line list | array | See the kline\_list definition below for the specific format. | **kline\_list definition** | Fields | name | type | illustrate | | -------------------- | ----------------------------------------- | ------ | ------------------ | | timestamp | The timestamp of the K line | uint64 | Unit: Seconds | | open\_price | The opening price of the K-line | string | | | close\_price | The closing price of the K-line | string | | | high\_price | The highest price of the K line | string | | | low\_price | The lowest price of the K line | string | | | last\_tick\_time | The last tick time of the K line | uint64 | Unit: milliseconds | | last\_tick\_seq | The last tick number of the K-line | uint64 | | | transactions\_number | The number of transactions of this K line | string | | #### Example Response Copy ``` { "ret":200, "msg":"ok", "cmd_id":14013, "seq_id":123, "ext":"3baaa938-f92c-4a74-a228-fd49d5e2f8bc-1678419657806", "data":{ "symbol_id": 1123, "trade_type": 1, "trade_mode": 0, "kline_type": 1, "price_digits": 2, "kline_list":[ { "timestamp": 1605509068, "open_price": "651.12", "close_price": "623.12", "high_price": "674.12", "low_price": "619.12", "last_tick_time": 1605509068000001, "last_tick_seq": 1605509068000001, "transactions_number": "12345.6", }, ] } } ``` [
](https://docs-cn.multimarkets.org/client-api/bao-jia-jie-kou/cha-xun-jie-kou/xin-tiao) # Open API Open # Readme ### 1. API Introduction This API supports placing orders, receiving transaction messages, market data subscription, and other functionalities. Supported Methods: * Through API key: You need to use specific header parameters when calling. For details, please refer to the following documents: [Signature Rules](https://docs.multimarkets.org/client-api/open-api/sign) and [Request & Response](https://docs.multimarkets.org/client-api/open-api/request). In the "Request & Response" documentation, optional header information parameters must be referenced based on each interface's header description. If an interface's header requires a token parameter, it should be omitted and ignored. * The Open API interface is the same as the Client open interface. The difference is that the encryption authentication method of the request is different. The Open API needs to apply for apikey and secretKey for signature access. You can refer to the detailed interface list [Client API](https://multimarkets-c-api-en.apidocumentation.com/) Below is a guide on how to obtain an API key. ### 2. API Key Application Process #### Method 1: > Log in to the trading client, find "API Management" on the "My" page, and then create an ApiKey and SecretKey on the API management page. The SecretKey is only displayed once after creation (for security reasons, the system does not store it), so it needs to be kept safely. #### Method 2: > Apply through the Client API interface with the following steps: **1. Log in** Call the interface: [Login](https://docs.multimarkets.org/client-api/login) Retrieve the token from the result for future use. **2. Apply for an API Key** Call the interface: [Apply API](https://docs.multimarkets.org/client-api/customer/api-management/apply-api) Retrieve the apiKey and privateKey from the result and save them. These are necessary parameters for subsequent interface calls. You only need to apply for an API key once. **3. Bind your External IP Address** Call the interface: [Set Permissions](https://docs.multimarkets.org/client-api/customer/api-management/set-permissions) You need to bind the IP for it to be valid long-term; otherwise, the default validity period is only 90 days. # Sign Sign ## 1. Signature ### 1.1 Signature Rules The signature uses the SHA1WithRSA algorithm. The secretKey serves as the key for SHA1WithRSA, and the parameters in `param` + `timestamp` serve as the operating objects for SHA1WithRSA. The output obtained is the signature. * Step 1: Retrieve the request parameters in the body, sort the parameters alphabetically, and form a string. * The sorting method "alphabetical order" means sorting from smallest to largest alphabetically, comparing the first letter first, if the same, compare the second letter, and so on. * Remove all double quotes, whether they are from field names or field values. * No spaces in between. * If the field is `null`, it is not included in the signature. * Step 2: Retrieve the `timestamp` parameter from the request header and append it to the result of Step 1. * Step 3: Use the secretKey to perform SHA1WithRSA on the result from Step 2 to generate the signature. ### 1.2 Signature Example | Parameter | Value | | --------- | ----------------------------------------------------------------------------------- | | companyId | 220 | | apiKey | 1710e1f6b4b54c15bea72e8669966591 | | secretKey | MIICeAIBADANBgkqhkiG9w0BAQEFAASCAmIwggJeAgEAAoGBAI5WJjsBgtiuQQZDs5qe8LBDUm2ZSa4gTBJ | Request Parameters: {"companyId":1,"lang":"zh-CN","customerNo":"86001308"} Calculate Signature: * Step 1: Retrieve the request parameters in the body and sort them alphabetically to form the following string:\ {“companyId”:1,”customerNo”:”86001308”,”lang”:”zh-CN”} * Step 2: Retrieve the `timestamp` parameter from the request header and append it to the result of Step 1, as follows:\ {companyId:1,customerNo:86001308,lang:zh-CN}1650361143685 * Step 3: Use the secretKey to perform SHA1WithRSA on the result from Step 2, the result is:\ Dihl6oOt5UkaHo9sEouquP3EqbukLX2dAOoKTSGicYryTvH1m9r6vtSLHGutZn7u34/06gjhdpbXRFPdjb51GVHvG75qWXZ1P/boL89xtuja6eTEy9q/aS8R270Q1A+m/MOTxdiifCy0IByrSpCs4VJKaj2d8jlJo2GHznsH+q0= ## 2.Attachment Java version [demo](https://github.com/CTradeExchange/sign-demo/tree/master). # Request Request ## 1. Request Address {baseUrl}/openapi-c/global/{bizType} | Parameter | Type | Description | | --------- | ------ | --------------------------------------------------------------- | | baseUrl | String | Request domain or IP, contact operational staff for details | | bizType | String | Resource information. See the specific interface documentation. | The DEMO is as follows: POST ## 2. Request Method Request Method: POST ## 3. Request Header Information | Parameter | Type | Required | Description | | ---------- | ------ | -------- | ------------------------------------------------------------- | | companyId | long | Yes | Unique company identifier | | trace | String | Yes | Unique identifier for global tracing | | timestamp | long | Yes | Request sending time, timestamp in milliseconds | | apiKey | String | Yes | API key applied through the platform | | signature | String | Yes | Signature, see signature rules | | recvWindow | long | No | Time window | | version | String | No | Resource version number, see specific interface documentation | | group | String | No | Resource group, see specific interface documentation | | lang | String | No | Language info, default is zh-CN | ## 4. Request Body Parameters To be transmitted in the format content-type=application/json Refer to specific interface documentation. ## 5. Response Format Responses use JSON format. All responses follow a unified format: ```json { "code": "code", "message":"message", "data": null } ``` ## 6. Response Error Codes | Code | Description | | -------- | ----------------------------------------- | | 00012001 | Signature verification failed | | 00012002 | Request has exceeded the time window | | 00012003 | The requested API\_KEY does not exist | | 00012004 | No permission for the current API request | | 00012005 | Request too frequent | | 00012006 | API has expired | | 00012007 | Illegal IP address | ## 7. Access Restrictions * Currently, a single API-KEY can be accessed no more than 100 times per minute; otherwise, it will return 429. * If requests continue after receiving a 429 response, it will return 418. * The first time a 418 response is returned, the API key will be disabled for 5 minutes. Subsequent access attempts will increase the disable period to 10 minutes, and so on. # Error Code Error Code ### Note: Error codes may be added or changed with system updates and iterations | Error Code | Error Description | Error Type | | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | | CFDWBW500 | System Exception | System | | CFDWBWE000001 | Order failed, please contact customer service | Business | | CFDWBWE000002 | Account total position exceeds the limit, trading not allowed | Business | | CFDWBWE000003 | No real-time market quotes for this product | Business | | CFDWBWE000004 | Failed to subscribe to real-time market quotes | Business | | CFDWBWE000005 | Parameter cannot be empty | Business | | CFDWBWE000006 | Incorrect format | Business | | CFDWBWE000007 | Parameter validation failed | Business | | CFDWBWE000008 | Position does not exist | Business | | CFDWBWE000009 | Stop-loss price is out of the allowed range | Business | | CFDWBWE000010 | Take-profit price is out of the allowed range | Business | | CFDWBWE000011 | Single-side maximum position limit exceeded, trading not allowed | Business | | CFDWBWE000012 | Trading time not set | Business | | CFDWBWE000013 | Product not configured | Business | | CFDWBWE000014 | Only descending or ascending sorting allowed | Business | | CFDWBWE000015 | Sorting by this field name not supported | Business | | CFDWBWE000016 | Trading not allowed outside trading hours | Business | | CFDWBWE000017 | Trading not allowed outside trading hours | Business | | CFDWBWE000018 | Trading not allowed outside trading hours | Business | | CFDWBWE000019 | Closing position amount cannot be less than the minimum amount | Business | | CFDWBWE000020 | Closing position amount cannot exceed the maximum amount limit | Business | | CFDWBWE000021 | Closing position amount must be an integer multiple of the minimum amount | Business | | CFDWBWE000022 | Parameter anomaly | Business | | CFDWBWE000023 | Closing position amount does not meet the rules | Business | | CFDWBWE000024 | Specified price cannot be empty | Business | | CFDWBWE000025 | Product exchange rate not found | Business | | CFDWBWE000026 | Quantity must be within the range of %s to %s lots, and must be an integer multiple of %s lots | Business | | CFDWBWE000027 | The single-side maximum position limit for this product is %s lots. After placing the order, it exceeds the range. Please try reducing the order quantity | Business | | CFDWBWE000028 | The account maximum position limit is %s lots. After placing the order, it exceeds the range. Please try reducing the order quantity | Business | | CFDWBWE000029 | Exceeds maximum leverage | Business | # API Address Address ### PRE test environment address ### ### PRD official environment address # Order Process ## Subscription Trade Messages: ### 1.Obtain token Call the API: [Get Token](https://docs.multimarkets.org/client-api/open-api/message/get-msg-token) Extract the \`data\` field from the response; this is the token. ### 2.Subscribe to Trade Messages: Refer to the API documentation: [Message Subscription](https://docs.multimarkets.org/client-api/open-api/message/msg-subscribe) #### 2.1 Establish Connection PRE environment address: wss\://pre-api-test.cmfbl.com/openapi-c/openMsg/{appId} #### 2.2 Send Login Message: ``` {"device":1,"head":{"lang":"en-US","msgType":"login","sendTime":1698299047686,"token":"dbe3d3e6-0b10-4bdc-9778-dfc76c6d9341app"},"seqId":3,"trace":"x-1698299047686-4"} ``` #### 2.3 Send Subscription Message: ``` {"data":{"tradeTypes":"2"},"device":1,"head":{"lang":"en-US","msgType":"subscribe_asset","sendTime":1698299047686,"token":"dbe3d3e6-0b10-4bdc-9778-dfc76c6d9341app"},"seqId":5,"trace":"x-1698299047686-6"} ``` #### 2.4 Send Heartbeat Message Every 15 Seconds to Maintain Connection: ``` {"device":1,"head":{"lang":"en-US","msgType":"ping","sendTime":1698299057667,"token":"dbe3d3e6-0b10-4bdc-9778-dfc76c6d9341app"},"seqId":7,"trace":"x-1698299057667-8"} ``` ## Order Process: ### 1.Request Product Information: Call the API: [Product Brief Data](https://docs.multimarkets.org/client-api/open-api/base/symbol-base-info)Extract symbolId and symbolDigits for later use. ### 2.Request Customer Information: Call the API: [Query Customer Information](https://docs.multimarkets.org/client-api/open-api/customer/customer-info)Extract accountId, digits, and currency from the entry in accountList with trade\_type=2. ### 3.Place Order: Call the API: [Place Order](https://docs.multimarkets.org/client-api/open-api/trade/contract-order) Example：\ http header: ``` Version: 0.01 Group: tradeApi Trace: [Custom unique string] Content-Type: application/json Accept: application/json Apikey: [Already provided.] Timestamp: [Millisecond timestamp] CompanyId: [Already provided (Test field: 439)] Signature: Signature, the generation rules are here ``` http body： ``` { "accountCurrency":"CNY", //Parameters obtained in step 2 "accountDigits":2, //Parameters obtained in step 2 "accountId":1034124, //Parameters obtained in step 2 "bizType":1, //Currently only supports these four types: business types, 1-market price opening; 2-market price flat; 13-limit price opening order; 14-limit price closing order "crossLevelNum":1, //fixed with 1 "direction":1, //Order buying and selling direction, 1-buy; 2-sell; "entryType":1, //Order type 1 by quantity, 2 by amount "expireType":1, //limit order expiration type, 1-valid on the day; 2-valid on the week; "requestNum":"0.100000", //Order lot size or order amount, used with entryType "requestPrice":"167655", //The decimal place obtained in step 1 is used to convert the quotation into an integer. For example, if the decimal place is 3 and the quotation is 1.23, it will be converted to: 1230 "requestTime":1698299972000, "symbolId":8390, //Parameters obtained in step 1 "tradeType":2 //Fixed to 2 } ``` ### 4.Handle Response Upon receiving a response from step 3, check if code is “0”. If it is, the order placement is successful. Extract the orderId field from the data and match it with the orderId in the trade message. Trade Message Fields: ``` { "trace":"x-1698310473323-102_b_bb76b676-8d8e-4278-82be-6ae7e063c9d3", "msgCode":"trade", //Only need to pay attention to msgCode=trade "content":{ "accountId":1034124, "companyId":439, "bizType":"POSITION_OPEN", //POSITION_OPEN: Market price opening was successful, POSITION_CLOSE: Market price closing was successful, ME_POSITION_LIMIT_OPEN: Limit price opening was successful, ME_POSITION_LIMIT_CLOSE: Limit price closing was successful POSITION_OPEN_FAIL: Market price opening failed, ME_POSITION_LIMIT_FAIL: Limit price opening was Warehouse failed "customerId":2482, "paramMap":{ "date":"1698310474529", "orderType":"1", "symbolId":"8390", "dealExecuteTime":"1698310474529", "orderBizType":"1", "orderId":"21257491", //Order ID "pendingId":"0", "dealId":"21262382", "accountCurrency":"CNY", "orderStatus":"2", //Order status: 1-order received; 2-order completed; 3-order partially completed; 4-order canceled; 5-order partially canceled; 6-order rejected; 7-order expired ; "dealExecuteNum":"8000.0", "source":"H5", "dealPrice":"1.67094", //Transaction price "requestAmount":"0.08", "takeProfitMsg":"--", "currency":"CNY", "symbolName":"EURAUD", "contractSize":"100000", //Contract size "sourceExecuteVolSum":"0.100000", "commission":"0", "sourceExecuteVol":"0.100000", "direction":"2", "dealAmount":"0.08", //Number of lots traded "accountId":"1034124", "companyId":"439", "positionId":"2023102650229", //Position ID "dealExecutePrice":"1.67094", "playType":"2", "orderDirection":"2", "symbolDigits":"5", "stopLossMsg":"--", "Margin":"59371.20" }, "tradeType":2 }, "timestamp":1698310474563 } ``` # Base Base # Symbol Base Info Symbol Base Info {% openapi src="/files/5GLLyQq34kkKHu3xlElj" path="/global/config.app.AppSymbolDubboService.getSymbolBaseList" method="post" %} [MultiMarkets-ClientAPI.openapi.en.yaml](https://3404072034-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FvilfBi544sqSg2yLNueg%2Fuploads%2FSs3fEdIXpRTn0mqBDkuQ%2FMultiMarkets-ClientAPI.openapi.en.yaml?alt=media\&token=e5badae2-4fd4-4801-93ed-5a2e30a5a0a9) {% endopenapi %} # Customer Customer # Customer Info Customer Info {% openapi src="/files/5GLLyQq34kkKHu3xlElj" path="/global/customer.app.CustomerWebApiService.findCustomerInfo" method="post" %} [MultiMarkets-ClientAPI.openapi.en.yaml](https://3404072034-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FvilfBi544sqSg2yLNueg%2Fuploads%2FSs3fEdIXpRTn0mqBDkuQ%2FMultiMarkets-ClientAPI.openapi.en.yaml?alt=media\&token=e5badae2-4fd4-4801-93ed-5a2e30a5a0a9) {% endopenapi %} # Trade Trade # Contract order {% openapi src="/files/5GLLyQq34kkKHu3xlElj" path="/global/tradeapi.app.CfdMMOrderApiService.addMarketOrder" method="post" %} [MultiMarkets-ClientAPI.openapi.en.yaml](https://3404072034-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FvilfBi544sqSg2yLNueg%2Fuploads%2FSs3fEdIXpRTn0mqBDkuQ%2FMultiMarkets-ClientAPI.openapi.en.yaml?alt=media\&token=e5badae2-4fd4-4801-93ed-5a2e30a5a0a9) {% endopenapi %} # Message Message # Get Msg Token Get Msg Token {% openapi src="/files/5GLLyQq34kkKHu3xlElj" path="/global/getMsgPushToken" method="post" %} [MultiMarkets-ClientAPI.openapi.en.yaml](https://3404072034-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FvilfBi544sqSg2yLNueg%2Fuploads%2FSs3fEdIXpRTn0mqBDkuQ%2FMultiMarkets-ClientAPI.openapi.en.yaml?alt=media\&token=e5badae2-4fd4-4801-93ed-5a2e30a5a0a9) {% endopenapi %} # Msg Subscribe Msg Subscribe ## Environment Address > wss\://pre-api-test.cmfbl.com/openapi-c/openMsg/{appId} ## Request Messages > Sending Heartbeat Message\ > `{"head":{"msgType":"ping","token":"fd5e62aa-1b7b-44bd-b693-43ef7a60e684app","sendTime":1628899424051,"lang":"zh-CN"},"device":1,"seqId":1434,"trace":"d141023c-c706-43f4-bfaf-e73132b1da52-1628899424051"}` > Sending Login Message\ > `{"head":{"msgType":"login","token":"74e6e8df-9399-4bec-85aa-217c9b93e38eapp","sendTime":1628899396299,"lang":"zh-CN"},"device":1,"seqId":1222,"trace":"12321229-c31b-4c52-8471-9f27fd61e9e8-1628899396299"}` > Sending Subscribe Asset\ > `{"head":{"msgType":"subscribe_asset","token":"74e6e8df-9399-4bec-85aa-217c9b93e38eapp","sendTime":1628899396299,"lang":"zh-CN"}, "data":{"tradeTypes":"1"}, "device":1,"seqId":1222,"trace":"12321229-c31b-4c52-8471-9f27fd61e9e8-1628899396299"}` > Sending Cancel Subscribe Asset\ > `{"head":{"msgType":"cancel_subscribe_asset","token":"74e6e8df-9399-4bec-85aa-217c9b93e38eapp","sendTime":1628899396299,"lang":"zh-CN"}, "data":{"tradeTypes":"1"}, "device":1,"seqId":1222,"trace":"12321229-c31b-4c52-8471-9f27fd61e9e8-1628899396299"}` > Sending Logout Message\ > `{"head":{"msgType":"logout","token":"74e6e8df-9399-4bec-85aa-217c9b93e38eapp","sendTime":1628899396299,"lang":"zh-CN"},"device":1,"seqId":1222,"trace":"12321229-c31b-4c52-8471-9f27fd61e9e8-1628899396299"}` ## Field Descriptions | Field Name | Type | Description | | ------------- | :----: | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | | msgType | String | Message type | | sendTime | Long | Sending time | | lang | String | Language | | device | String | Subscription device type | | trace | String | Trace number | | tradeTypes | String | Mode types (1: Contract Full, 2: Contract Isolated, 6: Stock) | | subscribeType | String | Stock mode subscription type (only for stock mode) (1: Position floating profit and loss, 2: Asset message, for both position and asset subscription pass 1,2) | | companyId | Long | Company ID | | accountId | Long | Account ID | | customerId | Long | Customer ID | ## Response Messages | Field Name | Description | | ---------- | ------------------- | | msgCode | Message CODE | | timestamp | Sending timestamp | | trace | Trace unique code | | seqId | Sending sequence ID | | content | Message content | # Get Msg Token get Msg Token {% openapi src="/files/5GLLyQq34kkKHu3xlElj" path="/global/getMsgPushToken" method="post" %} [MultiMarkets-ClientAPI.openapi.en.yaml](https://3404072034-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FvilfBi544sqSg2yLNueg%2Fuploads%2FSs3fEdIXpRTn0mqBDkuQ%2FMultiMarkets-ClientAPI.openapi.en.yaml?alt=media\&token=e5badae2-4fd4-4801-93ed-5a2e30a5a0a9) {% endopenapi %} # Msg Subscribe ## 环境地址 > wss\://pre-api-test.cmfbl.com/openapi-c /openMsg/{appId} ## 请求报文 > 发送心跳消息\ > `{"head":{"msgType":"ping","token":"fd5e62aa-1b7b-44bd-b693-43ef7a60e684app","sendTime":1628899424051,"lang":"zh-CN"},"device":1,"seqId":1434,"trace":"d141023c-c706-43f4-bfaf-e73132b1da52-1628899424051"}` > > \ > 发送登录消息\ > `{"head":{"msgType":"login","token":"74e6e8df-9399-4bec-85aa-217c9b93e38eapp","sendTime":1628899396299,"lang":"zh-CN"},"device":1,"seqId":1222,"trace":"12321229-c31b-4c52-8471-9f27fd61e9e8-1628899396299"}` > > \ > 发送订阅资产\ > `{"head":{"msgType":"subscribe_asset","token":"74e6e8df-9399-4bec-85aa-217c9b93e38eapp","sendTime":1628899396299,"lang":"zh-CN"}, "data":{"tradeTypes":"1"}, "device":1,"seqId":1222,"trace":"12321229-c31b-4c52-8471-9f27fd61e9e8-1628899396299"}`\ > \ > 发送取消订阅资产\ > `{"head":{"msgType":"cancel_subscribe_asset","token":"74e6e8df-9399-4bec-85aa-217c9b93e38eapp","sendTime":1628899396299,"lang":"zh-CN"}, "data":{"tradeTypes":"1"}, "device":1,"seqId":1222,"trace":"12321229-c31b-4c52-8471-9f27fd61e9e8-1628899396299"}` > > \ > 退出登录\ > `{"head":{"msgType":"logout","token":"74e6e8df-9399-4bec-85aa-217c9b93e38eapp","sendTime":1628899396299,"lang":"zh-CN"},"device":1,"seqId":1222,"trace":"12321229-c31b-4c52-8471-9f27fd61e9e8-1628899396299"}` ## **字段描述**
字段名称类型描述
msgTypeString消息类型
sendTimeLong发送时间
langString语言
deviceString订阅设备类型
traceString跟踪号
tradeTypesString交易模式 1：合约全仓，2：合约逐仓，5：现货，6：股票
subscribeTypeString股票模式订阅类型（只有股票玩法需要传）1:仓位浮动盈亏，2:资产消息，仓位和资产一起同时订阅传1,2
companyIdLong公司id
accountIdLong账户id
customerIdLong客户id
## **响应报文** | 字段名称 | 描述 | | --------- | :----: | | msgCode | 消息CODE | | timestamp | 发送时间戳 | | trace | 追踪唯一码 | | seqId | 发送序列id | | content | 消息内容 | # More... More Please refer to [Client API](https://multimarkets-c-api-en.apidocumentation.com/reference#tag/basic) # Auth2 API Auth2API # Readme The user's third-party system is integrated with the account system of MulitMarket's white-label customers. Quick login to the third-party system is performed based on MulitMarket's white-label account system. To use this API, you need to apply for authorization information such as appid from the white-label customer. ## Process Get the authorization code by jumping to the white label client page. The white label client requires the user to authorize the third-party system to obtain the authorization code. After the customer agrees, the code is returned to the third-party platform. The third-party platform obtains a valid access token for accessing user information by calling the backend interface based on the appId, appSecret, and code information. Finally, the basic user information can be obtained based on this token and authorization binding can be performed. ## Steps: 1、Open the authorization page to obtain the authorization code \ \ \ After the above authorization is confirmed, you will be redirected to \ 2、The third-party platform exchanges the access token through the authorization code. By obtaining the code, the backend calls the interface to exchange for accessToken \ 3、Obtain user information based on the access token to bind the account. The backend of the third-party platform obtains user information based on the accessToken # Auth Code {% openapi src="/files/vb33gLBHH3Q5HLSEJxKE" path="/auth2/code" method="post" %} [MultiMarkets-Auth2Api.openapi.en.yaml](https://3404072034-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FvilfBi544sqSg2yLNueg%2Fuploads%2FXCJ6ADT0ACx2LmNmXOgi%2FMultiMarkets-Auth2Api.openapi.en.yaml?alt=media\&token=6653c29f-e7b4-440e-be6f-dc7b6fcb3e23) {% endopenapi %} # Access Token {% openapi src="/files/vb33gLBHH3Q5HLSEJxKE" path="/auth2/token" method="post" %} [MultiMarkets-Auth2Api.openapi.en.yaml](https://3404072034-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FvilfBi544sqSg2yLNueg%2Fuploads%2FXCJ6ADT0ACx2LmNmXOgi%2FMultiMarkets-Auth2Api.openapi.en.yaml?alt=media\&token=6653c29f-e7b4-440e-be6f-dc7b6fcb3e23) {% endopenapi %} # User Info {% openapi src="/files/vb33gLBHH3Q5HLSEJxKE" path="/auth2/user" method="post" %} [MultiMarkets-Auth2Api.openapi.en.yaml](https://3404072034-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FvilfBi544sqSg2yLNueg%2Fuploads%2FXCJ6ADT0ACx2LmNmXOgi%2FMultiMarkets-Auth2Api.openapi.en.yaml?alt=media\&token=6653c29f-e7b4-440e-be6f-dc7b6fcb3e23) {% endopenapi %} # Refresh Token {% openapi src="/files/vb33gLBHH3Q5HLSEJxKE" path="/auth2/refresh" method="post" %} [MultiMarkets-Auth2Api.openapi.en.yaml](https://3404072034-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FvilfBi544sqSg2yLNueg%2Fuploads%2FXCJ6ADT0ACx2LmNmXOgi%2FMultiMarkets-Auth2Api.openapi.en.yaml?alt=media\&token=6653c29f-e7b4-440e-be6f-dc7b6fcb3e23) {% endopenapi %} # More... More For more management APIs, you can directly download the Openapi3.0 specification document [Openapi3.0](https://github.com/CTradeExchange/multimarkets-api-postman) or directly jump to the online address: [Online API documentation](https://multimarkets-c-api-en.apidocumentation.com) # Basic ## HEAD / > Global Unified Request Header ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Basic"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/":{"head":{"summary":"Global Unified Request Header","deprecated":false,"description":"","operationId":"updateLoginPwd","tags":["Basic"],"parameters":[{"name":"companyId","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"Default Value: en-US","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"group","in":"header","description":"","required":false,"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,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"string"}}},"headers":{}}}}}}} ``` ## Get country information based on IP > IP country query, accessible to visitors ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Basic"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/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,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"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":{}}}}}}} ``` ## Get current service time > Get current service time ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Basic"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/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,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"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"]}}},"headers":{}}}}}}} ``` ## Asset code data > bizType=config.app.AppAssetsDubboService.getAssetsList\ > Get all asset list data supported by the platform
```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Basic"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/config.app.AppAssetsDubboService.getAssetsList":{"post":{"summary":"Asset code data","deprecated":false,"description":"bizType=config.app.AppAssetsDubboService.getAssetsList\nGet all asset list data supported by the platform\n","operationId":"getAssetsList","tags":["Basic"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"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"}}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultListAssets"}}},"headers":{}}}}}},"components":{"schemas":{"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"}}}}}} ``` ## Dictionary query based on ID > bizType=config.app.AppDictDubboService.getListByParentId\ > Dictionary query based on parentId\ > Accessible to visitors ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Basic"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/config.app.AppDictDubboService.getListByParentId":{"post":{"summary":"Dictionary query based on ID","deprecated":false,"description":"bizType=config.app.AppDictDubboService.getListByParentId\nDictionary query based on parentId\nAccessible to visitors","operationId":"getListByParentId","tags":["Basic"],"parameters":[{"name":"companyId","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"parentId":{"type":"integer","description":"Parent ID"}},"required":["parentId"]}}}},"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"}}}}},"headers":{}}}}}}} ``` ## Dictionary query based on code > bizType=config.app.AppDictDubboService.getListByParentCode\ > Dictionary query based on code\ > Guest access ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Basic"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/config.app.AppDictDubboService.getListByParentCode":{"post":{"summary":"Dictionary query based on code","deprecated":false,"description":"bizType=config.app.AppDictDubboService.getListByParentCode\nDictionary query based on code\nGuest access","operationId":"getListByParentCode","tags":["Basic"],"parameters":[{"name":"companyId","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"parentCode":{"type":"string","description":"Dictionary code"}},"required":["parentCode"]}}}},"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"}}}}},"headers":{}}}}}}} ``` ## Batch query based on Code dictionary > bizType=config.app.AppDictDubboService.getMapByParentCodes\ > Batch get dictionary data ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Basic"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/config.app.AppDictDubboService.getMapByParentCodes":{"post":{"summary":"Batch query based on Code dictionary","deprecated":false,"description":"bizType=config.app.AppDictDubboService.getMapByParentCodes\nBatch get dictionary data","operationId":"getListByParentId","tags":["Basic"],"parameters":[{"name":"companyId","in":"header","description":"Company ID, obtained through environment variables","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"Random Tracking Code UUID","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"Login Token","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"Language","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"parentCode":{"description":"Dictionary codes, separated by commas","type":"string"}},"required":["parentCode"]}}}},"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":"#/components/schemas/DictVO","description":"Dictionary item list"},"description":"Dictionary code"}},"required":["code"],"description":"Data Body"},"ok":{"type":"boolean"},"fail":{"type":"boolean"}},"required":["data"]}}},"headers":{}}}}}},"components":{"schemas":{"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"}}}}}} ``` ## Country/Region query based on ID > bizType=config.app.AppDictDubboService.getCountryListByParentId\ > Country/Region query based on ID\ > Accessible to visitors ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Basic"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/config.app.AppDictDubboService.getCountryListByParentId":{"post":{"summary":"Country/Region query based on ID","deprecated":false,"description":"bizType=config.app.AppDictDubboService.getCountryListByParentId\nCountry/Region query based on ID\nAccessible to visitors","operationId":"getCountryListByParentId","tags":["Basic"],"parameters":[{"name":"companyId","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"parentId":{"type":"string","description":"Parent ID"}},"required":["parentId"]}}}},"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":"#/components/schemas/CountryDictVo"}}}}},"ok":{"type":"boolean"},"fail":{"type":"boolean"}}}}},"headers":{}}}}}},"components":{"schemas":{"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":"#/components/schemas/CountryDictVo"}}}}}}} ``` ## Query country/region based on code > bizType=config.app.AppDictDubboService.getCountryListByParentCode\ > Query country/region based on code\ > Accessible to visitors ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Basic"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/config.app.AppDictDubboService.getCountryListByParentCode":{"post":{"summary":"Query country/region based on code","deprecated":false,"description":"bizType=config.app.AppDictDubboService.getCountryListByParentCode\nQuery country/region based on code\nAccessible to visitors","operationId":"getCountryListByParentCode","tags":["Basic"],"parameters":[{"name":"companyId","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"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"]}}}},"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":"#/components/schemas/CountryDictVo"}}}}},"ok":{"type":"boolean"},"fail":{"type":"boolean"}}}}},"headers":{}}}}}},"components":{"schemas":{"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":"#/components/schemas/CountryDictVo"}}}}}}} ``` ## Product Basic Data > bizType=config.app.AppSymbolDubboService.getSymbolList\ > Query basic product information, support customer group and product name/code fuzzy query\ > Guest access available ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Basic"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/config.app.AppSymbolDubboService.getSymbolList":{"post":{"summary":"Product Basic Data","deprecated":false,"description":"bizType=config.app.AppSymbolDubboService.getSymbolList\nQuery basic product information, support customer group and product name/code fuzzy query\nGuest access available","operationId":"getSymbolList","tags":["Basic"],"parameters":[{"name":"companyId","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"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"]}}}},"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"}}}}},"headers":{}}}}}}} ``` ## Brief Product Data > 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 ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Basic"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/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,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"Random Tracking Code UUID","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"Login Token","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"Language","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchSymbolBaseDto"}}}},"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":"#/components/schemas/HolidayTime"},"description":"Holiday Time"},"tradeTimeList":{"type":"array","items":{"$ref":"#/components/schemas/TradeTime"},"description":"Trading Time"}},"required":["inHolidayTime","inTradeTime","holidayTimeList","tradeTimeList"]}},"ok":{"type":"boolean"},"fail":{"type":"boolean"}}}}},"headers":{}}}}}},"components":{"schemas":{"SearchSymbolBaseDto":{"type":"object","properties":{"customerGroupId":{"type":"integer","format":"int64","description":"Client group ID"}},"required":["customerGroupId"]},"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"},"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"}}}} ``` ## Product Detailed Data > bizType=config.app.AppSymbolDubboService.getSymbolDetail Get detailed trading parameters for product configuration ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Basic"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/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,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"Random Tracking Code UUID","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"Login Token","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"Language","required":true,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":true,"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"]}}}},"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":"#/components/schemas/MarginSet"},"description":"Weekday Margin Level"},"holidayMarginSet":{"type":"array","items":{"$ref":"#/components/schemas/MarginSet"},"description":"Holiday Margin Level"},"weekendMarginSet":{"type":"array","items":{"$ref":"#/components/schemas/MarginSet"},"description":"Weekend Margin Level"},"beforeHolidayMarginSet":{"type":"array","items":{"$ref":"#/components/schemas/MarginSet"},"description":"Margin ratio before the holiday"},"beforeWeekendMarginSet":{"type":"array","items":{"$ref":"#/components/schemas/MarginSet"},"description":"Margin ratio before the weekend"},"usedMarginSet":{"type":"array","items":{"$ref":"#/components/schemas/MarginSet"},"description":"Current margin ratio in use"},"tradeTimeList":{"type":"array","items":{"$ref":"#/components/schemas/TradeTime"},"description":"Trading Time"},"quoteTimeList":{"type":"array","items":{"$ref":"#/components/schemas/QuoteTime"},"description":"Market time"},"holidayTimeList":{"type":"array","items":{"$ref":"#/components/schemas/HolidayTime"},"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":"#/components/schemas/DictVO","description":"Dictionary item list"},"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":"#/components/schemas/MarginSet"},"daytimeBuyRemainingMarginRatio":{"$ref":"#/components/schemas/MarginSet"},"daytimeBuyAlarmMarginRatio":{"$ref":"#/components/schemas/MarginSet"},"daytimeSellInitMarginRatio":{"$ref":"#/components/schemas/MarginSet"},"daytimeSellRemainingMarginRatio":{"$ref":"#/components/schemas/MarginSet"},"daytimeSellAlarmMarginRatio":{"$ref":"#/components/schemas/MarginSet"},"overnightBuyInitMarginRatio":{"$ref":"#/components/schemas/MarginSet"},"overnightBuyRemainingMarginRatio":{"$ref":"#/components/schemas/MarginSet"},"overnightBuyAlarmMarginRatio":{"$ref":"#/components/schemas/MarginSet"},"overnightSellInitMarginRatio":{"$ref":"#/components/schemas/MarginSet"},"overnightSellRemainingMarginRatio":{"$ref":"#/components/schemas/MarginSet"},"overnightSellAlarmMarginRatio":{"$ref":"#/components/schemas/MarginSet"},"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":"#/components/schemas/DividendInfo"},"description":"Company future action"},"dividendPastInfos":{"type":"array","items":{"$ref":"#/components/schemas/DividendInfo"},"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"}}}}},"headers":{}}}}}},"components":{"schemas":{"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"}}},"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"},"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"},"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"},"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"},"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"},"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"},"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"}}},"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"},"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"}}}} ``` ## Fund detailed information > Get fund detailed information ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Basic"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/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,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"fundId":{"type":"integer","format":"int64","description":"Fund ID"}}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultOpenFundsVo"}}},"headers":{}}}}}},"components":{"schemas":{"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":"#/components/schemas/OpenFundsVo"},"ok":{"type":"boolean"},"fail":{"type":"boolean"}}},"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"}}},"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"}}},"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"}}},"BaseAssets":{"type":"object","properties":{"currencyCode":{"type":"string","description":"Currency Code"},"currencyName":{"type":"string","description":"Currency Name"},"weight":{"type":"string","description":"Weight"}}}}}} ``` ## Brief information query for funds > Pagination query for fund list data ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Basic"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/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,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"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"}}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultBasePageVoOpenFundsVo"}}},"headers":{}}}}}},"components":{"schemas":{"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":"#/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"}}},"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"}}},"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"}}},"BaseAssets":{"type":"object","properties":{"currencyCode":{"type":"string","description":"Currency Code"},"currencyName":{"type":"string","description":"Currency Name"},"weight":{"type":"string","description":"Weight"}}}}}} ``` ## Fund Detailed Information Query > Fund Detailed Information Pagination Query (with real-time information) ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Basic"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/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,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"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"}}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultBasePageVoOpenFundsVo"}}},"headers":{}}}}}},"components":{"schemas":{"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":"#/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"}}},"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"}}},"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"}}},"BaseAssets":{"type":"object","properties":{"currencyCode":{"type":"string","description":"Currency Code"},"currencyName":{"type":"string","description":"Currency Name"},"weight":{"type":"string","description":"Weight"}}}}}} ``` ## Fund net asset value and premium rate query > Query net asset value and premium rate ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Basic"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/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,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"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"}}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultQueryEquityPremiumRateVo"}}},"headers":{}}}}}},"components":{"schemas":{"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"}}}}}} ``` ## Fund detailed information query - Fund manager > Get fund details based on fund manager ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Basic"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/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,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"customerNo":{"type":"string","description":"Client number"}},"required":["customerNo"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultOpenFundsVo"}}},"headers":{}}}}}},"components":{"schemas":{"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":"#/components/schemas/OpenFundsVo"},"ok":{"type":"boolean"},"fail":{"type":"boolean"}}},"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"}}},"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"}}},"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"}}},"BaseAssets":{"type":"object","properties":{"currencyCode":{"type":"string","description":"Currency Code"},"currencyName":{"type":"string","description":"Currency Name"},"weight":{"type":"string","description":"Weight"}}}}}} ``` # Customer/Basic ## First Time Setting Login Password > version=0.0.1\ > bizType=customer.app.CustomerWebApiService.bindLoginPwd\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Basic"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerWebApiService.bindLoginPwd":{"post":{"summary":"First Time Setting Login Password","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerWebApiService.bindLoginPwd\nAccessible after login","operationId":"bindLoginPwd","tags":["Customer/Basic"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResult1"}}},"headers":{}}}}}},"components":{"schemas":{"BaseResult1":{"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"}}}}}} ``` ## Change Email > version=0.0.1\ > bizType=customer.app.CustomerWebApiService.changeEmail\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Basic"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerWebApiService.changeEmail":{"post":{"summary":"Change Email","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerWebApiService.changeEmail\nAccessible after login","operationId":"changeEmail","tags":["Customer/Basic"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResult1"}}},"headers":{}}}}}},"components":{"schemas":{"BaseResult1":{"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"}}}}}} ``` ## Change Email (MFA) > 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 ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Basic"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerWebApiService.changeEmailV1v1v2":{"post":{"summary":"Change Email (MFA)","deprecated":true,"description":"version=0.0.1\nbizType=customer.app.CustomerWebApiService.changeEmailV1v1v2\nAccessible after login\n\nIf 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,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResult1"}}},"headers":{}}}}}},"components":{"schemas":{"BaseResult1":{"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"}}}}}} ``` ## Change phone number > version=0.0.1\ > bizType=customer.app.CustomerWebApiService.changePhone\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Basic"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerWebApiService.changePhone":{"post":{"summary":"Change phone number","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerWebApiService.changePhone\nAccessible after login","operationId":"changePhone","tags":["Customer/Basic"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResult1"}}},"headers":{}}}}}},"components":{"schemas":{"BaseResult1":{"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"}}}}}} ``` ## Change phone number (MFA) > 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 ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Basic"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerWebApiService.changePhoneV1v1v2":{"post":{"summary":"Change phone number (MFA)","deprecated":true,"description":"version=0.0.1\nbizType=customer.app.CustomerWebApiService.changePhoneV1v1v2\nAccessible after login\n\nIf the customer enables Google Authenticator (MFA), the Google Authenticator code (googleCode) in the input parameters is required,\nand the user does not need to enter the old phone number","operationId":"changePhoneV1v1v2","tags":["Customer/Basic"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResult1"}}},"headers":{}}}}}},"components":{"schemas":{"BaseResult1":{"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"}}}}}} ``` ## Check if customer information exists > version=0.0.1\ > bizType=customer.app.CustomerWebApiService.checkCustomerExist\ > Accessible to visitors ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Basic"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerWebApiService.checkCustomerExist":{"post":{"summary":"Check if customer information exists","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerWebApiService.checkCustomerExist\nAccessible to visitors","operationId":"checkCustomerExist","tags":["Customer/Basic"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"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":{}}}}}}} ``` ## Customer cancellation > version=0.0.1\ > bizType=customer.app.CustomerWebApiService.destroy\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Basic"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerWebApiService.destroy":{"post":{"summary":"Customer cancellation","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerWebApiService.destroy\nAccessible after login","operationId":"destroy","tags":["Customer/Basic"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"remark":{"type":"string","description":"Cancellation remarks"}}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResult1"}}},"headers":{}}}}}},"components":{"schemas":{"BaseResult1":{"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"}}}}}} ``` ## Google verification code binding and unbinding > 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\ ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Basic"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerWebApiService.enableOrForbidMFA":{"post":{"summary":"Google verification code binding and unbinding","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerWebApiService.enableOrForbidMFA\nAccessible after login\nIf 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,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnableOrForbidMFADTO"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResult1"}}},"headers":{}}}}}},"components":{"schemas":{"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}}},"BaseResult1":{"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"}}}}}} ``` ## Query customer information > version=0.0.1\ > bizType=customer.app.CustomerWebApiService.findCustomerInfo\ > Access after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Basic"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerWebApiService.findCustomerInfo":{"post":{"summary":"Query customer information","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerWebApiService.findCustomerInfo\nAccess after login","operationId":"findCustomerInfo","tags":["Customer/Basic"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"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":{}}}}}}} ``` ## Forget fund password > version=0.0.1\ > bizType=customer.app.CustomerWebApiService.forgetAssertsPwd\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Basic"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerWebApiService.forgetAssertsPwd":{"post":{"summary":"Forget fund password","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerWebApiService.forgetAssertsPwd\nAccessible after login","operationId":"forgetAssertsPwd","tags":["Customer/Basic"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResult1"}}},"headers":{}}}}}},"components":{"schemas":{"BaseResult1":{"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"}}}}}} ``` ## Forget fund password (MFA) > 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 ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Basic"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerWebApiService.forgetAssertsPwdV1v1v2":{"post":{"summary":"Forget fund password (MFA)","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerWebApiService.forgetAssertsPwdV1v1v2\nAccessible after login\n\nIf 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,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResult1"}}},"headers":{}}}}}},"components":{"schemas":{"BaseResult1":{"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"}}}}}} ``` ## Forgot Login Password > version=0.0.1\ > bizType=customer.app.CustomerWebApiService.forgetLoginPwd\ > Guest Accessible ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Basic"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerWebApiService.forgetLoginPwd":{"post":{"summary":"Forgot Login Password","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerWebApiService.forgetLoginPwd\nGuest Accessible","operationId":"forgetLoginPwd","tags":["Customer/Basic"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResult1"}}},"headers":{}}}}}},"components":{"schemas":{"BaseResult1":{"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"}}}}}} ``` ## Set Fund Password for the First Time > version=0.0.1\ > bizType=customer.app.CustomerWebApiService.bindAssertsPwd\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Basic"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerWebApiService.bindAssertsPwd":{"post":{"summary":"Set Fund Password for the First Time","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerWebApiService.bindAssertsPwd\nAccessible after login","operationId":"bindAssertsPwd","tags":["Customer/Basic"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResult1"}}},"headers":{}}}}}},"components":{"schemas":{"BaseResult1":{"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"}}}}}} ``` ## Bind Email > version=0.0.1\ > bizType=customer.app.CustomerWebApiService.bindEmail\ > Access after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Basic"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerWebApiService.bindEmail":{"post":{"summary":"Bind Email","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerWebApiService.bindEmail\nAccess after login","operationId":"bindEmail","tags":["Customer/Basic"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResult1"}}},"headers":{}}}}}},"components":{"schemas":{"BaseResult1":{"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"}}}}}} ``` ## Bind mobile phone number > version=0.0.1\ > bizType=customer.app.CustomerWebApiService.bindPhone\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Basic"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerWebApiService.bindPhone":{"post":{"summary":"Bind mobile phone number","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerWebApiService.bindPhone\nAccessible after login","operationId":"bindEmail","tags":["Customer/Basic"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResult1"}}},"headers":{}}}}}},"components":{"schemas":{"BaseResult1":{"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"}}}}}} ``` ## Switch language > version=0.0.1\ > bizType=customer.app.CustomerWebApiService.changeLang\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Basic"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerWebApiService.changeLang":{"post":{"summary":"Switch language","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerWebApiService.changeLang\nAccessible after login","operationId":"changeLang","tags":["Customer/Basic"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"newLang":{"type":"string","description":"Language Information"}},"required":["newLang"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResult1"}}},"headers":{}}}}}},"components":{"schemas":{"BaseResult1":{"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"}}}}}} ``` ## Query customer language > version=0.0.1\ > bizType=customer.app.CustomerWebApiService.findCustomerLang\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Basic"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerWebApiService.findCustomerLang":{"post":{"summary":"Query customer language","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerWebApiService.findCustomerLang\nAccessible after login","operationId":"changeLang","tags":["Customer/Basic"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"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"}}}}},"headers":{}}}}}}} ``` ## Modify Customer Communication Address and Postal Code > version=0.0.1\ > bizType=customer.app.CustomerWebApiService.changeCustomerAddressAndPostalCode\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Basic"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerWebApiService.changeCustomerAddressAndPostalCode":{"post":{"summary":"Modify Customer Communication Address and Postal Code","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerWebApiService.changeCustomerAddressAndPostalCode\nAccessible after login","operationId":"changeLang","tags":["Customer/Basic"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"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"}}}}},"headers":{}}}}}}} ``` ## First set phone number (TG) > version=0.0.1\ > bizType=customer.app.CustomerWebApiService.firstSetPhone\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Basic"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerWebApiService.firstSetPhone":{"post":{"summary":"First set phone number (TG)","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerWebApiService.firstSetPhone\nAccessible after login","operationId":"changeLang","tags":["Customer/Basic"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"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"}}}}},"headers":{}}}}}}} ``` ## First Time Setting Email (TG) > version=0.0.1\ > bizType=customer.app.CustomerWebApiService.firstSetEmail\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Basic"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerWebApiService.firstSetEmail":{"post":{"summary":"First Time Setting Email (TG)","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerWebApiService.firstSetEmail\nAccessible after login","operationId":"changeLang","tags":["Customer/Basic"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"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"}}}}},"headers":{}}}}}}} ``` ## First Time Setting Login Password (TG) > version=0.0.1\ > bizType=customer.app.CustomerWebApiService.firstTimeSettingLoginPassword\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Basic"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerWebApiService.firstTimeSettingLoginPassword":{"post":{"summary":"First Time Setting Login Password (TG)","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerWebApiService.firstTimeSettingLoginPassword\nAccessible after login","operationId":"changeLang","tags":["Customer/Basic"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"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"}}}}},"headers":{}}}}}}} ``` ## Query Customer 3rd Party Binding Information > version=0.0.1\ > bizType=customer.app.CustomerWebApiService.findThirdAccountInfo\ > Access after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Basic"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerWebApiService.findThirdAccountInfo":{"post":{"summary":"Query Customer 3rd Party Binding Information","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerWebApiService.findThirdAccountInfo\nAccess after login","operationId":"changeLang","tags":["Customer/Basic"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"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"}}}}},"headers":{}}}}}}} ``` ## Check if the customer has enabled GoogleMFA > version=0.0.1\ > bizType=customer.app.CustomerWebApiService.checkGoogleMFAStatus\ > Guest access ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Basic"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerWebApiService.checkGoogleMFAStatus":{"post":{"summary":"Check if the customer has enabled GoogleMFA","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerWebApiService.checkGoogleMFAStatus\nGuest access","operationId":"checkGoogleMFAStatus","tags":["Customer/Basic"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"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"}}}}},"headers":{}}}}}}} ``` ## Check customer status > 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 ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Basic"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerWebApiService.checkStatus":{"post":{"summary":"Check customer status","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerWebApiService.checkStatus\nDetermine customer status: 1 exists, 2 does not exist, -1 customer is disabled\nThis interface requires login","operationId":"checkStatus","tags":["Customer/Basic"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultCustomerStatusVO"}}},"headers":{}}}}}},"components":{"schemas":{"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"}}}}}} ``` ## Query account asset information (leverage) > version=0.0.1\ > bizType=customer.app.CustomerWebApiService.queryAccountAssetsInfo\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Basic"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerWebApiService.queryAccountAssetsInfo":{"post":{"summary":"Query account asset information (leverage)","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerWebApiService.queryAccountAssetsInfo\nAccessible after login","operationId":"queryAccountAssetsInfo","tags":["Customer/Basic"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResult1"}}},"headers":{}}}}}},"components":{"schemas":{"BaseResult1":{"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"}}}}}} ``` ## Real-time account fund information > version=0.0.1\ > bizType=customer.app.CustomerWebApiService.queryAccountById\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Basic"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerWebApiService.queryAccountById":{"post":{"summary":"Real-time account fund information","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerWebApiService.queryAccountById\nAccessible after login","operationId":"queryAccountById","tags":["Customer/Basic"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"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":{}}}}}}} ``` ## Query customer assets > version=0.0.1\ > bizType=customer.app.CustomerWebApiService.queryCustomerAssets\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Basic"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerWebApiService.queryCustomerAssets":{"post":{"summary":"Query customer assets","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerWebApiService.queryCustomerAssets\nAccessible after login","operationId":"queryCustomerAssets","tags":["Customer/Basic"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"tradeType":{"type":"integer","format":"int64","description":"Game ID"}}}}}},"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"]}}},"headers":{}}}}}}} ``` ## Customer total asset information (does not support contract gameplay) > version=0.0.1\ > bizType=customer.app.CustomerWebApiService.queryCustomerAssetsInfo\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Basic"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerWebApiService.queryCustomerAssetsInfo":{"post":{"summary":"Customer total asset information (does not support contract gameplay)","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerWebApiService.queryCustomerAssetsInfo\nAccessible after login","operationId":"queryCustomerAssetsInfo","tags":["Customer/Basic"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"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"]}}},"headers":{}}}}}}} ``` ## Borrowing and repayment flow list (leverage) > version=0.0.1\ > bizType=customer.app.CustomerWebApiService.queryLiabilitiesWaterByPage\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Basic"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerWebApiService.queryLiabilitiesWaterByPage":{"post":{"summary":"Borrowing and repayment flow list (leverage)","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerWebApiService.queryLiabilitiesWaterByPage\nAccessible after login","operationId":"queryLiabilitiesWaterByPage","tags":["Customer/Basic"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"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":{}}}}}}} ``` ## Modify fund password > version=0.0.1\ > bizType=customer.app.CustomerWebApiService.updateAssertsPwd\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Basic"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerWebApiService.updateAssertsPwd":{"post":{"summary":"Modify fund password","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerWebApiService.updateAssertsPwd\nAccessible after login","operationId":"updateAssertsPwd","tags":["Customer/Basic"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResult1"}}},"headers":{}}}}}},"components":{"schemas":{"BaseResult1":{"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"}}}}}} ``` ## Modify fund password (MFA) > version=0.0.1\ > bizType=customer.app.CustomerWebApiService.updateAssertsPwdMFA\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Basic"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerWebApiService.updateAssertsPwdMFA":{"post":{"summary":"Modify fund password (MFA)","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerWebApiService.updateAssertsPwdMFA\nAccessible after login","operationId":"updateAssertsPwd","tags":["Customer/Basic"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResult1"}}},"headers":{}}}}}},"components":{"schemas":{"BaseResult1":{"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"}}}}}} ``` ## Modify login password > version=0.0.1\ > bizType=customer.app.CustomerWebApiService.updateLoginPwd\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Basic"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerWebApiService.updateLoginPwd":{"post":{"summary":"Modify login password","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerWebApiService.updateLoginPwd\nAccessible after login","operationId":"updateLoginPwd","tags":["Customer/Basic"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResult1"}}},"headers":{}}}}}},"components":{"schemas":{"BaseResult1":{"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"}}}}}} ``` ## Modify login password (MFA) > version=0.0.1\ > bizType=customer.app.CustomerWebApiService.updateLoginPwdMFA\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Basic"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerWebApiService.updateLoginPwdMFA":{"post":{"summary":"Modify login password (MFA)","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerWebApiService.updateLoginPwdMFA\nAccessible after login","operationId":"updateAssertsPwd","tags":["Customer/Basic"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResult1"}}},"headers":{}}}}}},"components":{"schemas":{"BaseResult1":{"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"}}}}}} ``` ## Query customer group list > version=0.0.1\ > bizType=customer.app.CustomerWebApiService.groupList\ > Accessible to visitors ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Basic"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerWebApiService.groupList":{"post":{"summary":"Query customer group list","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerWebApiService.groupList\nAccessible to visitors","operationId":"updateLoginPwd","tags":["Customer/Basic"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"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":{}}}}}}} ``` ## Modify email (MFA) Copy > version=0.0.1\ > bizType=customer.app.CustomerWebApiService.changeEmailMFA\ > Accessible after login\ > This interface: can independently choose old credential verification method ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Basic"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerWebApiService.changeEmailMFA":{"post":{"summary":"Modify email (MFA) Copy","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerWebApiService.changeEmailMFA\nAccessible after login\nThis interface: can independently choose old credential verification method","operationId":"updateAssertsPwd","tags":["Customer/Basic"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResult1"}}},"headers":{}}}}}},"components":{"schemas":{"BaseResult1":{"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"}}}}}} ``` ## Modify phone (MFA) Copy > version=0.0.1\ > bizType=customer.app.CustomerWebApiService.changePhoneMFA\ > Accessible after login\ > This interface: can independently choose old credential verification method ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Basic"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerWebApiService.changePhoneMFA":{"post":{"summary":"Modify phone (MFA) Copy","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerWebApiService.changePhoneMFA\nAccessible after login\nThis interface: can independently choose old credential verification method","operationId":"updateAssertsPwd","tags":["Customer/Basic"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResult1"}}},"headers":{}}}}}},"components":{"schemas":{"BaseResult1":{"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"}}}}}} ``` ## Modify country > 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. ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Basic"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerWebApiService.changeCountry":{"post":{"summary":"Modify country","deprecated":false,"description":"version=0.0.1 bizType=customer.app.CustomerWebApiService.changeCountry \nYou can access it after logging in.\nIf the customer has an approved KYC, the country change will be rejected.\nAfter 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,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"newCountry":{"type":"string","description":"Country code","maxLength":15}},"required":["newCountry"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResult1"}}},"headers":{}}}}}},"components":{"schemas":{"BaseResult1":{"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"}}}}}} ``` ## Set fund password (MFA) > version=0.0.1\ > bizType=customer.app.CustomerWebApiService.bindAssertsPwdMFA\ > After logging in, you can access it. ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Basic"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerWebApiService.bindAssertsPwdMFA":{"post":{"summary":"Set fund password (MFA)","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerWebApiService.bindAssertsPwdMFA\nAfter logging in, you can access it.","operationId":"bindAssertsPwd","tags":["Customer/Basic"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResult1"}}},"headers":{}}}}}},"components":{"schemas":{"BaseResult1":{"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"}}}}}} ``` ## Reset fund password (MFA) > version=0.0.1\ > bizType=customer.app.CustomerWebApiService.forgetAssertsPwdMFA\ > After logging in, you can access it. ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Basic"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerWebApiService.forgetAssertsPwdMFA":{"post":{"summary":"Reset fund password (MFA)","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerWebApiService.forgetAssertsPwdMFA\nAfter logging in, you can access it.","operationId":"bindAssertsPwd","tags":["Customer/Basic"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResult1"}}},"headers":{}}}}}},"components":{"schemas":{"BaseResult1":{"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"}}}}}} ``` ## Bind third-party account information > version=0.0.1\ > bizType=customer.app.CustomerWebApiService.bindThirdAccount\ > After logging in, you can access it. ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Basic"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerWebApiService.bindThirdAccount":{"post":{"summary":"Bind third-party account information","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerWebApiService.bindThirdAccount\nAfter logging in, you can access it.","tags":["Customer/Basic"],"parameters":[{"name":"version","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"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"]}}}},"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"}}}}},"headers":{}}}}}}} ``` ## Query the balance of the account in the third-party system > version=0.0.1\ > bizType=customer.app.CustomerWebApiService.queryLatestBalanceOfUserAccountInExternalSystem\ > Access after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Basic"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/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\nbizType=customer.app.CustomerWebApiService.queryLatestBalanceOfUserAccountInExternalSystem\nAccess after login","tags":["Customer/Basic"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"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":{}}}}}}} ``` ## Query customer's phone and email > version=0.0.1\ > bizType=customer.app.CustomerWebApiService.findPhoneAndEmail\ > Access after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Basic"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerWebApiService.findPhoneAndEmail":{"post":{"summary":"Query customer's phone and email","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerWebApiService.findPhoneAndEmail\nAccess after login","tags":["Customer/Basic"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"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":{}}}}}}} ``` # Customer/Social ## Get Third-Party Login Configuration Information > version=0.0.1 bizType=customer.app.CustomerThirdLoginService.config Guest Accessible ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Social"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/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,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"thirdSource":{"type":"string","description":"Third-Party Sources: google, facebook, twitter, telegram, apple, metamask"}}}}}},"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":{}}}}}}} ``` ## Apple Third-party Login Verification > version=0.0.1\ > bizType=customer.app.CustomerThirdLoginService.appleVerify\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Social"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/h/com.cats.customer.api.app.CustomerThirdLoginService/appleVerify":{"post":{"summary":"Apple Third-party Login Verification","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerThirdLoginService.appleVerify\nAccessible 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"]}}}},"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":{}}}}}}} ``` ## Facebook Third-party Login Verification > version=0.0.1\ > bizType=customer.app.CustomerThirdLoginService.facebookVerify\ > Access after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Social"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/third/login/customer.app.CustomerThirdLoginService.facebookVerify":{"post":{"summary":"Facebook Third-party Login Verification","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerThirdLoginService.facebookVerify\nAccess after login","operationId":"facebookVerify","tags":["Customer/Social"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"accessToken":{"type":"string","description":"Verify accessToken"}}}}}},"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":{}}}}}}} ``` ## Google Third-party Login Verification > version=0.0.1\ > bizType=customer.app.CustomerThirdLoginService.googleVerify\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Social"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/h/com.cats.customer.api.app.CustomerThirdLoginService/googleVerify":{"post":{"summary":"Google Third-party Login Verification","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerThirdLoginService.googleVerify\nAccessible 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"}}}}}},"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":{}}}}}}} ``` ## Telegram third-party login verification > 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 ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Social"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/third/login/customer.app.CustomerThirdLoginService.telegramVerify":{"post":{"summary":"Telegram third-party login verification","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerThirdLoginService.telegramVerify\n###Version 0.0.2, used for third-party registration and login (no need for phone or email)\nversion=0.0.2\nbizType=customer.app.CustomerThirdLoginService.telegramVerify\nAccess after login","operationId":"metaMaskVerify","tags":["Customer/Social"],"parameters":[{"name":"companyId","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":true,"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"]}}}},"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":{}}}}}}} ``` ## Metamask third-party login verification > version=0.0.1\ > bizType=customer.app.CustomerThirdLoginService.metaMaskVerify\ > Access after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Social"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/third/login/customer.app.CustomerThirdLoginService.metaMaskVerify":{"post":{"summary":"Metamask third-party login verification","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerThirdLoginService.metaMaskVerify\nAccess 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"]}}}},"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":{}}}}}}} ``` ## Twitter third-party login verification > version=0.0.1\ > bizType=customer.app.CustomerThirdLoginService.twitterVerify\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Social"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/third/login/customer.app.CustomerThirdLoginService.twitterVerify":{"post":{"summary":"Twitter third-party login verification","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerThirdLoginService.twitterVerify\nAccessible 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"]}}}},"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":{}}}}}}} ``` ## Third-party login > version=0.0.1\ > bizType=customer.app.CustomerThirdLoginService.login\ > Accessible to guests ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Social"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/third/login/customer.app.CustomerThirdLoginService.login":{"post":{"summary":"Third-party login","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerThirdLoginService.login\nAccessible to guests","operationId":"login","tags":["Customer/Social"],"parameters":[{"name":"companyId","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":true,"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"]}}}},"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":{}}}}}}} ``` ## Third-party login (no need for phone, email) > version=0.0.1\ > bizType=customer.app.CustomerThirdLoginService.socialLogin\ > Guest access ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Social"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/third/login/customer.app.CustomerThirdLoginService.socialLogin":{"post":{"summary":"Third-party login (no need for phone, email)","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerThirdLoginService.socialLogin\nGuest access","operationId":"login","tags":["Customer/Social"],"parameters":[{"name":"companyId","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":true,"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"]}}}},"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":{}}}}}}} ``` ## Third-party registration > version=0.0.1\ > bizType=customer.app.CustomerThirdLoginService.register\ > Guest access ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Social"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/third/login/customer.app.CustomerThirdLoginService.register":{"post":{"summary":"Third-party registration","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerThirdLoginService.register\nGuest access","operationId":"register","tags":["Customer/Social"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"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":"#/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":{}}}}}},"components":{"schemas":{"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"}}}}}} ``` ## Third-party registration (no need for phone, email) > version=0.0.1\ > bizType=customer.app.CustomerThirdLoginService.socialRegister\ > Accessible for guests ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Social"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/third/login/customer.app.CustomerThirdLoginService.socialRegister":{"post":{"summary":"Third-party registration (no need for phone, email)","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerThirdLoginService.socialRegister\nAccessible for guests","operationId":"register","tags":["Customer/Social"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"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":"#/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."}}},"ok":{"type":"boolean"},"fail":{"type":"boolean"}}}}},"headers":{}}}}}},"components":{"schemas":{"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"}}}}}} ``` # Customer/Auth ## Login > version=0.0.1\ > bizType=customer.app.CustomerWebApiService.login\ > Guest Accessible ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Auth"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/login/customer.app.CustomerWebApiService.login":{"post":{"summary":"Login","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerWebApiService.login\nGuest Accessible","tags":["Customer/Auth"],"parameters":[{"name":"version","in":"header","description":"Version Number","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"Company ID, obtained through environment variables","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"Random Tracking Code UUID","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"Language","required":true,"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"]}}}},"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"}}}}},"headers":{}}}}}}} ``` ## POST /thirdExt/switchAccount > Switch Real Simulation Account ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Auth"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/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,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"Random Tracking Code UUID","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"Login Token","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"Language","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{}}}},"headers":{}}}}}}} ``` ## Reset Demo Account > version=0.0.1\ > bizType=customer.app.CustomerDubboApiService.resetAccount ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Auth"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerDubboApiService.resetAccount":{"post":{"summary":"Reset Demo Account","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerDubboApiService.resetAccount","tags":["Customer/Auth"],"parameters":[{"name":"companyId","in":"header","description":"Company ID, obtained through environment variables","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"Random Tracking Code UUID","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"Login Token","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"Language","required":true,"schema":{"type":"string"}},{"name":"version","in":"header","description":"Version Number","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{}}}},"headers":{}}}}}}} ``` ## Customer registration > version=0.0.1\ > bizType=customer.app.CustomerWebApiService.register\ > Guest access ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Auth"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/register/customer.app.CustomerWebApiService.register":{"post":{"summary":"Customer registration","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerWebApiService.register\nGuest access","operationId":"register","tags":["Customer/Auth"],"parameters":[{"name":"version","in":"header","description":"Version Number","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"Company ID, obtained through environment variables","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"Random Tracking Code UUID","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"Language","required":true,"schema":{"type":"string"}},{"name":"X-Forwarded-For","in":"header","description":"","required":true,"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"]}}}},"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":"#/components/schemas/KycAuthVO"}},"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":{}}}}}},"components":{"schemas":{"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"}}}}}} ``` ## Get access token > /global/thirdExt/randomKey\ > Exchange final access token with a temporary token ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Auth"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/thirdExt/randomKey":{"post":{"summary":"Get access token","deprecated":false,"description":"/global/thirdExt/randomKey\nExchange 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,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"Random Tracking Code UUID","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"Login Token","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"Language","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"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"]}}},"headers":{}}}}}}} ``` # Customer/Bank Card ## Add domestic bank card > version=0.0.1\ > bizType=customer.app.WithdrawBankWebApiService.add\ > Access after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Bank Card"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.WithdrawBankWebApiService.add":{"post":{"summary":"Add domestic bank card","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.WithdrawBankWebApiService.add\nAccess after login","operationId":"add","tags":["Customer/Bank Card"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResult1"}}},"headers":{}}}}}},"components":{"schemas":{"BaseResult1":{"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"}}}}}} ``` ## Add International Bank Card > version=0.0.1\ > bizType=customer.app.WithdrawBankWebApiService.addV1v2v8\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Bank Card"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.WithdrawBankWebApiService.addV1v2v8":{"post":{"summary":"Add International Bank Card","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.WithdrawBankWebApiService.addV1v2v8\nAccessible after login","operationId":"addV1v2v8","tags":["Customer/Bank Card"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResult1"}}},"headers":{}}}}}},"components":{"schemas":{"BaseResult1":{"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"}}}}}} ``` ## Get bank card list > version=0.0.1\ > bizType=customer.app.WithdrawBankWebApiService.bankList\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Bank Card"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.WithdrawBankWebApiService.bankList":{"post":{"summary":"Get bank card list","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.WithdrawBankWebApiService.bankList\nAccessible after login","operationId":"bankList","tags":["Customer/Bank Card"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"}}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultListCustomerWithdrawBankVO"}}},"headers":{}}}}}},"components":{"schemas":{"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"}}}}}} ``` ## Delete bank card information > version=0.0.1\ > bizType=customer.app.WithdrawBankWebApiService.delete\ > Access after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Bank Card"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.WithdrawBankWebApiService.delete":{"post":{"summary":"Delete bank card information","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.WithdrawBankWebApiService.delete\nAccess 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"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResult"}}},"headers":{}}}}}},"components":{"schemas":{"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"}}}} ``` # Customer/Extended ## View Customer Expansion Information > version=0.0.1\ > bizType=customer.app.CustomerExtendWebApiService.findCustomerExtend\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Extended"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerExtendWebApiService.findCustomerExtend":{"post":{"summary":"View Customer Expansion Information","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerExtendWebApiService.findCustomerExtend\nAccessible after login","operationId":"findCustomerExtend","tags":["Customer/Extended"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"integer","format":"int32","description":"Expansion Type, 1=payRedeem"}},"required":["type"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultObject"}}},"headers":{}}}}}},"components":{"schemas":{"BaseResultObject":{"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"}}}}}} ``` ## Save Customer Extension Information > version=0.0.1\ > bizType=customer.app.CustomerExtendWebApiService.saveCustomerExtend\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Extended"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerExtendWebApiService.saveCustomerExtend":{"post":{"summary":"Save Customer Extension Information","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerExtendWebApiService.saveCustomerExtend\nAccessible after login","operationId":"saveCustomerExtend","tags":["Customer/Extended"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResult1"}}},"headers":{}}}}}},"components":{"schemas":{"BaseResult1":{"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"}}}}}} ``` # Customer/Products ## Add Optional Products > version=0.0.1\ > bizType=customer.app.CustomerOptionalWebApiService.add\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Products"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerOptionalWebApiService.add":{"post":{"summary":"Add Optional Products","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerOptionalWebApiService.add\nAccessible after login","operationId":"add","tags":["Customer/Products"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResult1"}}},"headers":{}}}}}},"components":{"schemas":{"BaseResult1":{"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"}}}}}} ``` ## Delete selected products > version=0.0.1\ > bizType=customer.app.CustomerOptionalWebApiService.delete\ > Access after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Products"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerOptionalWebApiService.delete":{"post":{"summary":"Delete selected products","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerOptionalWebApiService.delete\nAccess after login","operationId":"delete","tags":["Customer/Products"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResult1"}}},"headers":{}}}}}},"components":{"schemas":{"BaseResult1":{"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"}}}}}} ``` ## Customized List > version=0.0.1\ > bizType=customer.app.CustomerOptionalWebApiService.optionalList\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Products"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerOptionalWebApiService.optionalList":{"post":{"summary":"Customized List","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerOptionalWebApiService.optionalList\nAccessible after login","operationId":"optionalList","tags":["Customer/Products"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultMapLongListCustomerOptionalVO"}}},"headers":{}}}}}},"components":{"schemas":{"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"}}}}}} ``` # Customer/Wallet ## Add Wallet > version=0.0.1\ > bizType=customer.app.CustomerWalletWebApiService.add\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Wallet"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerWalletWebApiService.add":{"post":{"summary":"Add Wallet","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerWalletWebApiService.add\nAccessible after login","operationId":"add","tags":["Customer/Wallet"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResult1"}}},"headers":{}}}}}},"components":{"schemas":{"BaseResult1":{"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"}}}}}} ``` ## Add Wallet (MFA) > 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 ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Wallet"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerWalletWebApiService.addV1v1v2":{"post":{"summary":"Add Wallet (MFA)","deprecated":true,"description":"version=0.0.1\nbizType=customer.app.CustomerWalletWebApiService.addV1v1v2\nAccessible after login\n\nIf the customer enables Google Authenticator (MFA), the Google Authenticator code (googleCode) in the input parameters is required,\nAt the same time, the user does not need to enter a phone number or email,\nIf both phone and email exist, the phone number is verified first","operationId":"addV1v1v2","tags":["Customer/Wallet"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResult1"}}},"headers":{}}}}}},"components":{"schemas":{"BaseResult1":{"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"}}}}}} ``` ## Delete Wallet > version=0.0.1\ > bizType=customer.app.CustomerWalletWebApiService.delete\ > Access after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Wallet"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerWalletWebApiService.delete":{"post":{"summary":"Delete Wallet","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerWalletWebApiService.delete\nAccess after login","operationId":"delete","tags":["Customer/Wallet"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Wallet Id","minimum":1}}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResult1"}}},"headers":{}}}}}},"components":{"schemas":{"BaseResult1":{"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"}}}}}} ``` ## Set default wallet (H5 does not use this interface) > version=0.0.1\ > bizType=customer.app.CustomerWalletWebApiService.updateWallet\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Wallet"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerWalletWebApiService.updateWallet":{"post":{"summary":"Set default wallet (H5 does not use this interface)","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerWalletWebApiService.updateWallet\nAccessible 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}}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResult1"}}},"headers":{}}}}}},"components":{"schemas":{"BaseResult1":{"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"}}}}}} ``` ## Wallet List > version=0.0.1\ > bizType=customer.app.CustomerWalletWebApiService.walletList\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Wallet"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerWalletWebApiService.walletList":{"post":{"summary":"Wallet List","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerWalletWebApiService.walletList\nAccessible after login","operationId":"walletList","tags":["Customer/Wallet"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"currency":{"type":"string","description":"Wallet Currency"},"chainName":{"type":"string","description":"Chain Name"}}}}}},"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"}}}}},"headers":{}}}}}}} ``` ## Add Withdrawal Address (MFA) > version=0.0.1\ > bizType=customer.app.CustomerWalletWebApiService.addWithdrawalAddressMFA\ > Accessible after login
```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Wallet"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerWalletWebApiService.addWithdrawalAddressMFA":{"post":{"summary":"Add Withdrawal Address (MFA) ","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerWalletWebApiService.addWithdrawalAddressMFA\nAccessible after login\n","operationId":"addV1v1v2","tags":["Customer/Wallet"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResult1"}}},"headers":{}}}}}},"components":{"schemas":{"BaseResult1":{"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"}}}}}} ``` ## Query withdrawal address list > version=0.0.1\ > bizType=customer.app.CustomerWalletWebApiService.withdrawalAddressList\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Wallet"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerWalletWebApiService.withdrawalAddressList":{"post":{"summary":"Query withdrawal address list","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerWalletWebApiService.withdrawalAddressList\nAccessible after login","operationId":"walletList","tags":["Customer/Wallet"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"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"}}}}},"headers":{}}}}}}} ``` ## Query withdrawal address list (grouped) > version=0.0.1\ > bizType=customer.app.CustomerWalletWebApiService.withdrawalAddressGroupList\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Wallet"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerWalletWebApiService.withdrawalAddressGroupList":{"post":{"summary":"Query withdrawal address list (grouped)","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerWalletWebApiService.withdrawalAddressGroupList\nAccessible after login","operationId":"walletList","tags":["Customer/Wallet"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"currency":{"type":"string","description":"Currency"}}}}}},"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"}}}}},"headers":{}}}}}}} ``` # Customer/Verification ## Generate Google verification account > version=0.0.1\ > bizType=customer.app.GoogleVerifyApiService.generateGoogleAccount\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Verification"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.GoogleVerifyApiService.generateGoogleAccount":{"post":{"summary":"Generate Google verification account","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.GoogleVerifyApiService.generateGoogleAccount\nAccessible after login","operationId":"checkGoogleCode","tags":["Customer/Verification"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultBoolean"}}},"headers":{}}}}}},"components":{"schemas":{"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"}}}}}} ``` ## Check Google verification code status > version=0.0.1\ > bizType=customer.app.GoogleVerifyApiService.checkGoogleCode\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Verification"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.GoogleVerifyApiService.checkGoogleCode":{"post":{"summary":"Check Google verification code status","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.GoogleVerifyApiService.checkGoogleCode\nAccessible after login","operationId":"findGoogleVerifyByCustomerNo","tags":["Customer/Verification"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"Google Verification Code"}},"required":["code"]}}}},"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"}}}}},"headers":{}}}}}}} ``` # Customer/KYC ## Is the business scenario KYC approved? > version=0.0.1\ > bizType=customer.app.KycWebApiService.checkKycApply\ > Can access after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/KYC"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.KycWebApiService.checkKycApply":{"post":{"summary":"Is the business scenario KYC approved?","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.KycWebApiService.checkKycApply\nCan access after login","operationId":"checkKycApply","tags":["Customer/KYC"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"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"}}}}},"headers":{}}}}}}} ``` ## Get KYC authentication information for business scenarios > version=0.0.1\ > bizType=customer.app.KycWebApiService.findAllBizKyc\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/KYC"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.KycWebApiService.findAllBizKyc":{"post":{"summary":"Get KYC authentication information for business scenarios","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.KycWebApiService.findAllBizKyc\nAccessible after login","operationId":"findAllBizKyc","tags":["Customer/KYC"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultListKycAuthVO"}}},"headers":{}}}}}},"components":{"schemas":{"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":"#/components/schemas/KycAuthVO"}},"ok":{"type":"boolean"},"fail":{"type":"boolean"}}},"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"}}}}}} ``` ## Identity authentication list > version=0.0.1\ > bizType=customer.app.KycWebApiService.findAllBizKycList\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/KYC"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.KycWebApiService.findAllBizKycList":{"post":{"summary":"Identity authentication list","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.KycWebApiService.findAllBizKycList\nAccessible after login","operationId":"findAllBizKycList","tags":["Customer/KYC"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"openAccountType":{"type":"integer","format":"int32","description":"Account type: 0. Individual 1. Enterprise "}}}}}},"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":{}}}}}}} ``` ## Get customer's authenticated information based on business scenarios > version=0.0.1\ > bizType=customer.app.KycWebApiService.findAllCusKycListByBiz\ > Access after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/KYC"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.KycWebApiService.findAllCusKycListByBiz":{"post":{"summary":"Get customer's authenticated information based on business scenarios","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.KycWebApiService.findAllCusKycListByBiz\nAccess after login","operationId":"findAllCusKycListByBiz","tags":["Customer/KYC"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultListKycAuthVO"}}},"headers":{}}}}}},"components":{"schemas":{"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":"#/components/schemas/KycAuthVO"}},"ok":{"type":"boolean"},"fail":{"type":"boolean"}}},"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"}}}}}} ``` ## Does KYC Level Require KYC Authentication > version=0.0.1\ > bizType=customer.app.KycWebApiService.findAllLevelKyc\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/KYC"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.KycWebApiService.findAllLevelKyc":{"post":{"summary":"Does KYC Level Require KYC Authentication","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.KycWebApiService.findAllLevelKyc\nAccessible after login","operationId":"findAllLevelKyc","tags":["Customer/KYC"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"}}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultListKycAuthVO"}}},"headers":{}}}}}},"components":{"schemas":{"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":"#/components/schemas/KycAuthVO"}},"ok":{"type":"boolean"},"fail":{"type":"boolean"}}},"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"}}}}}} ``` ## Get countries supporting enterprise account opening > version=0.0.1\ > bizType=customer.app.KycWebApiService.findCompanyCountry\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/KYC"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.KycWebApiService.findCompanyCountry":{"post":{"summary":"Get countries supporting enterprise account opening","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.KycWebApiService.findCompanyCountry\nAccessible after login","operationId":"findCompanyCountry","tags":["Customer/KYC"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"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"}}}}},"headers":{}}}}}}} ``` ## KYC business scenario authentication application > version=0.0.1\ > bizType=customer.app.KycWebApiService.kycApply\ > Access after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/KYC"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.KycWebApiService.kycApply":{"post":{"summary":"KYC business scenario authentication application","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.KycWebApiService.kycApply\nAccess after login","operationId":"kycApply","tags":["Customer/KYC"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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":"#/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"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResult1"}}},"headers":{}}}}}},"components":{"schemas":{"KycWebAddInnerDTO":{"type":"object","required":["elementCode","elementValue"],"properties":{"elementValue":{"type":"string","description":"KYC element value"},"elementCode":{"type":"string","description":"KYC element"}}},"BaseResult1":{"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"}}}}}} ``` ## KYC Level Certification Application > version=0.0.1\ > bizType=customer.app.KycWebApiService.kycLevelApply\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/KYC"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.KycWebApiService.kycLevelApply":{"post":{"summary":"KYC Level Certification Application","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.KycWebApiService.kycLevelApply\nAccessible after login","operationId":"kycLevelApply","tags":["Customer/KYC"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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":"#/components/schemas/KycWebAddInnerDTO"},"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"]}}}},"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"}}}}},"headers":{}}}}}},"components":{"schemas":{"KycWebAddInnerDTO":{"type":"object","required":["elementCode","elementValue"],"properties":{"elementValue":{"type":"string","description":"KYC element value"},"elementCode":{"type":"string","description":"KYC element"}}}}}} ``` # Customer/Open API ## Downgrade API > version=0.0.1\ > bizType=customer.app.CustomerApiWebService.downgrade\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Open API"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerApiWebService.downgrade":{"post":{"summary":"Downgrade API","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerApiWebService.downgrade\nAccessible after login","operationId":"applyApi","tags":["Customer/Open API"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"apiKey":{"type":"string","description":"Customer ApiKey"},"tag":{"type":"string","description":"API tags"},"times":{"type":"string","description":"Type of package duration. month－month; year－year; quarter－one season; half－six months;"}},"required":["apiKey","tag","times"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResult1"}}},"headers":{}}}}}},"components":{"schemas":{"BaseResult1":{"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"}}}}}} ``` ## Apply API > version=0.0.1\ > bizType=customer.app.CustomerApiWebService.applyApi\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Open API"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerApiWebService.applyApi":{"post":{"summary":"Apply API","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerApiWebService.applyApi\nAccessible after login","operationId":"applyApi","tags":["Customer/Open API"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResult1"}}},"headers":{}}}}}},"components":{"schemas":{"BaseResult1":{"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"}}}}}} ``` ## Delete API > version=0.0.1\ > bizType=customer.app.CustomerApiWebService.delApi\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Open API"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerApiWebService.delApi":{"post":{"summary":"Delete API","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerApiWebService.delApi\nAccessible after login","operationId":"delApi","tags":["Customer/Open API"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"api id"}}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResult1"}}},"headers":{}}}}}},"components":{"schemas":{"BaseResult1":{"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"}}}}}} ``` ## Allocate permissions > version=0.0.1\ > bizType=customer.app.CustomerApiWebService.editApiPermission\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Open API"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerApiWebService.editApiPermission":{"post":{"summary":"Allocate permissions","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerApiWebService.editApiPermission\nAccessible after login","operationId":"editApiPermission","tags":["Customer/Open API"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"}}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResult1"}}},"headers":{}}}}}},"components":{"schemas":{"BaseResult1":{"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"}}}}}} ``` ## API list > version=0.0.1\ > bizType=customer.app.CustomerApiWebService.page\ > Access after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Open API"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerApiWebService.page":{"post":{"summary":"API list","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerApiWebService.page\nAccess after login","operationId":"page","tags":["Customer/Open API"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"}}}}}},"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":"#/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"}}}}},"headers":{}}}}}},"components":{"schemas":{"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"}}}}}}} ``` ## API details > version=0.0.1\ > bizType=customer.app.CustomerApiWebService.queryApi\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Open API"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerApiWebService.queryApi":{"post":{"summary":"API details","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerApiWebService.queryApi\nAccessible after login","operationId":"queryApi","tags":["Customer/Open API"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"API Id"}}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultCustomerApiVO"}}},"headers":{}}}}}},"components":{"schemas":{"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":"#/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,"}}},"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"}}}}}}} ``` # Customer/Agent ## Query customer list > version=0.0.1\ > bizType=customer.app.CustomerWebApiService.queryCustomerOfAgentPage\ > Access after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Agent"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerWebApiService.queryCustomerOfAgentPage":{"post":{"summary":"Query customer list","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerWebApiService.queryCustomerOfAgentPage\nAccess after login","operationId":"applyApi","tags":["Customer/Agent"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"current":{"type":"integer","description":"Current Page"},"size":{"type":"integer","description":"Number of Items per Page"}},"required":["size","current"]}}}},"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":"integer","format":"int64","description":"Processing time (milliseconds)"},"trace":{"type":"string","description":"Tracking code"},"data":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Primary key id"},"createTime":{"type":"integer","description":"Creation time"},"updateTime":{"type":"integer","description":"Update Time"},"customerGroupId":{"type":"integer","description":"Customer group ID"},"customerGroupName":{"type":"string","description":"Customer Group Name"},"status":{"type":"integer","description":"Customer Status, 1 Normal, 2 Disabled, 3 Deleted, 4 Closed Account, 5 Locked, 6 Closing Account"},"companyId":{"type":"integer","description":"Company ID"},"customerNo":{"type":"string","description":"Client number"},"phone":{"type":"string","description":"Phone Number"},"phoneArea":{"type":"string","description":"Phone area code"},"registerSource":{"type":"integer","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"},"unitId":{"type":"integer","description":"Organization ID"},"firstName":{"type":"string","description":"First name"},"lastName":{"type":"string","description":"Last name"},"email":{"type":"string","description":"Email"},"customerType":{"type":"integer","description":"Customer Type 0 Default 1 Agent"}},"required":["id","createTime","updateTime","customerGroupId","customerGroupName","status","companyId","customerNo","phone","phoneArea","registerSource","unitId","firstName","lastName","email","customerType"]},"description":"Data List"},"total":{"type":"integer","description":"Total"},"size":{"type":"integer","description":"Page Size"},"current":{"type":"integer","description":"Current Page"}},"required":["records","total","size","current"],"description":"Paging Data Body"},"fail":{"type":"boolean"},"ok":{"type":"boolean"},"bizCode":{"type":"string","description":"Module identifier code"},"msgParams":{"type":"string","description":"Placeholder parameter string in return description, multiple parameters separated by commas"}},"required":["code","msg","tm","trace","data","fail","ok"]}}},"headers":{}}}}}}} ``` ## Customer registration > version=0.0.1\ > bizType=customer.app.CustomerWebApiService.registerOfAgentShareLink\ > Accessible to visitors\ > Agent share link, customer registration ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Agent"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerWebApiService.registerOfAgentShareLink":{"post":{"summary":"Customer registration","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerWebApiService.registerOfAgentShareLink\nAccessible to visitors\nAgent share link, customer registration","operationId":"applyApi","tags":["Customer/Agent"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"},"phoneArea":{"type":"string","description":"Phone area code","maxLength":15},"loginName":{"type":"string","description":"Account: email/phone number, used in conjunction with type","maxLength":50},"pwd":{"type":"string","description":"Password, MD5 encryption"},"type":{"type":"integer","description":"Registration method: 1=email, 2=phone number","format":"int32","minimum":1,"maximum":2},"registerDevice":{"type":"string","description":"Registered device model"},"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"},"thirdServerCode":{"type":"string","description":"Unique identifier of third-party system (input agent customer number)"}},"required":["registerSource","type","country","loginName","thirdServerCode"]}}}},"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":"#/components/schemas/KycAuthVO"}},"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"}}},"ok":{"type":"boolean"},"fail":{"type":"boolean"}}}}},"headers":{}}}}}},"components":{"schemas":{"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"}}}}}} ``` # Customer/Credit Card ## Verify the Validity of the Password Setting Link > version=0.0.1\ > bizType=customer.app.CustomerWebApiService.checkToken\ > Accessible to guests ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Credit Card"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerWebApiService.checkToken":{"post":{"summary":"Verify the Validity of the Password Setting Link","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerWebApiService.checkToken\nAccessible to guests","tags":["Customer/Credit Card"],"parameters":[{"name":"version","in":"header","description":"Version Number","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"Company ID, obtained through environment variables","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"Random Tracking Code UUID","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"Login Token","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"Language","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"companyId":{"type":"integer","title":"Company ID","description":"Environment variable configuration","format":"long"},"checkToken":{"type":"string","title":"Verify the Token","description":"Token Information on the Email Link","nullable":true}},"required":["companyId"]}}}},"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":{"errorCode":{"type":"string","description":"Custom error codes, 0 for success, CUSTOMER_API_0000148=The current link has expired, CUSTOMER_API_0000149=The current link has been used"},"email":{"type":"string","description":"Email, masked"},"bool":{"type":"string","description":"Is Email Exist, yes for exist, no for non-exist"}},"required":["bool"]},"ok":{"type":"boolean"},"fail":{"type":"boolean"}}}}},"headers":{}}}}}}} ``` ## Set password, verify phone number > version=0.0.1\ > bizType=customer.app.CustomerWebApiService.checkPhone\ > Guest access ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Credit Card"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerWebApiService.checkPhone":{"post":{"summary":"Set password, verify phone number","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerWebApiService.checkPhone\nGuest access","tags":["Customer/Credit Card"],"parameters":[{"name":"version","in":"header","description":"Version Number","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"Company ID, obtained through environment variables","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"Random Tracking Code UUID","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"Login Token","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"Language","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"checkToken":{"type":"string","title":"Verify the Token","description":"Token Information on the Email Link"},"phone":{"type":"string","title":"Phone Number"},"phoneArea":{"type":"string","title":"Phone area code"},"smsVerifyCode":{"type":"string","title":"Mobile Verification Code"},"smsSendToken":{"type":"string","title":"Send ticket"}},"required":["phone","phoneArea","smsVerifyCode","smsSendToken","checkToken"]}}}},"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, verify token information, next step information required","properties":{}},"ok":{"type":"boolean"},"fail":{"type":"boolean"}}}}},"headers":{}}}}}}} ``` ## Forgot password, verify phone number > version=0.0.1\ > bizType=customer.app.CustomerWebApiService.checkPhoneForRetriedLoginPwd\ > Accessible for guests ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Credit Card"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerWebApiService.checkPhoneForRetriedLoginPwd":{"post":{"summary":"Forgot password, verify phone number","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerWebApiService.checkPhoneForRetriedLoginPwd\nAccessible for guests","tags":["Customer/Credit Card"],"parameters":[{"name":"version","in":"header","description":"Version Number","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"Company ID, obtained through environment variables","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"Random Tracking Code UUID","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"Login Token","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"Language","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"phone":{"type":"string","title":"Phone Number"},"phoneArea":{"type":"string","title":"Phone area code"},"smsVerifyCode":{"type":"string","title":"Mobile Verification Code"},"smsSendToken":{"type":"string","title":"Send ticket"}},"required":["phone","phoneArea","smsVerifyCode","smsSendToken"]}}}},"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, verify token information, next step information required, valid for 7 days","properties":{}},"ok":{"type":"boolean"},"fail":{"type":"boolean"}}}}},"headers":{}}}}}}} ``` ## Retrieve password > version=0.0.1\ > bizType=customer.app.CustomerWebApiService.retrieveLoginPwd\ > Accessible to guests ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Credit Card"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerWebApiService.retrieveLoginPwd":{"post":{"summary":"Retrieve password","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerWebApiService.retrieveLoginPwd\nAccessible to guests","tags":["Customer/Credit Card"],"parameters":[{"name":"version","in":"header","description":"Version Number","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"Company ID, obtained through environment variables","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"Random Tracking Code UUID","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"Language","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"newPwd":{"type":"string","title":"New password, MD5 encryption","minLength":6,"maxLength":50},"validToken":{"type":"string","title":"Verify the Token","description":"Generate token in the previous step"}},"required":["newPwd","validToken"]}}}},"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, verify token information, next step information required","properties":{}},"ok":{"type":"boolean"},"fail":{"type":"boolean"}}}}},"headers":{}}}}}}} ``` ## Set password for the first time > version=0.0.1\ > bizType=customer.app.CustomerWebApiService.firstSetLoginPwd\ > Guests can access, automatically log in after successful setting ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Credit Card"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerWebApiService.firstSetLoginPwd":{"post":{"summary":"Set password for the first time","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerWebApiService.firstSetLoginPwd\nGuests can access, automatically log in after successful setting","tags":["Customer/Credit Card"],"parameters":[{"name":"version","in":"header","description":"Version Number","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"Company ID, obtained through environment variables","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"Random Tracking Code UUID","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"Login Token","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"Language","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"newPwd":{"type":"string","title":"New password, MD5 encryption","minLength":6,"maxLength":50},"device":{"type":"integer","title":"Login device","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"},"validToken":{"type":"string","title":"Verify the Token","description":"Generate token in the previous step"}},"required":["newPwd","device"]}}}},"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"},"country":{"type":"string","description":"Country"},"thirdServerCode":{"type":"string","description":"Unique identifier from third-party system"},"source":{"type":"string","description":"Source, i.e.: login device"},"relationCustomerId":{"type":"integer","format":"int64","description":"Associated account id"},"companyType":{"type":"string","description":"Company type"},"associationCompanyId":{"type":"integer","format":"int64","description":"Associated company Id"},"token":{"type":"string","description":"Authentication token"}}},"ok":{"type":"boolean"},"fail":{"type":"boolean"}}}}},"headers":{}}}}}}} ``` # Message ## Send verification code > 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 ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Message"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/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\n\nversion=0.0.1\nbizType=message.app.VerificationApiService.verifyCodeSend\n\n\nEnable CAPTCHA\nversion=0.0.2\nbizType=message.app.VerificationApiService.verifyCodeSend","tags":["Message"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"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"}}}}},"headers":{}}}}}}} ``` ## Verify verification code > Description: Verify verification code\ > \ > version=0.0.1\ > bizType=message.app.VerificationApiService.verifyCodeCheck ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Message"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/message.app.VerificationApiService.verifyCodeCheck":{"post":{"summary":"Verify verification code","deprecated":false,"description":"Description: Verify verification code\n\nversion=0.0.1\nbizType=message.app.VerificationApiService.verifyCodeCheck","tags":["Message"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"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"}}}}},"headers":{}}}}}}} ``` ## Station message type > Explanation: Get the list of station message types under the specified company\ > \ > version=0.0.1\ > bizType=message.app.PlatFormMessageTempApiService.getPlatformTempParentTypeList ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Message"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/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\n\nversion=0.0.1\nbizType=message.app.PlatFormMessageTempApiService.getPlatformTempParentTypeList","tags":["Message"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"companyId":{"type":"integer","format":"long","title":"Company Id"}},"required":["companyId"]}}}},"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":{}}}}}}} ``` ## Internal message list > Explanation: Get the message list of the specified company\ > \ > version=0.0.1\ > bizType=message.app.PlatFormMessageLogApiService.queryPlatFormMessageLogList ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Message"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/message.app.PlatFormMessageLogApiService.queryPlatFormMessageLogList":{"post":{"summary":"Internal message list","deprecated":false,"description":"Explanation: Get the message list of the specified company\n\nversion=0.0.1\nbizType=message.app.PlatFormMessageLogApiService.queryPlatFormMessageLogList","tags":["Message"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"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":{}}}}}}} ``` ## Paging query station message records > Explanation: Paging query channel message template list\ > \ > version=0.0.1\ > bizType=message.app.PlatFormMessageLogApiService.queryPlatFormMessageLogByPage ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Message"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/message.app.PlatFormMessageLogApiService.queryPlatFormMessageLogByPage":{"post":{"summary":"Paging query station message records","deprecated":false,"description":"Explanation: Paging query channel message template list\n\nversion=0.0.1\nbizType=message.app.PlatFormMessageLogApiService.queryPlatFormMessageLogByPage","tags":["Message"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"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":{}}}}}}} ``` ## Announcement list > Explanation: Query announcement list\ > \ > version=0.0.1\ > bizType=message.app.CompanyNoticeApiService.customerViewNoticePage ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Message"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/message.app.CompanyNoticeApiService.customerViewNoticePage":{"post":{"summary":"Announcement list","deprecated":false,"description":"Explanation: Query announcement list\n\nversion=0.0.1\nbizType=message.app.CompanyNoticeApiService.customerViewNoticePage","tags":["Message"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"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":{}}}}}}} ``` ## Message list > Explanation: Customers view message list\ > \ > version=0.0.1\ > bizType=message.app.CompanyNoticeApiService.customerViewMsgPage ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Message"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/message.app.CompanyNoticeApiService.customerViewMsgPage":{"post":{"summary":"Message list","deprecated":false,"description":"Explanation: Customers view message list\n\nversion=0.0.1\nbizType=message.app.CompanyNoticeApiService.customerViewMsgPage","tags":["Message"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"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":{}}}}}}} ``` ## Read message > Explanation: Customer reads message\ > \ > version=0.0.1\ > bizType=message.app.CompanyNoticeApiService.msgRead ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Message"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/message.app.CompanyNoticeApiService.msgRead":{"post":{"summary":"Read message","deprecated":false,"description":"Explanation: Customer reads message\n\nversion=0.0.1\nbizType=message.app.CompanyNoticeApiService.msgRead","tags":["Message"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"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":{}}}}}}} ``` ## All messages read > Explanation: All customer messages have been read\ > \ > version=0.0.1\ > bizType=message.app.CompanyNoticeApiService.msgAllRead ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Message"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/message.app.CompanyNoticeApiService.msgAllRead":{"post":{"summary":"All messages read","deprecated":false,"description":"Explanation: All customer messages have been read\n\nversion=0.0.1\nbizType=message.app.CompanyNoticeApiService.msgAllRead","tags":["Message"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"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":{}}}}}}} ``` ## Unipush account binding > Explanation: Unipush account binding clientId bizType=messagepush.app.OfflinePushService.clientIdBindCustomer ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Message"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/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,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"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":{}}}}}}} ``` ## Send Contact Us Email Message > Explanation: Send Contact Us Information\ > \ > version=0.0.1\ > bizType=message.app.CompanyNoticeApiService.sendContactUsMsg ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Message"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/message.app.CompanyNoticeApiService.sendContactUsMsg":{"post":{"summary":"Send Contact Us Email Message","deprecated":false,"description":"Explanation: Send Contact Us Information\n\nversion=0.0.1\nbizType=message.app.CompanyNoticeApiService.sendContactUsMsg","tags":["Message"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"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":{}}}}}}} ``` ## get Msg Token > 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. ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Message"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/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,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"Trace","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"language","required":false,"schema":{"type":"string"}},{"name":"recvWindow","in":"header","description":"Time window","required":false,"schema":{"type":"string"}},{"name":"apiKey","in":"header","description":"apiKey","required":false,"schema":{"type":"string"}},{"name":"signature","in":"header","description":"signature","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"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"]}}},"headers":{}}}}}}} ``` # Funds/Deposit ## Apply for Binding Direct Recharge Payment Wallet Address > bizType=fund.app.DepositAppDubboService.applyRechargeBindAddress\ > Apply for Binding Direct Recharge Payment Wallet Address\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Funds/Deposit"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.DepositAppDubboService.applyRechargeBindAddress":{"post":{"summary":"Apply for Binding Direct Recharge Payment Wallet Address","deprecated":false,"description":"bizType=fund.app.DepositAppDubboService.applyRechargeBindAddress\nApply for Binding Direct Recharge Payment Wallet Address\nAccessible after login","operationId":"applyRechargeBindAddress","tags":["Funds/Deposit"],"parameters":[{"name":"version","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerRechargeWalletAddrReqDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultCustomerRechargeWalletAddrRespDto"}}},"headers":{}}}}}},"components":{"schemas":{"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"}}},"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"}}}}}} ``` ## Mark the exchange rate for opening card fee deposit > bizType=fund.app.DepositAppDubboService.markOpenCardDepositRate\ > Mark the exchange rate for opening card fee deposit\ > Login required to access ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Funds/Deposit"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.DepositAppDubboService.markOpenCardDepositRate":{"post":{"summary":"Mark the exchange rate for opening card fee deposit","deprecated":false,"description":"bizType=fund.app.DepositAppDubboService.markOpenCardDepositRate\nMark the exchange rate for opening card fee deposit\nLogin 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"]}}}},"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":{}}}}}}} ``` ## Prepayment order information > 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 ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Funds/Deposit"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.DepositAppDubboService.prePaymentOrder":{"post":{"summary":"Prepayment order information","deprecated":false,"description":"bizType=fund.app.DepositAppDubboService.prePaymentOrder\nversion=0.0.1\nPrepayment 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.\nAccess 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"]}}}},"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":{}}}}}}} ``` ## Transfer of assets and funds between different gameplay with the same currency > bizType=fund.app.DepositAppDubboService.capitalTransfer Transfer of funds between different gameplay with the same assets Access after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Funds/Deposit"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/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,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapitalTransferReqDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultAmountTransferVo"}}},"headers":{}}}}}},"components":{"schemas":{"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"}}},"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"]}}}} ``` ## Transfer assets and funds from the proxy client to the client being represented > bizType=fund.app.DepositAppDubboService.capitalTransferForAgent\ > Transfer of the same assets and funds between different gameplay\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Funds/Deposit"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/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\nTransfer of the same assets and funds between different gameplay\nAccessible after login","operationId":"capitalTransfer","tags":["Funds/Deposit"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultAmountTransferVo"}}},"headers":{}}}}}},"components":{"schemas":{"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"]}}}} ``` ## Query Fund Transfer Records > bizType=fund.app.DepositAppDubboService.capitalTransferRecord\ > Query capital transfer records\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Funds/Deposit"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.DepositAppDubboService.capitalTransferRecord":{"post":{"summary":"Query Fund Transfer Records","deprecated":false,"description":"bizType=fund.app.DepositAppDubboService.capitalTransferRecord\nQuery capital transfer records\nAccessible after login","operationId":"capitalTransferRecord","tags":["Funds/Deposit"],"parameters":[{"name":"version","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapitalTransferRecordDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultCapitalTransferRecordResDto"}}},"headers":{}}}}}},"components":{"schemas":{"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"}}},"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"]}}}} ``` ## Asset fund transfer > bizType=fund.app.DepositAppDubboService.capitalTransferSupportDiffCurr\ > Asset fund transfer\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Funds/Deposit"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.DepositAppDubboService.capitalTransferSupportDiffCurr":{"post":{"summary":"Asset fund transfer","deprecated":false,"description":"bizType=fund.app.DepositAppDubboService.capitalTransferSupportDiffCurr\nAsset fund transfer\nAccessible after login","operationId":"capitalTransferSupportDiffCurr","tags":["Funds/Deposit"],"parameters":[{"name":"version","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapitalTransferDiffCurrReqDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultAmountTransferVo"}}},"headers":{}}}}}},"components":{"schemas":{"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"}}},"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"]}}}} ``` ## Create Deposit Proposal > bizType=fund.app.DepositAppDubboService.createDepositProposal\ > Create Deposit Proposal\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Funds/Deposit"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.DepositAppDubboService.createDepositProposal":{"post":{"summary":"Create Deposit Proposal","deprecated":false,"description":"bizType=fund.app.DepositAppDubboService.createDepositProposal\nCreate Deposit Proposal\nAccessible after login","operationId":"createDepositProposal","tags":["Funds/Deposit"],"parameters":[{"name":"version","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCustomerDepositReqDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultCreateCustomerDepositRespDto"}}},"headers":{}}}}}},"components":{"schemas":{"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"}}},"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"}}}}}} ``` ## Query direct recharge payment wallet address > bizType=fund.app.DepositAppDubboService.getBindRechargeAddress\ > Query direct recharge payment wallet address\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Funds/Deposit"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.DepositAppDubboService.getBindRechargeAddress":{"post":{"summary":"Query direct recharge payment wallet address","deprecated":false,"description":"bizType=fund.app.DepositAppDubboService.getBindRechargeAddress\nQuery direct recharge payment wallet address\nAccessible after login","operationId":"getBindRechargeAddress","tags":["Funds/Deposit"],"parameters":[{"name":"version","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerRechargeWalletAddrReqDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultCustomerRechargeWalletAddrRespDto"}}},"headers":{}}}}}},"components":{"schemas":{"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"}}},"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"}}}}}} ``` ## Get direct top-up payment channel supported currency information > bizType=fund.app.DepositAppDubboService.getDepositCoinList\ > Get direct top-up payment channel supported currency information\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Funds/Deposit"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.DepositAppDubboService.getCryptoBlockchainInfo":{"post":{"summary":"Get direct top-up payment channel supported currency information","deprecated":false,"description":"bizType=fund.app.DepositAppDubboService.getDepositCoinList\nGet direct top-up payment channel supported currency information\nAccessible after login","operationId":"getCryptoBlockchainInfo","tags":["Funds/Deposit"],"parameters":[{"name":"version","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CryptoBlockchainReqDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultCryptoBlockchainRespDto"}}},"headers":{}}}}}},"components":{"schemas":{"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"}}},"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"}}}}}}} ``` ## Get the list of account currency information supported by the payment channel > bizType=fund.app.DepositAppDubboService.getDepositAccountCurrencyList\ > Get the list of account currency information supported by the payment channel\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Funds/Deposit"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/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\nGet the list of account currency information supported by the payment channel\nAccessible after login","operationId":"getDepositAccountCurrencyList","tags":["Funds/Deposit"],"parameters":[{"name":"version","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryDepositAccountCurrencyListDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultSetDepositAccountCurrencyRespDto"}}},"headers":{}}}}}},"components":{"schemas":{"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"}}},"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"}}}}}} ``` ## Query the supported recharge account currency and chain information for payment channels > bizType=fund.app.DepositAppDubboService.getDepositAccountCurrencyListV2\ > Query the supported recharge account currency and chain information for payment channels\ > Access after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Funds/Deposit"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/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\nQuery the supported recharge account currency and chain information for payment channels\nAccess after login","operationId":"getDepositAccountCurrencyListV2","tags":["Funds/Deposit"],"parameters":[{"name":"version","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryDepositAccountCurrencyListV2Dto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultListDepositAccountCurrencyRespV2Dto"}}},"headers":{}}}}}},"components":{"schemas":{"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"}}},"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"}}}}}}} ``` ## Get a list of deposit currencies supported by customers > bizType=fund.app.DepositAppDubboService.getDepositCoinList\ > Get a list of deposit currencies supported by customers\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Funds/Deposit"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.DepositAppDubboService.getDepositCoinList":{"post":{"summary":"Get a list of deposit currencies supported by customers","deprecated":false,"description":"bizType=fund.app.DepositAppDubboService.getDepositCoinList\nGet a list of deposit currencies supported by customers\nAccessible after login","operationId":"getDepositCoinList","tags":["Funds/Deposit"],"parameters":[{"name":"version","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryDepositCoinListDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultSetString"}}},"headers":{}}}}}},"components":{"schemas":{"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"}}},"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"}}}}}} ``` ## Get deposit currency exchange rate > bizType=fund.app.DepositAppDubboService.getDepositExchangeRate\ > Get deposit currency exchange rate\ > Access after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Funds/Deposit"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.DepositAppDubboService.getDepositExchangeRate":{"post":{"summary":"Get deposit currency exchange rate","deprecated":false,"description":"bizType=fund.app.DepositAppDubboService.getDepositExchangeRate\nGet deposit currency exchange rate\nAccess after login","operationId":"getDepositExchangeRate","tags":["Funds/Deposit"],"parameters":[{"name":"version","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCustomerDepositExchangeRateDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultQueryCustomerDepositExchangeRateDto"}}},"headers":{}}}}}},"components":{"schemas":{"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"}}},"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"]}}}} ``` ## Get payment channel information > 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 ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Funds/Deposit"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.DepositAppDubboService.getPayChannels":{"post":{"summary":"Get payment channel information","deprecated":false,"description":"bizType=fund.app.DepositAppDubboService.getPayChannels\nGet payment channel information\nWhen version=0.0.1, accountCurrency and rechargeType will be used as query filter conditions in the request parameters\nWhen version=0.0.2, accountCurrency will be used as query filter conditions in the request parameters\nLogin required to access","operationId":"getPayChannels","tags":["Funds/Deposit"],"parameters":[{"name":"version","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCustomerPaymentChannelReqDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultListQueryCustomerPaymentChannelRespDto"}}},"headers":{}}}}}},"components":{"schemas":{"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"}}},"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"}}}}}} ``` ## Get payment channel information without filtering account currency and recharge method > 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 ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Funds/Deposit"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/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,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCustomerPaymentChannelReqV2Dto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultListQueryCustomerPaymentChannelRespDto"}}},"headers":{}}}}}},"components":{"schemas":{"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"}}},"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"}}}}}} ``` ## Get payment channel information filtering account currency and chain name > bizType=fund.app.DepositAppDubboService.getPayChannelsV3\ > Get payment channel information filtering account currency and chain name\ > Access after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Funds/Deposit"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/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\nGet payment channel information filtering account currency and chain name\nAccess after login","operationId":"getPayChannelsV3","tags":["Funds/Deposit"],"parameters":[{"name":"version","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCustomerPaymentChannelReqV3Dto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultListQueryCustomerPaymentChannelRespV3Dto"}}},"headers":{}}}}}},"components":{"schemas":{"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"}}},"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"}}}}}} ``` ## Query encrypted cryptocurrency payment status > bizType=fund.app.DepositAppDubboService.getPayStatus\ > Query encrypted cryptocurrency payment status\ > Access after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Funds/Deposit"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.DepositAppDubboService.getPayStatus":{"post":{"summary":"Query encrypted cryptocurrency payment status","deprecated":false,"description":"bizType=fund.app.DepositAppDubboService.getPayStatus\nQuery encrypted cryptocurrency payment status\nAccess after login","operationId":"getPayStatus","tags":["Funds/Deposit"],"parameters":[{"name":"version","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCoinPayStatusReqDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultQueryCoinPayStatusRespDto"}}},"headers":{}}}}}},"components":{"schemas":{"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"}}},"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"}}}}}} ``` ## Determine whether the user has deposited > bizType=fund.app.DepositAppDubboService.judgeIsAlreadyDeposit\ > Determine whether the user has deposited\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Funds/Deposit"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.DepositAppDubboService.judgeIsAlreadyDeposit":{"post":{"summary":"Determine whether the user has deposited","deprecated":false,"description":"bizType=fund.app.DepositAppDubboService.judgeIsAlreadyDeposit\nDetermine whether the user has deposited\nAccessible after login","operationId":"judgeIsAlreadyDeposit","tags":["Funds/Deposit"],"parameters":[{"name":"version","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultBoolean"}}},"headers":{}}}}}},"components":{"schemas":{"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"}}}}}} ``` ## Manual loan > bizType=fund.app.DepositAppDubboService.manualLoan\ > Manual loan\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Funds/Deposit"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.DepositAppDubboService.manualLoan":{"post":{"summary":"Manual loan","deprecated":false,"description":"bizType=fund.app.DepositAppDubboService.manualLoan\nManual loan\nAccessible after login","operationId":"manualLoan","tags":["Funds/Deposit"],"parameters":[{"name":"version","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManualLoanDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResult1"}}},"headers":{}}}}}},"components":{"schemas":{"ManualLoanDto":{"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"}}},"BaseResult1":{"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"}}}}}} ``` ## Manual Repayment > bizType=fund.app.DepositAppDubboService.manualRepayment\ > Manual Repayment\ > Access after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Funds/Deposit"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.DepositAppDubboService.manualRepayment":{"post":{"summary":"Manual Repayment","deprecated":false,"description":"bizType=fund.app.DepositAppDubboService.manualRepayment\nManual Repayment\nAccess after login","operationId":"manualRepayment","tags":["Funds/Deposit"],"parameters":[{"name":"version","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManualRepaymentDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResult1"}}},"headers":{}}}}}},"components":{"schemas":{"ManualRepaymentDto":{"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"}}},"BaseResult1":{"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"}}}}}} ``` ## Query Deposit Proposal > bizType=fund.app.DepositAppDubboService.queryDepositProposal\ > Query Deposit Proposal\ > Access after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Funds/Deposit"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.DepositAppDubboService/queryDepositProposal":{"post":{"summary":"Query Deposit Proposal","deprecated":false,"description":"bizType=fund.app.DepositAppDubboService.queryDepositProposal\nQuery Deposit Proposal\nAccess after login","operationId":"queryDepositProposal","tags":["Funds/Deposit"],"parameters":[{"name":"version","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCustomerDepositProposalReqDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultCustomerDepositProposalDto"}}},"headers":{}}}}}},"components":{"schemas":{"QueryCustomerDepositProposalReqDto":{"type":"object","required":["tradeType"],"properties":{"tradeType":{"type":"integer","format":"int64","description":"Game type"},"proposalNo":{"type":"string","description":"Proposal number"}}},"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":"#/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"}}}}}} ``` ## Query payment types for third-party payment channels > bizType=fund.app.DepositAppDubboService.queryPayChannelType\ > Query payment types for third-party payment channels\ > Access after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Funds/Deposit"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.DepositAppDubboService.queryPayChannelType":{"post":{"summary":"Query payment types for third-party payment channels","deprecated":false,"description":"bizType=fund.app.DepositAppDubboService.queryPayChannelType\nQuery payment types for third-party payment channels\nAccess after login","operationId":"queryPayChannelType","tags":["Funds/Deposit"],"parameters":[{"name":"version","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPayChannelTypeDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultListFundPayChannelTypeDto"}}},"headers":{}}}}}},"components":{"schemas":{"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"]},"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"}}}}}} ``` # Funds/Proposal ## Check if the customer has any unfinished proposals > bizType=fund.app.CustomerProposalQueryService.isHaveUnCompleteProposal\ > Check if the customer has any unfinished proposals\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Funds/Proposal"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.CustomerProposalQueryService.isHaveUnCompleteProposal":{"post":{"summary":"Check if the customer has any unfinished proposals","deprecated":false,"description":"bizType=fund.app.CustomerProposalQueryService.isHaveUnCompleteProposal\nCheck if the customer has any unfinished proposals\nAccessible after login","operationId":"isHaveUnCompleteProposal","tags":["Funds/Proposal"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FundBaseDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultBoolean"}}},"headers":{}}}}}},"components":{"schemas":{"FundBaseDto":{"type":"object","properties":{}},"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"}}}}}} ``` ## Query customer credit adjustment proposal pagination data > bizType=fund.app.CustomerProposalQueryService.queryDepositAdjustPageList\ > Query customer credit adjustment proposal page data\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Funds/Proposal"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.CustomerProposalQueryService.queryDepositAdjustPageList":{"post":{"summary":"Query customer credit adjustment proposal pagination data","deprecated":false,"description":"bizType=fund.app.CustomerProposalQueryService.queryDepositAdjustPageList\nQuery customer credit adjustment proposal page data\nAccessible after login","operationId":"queryDepositAdjustPageList","tags":["Funds/Proposal"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryProposalPageReqDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultBasePageVoCustomerAdjustProposalDto"}}},"headers":{}}}}}},"components":{"schemas":{"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":"#/components/schemas/FieldOrderDto"}},"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"}}},"FieldOrderDto":{"type":"object","properties":{"column":{"type":"string","description":"Sorting Field Column"},"asc":{"type":"boolean","description":"Order Method"}}},"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"}}}}}} ``` ## Query customer deposit proposal pagination data > bizType=fund.app.CustomerProposalQueryService.queryDepositPageList\ > Query customer withdrawal proposal pagination data\ > Access after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Funds/Proposal"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.CustomerProposalQueryService.queryDepositPageList":{"post":{"summary":"Query customer deposit proposal pagination data","deprecated":false,"description":"bizType=fund.app.CustomerProposalQueryService.queryDepositPageList\nQuery customer withdrawal proposal pagination data\nAccess after login","operationId":"queryDepositPageList","tags":["Funds/Proposal"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryDepositProposalPageReqDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultBasePageVoCustomerDepositProposalDto"}}},"headers":{}}}}}},"components":{"schemas":{"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":"#/components/schemas/FieldOrderDto"}},"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"}}},"FieldOrderDto":{"type":"object","properties":{"column":{"type":"string","description":"Sorting Field Column"},"asc":{"type":"boolean","description":"Order Method"}}},"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":"#/components/schemas/CustomerDepositProposalDto"}},"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"}}},"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"}}}}}} ``` ## Query customer withdrawal proposal pagination data > bizType=fund.app.CustomerProposalQueryService.queryWithdrawPageList\ > Query customer withdrawal proposal pagination data\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Funds/Proposal"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.CustomerProposalQueryService.queryWithdrawPageList":{"post":{"summary":"Query customer withdrawal proposal pagination data","deprecated":false,"description":"bizType=fund.app.CustomerProposalQueryService.queryWithdrawPageList\nQuery customer withdrawal proposal pagination data\nAccessible after login","operationId":"queryWithdrawPageList","tags":["Funds/Proposal"],"parameters":[{"name":"version","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryWithdrawProposalPageReqDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultBasePageVoCustomerWithdrawProposalDto"}}},"headers":{}}}}}},"components":{"schemas":{"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":"#/components/schemas/FieldOrderDto"}},"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"}}},"FieldOrderDto":{"type":"object","properties":{"column":{"type":"string","description":"Sorting Field Column"},"asc":{"type":"boolean","description":"Order Method"}}},"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":"#/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"}}}}}} ``` # Funds/Rate ## Batch query deposit and withdrawal exchange rates for currency pairs > bizType=fund.app.FundExchangeRateQueryService.getExchangeRateList\ > Batch query deposit and withdrawal exchange rates for currency pairs\ > Accessible to visitors\ > version: 0.0.1 ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Funds/Rate"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/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\nBatch query deposit and withdrawal exchange rates for currency pairs\nAccessible to visitors\nversion: 0.0.1","operationId":"getExchangeRateList","tags":["Funds/Rate"],"parameters":[{"name":"version","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FundExchangeRateBatchQueryDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultListExchangeRateConvertDto"}}},"headers":{}}}}}},"components":{"schemas":{"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"}}},"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":"#/components/schemas/ExchangeRateConvertDto"}},"ok":{"type":"boolean"},"fail":{"type":"boolean"}}},"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"}}}}}} ``` ## Query the Trading Exchange Rate of Currency Pairs > bizType=fund.app.FundExchangeRateQueryService.getTradeExchangeRate\ > Query the Trading Exchange Rate of Currency Pairs\ > version: 0.0.1 ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Funds/Rate"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.FundExchangeRateQueryService.getTradeExchangeRate":{"post":{"summary":"Query the Trading Exchange Rate of Currency Pairs","deprecated":false,"description":"bizType=fund.app.FundExchangeRateQueryService.getTradeExchangeRate\nQuery the Trading Exchange Rate of Currency Pairs\nversion: 0.0.1","operationId":"getExchangeRateList","tags":["Funds/Rate"],"parameters":[{"name":"version","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"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"]}}}},"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":"#/components/schemas/ExchangeRateConvertDto"},"ok":{"type":"string"},"fail":{"type":"string"}}}}},"headers":{}}}}}},"components":{"schemas":{"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"}}}}}} ``` # Funds/Withdrawal ## Get withdrawal fee > bizType=fund.app.WithdrawAppDubboService.computeWithdrawFee\ > Get withdrawal (cash withdrawal/coin withdrawal) fee\ > Login required to access ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Funds/Withdrawal"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.WithdrawAppDubboService.computeWithdrawFee":{"post":{"summary":"Get withdrawal fee","deprecated":false,"description":"bizType=fund.app.WithdrawAppDubboService.computeWithdrawFee\nGet withdrawal (cash withdrawal/coin withdrawal) fee\nLogin required to access","operationId":"computeWithdrawFee","tags":["Funds/Withdrawal"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputeWithdrawReqDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultComputeWithdrawFeeRespDto"}}},"headers":{}}}}}},"components":{"schemas":{"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"}}},"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)"}}}}}} ``` ## Get withdrawal currency exchange rate > bizType=fund.app.WithdrawAppDubboService.getWithdrawExchangeRate\ > Get withdrawal currency exchange rate\ > Access after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Funds/Withdrawal"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.WithdrawAppDubboService.getWithdrawExchangeRate":{"post":{"summary":"Get withdrawal currency exchange rate","deprecated":false,"description":"bizType=fund.app.WithdrawAppDubboService.getWithdrawExchangeRate\nGet withdrawal currency exchange rate\nAccess after login","operationId":"getWithdrawExchangeRate","tags":["Funds/Withdrawal"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCustomerWithdrawExchangeRateDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultQueryCustomerWithdrawExchangeRateDto"}}},"headers":{}}}}}},"components":{"schemas":{"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"}}},"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":"#/components/schemas/QueryCustomerWithdrawExchangeRateDto"},"ok":{"type":"boolean"},"fail":{"type":"boolean"}}}}}} ``` ## Create withdrawal proposal > bizType=fund.app.WithdrawAppDubboService.createWithdrawProposal\ > Create withdrawal (cash withdrawal/coin withdrawal) proposal\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Funds/Withdrawal"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.WithdrawAppDubboService.createWithdrawProposal":{"post":{"summary":"Create withdrawal proposal","deprecated":false,"description":"bizType=fund.app.WithdrawAppDubboService.createWithdrawProposal\nCreate withdrawal (cash withdrawal/coin withdrawal) proposal\nAccessible after login","operationId":"createWithdrawProposal","tags":["Funds/Withdrawal"],"parameters":[{"name":"version","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"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"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultCustomerWithdrawProposalDto"}}},"headers":{}}}}}},"components":{"schemas":{"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":"#/components/schemas/CustomerWithdrawProposalDto"},"ok":{"type":"boolean"},"fail":{"type":"boolean"}}},"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"}}}}}} ``` ## Get the total amount of opening margin/deposit ratio > bizType=fund.app.WithdrawAppDubboService.getAccountMarginRate\ > Get the total amount of opening margin/deposit ratio\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Funds/Withdrawal"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.WithdrawAppDubboService.getAccountMarginRate":{"post":{"summary":"Get the total amount of opening margin/deposit ratio","deprecated":false,"description":"bizType=fund.app.WithdrawAppDubboService.getAccountMarginRate\nGet the total amount of opening margin/deposit ratio\nAccessible after login","operationId":"getAccountMarginRate","tags":["Funds/Withdrawal"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputeWithdrawReqDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultString"}}},"headers":{}}}}}},"components":{"schemas":{"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"}}},"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"}}}}}} ``` ## Get all withdrawal currency lists > bizType=fund.app.WithdrawAppDubboService.getAllWithdrawCurrencyList\ > Get all withdrawal currency lists\ > Access after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Funds/Withdrawal"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.WithdrawAppDubboService.getAllWithdrawCurrencyList":{"post":{"summary":"Get all withdrawal currency lists","deprecated":false,"description":"bizType=fund.app.WithdrawAppDubboService.getAllWithdrawCurrencyList\nGet all withdrawal currency lists\nAccess after login","operationId":"getAllWithdrawCurrencyList","tags":["Funds/Withdrawal"],"parameters":[{"name":"version","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WithdrawMethodQueryDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultListCustomerGroupWithdrawCurrencyConfigDto"}}},"headers":{}}}}}},"components":{"schemas":{"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"}}},"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"}}}}}} ``` ## Obtain list of client wallet withdrawal currency chain addresses > bizType=fund.app.WithdrawAppDubboService.getCoinWithdrawCurrencyList\ > Obtain list of client wallet withdrawal currency chain addresses\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Funds/Withdrawal"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.WithdrawAppDubboService.getCoinWithdrawCurrencyList":{"post":{"summary":"Obtain list of client wallet withdrawal currency chain addresses","deprecated":false,"description":"bizType=fund.app.WithdrawAppDubboService.getCoinWithdrawCurrencyList\nObtain list of client wallet withdrawal currency chain addresses\nAccessible after login","operationId":"getCoinWithdrawCurrencyList","tags":["Funds/Withdrawal"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WithdrawMethodQueryDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultListCustomerGroupWithdrawCurrencyConfigDto"}}},"headers":{}}}}}},"components":{"schemas":{"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"}}},"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"}}}}}} ``` ## Get withdrawal account currency list > bizType=fund.app.WithdrawAppDubboService.getWithdrawAccountCurrencyList\ > Get withdrawal account currency list\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Funds/Withdrawal"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.WithdrawAppDubboService.getWithdrawAccountCurrencyList":{"post":{"summary":"Get withdrawal account currency list","deprecated":false,"description":"bizType=fund.app.WithdrawAppDubboService.getWithdrawAccountCurrencyList\nGet withdrawal account currency list\nAccessible after login","operationId":"getWithdrawAccountCurrencyList","tags":["Funds/Withdrawal"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WithdrawCurrencyListReqDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultSetString"}}},"headers":{}}}}}},"components":{"schemas":{"WithdrawCurrencyListReqDto":{"type":"object","required":["tradeType"],"properties":{"tradeType":{"type":"integer","format":"int64"},"customerGroupId":{"type":"integer","format":"int64"},"country":{"type":"string","description":"Country Code"}}},"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"}}}}}} ``` ## Get withdrawal amount limit information > bizType=fund.app.WithdrawAppDubboService.getWithdrawAmountLimitInfo\ > Get withdrawal amount limit information\ > Result after exchange rate conversion\ > Access after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Funds/Withdrawal"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.WithdrawAppDubboService.getWithdrawAmountLimitInfo":{"post":{"summary":"Get withdrawal amount limit information","deprecated":false,"description":"bizType=fund.app.WithdrawAppDubboService.getWithdrawAmountLimitInfo\nGet withdrawal amount limit information\nResult after exchange rate conversion\nAccess after login","operationId":"getWithdrawAmountLimitInfo","tags":["Funds/Withdrawal"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WithdrawAmountLimitReqDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultWithdrawAmountLimitRespDto"}}},"headers":{}}}}}},"components":{"schemas":{"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"}}},"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"}}}}}} ``` ## Get withdrawal currency list > bizType=fund.app.WithdrawAppDubboService.getWithdrawCurrencyList\ > Get withdrawal currency list\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Funds/Withdrawal"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.WithdrawAppDubboService.getWithdrawCurrencyList":{"post":{"summary":"Get withdrawal currency list","deprecated":false,"description":"bizType=fund.app.WithdrawAppDubboService.getWithdrawCurrencyList\nGet withdrawal currency list\nAccessible after login","operationId":"getWithdrawCurrencyList","tags":["Funds/Withdrawal"],"parameters":[{"name":"version","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WithdrawMethodQueryDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultListCustomerGroupWithdrawCurrencyConfigDto"}}},"headers":{}}}}}},"components":{"schemas":{"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"}}},"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"}}}}}} ``` ## Get Withdrawal Method > bizType=fund.app.WithdrawAppDubboService.getWithdrawMethodList\ > Get Withdrawal Method\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Funds/Withdrawal"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.WithdrawAppDubboService.getWithdrawMethodList":{"post":{"summary":"Get Withdrawal Method","deprecated":false,"description":"bizType=fund.app.WithdrawAppDubboService.getWithdrawMethodList\nGet Withdrawal Method\nAccessible after login","operationId":"getWithdrawMethodList","tags":["Funds/Withdrawal"],"parameters":[{"name":"version","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WithdrawMethodQueryDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultListWithdrawMethodQueryDto"}}},"headers":{}}}}}},"components":{"schemas":{"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"}}},"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":"#/components/schemas/WithdrawMethodQueryDto"}},"ok":{"type":"boolean"},"fail":{"type":"boolean"}}}}}} ``` ## Get withdrawal times in 24 hours > bizType=fund.app.WithdrawAppDubboService.getWithdrawTimesIn24Hour\ > Get withdrawal method\ > Access after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Funds/Withdrawal"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.WithdrawAppDubboService.getWithdrawTimesIn24Hour":{"post":{"summary":"Get withdrawal times in 24 hours","deprecated":false,"description":"bizType=fund.app.WithdrawAppDubboService.getWithdrawTimesIn24Hour\nGet withdrawal method\nAccess after login","operationId":"getWithdrawTimesIn24Hour","tags":["Funds/Withdrawal"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputeWithdrawReqDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultInteger"}}},"headers":{}}}}}},"components":{"schemas":{"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"}}},"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"}}}}}} ``` ## Query the list of third-party payment withdrawal banks > bizType=fund.app.WithdrawAppDubboService.queryPayWithdrawBankList\ > Query third-party payment withdrawal bank list\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Funds/Withdrawal"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.WithdrawAppDubboService.queryPayWithdrawBankList":{"post":{"summary":"Query the list of third-party payment withdrawal banks","deprecated":false,"description":"bizType=fund.app.WithdrawAppDubboService.queryPayWithdrawBankList\nQuery third-party payment withdrawal bank list\nAccessible after login","operationId":"queryPayWithdrawBankList","tags":["Funds/Withdrawal"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryWithdrawBankReqDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultJSONArray"}}},"headers":{}}}}}},"components":{"schemas":{"QueryWithdrawBankReqDto":{"type":"object","properties":{"withdrawMethod":{"type":"string","description":"Withdrawal method"},"withdrawCurrency":{"type":"string","description":"Withdrawal currency"}}},"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"}}}}}} ``` ## Query withdrawal limit configuration > bizType=fund.app.WithdrawAppDubboService.queryWithdrawLimitConfig\ > Query withdrawal limit configuration\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Funds/Withdrawal"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.WithdrawAppDubboService.queryWithdrawLimitConfig":{"post":{"summary":"Query withdrawal limit configuration","deprecated":false,"description":"bizType=fund.app.WithdrawAppDubboService.queryWithdrawLimitConfig\nQuery withdrawal limit configuration\nAccessible after login","operationId":"queryWithdrawLimitConfig","tags":["Funds/Withdrawal"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryWithdrawLimitConfigReqDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultQueryWithdrawLimitConfigRespDto"}}},"headers":{}}}}}},"components":{"schemas":{"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"}}},"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?"}}},"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"}}},"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"}}},"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"}}},"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"}}}}}} ``` ## Query withdrawal currency and limit condition list > bizType=fund.app.WithdrawAppDubboService.withdrawCurrencyList\ > Query withdrawal currency list\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Funds/Withdrawal"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.WithdrawAppDubboService.withdrawCurrencyList":{"post":{"summary":"Query withdrawal currency and limit condition list","deprecated":false,"description":"bizType=fund.app.WithdrawAppDubboService.withdrawCurrencyList\nQuery withdrawal currency list\nAccessible after login","operationId":"withdrawCurrencyList","tags":["Funds/Withdrawal"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WithdrawCurrencyListReqDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultWithdrawCurrencyResDto"}}},"headers":{}}}}}},"components":{"schemas":{"WithdrawCurrencyListReqDto":{"type":"object","required":["tradeType"],"properties":{"tradeType":{"type":"integer","format":"int64"},"customerGroupId":{"type":"integer","format":"int64"},"country":{"type":"string","description":"Country Code"}}},"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"}}}}}} ``` ## Get customer group withdrawal methods > bizType=fund.app.WithdrawAppDubboService.getCustomerGroupWithdrawMethodList\ > Get customer group withdrawal methods\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Funds/Withdrawal"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.WithdrawAppDubboService.getCustomerGroupWithdrawMethodList":{"post":{"summary":"Get customer group withdrawal methods","deprecated":false,"description":"bizType=fund.app.WithdrawAppDubboService.getCustomerGroupWithdrawMethodList\nGet customer group withdrawal methods\nAccessible after login","operationId":"getWithdrawMethodList","tags":["Funds/Withdrawal"],"parameters":[{"name":"version","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultListWithdrawMethodQueryDto"}}},"headers":{}}}}}},"components":{"schemas":{"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":"#/components/schemas/WithdrawMethodQueryDto"}},"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"}}}}}} ``` ## Get customer group withdrawal risk control configuration > bizType=fund.app.WithdrawAppDubboService.queryCustomerGroupWithdrawRiskConfig\ > Get customer group withdrawal risk control configuration\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Funds/Withdrawal"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.WithdrawAppDubboService.queryCustomerGroupWithdrawRiskConfig":{"post":{"summary":"Get customer group withdrawal risk control configuration","deprecated":false,"description":"bizType=fund.app.WithdrawAppDubboService.queryCustomerGroupWithdrawRiskConfig\nGet customer group withdrawal risk control configuration\nAccessible after login","operationId":"getWithdrawMethodList","tags":["Funds/Withdrawal"],"parameters":[{"name":"version","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"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"]}}}},"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"}}}}},"headers":{}}}}}}} ``` ## Check customer's withdrawal limit conditions > 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 ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Funds/Withdrawal"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/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;\\\n2. 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. \nUSCUSTOMER_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,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"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"]}}}},"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":{}}}}}}} ``` ## Get the remaining withdrawal amount of the withdrawal method + currency + chain > bizType=fund.app.WithdrawAppDubboService.queryRemainWithdrawAmount\ > Get the remaining withdrawal amount of the withdrawal method + currency + chain\ > Access after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Funds/Withdrawal"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/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\nGet the remaining withdrawal amount of the withdrawal method + currency + chain\nAccess after login","operationId":"queryWithdrawLimitConfig","tags":["Funds/Withdrawal"],"parameters":[{"name":"version","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryRemainWithdrawAmountReqDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultQueryRemainWithdrawAmountRespDto"}}},"headers":{}}}}}},"components":{"schemas":{"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"}}},"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"}}}}}} ``` # Trade/Full Margin Contract ## Place an order > Description: Contract full position trading order group=tradeApi version=0.0.1 bizType=tradeapi.app.OrderApiService.addMarketOrder ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Trade/Full Margin Contract"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/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,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"group","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"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"}}}}},"headers":{}}}}}}} ``` ## Modify Pending Order > group=tradeApi\ > version=0.0.1\ > bizType=tradeapi.app.OrderApiService.updatePboOrder ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Trade/Full Margin Contract"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/tradeapi.app.OrderApiService.updatePboOrder":{"post":{"summary":"Modify Pending Order","deprecated":false,"description":"group=tradeApi\nversion=0.0.1\nbizType=tradeapi.app.OrderApiService.updatePboOrder","tags":["Trade/Full Margin Contract"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"group","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"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"}}}}},"headers":{}}}}}}} ``` ## Set position stop loss and take profit > Explanation: Set position stop loss and take profit group=tradeApi version=0.0.1 bizType=tradeapi.app.OrderApiService.updateOrder ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Trade/Full Margin Contract"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/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,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"group","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"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;"}}}}}}},"headers":{}}}}}}} ``` ## Closing record > Explanation: Query historical closing records\ > \ > \ > group=tradeApi\ > version=0.0.1\ > bizType=tradeapi.app.OrderApiService.queryHistoryCloseOrderList ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Trade/Full Margin Contract"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/tradeapi.app.CfdMMOrderApiService.queryHistoryCloseOrderList":{"post":{"summary":"Closing record","deprecated":false,"description":"Explanation: Query historical closing records\n\n\ngroup=tradeApi\nversion=0.0.1\nbizType=tradeapi.app.OrderApiService.queryHistoryCloseOrderList","tags":["Trade/Full Margin Contract"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"group","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"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"}}}}},"headers":{}}}}}}} ``` ## Set leverage multiplier > 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 ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Trade/Full Margin Contract"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/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\n\ngroup=tradeApi\nversion=0.0.1\nbizType=tradeapi.app.OrderApiService.setCrossLevelNum","tags":["Trade/Full Margin Contract"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"group","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"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"}}}}},"headers":{}}}}}}} ``` ## Order Trial Calculation > Explanation: Calculate margin and commission for placing orders group=tradeApi version=0.0.1 bizType=tradeapi.app.OrderApiService.calculateMarketOrder ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Trade/Full Margin Contract"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/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,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"group","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"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"}}}}},"headers":{}}}}}}} ``` ## Position Details > Description: Query position details\ > \ > group=tradeApi\ > version=0.0.1\ > bizType=tradeapi.app.PositionApiService.queryPositionDetail ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Trade/Full Margin Contract"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/tradeapi.app.CfdMMPositionApiService.queryPositionDetail":{"post":{"summary":"Position Details","deprecated":false,"description":"Description: Query position details\n\ngroup=tradeApi\nversion=0.0.1\nbizType=tradeapi.app.PositionApiService.queryPositionDetail","tags":["Trade/Full Margin Contract"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"group","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"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"}}}}},"headers":{}}}}}}} ``` ## Fund Flow > Explanation: Pagination query account capital flow group=tradeApi version=0.0.1 bizType=tradeapi.app.OrderApiService.queryCapitalFlowList ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Trade/Full Margin Contract"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/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,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"group","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"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"}}}}},"headers":{}}}}}}} ``` # Trade/Isolated Margin Contract ## Place an order > Explanation: Contract isolated trading order\ > \ > \ > group=tradeApi\ > version=0.0.1\ > bizType=tradeapi.app.OrderApiService.addMarketOrder ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Trade/Isolated Margin Contract"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/tradeapi.app.OrderApiService.addMarketOrder":{"post":{"summary":"Place an order","deprecated":false,"description":"Explanation: Contract isolated trading order\n\n\ngroup=tradeApi\nversion=0.0.1\nbizType=tradeapi.app.OrderApiService.addMarketOrder","tags":["Trade/Isolated Margin Contract"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"group","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"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"]}}}}},"headers":{}}}}}}} ``` ## Pending Order List > group=tradeApi\ > version=0.0.1\ > bizType=tradeapi.app.OrderApiService.queryPBOOrderPage ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Trade/Isolated Margin Contract"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/tradeapi.app.CfdWBWOrderApiService.queryPBOOrderPage":{"post":{"summary":"Pending Order List","deprecated":false,"description":"group=tradeApi\nversion=0.0.1\nbizType=tradeapi.app.OrderApiService.queryPBOOrderPage","tags":["Trade/Isolated Margin Contract"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"group","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"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"}}}}},"headers":{}}}}}}} ``` ## Set position stop loss and take profit > Explanation: Set position stop loss and take profit group=tradeApi version=0.0.1 bizType=tradeapi.app.OrderApiService.updateOrder ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Trade/Isolated Margin Contract"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/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,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"group","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"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":"*"}}}}},"headers":{}}}}}}} ``` ## Order details > Explanation: View order details group=tradeApi version=0.0.1 bizType=tradeapi.app.OrderApiService.queryOrderDetail ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Trade/Isolated Margin Contract"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/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,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"group","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"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":{}}}}}}} ``` ## Order list > Explanation: View order list\ > \ > \ > group=tradeApi\ > version=0.0.1\ > bizType=tradeapi.app.OrderApiService.queryOrderPage ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Trade/Isolated Margin Contract"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/tradeapi.app.OrderApiService.queryOrderPage":{"post":{"summary":"Order list","deprecated":false,"description":"Explanation: View order list\n\n\ngroup=tradeApi\nversion=0.0.1\nbizType=tradeapi.app.OrderApiService.queryOrderPage","tags":["Trade/Isolated Margin Contract"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"group","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"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"}}}}},"headers":{}}}}}}} ``` ## Closing record > Explanation: Query historical closing records\ > \ > \ > group=tradeApi\ > version=0.0.1\ > bizType=tradeapi.app.OrderApiService.queryHistoryCloseOrderList ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Trade/Isolated Margin Contract"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/tradeapi.app.CfdWBWOrderApiService.queryHistoryCloseOrderList":{"post":{"summary":"Closing record","deprecated":false,"description":"Explanation: Query historical closing records\n\n\ngroup=tradeApi\nversion=0.0.1\nbizType=tradeapi.app.OrderApiService.queryHistoryCloseOrderList","tags":["Trade/Isolated Margin Contract"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"group","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"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"}}}}},"headers":{}}}}}}} ``` ## Transaction records > Explanation: Query transaction record list\ > \ > \ > group=tradeApi\ > version=0.0.1\ > bizType=tradeapi.app.OrderApiService.queryTradeRecordPage ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Trade/Isolated Margin Contract"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/tradeapi.app.OrderApiService.queryTradeRecordPage":{"post":{"summary":"Transaction records","deprecated":false,"description":"Explanation: Query transaction record list\n\n\ngroup=tradeApi\nversion=0.0.1\nbizType=tradeapi.app.OrderApiService.queryTradeRecordPage","tags":["Trade/Isolated Margin Contract"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"group","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"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"}}}}},"headers":{}}}}}}} ``` ## Set position leverage multiplier > \`\`\`\ > group=tradeApi\ > version=0.0.1\ > bizType=tradeapi.app.PositionApiService.updateCrossLevelNum\ > \`\`\` ````json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Trade/Isolated Margin Contract"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/tradeapi.app.PositionApiService.updateCrossLevelNum":{"post":{"summary":"Set position leverage multiplier","deprecated":false,"description":"```\ngroup=tradeApi\nversion=0.0.1\nbizType=tradeapi.app.PositionApiService.updateCrossLevelNum\n```","tags":["Trade/Isolated Margin Contract"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"group","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"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"}}}}},"headers":{}}}}}}} ```` ## Modify position margin > 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 ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Trade/Isolated Margin Contract"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/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,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"group","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"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"}}}}},"headers":{}}}}}}} ``` ## Order Trial Calculation > Explanation: Calculate margin and commission for placing orders group=tradeApi version=0.0.1 bizType=tradeapi.app.OrderApiService.calculateMarketOrder ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Trade/Isolated Margin Contract"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/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,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"group","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"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"}}}}},"headers":{}}}}}}} ``` ## Calculate Liquidation Price > Explanation: Calculate Liquidation Price\ > \ > \ > group=tradeApi\ > version=0.0.1\ > bizType=tradeapi.app.OrderApiService.calculationBurstPrice ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Trade/Isolated Margin Contract"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/tradeapi.app.OrderApiService.calculationBurstPrice":{"post":{"summary":"Calculate Liquidation Price","deprecated":false,"description":"Explanation: Calculate Liquidation Price\n\n\ngroup=tradeApi\nversion=0.0.1\nbizType=tradeapi.app.OrderApiService.calculationBurstPrice","tags":["Trade/Isolated Margin Contract"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"group","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"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"}}}}},"headers":{}}}}}}} ``` ## Position Details > Description: Query position details\ > \ > group=tradeApi\ > version=0.0.1\ > bizType=tradeapi.app.PositionApiService.queryPositionDetail ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Trade/Isolated Margin Contract"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/tradeapi.app.PositionApiService.queryPositionDetail":{"post":{"summary":"Position Details","deprecated":false,"description":"Description: Query position details\n\ngroup=tradeApi\nversion=0.0.1\nbizType=tradeapi.app.PositionApiService.queryPositionDetail","tags":["Trade/Isolated Margin Contract"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"group","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"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"}}}}},"headers":{}}}}}}} ``` ## Position List > Description: Query position list\ > \ > group=tradeApi\ > version=0.0.1\ > bizType=tradeapi.app.PositionApiService.queryPositionPage ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Trade/Isolated Margin Contract"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/tradeapi.app.PositionApiService.queryPositionPage":{"post":{"summary":"Position List","deprecated":false,"description":"Description: Query position list\n\ngroup=tradeApi\nversion=0.0.1\nbizType=tradeapi.app.PositionApiService.queryPositionPage","tags":["Trade/Isolated Margin Contract"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"group","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"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"}}}}},"headers":{}}}}}}} ``` ## Fund Flow > Explanation: Pagination query account capital flow group=tradeApi version=0.0.1 bizType=tradeapi.app.OrderApiService.queryCapitalFlowList ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Trade/Isolated Margin Contract"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/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,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"group","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"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"}}}}},"headers":{}}}}}}} ``` ## Cancel limit order(For aggregation mode only) > Explanation: Cancel limit order(For aggregation mode only)\ > group=tradeApi \ > version=0.0.1 \ > bizType=tradeapi.app.OrderApiService.closeTradePboOrder ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Trade/Isolated Margin Contract"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/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)\ngroup=tradeApi \nversion=0.0.1 \nbizType=tradeapi.app.OrderApiService.closeTradePboOrder","tags":["Trade/Isolated Margin Contract"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"group","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"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"}}}}},"headers":{}}}}}}} ``` ## Check Order Status > Description: Check Order Status\ > \ > \ > group=tradeApi\ > version=0.0.1\ > bizType=tradeapi.app.OrderApiService.checkOrderStatus ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Trade/Isolated Margin Contract"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/tradeapi.app.OrderApiService.checkOrderStatus":{"post":{"summary":"Check Order Status","deprecated":false,"description":"Description: Check Order Status\n\n\ngroup=tradeApi\nversion=0.0.1\nbizType=tradeapi.app.OrderApiService.checkOrderStatus","tags":["Trade/Isolated Margin Contract"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"group","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"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"}}}}},"headers":{}}}}}}} ``` # Trade/Leveraged ## Place an order > Description: Contract margin trading order group=tradeApi version=0.0.1 bizType=tradeapi.app.OrderApiService.addOrder ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Trade/Leveraged"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/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,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"group","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"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"}}}}},"headers":{}}}}}}} ``` ## Set position stop loss and take profit > Explanation: Set position stop loss and take profit group=tradeApi version=0.0.1 bizType=tradeapi.app.OrderApiService.updateOrder ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Trade/Leveraged"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/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,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"group","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"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":"*"}}}}},"headers":{}}}}}}} ``` ## Transaction records > Explanation: Query transaction record list\ > \ > \ > group=tradeApi\ > version=0.0.1\ > bizType=tradeapi.app.OrderApiService.queryTradeRecordPage ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Trade/Leveraged"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/tradeapi.app.CrossLeverOrderApiService.queryTradeRecordPage":{"post":{"summary":"Transaction records","deprecated":false,"description":"Explanation: Query transaction record list\n\n\ngroup=tradeApi\nversion=0.0.1\nbizType=tradeapi.app.OrderApiService.queryTradeRecordPage","tags":["Trade/Leveraged"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"group","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"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"}}}}},"headers":{}}}}}}} ``` ## Get cross-currency repayment exchange rate > group=tradeApi\ > version=0.0.1\ > bizType=tradeapi.app.OrderApiService.previewOrder ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Trade/Leveraged"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/tradeapi.app.CrossLeverOrderApiService.previewOrder":{"post":{"summary":"Get cross-currency repayment exchange rate","deprecated":false,"description":"group=tradeApi\nversion=0.0.1\nbizType=tradeapi.app.OrderApiService.previewOrder","tags":["Trade/Leveraged"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"group","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"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"}}}}},"headers":{}}}}}}} ``` ## Cross-currency repayment > group=tradeApi\ > version=0.0.1\ > bizType=tradeapi.app.OrderApiService.addRepaymentOrder ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Trade/Leveraged"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/tradeapi.app.CrossLeverOrderApiService.addRepaymentOrder":{"post":{"summary":"Cross-currency repayment","deprecated":false,"description":"group=tradeApi\nversion=0.0.1\nbizType=tradeapi.app.OrderApiService.addRepaymentOrder","tags":["Trade/Leveraged"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"group","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"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"}}}}},"headers":{}}}}}}} ``` ## Fund Flow > Explanation: Pagination query account capital flow group=tradeApi version=0.0.1 bizType=tradeapi.app.OrderApiService.queryCapitalFlowList ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Trade/Leveraged"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/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,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"group","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"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"}}}}}}},"headers":{}}}}}}} ``` # Trade/Spot ## Fund Flow > Explanation: Pagination query of account fund flow Accessible after login group=tradeApi version=0.0.1 bizType=tradeapi.app.SpotOrderApiService.queryCapitalFlowList ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Trade/Spot"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/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"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultBasePageVoSpotSubjectWaterVo"}}},"headers":{}}}}}},"components":{"schemas":{"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"}}},"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"}}}}}} ``` ## Cancel limit order > Explanation: Cancel limit order for spot trading. Access after login group=tradeApi version=0.0.1 bizType=tradeapi.app.SpotOrderApiService.closeTradePboOrder ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Trade/Spot"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/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"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultSpotQueryOrderVo"}}},"headers":{}}}}}},"components":{"schemas":{"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"}}},"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":"#/components/schemas/SpotQueryOrderVo"},"ok":{"type":"boolean"},"fail":{"type":"boolean"}}},"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"}}}}}} ``` ## View Order List > Explanation: View Order List group=tradeApi version=0.0.1 bizType=tradeapi.app.SpotOrderApiService.queryOrderPage ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Trade/Spot"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/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,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"group","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpotQueryOrderPageDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultSpotQueryOrderPageVo"}}},"headers":{}}}}}},"components":{"schemas":{"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"}}},"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":"#/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"}}}}}} ``` ## View Order Details > Explanation: View order details for spot game, accessible after login group=tradeApi version=0.0.1 bizType=tradeapi.app.SpotOrderApiService.queryOrderDetail ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Trade/Spot"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/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"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultSpotQueryOrderVo"}}},"headers":{}}}}}},"components":{"schemas":{"SpotQueryOrderDto":{"type":"object","properties":{"orderId":{"type":"integer","format":"int64"}}},"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":"#/components/schemas/SpotQueryOrderVo"},"ok":{"type":"boolean"},"fail":{"type":"boolean"}}},"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"}}}}}} ``` ## Query transaction record list > Explanation: Query transaction record list group=tradeApi version=0.0.1 bizType=tradeapi.app.SpotOrderApiService.queryTradeRecordPage ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Trade/Spot"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/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"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultSpotTradeRecordVo"}}},"headers":{}}}}}},"components":{"schemas":{"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"}}},"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"}}}}}} ``` # Trade/Stock ## Place an order > Explanation: Place stock trading orders group=tradeApi version=0.0.1 bizType=tradeapi.app.OrderApiService.placeOrder ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Trade/Stock"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/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"]}}}},"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":{}}}}}}} ``` ## Cancel order > Explanation: Cancel unexecuted orders\ > \ > \ > group=tradeApi\ > version=0.0.1\ > bizType=tradeapi.app.OrderApiService.cancelOrder ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Trade/Stock"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/tradeapi.app.StockOrderApiService.cancelOrder":{"post":{"summary":"Cancel order","deprecated":false,"description":"Explanation: Cancel unexecuted orders\n\n\ngroup=tradeApi\nversion=0.0.1\nbizType=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"]}}}},"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":{}}}}}}} ``` ## Order information > Note: Query order information\ > \ > \ > group=tradeApi\ > version=0.0.1\ > bizType=tradeapi.app.OrderApiService.queryOrderDetail ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Trade/Stock"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/tradeapi.app.StockOrderApiService.queryOrderDetail":{"post":{"summary":"Order information","deprecated":false,"description":"Note: Query order information\n\n\ngroup=tradeApi\nversion=0.0.1\nbizType=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"]}}}},"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":{}}}}}}} ``` ## Entrustment order list > Note: Paginate query entrustment order list\ > \ > \ > group=tradeApi\ > version=0.0.1\ > bizType=tradeapi.app.OrderApiService.queryOrderPage ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Trade/Stock"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/tradeapi.app.StockOrderApiService.queryOrderPage":{"post":{"summary":"Entrustment order list","deprecated":false,"description":"Note: Paginate query entrustment order list\n\n\ngroup=tradeApi\nversion=0.0.1\nbizType=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"]}}}},"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":{}}}}}}} ``` ## Customer entrustment list > Explanation: Query the current customer entrustment list group=tradeApi version=0.0.1 bizType=tradeapi.app.OrderApiService.queryPendingOrderList ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Trade/Stock"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/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"]}}}},"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":{}}}}}}} ``` ## Place an order verification > Explanation: Verify the result of this order\ > \ > \ > group=tradeApi\ > version=0.0.1\ > bizType=tradeapi.app.OrderApiService.checkOrder ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Trade/Stock"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/tradeapi.app.StockOrderApiService.checkOrder":{"post":{"summary":"Place an order verification","deprecated":false,"description":"Explanation: Verify the result of this order\n\n\ngroup=tradeApi\nversion=0.0.1\nbizType=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"]}}}},"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":{}}}}}}} ``` ## Trading trial calculation > Explanation: Trial calculation can buy and sell shares group=tradeApi version=0.0.1 bizType=tradeapi.app.OrderApiService.calculateOrder ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Trade/Stock"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/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"]}}}},"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":{}}}}}}} ``` ## Deal list > Note: Query deal list group=tradeApi version=0.0.1 bizType=tradeapi.app.OrderApiService.queryDealPage ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Trade/Stock"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/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"]}}}},"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":{}}}}}}} ``` ## Position transaction list > Description: Query the list of position-related transaction orders\ > \ > \ > group=tradeApi\ > version=0.0.1\ > bizType=tradeapi.app.OrderApiService.getPositionDealDetailList ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Trade/Stock"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/tradeapi.app.StockOrderApiService.getPositionDealDetailList":{"post":{"summary":"Position transaction list","deprecated":false,"description":"Description: Query the list of position-related transaction orders\n\n\ngroup=tradeApi\nversion=0.0.1\nbizType=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"]}}}},"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":{}}}}}}} ``` ## Position Details > Description: Query position details\ > \ > group=tradeApi\ > version=0.0.1\ > bizType=tradeapi.app.PositionApiService.queryPositionDetail ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Trade/Stock"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/tradeapi.app.StockPositionApiService.queryPositionDetail":{"post":{"summary":"Position Details","deprecated":false,"description":"Description: Query position details\n\ngroup=tradeApi\nversion=0.0.1\nbizType=tradeapi.app.PositionApiService.queryPositionDetail","tags":["Trade/Stock"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"group","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"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":{}}}}}}} ``` ## Position List > Description: Query position list\ > \ > group=tradeApi\ > version=0.0.1\ > bizType=tradeapi.app.PositionApiService.queryPositionPage ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Trade/Stock"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/tradeapi.app.StockPositionApiService.queryPositionPage":{"post":{"summary":"Position List","deprecated":false,"description":"Description: Query position list\n\ngroup=tradeApi\nversion=0.0.1\nbizType=tradeapi.app.PositionApiService.queryPositionPage","tags":["Trade/Stock"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"group","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"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":{}}}}}}} ``` ## Fund Flow > Explanation: Pagination query account capital flow group=tradeApi version=0.0.1 bizType=tradeapi.app.OrderApiService.queryCapitalFlowList ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Trade/Stock"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/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,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"group","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"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":{}}}}}}} ``` ## Asset information > Explanation: Query account asset information\ > \ > \ > group=tradeApi\ > version=0.0.1\ > bizType=tradeapi.app.AccountApiService.queryAccountAssetsInfo ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Trade/Stock"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/tradeapi.app.StockAccountApiService.queryAccountAssetsInfo":{"post":{"summary":"Asset information","deprecated":false,"description":"Explanation: Query account asset information\n\n\ngroup=tradeApi\nversion=0.0.1\nbizType=tradeapi.app.AccountApiService.queryAccountAssetsInfo","tags":["Trade/Stock"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"group","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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"]}}}},"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":{}}}}}}} ``` # Index/Report ## Index Sample Data > Explanation: Index sample data version=0.0.1 bizType=report.app.ReportDatadDubboService.indexSample ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Index/Report"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/report.app.ReportDatadDubboService.indexSample":{"post":{"summary":"Index Sample Data","deprecated":false,"description":"Explanation: Index sample data version=0.0.1 bizType=report.app.ReportDatadDubboService.indexSample","operationId":"indexSample","tags":["Index/Report"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"indexId":{"type":"integer","format":"int64","title":"Index ID"}},"required":["indexId"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultListIndexSymbolCombinationVo"}}},"headers":{}}}}}},"components":{"schemas":{"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":""}}}} ``` ## Index Single Asset Performance Bar Chart Data > Explanation: Index Single Asset Performance Bar Chart Data version=0.0.1 bizType=report.app.ReportDatadDubboService.assetPerformance ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Index/Report"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/report.app.ReportDatadDubboService.indexSimplePerformance":{"post":{"summary":"Index Single Asset Performance Bar Chart Data","deprecated":false,"description":"Explanation: Index Single Asset Performance Bar Chart Data version=0.0.1 bizType=report.app.ReportDatadDubboService.assetPerformance","operationId":"indexSimplePerformance","tags":["Index/Report"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IndexChartDto","required":["indexId"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultListIndexSingleAssetPerformanceVo"}}},"headers":{}}}}}},"components":{"schemas":{"IndexChartDto":{"type":"object","properties":{"indexId":{"type":"integer","format":"int64","title":"Index ID"}},"required":["indexId"],"title":""},"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":""}}}} ``` ## Fund Single Asset Performance Bar Chart Data > Explanation: Fund Single Asset Performance Bar Chart Data\ > \ > version=0.0.1\ > bizType=report.app.ReportDatadDubboService.assetPerformance ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Index/Report"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/report.app.ReportDatadDubboService.assetPerformance":{"post":{"summary":"Fund Single Asset Performance Bar Chart Data","deprecated":false,"description":"Explanation: Fund Single Asset Performance Bar Chart Data\n\nversion=0.0.1\nbizType=report.app.ReportDatadDubboService.assetPerformance","operationId":"assetPerformance","tags":["Index/Report"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SingeAssetPerformanceChartVo"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultListSingleAssetPerformanceDto"}}},"headers":{}}}}}},"components":{"schemas":{"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":""},"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":""}}}} ``` ## Batch Get Market Performance Trend Chart for Funds > Explanation: Batch Get Market Performance Trend Chart\ > \ > version=0.0.1\ > bizType=report.app.ReportDatadDubboService.batchMarketPerformance ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Index/Report"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/report.app.ReportDatadDubboService.batchMarketPerformance":{"post":{"summary":"Batch Get Market Performance Trend Chart for Funds","deprecated":false,"description":"Explanation: Batch Get Market Performance Trend Chart\n\nversion=0.0.1\nbizType=report.app.ReportDatadDubboService.batchMarketPerformance","operationId":"batchMarketPerformance","tags":["Index/Report"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FundBatchMarketPerfChartVo"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultMapLongListFundTrendChartTypeDto"}}},"headers":{}}}}}},"components":{"schemas":{"FundBatchMarketPerfChartVo":{"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":""},"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":"#/components/schemas/FundTrendChartDto"}}},"required":["name","columnList"]},"FundTrendChartDto":{"type":"object","properties":{"time":{"type":"string","title":"Date"},"value":{"type":"string","title":"Y-coordinate value"}},"required":["time","value"]}}}} ``` ## Fund Net Value Change Ratio > Explanation: Fund Net Value Change Ratio\ > \ > version=0.0.1\ > bizType=report.app.ReportDatadDubboService.fundNetValueChangeQuote ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Index/Report"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/report.app.ReportDatadDubboService.fundNetValueChangeQuote":{"post":{"summary":"Fund Net Value Change Ratio","deprecated":false,"description":"Explanation: Fund Net Value Change Ratio\n\nversion=0.0.1\nbizType=report.app.ReportDatadDubboService.fundNetValueChangeQuote","operationId":"fundNetValueChangeQuote","tags":["Index/Report"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FundNetValueChangeQuoteChartVo"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultFundNetValueCompareDto"}}},"headers":{}}}}}},"components":{"schemas":{"FundNetValueChangeQuoteChartVo":{"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":""},"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":""}}}} ``` ## Real-time fund investment portfolio ranking > Explanation: Real-time fund investment portfolio ranking\ > \ > version=0.0.1\ > bizType=report.app.ReportDatadDubboService.investCombination ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Index/Report"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/report.app.ReportDatadDubboService.investCombination":{"post":{"summary":"Real-time fund investment portfolio ranking","deprecated":false,"description":"Explanation: Real-time fund investment portfolio ranking\n\nversion=0.0.1\nbizType=report.app.ReportDatadDubboService.investCombination","operationId":"investCombination","tags":["Index/Report"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FundInvestCombChartVo"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultListRealTimeInvestCombinationDto"}}},"headers":{}}}}}},"components":{"schemas":{"FundInvestCombChartVo":{"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":""},"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":""}}}} ``` ## Fund market performance trend chart > Explanation: Fund market performance trend chart\ > \ > version=0.0.1\ > bizType=report.app.ReportDatadDubboService.marketPerformance ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Index/Report"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/report.app.ReportDatadDubboService.marketPerformance":{"post":{"summary":"Fund market performance trend chart","deprecated":false,"description":"Explanation: Fund market performance trend chart\n\nversion=0.0.1\nbizType=report.app.ReportDatadDubboService.marketPerformance","operationId":"marketPerformance","tags":["Index/Report"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FundMarketPerfChartVo"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultMapStringListFundTrendChartDto"}}},"headers":{}}}}}},"components":{"schemas":{"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":""},"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":"#/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"]}}}} ``` ## Fund market performance rise and fall trend chart > Explanation: Market performance rise and fall trend chart\ > \ > version=0.0.1\ > bizType=report.app.ReportDatadDubboService.marketPerformanceQuoteChange ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Index/Report"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/report.app.ReportDatadDubboService.marketPerformanceQuoteChange":{"post":{"summary":"Fund market performance rise and fall trend chart","deprecated":false,"description":"Explanation: Market performance rise and fall trend chart\n\nversion=0.0.1\nbizType=report.app.ReportDatadDubboService.marketPerformanceQuoteChange","operationId":"marketPerformanceQuoteChange","tags":["Index/Report"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FundMarketPerfQuoteChangeChartVo"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultMapStringListFundTrendChartDto"}}},"headers":{}}}}}},"components":{"schemas":{"FundMarketPerfQuoteChangeChartVo":{"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":""},"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":"#/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"]}}}} ``` # Index/Subscription ## Fund subscription > bizType=fund.app.FundApplyAppDubboService.apply\ > Fund subscription\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Index/Subscription"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.FundApplyAppDubboService.apply":{"post":{"summary":"Fund subscription","deprecated":false,"description":"bizType=fund.app.FundApplyAppDubboService.apply\nFund subscription\nAccessible after login","operationId":"apply","tags":["Index/Subscription"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFundApplyReqDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultCustomerFundApplyDto"}}},"headers":{}}}}}},"components":{"schemas":{"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"}}},"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":"#/components/schemas/CustomerFundApplyDto"},"ok":{"type":"boolean"},"fail":{"type":"boolean"}}},"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":"#/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"}}}}}} ``` ## Calculate service fee and shares for customer subscription > bizType=fund.app.FundApplyAppDubboService.calcApplyShares\ > Calculate service fee and shares for customer subscription\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Index/Subscription"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.FundApplyAppDubboService.calcApplyShares":{"post":{"summary":"Calculate service fee and shares for customer subscription","deprecated":false,"description":"bizType=fund.app.FundApplyAppDubboService.calcApplyShares\nCalculate service fee and shares for customer subscription\nAccessible after login","operationId":"calcApplyShares","tags":["Index/Subscription"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFundApplyReqDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultFundApplyCalcDto"}}},"headers":{}}}}}},"components":{"schemas":{"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"}}},"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":"#/components/schemas/CustomerFundCurrencyDto"}}}},"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"}}}}}} ``` ## Customer subscription record > bizType=fund.app.FundApplyAppDubboService.customerPage\ > H5 subscription record\ > Access after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Index/Subscription"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.FundApplyAppDubboService.customerPage":{"post":{"summary":"Customer subscription record","deprecated":false,"description":"bizType=fund.app.FundApplyAppDubboService.customerPage\nH5 subscription record\nAccess after login","operationId":"customerPage","tags":["Index/Subscription"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FundApplyRecordDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultBasePageVoCustomerFundApplyDto"}}},"headers":{}}}}}},"components":{"schemas":{"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"}}},"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":"#/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":"#/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"}}}}}} ``` ## Get underlying asset information of the fund > bizType=fund.app.FundApplyAppDubboService.getFundCurrencyList\ > Get underlying asset information of the fund\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Index/Subscription"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.FundApplyAppDubboService.getFundCurrencyList":{"post":{"summary":"Get underlying asset information of the fund","deprecated":false,"description":"bizType=fund.app.FundApplyAppDubboService.getFundCurrencyList\nGet underlying asset information of the fund\nAccessible after login","operationId":"getFundCurrencyList","tags":["Index/Subscription"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FundCurrencyQueryReqDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultListCustomerFundCurrencyDto"}}},"headers":{}}}}}},"components":{"schemas":{"FundCurrencyQueryReqDto":{"type":"object","required":["proposalNo"],"properties":{"proposalNo":{"type":"string","description":"Proposal number"}}},"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":"#/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"}}}}}} ``` ## Client manager pagination query fund records > bizType=fund.app.FundApplyAppDubboService.page\ > PCUI client manager pagination query fund records\ > Access after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Index/Subscription"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.FundApplyAppDubboService.page":{"post":{"summary":"Client manager pagination query fund records","deprecated":false,"description":"bizType=fund.app.FundApplyAppDubboService.page\nPCUI client manager pagination query fund records\nAccess after login","operationId":"page","tags":["Index/Subscription"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FundApplyRecordDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultBasePageVoCustomerFundApplyDto"}}},"headers":{}}}}}},"components":{"schemas":{"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"}}},"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":"#/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":"#/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"}}}}}} ``` # Index/Management ## Total fund management fees > bizType=fund.app.FundManagementFeesAppDubboService.calcDeduct\ > Total fund management fees\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Index/Management"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.FundManagementFeesAppDubboService.calcDeduct":{"post":{"summary":"Total fund management fees","deprecated":false,"description":"bizType=fund.app.FundManagementFeesAppDubboService.calcDeduct\nTotal fund management fees\nAccessible after login","operationId":"calcDeduct","tags":["Index/Management"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FundManagementFeesDeductDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultFundManagementFeesCalcDto"}}},"headers":{}}}}}},"components":{"schemas":{"FundManagementFeesDeductDto":{"type":"object","properties":{"idList":{"type":"array","items":{"type":"integer","format":"int64"}}}},"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"}}}}}} ``` ## Manually execute management fee deduction > bizType=fund.app.FundManagementFeesAppDubboService.deduct\ > Manually execute management fee deduction\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Index/Management"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.FundManagementFeesAppDubboService.deduct":{"post":{"summary":"Manually execute management fee deduction","deprecated":false,"description":"bizType=fund.app.FundManagementFeesAppDubboService.deduct\nManually execute management fee deduction\nAccessible after login","operationId":"deduct","tags":["Index/Management"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FundManagementFeesDeductDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultVoid"}}},"headers":{}}}}}},"components":{"schemas":{"FundManagementFeesDeductDto":{"type":"object","properties":{"idList":{"type":"array","items":{"type":"integer","format":"int64"}}}},"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":{"type":"object","properties":{}}}}} ``` ## Fund management fee execution > bizType=fund.app.FundManagementFeesAppDubboService.execute\ > Fund management fee execution\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Index/Management"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.FundManagementFeesAppDubboService.excute":{"post":{"summary":"Fund management fee execution","deprecated":false,"description":"bizType=fund.app.FundManagementFeesAppDubboService.execute\nFund management fee execution\nAccessible after login","operationId":"excute","tags":["Index/Management"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultVoid"}}},"headers":{}}}}}},"components":{"schemas":{"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":{"type":"object","properties":{}}}}} ``` ## Query fund management fee pagination records > bizType=fund.app.FundManagementFeesAppDubboService.page\ > Query fund management fee pagination records\ > Access after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Index/Management"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.FundManagementFeesAppDubboService.page":{"post":{"summary":"Query fund management fee pagination records","deprecated":false,"description":"bizType=fund.app.FundManagementFeesAppDubboService.page\nQuery fund management fee pagination records\nAccess after login","operationId":"page","tags":["Index/Management"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FundManagementFeesRecordDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultBasePageVoFundManagementFeesDto"}}},"headers":{}}}}}},"components":{"schemas":{"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"}}},"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"}}}}}} ``` ## Confirm Fund Product Purchase Execution Information > bizType=fund.app.FundsApplyExecuteService.confirmFundsApplyExecuteInfo\ > Confirm Fund Product Purchase Execution Information\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Index/Management"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.FundsApplyExecuteService.confirmFundsApplyExecuteInfo":{"post":{"summary":"Confirm Fund Product Purchase Execution Information","deprecated":false,"description":"bizType=fund.app.FundsApplyExecuteService.confirmFundsApplyExecuteInfo\nConfirm Fund Product Purchase Execution Information\nAccessible after login","operationId":"confirmFundsApplyExecuteInfo","tags":["Index/Management"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FundsApplyExecuteInfoDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultBoolean"}}},"headers":{}}}}}},"components":{"schemas":{"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":"#/components/schemas/FundsApplyExecuteRecordDetailDto"}}}},"FundsApplyExecuteRecordDto":{"type":"object","properties":{"amount":{"type":"number","description":"Profit Currency Amount"},"profitCurrency":{"type":"string","description":"Profit Currency"}}},"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"}}},"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"}}}}}} ``` ## Get fund product subscription execution information > bizType=fund.app.FundsApplyExecuteService.getFundsApplyExecuteInfo\ > Get fund product subscription execution information\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Index/Management"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.FundsApplyExecuteService.getFundsApplyExecuteInfo":{"post":{"summary":"Get fund product subscription execution information","deprecated":false,"description":"bizType=fund.app.FundsApplyExecuteService.getFundsApplyExecuteInfo\nGet fund product subscription execution information\nAccessible after login","operationId":"getFundsApplyExecuteInfo","tags":["Index/Management"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryFundsApplyExecuteRecordDetailReqDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultFundsApplyExecuteInfoDto"}}},"headers":{}}}}}},"components":{"schemas":{"QueryFundsApplyExecuteRecordDetailReqDto":{"type":"object","required":["applyIds"],"properties":{"applyIds":{"type":"array","description":"Fund Product Subscription Record ID List","items":{"type":"integer","format":"int64"}}}},"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":"#/components/schemas/FundsApplyExecuteInfoDto"},"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":"#/components/schemas/FundsApplyExecuteRecordDetailDto"}}}},"FundsApplyExecuteRecordDto":{"type":"object","properties":{"amount":{"type":"number","description":"Profit Currency Amount"},"profitCurrency":{"type":"string","description":"Profit Currency"}}},"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"}}}}}} ``` ## Get fund product order execution standard configuration product list > bizType=fund.app.FundsOrderExecuteStandardService.getOrderExecuteStandardConfigSymbolList\ > Get fund product order execution standard configuration product list\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Index/Management"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.FundsOrderExecuteStandardService.getOrderExecuteStandardConfigSymbolList":{"post":{"summary":"Get fund product order execution standard configuration product list","deprecated":false,"description":"bizType=fund.app.FundsOrderExecuteStandardService.getOrderExecuteStandardConfigSymbolList\nGet fund product order execution standard configuration product list\nAccessible after login","operationId":"getOrderExecuteStandardConfigSymbolList","tags":["Index/Management"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryOrderExecuteStandardConfigSymbolListReqDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultListOrderExecuteStandardConfigSymbolDto"}}},"headers":{}}}}}},"components":{"schemas":{"QueryOrderExecuteStandardConfigSymbolListReqDto":{"type":"object","properties":{}},"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":{"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"}}}}}} ``` ## Get the list of fund product order execution standard configurations > bizType=fund.app.FundsOrderExecuteStandardService.getOrderExecuteStandardConfigs\ > Get the list of fund product order execution standard configurations\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Index/Management"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.FundsOrderExecuteStandardService.getOrderExecuteStandardConfigs":{"post":{"summary":"Get the list of fund product order execution standard configurations","deprecated":false,"description":"bizType=fund.app.FundsOrderExecuteStandardService.getOrderExecuteStandardConfigs\nGet the list of fund product order execution standard configurations\nAccessible after login","operationId":"getOrderExecuteStandardConfigs","tags":["Index/Management"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryOrderExecuteStandardConfigReqDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultListOrderExecuteStandardConfigDto"}}},"headers":{}}}}}},"components":{"schemas":{"QueryOrderExecuteStandardConfigReqDto":{"type":"object","required":["customerGroupId"],"properties":{"customerGroupId":{"type":"integer","format":"int64","description":"Customer group ID"}}},"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":"#/components/schemas/OrderExecuteStandardConfigDto"}},"ok":{"type":"boolean"},"fail":{"type":"boolean"}}},"OrderExecuteStandardConfigDto":{"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"}}}}}} ``` ## Save gold product order execution standard configuration > bizType=fund.app.FundsOrderExecuteStandardService.saveOrderExecuteStandardConfigs\ > Save gold product order execution standard configuration\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Index/Management"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.FundsOrderExecuteStandardService.saveOrderExecuteStandardConfigs":{"post":{"summary":"Save gold product order execution standard configuration","deprecated":false,"description":"bizType=fund.app.FundsOrderExecuteStandardService.saveOrderExecuteStandardConfigs\nSave gold product order execution standard configuration\nAccessible after login","operationId":"saveOrderExecuteStandardConfigs","tags":["Index/Management"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveOrderExecuteStandardConfigReqDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultBoolean"}}},"headers":{}}}}}},"components":{"schemas":{"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":"#/components/schemas/OrderExecuteStandardConfigDto"}}}},"OrderExecuteStandardConfigDto":{"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"}}},"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"}}}}}} ``` # Index/Query ## Query fund information > bizType=fund.app.FundOperationInfoAppDubboService.queryFundInfo\ > Query fund information\ > Login required to access ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Index/Query"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.FundOperationInfoAppDubboService.queryFundInfo":{"post":{"summary":"Query fund information","deprecated":false,"description":"bizType=fund.app.FundOperationInfoAppDubboService.queryFundInfo\nQuery fund information\nLogin required to access","operationId":"queryFundInfo","tags":["Index/Query"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FundInfoQueryReqDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultFundOperationInfoDto"}}},"headers":{}}}}}},"components":{"schemas":{"FundInfoQueryReqDto":{"type":"object","required":["fundId"],"properties":{"fundId":{"type":"integer","format":"int64","description":"Fund ID"}}},"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"}}}}}} ``` # Index/Redemption ## Calculate redemption shares for clients > bizType=fund.app.FundRedeemAppDubboService.calFundRedeem\ > Calculate redemption shares for clients\ > Login required to access ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Index/Redemption"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.FundRedeemAppDubboService.calFundRedeem":{"post":{"summary":"Calculate redemption shares for clients","deprecated":false,"description":"bizType=fund.app.FundRedeemAppDubboService.calFundRedeem\nCalculate redemption shares for clients\nLogin required to access","operationId":"calFundRedeem","tags":["Index/Redemption"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFundRedeemReqDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultCustomerFundRedeemDto"}}},"headers":{}}}}}},"components":{"schemas":{"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"}}},"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":"#/components/schemas/CustomerFundRedeemDto"},"ok":{"type":"boolean"},"fail":{"type":"boolean"}}},"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"}}}}}} ``` ## Customer manager calculates shares > bizType=fund.app.FundRedeemAppDubboService.calShares\ > Customer manager calculates shares\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Index/Redemption"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.FundRedeemAppDubboService.calShares":{"post":{"summary":"Customer manager calculates shares","deprecated":false,"description":"bizType=fund.app.FundRedeemAppDubboService.calShares\nCustomer manager calculates shares\nAccessible after login","operationId":"calShares","tags":["Index/Redemption"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FundRedeemSharesCheckReqDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultFundRedeemSharesCheckRespDto"}}},"headers":{}}}}}},"components":{"schemas":{"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"}}},"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":{}}}}}}} ``` ## Customer Manager Confirms Redemption Shares > bizType=fund.app.FundRedeemAppDubboService.checkShares\ > Customer Manager Confirms Redemption Shares\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Index/Redemption"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.FundRedeemAppDubboService.checkShares":{"post":{"summary":"Customer Manager Confirms Redemption Shares","deprecated":false,"description":"bizType=fund.app.FundRedeemAppDubboService.checkShares\nCustomer Manager Confirms Redemption Shares\nAccessible after login","operationId":"checkShares","tags":["Index/Redemption"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FundRedeemSharesCheckReqDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultFundRedeemSharesCheckRespDto"}}},"headers":{}}}}}},"components":{"schemas":{"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"}}},"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":{}}}}}}} ``` ## Customer redeem fund > bizType=fund.app.FundRedeemAppDubboService.createFundRedeem\ > Customer redeem fund\ > Access after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Index/Redemption"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.FundRedeemAppDubboService.createFundRedeem":{"post":{"summary":"Customer redeem fund","deprecated":false,"description":"bizType=fund.app.FundRedeemAppDubboService.createFundRedeem\nCustomer redeem fund\nAccess after login","operationId":"createFundRedeem","tags":["Index/Redemption"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFundRedeemReqDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultVoid"}}},"headers":{}}}}}},"components":{"schemas":{"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"}}},"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":{"type":"object","properties":{}}}}} ``` ## Obtain underlying asset information of redemption funds > bizType=fund.app.FundRedeemAppDubboService.getFundRedeemCurrencyList\ > Obtain underlying asset information of redemption funds\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Index/Redemption"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.FundRedeemAppDubboService.getFundRedeemCurrencyList":{"post":{"summary":"Obtain underlying asset information of redemption funds","deprecated":false,"description":"bizType=fund.app.FundRedeemAppDubboService.getFundRedeemCurrencyList\nObtain underlying asset information of redemption funds\nAccessible after login","operationId":"getFundRedeemCurrencyList","tags":["Index/Redemption"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FundCurrencyQueryReqDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultListCustomerFundCurrencyDto"}}},"headers":{}}}}}},"components":{"schemas":{"FundCurrencyQueryReqDto":{"type":"object","required":["proposalNo"],"properties":{"proposalNo":{"type":"string","description":"Proposal number"}}},"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":"#/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"}}}}}} ``` ## Customer query redemption record pagination list > bizType=fund.app.FundRedeemAppDubboService.page\ > H5 pagination query redemption list\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Index/Redemption"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.FundRedeemAppDubboService.page":{"post":{"summary":"Customer query redemption record pagination list","deprecated":false,"description":"bizType=fund.app.FundRedeemAppDubboService.page\nH5 pagination query redemption list\nAccessible after login","operationId":"page","tags":["Index/Redemption"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FundRedeemQueryReqDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultBasePageVoCustomerFundRedeemDto"}}},"headers":{}}}}}},"components":{"schemas":{"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":"#/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"}}},"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":"#/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"}}}}}} ``` ## Client manager pagination query fund records > bizType=fund.app.FundRedeemAppDubboService.page\ > Customer manager paginated fund record query\ > Access after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Index/Redemption"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.FundRedeemAppDubboService.queryManagerPage":{"post":{"summary":"Client manager pagination query fund records","deprecated":false,"description":"bizType=fund.app.FundRedeemAppDubboService.page\nCustomer manager paginated fund record query\nAccess after login","operationId":"queryManagerPage","tags":["Index/Redemption"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FundRedeemQueryReqDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultBasePageVoCustomerFundRedeemDto"}}},"headers":{}}}}}},"components":{"schemas":{"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":"#/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"}}},"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":"#/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"}}}}}} ``` ## Query the number of unredeemed records for fund managers > bizType=fund.app.FundRedeemAppDubboService.queryNotConfirmedRecs\ > Customer manager paginated query fund records\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Index/Redemption"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/fund.app.FundRedeemAppDubboService.queryNotConfirmedRecs":{"post":{"summary":"Query the number of unredeemed records for fund managers","deprecated":false,"description":"bizType=fund.app.FundRedeemAppDubboService.queryNotConfirmedRecs\nCustomer manager paginated query fund records\nAccessible after login","operationId":"queryNotConfirmedRecs","tags":["Index/Redemption"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FundInfoQueryReqDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultLong"}}},"headers":{}}}}}},"components":{"schemas":{"FundInfoQueryReqDto":{"type":"object","required":["fundId"],"properties":{"fundId":{"type":"integer","format":"int64","description":"Fund ID"}}},"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"}}}}}} ``` # Credit Card/Operation ## Apply for card > Header Description: version=0.0.1 bizType=passToCredit.app.AppCardActiveService.applyCard ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Credit Card/Operation"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/passToCredit.app.AppCardActiveService.applyCard":{"post":{"summary":"Apply for card","deprecated":false,"description":"Header Description: version=0.0.1 bizType=passToCredit.app.AppCardActiveService.applyCard","tags":["Credit Card/Operation"],"parameters":[{"name":"version","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"companyId":{"type":"integer","title":"Company ID","description":"Company ID. Environment variable configuration","format":"long"},"customerId":{"type":"integer","title":"Client ID","format":"long","description":"Client ID"},"customerNo":{"type":"string","title":"Client number","description":"Client number"},"ip":{"type":"string","title":"Operation IP","description":"Operation IP","nullable":true},"trace":{"type":"string","title":"Trace number","description":"Trace number","nullable":true},"type":{"type":"integer","title":"Apply card type.","description":"Apply card type. 1-Platinum;","format":"int32"},"applyCurrency":{"type":"string","title":"Apply card currency.","description":"Apply card currency. Default HKD (currently only supports \"HKD\")","nullable":true},"remark":{"type":"string","title":"Remarks","description":"Remarks","nullable":true},"kycPno":{"type":"string","title":"KYC proposal number","description":"KYC proposal number","nullable":true},"address":{"type":"string","title":"Address","description":"Address"},"postalCode":{"type":"string","title":"Postal code","description":"Postal code"},"mailingCountry":{"type":"string","title":"Country/Region code","description":"Country/Region code","nullable":true},"mailingProvince":{"type":"string","title":"State/Province code","description":"State/Province code","nullable":true},"mailingCity":{"type":"string","title":"City code","description":"City code","nullable":true},"mailingAddress":{"type":"string","title":"Detailed address","description":"Detailed address","nullable":true},"applyEntity":{"type":"string","title":"Apply for physical card","description":"Apply for physical card"}},"required":["companyId","customerId","customerNo","type","address","postalCode"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"System universal return code. 0-Success; 9000-Need to guide KYC","title":"System universal return code."},"msg":{"type":"string","title":"Return information","description":"Return information"},"data":{"type":"object","properties":{"fee":{"type":"string","title":"Card issuance fee","description":"Card issuance fee. Same as the applied card currency"},"administrativeOverTime":{"type":"integer","description":"Administrative fee collection time"}},"title":"Return message body.","description":"Return message body."}},"title":""}}},"headers":{}}}}}}} ``` ## Activate card > Header description: version=0.0.1 bizType=passToCredit.app.AppCardActiveService.activationCard ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Credit Card/Operation"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/passToCredit.app.AppCardActiveService.activationCard":{"post":{"summary":"Activate card","deprecated":false,"description":"Header description: version=0.0.1 bizType=passToCredit.app.AppCardActiveService.activationCard","tags":["Credit Card/Operation"],"parameters":[{"name":"version","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"companyId":{"type":"integer","title":"Company ID","description":"Company ID. Environment variable configuration","format":"long"},"customerId":{"type":"integer","title":"Client ID","format":"long","description":"Client ID"},"customerNo":{"type":"string","title":"Client number","description":"Client number"},"ip":{"type":"string","title":"Operation IP","description":"Operation IP","nullable":true},"trace":{"type":"string","title":"Trace number","description":"Trace number","nullable":true},"cardId":{"type":"integer","title":"Card ID","format":"long","description":"Card ID"},"cardNumber":{"type":"string","title":"Card number","description":"Card number"},"smsSendToken":{"type":"string","title":"SMS verification code sending ticket","description":"SMS verification code sending ticket"},"smsCode":{"type":"string","title":"SMS verification code","description":"SMS verification code"},"activationCode":{"type":"string","title":"Activation code","description":"Activation code"}},"required":["companyId","customerId","customerNo","cardId","smsSendToken","smsCode","cardNumber","activationCode"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"System universal return code. 0-Success;","title":"System universal return code."},"msg":{"type":"string","title":"Return information","description":"Return information"},"data":{"type":"object","properties":{"id":{"type":"integer","title":"Card ID","format":"long","description":"Card ID"}},"title":"Return message body.","description":"Return message body."}},"title":""}}},"headers":{}}}}}}} ``` ## Lock card > Header description: version=0.0.1 bizType=passToCredit.app.AppCardActiveService.lockCard ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Credit Card/Operation"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/passToCredit.app.AppCardActiveService.lockCard":{"post":{"summary":"Lock card","deprecated":false,"description":"Header description: version=0.0.1 bizType=passToCredit.app.AppCardActiveService.lockCard","tags":["Credit Card/Operation"],"parameters":[{"name":"version","in":"header","description":"Version Number","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"Company ID, obtained through environment variables","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"Random Tracking Code UUID","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"Login Token","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"Language","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"companyId":{"type":"integer","title":"Company ID","description":"Company ID. Environment variable configuration","format":"long"},"customerId":{"type":"integer","title":"Client ID","format":"long","description":"Client ID"},"customerNo":{"type":"string","title":"Client number","description":"Client number"},"ip":{"type":"string","title":"Operation IP","description":"Operation IP","nullable":true},"trace":{"type":"string","title":"Trace number","description":"Trace number","nullable":true},"cardId":{"type":"integer","title":"Card ID","format":"long","description":"Card ID"},"smsSendToken":{"type":"string","title":"SMS verification code sending ticket","description":"SMS verification code sending ticket"},"smsCode":{"type":"string","title":"SMS verification code","description":"SMS verification code"}},"required":["companyId","customerId","customerNo","cardId","smsSendToken","smsCode"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"System universal return code. 0-Success;","title":"System universal return code."},"msg":{"type":"string","title":"Return information","description":"Return information"},"data":{"type":"boolean","title":"Return message body.","description":"Return message body. true-success"}},"title":""}}},"headers":{}}}}}}} ``` ## Lost card > Header description: version=0.0.1 bizType=passToCredit.app.AppCardActiveService.addSuspendCardProposal ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Credit Card/Operation"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/passToCredit.app.AppCardActiveService.addSuspendCardProposal":{"post":{"summary":"Lost card","deprecated":false,"description":"Header description: version=0.0.1 bizType=passToCredit.app.AppCardActiveService.addSuspendCardProposal","tags":["Credit Card/Operation"],"parameters":[{"name":"version","in":"header","description":"Version Number","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"Company ID, obtained through environment variables","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"Random Tracking Code UUID","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"Login Token","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"Language","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"companyId":{"type":"integer","title":"Company ID","description":"Environment variable configuration","format":"long"},"customerId":{"type":"integer","title":"Client ID","format":"long"},"customerNo":{"type":"string","title":"Client number"},"ip":{"type":"string","title":"Operation IP","nullable":true},"trace":{"type":"string","title":"Trace number","nullable":true},"cardId":{"type":"integer","title":"Card ID","format":"long"},"remark":{"type":"string","title":"Remarks","nullable":true},"smsSendToken":{"type":"string","title":"Verification code sending ticket"},"smsCode":{"type":"string","title":"Verification code"}},"required":["companyId","customerId","customerNo","cardId","smsSendToken","smsCode"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"0-Success;","title":"System universal return code."},"msg":{"type":"string","title":"Return information"},"data":{"type":"boolean","title":"Return message body.","description":"true-Success"}},"title":""}}},"headers":{}}}}}}} ``` ## Transfer > Header description: version=0.0.1 bizType=passToCredit.app.AmountActiveService.addTransferProposal ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Credit Card/Operation"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/passToCredit.app.AmountActiveService.addTransferProposal":{"post":{"summary":"Transfer","deprecated":false,"description":"Header description: version=0.0.1 bizType=passToCredit.app.AmountActiveService.addTransferProposal","tags":["Credit Card/Operation"],"parameters":[{"name":"version","in":"header","description":"Version Number","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"Company ID, obtained through environment variables","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"Random Tracking Code UUID","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"Login Token","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"Language","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"companyId":{"type":"integer","title":"Company ID","description":"Company ID. Environment variable configuration","format":"long"},"customerId":{"type":"integer","title":"Transfer out customer ID","format":"long","description":"Transfer out customer ID. This interface is for agents' use, the gateway of this project should automatically fill in"},"customerNo":{"type":"string","title":"Transfer out customer number","description":"Transfer out customer number. This interface is for agents' use, the gateway of this project should automatically fill in"},"amount":{"type":"string","title":"Transfer amount","description":"Transfer amount"},"currency":{"type":"string","title":"Transfer currency","description":"Transfer currency. Not required, default is HKD","nullable":true},"toCustomerNo":{"type":"string","title":"Transfer to customer number","description":"Transfer to customer number","nullable":true}},"required":["customerId","customerNo","amount","companyId"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"System universal return code. 0-Success;","title":"System universal return code."},"msg":{"type":"string","title":"Return information","description":"Return information"},"data":{"type":"boolean","title":"Return message body.","description":"Return message body. true-success"}},"title":""}}},"headers":{}}}}}}} ``` ## Unlock card > Header description: version=0.0.1 bizType=passToCredit.app.AppCardActiveService.unlockCard ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Credit Card/Operation"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/passToCredit.app.AppCardActiveService.unlockCard":{"post":{"summary":"Unlock card","deprecated":false,"description":"Header description: version=0.0.1 bizType=passToCredit.app.AppCardActiveService.unlockCard","tags":["Credit Card/Operation"],"parameters":[{"name":"version","in":"header","description":"Version Number","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"Company ID, obtained through environment variables","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"Random Tracking Code UUID","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"Login Token","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"Language","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"companyId":{"type":"integer","title":"Company ID","description":"Company ID. Environment variable configuration","format":"long"},"customerId":{"type":"integer","title":"Client ID","format":"long","description":"Client ID"},"customerNo":{"type":"string","title":"Client number","description":"Client number"},"ip":{"type":"string","title":"Operation IP","description":"Operation IP","nullable":true},"trace":{"type":"string","title":"Trace number","description":"Trace number","nullable":true},"cardId":{"type":"integer","title":"Card ID","format":"long","description":"Card ID"},"smsSendToken":{"type":"string","title":"SMS verification code sending ticket","description":"SMS verification code sending ticket"},"smsCode":{"type":"string","title":"SMS verification code","description":"SMS verification code"}},"required":["customerNo","cardId","smsSendToken","smsCode","customerId","companyId"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"System universal return code. 0-Success;","title":"System universal return code."},"msg":{"type":"string","title":"Return information","description":"Return information"},"data":{"type":"boolean","title":"Return message body.","description":"Return message body. true-success"}},"title":""}}},"headers":{}}}}}}} ``` ## Set card transaction password > Header Explanation: version=0.0.1 bizType=passToCredit.app.AppCardActiveService.modifyTradePassword ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Credit Card/Operation"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/passToCredit.app.AppCardActiveService.modifyTradePassword":{"post":{"summary":"Set card transaction password","deprecated":false,"description":"Header Explanation: version=0.0.1 bizType=passToCredit.app.AppCardActiveService.modifyTradePassword","tags":["Credit Card/Operation"],"parameters":[{"name":"version","in":"header","description":"Version Number","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"Company ID, obtained through environment variables","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"Random Tracking Code UUID","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"Login Token","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"Language","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"companyId":{"type":"integer","title":"Company ID","description":"Company ID. Environment variable configuration","format":"long"},"customerId":{"type":"integer","title":"Client ID","format":"long","description":"Client ID"},"customerNo":{"type":"string","title":"Client number","description":"Client number"},"ip":{"type":"string","title":"Operation IP","description":"Operation IP","nullable":true},"trace":{"type":"string","title":"Trace number","description":"Trace number","nullable":true},"cardId":{"type":"integer","title":"Card ID","format":"long","description":"Card ID"},"smsSendToken":{"type":"string","title":"SMS verification code sending ticket","description":"SMS verification code sending ticket"},"smsCode":{"type":"string","title":"SMS verification code","description":"SMS verification code"},"password":{"type":"string","title":"Password","description":"Password"},"checkPassword":{"type":"string","title":"Confirm Password","description":"Confirm Password"}},"required":["companyId","customerId","customerNo","cardId","smsSendToken","smsCode","password","checkPassword"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"System universal return code. 0-Success;","title":"System universal return code."},"msg":{"type":"string","title":"Return information","description":"Return information"},"data":{"type":"boolean","title":"Return message body.","description":"Return message body. true-success"}},"title":""}}},"headers":{}}}}}}} ``` ## Set card limit > Header explanation: version=0.0.1 bizType=passToCredit.app.AppCardActiveService.settingCardLimit ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Credit Card/Operation"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/passToCredit.app.AppCardActiveService.settingCardLimit":{"post":{"summary":"Set card limit","deprecated":false,"description":"Header explanation: version=0.0.1 bizType=passToCredit.app.AppCardActiveService.settingCardLimit","tags":["Credit Card/Operation"],"parameters":[{"name":"version","in":"header","description":"Version Number","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"Company ID, obtained through environment variables","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"Random Tracking Code UUID","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"Login Token","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"Language","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"companyId":{"type":"integer","title":"Company ID","description":"Company ID. Environment variable configuration","format":"long"},"customerId":{"type":"integer","title":"Client ID","format":"long","description":"Client ID"},"customerNo":{"type":"string","title":"Client number","description":"Client number"},"ip":{"type":"string","title":"Operation IP","description":"Operation IP","nullable":true},"trace":{"type":"string","title":"Trace number","description":"Trace number","nullable":true},"cardId":{"type":"integer","title":"Card ID","format":"long","description":"Card ID"},"dailyAtmLimit":{"type":"string","title":"Daily withdrawal limit","description":"Daily withdrawal limit"},"dailyPurchaseLimit":{"type":"string","title":"Daily spending limit","description":"Daily spending limit"}},"required":["companyId","customerId","customerNo","cardId"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"System universal return code. 0-Success;","title":"System universal return code."},"msg":{"type":"string","title":"Return information","description":"Return information"},"data":{"type":"boolean","title":"Return message body.","description":"Return message body. true-success"}},"title":""}}},"headers":{}}}}}}} ``` ## Send verification code > Header description: version=0.0.1 bizType=passToCredit.app.AppMessageService.sendVerifyCode ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Credit Card/Operation"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/passToCredit.app.AppMessageService.sendVerifyCode":{"post":{"summary":"Send verification code","deprecated":false,"description":"Header description: version=0.0.1 bizType=passToCredit.app.AppMessageService.sendVerifyCode","tags":["Credit Card/Operation"],"parameters":[{"name":"version","in":"header","description":"Version Number","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"Company ID, obtained through environment variables","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"Random Tracking Code UUID","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"Login Token","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"Language","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"companyId":{"type":"integer","title":"Company ID","description":"Company ID. Environment variable configuration","format":"long"},"customerId":{"type":"integer","title":"Client ID","format":"long","description":"Client ID"},"customerNo":{"type":"string","title":"Client number","description":"Client number"},"ip":{"type":"string","title":"Operation IP","description":"Operation IP","nullable":true},"trace":{"type":"string","title":"Trace number","description":"Trace number","nullable":true},"bizType":{"type":"integer","title":"Business type","description":"Business type: 2-Cancel card; 3-Change card; 4-Lock card; 5-Unlock card; 6-Change transaction password; 7-Get card private information; 8-Activate card;","format":"int32"},"country":{"type":"string","title":"Country Code","description":"Country Code"},"customerGroupId":{"type":"integer","title":"Client Group Number","format":"long","description":"Client Group Number"},"cardId":{"type":"integer","title":"Card ID","format":"long","description":"Card ID"}},"required":["companyId","customerId","customerNo","bizType","country","customerGroupId","cardId"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"System universal return code. 0-Success;","title":"System universal return code."},"msg":{"type":"string","title":"Return information","description":"Return information"},"data":{"type":"object","properties":{"token":{"type":"string","title":"Send ticket","description":"Send ticket"}},"title":"Return message body.","description":"Return message body."}},"title":""}}},"headers":{}}}}}}} ``` ## Batch setting customer subscription method > Header Explanation: version=0.0.1 bizType=passToCredit.app.AppMessageService.batchSettingSubscriptionType ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Credit Card/Operation"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/passToCredit.app.AppMessageService.batchSettingSubscriptionType":{"post":{"summary":"Batch setting customer subscription method","deprecated":false,"description":"Header Explanation: version=0.0.1 bizType=passToCredit.app.AppMessageService.batchSettingSubscriptionType","tags":["Credit Card/Operation"],"parameters":[{"name":"version","in":"header","description":"Version Number","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"Company ID, obtained through environment variables","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"Random Tracking Code UUID","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"Login Token","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"Language","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"companyId":{"type":"string","title":"Company ID","description":"Company ID. Environment variable configuration"},"customerId":{"type":"integer","title":"Client ID","format":"long","description":"Client ID"},"customerNo":{"type":"string","title":"Client number","description":"Client number"},"ip":{"type":"string","title":"Operation IP","description":"Operation IP","nullable":true},"trace":{"type":"string","title":"Trace number","description":"Trace number","nullable":true},"currency":{"type":"string","title":"Currency","description":"Currency","nullable":true},"verifyCodeSubType":{"type":"string","title":"3-D authentication code push method","description":"3-D authentication code push method. Multiple types separated by commas. 1-Email; 2-SMS; 3-WhatsApp; 4-Telegram","nullable":true},"securityVerifyCodeSubType":{"type":"string","title":"Security code push method","description":"Security code push method. Multiple types separated by commas. 1-Email; 2-SMS; 3-WhatsApp; 4-Telegram","nullable":true},"localTransactionSubType":{"type":"string","title":"Local trade message push method","description":"Local trade message push method. Multiple types separated by commas. 1-Email; 2-SMS; 3-WhatsApp; 4-Telegram","nullable":true},"overseasTransactionSubType":{"type":"string","title":"Overseas trading message push method","description":"Overseas trading message push method. Multiple types separated by commas. 1-Email; 2-SMS; 3-WhatsApp; 4-Telegram","nullable":true},"atmWithdrawalSubType":{"type":"string","title":"ATM withdrawal message push method","description":"ATM withdrawal message push method. Multiple types separated by commas. 1-Email; 2-SMS; 3-WhatsApp; 4-Telegram","nullable":true}},"required":["companyId","customerId","customerNo"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"System universal return code. 0-Success;","title":"System universal return code."},"msg":{"type":"string","title":"Return information","description":"Return information"},"data":{"type":"boolean","title":"Return message body.","description":"Return message body. true-success"}},"title":""}}},"headers":{}}}}}}} ``` ## Send WatsApp verification code > Header description: version=0.0.1 bizType=passToCredit.app.AppMessageService.sendWatsAppVerifyCode ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Credit Card/Operation"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/passToCredit.app.AppMessageService.sendWatsAppVerifyCode":{"post":{"summary":"Send WatsApp verification code","deprecated":false,"description":"Header description: version=0.0.1 bizType=passToCredit.app.AppMessageService.sendWatsAppVerifyCode","tags":["Credit Card/Operation"],"parameters":[{"name":"version","in":"header","description":"Version Number","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"Company ID, obtained through environment variables","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"Random Tracking Code UUID","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"Login Token","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"Language","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"companyId":{"type":"integer","title":"Company ID","description":"Company ID. Environment variable configuration","format":"long"},"customerId":{"type":"integer","title":"Client ID","format":"long","description":"Client ID"},"customerNo":{"type":"string","title":"Client number","description":"Client number"},"ip":{"type":"string","title":"Operation IP","description":"Operation IP","nullable":true},"trace":{"type":"string","title":"Trace number","description":"Trace number","nullable":true},"watsAppAccount":{"type":"string","title":"WatsApp account","description":"WatsApp account. If not filled, the old configured account will be used for sending. If no account is configured, an error will be reported"},"country":{"type":"string","title":"Country Code","description":"Country Code"},"customerGroupId":{"type":"integer","title":"Client Group Number","format":"long","description":"Client Group Number"}},"required":["companyId","customerId","customerNo","watsAppAccount","country","customerGroupId"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"System universal return code. 0-Success;","title":"System universal return code."},"msg":{"type":"string","title":"Return information","description":"Return information"},"data":{"type":"object","properties":{"token":{"type":"string","title":"Send ticket","description":"Send ticket"}},"title":"Return message body.","description":"Return message body."}},"title":""}}},"headers":{}}}}}}} ``` ## Modify WatsApp account > Header description: version=0.0.1 bizType=passToCredit.app..AppMessageService.updateWatsAppAccount ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Credit Card/Operation"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/passToCredit.app.AppMessageService.updateWatsAppAccount":{"post":{"summary":"Modify WatsApp account","deprecated":false,"description":"Header description: version=0.0.1 bizType=passToCredit.app..AppMessageService.updateWatsAppAccount","tags":["Credit Card/Operation"],"parameters":[{"name":"version","in":"header","description":"Version Number","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"Company ID, obtained through environment variables","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"Random Tracking Code UUID","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"Login Token","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"Language","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"companyId":{"type":"integer","title":"Company ID","description":"Company ID. Environment variable configuration","format":"long"},"customerId":{"type":"integer","title":"Client ID","format":"long","description":"Client ID"},"customerNo":{"type":"string","title":"Client number","description":"Client number"},"ip":{"type":"string","title":"Operation IP","description":"Operation IP","nullable":true},"trace":{"type":"string","title":"Trace number","description":"Trace number","nullable":true},"watsAppAccount":{"type":"string","title":"WatsApp account","description":"WatsApp account"},"oldWatsAppSendToken":{"type":"string","title":"Old account verification code sending ticket","description":"Old account verification code sending ticket"},"oldWatsAppCode":{"type":"string","title":"Old account verification code","description":"Old account verification code"},"newWatsAppSendToken":{"type":"string","title":"New account verification code sending ticket","description":"New account verification code sending ticket"},"newWatsAppCode":{"type":"string","title":"New account verification code","description":"New account verification code"}},"required":["companyId","customerId","customerNo","watsAppAccount","oldWatsAppSendToken","oldWatsAppCode","newWatsAppSendToken","newWatsAppCode"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"System universal return code. 0-Success;","title":"System universal return code."},"msg":{"type":"string","title":"Return information","description":"Return information"},"data":{"type":"boolean","title":"Return message body.","description":"Return message body. true-success"}},"title":""}}},"headers":{}}}}}}} ``` ## POST /passToCreditUpload > Upload file ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Credit Card/Operation"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/passToCreditUpload":{"post":{"summary":"Upload file","deprecated":false,"description":"","tags":["Credit Card/Operation"],"parameters":[{"name":"companyId","in":"header","description":"Company ID, obtained through environment variables","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"Random Tracking Code UUID","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"Language","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"Login Token","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"object":{"type":"string","format":"binary"},"userPhone":{"type":"string"}},"required":["userPhone"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{}}}},"headers":{}}}}}}} ``` # Credit Card/Query ## Get customer card list > Header explanation: version=0.0.1 bizType=passToCredit.app.AppCardQueryService.queryCardList ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Credit Card/Query"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/passToCredit.app.AppCardQueryService.queryCardList":{"post":{"summary":"Get customer card list","deprecated":false,"description":"Header explanation: version=0.0.1 bizType=passToCredit.app.AppCardQueryService.queryCardList","tags":["Credit Card/Query"],"parameters":[{"name":"version","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"companyId":{"type":"integer","title":"Company ID","description":"Company ID. Environment variable configuration","format":"long"},"customerId":{"type":"integer","title":"Client ID","format":"long","description":"Client ID"},"customerNo":{"type":"string","title":"Client number","description":"Client number"},"ip":{"type":"string","title":"Operation IP","description":"Operation IP","nullable":true},"trace":{"type":"string","title":"Trace number","description":"Trace number","nullable":true}},"required":["companyId","customerId","customerNo"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"System universal return code. 0-Success;","title":"System universal return code."},"msg":{"type":"string","title":"Return information","description":"Return information"},"data":{"type":"object","properties":{"id":{"type":"integer","title":"Card ID","format":"long","description":"Card ID"},"last4":{"type":"string","title":"Last four digits of the card","description":"Last four digits of the card"},"status":{"type":"integer","title":"Card status.","description":"Card status. 1-Card pending activation; 2-Normal; 3-Suspended; 4-Locked; 5-Lost;","format":"int32"},"expiryMonth":{"type":"string","title":"Expiration month","description":"Expiration month"},"expiryYear":{"type":"string","title":"Expiration year","description":"Expiration year"},"embossedName":{"type":"string","title":"Name on the card","description":"Name on the card"},"network":{"type":"string","title":"Card network","description":"Card network"},"type":{"type":"integer","title":"Type.","description":"Type. 1-Platinum;","format":"long"},"typeName":{"type":"string","title":"Type name","description":"Type name"},"typeImageUrl":{"type":"string","title":"Type icon address","description":"Type icon address"},"phoneArea":{"type":"string","title":"Area code","description":"Area code"},"phone":{"type":"string","title":"Phone number","description":"Phone number"},"email":{"type":"string","title":"Email","description":"Email"},"minDailyAtmLimit":{"type":"string","title":"Lower limit of daily withdrawal limit","description":"Lower limit of daily withdrawal limit"},"maxDailyAtmLimit":{"type":"string","title":"Upper limit of daily withdrawal limit","description":"Upper limit of daily withdrawal limit"},"minDailyPurchaseLimit":{"type":"string","title":"Lower limit of daily spending limit","description":"Lower limit of daily spending limit"},"maxDailyPurchaseLimit":{"type":"string","title":"Daily consumption limit upper limit","description":"Daily consumption limit upper limit"},"customDailyAtmLimit":{"type":"string","title":"Customer sets daily withdrawal limit","description":"Customer sets daily withdrawal limit"},"customDailyPurchaseLimit":{"type":"string","title":"Customer sets daily consumption limit","description":"Customer sets daily consumption limit"},"physicalCard":{"type":"string","title":"Physical card or not","description":"Physical card or not. true-physical card; false-virtual card"},"thirdPartyCardAccountId":{"type":"string","title":"Third-party card account ID","description":"Third-party card account ID"},"thirdPartyAccountId":{"type":"string","title":"Third-party account ID","description":"Third-party account ID"},"firstName":{"type":"string","title":"firstName","description":"firstName"},"lastName":{"type":"string","title":"lastName","description":"lastName"},"kycPno":{"type":"string","title":"KYC proposal number","description":"KYC proposal number"},"feesUnpaid":{"type":"string","title":"Pending fees","description":"Pending fees"},"timeout":{"type":"string","title":"Deadline for pending fees","description":"Deadline for pending fees. 13-digit timestamp"},"thirdPartyAccountNumber":{"type":"string","title":"Third-party account code","description":"Third-party account code"}},"title":"Return message body.","description":"Return message body."}},"title":""}}},"headers":{}}}}}}} ``` ## Query card sensitive information > Header description: version=0.0.1 bizType=passToCredit.app.AppCardQueryService.getCardSensitiveInfo ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Credit Card/Query"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/passToCredit.app.AppCardQueryService.getCardSensitiveInfo":{"post":{"summary":"Query card sensitive information","deprecated":false,"description":"Header description: version=0.0.1 bizType=passToCredit.app.AppCardQueryService.getCardSensitiveInfo","tags":["Credit Card/Query"],"parameters":[{"name":"version","in":"header","description":"Version Number","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"Company ID, obtained through environment variables","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"Random Tracking Code UUID","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"Login Token","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"Language","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"companyId":{"type":"integer","title":"Company ID","description":"Company ID. Environment variable configuration","format":"long"},"customerId":{"type":"integer","title":"Client ID","format":"long","description":"Client ID"},"customerNo":{"type":"string","title":"Client number","description":"Client number"},"ip":{"type":"string","title":"Operation IP","description":"Operation IP"},"trace":{"type":"string","title":"Trace number","description":"Trace number","nullable":true},"cardId":{"type":"integer","title":"Card ID","format":"long","description":"Card ID"}},"required":["companyId","customerId","customerNo","cardId","ip"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"System universal return code. 0-Success;","title":"System universal return code."},"msg":{"type":"string","title":"Return information","description":"Return information"},"data":{"type":"object","properties":{"cardNumber":{"type":"string","title":"Card number","description":"Card number"},"expiryMonth":{"type":"string","title":"Expiration month","description":"Expiration month"},"expiryYear":{"type":"string","title":"Expiration year","description":"Expiration year"},"securityCode":{"type":"string","title":"Password (CVV)","description":"Password (CVV)"}},"title":"Return message body.","description":"Return message body."}},"title":""}}},"headers":{}}}}}}} ``` ## Get customer application card proposal list > Header description: version=0.0.1 bizType=passToCredit.app.AppCardQueryService.queryApplyCardProposalList ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Credit Card/Query"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/passToCredit.app.AppCardQueryService.queryApplyCardProposalList":{"post":{"summary":"Get customer application card proposal list","deprecated":false,"description":"Header description: version=0.0.1 bizType=passToCredit.app.AppCardQueryService.queryApplyCardProposalList","tags":["Credit Card/Query"],"parameters":[{"name":"version","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"companyId":{"type":"integer","title":"Company ID","description":"Company ID. Environment variable configuration","format":"long"},"customerId":{"type":"integer","title":"Client ID","format":"long","description":"Client ID"},"customerNo":{"type":"string","title":"Client number","description":"Client number"},"ip":{"type":"string","title":"Operation IP","description":"Operation IP","nullable":true},"trace":{"type":"string","title":"Trace number","description":"Trace number","nullable":true},"queryStatus":{"type":"string","title":"Filter status","description":"Filter status (1-Pending KYC review; 2-Pending third-party confirmation; 3-Card issuance in progress; 4-Completed; 5-Rejected;). Multiple statuses separated by commas|","nullable":true}},"required":["companyId","customerId","customerNo"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"System universal return code. 0-Success;","title":"System universal return code."},"msg":{"type":"string","title":"Return information","description":"Return information"},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","title":"Proposal ID","format":"long","description":"Proposal ID"},"revision":{"type":"string","title":"Optimistic lock","description":"Optimistic lock"},"createBy":{"type":"string","title":"Creator","description":"Creator"},"createTime":{"type":"integer","title":"Creation time","format":"long","description":"Creation time"},"updateBy":{"type":"string","title":"Updater","description":"Updater"},"updateTime":{"type":"integer","title":"Update Time","format":"long","description":"Update Time"},"companyId":{"type":"integer","title":"Company ID","format":"long","description":"Company ID"},"customerId":{"type":"integer","title":"Client ID","format":"long","description":"Client ID"},"customerNo":{"type":"string","title":"Client number","description":"Client number"},"status":{"type":"integer","title":"Status","description":"Status. 1-Pending KYC review; 2-Pending deposit; 3-Card production; 4-Dispatched; 5-Rejected; 6-Expired; 7-Card activation failed;","format":"int32"},"type":{"type":"integer","title":"Card Type","description":"Card Type. 1-Platinum;","format":"int32"},"applyCurrency":{"type":"string","title":"Application Currency","description":"Application Currency"},"remark":{"type":"string","title":"Remarks","description":"Remarks"},"firstName":{"type":"string","title":"firstName","description":"firstName"},"lastName":{"type":"string","title":"lastName","description":"lastName"},"kycPno":{"type":"string","title":"KYC Proposal Number","description":"KYC Proposal Number"},"openCardTargetAmount":{"type":"string","title":"Card Activation Target Amount","description":"Card Activation Target Amount. Same as application card currency"},"alreadyDepositAmount":{"type":"string","title":"Deposited Amount","description":"Deposited Amount. Same as application card currency"},"kycSubmitTime":{"type":"integer","title":"KYC Submission Time","description":"KYC Submission Time. 13-digit timestamp","format":"long"},"kycApproveTime":{"type":"integer","title":"KYC Approval Time","description":"KYC Approval Time. 13-digit timestamp","format":"long"},"timeout":{"type":"integer","format":"long","title":"Timeout Time","description":"Timeout Time. When reaching the timeout time, the account balance will be reclaimed. 13-digit timestamp"},"warningTime":{"type":"integer","format":"long","title":"Warning Time","description":"Warning time. When the warning time is reached, remind the customer to re-upload KYC information. 13-digit timestamp"},"fee":{"type":"string","title":"Virtual card opening fee","description":"Card issuance fee"},"entityFee":{"type":"string","title":"Physical card opening fee","description":"Postage"},"applyEntity":{"type":"boolean","title":"Apply for physical card","description":"Whether to apply for a physical card. true-apply for a physical card; false-do not apply for a physical card"},"address":{"type":"string","title":"Address","description":"Address"},"postalCode":{"type":"string","title":"Postal code","description":"Postal code"},"mailingCountry":{"type":"string","title":"Country/Region code","description":"Country/Region code"},"mailingProvince":{"type":"string","title":"State/Province code","description":"State/Province code"},"mailingCity":{"type":"string","title":"City code","description":"City code"},"mailingAddress":{"type":"string","title":"Detailed address","description":"Detailed address"}},"title":"Return message body."},"title":"","description":"Return message body."}},"title":""}}},"headers":{}}}}}}} ``` ## Query customer list (for agent backend use) > version=0.0.1\ > bizType=passToCredit.app.AppCardQueryService.queryCustomerOfAgentPage\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Credit Card/Query"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/passToCredit.app.AppCardQueryService.queryCustomerOfAgentPage":{"post":{"summary":"Query customer list (for agent backend use)","deprecated":false,"description":"version=0.0.1\nbizType=passToCredit.app.AppCardQueryService.queryCustomerOfAgentPage\nAccessible after login","operationId":"applyApi","tags":["Credit Card/Query"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"current":{"type":"integer","description":"Current Page"},"size":{"type":"integer","description":"Number of Items per Page"},"last4Phone":{"type":"string","title":"Last four digits of the number","description":"Last four digits of the number"},"name":{"type":"string","title":"Name","description":"Name"},"selectCustomerNo":{"type":"string","title":"Filter customer number","description":"Filter customer number"},"openCardStartTime":{"type":"integer","format":"long","title":"Card issuance time - start time","description":"Card issuance time - start time"},"openCardEndTime":{"type":"integer","format":"long","title":"Card issuance time - end time","description":"Card issuance time - end time"},"last4":{"type":"string","title":"Last four digits of the card","description":"Last four digits of the card"},"firstRegisterTimeFrom":{"type":"integer","title":"First registration time - start time","format":"long","description":"First registration time - start time"},"firstRegisterTimeTo":{"type":"integer","title":"First registration time - end time","format":"long","description":"First registration time - end time"}},"required":["size","current"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"Status return code","title":"Status return code"},"msg":{"type":"string","description":"Status description","title":"Status description"},"tm":{"type":"integer","format":"int64","description":"Processing time (milliseconds)","title":"Processing time (milliseconds)"},"trace":{"type":"string","description":"Tracking code","title":"Tracking code"},"data":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Primary key id"},"createTime":{"type":"integer","description":"Creation time"},"updateTime":{"type":"integer","description":"Update Time"},"customerGroupId":{"type":"integer","description":"Customer group ID"},"customerGroupName":{"type":"string","description":"Customer Group Name"},"status":{"type":"integer","description":"Customer Status, 1 Normal, 2 Disabled, 3 Deleted, 4 Closed Account, 5 Locked, 6 Closing Account"},"companyId":{"type":"integer","description":"Company ID"},"customerNo":{"type":"string","description":"Client number"},"phone":{"type":"string","description":"Phone Number"},"phoneArea":{"type":"string","description":"Phone area code"},"registerSource":{"type":"integer","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"},"unitId":{"type":"integer","description":"Organization ID"},"firstName":{"type":"string","description":"First name"},"lastName":{"type":"string","description":"Last name"},"email":{"type":"string","description":"Email"},"customerType":{"type":"integer","description":"Customer Type 0 Default 1 Agent"},"cardNumber":{"type":"string","description":"Credit card number","title":"Card number"},"openCardTime":{"type":"integer","format":"long","title":"Card issuance time","description":"Card issuance time"}},"required":["id","createTime","updateTime","customerGroupId","customerGroupName","status","companyId","customerNo","phone","phoneArea","registerSource","unitId","firstName","lastName","email","customerType"]},"description":"Data List"},"total":{"type":"integer","description":"Total"},"size":{"type":"integer","description":"Page Size"},"current":{"type":"integer","description":"Current Page"}},"required":["records","total","size","current"],"description":"Paging Data Body","title":"Paging Data Body"},"fail":{"type":"boolean"},"ok":{"type":"boolean"},"bizCode":{"type":"string","description":"Module identifier code","title":"Module identifier code"},"msgParams":{"type":"string","description":"Placeholder parameter string in return description, multiple parameters separated by commas","title":"Placeholder parameter string in return description, multiple parameters separated by commas"}},"required":["code","msg","tm","trace","data","fail","ok"]}}},"headers":{}}}}}}} ``` ## Pagination query account transaction records > Header description: version=0.0.1 bizType=passToCredit.app.AppCardQueryService.queryAccountTransactionRecordPage ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Credit Card/Query"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/passToCredit.app.AppCardQueryService.queryAccountTransactionRecordPage":{"post":{"summary":"Pagination query account transaction records","deprecated":false,"description":"Header description: version=0.0.1 bizType=passToCredit.app.AppCardQueryService.queryAccountTransactionRecordPage","tags":["Credit Card/Query"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"companyId":{"type":"integer","title":"Company ID","description":"Company ID. Environment variable configuration","format":"long"},"customerId":{"type":"integer","title":"Client ID","format":"long","description":"Client ID"},"customerNo":{"type":"string","title":"Client number","description":"Client number"},"ip":{"type":"string","title":"Operation IP","description":"Operation IP","nullable":true},"trace":{"type":"string","title":"Trace number","description":"Trace number","nullable":true},"current":{"type":"integer","title":"Current Page","description":"Current page. Default is 1","format":"long"},"size":{"type":"integer","title":"Number of Items per Page","description":"Number of items per page. Default is 20","format":"long"},"queryStatus":{"type":"string","title":"Filter status","description":"Filter status (1-Pending; 2-Published; 3-Rejected; 4-Invalid;). Multiple statuses separated by commas","nullable":true},"queryTypes":{"type":"string","description":"Filter type (1-Charge; 2-Refund; 3-Recharge; 4-Repayment; 5-Cashback; 6-Interest; 7-Fee; 8-Other; 9-Card fee; 10-Postage fee; 11-Mortgage; 12-Mortgage handling fee; 13-Capital injection; 14-Cash feedback; 15-Other; 16-Administrative expenses; 17-Transfer_Card fee; 18-Transfer_Mortgage;). Multiple types separated by commas","title":"Filter Type"},"createdAtStartTime":{"type":"integer","title":"Create Trade - Start Time","format":"long","description":"Create Trade - Start Time","nullable":true},"createdAtEndTime":{"type":"integer","title":"Create Trade - End Time","format":"long","description":"Create Trade - End Time","nullable":true},"postedAtStartTime":{"type":"integer","title":"Complete Trade - Start Time","format":"long","description":"Complete Trade - Start Time","nullable":true},"postedAtEndTime":{"type":"integer","title":"Complete Trade - End Time","format":"long","description":"Complete Trade - End Time","nullable":true},"cardId":{"type":"integer","title":"Card ID","format":"long","description":"Card ID","nullable":true},"operateType":{"type":"integer","format":"int32","title":"Operation Type","description":"Operation Type. 1-Debit; 2-Credit;","nullable":true}},"required":["companyId","customerId","customerNo","queryTypes"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"System universal return code. 0-Success;","title":"System universal return code."},"msg":{"type":"string","title":"Return information","description":"Return information"},"data":{"type":"object","properties":{"current":{"type":"integer","title":"Current Page","format":"long","description":"Current Page"},"size":{"type":"integer","title":"Number of Items per Page","format":"long","description":"Number of Items per Page"},"total":{"type":"integer","title":"Total","format":"long","description":"Total"},"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","title":"Trade ID","format":"long","description":"Trade ID"},"revision":{"type":"string","title":"Optimistic lock","description":"Optimistic lock"},"createBy":{"type":"string","title":"Creator","description":"Creator"},"createTime":{"type":"integer","title":"Creation time","format":"long","description":"Creation time"},"updateBy":{"type":"string","title":"Updater","description":"Updater"},"updateTime":{"type":"integer","title":"Update Time","format":"long","description":"Update Time"},"companyId":{"type":"integer","title":"Company ID","format":"long","description":"Company ID"},"customerId":{"type":"integer","title":"Client ID","format":"long","description":"Client ID"},"customerNo":{"type":"string","title":"Customer Code","description":"Customer Code"},"transactionId":{"type":"string","title":"Third Party Trade ID","description":"Third Party Trade ID"},"refId":{"type":"string","title":"Third Party Related ID","description":"Third Party Related ID"},"cardId":{"type":"integer","title":"Card ID","format":"long","description":"Card ID"},"last4":{"type":"string","title":"Last four digits of the card","description":"Last four digits of the card"},"accountId":{"type":"integer","title":"Account ID","format":"long","description":"Account ID"},"createdAt":{"type":"integer","title":"Trade Initiation Time","description":"Trade Initiation Time. 13-digit timestamp","format":"long"},"status":{"type":"integer","title":"Status","description":"Status. 1-Pending; 2-Published; 3-Rejected; 4-Invalid;","format":"int32"},"postedAt":{"type":"integer","title":"Debit Time","description":"Debit Time. 13-digit timestamp","format":"long"},"type":{"type":"integer","title":"Trade Type","description":"Trade Type. 1-Charge; 2-Refund; 3-Top-up; 4-Repayment; 5-Cashback; 6-Interest; 7-Fee; 8-Other; 9-Card Fee; 10-Postage Fee; 11-Mortgage; 12-Mortgage Handling Fee; 13-Capital Injection; 14-Cash Rebate; 15-Other; 16-Administrative Expenses; 17-Transfer_Card Fee; 18-Transfer_Mortgage;","format":"int32"},"merchantName":{"type":"string","title":"Merchant Name","description":"Merchant Name"},"merchantMcc":{"type":"string","title":"Merchant MCC Code","description":"Merchant MCC Code"},"merchantCategory":{"type":"string","title":"Merchant Ownership Type","description":"Merchant Ownership Type"},"currency":{"type":"string","title":"Application Currency","description":"Application Currency"},"amount":{"type":"string","title":"Transaction Amount","description":"Transaction Amount."},"remark":{"type":"string","title":"Remarks","description":"Remarks"},"operateType":{"type":"integer","title":"Operation Type","description":"Operation Type. 1-Debit; 2-Credit;","format":"int32"},"country":{"type":"string","title":"Country Code","description":"Country Code"},"sourceAmount":{"type":"string","title":"Original Transaction Amount","description":"Original Transaction Amount"},"sourceCurrency":{"type":"string","title":"Original Transaction Currency","description":"Original Transaction Currency"},"activeType":{"type":"string","title":"Execution Type","description":"Execution Type. PURCHASE-Transaction; ATM-ATM Withdrawal;"}}},"title":"Result list","description":"Result list"}},"title":"Return message body.","description":"Return message body."}},"title":""}}},"headers":{}}}}}}} ``` ## Query customer message push method > Header description: version=0.0.1 bizType=passToCredit.app.AppMessageService.queryCustomerNoticeSubscription ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Credit Card/Query"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/passToCredit.app.AppMessageService.queryCustomerNoticeSubscription":{"post":{"summary":"Query customer message push method","deprecated":false,"description":"Header description: version=0.0.1 bizType=passToCredit.app.AppMessageService.queryCustomerNoticeSubscription","tags":["Credit Card/Query"],"parameters":[{"name":"version","in":"header","description":"Version Number","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"Company ID, obtained through environment variables","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"Random Tracking Code UUID","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"Login Token","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"Language","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"companyId":{"type":"integer","title":"Company ID","description":"Company ID. Environment variable configuration","format":"long"},"customerId":{"type":"integer","title":"Client ID","format":"long","description":"Client ID"},"customerNo":{"type":"string","title":"Client number","description":"Client number"},"ip":{"type":"string","title":"Operation IP","description":"Operation IP","nullable":true},"trace":{"type":"string","title":"Trace number","description":"Trace number","nullable":true},"currency":{"type":"string","title":"Currency","description":"Currency","nullable":true}},"required":["companyId","customerId","customerNo"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"System universal return code. 0-Success;","title":"System universal return code."},"msg":{"type":"string","title":"Return information","description":"Return information"},"data":{"type":"object","properties":{"subscriptionTo":{"type":"string","title":"Message push account","description":"Message push account. JSON format, key is the push type"},"verifyCodeSubType":{"type":"string","title":"3-D authentication code push method","description":"3-D authentication code push method. Multiple types separated by commas. 1-Email; 2-SMS; 3-WhatsApp; 4-Telegram"},"securityVerifyCodeSubType":{"type":"string","title":"Security code push method","description":"Security code push method. Multiple types separated by commas. 1-Email; 2-SMS; 3-WhatsApp; 4-Telegram"},"localTransactionSubType":{"type":"string","title":"Local trade message push method","description":"Local trade message push method. Multiple types separated by commas. 1-Email; 2-SMS; 3-WhatsApp; 4-Telegram"},"overseasTransactionSubType":{"type":"string","title":"Overseas trading message push method","description":"Overseas trading message push method. Multiple types separated by commas. 1-Email; 2-SMS; 3-WhatsApp; 4-Telegram"},"atmWithdrawalSubType":{"type":"string","title":"ATM withdrawal message push method","description":"ATM withdrawal message push method. Multiple types separated by commas. 1-Email; 2-SMS; 3-WhatsApp; 4-Telegram"}},"title":"Return message body.","description":"Return message body."}},"title":""}}},"headers":{}}}}}}} ``` ## Query customer's method & information for sending verification code > Header Explanation: version=0.0.1 bizType=passToCredit.app.AppMessageService.querySendVerifyCodeInfo ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Credit Card/Query"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/passToCredit.app.AppMessageService.querySendVerifyCodeInfo":{"post":{"summary":"Query customer's method & information for sending verification code","deprecated":false,"description":"Header Explanation: version=0.0.1 bizType=passToCredit.app.AppMessageService.querySendVerifyCodeInfo","tags":["Credit Card/Query"],"parameters":[{"name":"version","in":"header","description":"Version Number","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"Company ID, obtained through environment variables","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"Random Tracking Code UUID","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"Login Token","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"Language","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"companyId":{"type":"integer","title":"Company ID","description":"Company ID. Environment variable configuration","format":"long"},"customerId":{"type":"integer","title":"Client ID","format":"long","description":"Client ID"},"customerNo":{"type":"string","title":"Client number","description":"Client number"},"ip":{"type":"string","title":"Operation IP","description":"Operation IP","nullable":true},"trace":{"type":"string","title":"Trace number","description":"Trace number","nullable":true},"bizType":{"type":"integer","title":"Business type","description":"Business type: 2-Cancel card; 3-Change card; 4-Lock card; 5-Unlock card; 6-Change transaction password; 7-Get card private information; 8-Activate card;","format":"int32"},"sendType":{"type":"integer","title":"Send Type","description":"Send Type. 1-Email; 2-SMS; 3-WhatsApp","format":"int32"},"country":{"type":"string","title":"Country Code","description":"Country Code"},"customerGroupId":{"type":"integer","title":"Client Group Number","format":"long","description":"Client Group Number"},"cardId":{"type":"integer","title":"Card ID","format":"long","description":"Card ID"}},"required":["companyId","customerId","customerNo","bizType","sendType","country","customerGroupId","cardId"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"System universal return code. 0-Success;","title":"System universal return code."},"msg":{"type":"string","title":"Return information","description":"Return information"},"data":{"type":"object","properties":{"sendType":{"type":"string","title":"Send Type","description":"Send Type. 1-Email; 2-SMS; 3-WhatsApp"},"sendTo":{"type":"string","title":"Send Account","description":"Send Account"}},"title":"Return message body.","description":"Return message body."}},"title":""}}},"headers":{}}}}}}} ``` ## Query account transaction records > Header description: version=0.0.1 bizType=passToCredit.app.AppCardQueryService.queryAccountTransactionRecordList ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Credit Card/Query"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/passToCredit.app.AppCardQueryService.queryAccountTransactionRecordList":{"post":{"summary":"Query account transaction records","deprecated":false,"description":"Header description: version=0.0.1 bizType=passToCredit.app.AppCardQueryService.queryAccountTransactionRecordList","tags":["Credit Card/Query"],"parameters":[{"name":"version","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"companyId":{"type":"integer","title":"Company ID","description":"Company ID. Environment variable configuration","format":"long"},"customerId":{"type":"integer","title":"Client ID","format":"long","description":"Client ID"},"customerNo":{"type":"string","title":"Client number","description":"Client number"},"ip":{"type":"string","title":"Operation IP","description":"Operation IP","nullable":true},"trace":{"type":"string","title":"Trace number","description":"Trace number","nullable":true},"current":{"type":"integer","title":"Current Page","description":"Current page. Default is 1","format":"long"},"size":{"type":"integer","title":"Number of Items per Page","description":"Number of items per page. Default is 20","format":"long"},"queryStatus":{"type":"string","title":"Filter status","description":"Filter status (1-Pending; 2-Published; 3-Rejected; 4-Invalid;). Multiple statuses separated by commas","nullable":true},"queryTypes":{"type":"string","description":"Filter type (1-charge; 2-refund; 3-recharge; 4-repayment; 5-cashback; 6-interest; 7-fees; 8-other; 9-card issuance fee; 10-postage fee; 11-original mortgage; 12-mortgage handling fee; 13-capital injection; 14-cash feedback; 15-other; 16-administrative expenses; 17-transfer_card fee; 18-transfer_mortgage; 19-cancel card fee; 20-annual fee; 21-local consumption; 22-out-of-town consumption; 23-local ATM withdrawal; 24-out-of-town ATM withdrawal; Special logic [-1=mortgage query (11, 13, 18)]). Multiple statuses are separated by commas","title":"Filter Type"},"createdAtStartTime":{"type":"integer","title":"Create Trade - Start Time","format":"long","description":"Create Trade - Start Time","nullable":true},"createdAtEndTime":{"type":"integer","title":"Create Trade - End Time","format":"long","description":"Create Trade - End Time","nullable":true},"postedAtStartTime":{"type":"integer","title":"Complete Trade - Start Time","format":"long","description":"Complete Trade - Start Time","nullable":true},"postedAtEndTime":{"type":"integer","title":"Complete Trade - End Time","format":"long","description":"Complete Trade - End Time","nullable":true},"cardId":{"type":"integer","title":"Card ID","format":"long","description":"Card ID","nullable":true}},"required":["companyId","customerId","customerNo","queryTypes"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"System universal return code. 0-Success;","title":"System universal return code."},"msg":{"type":"string","title":"Return information","description":"Return information"},"data":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","title":"Trade ID","format":"long","description":"Trade ID"},"revision":{"type":"string","title":"Optimistic lock","description":"Optimistic lock"},"createBy":{"type":"string","title":"Creator","description":"Creator"},"createTime":{"type":"integer","title":"Creation time","format":"long","description":"Creation time"},"updateBy":{"type":"string","title":"Updater","description":"Updater"},"updateTime":{"type":"integer","title":"Update Time","format":"long","description":"Update Time"},"companyId":{"type":"integer","title":"Company ID","format":"long","description":"Company ID"},"customerId":{"type":"integer","title":"Client ID","format":"long","description":"Client ID"},"customerNo":{"type":"string","title":"Customer Code","description":"Customer Code"},"transactionId":{"type":"string","title":"Third Party Trade ID","description":"Third Party Trade ID"},"refId":{"type":"string","title":"Third Party Related ID","description":"Third Party Related ID"},"cardId":{"type":"integer","title":"Card ID","format":"long","description":"Card ID"},"last4":{"type":"string","title":"Last four digits of the card","description":"Last four digits of the card"},"accountId":{"type":"integer","title":"Account ID","format":"long","description":"Account ID"},"createdAt":{"type":"integer","title":"Trade Initiation Time","description":"Trade Initiation Time. 13-digit timestamp","format":"long"},"status":{"type":"integer","title":"Status","description":"Status. 1-Pending; 2-Published; 3-Rejected; 4-Invalid;","format":"int32"},"postedAt":{"type":"integer","title":"Debit Time","description":"Debit Time. 13-digit timestamp","format":"long"},"type":{"type":"integer","title":"Trade Type","description":"Trade Type. 1-Charge; 2-Refund; 3-Top-up; 4-Repayment; 5-Cashback; 6-Interest; 7-Fee; 8-Other; 9-Card Fee; 10-Postage Fee; 11-Mortgage; 12-Mortgage Handling Fee; 13-Capital Injection; 14-Cash Rebate; 15-Other; 16-Administrative Expenses; 17-Transfer_Card Fee; 18-Transfer_Mortgage;","format":"int32"},"merchantName":{"type":"string","title":"Merchant Name","description":"Merchant Name"},"merchantMcc":{"type":"string","title":"Merchant MCC Code","description":"Merchant MCC Code"},"merchantCategory":{"type":"string","title":"Merchant Ownership Type","description":"Merchant Ownership Type"},"currency":{"type":"string","title":"Application Currency","description":"Application Currency"},"amount":{"type":"string","title":"Transaction Amount","description":"Transaction Amount"},"remark":{"type":"string","title":"Remarks","description":"Remarks"},"operateType":{"type":"integer","title":"Operation Type","description":"Operation type.1-Inbound; 2-Outbound;","format":"int32"},"country":{"type":"string","title":"Country Code","description":"Country Code"},"sourceAmount":{"type":"string","title":"Original Transaction Amount","description":"Original Transaction Amount"},"sourceCurrency":{"type":"string","title":"Original Transaction Currency","description":"Original Transaction Currency"},"activeType":{"type":"string","title":"Execution Type","description":"Execution Type. PURCHASE-Transaction; ATM-ATM Withdrawal;"}}},"title":"Result list","description":"Result list"}},"title":"Return message body.","description":"Return message body."}},"title":""}}},"headers":{}}}}}}} ``` ## Query the total number of account transaction records for the month > Header Description: version=0.0.1 bizType=passToCredit.app.AppCardQueryService.queryAccountTransactionRecordMonthTotal ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Credit Card/Query"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/passToCredit.app.AppCardQueryService.queryAccountTransactionRecordMonthTotal":{"post":{"summary":"Query the total number of account transaction records for the month","deprecated":false,"description":"Header Description: version=0.0.1 bizType=passToCredit.app.AppCardQueryService.queryAccountTransactionRecordMonthTotal","tags":["Credit Card/Query"],"parameters":[{"name":"version","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"companyId":{"type":"integer","title":"Company ID","description":"Company ID. Environment variable configuration","format":"long"},"customerId":{"type":"integer","title":"Client ID","format":"long","description":"Client ID"},"customerNo":{"type":"string","title":"Client number","description":"Client number"},"ip":{"type":"string","title":"Operation IP","description":"Operation IP","nullable":true},"trace":{"type":"string","title":"Trace number","description":"Trace number","nullable":true},"current":{"type":"integer","title":"Current Page","description":"Current page. Default is 1","format":"long"},"size":{"type":"integer","title":"Number of Items per Page","description":"Number of items per page. Default is 20","format":"long"},"queryStatus":{"type":"string","title":"Filter status","description":"Filter status (1-Pending; 2-Published; 3-Rejected; 4-Invalid;). Multiple statuses separated by commas","nullable":true},"queryTypes":{"type":"string","description":"Filter type (1-Charge; 2-Refund; 3-Recharge; 4-Repayment; 5-Cashback; 6-Interest; 7-Fee; 8-Other; 9-Card fee; 10-Postage fee; 11-Mortgage; 12-Mortgage handling fee; 13-Capital injection; 14-Cash feedback; 15-Other; 16-Administrative expenses; 17-Transfer_Card fee; 18-Transfer_Mortgage;). Multiple types separated by commas","title":"Filter Type"},"createdAtStartTime":{"type":"integer","title":"Create Trade - Start Time","format":"long","description":"Create Trade - Start Time","nullable":true},"createdAtEndTime":{"type":"integer","title":"Create Trade - End Time","format":"long","description":"Create Trade - End Time","nullable":true},"postedAtStartTime":{"type":"integer","title":"Complete Trade - Start Time","format":"long","description":"Complete Trade - Start Time","nullable":true},"postedAtEndTime":{"type":"integer","title":"Complete Trade - End Time","format":"long","description":"Complete Trade - End Time","nullable":true},"cardId":{"type":"integer","title":"Card ID","format":"long","description":"Card ID","nullable":true}},"required":["companyId","customerId","customerNo","queryTypes"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"System universal return code. 0-Success;","title":"System universal return code."},"msg":{"type":"string","title":"Return information","description":"Return information"},"data":{"type":"object","properties":{"postedTotalAmount":{"type":"string","title":"Confirmed Total Amount","description":"Confirmed Total Amount"},"totalAmount":{"type":"string","title":"Total Amount","description":"Total Amount"},"pendingTotalAmount":{"type":"string","title":"Pending Confirmation Total Amount","description":"Pending Confirmation Total Amount"},"recordList":{"type":"object","properties":{"date":{"type":"string","title":"Date","description":"Date"},"postedTotalAmount":{"type":"string","title":"Confirmed Total Amount","description":"Confirmed Total Amount"},"totalAmount":{"type":"string","title":"Total Amount","description":"Total Amount"},"total":{"type":"string","title":"Total Number of Entries","description":"Total Number of Entries"},"pendingTotalAmount":{"type":"string","title":"Pending Confirmation Total Amount","description":"Pending Confirmation Total Amount"}},"title":"Monthly Record List","description":"Monthly Record List"}},"title":"Return message body.","description":"Return message body."}},"title":""}}},"headers":{}}}}}}} ``` ## Get Mortgage Currency Exchange Rate > bizType=passToCredit.app.AppRateDubboService.findDepositExchangeRate\ > version = 0.0.1\ > Get Mortgage Currency Exchange Rate\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Credit Card/Query"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/passToCredit.app.AppRateDubboService.findDepositExchangeRate":{"post":{"summary":"Get Mortgage Currency Exchange Rate","deprecated":false,"description":"bizType=passToCredit.app.AppRateDubboService.findDepositExchangeRate\nversion = 0.0.1\nGet Mortgage Currency Exchange Rate\nAccessible after login","operationId":"getDepositExchangeRate","tags":["Credit Card/Query"],"parameters":[{"name":"version","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"sourceCurrency":{"type":"string","description":"Source Currency Code"},"targetCurrency":{"type":"string","description":"Target Currency Code"}},"required":["sourceCurrency","targetCurrency"]}}}},"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":{"sourceCurrency":{"type":"string","description":"Payment Currency Code"},"targetCurrency":{"type":"string","description":"Account Currency Code"},"exchangeRate":{"type":"string","description":"Exchange Rate"},"formulaSymbol":{"type":"string","description":"Exchange Rate Direction, multiply-multiply, divide-divide"},"sourceDigits":{"type":"string","description":"Original Currency Asset Decimal Places"},"targetDigits":{"type":"string","description":"Target Currency Asset Decimal Places"},"exchangeRateDigits":{"type":"string","description":"Exchange rate decimal places"},"rateRangeLevelList":{"type":"array","items":{"type":"string"},"description":"Source Exchange Rate Interval Level Information"}},"required":["exchangeRate","formulaSymbol","sourceDigits","targetDigits","exchangeRateDigits"]},"ok":{"type":"boolean"},"fail":{"type":"boolean"}}}}},"headers":{}}}}}}} ``` ## Query Card Type Information > Header Explanation: version=0.0.1 bizType=passToCredit.app.AppCardQueryService.queryCardTypeInfo ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Credit Card/Query"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/passToCredit.app.AppCardQueryService.queryCardTypeInfo":{"post":{"summary":"Query Card Type Information","deprecated":false,"description":"Header Explanation: version=0.0.1 bizType=passToCredit.app.AppCardQueryService.queryCardTypeInfo","tags":["Credit Card/Query"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"companyId":{"type":"integer","format":"long","title":"Company ID","description":"Company ID"},"ip":{"type":"string","title":"Operation IP","description":"Operation IP","nullable":true},"trace":{"type":"string","title":"Trace number","description":"Trace number","nullable":true},"type":{"type":"integer","format":"int32","title":"Apply card type.","description":"Apply card type. 1-Platinum;"},"applyCurrency":{"type":"string","description":"Apply for card currency. Default HKD (only support \"HKD\")","title":"Apply card currency."},"customerNo":{"type":"string","title":"Client number","description":"Client number"},"cardId":{"type":"integer","format":"long","title":"Card Id","description":"Card Id","nullable":true}},"required":["companyId","type","applyCurrency","customerNo"]}}}},"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":{"fee":{"type":"string","title":"Apply for virtual card fee","description":"Apply for card fee"},"entityFee":{"type":"string","title":"Apply for physical card fee","description":"Mailing fee"},"minDailyAtmLimit":{"type":"string","title":"Lower limit of daily withdrawal limit","description":"Lower limit of daily withdrawal limit"},"maxDailyAtmLimit":{"type":"string","title":"Upper limit of daily withdrawal limit","description":"Upper limit of daily withdrawal limit"},"minDailyPurchaseLimit":{"type":"string","title":"Lower limit of daily spending limit","description":"Lower limit of daily spending limit"},"maxDailyPurchaseLimit":{"type":"string","title":"Daily consumption limit upper limit","description":"Daily consumption limit upper limit"},"minDailyAtmLimitOfEntity":{"type":"string","title":"Physical card daily withdrawal limit lower limit","description":"Physical card daily withdrawal limit lower limit"},"maxDailyAtmLimitOfEntity":{"type":"string","title":"Physical card daily withdrawal limit upper limit","description":"Physical card daily withdrawal limit upper limit"},"minDailyPurchaseLimitOfEntity":{"type":"string","title":"Physical card daily consumption limit lower limit","description":"Physical card daily consumption limit lower limit"},"maxDailyPurchaseLimitOfEntity":{"type":"string","title":"Physical card daily consumption limit upper limit","description":"Physical card daily consumption limit upper limit"}},"title":"Data Body","description":"Data Body"}}}}},"headers":{}}}}}}} ``` ## Resend one-time password setting link > Header Description: version=0.0.1 bizType=passToCredit.app.AppMessageService.sendCustomerPasswordUrl ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Credit Card/Query"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/passToCredit.app.AppMessageService.sendCustomerPasswordUrl":{"post":{"summary":"Resend one-time password setting link","deprecated":false,"description":"Header Description: version=0.0.1 bizType=passToCredit.app.AppMessageService.sendCustomerPasswordUrl","tags":["Credit Card/Query"],"parameters":[{"name":"version","in":"header","description":"Version Number","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"Company ID, obtained through environment variables","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"Random Tracking Code UUID","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"Language","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"ip":{"type":"string","title":"Operation IP","description":"Operation IP"},"checkToken":{"type":"string","title":"Verify token.","description":"Verify token. The previous token has expired."}},"required":["checkToken"]}}}},"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":"boolean","title":"Data Body","description":"Data body. true-success"}}}}},"headers":{}}}}}}} ``` ## Check card display status > Header description: version=0.0.1 bizType=passToCredit.app.AppCardQueryService.checkCardDisplayStatus ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Credit Card/Query"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/passToCredit.app.AppCardQueryService.checkCardDisplayStatus":{"post":{"summary":"Check card display status","deprecated":false,"description":"Header description: version=0.0.1 bizType=passToCredit.app.AppCardQueryService.checkCardDisplayStatus","tags":["Credit Card/Query"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"companyId":{"type":"integer","format":"long","title":"Company ID","description":"Company ID"},"ip":{"type":"string","title":"Operation IP","description":"Operation IP","nullable":true},"trace":{"type":"string","title":"Trace number","description":"Trace number","nullable":true},"cardType":{"type":"integer","title":"Card Type","format":"int32","description":"Card Type"},"currency":{"type":"string","title":"Currency","description":"Currency. Only supports HKD"}},"required":["companyId","cardType"]}}}},"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":{"status":{"type":"integer","format":"int32","description":"Display status. 1-Pending application for physical card; 2-Physical card pending approval; 3-Applying for physical card (card production in progress); 4-Pending activation of physical card; 5-Physical card; 6-Physical card application pending deposit; 7-Physical card timeout unpaid; 8-Virtual card unpaid; 9-Virtual card opening fee insufficient; 10-Virtual card timeout unpaid; 11-Virtual card timeout opening fee insufficient; 12-Card not applied for;","title":"Display status"},"feesUnpaid":{"type":"string","title":"Pending fees","description":"Pending fees"},"fee":{"type":"string","title":"Virtual card opening fee","description":"Card issuance fee"},"entityFee":{"type":"string","title":"Physical card mailing fee","description":"Mailing fee"},"timeout":{"type":"integer","format":"long","title":"Timeout Time","description":"Timeout. 13-digit timestamp, proposal timeout at this time"}},"title":""}}}}},"headers":{}}}}}}} ``` ## Check application card proposal processing status > Header description: version=0.0.1 bizType=passToCredit.app.AppCardQueryService.checkActionStatus ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Credit Card/Query"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/passToCredit.app.AppCardQueryService.checkActionStatus":{"post":{"summary":"Check application card proposal processing status","deprecated":false,"description":"Header description: version=0.0.1 bizType=passToCredit.app.AppCardQueryService.checkActionStatus","tags":["Credit Card/Query"],"parameters":[{"name":"version","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"companyId":{"type":"integer","format":"long","title":"Company ID","description":"Company ID"},"proposalId":{"type":"integer","format":"long","title":"Application card proposal Id","description":"Application card proposal Id"},"ip":{"type":"string","title":"Operation IP","description":"Operation IP","nullable":true},"trace":{"type":"string","title":"Trace number","description":"Trace number","nullable":true}},"required":["companyId","proposalId"]}}}},"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":"integer","title":"Display status","format":"int32","description":"Display status. 0-No action; 1-In progress;"}}}}},"headers":{}}}}}}} ``` ## Check if WatsApp account has been bound > Header Description: version=0.0.1 bizType=passToCredit.app.AppMessageService.checkWatsAppAccount ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Credit Card/Query"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/passToCredit.app.AppMessageService.checkWatsAppAccount":{"post":{"summary":"Check if WatsApp account has been bound","deprecated":false,"description":"Header Description: version=0.0.1 bizType=passToCredit.app.AppMessageService.checkWatsAppAccount","tags":["Credit Card/Query"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"companyId":{"type":"integer","title":"Company ID","description":"Company ID. Environment variable configuration","format":"long"},"ip":{"type":"string","title":"Operation IP","description":"Operation IP","nullable":true},"trace":{"type":"string","title":"Trace number","description":"Trace number","nullable":true},"watsAppAccount":{"type":"string","title":"WatsApp Account","description":"WatsApp Account"}},"required":["companyId","watsAppAccount"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"General system return code. 0-Success; 50004-Whatsapp account has been bound before","title":"System universal return code."},"msg":{"type":"string","title":"Return information","description":"Return information"},"data":{"type":"boolean","title":"Return message body.","description":"Return message body. true-Unbound"}},"title":""}}},"headers":{}}}}}}} ``` ## Pagination query for transfer records > Header Description: version=0.0.1 bizType=passToCredit.app.AmountQueryService.queryCustomerTransferProposalPage ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Credit Card/Query"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/passToCredit.app.AmountQueryService.queryCustomerTransferProposalPage":{"post":{"summary":"Pagination query for transfer records","deprecated":false,"description":"Header Description: version=0.0.1 bizType=passToCredit.app.AmountQueryService.queryCustomerTransferProposalPage","tags":["Credit Card/Query"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"companyId":{"type":"integer","title":"Company ID","description":"Company ID. Environment variable configuration","format":"long"},"customerNo":{"type":"string","title":"Agent customer number","description":"Agent customer number. The gateway should fill it in"},"queryStatus":{"type":"string","title":"Filter status list","description":"Filter status list. Multiple statuses are separated by commas. 1-Pending review; 2-Completed; 3-Rejected; 4-Transfer failed;"},"queryTypes":{"type":"string","title":"Filter type list","description":"Filter type list. Multiple statuses separated by commas. 1-Pending confirmation; 2-Transfer_card fee; 3-Transfer_mortgage;"},"startTime":{"type":"integer","title":"Creation time-start time","description":"Creation time-start time"},"endTime":{"type":"integer","title":"Creation time-end time","description":"Creation time-end time"},"updateStartTime":{"type":"string","title":"Update time-start time","description":"Update time-start time"},"updateEndTime":{"type":"string","title":"Update time-end time","description":"Update time-end time"},"thirdPartyAccountNumber":{"type":"string","title":"Third-party account code","description":"Third-party account code"},"firstName":{"type":"string","title":"firstName","description":"firstName"},"lastName":{"type":"string","title":"lastName","description":"lastName"},"name":{"type":"string","title":"Name","description":"Name. Currently lastName+firstName exact match"},"selectCustomerNo":{"type":"string","title":"Query customer number","description":"Query customer number"},"size":{"type":"integer","title":"Number of Items per Page","description":"Number of Items per Page"},"current":{"type":"integer","title":"Current Page","description":"Current Page"}}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"System universal return code. 0-Success;","title":"System universal return code."},"msg":{"type":"string","title":"Return information","description":"Return information"},"data":{"type":"object","properties":{"id":{"type":"integer","format":"long","title":"ID","description":"ID"},"createBy":{"type":"string","title":"Creator","description":"Creator"},"createTime":{"type":"integer","format":"long","title":"Creation time","description":"Creation time"},"updateBy":{"type":"string","title":"Updater","description":"Updater"},"updateTime":{"type":"integer","format":"long","title":"Update Time","description":"Update Time"},"companyId":{"type":"integer","format":"long","title":"Company ID","description":"Company ID"},"outCustomerId":{"type":"integer","format":"long","title":"Transfer out customer ID","description":"Transfer out customer ID"},"outCustomerNo":{"type":"string","title":"Transfer out customer number","description":"Transfer out customer number"},"outAccountId":{"type":"integer","format":"long","title":"Transfer out account ID","description":"Transfer out account ID"},"currency":{"type":"string","title":"Transfer currency","description":"Transfer currency"},"amount":{"type":"string","title":"Transfer amount","description":"Transfer amount"},"customerId":{"type":"integer","format":"long","title":"Transfer in customer ID","description":"Transfer in customer ID"},"customerNo":{"type":"string","title":"Transfer to customer number","description":"Transfer to customer number"},"accountId":{"type":"integer","format":"long","title":"Transfer in account ID","description":"Transfer in account ID"},"thirdPartyCardAccountId":{"type":"string","title":"Transfer in third party card account ID","description":"Transfer in third party card account ID"},"thirdPartyAccountId":{"type":"string","title":"Transfer in third party account ID","description":"Transfer in third party account ID"},"thirdPartyAccountNumber":{"type":"string","title":"Transfer in third party account code","description":"Transfer in third party account code"},"firstName":{"type":"string","title":"firstName","description":"firstName"},"lastName":{"type":"string","title":"lastName","description":"lastName"},"status":{"type":"integer","format":"long","title":"Status","description":"Status. 1-Pending review; 2-Completed; 3-Rejected; 4-Transfer failed;"},"estimateMortgageRate":{"type":"string","title":"Estimated mortgage rate","description":"Estimated mortgage rate. Decimal. 1 is one hundred percent"},"estimateExchangeRate":{"type":"string","title":"Estimated exchange rate","description":"Estimated exchange rate"},"estimateToCurrency":{"type":"string","title":"Estimated credited currency","description":"Estimated credited currency"},"estimateToAmount":{"type":"string","title":"Estimated credited amount","description":"Estimated credited amount"},"mortgageRate":{"type":"string","title":"Mortgage rate","description":"Mortgage rate. Decimal. 1 is one hundred percent"},"exchangeRate":{"type":"string","title":"Exchange Rate","description":"Exchange Rate"},"toCurrency":{"type":"string","title":"Credited currency","description":"Credited currency"},"toAmount":{"type":"string","title":"Credited amount","description":"Credited amount"},"unitId":{"type":"integer","format":"long","title":"Institution Id","description":"Institution Id"},"agentCustomerNo":{"type":"string","title":"Agent customer code","description":"Agent customer code"},"type":{"type":"integer","format":"long","title":"Type","description":"Type. 1-To be determined; 2-Transfer_card fee; 3-Transfer_mortgage;"}},"title":"Return message body.","description":"Return message body."}},"title":""}}},"headers":{}}}}}}} ``` ## Get brief information of agent customer > Header explanation: version=0.0.1 bizType=passToCredit.app.AppCardQueryService.findCustomerInfoUnderAgentByCustomerNo ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Credit Card/Query"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/passToCredit.app.AppCardQueryService.findCustomerInfoUnderAgentByCustomerNo":{"post":{"summary":"Get brief information of agent customer","deprecated":false,"description":"Header explanation: version=0.0.1 bizType=passToCredit.app.AppCardQueryService.findCustomerInfoUnderAgentByCustomerNo","tags":["Credit Card/Query"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"companyId":{"type":"integer","title":"Company ID","description":"Company ID. Environment variable configuration","format":"long"},"customerNo":{"type":"string","title":"Agent customer number","description":"Agent customer number. The gateway should fill it in"},"unitId":{"type":"integer","title":"Institution Id","description":"Organization Id. The gateway should fill in","format":"long"},"selectCustomerNo":{"type":"string","title":"Query customer number","description":"Query customer number"}},"required":["companyId","customerNo","selectCustomerNo"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"System universal return code. 0-Success;","title":"System universal return code."},"msg":{"type":"string","title":"Return information","description":"Return information"},"data":{"type":"object","properties":{"last4Phone":{"type":"string","title":"Creator","description":"Creator"},"updateBy":{"type":"string","title":"Updater","description":"Updater"},"outCustomerNo":{"type":"string","title":"Transfer out customer number","description":"Transfer out customer number"},"currency":{"type":"string","title":"Transfer currency","description":"Transfer currency"}},"title":"Return message body.","description":"Return message body."}},"title":""}}},"headers":{}}}}}}} ``` ## View customer list information under the agent > Header Description:\ > version=0.0.1\ > bizType=passToCredit.app.AppCardQueryService.queryCustomerOfAgentList ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Credit Card/Query"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/passToCredit.app.AppCardQueryService.queryCustomerOfAgentList":{"post":{"summary":"View customer list information under the agent","deprecated":false,"description":"Header Description:\nversion=0.0.1\nbizType=passToCredit.app.AppCardQueryService.queryCustomerOfAgentList","tags":["Credit Card/Query"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"cardFirstNameLastNameCustomerNo":{"type":"string","description":"Cardholder last name, first name, customer number"}}}}}},"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":"object","properties":{"companyId":{"type":"integer","description":"Company ID"},"unitId":{"type":"string","description":"Organization ID"},"customerNo":{"type":"string","description":"Client number"},"phone":{"type":"string","description":"Area code"},"phoneArea":{"type":"string","description":"Phone Number"},"last4Phone":{"type":"string","description":"Last 4 digits of the phone number"},"cardNumber":{"type":"string","description":"Card number"},"cardFirstName":{"type":"string","description":"Cardholder last name"},"cardLastName":{"type":"string","description":"Cardholder first name"}},"description":"Response result body","required":["unitId","customerNo","phone","phoneArea","last4Phone","cardNumber","cardFirstName","cardLastName"]},"ok":{"type":"boolean","description":"Operation success, true=success, false=failure"},"fail":{"type":"boolean","description":"Operation failure, true=success, false=failure"}}}}},"headers":{}}}}}}} ``` ## Get customer service contact information > Header Description: version=0.0.1 bizType=passToCredit.app.AppContactCustomerDubboService.info ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Credit Card/Query"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/passToCredit.app.AppContactCustomerDubboService.info":{"post":{"summary":"Get customer service contact information","deprecated":false,"description":"Header Description: version=0.0.1 bizType=passToCredit.app.AppContactCustomerDubboService.info","tags":["Credit Card/Query"],"parameters":[{"name":"version","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"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":"object","properties":{"tg":{"type":"integer","description":"tg"},"whatsApp":{"type":"string","description":"whatsApp"}},"description":"Response result body","required":["whatsApp"]},"ok":{"type":"boolean","description":"Operation success, true=success, false=failure"},"fail":{"type":"boolean","description":"Operation failure, true=success, false=failure"}}}}},"headers":{}}}}}}} ``` # External Settlement ## External system adjustment > 1: When a user places an order within a platform, the platform will send this request to an external system. This request must be replied to within 3 seconds, otherwise the platform will consider it as a timeout and cancel the operation, while also sending a 'cancel external system adjustment' to the external system to maintain data consistency. 2: Special note, when calling the 'cancel external system adjustment' interface, if an exception occurs or the correct response is not received, it will retry a specified number of times and then abort subsequent operations. !\[]\() ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"External Settlement"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/":{"post":{"summary":"External system adjustment","deprecated":false,"description":"1: When a user places an order within a platform, the platform will send this request to an external system. This request must be replied to within 3 seconds, otherwise the platform will consider it as a timeout and cancel the operation, while also sending a 'cancel external system adjustment' to the external system to maintain data consistency. 2: Special note, when calling the 'cancel external system adjustment' interface, if an exception occurs or the correct response is not received, it will retry a specified number of times and then abort subsequent operations. ![](https://www.processon.com/view/link/64a4e5122383dc0d3e2b982c)","tags":["External Settlement"],"parameters":[{"name":"trace","in":"header","description":"Global link identifier","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"Company Id, country where the user is located","required":false,"schema":{"type":"integer"}},{"name":"timestamp","in":"header","description":"Request initiation timestamp, accurate to the millisecond, 13 digits","required":true,"schema":{"type":"number"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"thirdServerCode":{"type":"string","description":"Unique customer number for third-party systems"},"userName":{"type":"string","description":"TradeBoss user identity unique number","title":"","maxLength":48},"currency":{"type":"string","description":"Account currency code, standard ISO 3-character currency unit","title":"","maxLength":16},"bizType":{"type":"integer","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"},"operationType":{"type":"string","description":"Operation type, OPEN_POSITION=Opening position, NORMAL_CLOSE=Normal closing, ABNORMAL_OVERTRADING=Abnormal overtrading. When it is NORMAL_CLOSE or OPEN_POSITION, the amount can only be a positive number; when it is ABNORMAL_OVERTRADING, the amount is a negative number. The external system can independently decide whether to continue deducting the quota to complete this transaction, or ignore this request."},"amount":{"type":"string","description":"Amount, combined with operationType"},"amountDigits":{"type":"integer","description":"Amount decimal places"},"orderId":{"type":"integer","format":"long","description":"Order ID"},"requestUniqueNo":{"type":"string","description":"Request unique number, multiple requests need to maintain business idempotence","maxLength":48},"requestTime":{"type":"integer","format":"long","description":"Request initiation timestamp, accurate to the millisecond, 13 digits"},"ip":{"type":"string","description":"User IP"},"metadata":{"type":"string","description":"Remarks, JSON format","maxLength":200}},"required":["currency","userName","amount","requestUniqueNo","ip","requestTime","amountDigits","bizType","operationType","orderId","thirdServerCode"]}}}},"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":"object","properties":{},"description":"Response result body"},"ok":{"type":"boolean","description":"Operation success, true=success, false=failure"},"fail":{"type":"boolean","description":"Operation failure, true=success, false=failure"}}}}},"headers":{}}}}}}} ``` ## Transfer to CP when closing position > When a member has finished a game they have bet on and has a net win amount, CATS2 will send this request to the CP system. The CP system needs to adjust the member's account balance. This request will be sent continuously until it is processed and responded to correctly. ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"External Settlement"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/tradeapi.app.OrderApiService.queryPBOOrderPage":{"post":{"summary":"Transfer to CP when closing position","deprecated":true,"description":"When a member has finished a game they have bet on and has a net win amount, CATS2 will send this request to the CP system. The CP system needs to adjust the member's account balance. This request will be sent continuously until it is processed and responded to correctly.","tags":["External Settlement"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"group","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"username":{"type":"string","description":"Unique customer identity number","title":"","maxLength":48},"currency":{"type":"string","description":"Account currency code, standard ISO 3-character currency unit","title":"","maxLength":16},"amount":{"type":"string","description":"Operation amount"},"amountDigist":{"type":"integer","description":"Amount decimal places"},"txid":{"type":"string","description":"Unique transaction number, business idempotent needs to be maintained for multiple requests","maxLength":48},"requesttime":{"type":"integer","format":"long","description":"Request initiation timestamp, accurate to the millisecond, 13 digits"},"ip":{"type":"string","description":"User IP"},"remark":{"type":"string","description":"Third-party business remark information","maxLength":200}},"required":["currency","username","amount","txid","remark","ip","amountDigist"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"bizCode":{"type":"string","description":"Module identifier code"},"code":{"type":"string","description":"Status Return Code, code=0 indicates current request operation success, other codes handle exceptions"},"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":"Message body"},"ok":{"type":"boolean"},"fail":{"type":"boolean"}}}}},"headers":{}}}}}}} ``` ## Cancel external system adjustment > When an 'external system adjustment' request times out or the external system returns an error message, the platform will send this request to the external system to ensure data consistency. ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"External Settlement"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/get-user-amount":{"post":{"summary":"Cancel external system adjustment","deprecated":false,"description":"When an 'external system adjustment' request times out or the external system returns an error message, the platform will send this request to the external system to ensure data consistency.","tags":["External Settlement"],"parameters":[{"name":"trace","in":"header","description":"Global link identifier","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"Company Id, country where the user is located","required":false,"schema":{"type":"integer"}},{"name":"timestamp","in":"header","description":"Request initiation timestamp, accurate to the millisecond, 13 digits","required":true,"schema":{"type":"number"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"thirdServerCode":{"type":"string","description":"Unique customer number for third-party systems"},"userName":{"type":"string","description":"TradeBoss user identity unique number","title":"","maxLength":48},"currency":{"type":"string","description":"Account currency code, standard ISO 3-character currency unit","title":"","maxLength":16},"bizType":{"type":"integer","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"},"amount":{"type":"string","description":"Amount, can only be a positive number"},"amountDigits":{"type":"integer","description":"Amount decimal places"},"orderId":{"type":"integer","format":"long","description":"Order ID"},"requestUniqueNo":{"type":"string","description":"Request unique number, multiple requests need to maintain business idempotence","maxLength":48},"reverseRequestUniqueNo":{"type":"string","description":"This number corresponds to the requestUniqueNo when the 'external system adjusts the amount' request was made. The external system needs to check if this number has been processed. If processed correctly, the correct amount needs to be returned to the client; if the request was received but not processed correctly, return code=US_0000001. If no request with this number was received, return code=US_0000002"},"requestTime":{"type":"integer","format":"long","description":"Request initiation timestamp, accurate to the millisecond, 13 digits"},"ip":{"type":"string","description":"User IP"},"cancelRemark":{"type":"string","description":"Cancellation reason","maxLength":200},"metadata":{"type":"string","description":"Remarks, JSON format","maxLength":200}},"required":["currency","userName","amount","requestUniqueNo","ip","requestTime","amountDigits","bizType","cancelRemark","reverseRequestUniqueNo"]}}}},"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":"object","properties":{},"description":"Response result body"},"ok":{"type":"boolean","description":"Operation success, true=success, false=failure"},"fail":{"type":"boolean","description":"Operation failure, true=success, false=failure"}}}}},"headers":{}}}}}}} ``` ## External System Credit Limit Adjustment > 1: When a user places an order within the TradeBoss platform, the platform sends this request to an external system. The external system must respond within 3 seconds, otherwise the TradeBoss platform will consider it as a timeout and cancel the operation. At the same time, it will also send a "Cancel external system credit limit adjustment" request to maintain data consistency with the external system.\ > \ > 2: It is important to note that when calling the "Cancel external system credit limit adjustment" interface, if any exceptions occur or if a correct response is not received, there will be specified retries before aborting subsequent operations.
```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"External Settlement"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/external-system-credit-limit-adjustment":{"post":{"summary":"External System Credit Limit Adjustment","deprecated":false,"description":"1: When a user places an order within the TradeBoss platform, the platform sends this request to an external system. The external system must respond within 3 seconds, otherwise the TradeBoss platform will consider it as a timeout and cancel the operation. At the same time, it will also send a \"Cancel external system credit limit adjustment\" request to maintain data consistency with the external system.\n\n2: It is important to note that when calling the \"Cancel external system credit limit adjustment\" interface, if any exceptions occur or if a correct response is not received, there will be specified retries before aborting subsequent operations.\n","tags":["External Settlement"],"parameters":[{"name":"trace","in":"header","description":"Global Link Identifier.","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"Company Id,User's company ID","required":true,"schema":{"type":"integer"}},{"name":"timestamp","in":"header","description":"Request initiation timestamp, accurate to the millisecond, 13 digits.","required":true,"schema":{"type":"number"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"thirdServerCode":{"type":"string","description":"Third-party system customer unique identifier"},"userName":{"type":"string","title":"","maxLength":48,"description":"TradeBoss user identity unique identifier"},"currency":{"type":"string","title":"","maxLength":16,"description":"Account currency code, standard ISO 3-character currency unit."},"bizType":{"type":"integer","description":"Business types: 1 - Market order open; 2 - Market order close; 10 - Limit price stop order; 11 - Stop loss stop order; 12 - Limit price open"},"operationType":{"type":"string","description":"The operation types are OPEN_POSITION for opening a position, NORMAL_CLOSE for normal closing, and ABNORMAL_OVERTRADING for abnormal overtrading. When the operation type is NORMAL_CLOSE or OPEN_POSITION, the amount can only be a positive number. When it is ABNORMAL_OVERTRADING, the amount should be negative. The third-party system can decide whether to continue deducting quotas to complete this transaction or ignore this request."},"amount":{"type":"string","description":"Amount, used in conjunction with operationType."},"amountDigits":{"type":"integer","description":"Amount decimal places."},"orderId":{"type":"integer","format":"long","description":"Order ID."},"requestUniqueNo":{"type":"string","maxLength":48,"description":"Request for a unique identifier, multiple requests need to maintain business idempotence."},"requestTime":{"type":"integer","format":"long","description":"Request initiation timestamp, accurate to the millisecond, 13 digits"},"ip":{"type":"string","description":"User IP"},"metadata":{"type":"string","description":"Remarks information, in JSON format.","maxLength":200}},"required":["currency","userName","amount","requestUniqueNo","ip","requestTime","amountDigits","bizType","operationType","orderId","thirdServerCode"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"bizCode":{"type":"string","description":"Module identification code, the service module that ultimately handles the current request, 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":"The global link identifier is consistent with the trace in the request header, which facilitates problem localization."},"msgParams":{"type":"string","description":"Return the placeholder parameter string in the status description, with multiple parameters separated by commas, used to process variable information in the status description and provide a user-friendly interactive experience."},"data":{"type":"object","properties":{},"description":"Response body."},"ok":{"type":"boolean","description":"The operation was successful if true, and failed if false."},"fail":{"type":"boolean","description":"The operation was successful if false, and failed if true."}}}}},"headers":{}}}}}}} ``` ## Cancel external system credit limit adjustment > When "External System Credit Limit Adjustment", if the request times out or the external system returns an error message, TradeBoss platform will send this request to the external system in order to maintain data consistency. ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"External Settlement"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/cancel-external-system-credit-limit-adjustment":{"post":{"summary":"Cancel external system credit limit adjustment","deprecated":false,"description":"When \"External System Credit Limit Adjustment\", if the request times out or the external system returns an error message, TradeBoss platform will send this request to the external system in order to maintain data consistency.","tags":["External Settlement"],"parameters":[{"name":"trace","in":"header","description":"Global Link Identifier.","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"Company Id,User's company ID","required":true,"schema":{"type":"integer"}},{"name":"timestamp","in":"header","description":"Request initiation timestamp, accurate to the millisecond, 13 digits.","required":false,"schema":{"type":"number"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"thirdServerCode":{"type":"string","description":"Third-party system customer unique identifier"},"userName":{"type":"string","description":"TradeBoss user identity unique identifier","title":"","maxLength":48},"currency":{"type":"string","description":"Account currency code, standard ISO 3-character currency unit","title":"","maxLength":16},"bizType":{"type":"integer","description":"Business type, 1-market price opening; 2-market price closing; 10-limit price pre-embedded order; 11-stop loss pre-embedded order; 12-limit price opening"},"amount":{"type":"string","description":"Amount, can only be positive"},"amountDigits":{"type":"integer","description":"Amount decimal places"},"orderId":{"type":"integer","format":"long","description":"Order ID"},"requestUniqueNo":{"type":"string","description":"Request unique number, multiple requests need to maintain business idempotence.","maxLength":48},"reverseRequestUniqueNo":{"type":"string","description":"This number corresponds to the request_unique_no when the \"third-party system transfer\" was requested earlier. The third-party system needs to check whether this number has been processed. If it is correctly processed, it needs to return the correct amount to the customer. If a request is received but not processed correctly, return code=US_0000001. If no request with this number is received, return code=US_0000002."},"requestTime":{"type":"integer","format":"long","description":"Request initiation timestamp accurate up to milliseconds and in a format of 13 digits."},"ip":{"type":"string","description":"User IP address"},"cancelRemark":{"type":"string","description":"Cancellation reason","maxLength":200},"metadata":{"type":"string","description":"Remarks information in JSON format","maxLength":200}},"required":["currency","userName","amount","requestUniqueNo","ip","requestTime","amountDigits","bizType","cancelRemark","reverseRequestUniqueNo","thirdServerCode"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"bizCode":{"type":"string","description":"Module identification code, the service module that ultimately processes the current request, can be empty."},"code":{"type":"string","description":"The status return code, code=0, indicates that 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 identifier, consistent with the trace in the request header for easy problem locating."},"msgParams":{"type":"string","description":"Return the placeholder parameter string in the status description, with multiple parameters separated by commas, used to process variable information in the status description and provide a user-friendly interactive experience."},"data":{"type":"object","properties":{},"description":"Response Body"},"ok":{"type":"boolean","description":"The operation was successful if true, and failed if false."},"fail":{"type":"boolean","description":"The operation was successful if false, and failed if true."}}}}},"headers":{}}}}}}} ``` # Market Maker ## POST /marketPosition > Market Maker Position Report ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Market Maker"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/marketPosition":{"post":{"summary":"Market Maker Position Report","deprecated":false,"description":"","tags":["Market Maker"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"integer","title":"Type 1-Position Report 2-Market Maker Position 3-Single Order Position"},"externalOrderId":{"type":"string","title":"External Order ID"},"blacklist":{"type":"boolean","title":"Is Blacklisted"},"symbolName":{"type":"string","title":"Trading Product"},"direction":{"type":"integer","title":"Buy/Sell Type; 1-Buy; 2-Sell"},"positionId":{"type":"integer","title":"Position number"},"dealId":{"type":"integer","title":"Deal Number"},"startTime":{"type":"integer","title":"Start Time"},"endTime":{"type":"integer","title":"End Time"}},"required":["type","externalOrderId","blacklist","symbolName","direction","positionId","dealId","startTime","endTime"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"customerNo":{"type":"string","title":"Client number"},"accountType":{"type":"integer","title":"Account Type"},"symbolName":{"type":"string","title":"Trading Product"},"direction":{"type":"integer","title":"Buy/Sell Type; 1-Buy; 2-Sell"},"volumeTarget":{"type":"string","title":"Position Lots"},"floatProfitLoss":{"type":"string","title":"Floating P/L"},"openVolumeTarget":{"type":"string","title":"Initial Lots"},"openPriceTarget":{"type":"string","title":"Opening price"},"takeProfitTarget":{"type":"string","title":"Take profit"},"stopLossTarget":{"type":"string","title":"Stop loss"},"openMarginTarget":{"type":"string","title":"Opening margin"},"overnightInterest":{"type":"string","title":"Overnight interest"},"occupyTheMarginTarget":{"type":"string","title":"Margin in use"},"positionId":{"type":"integer","title":"Position number"},"dealId":{"type":"integer","title":"Deal Number"},"externalOrderId":{"type":"string","title":"External order number"},"blacklist":{"type":"boolean","title":"Is Blacklisted"},"createTime":{"type":"integer","title":"Opening time"},"remark":{"type":"string","title":"Remarks"},"estimateForcePrice":{"type":"string","title":"Estimated liquidation price"}},"required":["customerNo","accountType","symbolName","direction","volumeTarget","openVolumeTarget","openPriceTarget","takeProfitTarget","stopLossTarget","openMarginTarget","overnightInterest","occupyTheMarginTarget","positionId","dealId","externalOrderId","blacklist","createTime","remark","estimateForcePrice","floatProfitLoss"]}}},"headers":{}}}}}}} ``` ## Net Position Configuration - Query Market Maker Net Position Configuration > bizType=config.app.AppJcStrategyDubboService.getPageView\ > Query Market Maker Net Position Configuration ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Market Maker"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/config.app.AppJcStrategyDubboService.getPageView":{"post":{"summary":"Net Position Configuration - Query Market Maker Net Position Configuration","deprecated":false,"description":"bizType=config.app.AppJcStrategyDubboService.getPageView\nQuery Market Maker Net Position Configuration","operationId":"getExchangeRateList","tags":["Market Maker"],"parameters":[{"name":"version","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"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"},"size":{"type":"string","description":"Number of Items per Page","title":"Number of Items per Page"},"current":{"type":"string","description":"Current Page","title":"Current Page"},"symbolId":{"type":"string","title":"Product ID","description":"Product ID"},"status":{"type":"string","title":"Status","description":"Status"},"symbolNames":{"type":"string","title":"Product name","description":"Product name"}},"required":["size","current","trace","symbolId","status","symbolNames"]}}}},"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":{"description":"Data Body","type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"symbolId":{"type":"string","description":"Product ID"},"symbolName":{"type":"string","description":"Product name"},"shortNetPosition":{"type":"string","description":"Short Net Position (Lots)"},"longNetPosition":{"type":"string","description":"Long Net Position (Lots)"},"waitingTime":{"type":"string","description":"Waiting time (s)"}},"required":["symbolId","symbolName","shortNetPosition","longNetPosition","waitingTime"],"description":"Array"},"description":"Result list"},"total":{"type":"string","description":"Total"},"size":{"type":"string","description":"Number of Items per Page"},"current":{"type":"string","description":"Current Page"}}},"ok":{"type":"string"},"fail":{"type":"string"}}}}},"headers":{}}}}}}} ``` ## Net position configuration - Add market maker net position configuration > bizType=config.app.AppJcStrategyDubboService.add Add market maker net position configuration ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Market Maker"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/config.app.AppJcStrategyDubboService.add":{"post":{"summary":"Net position configuration - Add market maker net position configuration","deprecated":false,"description":"bizType=config.app.AppJcStrategyDubboService.add Add market maker net position configuration","operationId":"getExchangeRateList","tags":["Market Maker"],"parameters":[{"name":"version","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"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"},"symbolId":{"type":"string","title":"Product ID","description":"Product ID"},"accountId":{"type":"string","title":"Trading account","description":"Trading account"},"shortNetPosition":{"type":"string","description":"Short Net Position (Lots)","title":"Short Net Position (Lots)"},"longNetPosition":{"type":"string","description":"Long Net Position (Lots)","title":"Long Net Position (Lots)"},"waitingTime":{"type":"string","description":"Waiting time (s)","title":"Waiting time (s)"}},"required":["trace","symbolId","accountId","shortNetPosition","longNetPosition","waitingTime"]}}}},"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":{"description":"Data Body","type":"object","properties":{"symbolId":{"type":"string","description":"Product ID"},"symbolName":{"type":"string","description":"Product name"},"shortNetPosition":{"type":"string","description":"Short Net Position (Lots)"},"longNetPosition":{"type":"string","description":"Long Net Position (Lots)"},"waitingTime":{"type":"string","description":"Waiting time (s)"}}},"ok":{"type":"string"},"fail":{"type":"string"}}}}},"headers":{}}}}}}} ``` ## Net position configuration - enable/disable market maker net position configuration > bizType=config.app.AppJcStrategyDubboService.updateStatus\ > Enable/disable market maker net position configuration ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Market Maker"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/config.app.AppJcStrategyDubboService.updateStatus":{"post":{"summary":"Net position configuration - enable/disable market maker net position configuration","deprecated":false,"description":"bizType=config.app.AppJcStrategyDubboService.updateStatus\nEnable/disable market maker net position configuration","operationId":"getExchangeRateList","tags":["Market Maker"],"parameters":[{"name":"version","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"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"},"id":{"type":"string","title":"Record ID","description":"Record ID"},"status":{"type":"string","description":"Status 1, 2, enable, disable","title":"Status"}},"required":["trace","id","status"]}}}},"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":{"description":"Data Body","type":"object","properties":{"symbolId":{"type":"string","description":"Product ID"},"symbolName":{"type":"string","description":"Product name"},"shortNetPosition":{"type":"string","description":"Short Net Position (Lots)"},"longNetPosition":{"type":"string","description":"Long Net Position (Lots)"},"waitingTime":{"type":"string","description":"Waiting time (s)"}}},"ok":{"type":"string"},"fail":{"type":"string"}}}}},"headers":{}}}}}}} ``` ## Net Position Configuration - Edit Market Maker Net Position Configuration > bizType=config.app.AppJcStrategyDubboService.update\ > Enable/Disable Market Maker Net Position Configuration ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Market Maker"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/config.app.AppJcStrategyDubboService.update":{"post":{"summary":"Net Position Configuration - Edit Market Maker Net Position Configuration","deprecated":false,"description":"bizType=config.app.AppJcStrategyDubboService.update\nEnable/Disable Market Maker Net Position Configuration","operationId":"getExchangeRateList","tags":["Market Maker"],"parameters":[{"name":"version","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"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"},"id":{"type":"string","title":"Record ID","description":"Record ID"},"shortNetPosition":{"type":"string","description":"Short Net Position (Lots)","title":"Short Net Position (Lots)"},"longNetPosition":{"type":"string","title":"Long Net Position (Lots)","description":"Long Net Position (Lots)"},"waitingTime":{"type":"string","title":"Waiting time (s)","description":"Waiting time (s)"},"status":{"type":"string","title":"Status","description":"Status"}},"required":["trace","id","shortNetPosition","longNetPosition","waitingTime","status"]}}}},"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":{"description":"Data Body","type":"object","properties":{"symbolId":{"type":"string","description":"Product ID"},"symbolName":{"type":"string","description":"Product name"},"shortNetPosition":{"type":"string","description":"Short Net Position (Lots)"},"longNetPosition":{"type":"string","description":"Long Net Position (Lots)"},"waitingTime":{"type":"string","description":"Waiting time (s)"}}},"ok":{"type":"string"},"fail":{"type":"string"}}}}},"headers":{}}}}}}} ``` ## Net position configuration-Delete market maker net position configuration > bizType=config.app.AppJcStrategyDubboService.removeById\ > Remove market maker net position configuration ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Market Maker"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/config.app.AppJcStrategyDubboService.removeById":{"post":{"summary":"Net position configuration-Delete market maker net position configuration","deprecated":false,"description":"bizType=config.app.AppJcStrategyDubboService.removeById\nRemove market maker net position configuration","operationId":"getExchangeRateList","tags":["Market Maker"],"parameters":[{"name":"version","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"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"},"id":{"type":"string","title":"Record ID","description":"Record ID"}},"required":["trace","id"]}}}},"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":{"description":"Data Body","type":"object","properties":{"symbolId":{"type":"string","description":"Product ID"},"symbolName":{"type":"string","description":"Product name"},"shortNetPosition":{"type":"string","description":"Short Net Position (Lots)"},"longNetPosition":{"type":"string","description":"Long Net Position (Lots)"},"waitingTime":{"type":"string","description":"Waiting time (s)"}}},"ok":{"type":"string"},"fail":{"type":"string"}}}}},"headers":{}}}}}}} ``` ## POST /marketTrade > Market maker trading report ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Market Maker"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/marketTrade":{"post":{"summary":"Market maker trading report","deprecated":false,"description":"","tags":["Market Maker"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"accountType":{"type":"integer","title":"Account type 1-Active market maker account 2-Passive market maker account 3-Shooting order account 4-C-end order account"},"externalOrderId":{"type":"string","title":"External Order ID"},"blacklist":{"type":"boolean","title":"Is Blacklisted"},"symbolName":{"type":"string","title":"Trading Product"},"direction":{"type":"string","title":"Buy/Sell Type; 1-Buy; 2-Sell"},"openClose":{"type":"integer","title":"Open/Close position 1-Open position 2-Close position"},"bizType":{"type":"integer","title":"Order type 1-Market price open position 2-Limit price open position 3-Stop loss open position 4-Market price close position 5-Take profit close position 6-Stop loss close position 7-System close position 8-Expiration close position"},"positionId":{"type":"integer","title":"Position number"},"dealId":{"type":"integer","title":"Deal Number"},"counterpartyDealId":{"type":"string","title":"Counterparty transaction number"},"startTime":{"type":"integer","title":"Start Time"},"endTime":{"type":"integer","title":"End Time"}},"required":["accountType","externalOrderId","blacklist","symbolName","direction","openClose","bizType","positionId","dealId","counterpartyDealId","startTime","endTime"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"customerNo":{"type":"string","title":"Client number"},"accountType":{"type":"integer","title":"Account Type"},"accountCurrency":{"type":"string","title":"Account currency"},"symbolName":{"type":"string","title":"Trading Product"},"direction":{"type":"integer","title":"Buy/Sell Type; 1-Buy; 2-Sell"},"openClose":{"type":"integer","title":"Open/Close position 1-Open position 2-Close position"},"bizType":{"type":"integer","title":"Order type 1-Market price open position 2-Limit price open position 3-Stop loss open position 4-Market price close position 5-Take profit close position 6-Stop loss close position 7-System close position 8-Expiration close position"},"numberStatisticMode":{"type":"integer","title":"Quantity statistics method 1: by quantity 2: by amount"},"requestPrice":{"type":"string","title":"Entrustment price"},"requestAmount":{"type":"string","title":"Entrustment amount"},"executeAmount":{"type":"string","title":"Transaction amount"},"executePrice":{"type":"string","title":"Average transaction price"},"profitLoss":{"type":"string","title":"Profit and Loss"},"commission":{"type":"string","title":"Commission fee"},"interest":{"type":"string","title":"Interest"},"takeProfitTarget":{"type":"string","title":"Take profit"},"stopLossTarget":{"type":"string","title":"Stop loss"},"positionId":{"type":"integer","title":"Position number"},"dealId":{"type":"integer","title":"Deal Number"},"externalOrderId":{"type":"string","title":"External order number"},"counterpartyDealId":{"type":"string","title":"Counterparty transaction number"},"blacklist":{"type":"boolean","title":"Is Blacklisted"},"requestTime":{"type":"integer","title":"Order time"},"executeTime":{"type":"integer","title":"Transaction time"},"status":{"type":"integer","title":"Status"},"remark":{"type":"string","title":"Remarks"},"estimateForcePrice":{"type":"string","title":"Estimated liquidation price"}},"required":["customerNo","accountType","symbolName","direction","profitLoss","takeProfitTarget","stopLossTarget","positionId","dealId","externalOrderId","blacklist","requestTime","remark","estimateForcePrice","openClose","bizType","counterpartyDealId","accountCurrency","numberStatisticMode","requestPrice","requestAmount","executePrice","executeAmount","commission","interest","executeTime","status"]}}},"headers":{}}}}}}} ``` ## POST /marketEntrust > Market maker order report ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Market Maker"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/marketEntrust":{"post":{"summary":"Market maker order report","deprecated":false,"description":"","tags":["Market Maker"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"accountType":{"type":"integer","title":"Account type 1-Active market maker account 2-Passive market maker account 3-Shooting order account 4-C-end order account"},"externalOrderId":{"type":"string","title":"External Order ID"},"blacklist":{"type":"boolean","title":"Is Blacklisted"},"startTime":{"type":"integer","title":"Start Time"},"endTime":{"type":"integer","title":"End Time"},"symbolName":{"type":"string","title":"Trading Product"},"direction":{"type":"integer","title":"Buy/Sell Type; 1-Buy; 2-Sell"},"bizType":{"type":"integer","title":"Order type"},"orderId":{"type":"integer","title":"Order number"},"numberStatisticMode":{"type":"integer","title":"Quantity statistics method 1: by quantity 2: by amount\""}},"required":["accountType","externalOrderId","blacklist","startTime","endTime","symbolName","direction","bizType","orderId","numberStatisticMode"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"customerNo":{"type":"string","title":"Client number"},"accountType":{"type":"integer","title":"Account type 1-Active market maker account 2-Passive market maker account 3-Shooting order account 4-C-end order account"},"symbolName":{"type":"string","title":"Trading Product"},"direction":{"type":"integer","title":"Buy/Sell Type; 1-Buy; 2-Sell"},"bizType":{"type":"integer","title":"Order type"},"numberStatisticMode":{"type":"integer","title":"Quantity statistics method 1: by quantity 2: by amount\""},"requestPrice":{"type":"string","title":"Entrustment price"},"requestVolume":{"type":"string","title":"Order quantity"},"requestAmount":{"type":"string","title":"Order amount"},"orderId":{"type":"integer","title":"Order number"},"dealId":{"type":"integer","title":"Deal Number"},"executePrice":{"type":"string","title":"Deal price"},"executeVolume":{"type":"string","title":"Deal quantity"},"executeAmount":{"type":"string","title":"Deal amount"},"positionId":{"type":"integer","title":"Position number"},"lossPrice":{"type":"string","title":"Stop loss"},"profitPrice":{"type":"string","title":"Take profit"},"lockedMargin":{"type":"string","title":"Frozen margin"},"commission":{"type":"string","title":"Commission fee"},"requestTime":{"type":"integer","title":"Order time"},"remark":{"type":"string","title":"Remarks"},"status":{"type":"integer","title":"Status"},"externalOrderId":{"type":"string","title":"External order number"},"blacklist":{"type":"boolean","title":"Is Blacklisted"}},"required":["customerNo","accountType","symbolName","direction","bizType","numberStatisticMode","requestPrice","requestVolume","requestAmount","orderId","dealId","executePrice","executeVolume","executeAmount","positionId","lossPrice","profitPrice","lockedMargin","commission","requestTime","remark","status","externalOrderId","blacklist"]}}},"headers":{}}}}}}} ``` ## POST /marketStpRecord > Market Maker Blacklist Shooting Record Report ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Market Maker"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/marketStpRecord":{"post":{"summary":"Market Maker Blacklist Shooting Record Report","deprecated":false,"description":"","tags":["Market Maker"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"accountType":{"type":"integer","title":"Account type 1-Active market maker account 2-Passive market maker account 3-Shooting order account 4-C-end order account"},"externalOrderId":{"type":"string","title":"External order number"},"symbolName":{"type":"string","title":"Trading Product"},"direction":{"type":"string","title":"Buy/Sell"},"openClose":{"type":"integer","title":"Open/Close position 1-Open position 2-Close position"},"bizType":{"type":"integer","title":"Order type"},"numberStatisticMode":{"type":"integer","title":"Quantity statistics method 1: by quantity 2: by amount\""},"positionId":{"type":"integer","title":"Position number"},"dealId":{"type":"integer","title":"Deal Number"},"counterpartyDealId":{"type":"string","title":"Counterparty transaction number"},"startTime":{"type":"integer","title":"Start Time"},"endTime":{"type":"integer","title":"End Time"},"lpDealId":{"type":"string","title":"LP Deal Number"}},"required":["accountType","externalOrderId","symbolName","direction","openClose","bizType","positionId","dealId","counterpartyDealId","startTime","endTime","numberStatisticMode","lpDealId"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"customerNo":{"type":"string","title":"Client number"},"accountType":{"type":"integer","title":"Account type 1-Active market maker account 2-Passive market maker account 3-Shooting order account 4-C-end order account"},"currency":{"type":"string","title":"Account currency"},"symbolName":{"type":"string","title":"Trading Product"},"direction":{"type":"integer","title":"Buy/Sell"},"openClose":{"type":"integer","title":"Open/Close position 1-Open position 2-Close position"},"bizType":{"type":"integer","title":"Order type"},"numberStatisticMode":{"type":"integer","title":" 1: By Quantity 2: By Amount\""},"requestPrice":{"type":"string","title":"Entrustment price"},"requestVolume":{"type":"string","title":"Order quantity"},"requestAmount":{"type":"string","title":"Order amount"},"executeAmount":{"type":"string","title":"Deal amount"},"executePrice":{"type":"string","title":"Average transaction price"},"profitLoss":{"type":"string","title":"Profit and Loss"},"commission":{"type":"string","title":"Commission fee"},"interest":{"type":"string","title":"Interest"},"lossPrice":{"type":"string","title":"Stop loss"},"profitPrice":{"type":"string","title":"Take profit"},"dealId":{"type":"integer","title":"Deal Number"},"counterpartyDealId":{"type":"string","title":"Counterparty transaction number"},"positionId":{"type":"integer","title":"Position number"},"status":{"type":"integer","title":"Status"},"requestTime":{"type":"integer","title":"Order time"},"executeTime":{"type":"integer","title":"Transaction time"},"externalOrderId":{"type":"string","title":"External order number"},"lpDealDirection":{"type":"integer","title":"LP Deal Direction"},"lpDealVolume":{"type":"string","title":"LP Deal Lots"},"lpDealPrice":{"type":"string","title":"LP Deal Price"},"lpDealId":{"type":"string","title":"LP Deal Number"},"remark":{"type":"string","title":"Remarks"}},"required":["customerNo","accountType","symbolName","direction","bizType","numberStatisticMode","requestPrice","requestVolume","requestAmount","dealId","executePrice","executeAmount","positionId","lossPrice","profitPrice","counterpartyDealId","commission","interest","profitLoss","requestTime","remark","status","externalOrderId","lpDealDirection","lpDealVolume","lpDealPrice","lpDealId","openClose","currency","executeTime"]}}},"headers":{}}}}}}} ``` ## POST /marketNetRecord > Market maker net position shooting order record report ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Market Maker"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/marketNetRecord":{"post":{"summary":"Market maker net position shooting order record report","deprecated":false,"description":"","tags":["Market Maker"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"accountType":{"type":"integer","title":"Account type 1-Active market maker account 2-Passive market maker account 3-Shooting order account 4-C-end order account"},"externalOrderId":{"type":"string","title":"External order number"},"symbolName":{"type":"string","title":"Trading Product"},"direction":{"type":"string","title":"Buy/Sell"},"openClose":{"type":"integer","title":"Open/Close position 1-Open position 2-Close position"},"bizType":{"type":"integer","title":"Order type"},"numberStatisticMode":{"type":"integer","title":"Quantity statistics method 1: by quantity 2: by amount\""},"positionId":{"type":"integer","title":"Position number"},"dealId":{"type":"integer","title":"Deal Number"},"counterpartyDealId":{"type":"string","title":"Counterparty transaction number"},"startTime":{"type":"integer","title":"Start Time"},"endTime":{"type":"integer","title":"End Time"},"lpDealId":{"type":"string","title":"LP Deal Number"}},"required":["accountType","externalOrderId","symbolName","direction","openClose","bizType","positionId","dealId","counterpartyDealId","startTime","endTime","numberStatisticMode","lpDealId"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"customerNo":{"type":"string","title":"Client number"},"accountType":{"type":"integer","title":"Account type 1-Active market maker account 2-Passive market maker account 3-Shooting order account 4-C-end order account"},"currency":{"type":"string","title":"Account currency"},"symbolName":{"type":"string","title":"Trading Product"},"direction":{"type":"integer","title":"Buy/Sell"},"openClose":{"type":"integer","title":"Open/Close position 1-Open position 2-Close position"},"bizType":{"type":"integer","title":"Order type"},"numberStatisticMode":{"type":"integer","title":" 1: By Quantity 2: By Amount\""},"requestPrice":{"type":"string","title":"Entrustment price"},"requestVolume":{"type":"string","title":"Order quantity"},"requestAmount":{"type":"string","title":"Order amount"},"executeAmount":{"type":"string","title":"Deal amount"},"executePrice":{"type":"string","title":"Average transaction price"},"profitLoss":{"type":"string","title":"Profit and Loss"},"commission":{"type":"string","title":"Commission fee"},"interest":{"type":"string","title":"Interest"},"lossPrice":{"type":"string","title":"Stop loss"},"profitPrice":{"type":"string","title":"Take profit"},"dealId":{"type":"integer","title":"Deal Number"},"counterpartyDealId":{"type":"string","title":"Counterparty transaction number"},"positionId":{"type":"integer","title":"Position number"},"status":{"type":"integer","title":"Status"},"requestTime":{"type":"integer","title":"Order time"},"executeTime":{"type":"integer","title":"Transaction time"},"externalOrderId":{"type":"string","title":"External order number"},"lpDealDirection":{"type":"integer","title":"LP Deal Direction"},"lpDealVolume":{"type":"string","title":"LP Deal Lots"},"lpDealPrice":{"type":"string","title":"LP Deal Price"},"lpDealId":{"type":"string","title":"LP Deal Number"},"remark":{"type":"string","title":"Remarks"}},"required":["customerNo","accountType","symbolName","direction","bizType","numberStatisticMode","requestPrice","requestVolume","requestAmount","dealId","executePrice","executeAmount","positionId","lossPrice","profitPrice","counterpartyDealId","commission","interest","profitLoss","requestTime","remark","status","externalOrderId","lpDealDirection","lpDealVolume","lpDealPrice","lpDealId","openClose","currency","executeTime"]}}},"headers":{}}}}}}} ``` ## POST /api/cats-gateway/global/report.app.ReportDatadDubboService.marketMatchProfitRecord > Market Maker Match Profit and Loss Details Report ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Market Maker"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/api/cats-gateway/global/report.app.ReportDatadDubboService.marketMatchProfitRecord":{"post":{"summary":"Market Maker Match Profit and Loss Details Report","deprecated":false,"description":"","tags":["Market Maker"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"accountType":{"type":"integer","title":"Account Type 1-Aggregated Order Account 2-AMM Market Making Account"},"externalOrderId":{"type":"string","title":"External order number"},"symbolName":{"type":"string","title":"Trading Product"},"direction":{"type":"string","title":"Buy/Sell"},"openClose":{"type":"integer","title":"Open/Close position 1-Open position 2-Close position"},"bizType":{"type":"integer","title":"Order type"},"numberStatisticMode":{"type":"integer","title":"Quantity statistics method 1: by quantity 2: by amount\""},"positionId":{"type":"integer","title":"Position number"},"dealId":{"type":"integer","title":"Deal Number"},"counterpartyDealId":{"type":"string","title":"Counterparty transaction number"},"startTime":{"type":"integer","title":"Start Time"},"endTime":{"type":"integer","title":"End Time"}},"required":["accountType","externalOrderId","symbolName","direction","openClose","bizType","positionId","dealId","counterpartyDealId","startTime","endTime","numberStatisticMode"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"executeTime":{"type":"integer","title":"Transaction time"},"dealId":{"type":"integer","title":"Deal Number"},"accountType":{"type":"integer","title":"Account Type 1-Aggregated C Account 2-AMM Account (including active and passive)"},"customerNo":{"type":"string","title":"Client number"},"symbolName":{"type":"string","title":"Trading Product"},"openClose":{"type":"integer","title":"Open/Close position 1-Open position 2-Close position"},"direction":{"type":"integer","title":"Buy/Sell"},"bizType":{"type":"integer","title":"Order type"},"requestPrice":{"type":"string","title":"Entrustment price"},"executePrice":{"type":"string","title":"Average transaction price"},"executeVolume":{"type":"string","title":"Volume (Lots)"},"tradeVolume":{"type":"string","title":"Volume"},"executeAmount":{"type":"string","title":"Deal amount"},"tradeCurrency":{"type":"string","title":"Turnover Currency"},"takeProfitTarget":{"type":"string","title":"Take profit"},"stopLossTarget":{"type":"string","title":"Stop loss"},"profitLoss":{"type":"string","title":"Profit and Loss"},"profitLossU":{"type":"string","title":"Profit/Loss (USD)"},"counterpartyDealId":{"type":"string","title":"Counterparty transaction number"},"requestTime":{"type":"integer","title":"Order time"},"externalOrderId":{"type":"string","title":"External order number"},"remark":{"type":"string","title":"Remarks"}},"required":["customerNo","accountType","symbolName","direction","bizType","executeVolume","requestPrice","dealId","executePrice","executeAmount","stopLossTarget","takeProfitTarget","counterpartyDealId","profitLoss","requestTime","remark","externalOrderId","openClose","executeTime","tradeCurrency","tradeVolume","profitLossU"]}}},"headers":{}}}}}}} ``` ## POST /api/cats-gateway/global/report.app.ReportDatadDubboService.marketStpProfitRecord > Market maker single profit and loss detailed report ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Market Maker"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/api/cats-gateway/global/report.app.ReportDatadDubboService.marketStpProfitRecord":{"post":{"summary":"Market maker single profit and loss detailed report","deprecated":false,"description":"","tags":["Market Maker"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"accountType":{"type":"integer","title":"Account type 1.A Book account 2.Net position single order account 3.Large order stp account"},"externalOrderId":{"type":"string","title":"External order number"},"symbolName":{"type":"string","title":"Trading Product"},"direction":{"type":"string","title":"Buy/Sell"},"openClose":{"type":"integer","title":"Open/Close position 1-Open position 2-Close position"},"bizType":{"type":"integer","title":"Order type"},"numberStatisticMode":{"type":"integer","title":"Quantity statistics method 1: by quantity 2: by amount\""},"positionId":{"type":"integer","title":"Position number"},"dealId":{"type":"integer","title":"Deal Number"},"counterpartyDealId":{"type":"string","title":"Counterparty transaction number"},"startTime":{"type":"integer","title":"Start Time"},"endTime":{"type":"integer","title":"End Time"}},"required":["accountType","externalOrderId","symbolName","direction","openClose","bizType","positionId","dealId","counterpartyDealId","startTime","endTime","numberStatisticMode"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"executeTime":{"type":"integer","title":"Transaction time"},"dealId":{"type":"integer","title":"Deal Number"},"accountType":{"type":"integer","title":"Account type 1.A Book account 2.Net position single order account 3.Large order stp account"},"customerNo":{"type":"string","title":"Client number"},"symbolName":{"type":"string","title":"Trading Product"},"openClose":{"type":"integer","title":"Open/Close position 1-Open position 2-Close position"},"direction":{"type":"integer","title":"Buy/Sell"},"bizType":{"type":"integer","title":"Order type"},"executeAmount":{"type":"string","title":"Deal amount"},"tradeCurrency":{"type":"string","title":"Turnover Currency"},"executeVolume":{"type":"string","title":"Volume (Lots)"},"requestPrice":{"type":"string","title":"Entrustment price"},"executePrice":{"type":"string","title":"Average transaction price"},"profitLoss":{"type":"string","title":"Profit and Loss"},"commission":{"type":"string","title":"Commission fee"},"interest":{"type":"string","title":"Interest"},"requestTime":{"type":"integer","title":"Order time"},"remark":{"type":"string","title":"Remarks"}},"required":["customerNo","accountType","symbolName","direction","bizType","executeVolume","requestPrice","dealId","executePrice","executeAmount","interest","profitLoss","requestTime","remark","openClose","executeTime","tradeCurrency","commission"]}}},"headers":{}}}}}}} ``` ## POST /api/cats-gateway/global/benefit.app.ReportDatadDubboService.settlementProfitLossDayReport > Market maker settlement profit and loss daily report ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Market Maker"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/api/cats-gateway/global/benefit.app.ReportDatadDubboService.settlementProfitLossDayReport":{"post":{"summary":"Market maker settlement profit and loss daily report","deprecated":false,"description":"","tags":["Market Maker"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"startTime":{"type":"integer","title":"Start Time"},"endTime":{"type":"integer","title":"End Time"},"regeneration":{"type":"boolean","title":"Regenerate?"}},"required":["startTime","endTime","regeneration"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"date":{"type":"string","title":"Date"},"matchProfit":{"type":"integer","title":"Matched Profit (USD)"},"matchLoss":{"type":"integer","title":"Matched Loss (USD)"},"matchNetProfitLoss":{"type":"string","title":"Net Matched Profit and Loss (USD)"},"stpProfit":{"type":"string","title":"Shot Profit (USD)"},"stpLoss":{"type":"string","title":"Shot Loss (USD)"},"stpNetProfitLoss":{"type":"string","title":"Net Shot Profit and Loss (USD)"},"totalNetProfitLoss":{"type":"string","title":"Total Net Profit and Loss (USD)"},"executeTime":{"type":"integer","title":"Execution Time"}},"required":["matchNetProfitLoss","matchLoss","stpProfit","stpLoss","matchProfit","stpNetProfitLoss","date","executeTime","totalNetProfitLoss"]}}},"headers":{}}}}}}} ``` ## POST /marketNetStatistics > Market maker net position statistics report ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Market Maker"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/marketNetStatistics":{"post":{"summary":"Market maker net position statistics report","deprecated":false,"description":"","tags":["Market Maker"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"symbolName":{"type":"string","title":"Trading Product"}},"required":["symbolName"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"symbolName":{"type":"string","title":"Trading Product"},"longPositionVolume":{"type":"string","title":"Long position number of contracts"},"shortPositionVolume":{"type":"string","title":"Short position number of contracts"},"netPositionVolume":{"type":"string","title":"Net position number of contracts"},"lpDealDirection":{"type":"string","title":"LP net position number of contracts"},"stpLongThreshold":{"type":"string","title":"Single shot long position threshold (lots)"},"stpShortThreshold":{"type":"string","title":"Single shot short position threshold (lots)"},"status":{"type":"integer","title":"Set status 1-Enabled 2-Not enabled"}},"required":["symbolName","longPositionVolume","shortPositionVolume","netPositionVolume","lpDealDirection","stpLongThreshold","stpShortThreshold","status"]}}},"headers":{}}}}}}} ``` ## Net position configuration-query list of products not configured > Query list of products not configured ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Market Maker"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/config.app.AppJcStrategyDubboService.getSymbolList":{"post":{"summary":"Net position configuration-query list of products not configured","deprecated":false,"description":"Query list of products not configured","operationId":"getSymbolList","tags":["Market Maker"],"parameters":[{"name":"companyId","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"tradeType":{"type":"integer","format":"int64","description":"Game ID"},"name":{"type":"string","description":"Product Name or Code"}},"required":["tradeType"]}}}},"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"}}}},"ok":{"type":"boolean"},"fail":{"type":"boolean"}}}}},"headers":{}}}}}}} ``` ## Net position configuration - Query AMM passive market maker account balance > Query list of products not configured ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Market Maker"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/config.app.AppJcStrategyDubboService.queryJcAllAccount":{"post":{"summary":"Net position configuration - Query AMM passive market maker account balance","deprecated":false,"description":"Query list of products not configured","operationId":"getSymbolList","tags":["Market Maker"],"parameters":[{"name":"companyId","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"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":{"c":{"type":"object","properties":{"accountId":{"type":"string","description":"Account ID"},"balance":{"type":"string","description":"Balance"}},"required":["accountId","balance"]},"active":{"type":"object","properties":{"accountId":{"type":"string","description":"Account ID"},"balance":{"type":"string","description":"Account ID"}},"required":["accountId","balance"]},"passive":{"type":"object","properties":{"accountId":{"type":"string","description":"Account ID"},"balance":{"type":"string","description":"Account ID"}},"required":["accountId","balance"]},"stpBlack":{"type":"object","properties":{"accountId":{"type":"string","description":"Account ID"},"balance":{"type":"string","description":"Account ID"}},"required":["accountId","balance"]},"stpNetPosition":{"type":"object","properties":{"accountId":{"type":"string","description":"Account ID"},"balance":{"type":"string","description":"Account ID"}},"required":["accountId","balance"]}},"description":"Data Body","required":["c","active","passive","stpBlack","stpNetPosition"]},"ok":{"type":"boolean"},"fail":{"type":"boolean"}}}}},"headers":{}}}}}}} ``` ## POST /marketStpStatistics > Market Maker Blacklist Order Statistics Report ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Market Maker"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/marketStpStatistics":{"post":{"summary":"Market Maker Blacklist Order Statistics Report","deprecated":false,"description":"","tags":["Market Maker"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"startTime":{"type":"integer","title":"Start Time"},"endTime":{"type":"integer","title":"End Time"},"symbolName":{"type":"string","title":"Trading Product"},"direction":{"type":"integer","title":"Buy/Sell Type; 1-Buy; 2-Sell"},"positionId":{"type":"integer","title":"Position number"},"dealId":{"type":"integer","title":"Deal Number"},"externalOrderId":{"type":"string","title":"External order number"},"lpDealId":{"type":"string","title":"LP Deal Number"}},"required":["externalOrderId","symbolName","direction","positionId","dealId","startTime","endTime","lpDealId"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"accountType":{"type":"integer","title":"Account type 1-Active market maker account 2-Passive market maker account 3-Shooting order account 4-C-end order account"},"symbolName":{"type":"string","title":"Trading Product"},"direction":{"type":"integer","title":"Buy/Sell Type; 1-Buy; 2-Sell"},"volumeTarget":{"type":"integer","title":"Position Lots"},"floatProfitLoss":{"type":"string","title":"Floating P/L"},"openVolumeTarget":{"type":"string","title":"Initial Lots"},"openPriceTarget":{"type":"string","title":"Opening price"},"profitPrice":{"type":"string","title":"Take profit"},"lossPrice":{"type":"string","title":"Stop loss"},"overnightInterest":{"type":"string","title":"Overnight interest"},"openMarginTarget":{"type":"string","title":"Opening margin"},"occupyTheMarginTarget":{"type":"string","title":"Margin in use"},"estimateForcePrice":{"type":"string","title":"Estimated liquidation price"},"positionId":{"type":"integer","title":"Position number"},"dealId":{"type":"integer","title":"Deal Number"},"externalOrderId":{"type":"string","title":"External order number"},"lpDealDirection":{"type":"integer","title":"LP Deal Direction"},"lpDealVolume":{"type":"string","title":"LP Deal Lots"},"lpDealPrice":{"type":"string","title":"LP Deal Price"},"lpDealId":{"type":"string","title":"LP Deal Number"},"createTime":{"type":"integer","title":"Opening time"},"remark":{"type":"string","title":"Remarks"}},"required":["accountType","symbolName","direction","openPriceTarget","volumeTarget","dealId","estimateForcePrice","openVolumeTarget","positionId","lossPrice","profitPrice","openMarginTarget","overnightInterest","floatProfitLoss","remark","externalOrderId","lpDealDirection","lpDealVolume","lpDealPrice","lpDealId","createTime","occupyTheMarginTarget"]}}},"headers":{}}}}}}} ``` ## POST /marketDay > Market maker daily report ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Market Maker"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/marketDay":{"post":{"summary":"Market maker daily report","deprecated":false,"description":"","tags":["Market Maker"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"accountType":{"type":"integer","title":"Account type 1-Active market maker account 2-Passive market maker account 3-Shooting order account 4-C-end order account 5-Market maker account (active + passive)"},"date":{"type":"string","title":"Specify date string, for example \"2023-09-16\""}},"required":["accountType","date"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"date":{"type":"string","title":"Date"},"customerNo":{"type":"string","title":"Client number"},"accountType":{"type":"string","title":"Account type 1-Active market-making account 2-Passive market-making account 3-Shooting order account 4-C-end order account 5-Market-making account (active + passive)"},"currency":{"type":"string","title":"Account currency"},"totalBalance":{"type":"string","title":"Balance"},"yesterdayTotalBalance":{"type":"string","title":"Previous day balance"},"occupyTheMargin":{"type":"string","title":"Margin in use"},"notYetInterest":{"type":"string","title":"Unsettled interest"},"contractCommission":{"type":"string","title":"Trading commission"},"yetProfitLoss":{"type":"string","title":"Realized profit and loss"},"floatProfitLoss":{"type":"string","title":"Floating P/L"},"executeTime":{"type":"integer","title":"Execution Time"}},"required":["date","customerNo","accountType","currency","totalBalance","yesterdayTotalBalance","notYetInterest","contractCommission","yetProfitLoss","floatProfitLoss","executeTime","occupyTheMargin"]}}},"headers":{}}}}}}} ``` ## Add liquidity product > bizType=makerbot.app.MMBotService.addSymbolMMBotConf\ > Add liquidity product ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Market Maker"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/makerbot.app.MMBotService.addSymbolMMBotConf":{"post":{"summary":"Add liquidity product","deprecated":true,"description":"bizType=makerbot.app.MMBotService.addSymbolMMBotConf\nAdd liquidity product","tags":["Market Maker"],"parameters":[{"name":"company","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"Token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"Version","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"symbolId":{"type":"integer","description":"Product ID","format":"int64"},"lastPrice":{"type":"string","description":"Latest transaction price"},"lastPriceAsBid":{"type":"boolean","description":"Whether to use the latest transaction price in the bid as the first level"},"strategy":{"type":"string","description":"Strategy code currently only supports fix_total_amount"},"maxLimitPrice":{"type":"string","description":"Highest price"},"minLimitPrice":{"type":"string","description":"Lowest price"},"priceInterval":{"type":"string","description":"Lowest price for buying direction"},"accountId":{"type":"integer","format":"int64","description":"Market-making fund account ID"},"amount":{"type":"string","description":"Market-making fund amount"},"currency":{"type":"string","description":"Market-making fund account currency"},"digits":{"type":"integer","description":"Market-making fund account asset decimal places"}},"required":["symbolId","lastPrice","lastPriceAsBid","strategy","maxLimitPrice","minLimitPrice","priceInterval","amount","currency","digits"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultMMBotConfVo"}}},"headers":{}}}}}},"components":{"schemas":{"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"]}}}} ``` ## Pagination query liquidity product list > bizType=makerbot.app.MMBotService.querySymbolMMBotConfPageList\ > Pagination query liquidity product list ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Market Maker"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/makerbot.app.MMBotService.querySymbolMMBotConfPageList":{"post":{"summary":"Pagination query liquidity product list","deprecated":true,"description":"bizType=makerbot.app.MMBotService.querySymbolMMBotConfPageList\nPagination query liquidity product list","tags":["Market Maker"],"parameters":[{"name":"company","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"Token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"Version","in":"header","description":"","required":false,"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"}}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultBasePageVoMMBotConfVo"}}},"headers":{}}}}}},"components":{"schemas":{"BaseResultBasePageVoMMBotConfVo":{"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":"#/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"]}}}} ``` ## Automated market makers provide liquidity for products for the first time (initial configuration) > bizType=makerbot.app.MMBotService.addAmmSymbol\ > Automated market makers provide liquidity for products for the first time (initial configuration) ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Market Maker"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/makerbot.app.MMBotService.addAmmSymbol":{"post":{"summary":"Automated market makers provide liquidity for products for the first time (initial configuration)","deprecated":false,"description":"bizType=makerbot.app.MMBotService.addAmmSymbol\nAutomated market makers provide liquidity for products for the first time (initial configuration)","tags":["Market Maker"],"parameters":[{"name":"company","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"Token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"Version","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"symbolId":{"type":"integer","description":"Product ID","format":"uint64"},"lastPrice":{"type":"string","description":"Latest transaction price (starting price), must be within the highest and lowest price range"},"lastPriceAsBid":{"type":"boolean","description":"Whether to use the latest transaction price in the bid as the first level"},"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","description":"Aggregated account ID"}},"required":["symbolId","lastPrice","lastPriceAsBid","strategy","maxLimitPrice","minLimitPrice","priceInterval","amount","accountId"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultAmmSymbolInfoVo"}}},"headers":{}}}}}},"components":{"schemas":{"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"]},"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"]}}}} ``` ## Automated market makers provide liquidity for products (add new maker account) > bizType=makerbot.app.MMBotService.addAmmMaker ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Market Maker"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/makerbot.app.MMBotService.addAmmMaker":{"post":{"summary":"Automated market makers provide liquidity for products (add new maker account)","deprecated":false,"description":"bizType=makerbot.app.MMBotService.addAmmMaker","tags":["Market Maker"],"parameters":[{"name":"company","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"Token","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"Version","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddAmmMakerDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultAmmSymbolInfoVo"}}},"headers":{}}}}}},"components":{"schemas":{"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"]},"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"]},"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"]}}}} ``` ## Automated market makers add liquidity to products (add funds to existing maker account) > bizType=makerbot.app.MMBotService.addAmmAmount ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Market Maker"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/makerbot.app.MMBotService.addAmmAmount":{"post":{"summary":"Automated market makers add liquidity to products (add funds to existing maker account)","deprecated":false,"description":"bizType=makerbot.app.MMBotService.addAmmAmount","tags":["Market Maker"],"parameters":[{"name":"company","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"Token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"Version","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddAmmAmountDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultAmmSymbolInfoVo"}}},"headers":{}}}}}},"components":{"schemas":{"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"]},"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"]},"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"]}}}} ``` ## Automated market makers obtain liquidity product configuration information based on product ID > bizType=makerbot.app.MMBotService.queryAmmSymbolInfo\ > Return result: data empty, indicating maker can be configured for the first time;\ > data not empty and marketMaker attribute empty, indicating new maker can be configured for the second time;\ > data not empty and marketMaker attribute not empty, indicating maker can add liquidity funds; ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Market Maker"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/makerbot.app.MMBotService.queryAmmSymbolInfo":{"post":{"summary":"Automated market makers obtain liquidity product configuration information based on product ID","deprecated":false,"description":"bizType=makerbot.app.MMBotService.queryAmmSymbolInfo\nReturn result: data empty, indicating maker can be configured for the first time;\n data not empty and marketMaker attribute empty, indicating new maker can be configured for the second time;\n data not empty and marketMaker attribute not empty, indicating maker can add liquidity funds;","tags":["Market Maker"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"symbolId":{"type":"integer","format":"uint64","description":"Product ID"},"accountId":{"type":"string","description":"Account ID"}},"required":["symbolId","accountId"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultAmmSymbolInfoVo"}}},"headers":{}}}}}},"components":{"schemas":{"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"]},"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"]}}}} ``` ## Automated market makers obtain liquidity funds based on product ID > bizType=makerbot.app.MMBotService.getAmmSymbolAmount\ > The returned amount is the profit and loss currency amount of the product, which needs to be converted into the account currency amount ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Market Maker"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/makerbot.app.MMBotService.getAmmSymbolAmount":{"post":{"summary":"Automated market makers obtain liquidity funds based on product ID","deprecated":false,"description":"bizType=makerbot.app.MMBotService.getAmmSymbolAmount\nThe returned amount is the profit and loss currency amount of the product, which needs to be converted into the account currency amount","tags":["Market Maker"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"symbolId":{"type":"integer","format":"uint64","description":"Product ID"},"accountId":{"type":"string","description":"Account ID"}},"required":["symbolId","accountId"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultAmmSymbolAmountVo"}}},"headers":{}}}}}},"components":{"schemas":{"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":"#/components/schemas/AmmSymbolAmountVo"}},"title":""},"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"]}}}} ``` ## Automated market maker query for products with provided liquidity pagination data > bizType=makerbot.app.MMBotService.queryAmmSymbolPage\ > Returns the profit and loss currency amount of the product, needs to be converted to the account currency amount ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Market Maker"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/makerbot.app.MMBotService.queryAmmSymbolPage":{"post":{"summary":"Automated market maker query for products with provided liquidity pagination data","deprecated":false,"description":"bizType=makerbot.app.MMBotService.queryAmmSymbolPage\nReturns the profit and loss currency amount of the product, needs to be converted to the account currency amount","tags":["Market Maker"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"size":{"type":"integer","format":"uint32","description":"Number of Items per Page"},"current":{"type":"integer","format":"uint32","description":"Current Page"},"accountId":{"type":"integer","format":"int64","description":"Account ID"},"symbolCode":{"type":"string","description":"Product source code fuzzy query"},"symbolName":{"type":"string","description":"Product name"}},"required":["size","current","accountId","symbolName"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultBasePageVoAmmSymbolInfoVo"}}},"headers":{}}}}}},"components":{"schemas":{"BaseResultBasePageVoAmmSymbolInfoVo":{"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":"#/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"]}}}} ``` ## POST /api/cats-gateway/global/benefit.app.ReportDatadDubboService.getUnclaimedMarketAmount > Profit-sharing - Query unclaimed market-making income ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Market Maker"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/api/cats-gateway/global/benefit.app.ReportDatadDubboService.getUnclaimedMarketAmount":{"post":{"summary":"Profit-sharing - Query unclaimed market-making income","deprecated":false,"description":"","tags":["Market Maker"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"longIncome":{"type":"string","title":"Long income"},"longIncomePercent":{"type":"string","title":"Long income percentage"},"shortIncome":{"type":"string","title":"Short income"},"shortIncomePercent":{"type":"string","title":"Short income percentage"},"accountCurrency":{"type":"string","title":"Account currency"}},"required":["longIncome","longIncomePercent","shortIncome","shortIncomePercent","accountCurrency"]}}},"headers":{}}}}}}} ``` ## POST /api/cats-gateway/global/benefit.app.ReportDatadDubboService.extractUnclaimedMarketAmount > Profit-sharing - Withdraw market-making income ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Market Maker"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/api/cats-gateway/global/benefit.app.ReportDatadDubboService.extractUnclaimedMarketAmount":{"post":{"summary":"Profit-sharing - Withdraw market-making income","deprecated":false,"description":"","tags":["Market Maker"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{}}}},"headers":{}}}}}}} ``` ## POST /api/cats-gateway/global/benefit.app.ReportDatadDubboService.getLevel > Profit-sharing - Query market-making level ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Market Maker"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/api/cats-gateway/global/benefit.app.ReportDatadDubboService.getLevel":{"post":{"summary":"Profit-sharing - Query market-making level","deprecated":false,"description":"","tags":["Market Maker"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"makerLevel":{"type":"string","title":"Maker level"},"takerLevel":{"type":"string","title":"Taker level"}},"required":["makerLevel","takerLevel"]}}},"headers":{}}}}}}} ``` ## POST /getNetPositionStatistics > Net position lot statistics ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Market Maker"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/getNetPositionStatistics":{"post":{"summary":"Net position lot statistics","deprecated":false,"description":"","tags":["Market Maker"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"symbolName":{"type":"string","title":"Product name"}},"required":["symbolName"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"longVolume":{"type":"string","title":"Long position lot"},"shortVolume":{"type":"string","title":"Short position lot"},"totalVolume":{"type":"string","title":"Total lot"}},"required":["longVolume","shortVolume","totalVolume"]}}},"headers":{}}}}}}} ``` ## POST /getNetFloatProfitStatistics > Net position floating profit and loss statistics ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Market Maker"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/getNetFloatProfitStatistics":{"post":{"summary":"Net position floating profit and loss statistics","deprecated":false,"description":"","tags":["Market Maker"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"symbolName":{"type":"string","title":"Product name"}},"required":["symbolName"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"longFloatProfit":{"type":"string","title":"Long profit and loss"},"shortFloatProfit":{"type":"string","title":"Short profit and loss"},"totalFloatProfit":{"type":"string","title":"Total profit and loss"}},"required":["longFloatProfit","shortFloatProfit","totalFloatProfit"]}}},"headers":{}}}}}}} ``` ## POST /api/cats-gateway/global/benefit.app.ReportDatadDubboService.marketIncomeReport > Profit-sharing-Market-making income statement query ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Market Maker"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/api/cats-gateway/global/benefit.app.ReportDatadDubboService.marketIncomeReport":{"post":{"summary":"Profit-sharing-Market-making income statement query","deprecated":false,"description":"","tags":["Market Maker"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"startTime":{"type":"string","title":"Start Time"},"endTime":{"type":"string","title":"End Time"},"direction":{"type":"string","title":"Buy/Sell Direction"},"symbolName":{"type":"string","title":"Product name"},"dealId":{"type":"string","title":"Deal Number"},"openClose":{"type":"string","title":"Open/Close position 1-Open position 2-Close position"},"bizType":{"type":"string","title":"Order type"}},"required":["startTime","openClose","dealId","symbolName","direction","endTime","bizType"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"customerNo":{"type":"string","title":"User ID"},"customerId":{"type":"string","title":"User ID"},"companyId":{"type":"string","title":"Company ID"},"dealId":{"type":"string","title":"Deal Number"},"symbolName":{"type":"string","title":"Trading Product"},"openClose":{"type":"string","title":"Open/Close"},"direction":{"type":"string","title":"Buy/Sell"},"bizType":{"type":"string","title":"Order type"},"executePrice":{"type":"string","title":"Deal price"},"executeVolume":{"type":"string","title":"Deal quantity"},"executeAmount":{"type":"string","title":"Deal amount"},"executeAmountU":{"type":"string","title":"Trading volume in USD"},"executeTime":{"type":"string","title":"Transaction time"},"level":{"type":"string","title":"Level"},"percent":{"type":"string","title":"Ratio"},"amount":{"type":"string","title":"Market-making income"}},"required":["customerNo","executeAmount","executeVolume","executePrice","bizType","direction","openClose","symbolName","dealId","companyId","customerId","level","executeTime","executeAmountU","amount","percent"]}}},"headers":{}}}}}}} ``` ## POST /api/cats-gateway/global/benefit.app.ReportDatadDubboService.trafficStatisticsDayReport > Profit Sharing - Daily Flow Statistics Report Query ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Market Maker"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/api/cats-gateway/global/benefit.app.ReportDatadDubboService.trafficStatisticsDayReport":{"post":{"summary":"Profit Sharing - Daily Flow Statistics Report Query","deprecated":false,"description":"","tags":["Market Maker"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"startTime":{"type":"string","title":"Start Time"},"endTime":{"type":"string","title":"End Time"},"regeneration":{"type":"boolean","title":"Regenerate?"}},"required":["startTime","regeneration","endTime"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"takerLongTraffic":{"type":"string","title":"Taker Long Flow"},"takerShortTraffic":{"type":"string","title":"Taker Short Flow"},"takerLongTrafficFee":{"type":"string","title":"Taker Long Flow Fee"},"takerShortTrafficFee":{"type":"string","title":"Taker Short Flow Fee"},"makerLongTraffic":{"type":"string","title":"Maker Long Flow"},"makerShortTraffic":{"type":"string","title":"Maker Short Flow"},"makerLongMarketAmount":{"type":"string","title":"Maker Long Market Making Revenue"},"makerShortMarketAmount":{"type":"string","title":"Maker short market making income"},"date":{"type":"string","title":"Date"},"executeTime":{"type":"string","title":"Execution Time"}},"required":["takerLongTraffic","executeTime","date","makerShortMarketAmount","makerLongMarketAmount","makerShortTraffic","makerLongTraffic","takerShortTrafficFee","takerLongTrafficFee","takerShortTraffic"]}}},"headers":{}}}}}}} ``` # Models ## The BaseResultBasePageVoAmmSymbolInfoVo object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"BaseResultBasePageVoAmmSymbolInfoVo":{"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":"#/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"]}}}} ``` ## The BasePageVoAmmSymbolInfoVo object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"BasePageVoAmmSymbolInfoVo":{"type":"object","properties":{"records":{"type":"array","description":"Result list","items":{"$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"]}}}} ``` ## The AmmSymbolAmountVo object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"]}}}} ``` ## The MarketMakerInfoVo2 object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"]}}}} ``` ## The BaseResultAmmSymbolAmountVo object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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":"#/components/schemas/AmmSymbolAmountVo"}},"title":""},"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"]}}}} ``` ## The BaseResultListFundPayChannelTypeDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The FundPayChannelTypeDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"FundPayChannelTypeDto":{"type":"object","properties":{"name":{"type":"string","description":"name"},"code":{"type":"string","description":"code"}}}}}} ``` ## The QueryPayChannelTypeDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"]}}}} ``` ## The BaseResultCustomerStatusVO object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The CustomerStatusVO object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The BaseResultCustomerDepositProposalDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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":"#/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"}}}}}} ``` ## The CustomerDepositProposalDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The QueryCustomerDepositProposalReqDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"QueryCustomerDepositProposalReqDto":{"type":"object","required":["tradeType"],"properties":{"tradeType":{"type":"integer","format":"int64","description":"Game type"},"proposalNo":{"type":"string","description":"Proposal number"}}}}}} ``` ## The AddAmmAmountDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"]}}}} ``` ## The ManualRepaymentDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"ManualRepaymentDto":{"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"}}}}}} ``` ## The AddAmmMakerDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"]}}}} ``` ## The ManualLoanDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"ManualLoanDto":{"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"}}}}}} ``` ## The BaseResultAmmSymbolInfoVo object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"]},"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"]}}}} ``` ## The AmmSymbolInfoVo object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"]},"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"]}}}} ``` ## The BaseResultBasePageVoMMBotConfVo object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"BaseResultBasePageVoMMBotConfVo":{"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":"#/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"]}}}} ``` ## The BaseResultQueryCoinPayStatusRespDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The QueryCoinPayStatusRespDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The QueryCoinPayStatusReqDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The BaseResultMMBotConfVo object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"]}}}} ``` ## The MMBotConfVo object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"]}}}} ``` ## The MarketMakerInfoVo object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"]}}}} ``` ## The BaseResultListQueryCustomerPaymentChannelRespV3Dto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The QueryCustomerPaymentChannelRespV3Dto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The CustomerGroupDepositLimitConfigV3Vo object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The QueryCustomerPaymentChannelReqV3Dto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The BaseResultQueryRemainWithdrawAmountRespDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The QueryRemainWithdrawAmountRespDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The QueryRemainWithdrawAmountReqDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The BaseResultQueryEquityPremiumRateVo object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The QueryEquityPremiumRateVo object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The PremiumRate object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The QueryWithdrawRiskConfigReqDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"QueryWithdrawRiskConfigReqDto":{"type":"object","properties":{"customerGroupId":{"type":"integer","format":"int64","description":"Customer group ID"}},"required":["customerGroupId"]}}}} ``` ## The BaseResultWithdrawCurrencyResDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The WithdrawCurrencyResDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The WithdrawCurrencyListResDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"WithdrawCurrencyListResDto":{"type":"object","properties":{"currency":{"type":"string"},"withdrawMethod":{"type":"string"}}}}}} ``` ## The QueryCustomerPaymentChannelReqV2Dto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The BaseResultQueryWithdrawLimitConfigRespDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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?"}}},"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"}}},"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"}}},"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"}}},"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"}}}}}} ``` ## The QueryWithdrawLimitConfigRespDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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?"}}},"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"}}},"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"}}},"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"}}},"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"}}}}}} ``` ## The CustomerGroupWithdrawFeeConfigDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The CustomerGroupWithdrawAmountConfigDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The CustomerGroupWithdrawTimeConfigDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The CustomerGroupWithdrawConditionConfigDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The QueryWithdrawLimitConfigReqDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The BaseResultJSONArray object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The QueryWithdrawBankReqDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"QueryWithdrawBankReqDto":{"type":"object","properties":{"withdrawMethod":{"type":"string","description":"Withdrawal method"},"withdrawCurrency":{"type":"string","description":"Withdrawal currency"}}}}}} ``` ## The BaseResultListQueryCustomerPaymentChannelRespDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The QueryCustomerPaymentChannelRespDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The CustomerGroupDepositLimitConfigVo object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The QueryCustomerPaymentChannelReqDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The BaseResultBasePageVoOpenFundsVo object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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":"#/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"}}},"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"}}},"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"}}},"BaseAssets":{"type":"object","properties":{"currencyCode":{"type":"string","description":"Currency Code"},"currencyName":{"type":"string","description":"Currency Name"},"weight":{"type":"string","description":"Weight"}}}}}} ``` ## The BasePageVoOpenFundsVo object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"BasePageVoOpenFundsVo":{"type":"object","properties":{"records":{"type":"array","description":"Result list","items":{"$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"}}},"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"}}},"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"}}},"BaseAssets":{"type":"object","properties":{"currencyCode":{"type":"string","description":"Currency Code"},"currencyName":{"type":"string","description":"Currency Name"},"weight":{"type":"string","description":"Weight"}}}}}} ``` ## The OpenFundsVo object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}},"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"}}},"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"}}},"BaseAssets":{"type":"object","properties":{"currencyCode":{"type":"string","description":"Currency Code"},"currencyName":{"type":"string","description":"Currency Name"},"weight":{"type":"string","description":"Weight"}}}}}} ``` ## The BaseAssets object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"BaseAssets":{"type":"object","properties":{"currencyCode":{"type":"string","description":"Currency Code"},"currencyName":{"type":"string","description":"Currency Name"},"weight":{"type":"string","description":"Weight"}}}}}} ``` ## The RedemptionAssetsSet object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The PurchaseAssetsSet object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The BaseResultInteger object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The BaseResultQueryCustomerDepositExchangeRateDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"]}}}} ``` ## The QueryCustomerDepositExchangeRateDtoResp object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"]}}}} ``` ## The QueryCustomerDepositExchangeRateDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The BaseResultOpenFundsVo object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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":"#/components/schemas/OpenFundsVo"},"ok":{"type":"boolean"},"fail":{"type":"boolean"}}},"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"}}},"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"}}},"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"}}},"BaseAssets":{"type":"object","properties":{"currencyCode":{"type":"string","description":"Currency Code"},"currencyName":{"type":"string","description":"Currency Name"},"weight":{"type":"string","description":"Weight"}}}}}} ``` ## The BaseResultListWithdrawMethodQueryDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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":"#/components/schemas/WithdrawMethodQueryDto"}},"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"}}}}}} ``` ## The WithdrawMethodQueryDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The QueryDepositCoinListDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The DividendInfo object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The BorrowAssetsInterest object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The BorrowStatus object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The BorrowLimit object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The BorrowInterest object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The QuoteTime object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The MarginSet object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The MarginInfo object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The CustomerLoginVO object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The SaveOrderExecuteStandardConfigReqDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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":"#/components/schemas/OrderExecuteStandardConfigDto"}}}},"OrderExecuteStandardConfigDto":{"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"}}}}}} ``` ## The OrderExecuteStandardConfigDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"OrderExecuteStandardConfigDto":{"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"}}}}}} ``` ## The BaseResultListDepositAccountCurrencyRespV2Dto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}}} ``` ## The DepositAccountCurrencyRespV2Dto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}}} ``` ## The QueryDepositAccountCurrencyListV2Dto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The TradeTime object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The HolidayTime object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The SearchSymbolBaseDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"SearchSymbolBaseDto":{"type":"object","properties":{"customerGroupId":{"type":"integer","format":"int64","description":"Client group ID"}},"required":["customerGroupId"]}}}} ``` ## The BaseResultCustomerApiVO object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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":"#/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,"}}},"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"}}}}}}} ``` ## The CustomerApiVO object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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":"#/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,"}}},"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"}}}}}}} ``` ## The CustomerApiPermissionDTO object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}}} ``` ## The BaseResultLong object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The BaseResultListOrderExecuteStandardConfigDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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":"#/components/schemas/OrderExecuteStandardConfigDto"}},"ok":{"type":"boolean"},"fail":{"type":"boolean"}}},"OrderExecuteStandardConfigDto":{"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"}}}}}} ``` ## The QueryOrderExecuteStandardConfigReqDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"QueryOrderExecuteStandardConfigReqDto":{"type":"object","required":["customerGroupId"],"properties":{"customerGroupId":{"type":"integer","format":"int64","description":"Customer group ID"}}}}}} ``` ## The BaseResultSetDepositAccountCurrencyRespDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The DepositAccountCurrencyRespDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The QueryDepositAccountCurrencyListDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The FundMarketPerfQuoteChangeChartVo object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"FundMarketPerfQuoteChangeChartVo":{"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":""}}}} ``` ## The BaseResultWithdrawAmountLimitRespDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The WithdrawAmountLimitRespDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The WithdrawAmountLimitReqDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The KycWebAddInnerDTO object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"KycWebAddInnerDTO":{"type":"object","required":["elementCode","elementValue"],"properties":{"elementValue":{"type":"string","description":"KYC element value"},"elementCode":{"type":"string","description":"KYC element"}}}}}} ``` ## The BaseResultListOrderExecuteStandardConfigSymbolDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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":{"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"}}}}}} ``` ## The OrderExecuteStandardConfigSymbolDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"OrderExecuteStandardConfigSymbolDto":{"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"}}}}}} ``` ## The QueryOrderExecuteStandardConfigSymbolListReqDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"QueryOrderExecuteStandardConfigSymbolListReqDto":{"type":"object","properties":{}}}}} ``` ## The BaseResultCryptoBlockchainRespDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}}} ``` ## The CryptoBlockchainRespDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}}} ``` ## The CryptoBlockchainReqDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The BaseResultMapStringListFundTrendChartDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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":"#/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"]}}}} ``` ## The FundTrendChartDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"FundTrendChartDto":{"type":"object","properties":{"time":{"type":"string","title":"Date"},"value":{"type":"string","title":"Y-coordinate value"}},"required":["time","value"]}}}} ``` ## The FundMarketPerfChartVo object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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":""}}}} ``` ## The BaseResult object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The BaseResultSetString object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The WithdrawCurrencyListReqDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"WithdrawCurrencyListReqDto":{"type":"object","required":["tradeType"],"properties":{"tradeType":{"type":"integer","format":"int64"},"customerGroupId":{"type":"integer","format":"int64"},"country":{"type":"string","description":"Country Code"}}}}}} ``` ## The BaseResultBasePageVoCustomerFundRedeemDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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":"#/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"}}}}}} ``` ## The BasePageVoCustomerFundRedeemDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"BasePageVoCustomerFundRedeemDto":{"type":"object","properties":{"records":{"type":"array","description":"Result list","items":{"$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"}}}}}} ``` ## The CustomerFundRedeemDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The FundRedeemQueryReqDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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":"#/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"}}}}}} ``` ## The FieldOrderDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"FieldOrderDto":{"type":"object","properties":{"column":{"type":"string","description":"Sorting Field Column"},"asc":{"type":"boolean","description":"Order Method"}}}}}} ``` ## The BaseResultFundsApplyExecuteInfoDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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":"#/components/schemas/FundsApplyExecuteInfoDto"},"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":"#/components/schemas/FundsApplyExecuteRecordDetailDto"}}}},"FundsApplyExecuteRecordDto":{"type":"object","properties":{"amount":{"type":"number","description":"Profit Currency Amount"},"profitCurrency":{"type":"string","description":"Profit Currency"}}},"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"}}}}}} ``` ## The FundsApplyExecuteInfoDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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":"#/components/schemas/FundsApplyExecuteRecordDetailDto"}}}},"FundsApplyExecuteRecordDto":{"type":"object","properties":{"amount":{"type":"number","description":"Profit Currency Amount"},"profitCurrency":{"type":"string","description":"Profit Currency"}}},"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"}}}}}} ``` ## The FundsApplyExecuteRecordDetailDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The FundsApplyExecuteRecordDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"FundsApplyExecuteRecordDto":{"type":"object","properties":{"amount":{"type":"number","description":"Profit Currency Amount"},"profitCurrency":{"type":"string","description":"Profit Currency"}}}}}} ``` ## The QueryFundsApplyExecuteRecordDetailReqDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"QueryFundsApplyExecuteRecordDetailReqDto":{"type":"object","required":["applyIds"],"properties":{"applyIds":{"type":"array","description":"Fund Product Subscription Record ID List","items":{"type":"integer","format":"int64"}}}}}}} ``` ## The BaseResultSpotTradeRecordVo object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The SpotTradeRecordVo object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The SpotTradeRecordList object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The SpotQueryOrderRecordPageDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The BaseResultListRealTimeInvestCombinationDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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":""}}}} ``` ## The RealTimeInvestCombinationDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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":""}}}} ``` ## The FundInvestCombChartVo object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"FundInvestCombChartVo":{"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":""}}}} ``` ## The CountryDictVo object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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":"#/components/schemas/CountryDictVo"}}}}}}} ``` ## The SpotQueryOrderDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"SpotQueryOrderDto":{"type":"object","properties":{"orderId":{"type":"integer","format":"int64"}}}}}} ``` ## The BaseResultCreateCustomerDepositRespDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The CreateCustomerDepositRespDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The CreateCustomerDepositReqDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The BaseResultMapLongListCustomerOptionalVO object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The CustomerOptionalVO object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The DictVO object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The BaseResultListCustomerGroupWithdrawCurrencyConfigDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The CustomerGroupWithdrawCurrencyConfigDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The BaseResultBasePageVoFundManagementFeesDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The BasePageVoFundManagementFeesDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The FundManagementFeesDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The FundManagementFeesRecordDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The BaseResultListCustomerFundCurrencyDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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":"#/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"}}}}}} ``` ## The CustomerFundCurrencyDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The FundCurrencyQueryReqDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"FundCurrencyQueryReqDto":{"type":"object","required":["proposalNo"],"properties":{"proposalNo":{"type":"string","description":"Proposal number"}}}}}} ``` ## The BaseResultBasePageVoCustomerWithdrawProposalDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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":"#/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"}}}}}} ``` ## The BasePageVoCustomerWithdrawProposalDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"BasePageVoCustomerWithdrawProposalDto":{"type":"object","properties":{"records":{"type":"array","description":"Result list","items":{"$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"}}}}}} ``` ## The CustomerWithdrawProposalDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The QueryWithdrawProposalPageReqDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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":"#/components/schemas/FieldOrderDto"}},"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"}}},"FieldOrderDto":{"type":"object","properties":{"column":{"type":"string","description":"Sorting Field Column"},"asc":{"type":"boolean","description":"Order Method"}}}}}} ``` ## The CapitalTransferDiffCurrReqDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The BaseResultString object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The BaseResultBasePageVoCustomerFundApplyDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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":"#/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":"#/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"}}}}}} ``` ## The BasePageVoCustomerFundApplyDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"BasePageVoCustomerFundApplyDto":{"type":"object","properties":{"records":{"type":"array","description":"Result list","items":{"$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":"#/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"}}}}}} ``` ## The CustomerFundApplyDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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":"#/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"}}}}}} ``` ## The FundApplyRecordDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The BaseResultBasePageVoCustomerDepositProposalDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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":"#/components/schemas/CustomerDepositProposalDto"}},"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"}}},"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"}}}}}} ``` ## The BasePageVoCustomerDepositProposalDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"BasePageVoCustomerDepositProposalDto":{"type":"object","properties":{"records":{"type":"array","description":"Result list","items":{"$ref":"#/components/schemas/CustomerDepositProposalDto"}},"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"}}},"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"}}}}}} ``` ## The QueryDepositProposalPageReqDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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":"#/components/schemas/FieldOrderDto"}},"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"}}},"FieldOrderDto":{"type":"object","properties":{"column":{"type":"string","description":"Sorting Field Column"},"asc":{"type":"boolean","description":"Order Method"}}}}}} ``` ## The BaseResultCapitalTransferRecordResDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"]}}}} ``` ## The BasePageVoCapitalTransferRecordResDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"]}}}} ``` ## The CapitalTransferRecordResDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"]}}}} ``` ## The CapitalTransferRecordDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The BaseResultFundNetValueCompareDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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":""}}}} ``` ## The FundNetValueCompareDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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":""}}}} ``` ## The FundNetValueChangeQuoteChartVo object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"FundNetValueChangeQuoteChartVo":{"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":""}}}} ``` ## The BaseResultListCustomerWithdrawBankVO object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The CustomerWithdrawBankVO object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The KycAuthVO object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The KycAuthElementVO object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The CapitalTransferForAgentReqDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The BaseResultListAssets object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The Assets object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The BaseResultCustomerWithdrawProposalDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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":"#/components/schemas/CustomerWithdrawProposalDto"},"ok":{"type":"boolean"},"fail":{"type":"boolean"}}},"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"}}}}}} ``` ## The BaseResultFundRedeemSharesCheckRespDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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":{}}}}}}} ``` ## The FundRedeemSharesCheckRespDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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":{}}}}}}} ``` ## The FundRedeemSharesCheckReqDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The BaseResultListKycAuthVO object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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":"#/components/schemas/KycAuthVO"}},"ok":{"type":"boolean"},"fail":{"type":"boolean"}}},"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"}}}}}} ``` ## The BaseResultVoid object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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":{"type":"object","properties":{}}}}} ``` ## The Void object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"Void":{"type":"object","properties":{}}}}} ``` ## The BaseResultFundApplyCalcDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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":"#/components/schemas/CustomerFundCurrencyDto"}}}},"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"}}}}}} ``` ## The FundApplyCalcDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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":"#/components/schemas/CustomerFundCurrencyDto"}}}},"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"}}}}}} ``` ## The BaseResultBasePageVoCustomerAdjustProposalDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The BasePageVoCustomerAdjustProposalDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The CustomerAdjustProposalDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The QueryProposalPageReqDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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":"#/components/schemas/FieldOrderDto"}},"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"}}},"FieldOrderDto":{"type":"object","properties":{"column":{"type":"string","description":"Sorting Field Column"},"asc":{"type":"boolean","description":"Order Method"}}}}}} ``` ## The BaseResultSpotQueryOrderPageVo object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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":"#/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"}}}}}} ``` ## The BasePageVoSpotQueryOrderVo object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"BasePageVoSpotQueryOrderVo":{"type":"object","properties":{"records":{"type":"array","description":"Result list","items":{"$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"}}}}}} ``` ## The SpotQueryOrderVo object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The SpotQueryOrderPageDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The BaseResultAmountTransferVo object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"]}}}} ``` ## The AmountTransferVo object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"AmountTransferVo":{"type":"object","properties":{"surplusAmount":{"type":"string","description":"Amount of change"}},"required":["surplusAmount"]}}}} ``` ## The CapitalTransferReqDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The BaseResultMapLongListFundTrendChartTypeDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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":"#/components/schemas/FundTrendChartDto"}}},"required":["name","columnList"]},"FundTrendChartDto":{"type":"object","properties":{"time":{"type":"string","title":"Date"},"value":{"type":"string","title":"Y-coordinate value"}},"required":["time","value"]}}}} ``` ## The FundTrendChartTypeDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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":"#/components/schemas/FundTrendChartDto"}}},"required":["name","columnList"]},"FundTrendChartDto":{"type":"object","properties":{"time":{"type":"string","title":"Date"},"value":{"type":"string","title":"Y-coordinate value"}},"required":["time","value"]}}}} ``` ## The FundBatchMarketPerfChartVo object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"FundBatchMarketPerfChartVo":{"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":""}}}} ``` ## The ExchangeRateConvertDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The BaseResultQueryCustomerWithdrawExchangeRateDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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":"#/components/schemas/QueryCustomerWithdrawExchangeRateDto"},"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"}}}}}} ``` ## The QueryCustomerWithdrawExchangeRateDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The BaseResultSpotQueryOrderVo object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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":"#/components/schemas/SpotQueryOrderVo"},"ok":{"type":"boolean"},"fail":{"type":"boolean"}}},"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"}}}}}} ``` ## The SpotOrderUpdateDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The MarkOpenCardDepositRateDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The BaseResultComputeWithdrawFeeRespDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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)"}}}}}} ``` ## The ComputeWithdrawFeeRespDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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)"}}}}}} ``` ## The ComputeWithdrawReqDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The BaseResultCustomerFundRedeemDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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":"#/components/schemas/CustomerFundRedeemDto"},"ok":{"type":"boolean"},"fail":{"type":"boolean"}}},"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"}}}}}} ``` ## The CreateFundRedeemReqDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The BaseResultFundOperationInfoDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The FundOperationInfoDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The FundInfoQueryReqDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"FundInfoQueryReqDto":{"type":"object","required":["fundId"],"properties":{"fundId":{"type":"integer","format":"int64","description":"Fund ID"}}}}}} ``` ## The BaseResultFundManagementFeesCalcDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The FundManagementFeesCalcDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"FundManagementFeesCalcDto":{"type":"object","properties":{"amount":{"type":"string","description":"Total amount"},"currency":{"type":"string","description":"Currency"}}}}}} ``` ## The FundManagementFeesDeductDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"FundManagementFeesDeductDto":{"type":"object","properties":{"idList":{"type":"array","items":{"type":"integer","format":"int64"}}}}}}} ``` ## The BaseResultListExchangeRateConvertDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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":"#/components/schemas/ExchangeRateConvertDto"}},"ok":{"type":"boolean"},"fail":{"type":"boolean"}}},"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"}}}}}} ``` ## The BaseResult1 object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"BaseResult1":{"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"}}}}}} ``` ## The FundExchangeRateBatchQueryDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The CurrencyPair object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"CurrencyPair":{"type":"object","properties":{"source":{"type":"string","description":"Source Currency Code"},"target":{"type":"string","description":"Target Currency Code"}}}}}} ``` ## The BaseResultCustomerFundApplyDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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":"#/components/schemas/CustomerFundApplyDto"},"ok":{"type":"boolean"},"fail":{"type":"boolean"}}},"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":"#/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"}}}}}} ``` ## The CreateFundApplyReqDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The FundBaseDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"FundBaseDto":{"type":"object","properties":{}}}}} ``` ## The BaseResultBoolean object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The BaseResultBasePageVoSpotSubjectWaterVo object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The BasePageVoSubjectWaterVo object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The SpotSubjectWaterVo object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The SpotQueryWaterPageDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The BaseResultCustomerRechargeWalletAddrRespDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The CustomerRechargeWalletAddrRespDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The CustomerRechargeWalletAddrReqDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The BaseResultListSingleAssetPerformanceDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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":""}}}} ``` ## The SingleAssetPerformanceDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"SingleAssetPerformanceDto":{"type":"object","properties":{"type":{"type":"integer","format":"int32"},"quoteChange":{"type":"string"},"xaxisName":{"type":"string"}},"title":""}}}} ``` ## The SingeAssetPerformanceChartVo object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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":""}}}} ``` ## The BaseResultObject object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"BaseResultObject":{"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"}}}}}} ``` ## The BaseResultSpotOrderAddVo object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The SpotOrderAddVo object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The SpotOrderAddDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The BaseResultListIndexSingleAssetPerformanceVo object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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":""}}}} ``` ## The IndexSingleAssetPerformanceVo object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"IndexSingleAssetPerformanceVo":{"type":"object","properties":{"xaxisName":{"type":"string","title":"X-Axis Name"},"quoteChange":{"type":"string","title":"Price Change Percentage"}},"title":""}}}} ``` ## The BaseResultListIndexSymbolCombinationVo object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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":""}}}} ``` ## The IndexSymbolCombinationVo object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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":""}}}} ``` ## The IndexChartDto object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"IndexChartDto":{"type":"object","properties":{"indexId":{"type":"integer","format":"int64","title":"Index ID"}},"required":["indexId"],"title":""}}}} ``` ## The EnableOrForbidMFADTO object ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"components":{"schemas":{"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}}}}}} ``` # Overview > The white label open interface is used to manage its own white label data, such as customer information and customer transaction flow. Supports a variety of B-side APIs, and can provide business white labels for customized development of marketing activities. One business uses the B-side quota adjustment-bonus and system liquidation interfaces to develop marketing activities, such as airdrops for new customers, registration bonuses, and other activities. ## Example of accessing the activity system
# Access # Sign ### Signature Rules 1\. Connector Rule: > In the signature, an & represents a connector and not an operator. > > The signature rule states that the “signature” in the body is not part of the signature calculation. However, the “timestamp” in the header must be part of the body signature. 2\. Parameter Sorting: > Sort the remaining parameters by their names in ascending dictionary order (ascending ASCII order). > > **Only parameters with non-empty values and of number or string type are considered for the signature.** > > Concatenate the key-value pairs in the format “key=value”. Link multiple parameters with an & to obtain a string A. Parameters with empty values are not included in the signature. 3\. Timestamp Inclusion: > Add timestamp=TIMESTAMP\_VALUE to obtain string B. > > Concatenate B\&A to get string C. 4\. MD5 Encryption: > Encrypt string C using MD5 and convert all resulting letters to uppercase to obtain the final value D, which is the “signature” value. 5\. Signature Addition and Encoding: > Add the “signature” to the body. > > Convert the body to JSON and then encode it to get string E. 6\. RSA Encryption: > Encrypt string E using the company’s public key to obtain string F. > > If the length of F exceeds 100, encrypt F in segments of 100 using RSA and join the encrypted segments with a comma to get the final encrypted string F. 7\. Final Request Structure: > The final request parameters should be structured as follows: ```json //header { "timestamp": 11111131331, "trace": "xxxxxx" } //body { "data": F } ``` ### Signature Example 1\. Concatenation: > Concatenate the parameters in ascending order: a=1\&b=2\&c=3\×tamp=11111131331 to get string A. 2\. Timestamp: > Add timestamp: timestamp=11111131331 to get string B. 3\. Final Concatenation: > Concatenate B\&A to get string C: timestamp=11111131331\&a=1\&b=2\&c=3\×tamp=11111131331. 4\. MD5 Encryption: > Encrypt string C using MD5 and convert the result to uppercase to get the final signature key. 5\. JSON Encoding: > Convert all body parameters to JSON and then encode to get string E. 6\. RSA Encryption: > Encrypt string E using the company’s public key to get string F. > > If string E has a length greater than 100, segment E and encrypt each segment: RSA(E\[0-100])=E1, RSA(E\[remaining length])=E2, then concatenate E1 and E2 with a comma to obtain the final encrypted string F (F = E1,E2). ```json //header { "timestamp": 11111131331, "trace": "xxxxxx" } //body { "a": 1, "b": 2, "c": "3", "signature": "44b3a042-dd5d-4796-92e1-651927b6ada9" } ``` ### Trace {% hint style="info" %} Trace is the unique identifier of the request. The trace field will also be returned when the interface responds. \ Note: **`x-`** must be added at the beginning of trace to indicate that the parameters are encrypted during this request. Only parameters with non-empty values and of number or string type are considered for the signature {% endhint %} ### JAVA DEMO # Request ## 1.Interface address=>HTTP ``` http://ip:port/path/ ``` DEMO如下： ```http POST http://127.0.0.1:9008/openapi-b/auth/{bizType} # auth POST http://127.0.0.1:9008/openapi-b/{bizType} # request ... ``` Request method: POST ### 1.2 Request ``` Request header information Request body information, transmitted in the form of content-type=application/json ``` #### 1.2.1 Header Request Parameters | parameter | type | required | describe | | --------- | ------ | ------------ | -------------------------------------------- | | companyId | long | Required | System unique company identifier | | trace | String | Required | Global link unique identifier | | timestamp | long | Required | Timestamp, milliseconds | | version | String | Not required | Interface version number | | group | String | Not required | Interface Grouping | | lang | String | Not required | Language information, default is zh-CN | | token | String | Not required | Token information, required after logging in | #### 1.2.2 Request Body Parameters | parameter | type | required | describe | | --------- | ---- | -------- | ------------------------- | | bizBody | JSON | Required | Request message body，JSON | ## 1.2 Interface address=>websocket ``` ws://ip:port/path/ws ``` The DEMO is as follows: ``` ws://127.0.0.1:9008/openapi-b/ws ``` # Limit ## Speed ​​Limit MultiMarkets aims to provide a stable and secure platform for all users at all times. Therefore, all parties continuously monitor traffic to identify patterns that could negatively impact the network. If the traffic from a single account is identified as too high and the rate limit is reached, MultiMarkets may temporarily throttle or restrict that account. You have a rate limit on a per API endpoint and per minute basis. If your rate limit is reached, you will see an HTTP 429 error response letting you know that your rate limit has been temporarily exceeded. Partners should handle HTTP 429 status codes gracefully and drop and/or retry requests accordingly. The following headers are returned with every request. If a less restrictive rate limit is required, please contact your implementation manager to determine your use case. Please note that increasing the rate limit may incur additional charges. ## Parameters The response header returned by the interface will include the following three fields, which respectively represent: x-ratelimit-limit represents the total number of calls that can be made in the current cycle, x-ratelimit-remairing represents the number of remaining calls in the current cycle, and x-ratelimit-reset represents the cycle time in seconds. > x-ratelimit-limit: 300 > > x-ratelimit-remairing: 299 > > x-ratelimit-reset: 60 The above example: indicates that the interface can be called 300 times per minute, and currently there are 299 remaining calls that can be called # Error Code ```properties G500=System error GGATEWAY_CODE_001=TOKEN is null GGATEWAY_CODE_002=Invalid business type GGATEWAY_CODE_003=Company ID cannot be null GGATEWAY_CODE_004=Link sign cannot be null GGATEWAY_CODE_005=Login info is expired, please login again GGATEWAY_CODE_006=Request params is null GGATEWAY_CODE_008=Business type cannot be null GGATEWAY_CODE_009=Head request cannot be null GGATEWAY_CODE_010=Downstream port does not exist GGATEWAY_CODE_011=Downstream service is abnormal, please contact customer service GGATEWAY_CODE_012=Downstream service is unavailable GGATEWAY_CODE_013=The downstream service return an empty result GGATEWAY_CODE_014=Request expired GGATEWAY_CODE_015=The request parameter is invalid GGATEWAY_CODE_016=The current interface does not support this request type GGATEWAY_CODE_017=Login info is expired, please login again GGATEWAY_CODE_018=The request frequency is too fast, please try again later GGATEWAY_CODE_101=Invalid account info GGATEWAY_CODE_102=Data is abnormal, please try again later GGATEWAY_CODE_103=The current upload file format is not supported, please upload the file in %s format GGATEWAY_CODE_104=The current interface parameters are abnormal, please check and try again GGATEWAY_CODE_902=Service time out, please contact customer service GGATEWAY_CODE_019=No access rights USCUSTOMER_API_0000141=Your email has been bound to another %s account, please try again with another email USCUSTOMER_API_0000002=System error, API is abolish USCUSTOMER_API_0000003=Data not exist USCUSTOMER_API_0000004=Working in progress, current action is not allowed USCUSTOMER_API_0000005=Data is abnormal, please try again later USCUSTOMER_API_0000006=Your current APP version is too low, please download and install the latest version on the official website USCUSTOMER_API_0000007=Demo company is not allowed to register an account USCUSTOMER_API_0000008=Real account cannot reset account information USCUSTOMER_API_0000009=The Demo account is being reset, please try again after %s minutes or contact Customer Service USCUSTOMER_API_0000101=Client info exist already USCUSTOMER_API_0000102=Account number or password wrong USCUSTOMER_API_0000103=Login suspend, please contact Customer Service USCUSTOMER_API_0000104=Client info data abnormal USCUSTOMER_API_0000105=Should fill in at least mobile or email, or both USCUSTOMER_API_0000106=Mobile number already exist USCUSTOMER_API_0000107=Email exist already USCUSTOMER_API_0000108=Fail to get client number USCUSTOMER_API_0000109=Fail to obtain Company's Client Account interval USCUSTOMER_API_0000110=Company's Client account number out of interval USCUSTOMER_API_0000111=Company not exist, or suspended USCUSTOMER_API_0000112=Account number or password wrong USCUSTOMER_API_0000113=Account is suspended, login is not allowed. USCUSTOMER_API_0000114=Company asset ID not exist USCUSTOMER_API_0000115=Company asset information does\u2018t match USCUSTOMER_API_0000116=Client asset info is not matched with new Client group, transfer is not allowed USCUSTOMER_API_0000117=There is position holding, suspend is not allowed USCUSTOMER_API_0000118=There is account balance, suspen is not allowed USCUSTOMER_API_0000119=There is outstanding request, suspend is not allowed USCUSTOMER_API_0000120=New Client group do not have products authority, transfer is not allowed USCUSTOMER_API_0000121=This mobile number is connected before, please change USCUSTOMER_API_0000122=Email account is binded, please change USCUSTOMER_API_0000123=New password cannot be the same as old password USCUSTOMER_API_0000124=Old password is incorrect USCUSTOMER_API_0000125=Password cannot be null USCUSTOMER_API_0000126=Client group's corresponding type is not matched, transfer if not allow. USCUSTOMER_API_0000127=Client has liability, cannot cancel USCUSTOMER_API_0000128=Token verification failed USCUSTOMER_API_0000131=The third-party developer account is not configured or has been disabled USCUSTOMER_API_0000132=Fund password is incorrect, if you enter the wrong password %s times in a row, you will not be able to withdraw funds within %s hours. USCUSTOMER_API_0000133=Fund password has been set USCUSTOMER_API_0000134=The fund password has been entered incorrectly %s times in a row, please try again after %s hours or contact customer service USCUSTOMER_API_0000135=Login password has been set USCUSTOMER_API_0000136=Please enter the correct phone USCUSTOMER_API_0000137=Please enter the correct email USCUSTOMER_API_0000138=Client enable MFA USCUSTOMER_API_0000139=Password strength is too weak, please reset USCUSTOMER_API_0000143=The current account has already been bound to the %s account and cannot be bound again USCUSTOMER_API_0000144=The %s account has been bound, please change to another %s account USCUSTOMER_API_0000145=The type you submitted is not supported, only %s is supported USCUSTOMER_API_0000146=You have set a login password, please use the login password to log in USCUSTOMER_API_0000147=The phone number is incorrect, please check and enter again USCUSTOMER_API_0000148=The current link is invalid, please contact customer service USCUSTOMER_API_0000149=The current link has been used, please get it again USCUSTOMER_API_0000150=The current user has not set a password, and cannot use the password reset function USCUSTOMER_API_0000151=The reviewer and the submitter cannot be the same person USCUSTOMER_API_0000156=The customer does not have an email address, please bind the email address first USCUSTOMER_API_0000301=Client group info is not exist USCUSTOMER_API_0000302=Default client group cannot delete USCUSTOMER_API_0000303=Client's corresponding client group is not exist USCUSTOMER_API_0000304=Client exist under this client group, cannot delete USCUSTOMER_API_0000305=Delete client group product error USCUSTOMER_API_0000306=Account opening client group is not set, cannot register USCUSTOMER_API_0000307=Client group name cannot repeat USCUSTOMER_API_0000308=At least one account opening group in client group USCUSTOMER_API_0000309=Account opening group cannot delete USCUSTOMER_API_0000310=Account opening group aseet info is null USCUSTOMER_API_0000311=Account opening group info error USCUSTOMER_API_0000312=Account opening asset info not match USCUSTOMER_API_0000313=Account opening group trade type is null USCUSTOMER_API_0000314=Account opening trade type info is not match USCUSTOMER_API_0000315=Client group trade type asset info is not match USCUSTOMER_API_0000501=Mandatory param cannot be null USCUSTOMER_API_0000502=Mobile number cannot be null USCUSTOMER_API_0000503=Mobile number length is not correct USCUSTOMER_API_0000504=Mobile number format is not correct USCUSTOMER_API_0000505=Country code cannot be null USCUSTOMER_API_0000506=Length of country code is not correct USCUSTOMER_API_0000507=Country code is not correct USCUSTOMER_API_0000508=Email cannot be null USCUSTOMER_API_0000509=Length of email is not correct USCUSTOMER_API_0000510=Email format is not correct USCUSTOMER_API_0000511=Verification code is not correct USCUSTOMER_API_0000512=Verification code error many times,please try again later USCUSTOMER_API_0000513=New mobile verification code is not correct USCUSTOMER_API_0000514=Original mobile verification code is not correct USCUSTOMER_API_0000515=New email verification code is not correct USCUSTOMER_API_0000516=Old email verification code is not correct USCUSTOMER_API_0000517=Email verification code is not correct USCUSTOMER_API_0000518=Mobile verification code is not correct USCUSTOMER_API_0000519=Google authentication code is not correct USCUSTOMER_API_0000520=Google authentication code cannot be empty USCUSTOMER_API_0000521=Least one of the email and mobile verification code cannot be empty USCUSTOMER_API_0000601=KYC is submitted, it is under investigation, please wait USCUSTOMER_API_0000602=Company did not set KYC authentication info USCUSTOMER_API_0000603=Client's KYC authentication info is not found USCUSTOMER_API_0000604=Client's KYC authentication is passed USCUSTOMER_API_0000605=KYC is submitted and under investigation, please wait USCUSTOMER_API_0000606=Client KYC authentication is rejected USCUSTOMER_API_0000607=Client's KYC authentication info is null USCUSTOMER_API_0000608=Record is approved, please don't repeat USCUSTOMER_API_0000609=Business current KYC authentication info USCUSTOMER_API_0000610=KYC authentication fail USCUSTOMER_API_0000611=KYC authentication info not exist USCUSTOMER_API_0000612=KYC info not exist USCUSTOMER_API_0000613=KYC info save fail USCUSTOMER_API_0000614=KYC element exist in that KYC level USCUSTOMER_API_0000615=KYC corresponding info or sequence is null USCUSTOMER_API_0000616=KYC cannot bypass level setting USCUSTOMER_API_0000617=Business environment exist in other KYC level USCUSTOMER_API_0000618=KYC element exist in other KYC level USCUSTOMER_API_0000619=Delete KYC with higher level first USCUSTOMER_API_0000620=KYC element format error USCUSTOMER_API_0000624=This country does not support opening a business account USCUSTOMER_API_0000632=The phone number you entered has already been used USCUSTOMER_API_0000633=The ID number you entered has already been used USCUSTOMER_API_0000701=Bank card no exist already USCUSTOMER_API_0000702=Can add up to 5 wallet with same currency USCUSTOMER_API_0000703=This currency wallet already exists USCUSTOMER_API_0000705=There are already more than one payout address of this type USCUSTOMER_API_0000706=This type of payout address does not exist USCUSTOMER_API_0000707=The bank account already exists USCUSTOMER_API_0000801=Suspend info not exist USCUSTOMER_API_0000802=Account suspend fail USCUSTOMER_API_0000803=There is position holding, verification fail USCUSTOMER_API_0000804=There is account balance, verification fail USCUSTOMER_API_0000805=Outstanding request not complete, verification fail USCUSTOMER_API_0000807=Your account cancellation application has been submitted successfully.It will be process within 1-2 working days. USCUSTOMER_API_0000901=Agnet ID info decrypt fail USCUSTOMER_API_0000902=Third party service acion invalid USCUSTOMER_API_0000903=Superior agent no. is null USCUSTOMER_API_00010001=Your account opening application has been received, we will process it as soon as possible, if you have any questions, please contact customer service USCUSTOMER_API_00010002=Sorry, account opening failed, if you have any questions, please contact customer service USCUSTOMER_API_00011001=The requested permission is invalid USCUSTOMER_API_00011002=The API number of applications has exceeded the limit USCUSTOMER_API_00011003=The API label already exists USCUSTOMER_API_0000142=Your mobile has been bound to another %s account, please try again with another mobile\ USCUSTOMER_API_0000157=The customer is locked and operations are prohibited. USCUSTOMER_API_0000158=The customer is disabled, operation prohibited. USCUSTOMER_API_0001001=The country you selected is same as current country, action is not allowed USCUSTOMER_API_0001002=Your identity verification of located country is approved, amend Country is not allowed USCUSTOMER_API_0001003=The country you selected is not currently supported USCUSTOMER_API_0001004=The area code and mobile number you entered cannot be the same as the old area code and mobile number USCUSTOMER_API_0001005=The email you entered cannot be the same as the old email USCUSTOMER_API_0001006=1. Sorry, withdrawal is prohibited within %s hours after the login password is set, and you can perform the withdrawal operation later;\n2. If you have any questions or need help, please contact online customer service. USCUSTOMER_API_0001007=1. Sorry, withdrawal is prohibited within %s hours after setting the fund password, and you can withdraw later;\n2. If you have any questions or need help, please contact online customer service. USCUSTOMER_API_0001008=1. I'm very sorry, withdrawal is prohibited within %s hours after changing the login password, you can perform the withdrawal operation later;\n2. If you have any questions or need help, please contact online customer service. USCUSTOMER_API_0001009=1. Sorry, withdrawal is prohibited within %s hours after resetting the login password, and you can withdraw later;\n2. If you have any questions or need help, please contact online customer service. USCUSTOMER_API_0001010=1. I'm very sorry, withdrawal is prohibited within %s hours after changing the fund password, you can perform the withdrawal operation later;\n2. If you have any questions or need help, please contact online customer service. USCUSTOMER_API_0001011=1. Sorry, withdrawal is prohibited within %s hours after resetting the fund password, you can perform the withdrawal operation later;\n2. If you have any questions or need help, please contact online customer service. USCUSTOMER_API_0001012=1. I'm very sorry, withdrawal is prohibited within %s hours after changing the email address, you can perform the withdrawal operation later;\n2. If you have any questions or need help, please contact online customer service. USCUSTOMER_API_0001013=1. I'm very sorry, cash withdrawal is prohibited within %s hours after changing the mobile phone, you can perform the cash withdrawal operation later;\n2. If you have any questions or need help, please contact online customer service. USCUSTOMER_API_0001014=1. Sorry, the newly added withdrawal address is prohibited within %s hours, you can withdraw later;\n2. If you have any questions or need help, please contact online customer service. USCUSTOMER_API_0001015=The withdrawal address format is abnormal USCUSTOMER_API_0001016=The current delivery address does not exist, please check the data USCUSTOMER_API_0001017=The currency and network you selected are currently not supported by the system, please select again USCUSTOMER_API_0001018=%s verification code is incorrect USCUSTOMER_API_0001019=The current customer has already set up email, can not be repeated USCUSTOMER_API_0001020=The current customer has already set up phone, can not be repeated USCUSTOMER_API_0001021=The current client has not bound %s, please bind first USCUSTOMER_API_0001022=The current customer has not set up phone or email, and cannot bind Google Authenticator USCUSTOMER_API_0001023=The current customer has not set up phone and email, and cannot set login password USCUSTOMER_API_0001024=Tourist customer group cannot register and open an account USCUSTOMER_API_0001025=The current interface parameters are abnormal, please check and try again USCUSTOMER_API_0001026= USCUSTOMER_API_0001027=This client\u2018s proxy proposal requesting has been approved. USCUSTOMER_API_0001028=The client is already a proxy. USCUSTOMER_API_0001029=No access rights USCUSTOMER_API_0001030=The unique identifier for the third-party system does not exist, please verify the data USCUSTOMER_API_0001031=Third-party system unique identification number error, please verify the data. USCUSTOMER_API_0001032=The proxy application proposal has not been approved, operation is prohibited. USCUSTOMER_API_0001033=The organization information of the current customer does not exist, operation is prohibited. USCUSTOMER_API_0001034=The current customer is already an organizational credit account and cannot apply for agency. USCUSTOMER_API_0001035=Company information does not exist, operation prohibited USCUSTOMER_API_0001036=Failed to check balance, service exception. USCUSTOMER_API_0001037=Failed, the isolated margin contract trading is not enabled. USCUSTOMER_API_0001038=Please bind your phone number first. USCUSTOMER_API_0001039=Please bind the email first. USCUSTOMER_API_0001040=Please bind Google Authenticator first. USCUSTOMER_API_0001050=Your account has been locked due to 5 consecutive incorrect password attempts. Please contact customer service for assistance FS500=System error FS400=Request params invalid FS501=Update fail FS401=Invalid request FS404=Data is not found FS10001=Required parameters cannot be empty FS10002=Invalid parameter FS10003=The transfer amount of funds must be greater than 0 FS10005=Up to 50 currency pairs exchange rates can be queried in a single request FS10100=Payment gateway is already exist FS10101=Payment gateway name is already existed FS10200=Payment gateway is already exist FS10201=Payment gateway is suspended FS10202=This payment gateway is not allocated FS10300=Deposit request is invalid, this action is not allowed FS10301=Deposit request is not out of time, please operate after it is out of time FS10302=Deposit request status not allow this action FS20001=Failed to call interface FS20002=Call interface exception FS50000=Account enquiry unusual FS50001=Deopsit is not allowed currently FS50002=No payment gateway FS50003=No payment gateway FS50004=Deopsit is not allowed currently FS50005=Deopsit amount cannot smaller than minimum amount FS50006=Parameter setting is wrong FS50007=Deposit amount cannot exceed maximum amount FS50008=Account Credit fail FS50009=Fail to get Exchange rate FS50010=Pyament gateway notice deposit request not exist FS50011=Pyament gateway notice data verification signature is not passed FS50012=Pyament gateway notice data gateway setting is not existed FS50013=Payment gateway request fail FS50014=Send Message failure FS50015=Account activate fail FS50016=Payment gateway cannot be used FS50017=Bank card enquiry error FS50018=Bank card info is not conneected FS50019=Account currency repeat FS50020=Fee calculation error FS50022=Deposit time format error FS50023=Payment gateway repeat FS50024=No payment gateway FS50025=Transfer is not allowed currently FS51001=Fail to update withdrawal request data FS51002=Withdraw client roll back fail FS51003=Debit withdrawal account fail FS51004=Action is not allowed with thsi withdrawal request status FS51005=Fail to obtain exchange rate FS51006=Account enquiry fail FS51007=Param setting error FS51008=Incorrect setup, currently cannot withdraw, please contact Customer Service FS51011=Account should be activated to withdraw FS51012=Withdrawal is not alloed this time FS51013=Withdrawl amount is not within the range FS51014=Withdrawal amount cannot less than minimum amount FS51015=Withdrawal amount cannot exceed maximum amount FS51016=Withdrawal time exceed the maximum with 24 hours FS51017=Fee calculation is abnormal FS51018=Debit fee fail FS51019=There is withdrawal request is progressing, please try again later FS51020=Account currency repeat FS51021=Withdrawal is not allowed at this time FS51022=Withdrawal time format error FS51024=This currency is not supported for withdrawal at the moment, please change to another currency or contact customer service FS51025=No withdrawals are allowed within %s minute(s) after changing the password FS51026=No withdrawals are allowed within %s after changing the mobile phone or email FS51027=Total withdrawal amount cannot exceed %s in 24 hours FS51028=Incorrect channel configuration FS51029=This currency is not supported for withdrawal at the moment, please change to another currency or contact customer service FS51030=The withdrawal method is not supported FS51031=The withdrawal currency is not configured FS51032=The same account currency exists FS51033=This currency is not supported for withdrawal at the moment, please change to another currency or contact customer service FS51034=The decimal place of the withdrawal amount is too long FS51035=Sorry, there is a problem with the withdrawal process, the funds will be returned later, if you have any questions, please contact customer service FS51036=This currency is not supported for withdrawal at the moment, please change to another currency or contact customer service FS51037=After Fund password changed, not allow to withdraw in %s minutes FS51038=Supplementary information not submitted FS51046=The request for a large withdrawal has been submitted. Please wait for the backend review FS52001=Limit adjustment add request fail FS52002=Fund password incorrect FS52003=Limit adjustment request redo fail FS52004=Limit adjustment status not allow this action FS52005=Withdrawal amount cannot exceed available amount to withdraw FS52006=The client group can not deposits FS52007=The input amount is greater than the amount can be withdrawn FS52008=Release non-withdrawal amount must be greater than 0 FS52009=Release non-withdrawal amount is greater than the non-withdrawal amount FS520010=Account ID does not match tradeType FS520011=This record already exists FS10304=The account are not allowed to deposit, if you have any questions, please contact customer service FS10305=The account are not allowed withdrawals, if you have any questions, please contact customer service FS530001=Failed to get address,please use another chain to deposit FS530101=Failed to get currency information from COBO FS530102=COBO response failed FS530103=The eCard is invalid FS540001=Fund product is invalid FS540002=The fund does not support purchases FS540003=The fund does not support redemption FS540004=The minimum redemption share is %s FS540005=The asset is not within the scope of the redemption-backed asset FS540006=The asset is not within the scope of the purchase-backed asset FS540007=The minimum purchase amount is %s FS540008=When confirming shares in batches, the assets accepted by the client must be the same FS540009=Confirmed share has expired, please confirm again FS540010=There is already a pending purchase order that has not been fulfilled, please try again later FS540011=No valid NAV was obtained, please try again FS540012=Incorrect share status FS540013=Redemption failed, asset account balance is insufficient FS540014=The share confirmation failed, the balance of the asset account is insufficient, and the redemption order\uFF1A%s FS540015=Account deduction failed, please try again later FS540016=Account deduction failed, please try again later FS540017=Fail to obtain currency exchange rate setting FS540018=Verify Fund password fail FS540019=Fund management fee status is incorrect FS540020=Fund management fee execution records already exist FS540021=Google authentication code verification failed FS540022=Asset confirmation calculation failed, please try again later FS540023=The minimum purchase share for a single transaction is %s FS550001=Get product information exception FS5550002=Obtaining account asset information is abnormal FS550003=Order execution standard summary ratio cannot be greater than 100% FS550004=The account is missing assets, please check the configuration FS550005=The exchange rate configuration is incomplete, please check the configuration FS550006=The account is not configured with spot product permissions, please check the configuration FS550007=currency does not exist FS560001=Get the order execution standard ratio is abnormal, please check the order execution standard configuration FS560002=There is already an outstanding purchase execution order, please try again later FS560003=There are already completed orders in the submitted purchase execution order, please refresh the data and operate again. FS570001=Active record ID already exists FS570002=There is already an bonus record in submission, please try again later FS570003=Account processing failed, please try again later FS570004=The account from which the funds were transferred has been locked FS570005=The account to which the funds are transferred has been locked FS560004=Not authorized to perform this operation ``` # API Address Address ## PRE test environment address ## PRD official environment address # API Code Code ## Postman Collections The Postman collection is now available. Recommended for new users looking to quickly and easily get started with APIs. ## Swagger Below is a YAML file containing the OpenAPI specification of the RESTful API, as well as a Swagger UI page for reference. ## Contact us * [API Telegram Group](https://t.me/Multi_Markets_Greet) * Ask questions about API or Websockets performance. * Consult API questions not covered in the documentation. * [Developer Community](https://t.me/Multi_Markets_Greet) * Consult about API/Websockets code implementation, or any API/Websockets issues. * [Telegram Customer Service](https://t.me/Nana_support) * Consulting about accounts, wallets, 2FA, etc. # Authorize Management API interface authentication and authorization ## illustrate To authorize the white label management API, you need to obtain appId and appSecret in advance. You can obtain or reset them by contacting the main label customer service. The following is the information for testing the white label. ## Test Account ```json { "appId": "7cb9164942caec70594e594db46de7af", "appSecret": "33171f3e91c45e0dfbb3c9f219906471" } ``` {% openapi src="/files/EYDSUPQe2eIEOTTU2DgG" path="/auth/admin.admin.CompanyAuthDubboService.auth" method="post" %} [MultiMarkets-BusinessAPI.openapi.en.yaml](https://3404072034-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FvilfBi544sqSg2yLNueg%2Fuploads%2Fu5skqccABFnFm1GCci98%2FMultiMarkets-BusinessAPI.openapi.en.yaml?alt=media\&token=9a0af355-0ed4-497a-9c66-5c8c67bb20fc) {% endopenapi %} # Basic data # Universal dictionaries {% openapi src="/files/hDLeyOMqFn53ayn6XlAJ" path="/global/config.admin.AdminDictDubboService.getListByParentCode" method="post" expanded="true" fullWidth="false" %} [UTGL量化相关API.openapi.json](https://content.gitbook.com/content/vilfBi544sqSg2yLNueg/blobs/ShPDEtGCp2IaCC1Ylv8j/UTGL%E9%87%8F%E5%8C%96%E7%9B%B8%E5%85%B3API.openapi.json) {% endopenapi %} --- [Next Page](/llms-full.txt/1)