2026/03/06
| Release Date | Description of Product | Version |
|---|---|---|
| 2025/05/08 | First Draft | V0.1.0 |
| 2025/06/11 | Adding companyCode and walletType as request parameters to the WalletList interface | V0.1.1 |
| 2025/07/31 | Update PayoutModel parameters from symbol，side to fromAmount，toAmount and merge AgentModel；Add BankId parameter to bank account | V0.1.2 |
| 2025/08/18 | The payee removes the paymentWay | V0.1.3 |
| 2025/09/26 | The system now adds support for SOL and PLOY chains | V0.1.4 |
| 2025/10/21 | Added PayoutModel parameters extOrderNo | V0.1.5 |
| 2026/03/06 | The payee supports third-party non identical names | V0.1.6 |
WalletManagementAPI
1. File Upload (fileUpload)
Interface Overview Before submitting underlying customer information, you need to use this interface to upload files related to the company. Request Parameters| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| mediaType | string | M | Enum: jpeg / jpg / png / pdf / gif |
| mediaFile | file | M | The uploaded file, not exceeding 20M |
| Field Name | Type | Description |
|---|---|---|
| code | int32 | Response code, indicating the result of request processing. For example, 1 indicates success, other values indicate different error situations. |
| message | string | Response message, providing detailed processing information or error explanation. |
| data | string | Returned when validation is successful, the returned data is the key of the file. |
2. Submit Underlying Customer Information (createProfileApplication)
Interface Overview Submit the underlying customer’s information. The initial submission of underlying customer information can be made through this interface, or if the underlying customer information is rejected by RD review, it can be resubmitted through this interface. Request Parameters| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| extApplicationNo | string(128) | M | External application number(unique). |
| profile | Object | M | Company information form, Refer to Chapter [Underlying Customer Information Form]. |
| Field Name | Type | Description |
|---|---|---|
| code | int32 | Response code, indicating the result of request processing. For example, 1 indicates success, other values indicate different error situations. |
| message | string | Response message, providing detailed processing information or error explanation. |
| data | ApplicationData | Returned when the application form validation is successful. |
| errors | Array<Errors> | Returned when company archive information validation fails with code=6802. |
| Field Name | Type | Description |
|---|---|---|
| applicationNo | string | RD application number. Note: If rejected and resubmitted, a new RD application number will be generated. |
| applicationCreateTime | int64 | Application creation time, in milliseconds timestamp. |
| Field Name | Type | Description |
|---|---|---|
| message | string | See Appendix: Profile Error Description. |
3. Query Submitted Application (queryApplication)
Interface Overview Query the review progress of submitted underlying customer applications. Request Parameters| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| applicationNo | string | CM | RD application number |
| extApplicationNo | string | CM | External order number |
| Field Name | Type | Description |
|---|---|---|
| code | int32 | Response code, indicating the result of request processing. For example, 1 indicates success, other values indicate different error situations. |
| message | string | Response message, providing detailed processing information or error explanation. |
| data | QueryApplicationData | Returned when code=1. |
| Field Name | Type | Description |
|---|---|---|
| applicationNo | string | Application number. |
| extApplicationNo | string | External order number. |
| applicationCreateTime | int64 | Application creation time, timestamp. |
| applicationStatus | string | Status: Success, Fail, In Progress. |
| rejectReason | string | Rejection reason. |
| companyCode | string | Company code, returned when the application is approved. |
| profile | Object | Company information form, Refer to Chapter [Underlying Customer Information Form]. |
4. Query Company Profile (queryCompanyProfile)
Interface Overview Query the detailed information of underlying customers. Note: Only approved underlying customers can be queried, and the query must be based on the company code. Request Parameters| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| companyCode | string | M | Company Code |
| Field Name | Type | Description |
|---|---|---|
| code | int32 | Response code, indicating the result of request processing. For example, 1 indicates success, other values indicate different error situations. |
| message | string | Response message, providing detailed processing information or error explanation. |
| data | ProfileFormDto | Refer to Chapter [Underlying Customer Information Form]. |
5. Create Sub-Wallet (createSubWallet)
Interface Overview After the underlying customer has been approved, if you need to create a sub-wallet for digital currencies, you can use this interface to create a sub-wallet. Request Parameters| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| companyCode | string | M | Company Code |
| purpose | string(256) | M | Purpose of creating the sub-wallet |
| Field Name | Type | Description |
|---|---|---|
| code | int32 | Response code, indicating the result of request processing. For example, 1 indicates success, other values indicate different error situations. |
| message | string | Response message, providing detailed processing information or error explanation. |
| data | CreateSubWalletDto | Information returned after creating the wallet. |
| Field Name | Type | Description |
|---|---|---|
| walletId | string | Wallet ID |
| walletType | int32 | Wallet type: 2 - Sub-wallet |
| walletCreateTime | int64 | Wallet creation time, in milliseconds timestamp |
| companyNameEn | string | Company English name |
| companyNameCn | string | Company Chinese name |
| companyCode | string | Company code |
6. Wallet List(WalletList)
Interface Overview Query wallet list information. Request Parameters| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| companyCode | string | O | Company code |
| walletType | int32 | O | Wallet Type: 1-Main Wallet 2-Sub-wallet |
| Field Name | Type | Description |
|---|---|---|
| code | int32 | Response code, indicating the result of request processing, such as 1 for success, and other values for different error conditions |
| message | string | Response message, providing detailed processing information or error Description |
| data | WalletListDto | Wallet list data, including multiple WalletListDto objects |
| Field Name | Type | Description |
|---|---|---|
| walletId | int64 | Wallet ID |
| companyCode | string | Company Code |
| companyName | string | Company Name |
| companyNameCn | string | Chinese company name |
| walletStatus | int32 | Wallet Status: 1-Available 2-Freeze |
| createTime | int64 | Wallet creation time |
| walletType | int32 | Wallet Type: 1-Main Wallet 2-Sub-wallet |
7. Receive Address Query (receiveAddressQuery)
Interface Overview Query the payment address of a specified wallet under a specific blockchain and currency. Request Parameters| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| walletId | int64 | M | Wallet ID |
| network | string | M | Blockchain network: ETH/TRX/SOL/POLY |
| currency | string | M | Currency: USDT/USDC |
| Field Name | Type | Description |
|---|---|---|
| code | int64 | Response code, indicating the result of request processing, such as 1 for success, and other values for different error conditions |
| message | string | Response message, providing detailed processing information or error Description |
| data | ReceiveAddressQueryData | Payment address query data |
| Field Name | Type | Description |
|---|---|---|
| address | string | Payment address |
8. Wallet Assets Query (walletAssets)
Interface Overview Query wallet asset information. Request Parameters| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| walletId | int64 | M | Wallet ID |
| Field Name | Type | Description |
|---|---|---|
| code | int32 | Response code, indicating the result of request processing, such as 1 for success, and other values for different error conditions |
| message | string | Response message, providing detailed processing information or error Description |
| data | WalletDetailDto | Wallet details data |
| Field Name | Type | Description |
|---|---|---|
| walletId | int64 | Wallet ID |
| companyName | string | Company Name |
| companyNameCn | string | Chinese company name |
| walletStatus | int32 | Wallet Status: 1-Available 2-Freeze |
| createTime | string | Wallet creation time |
| walletType | int32 | Wallet Type: 1- Main wallet 2-Sub-wallet |
| assets | AssetDto | Custodied Assets List |
| exchangeAssets | AssetDto | Trading Assets List |
| Field Name | Type | Description |
|---|---|---|
| network | string | Blockchain network, which represents the network to which the asset belongs Trading assets do not have this field; e.g.ETH/TRX/SOL/POLY |
| address | string | Address information, indicating the address corresponding to the asset |
| currency | string | Asset currency: USDT/USDC |
| balance | string | Balance of assets |
Underlying Customer Information Form
Company Type| Company Type | Limited Company | Partnership Company | Sole Proprietorship |
|---|---|---|---|
| Hong Kong | ✓ | ✓ | ✓ |
| Mainland China | ✓ | ✗ | ✓ |
| Others | ✓ | ✗ | ✗ |
Partnership Company (Hong Kong)
Entity Information| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| businessType | int32 | M | Company business type: 2 - Partnership Company |
| incorpPlace | string | M | Place of incorporation, partnership companies only support HKG |
| brNumber | string(32) | M | Business registration certificate number |
| brFileKey | string(128) | M | Business Registration file |
| incorpDate | string | M | Date of incorporation YYYY-MM-DD |
| website | string(512) | Website URL | |
| regPlace | string | M | Place of registration, see appendix: Country/Region Code |
| regAddress | string(256) | M | Detailed address of registration, supports only English letters, numbers, and spaces. |
| operatingPlace | string | M | Place of operation, see appendix: Country/Region Code |
| operatingAddress | string(256) | M | Detailed address of operation |
| nameEn | string(128) | M | English company name |
| nameZh | string(128) | Local name/Chinese name | |
| paFileKey | Array<string> | M | Partnership Agreement file, up to 5 files |
| kycFileKey | Array<string> | M | KYC proof documents for the company, up to 5 files |
| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| list | Array(BusinessDetailDto) | M | Business information, maximum of 3 entries |
| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| subIndustryCode | string(10) | M | See appendix: Industry Code |
| yearsInBusiness | int32 | M | See appendix: Years in Business |
| businessLocations | Array<String>(3) | M | List of business locations, maximum of 3, see appendix: Country/Region Code |
| lastYearSales | int32 | M | See appendix: Last Year Sales |
| industryDetails | string(256) | M | Additional industry details |
| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| people | Array(KeyPeopleDto) | M | List of key people, fill in 2-6 partners |
| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| lastNameEn | string(128) | CM | English last name, either English or Chinese name must be filled |
| firstNameEn | string(128) | CM | English first name, either English or Chinese name must be filled |
| nameZh | string(128) | CM | Chinese name or local name, either English or Chinese name must be filled |
| areaCode | string(8) | O | Phone area code |
| mobileNumber | string(32) | O | Mobile phone number |
| string(128) | O | Email address | |
| gender | int32 | O | Gender: 1 - Male 2 - Female |
| birthdate | string | O | Date of birth YYYY-MM-DD |
| region | string | O | Country/Region where the ID is issued, see appendix: Country/Region Code |
| idType | int32 | O | ID type: 1 - CNID 2 - HKID 3 - Passport |
| idNumber | string | O | ID number |
| idFileKey | Array<string> | M | ID document files, up to 5 files |
| isPartner | bool | M | Whether it is a partner, true |
| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| customerType | int32 | M | Customer type: 1 - Underlying customer |
Limited Company (Hong Kong)
Entity Information| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| businessType | int32 | M | Company business type: 1 - Limited Company |
| incorpPlace | string | M | Place of incorporation, e.g., HKG |
| ciNumber | string(32) | M | Company registration certificate |
| ciFileKey | string(128) | M | Certificate of Incorporation file |
| brNumber | string(32) | M | Business Registration Certificate number |
| brFileKey | string(128) | M | Business Registration file |
| incorpDate | string | M | Date of incorporation, YYYY-MM-DD |
| website | string(512) | O | Website URL |
| regPlace | string | M | Place of registration, see appendix: Country/Region Code |
| regAddress | string(256) | M | Detailed address of registration, supports only English letters, numbers, and spaces. |
| operatingPlace | string | M | Place of operation, see appendix: Country/Region Code |
| operatingAddress | string(256) | M | Detailed address of operation |
| nameEn | string(128) | M | English company name |
| nameZh | string(128) | O | Local name (Chinese name) |
| isFinancialInstitution | int32 | M | Whether it is a regulated financial institution: 1 - Regulated 2 - Not regulated |
| financialRegulatorPlace | string | CM | Location of the financial regulator, see appendix: Country/Region Code; required if regulated |
| financialRegulator | string(256) | CM | Name of the regulatory body, required if regulated |
| financialLicenseType | string(128) | CM | Type of financial license, required if regulated |
| regulatedProofKey | Array<string> | CM | Regulatory proof documents, required when isFinancialInstitution is true, up to 5 files |
| isListed | int32 | M | Whether it is a listed company: 1 - Listed 2 - Not listed |
| listingPlace | string(3) | CM | Listing location, required for listed companies, see appendix: Country/Region Code |
| listingExchange | string(256) | CM | Exchange name, required for listed companies |
| stockCode | string(128) | CM | Stock code, required for listed companies |
| isGovOwned | int32 | M | Whether it is government-owned: 1 - Government-owned 2 - Not government-owned |
| ownedGovPlace | string(3) | CM | Location of the government that owns the company, required if government-owned, see appendix: Country/Region Code |
| maFileKey | Array<string> | M | Memorandum and Articles of Association file, up to 5 files |
| kycFileKey | Array<string> | M | KYC proof documents for the company, up to 5 files |
| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| list | Array(BusinessDetailDto) | M | Business information, maximum of 3 entries |
| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| subIndustryCode | string(10) | M | See appendix: Industry Code |
| yearsInBusiness | int32 | M | See appendix: Years in Business |
| businessLocations | Array<String>(3) | M | List of business locations, maximum of 3, see appendix: Country/Region Code |
| lastYearSales | int32 | M | See appendix: Last Year Sales |
| industryDetails | string(256) | M | Additional industry details |
| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| list | Array(ShareholderDto) | M | List of shareholders |
| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| shareholderId | int64 | M | Unique identifier for the shareholder, generated on the request side. There should be no duplicate IDs in the shareholder list. |
| sameId | int64 | O | Generated on the request side. Two identical shareholders in the shareholder list have the same and greater than 0 sameId, default value is 0. |
| parentId | int64 | O | Corresponds to the parent-level shareholderId of the parent node. The first level is 0. |
| shareholderType | int32 | M | Shareholder type: 1 - Individual shareholder 2 - Corporate shareholder |
| businessType | int32 | CM | Business type of corporate shareholders: 1 - Limited Liability Company 2 - Partnership 3 - Sole Proprietorship |
| incorpPlace | string | CM | Registration place for corporate shareholders. Only Hong Kong is supported for partnerships and sole proprietorships. See appendix: Country/Region Code. |
| ownedSharesPercent | double(6,3) | M | Current shareholding percentage of the shareholder for the parent, with three decimal places. Rounding up if exceeds. |
| companyNameEn | string(128) | CM | English name of the corporate shareholder. Either English or Chinese name must be filled. |
| companyNameZh | string(128) | CM | Local name (Chinese name) of the corporate shareholder. Either English or Chinese name must be filled. |
| financialRegulatorPlace | string | CM | Location of the financial regulatory body. See appendix: Country/Region Code. Must be filled if regulated. |
| isFinancialInstitution | int32 | O | Whether the corporate shareholder is a regulated financial institution: 1 - Regulated 2 - Not regulated |
| financialRegulator | string(256) | CM | Name of the regulatory body. Must be filled if regulated. |
| financialLicenseType | string(128) | CM | Type of financial license. Must be filled if regulated. |
| isListed | int32 | M | Whether the corporate shareholder is a listed company: 1 - Listed 2 - Not listed |
| listingPlace | string | CM | Listing location. Must be filled for listed companies. See appendix: Country/Region Code. |
| listingExchange | string(256) | CM | Exchange name. Must be filled for listed companies. |
| stockCode | string(128) | CM | Stock code. Must be filled for listed companies. |
| isGovOwned | int32 | O | Whether the corporate shareholder is government-owned. Default value is 2: 1 - Government-owned 2 - Not government-owned |
| ownedGovPlace | string | CM | Location of the government that owns the company. Must be filled if government-owned. See appendix: Country/Region Code. |
| firstNameEn | string(128) | CM | English first name of the individual shareholder. Either English or Chinese name must be filled. |
| lastNameEn | string(128) | CM | English last name of the individual shareholder. Either English or Chinese name must be filled. |
| nameZh | string(128) | CM | Local name (Chinese name) of the individual shareholder. Either English or Chinese name must be filled. |
| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| quorum | int32 | M | Minimum number of statutory members 1-99 |
| directorNum | int32 | M | Number of directors in a limited liability company. Must be consistent with the number of key people where isDirector is true, ranging from 1-99. |
| people | Array(KeyPeopleDto) | M | List all UBOs and directors of the company |
| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| lastNameEn | string(128) | CM | English last name. Either English or Chinese name must be filled. |
| firstNameEn | string(128) | CM | English first name. Either English or Chinese name must be filled. |
| nameZh | string(128) | CM | Chinese name or local name |
| areaCode | string(8) | O | Phone area code |
| mobileNumber | string(32) | O | Mobile phone number |
| string(128) | O | Email address | |
| gender | int32 | O | Gender: 1 - Male 2 - Female |
| birthdate | string | O | Date of birth YYYY-MM-DD |
| region | string | O | Country/Region where the ID is issued. See appendix: Country/Region Code |
| idType | int32 | O | ID type: 1 - CNID 2 - HKID 3 - Passport |
| idNumber | string | O | ID number |
| idFileKey | Array<string> | M | ID document files, up to 5 files |
| isDirector | boolean | M | Whether it is a director |
| isUbo | boolean | M | Whether it is an ultimate beneficial owner |
| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| customerType | int32 | M | Customer type: 1 - Underlying customer |
Limited Company (Non-Hong Kong)
Entity Information| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| businessType | int32 | M | Company business type: 1 - Limited Company |
| incorpPlace | string | M | Non-HKG, company registration place, see appendix: Country/Region Code |
| ciNumber | string(32) | M | Company Registration Certificate |
| ciFileKey | string(128) | M | Certificate of Incorporation file address |
| brNumber | string(32) | O | Business Registration Certificate number |
| brFileKey | string(128) | O | Business Registration file address |
| incorpDate | string | M | Company registration date, YYYY-MM-DD |
| website | string(512) | O | Website URL |
| regPlace | string | M | Company registration place, see appendix: Country/Region Code |
| regAddress | string(256) | M | Detailed company registration address, only supports English letters, numbers, and spaces |
| operatingPlace | string | M | Company operating place, see appendix: Country/Region Code |
| operatingAddress | string(256) | M | Detailed company operating address |
| nameEn | string(128) | CM | Company English name, required if not CHN |
| nameZh | string(128) | CM | Company local name (Chinese name), required if CHN |
| isFinancialInstitute | int32 | O | Whether it is a regulated financial institution, default is 2: 1 - Regulated 2 - Not regulated |
| financialRegulatorPlace | string | CM | Location of the financial regulatory body, see appendix: Country/Region Code, required if regulated |
| financialRegulator | string(256) | CM | Name of the regulatory body, required if regulated |
| financialLicenseType | string(128) | CM | Type of financial institution license, required if regulated |
| regulatedProofKey | Array<string> | CM | Regulatory proof documents, required when isFinancialInstitute is true, up to 5 files |
| isListed | int32 | O | Whether it is a listed company, default is 2: 1 - Listed company 2 - Non-listed company |
| listingPlace | string | CM | Listing location, see appendix: Country/Region Code, required if a listed company |
| listingExchange | string(256) | CM | Exchange name, required if a listed company |
| stockCode | string(128) | CM | Stock code, required if a listed company |
| isGovOwned | int32 | O | Whether state-owned: 1 - State-owned 2 - Not state-owned |
| ownedGovPlace | string(2) | CM | Location of the government owning the state-owned company, see appendix: Country/Region Code, required if state-owned |
| maFileKey | Array<string> | M | Memorandum and Articles of Association file address, up to 5 files |
| coiFileKey | Array<string> | CM | Certificate of Incumbency, required for BMU, WSM, SYC, CYM, VGB, up to 5 files |
| kycFileKey | Array<string> | M | KYC proof document for this company, up to 5 files |
| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| list | Array(BusinessDetailDto) | M | Business information can contain a maximum of 3 entries |
| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| subIndustryCode | string(10) | M | See appendix: Industry Code |
| yearsInBusiness | int32 | M | See appendix: Years in Business |
| businessLocations | Array<String>(3) | M | List of business locations, up to three, see appendix: Country/Region Code |
| lastYearSales | int32 | M | See appendix: Last Year’s Sales |
| industryDetails | string(256) | M | Additional industry details |
| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| list | Array(ShareholderDto) | M | Shareholder list |
| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| shareholderId | int64 | M | Unique identifier for the shareholder. Generated on the request side. There should be no duplicate IDs in the shareholder list. |
| sameId | int64 | O | Generated on the request side. Two identical shareholders in the shareholder list have the same and greater than 0 sameId. Default value is 0. |
| parentId | int64 | O | Corresponds to the shareholderId of the parent-level shareholder. The first level is 0. |
| shareholderType | int32 | M | Shareholder type: 1 - Individual Shareholder 2 - Corporate Shareholder |
| businessType | int32 | CM | Business type for corporate shareholders: 1 - Limited Company 2 - Partnership 3 - Sole Proprietorship |
| incorpPlace | string | CM | Registration place for corporate shareholders. Only supports Hong Kong for partnerships and sole proprietorships. See appendix: Country/Region Code. |
| ownedSharesPercent | double(6,3) | M | Current shareholder’s ownership percentage of the parent, up to three decimal places. Rounds to the nearest if exceeded. |
| companyNameEn | string(128) | CM | English name of the corporate shareholder. Either English or Chinese name must be filled. |
| companyNameZh | string(128) | CM | Local (Chinese) name of the corporate shareholder. Either English or Chinese name must be filled. |
| financialRegulatorPlace | string | CM | Location of the financial regulatory body. See appendix: Country/Region Code. Required if regulated. |
| isFinancialInstitute | int32 | O | Regulated Financial Institution: 1 - Regulated 2 - Not regulated |
| financialRegulator | string(256) | CM | Name of the regulatory body. Required if regulated. |
| financialLicenseType | string(128) | CM | Type of financial license. Required if regulated. |
| isListed | int32 | M | Whether the corporate shareholder is a listed company: 1 - Listed Company 2 - Unlisted Company |
| listingPlace | string | CM | Listing location. See appendix: Country/Region Code. Required if listed. |
| listingExchange | string(256) | CM | Exchange name. Required if listed. |
| stockCode | string(128) | CM | Stock code. Required if listed. |
| isGovOwned | int32 | O | Whether the company is state-owned. Default is 2: 1 - State-owned 2 - Not state-owned |
| ownedGovPlace | string | CM | Location of the government owning the state-owned company. See appendix: Country/Region Code. Required if state-owned. |
| firstNameEn | string(128) | CM | English first name of the individual shareholder. Either English or Chinese name must be filled. |
| lastNameEn | string(128) | CM | English last name of the individual shareholder. Either English or Chinese name must be filled. |
| nameZh | string(128) | CM | Local (Chinese) name of the individual shareholder. Either English or Chinese name must be filled. |
| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| quorum | int32 | M | Minimum number of statutory members 1-99 |
| directorNum | int32 | M | Number of directors for limited companies. Must match the number of key people with isDirector set to true 1-99 |
| people | Array(KeyPeopleDto) | M | List all UBOs and directors of the company |
| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| lastNameEn | string(128) | CM | English last name. Either English or Chinese name must be filled. |
| firstNameEn | string(128) | CM | English first name. Either English or Chinese name must be filled. |
| nameZh | string(128) | CM | Chinese name or local name. |
| areaCode | string(8) | O | Area code for phone number |
| mobileNumber | string(32) | O | Mobile phone number |
| string(128) | O | Email address | |
| gender | int32 | O | Gender: 1 - Male 2 - Female |
| birthdate | string | O | Date of birth YYYY-MM-DD |
| region | string | O | Country/Region where the ID document is issued. See appendix: Country/Region Code |
| idType | int32 | O | ID document type: 1 - CNID 2 - HKID 3 - Passport |
| idNumber | string | O | ID number |
| idFileKey | Array<string> | M | ID document files, up to 5 files |
| isDirector | boolean | M | Whether they are a director |
| isUbo | boolean | M | Whether they are an ultimate beneficial owner (UBO) |
| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| customerType | int32 | M | 1 - Underlying customer |
Sole Proprietorship Company (Hong Kong/Mainland China)
Entity Information| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| businessType | int32 | M | Company business type: 3 - Sole Proprietorship |
| incorpPlace | string | M | Company registration place. Sole proprietorships only support HKG/CHN. |
| brNumber | string(32) | M | Business Registration Certificate number |
| brFileKey | string(128) | M | Business Registration file |
| incorpDate | int32 | M | Company registration date, yyyy-MM-dd |
| website | string(512) | O | Website URL |
| isFinancialInstitute | int32 | O | Whether it is a regulated financial institution: 1 - Regulated 2 - Not regulated |
| financialRegulatorPlace | string | CM | Location of the financial regulatory body. See appendix: Country/Region Code. Required if regulated. |
| financialRegulator | string(256) | CM | Name of the regulatory body. Required if regulated. |
| financialLicenseType | string(128) | CM | Type of financial license. Required if regulated. |
| regulatedProofKey | Array<string> | CM | Regulatory proof documents. Required when isFinancialInstitute is 1 Up to 5 files. |
| regPlace | string | M | Company registration place. See appendix: Country/Region Code. |
| regAddress | string(256) | M | Detailed company registration address. Only supports English letters, numbers, and spaces. |
| operatingPlace | string(2) | M | Company operating place. See appendix: Country/Region Code. |
| operatingAddress | string(256) | M | Detailed company operating address. |
| nameEn | string(128) | CM | Company English name. Required for HKG. |
| nameZh | string(128) | CM | Company local name (Chinese name). Required for CHN. |
| kycFileKey | Array<string> | M | KYC proof documents for this company. Up to 5 files. |
| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| list | Array(BusinessDetailDto) | M | Business information must contain at least 1 entry and can have up to 3 entries. |
| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| subIndustryCode | string(10) | M | See appendix: Industry Code |
| yearsInBusiness | int32 | M | See appendix: Years in Business |
| businessLocations | Array<String>(3) | M | List of business locations. Up to three. See appendix: Country/Region Code. |
| lastYearSales | int32 | M | See appendix: Last Year’s Sales |
| industryDetails | string(256) | M | Additional industry details |
| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| people | Array(KeyPeopleDto) | M | Fill in one owner |
| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| lastNameEn | string(128) | CM | English last name |
| firstNameEn | string(128) | CM | English first name |
| nameZh | string(128) | CM | Chinese name or local name |
| areaCode | string(8) | O | Area code for phone number |
| mobileNumber | string(32) | O | Mobile phone number |
| string(128) | O | Email address | |
| gender | int32 | O | Gender: 1 - Male 2 - Female |
| birthdate | string | O | Date of birth YYYY-MM-DD |
| region | string | O | Country/Region where the ID document is issued. See appendix: Country/Region Code |
| idType | int32 | O | ID document type: 1 - CNID 2 - HKID 3 - Passport |
| idNumber | string | M | ID number |
| idFileKey | Array<string> | M | ID document files. Up to 5 files |
| isOwner | boolean | M | Whether they are the owner of a sole proprietorship (there must be and can only be one) |
| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| customerType | int32 | M | Customer type: 1 - Underlying customer |
WalletPaymentAPI
1. Wallet Transfer(walletTransfer)
Interface Overview Execute fund transfers between wallets within the platform. Request Parameters| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| walletId | int64 | M | ID of the wallet from which the transfer is made |
| targetWalletId | int64 | M | ID of the wallet to be transferred |
| currency | string | M | Transfer currency: USDT/USDC |
| network | string | M | Transfer currency network: ETH/TRX/SOL/POLY |
| amount | string | M | Transfer Amount |
| extOrderNo | string | M | External Order ID(Unique) |
| message | string | O | Transfer Notes |
| Field Name | Type | Description |
|---|---|---|
| code | int32 | Response code, indicating the result of request processing, such as 1 for success, and other values for different error conditions |
| message | string | Response message, indicating the Description or error information of the transfer operation |
| data | WalletTransferData | Data of transfer operations |
| Field Name | Type | Description |
|---|---|---|
| orderNo | string | RD Order Number |
2. Get Signature (getSignData)
Interface Overview Get the signature. Request Parameters| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| network | string | M | Blockchain network: ETH/TRX/SOL/POLY |
| address | string | M | Address to be added to the Whitelist |
| Field Name | Type | Description |
|---|---|---|
| code | int32 | Response code, indicating the result of request processing, such as 1 for success, and other values for different error conditions |
| message | string | Response message, indicating the result of the operation or error information |
| data | SignData | Signature response data |
| Field Name | Type | Description |
|---|---|---|
| data | string | Signature Data |
| expireTime | int64 | Signature expiry time |
3. Add Address Whitelist (addAddressWhitelist)
Interface Overview Add the address to the whitelist. Request Parameters| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| network | string | M | Blockchain network: ETH/TRX/SOL/POLY |
| address | string | M | Address to add |
| checkType | int32 | M | Check Type: 1-Signature check 2-Transaction check |
| signData | string | CM | Signature information, required when the check type is signature |
| signature | string | CM | Signature result, required when the check type is signature |
| currency | string | CM | Check type is required for transactions. Receipt currency: USDT/USDC |
| walletId | int64 | M | Receiving wallet ID |
| businessType | int32 | M | Business Type: 1-deposit 2-withdraw |
| addressSource | int32 | M | Address Source Type: 1-Personal wallet 2-Exchange/custodian platform |
| platformName | string | CM | The name of the exchange/custodian platform. Required when the address source type is 2 |
| remarks | string | O | Remark |
| Field Name | Type | Description |
|---|---|---|
| code | int32 | Response code, indicating the result of request processing, such as 1 for success, and other values for different error conditions |
| message | string | Response message, indicating the result of the operation or error information |
| data | WhiteListApiDto | Whitelist Add Result |
| Field Name | Type | Description |
|---|---|---|
| id | int64 | Request ID |
| network | string | Blockchain network: ETH/TRX/SOL/POLY |
| address | string | Address to add |
| checkType | int32 | Check Type: 1-Signature check 2-Small transfer check |
| signData | string | Data to be signed |
| signature | string | sign |
| currency | string | Currency for small transfers: USDT/USDC |
| depositAddress | string | Small amount transfer payment address |
| amount | string | Amount required for small transfers |
| status | string | state: SUCCESS、FAIL、PENDING、PENDING_DEPOSIT |
| expireTime | int64 | Small amount transfer deadline |
| businessType | int32 | Business Type: 1-deposit 2-withdraw |
| addressSource | int32 | Address Source Type: 1-Personal wallet 2-Exchange/custodian platform |
| platformName | string | Name of the exchange/custodian platform |
| remarks | string | Remark |
4. CheckAddressWhitelist(checkAddressWhitelist)
Interface Overview Check if the address is in the whitelist. Request Parameters| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| address | string | M | Check if the address is in the whitelist. |
| network | string | M | Blockchain network: ETH/TRX/SOL/POLY |
| businessType | int32 | M | Business Type: 1-deposit 2-withdraw |
| Field Name | Type | Description |
|---|---|---|
| code | int32 | Response code, indicating the result of request processing, such as 1 for success, and other values for different error conditions |
| message | string | Response message, providing detailed error information or status Description |
| data | CheckWhiteListDto | Whitelist check results |
| Field Name | Type | Description |
|---|---|---|
| status | string | Status: SUCCESS, FAIL, PENDING, PENDING_DEPOSIT,NOT_EXIST |
| businessType | int32 | Business Type: 1-deposit 2-withdraw |
| remarks | string | Remark |
5. DeleteAddressWhitelist(deleteAddressWhitelist)
Interface Overview Delete the address whitelist. Request Parameters| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| network | string | M | Blockchain network: ETH/TRX/SOL/POLY |
| address | string | M | Whitelist of addresses to be deleted |
| businessType | int32 | M | Business Type: 1-deposit 2-withdraw |
| Field Name | Type | Description |
|---|---|---|
| code | int32 | Response code, indicating the result of request processing, such as 1 for success, and other values for different error conditions |
| message | string | Response message, indicating the result of the operation or error information |
6. Declare Receive Order(declareReceiveOrder)
Interface Overview Declare a payment order. Request Parameters| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| senderAddress | string | M | Payer Address |
| recipientAddress | string | M | Recipient Address |
| amount | string | M | Amount, indicating the deposit amount |
| network | string | M | Blockchain network: ETH/TRX/SOL/POLY |
| currency | string | M | Currency: USDT/USDC |
| extOrderNo | string | M | External Order ID (Globally Unique) |
| Field Name | Type | Description |
|---|---|---|
| code | int32 | Response code, indicating the result of request processing, such as 1 for success, and other values for different error conditions |
| message | string | Response message, indicating the result of the operation or error information |
7. Internal Transfer(internalTransfer)
Interface Overview Execute internal transfer operation. Request Parameters| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| walletId | int64 | M | Wallet ID |
| internalTransferType | int32 | M | Internal transfer type: 1-Transfer Custodied Assets to Trading Assets |
| network | string | CM | Source Asset’s Network: ETH/TRX/SOL/POLY, required when transfer type is 1 |
| currency | string | M | Currency: USDT/USDC |
| amount | string | M | Amount |
| extOrderNo | string | M | External order ID(Globally Unique) |
| Field Name | Type | Description |
|---|---|---|
| code | int32 | Response code, indicating the result of request processing, such as 1 for success, and other values for different error conditions |
| message | string | Response message, providing detailed processing information or error Description |
| data | InternalTransferData | Data of internal transfer operations |
| Field Name | Type | Description |
|---|---|---|
| orderNo | string | Transfer order number |
8. Order details (walletOrderDetail)
Interface Overview Query wallet order details. Request Parameters| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| orderNo | string | CM | Order number Either “orderNo” or “extOrderNo” must be provided |
| extOrderNo | string | CM | External order number, Either “orderNo” or “extOrderNo” must be provided |
| Field Name | Type | Description |
|---|---|---|
| code | int32 | Response code, indicating the result of request processing, such as 1 for success, and other values for different error conditions |
| message | string | Response message, providing detailed error information or processing result Description |
| data | WalletOrderDetailData | Order details data |
| Field Name | Type | Description |
|---|---|---|
| orderNo | string | Order Number |
| extOrderNo | string | External order number |
| orderType | string | Order Type |
| orderStatus | string | See Appendix: Deposit Order Status |
| fromAddress | string | Initiator address |
| fromWallet | string | Source wallet |
| toAddress | string | Recipient Address |
| toWallet | string | Target wallet |
| amount | string | Amount |
| network | string | Blockchain network: ETH/TRX/SOL/POLY |
| currency | string | Currency: USDT/USDC |
| expireTime | int64 | Order expiration time |
| createTime | int64 | Order creation time |
9. Request Payment Order Declaration (payinOrderDeclare)
Interface Overview Submit a Request Payment deposit order Request Parameters| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| walletId | int64 | M | Deposit wallet ID |
| extOrderNo | string | M | External order ID(Unique) |
| senderAddress | string | M | Payer wallet address |
| network | string | M | Blockchain network: ETH/TRX/SOL/POLY |
| currency | string | M | Currency: USDT/USDC |
| amount | string | M | Declared amount Note: The declared amount must exactly match the final deposit amount |
| senderName | string | M | Payer Name |
| countryRegion | string | M | Please refer to the Country/Region ISO 3166 Code. e.g.HKG |
| contactAddress | string | M | Payer contact address |
| receiverName | string | M | Recipient Merchant Name |
| message | string | O | Remark |
| orderMaterials | Object | O | Collection of Material Declaration Objects for Order Return |
| productType | string | M | Product Type |
| productName | string | M | Product Name |
| productPrice | string | M | Product Price |
| productCount | string | M | Product Quantity |
| productUnit | string | M | Product Unit |
| logisticsTrackingName | string | O | Logistics Company Name |
| logisticsTrackingNo | string | O | Tracking number |
| Field Name | Type | Description |
|---|---|---|
| code | int32 | Response code, indicating the result of request processing |
| message | string | Response message, indicating the result of the operation or error information |
10. Request Payment order material supplement (addRequestPaymentMaterials)
Interface Overview Submit order and add product information and other materials Request Parameters| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| walletId | int64 | M | Deposit wallet ID |
| orderNo | string | M | Order ID |
| productType | string | M | Product Type |
| productName | string | M | Product Name |
| productPrice | string | M | Product Prices |
| productCount | string | M | Quantity of products |
| productUnit | string | M | Commodity Unit |
| logisticsTrackingName | string | O | Logistics Company Name |
| logisticsTrackingNo | string | O | Logistics tracking number |
| Field Name | Type | Description |
|---|---|---|
| code | int32 | Response code, indicating the result of request processing |
| message | string | Response message, indicating the result of the operation or error information |
11. Fee Query (feeQuery)
Interface Overview Fee Inquiry Interface for querying Transaction Fees. Request Parameters| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| orderType | int32 | M | See Appendix: Order Type |
| walletId | int64 | M | Wallet ID |
| network | string | M | Blockchain network: ETH/TRX/SOL/POLY |
| currency | string | M | Currency: USDT/USDC |
| payAmount | string | M | Order amount |
| Field Name | Type | Description |
|---|---|---|
| code | int32 | Response code, indicating the result of request processing, such as 1 for success, and other values for different error conditions |
| message | string | Response message, indicating the result of the operation or error information |
| data | Fee Details |
| Field Name | Type | Description |
|---|---|---|
| walletId | int64 | Wallet ID |
| network | string | Blockchain network: ETH/TRX/SOL/POLY |
| currency | string | Currency: USDT/USDC |
| payAmount | string | Order amount |
| feeAmount | string | Service Fee |
| receiveAmount | string | Amount Received |
12. Withdraw order(withdraw)
Interface Overview Create a withdrawal order Request Parameters| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| walletId | int64 | M | Wallet ID |
| extOrderNo | string | M | External order ID(Unique) |
| network | string | M | Blockchain network: ETH/TRX/SOL/POLY |
| currency | string | M | Currency: USDT/USDC |
| payAmount | string | M | The order amount supports up to 6 decimal places |
| recipientAddress | string | M | Recipient Blockchain Address |
| recipientName | string | M | Recipient Name |
| message | string | O | Remark |
| Field Name | Type | Description |
|---|---|---|
| code | int32 | Response code, indicating the result of request processing, such as 1 for success, and other values for different error conditions |
| message | string | Response message, indicating the result of the operation or error information |
13. Download the statement (queryReconBill)
Interface Overview At 9:00 am every day, the D-1 day statement can be downloaded (Note: the time zone corresponding to the time involved in the document is Hong Kong UTC+8 time zone) Request Parameters| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| walletId | int64 | M | Wallet ID |
| billDate | string | M | Billing Date (YYYYMMDD) |
| modeType | int32 | M | Authorization mode: 1- Direct connection mode (download the current wallet statement) 2-Authorization mode (download current wallet and sub-wallet statements) |
| accountType | int32 | M | Account Type: 1-Custody Account 2-Trading Account |
| currencyType | int32 | M | Currency Type: 1: ETH-USDT (Custody Account Currency) 2: ETH-USDC (Custody Account Currency) 3: TRX-USDT (Custody Account Currency) 4: USDT (Trading Account Currency) 5: USDC (Trading Account Currency) 6: USD (Custody Account Currency) |
| Field Name | Type | Description |
|---|---|---|
| code | int32 | Response code, indicating the result of request processing |
| message | string | Response message, indicating the result of the operation or error information |
| data | WalletBillData | Statement Information |
| Field Name | Type | Description |
|---|---|---|
| fileName | string | File name |
| fileUrl | string | Download address of the zip package of the statement |
ConvertAPI
PayoutModel
1. Quote(payoutQuote)
Interface Overview Used to obtain the price of a specified currency pair Request Parameters| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| walletId | int64 | M | Wallet ID |
| fromCurrency | string | M | From Currency: USDT,USDC |
| fromAmount | string | CM | From Amount, supports 2 decimal places At least one of fromAmount or toAmount must be provided |
| toCurrency | string | M | To Currency: USD |
| toAmount | string | CM | To Amount, supports 2 decimal places At least one of fromAmount or toAmount must be provided |
| paymentWay | string | M | Payment Method：RDT/CHATS |
| feeMode | int32 | CM | This field is required if paymentWay is CHATS. Fee Deduction Mode: 1 - Shared by both sender and receiver (SHAR) 2 - Borne entirely by the payer (OUR) |
| Field Name | Type | Description |
|---|---|---|
| code | int32 | Response code, indicating the result of request processing, such as 1 for success, and other values for different error conditions |
| message | string | Response message, providing detailed processing information or error Description |
| data | PayoutQuoteData | Price and Transfer-Related Data |
| Field Name | Type | Description |
|---|---|---|
| walletId | int64 | Wallet ID |
| fromCurrency | string | From Currency: USDT,USDC |
| fromAmount | string | From Amount |
| toCurrency | string | To Currency: USD |
| toAmount | string | To Amount（Subtract Service fee ） |
| paymentWay | string | Payment Method：RDT/CHATS |
| feeMode | int32 | Fee Deduction Mode: 1 - Shared by both sender and receiver (SHAR) 2 - Borne entirely by the payer (OUR) |
| quoteId | int64 | Inquiry ID |
| price | string | price |
| priceExpireTime | string | Price Expiration Time |
| feeAmount | string | Service fee |
| feeCurrency | string | Fee Currency |
2. Payout order (payoutBook)
Interface Overview Place an order at the specified currency pair price. Request Parameters| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| walletId | int64 | M | Wallet ID |
| quoteId | int64 | M | Inquiry ID |
| settlementAccountUID | int64 | M | Settlement Account ID(Unique)，Can be queried through getBankAccount |
| purpose | string | M | See Appendix: Purpose |
| extOrderNo | string | M | Unique Order ID provided by Business Entities Only alphanumeric characters, and _-* are allowed, also please ensure the uniqueness in the same wallet account ID |
| Field Name | Type | Description |
|---|---|---|
| code | int32 | Response code, indicating the result of request processing, such as 1 for success, and other values for different error conditions |
| message | string | Response message, providing detailed processing information or error Description |
| data | PayoutBookData | Order data |
| Field Name | Type | Description |
|---|---|---|
| walletId | int64 | Wallet ID |
| quoteId | int64 | Inquiry ID |
| settlementAccountUID | int64 | Settlement Account ID(Unique) |
| purpose | string | See Appendix: Purpose |
| orderNo | string | Order Number |
| fromCurrency | string | From Currency: USDT,USDC |
| fromAmount | string | From Amount |
| toCurrency | string | To Currency: USD |
| toAmount | string | To Amount（Subtract Service fee ） |
| paymentWay | string | Payment Method：RDT/CHATS |
| feeMode | int32 | Fee Deduction Mode: 1 - Shared by both sender and receiver (SHAR) 2 - Borne entirely by the payer (OUR) |
| feeAmount | string | Service fee |
| feeCurrency | string | Fee Currency |
| orderStatus | string | See Appendix: Payout order status |
| createTime | int64 | Order creation time |
| extOrderNo | string | Unique Order ID provided by Business Entities |
3. Payout Order Enquiry(payoutEnquiry)
Interface Overview To query order information Request Parameters| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| walletId | int64 | M | Wallet ID |
| orderNo | string | CM | At least one of orderNo or quoteId must be provided |
| quoteId | int64 | CM | At least one of orderNo or quoteId must be provided |
| Field Name | Type | Description |
|---|---|---|
| code | int32 | Response code, indicating the result of request processing, such as 1 for success, and other values for different error conditions |
| message | string | Response message, providing detailed processing information or error Description |
| data | PayoutData | Order query data |
| Field Name | Type | Description |
|---|---|---|
| walletId | int64 | Wallet ID |
| quoteId | int64 | Inquiry ID |
| orderNo | string | Order Number |
| fromCurrency | string | From Currency: USDT,USDC |
| fromAmount | string | From Amount |
| toCurrency | string | To Currency: USD |
| toAmount | string | To Amount（Subtract Service fee ） |
| tradeFromAmount | string | Transaction amount |
| tradeToAmount | string | Transaction amount |
| price | string | Order price |
| tradePrice | string | Transaction price |
| orderStatus | string | See Appendix:Payout order status |
| createTime | int64 | Order creation time |
| finishTime | int64 | Order completion time |
| errorMsg | string | Order failure reason |
| settlementAccountUID | int64 | Settlement Account ID(Unique) |
| purpose | string | See Appendix: Purpose |
| paymentWay | string | Payment Method：RDT/CHATS |
| feeMode | int32 | Fee Deduction Mode: 1-Shared by both sender and receiver (SHAR) 2-Borne entirely by the payer (OUR) This field is required if accountType of settlementAccountUID is 2. |
| feeAmount | string | Service fee |
| feeCurrency | string | Fee Currency |
| refundOrderNo | string | Refund order no when the order fail |
| refundAmount | string | Refund amount when the order fail |
| refundCurrency | string | Refund currency when the order fail |
| extOrderNo | string | Unique Order ID provided by Business Entities |
4. Re-settle order(payoutReSettle)
Interface Overview Used to re-initiate settlement after a refund or settle fail. Request Parameters| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| walletId | int64 | M | Wallet ID |
| orderNo | string | M | Payout Order no |
| refundOrderNo | string | M | Return Order no |
| settlementAccountUID | int64 | M | Settlement Account ID(Unique) |
| purpose | string | M | See Appendix: Purpose |
| remark | string | M | Remark |
| paymentWay | string | M | Payment Method：RDT/CHATS |
| feeMode | int32 | O | Fee Deduction Mode: 1-Shared by both sender and receiver (SHAR) 2-Borne entirely by the payer (OUR) This field is required if accountType of settlementAccountUID is 2. |
| Field Name | Type | Description |
|---|---|---|
| code | int32 | Response code, indicating the result of request processing, such as 1 for success, and other values for different error conditions |
| message | string | Response message, providing detailed processing information or error Description |
| data | PayoutReSettleData | Re-settle order data |
| Field Name | Type | Description |
|---|---|---|
| walletId | int64 | Wallet ID |
| orderNo | string | Payout Order no |
| refundOrderNo | string | Return Order no |
| settlementAccountUID | int64 | Settlement Account ID(Unique) |
| purpose | string | See Appendix: Purpose |
| remark | string | Remark |
| paymentWay | string | Payment Method：RDT/CHATS |
| feeMode | int32 | Fee Deduction Mode: 1-Shared by both sender and receiver (SHAR) 2-Borne entirely by the payer (OUR) |
| amount | string | Re-settlement Amount |
| currency | int64 | Re-settlemen currency |
| feeAmount | string | Service fee |
| feeCurrency | string | Fee Currency |
5. Add Beneficiary Bank Account(addBankAccount)
Interface Overview Add a bank account for the beneficiary Request Parameters| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| walletId | int64 | M | Wallet ID |
| alias | string | M | Alis of this bank account |
| accountOwnership | int32 | M | Ownership 1-own account 2-other account 3=Third party |
| currency | string | M | Fiat currency, eg: USD |
| accountType | int32 | M | Bank Account Type 1-RD Wallet 2-Bank Account |
| companyName | string | M | Company name accountOwnership=2，this name must be same with the name in the company profile |
| accountNumber | string | M | RD Wallet Id or Bank account number |
| bankId | string | M | HK Bank Id，example:003 |
| beneficiaryAddress1 | string | CM | Address (Line 1) of the receiving party(Chinese characters are not allowed) *Mandatory when accountType=2 |
| beneficiaryAddress2 | string | CM | Address (Line 2) of the receiving party(Chinese characters are not allowed) *Mandatory when accountType=2 |
| beneficiaryAddress3 | string | CM | Address (Line 3) of the receiving party Country / Region of address must be specified. Please refer to the Country/Region ISO 3166 Code. *Mandatory when accountType=2 |
| beneficiarySwiftCode | string | CM | Unique code to identify the receiving bank (The recipient bank only supports banks located in Hong Kong. If the 5th and 6th characters of the Swift Code are not ‘HK’ or ‘HB’, it does not meet the requirements.) *Mandatory when accountType=2 |
| intermediarySwiftCode | string | O | Intermediate BankSwiftCode (The recipient bank only supports banks located in Hong Kong. If the 5th and 6th characters of the Swift Code are not ‘HK’ or ‘HB’, it does not meet the requirements.) |
| companyCode | string | CM | Company profile code *Mandatory when accountOwnership=2 |
| paymentFiles | Array<FileInfo> | CM | Proof of payment *Mandatory when accountOwnership=3 |
| remark | string | O | remark Optional when accountOwnership=3 |
| Field Name | Type | Description |
|---|---|---|
| code | int32 | Response code, indicating the result of request processing, such as 1 for success, and other values for different error conditions |
| message | string | Response message, indicating the result of the operation or error information |
| data | BankAccountData | Bank account information |
| Field Name | Type | Description |
|---|---|---|
| settlementAccountUID | int64 | Bank account unique id |
| walletId | int64 | Wallet ID |
| alias | string | Alias of bank account |
| accountOwnership | int32 | Ownership 1-own account 2-other account |
| currency | string | Fiat ccurrency, eg: USD |
| accountType | int32 | Bank Account type 1-RD Wallet 2-Bank Account |
| companyName | string | Company name |
| accountNumber | string | RD Wallet Id or Bank account number |
| bankId | string | HK Bank Id，example:003 |
| beneficiaryAddress1 | string | Address (Line 1) of the receiving party(Chinese characters are not allowed) |
| beneficiaryAddress2 | string | Address (Line 2) of the receiving party(Chinese characters are not allowed) |
| beneficiaryAddress3 | string | Address (Line 3) of the receiving party Country / Region of address must be specified. Please refer to the Country/Region ISO 3166 Code |
| beneficiarySwiftCode | string | Unique code to identify the receiving bank (The recipient bank only supports banks located in Hong Kong. If the 5th and 6th characters of the Swift Code are not ‘HK’ or ‘HB’, it does not meet the requirements.) |
| intermediarySwiftCode | string | Intermediate BankSwiftCode (The recipient bank only supports banks located in Hong Kong. If the 5th and 6th characters of the Swift Code are not ‘HK’ or ‘HB’, it does not meet the requirements.) |
| companyCode | string | Company profile code |
| status | int32 | Status 0-Processing 1-Success 2-Fail |
| paymentFiles | Array<FileInfo> | Proof of payment |
| remark | string | remark |
| Field Name | Type | Description |
|---|---|---|
| fileKey | string | After calling the upload interface, it will return |
| fileName | string | |
| fileUrl | string | After calling the upload interface, it will return and the URL will be updated regularly |
6. Update Beneficiary Bank Account(updateBankAccount)
Interface Overview Update the bank account for the beneficiary Request Parameters| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| walletId | int64 | M | Wallet ID |
| settlementAccountUID | int64 | M | Bank account unique id |
| alias | string | O | Alis of this bank account |
| accountNumber | string | O | RD Wallet Id or Bank account number |
| bankId | string | O | HK Bank Id，example:003 |
| beneficiaryAddress1 | string | O | Address (Line 1) of the receiving party(Chinese characters are not allowed) |
| beneficiaryAddress2 | string | O | Address (Line 2) of the receiving party(Chinese characters are not allowed) |
| beneficiaryAddress3 | string | O | Address (Line 3) of the receiving party Country / Region of address must be specified. Please refer to the Country/Region ISO 3166 Code |
| beneficiarySwiftCode | string | O | Unique code to identify the receiving bank (The recipient bank only supports banks located in Hong Kong. If the 5th and 6th characters of the Swift Code are not ‘HK’ or ‘HB’, it does not meet the requirements.) |
| intermediarySwiftCode | string | O | Intermediate BankSwiftCode (The recipient bank only supports banks located in Hong Kong. If the 5th and 6th characters of the Swift Code are not ‘HK’ or ‘HB’, it does not meet the requirements.) |
| paymentFiles | Array<FileInfo> | CM | Proof of payment *Mandatory when accountOwnership=3 |
| remark | string | O | remark Optional when accountOwnership=3 |
| Field Name | Type | Description |
|---|---|---|
| code | int32 | Response code, indicating the result of request processing, such as 1 for success, and other values for different error conditions |
| message | string | Response message, indicating the result of the operation or error information |
| data | BankAccountData | Bank account information |
| Field Name | Type | Description |
|---|---|---|
| settlementAccountUID | int64 | Bank account unique id |
| walletId | int64 | Wallet ID |
| alias | string | Alias of bank account |
| accountOwnership | int32 | Ownership 1-own account 2-other account |
| currency | string | Fiat ccurrency, eg: USD |
| accountType | int32 | Bank Account type 1-RD Wallet 2-Bank Account |
| companyName | string | Company name |
| accountNumber | string | RD Wallet Id or Bank account number |
| bankId | string | HK Bank Id，example:003 |
| beneficiaryAddress1 | string | Address (Line 1) of the receiving party(Chinese characters are not allowed) |
| beneficiaryAddress2 | string | Address (Line 2) of the receiving party(Chinese characters are not allowed) |
| beneficiaryAddress3 | string | Address (Line 3) of the receiving party Country / Region of address must be specified .Please refer to the Country/Region ISO 3166 Code |
| beneficiarySwiftCode | string | Unique code to identify the receiving bank (The recipient bank only supports banks located in Hong Kong. If the 5th and 6th characters of the Swift Code are not ‘HK’ or ‘HB’, it does not meet the requirements.) |
| intermediarySwiftCode | string | Intermediate BankSwiftCode (The recipient bank only supports banks located in Hong Kong. If the 5th and 6th characters of the Swift Code are not ‘HK’ or ‘HB’, it does not meet the requirements.) |
| companyCode | string | Company profile code |
| status | int32 | Status 0-Processing 1-Success 2-Fail |
| paymentFiles | Array<FileInfo> | Proof of payment |
| remark | string | remark |
7. Delete Beneficiary Bank Account(delBankAccount)
Interface Overview Delete the bank account for the beneficiary Request Parameters| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| walletId | int64 | M | Wallet ID |
| settlementAccountUID | int64 | M | Bank account unique id |
| reason | string | M | The reason of deletion |
| Field Name | Type | Description |
|---|---|---|
| code | int32 | Response code, indicating the result of request processing, such as 1 for success, and other values for different error conditions |
| message | string | Response message, indicating the result of the operation or error information |
8. Enquiry Beneficiary Bank Account(getBankAccount)
Interface Overview Enquiry the bank account of beneficiary Request Parameters| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| walletId | int64 | M | Wallet ID |
| settlementAccountUID | int64 | O | Bank account unique id |
| companyCode | string | O | Company profile code |
| Field Name | Type | Description |
|---|---|---|
| code | int32 | Response code, indicating the result of request processing, such as 1 for success, and other values for different error conditions |
| message | string | Response message, indicating the result of the operation or error information |
| data | BankAccountData list | Bank account information |
| Field Name | Type | Description |
|---|---|---|
| settlementAccountUID | int64 | Bank account unique id |
| walletId | int64 | Wallet ID |
| alias | string | Alias of bank account |
| accountOwnership | int32 | Ownership 1-own account 2-other account 3=Third party |
| currency | string | Fiat ccurrency, eg: USD |
| accountType | int32 | Bank Account type 1-RD Wallet 2-Bank Account |
| companyName | string | Company name |
| accountNumber | string | RD Wallet Id or Bank account number |
| bankId | string | HK Bank Id，example:003 |
| beneficiaryAddress1 | string | Address (Line 1) of the receiving party(Chinese characters are not allowed) |
| beneficiaryAddress2 | string | Address (Line 2) of the receiving party(Chinese characters are not allowed) |
| beneficiaryAddress3 | string | Address (Line 3) of the receiving party Country / Region of address must be specified Please refer to the Country/Region ISO 3166 Code |
| beneficiarySwiftCode | string | Unique code to identify the receiving bank (The recipient bank only supports banks located in Hong Kong. If the 5th and 6th characters of the Swift Code are not ‘HK’ or ‘HB’, it does not meet the requirements.) |
| intermediarySwiftCode | string | Intermediate BankSwiftCode (The recipient bank only supports banks located in Hong Kong. If the 5th and 6th characters of the Swift Code are not ‘HK’ or ‘HB’, it does not meet the requirements.) |
| companyCode | string | Company profile code |
| status | int32 | Status 0-Processing 1-Success 2-Fail |
| paymentFiles | Array<FileInfo> | Proof of payment |
| remark | string | remark |
Callback
1. Callback request body (CallbackRequest)
Interface Overview The callback request body is used to receive the business data pushed back by the server. Request Parameters| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| bizType | OpenBizType | M | Business type, specify the callback business type |
| data | bytes | M | Business binary data, the actual business content in the callback |
| clientFingerprint | string | M | Client certificate fingerprint, used to verify the client identity of the callback request |
| serverFingerprint | string | M | Server certificate fingerprint, used to verify the server identity of the callback request |
| Enumeration Values | Description |
|---|---|
| _BIZ_TYPE_UNKNOWN | Unknown business type |
| ORDER_RESULT_NOTIFICATION | Order result notification |
| WHITELIST_RESULT_NOTIFICATION | Whitelist result notification |
| EXCHANGE_BIZ_TYPE_NOTIFICATION | Transaction business type notification |
| WALLET_OPEN_NOTIFICATION | Wallet account opening result notification |
2. Callback data type
2.1 Order result notification
Field Description| Field Name | Type | Description |
|---|---|---|
| orderNo | string | Order Number |
| currency | string | Currency: USDT/USDC |
| network | string | Blockchain network: ETH/TRX/SOL/POLY |
| status | string | Order Status |
| amount | string | Amount |
| fromAddress | string | Initiator address |
| fromWallet | string | Source wallet |
| toAddress | string | Recipient Address |
| toWallet | string | Target wallet |
| txHash | string | Transaction Hash |
| orderType | string | Order Type |
| extOrderNo | string | External order number |
2.2 Whitelist result notification
Field Description| Field Name | Type | Description |
|---|---|---|
| network | string | Blockchain network: ETH/TRX/SOL/POLY |
| address | string | address |
| businessType | int32 | Business Type: 1-deposit 2-withdraw |
| status | string | Status: true,false |
2.3 Wallet opening notification
WalletDetailDto Field Description| Field Name | Type | Description |
|---|---|---|
| walletId | int64 | Wallet ID |
| companyName | string | Company Name |
| companyNameCn | string | Chinese company name |
| walletStatus | string | Wallet opening status: Success |
| createTime | string | Wallet creation time |
| walletType | int32 | Wallet Type: 1- Main wallet 2-Sub-wallet |
| assets | AssetDto | List of managed assets |
| Field Name | Type | Description |
|---|---|---|
| network | string | Blockchain network: ETH/TRX/SOL/POLY, the channel to which the asset belongs. Trading assets do not have this field |
| currency | string | Asset currency: USDT/USDC |
| totalBalance | string | Total balance of assets |
| availableBalance | string | Available balance of assets |
| lockBalance | string | The locked balance of the asset |
2.4 Add Bank Account Result Notification
Field Description| Field Name | Type | Description |
|---|---|---|
| settlementAccountUID | int64 | Bank account unique id |
| walletId | int64 | Wallet ID |
| alias | string | Alias of bank account |
| accountOwnership | int32 | Ownership 1-own account 2-other account |
| currency | string | Fiat ccurrency, eg: USD |
| accountType | int32 | Bank Account type 1-RD Wallet 2-Bank Account |
| accountName | string | Company name |
| accountNumber | string | RD Wallet Id or Bank account number |
| bankId | string | HK Bank Id，example:003 |
| beneficiaryAddress1 | string | Address (Line 1) of the receiving party(Chinese characters are not allowed) |
| beneficiaryAddress2 | string | Address (Line 2) of the receiving party(Chinese characters are not allowed) |
| beneficiaryAddress3 | string | Address (Line 3) of the receiving party Country / Region of address must be specified Please refer to the Country/Region ISO 3166 Code |
| beneficiarySwiftCode | string | Unique code to identify the receiving bank (The recipient bank only supports banks located in Hong Kong. If the 5th and 6th characters of the Swift Code are not ‘HK’ or ‘HB’, it does not meet the requirements.) |
| intermediarySwiftCode | string | Intermediate BankSwiftCode (The recipient bank only supports banks located in Hong Kong. If the 5th and 6th characters of the Swift Code are not ‘HK’ or ‘HB’, it does not meet the requirements.) |
| companyCode | string | Company profile code |
| status | int32 | Status 0-Processing 1-Success 2-Fail |
2.5 Payout Result Notification
Field Description| Field Name | Type | Description |
|---|---|---|
| walletId | int64 | Wallet ID |
| quoteId | int64 | Inquiry ID |
| orderNo | string | Order Number |
| fromCurrency | string | From Currency: USDT,USDC |
| fromAmount | string | From Amount |
| toCurrency | string | To Currency: USD |
| toAmount | string | To Amount（Subtract Service fee ） |
| tradeFromAmount | string | Transaction amount |
| tradeToAmount | string | Transaction amount |
| price | string | Order price |
| tradePrice | string | Transaction price |
| orderStatus | string | See Appendix:Payout order status |
| createTime | int64 | Order creation time |
| finishTime | int64 | Order completion time |
| errorMsg | string | Order failure reason |
| settlementAccountUID | int64 | Settlement Account ID(Unique) |
| purpose | string | See Appendix: Purpose |
| paymentWay | string | Payment Method：RDT/CHATS |
| feeMode | int32 | Fee Deduction Mode: 1-Shared by both sender and receiver (SHAR) 2-Borne entirely by the payer (OUR) This field is required if accountType of settlementAccountUID is 2. |
| feeAmount | string | Service fee |
| feeCurrency | string | Fee Currency |
| refundOrderNo | string | Payout order status is SETTLING_SAILED with value, used to re-settlement |
| extOrderNo | string | Unique Order ID provided by Business Entities |
2.6 Payout Refund Result Notification
Field Description| Field Name | Type | Description |
|---|---|---|
| walletId | int64 | Wallet ID |
| orderNo | string | Order Number |
| refundOrderNo | string | Refund Order Number |
| refundAmount | string | Refund Amount |
| refundCurrency | string | Refund Currency |
| refundReason | string | Refund Reason |
2.7 Payout Re-Settle Result Notification
Field Description| Field Name | Type | Description |
|---|---|---|
| walletId | int64 | Wallet ID |
| orderNo | string | Order Number |
| refundOrderNo | string | Refund Order Number |
| settlementAccountUID | int64 | Settlement Account ID(Unique) |
| purpose | string | See Appendix: Purpose |
| remark | string | remark |
| paymentWay | string | Payment Method：RDT/CHATS |
| feeMode | int32 | Fee Deduction Mode: 1-Shared by both sender and receiver (SHAR) 2-Borne entirely by the payer (OUR) This field is required if accountType of settlementAccountUID is 2. |
| amount | string | amount |
| currency | int64 | currency |
| feeAmount | string | Service fee |
| feeCurrency | string | Fee Currency |
2.8 Enterprise Application Result Notification
Field Description| Field Name | Type | Description |
|---|---|---|
| applicationNo | string | RD application number |
| extApplicationNo | string | External application number |
| applicationCreateTime | int64 | Application creation time (milliseconds timestamp) |
| applicationStatus | string | Application status: IN_PROGRESS, SUCCESS, FAIL |
| rejectReason | string | Rejection reason (if the application is rejected) |
| companyCode | string | Company code |
| businessType | int32 | Business type: 1 - Limited Company 2 - Partnership 3 - Sole Proprietorship |
| incorpPlace | string | Company registration place, e.g.: HKG |
| ciNumber | string | Company registration certificate number |
| brNumber | string | Business Registration Certificate number |
| incorpDate | string | Company registration date, format: yyyy-MM-dd |
| nameEn | string | Company English name |
| nameZh | string | Company local name (Chinese name) |
Appendix
Response Code
| Code | Description |
|---|---|
| 1 | success |
| 6001 | failed General service failure |
| 6002 | parameter error |
| 6003 | order not exist (order does not exist) |
| 6004 | order duplicate (Duplicate order) |
| 6005 | no permissions |
| 6006 | assets not exists |
| 6101 | wallet account not exists |
| 6102 | wallet insufficient fund |
| 6103 | wallet status invalid (wallet account invalid) |
| 6104 | recipient wallet unavailable(Receiving wallet is not available) |
| 6105 | recipient wallet not exists(The receiving wallet does not exist) |
| 6109 | Daily payment limit exceeded |
| 6110 | Monthly collection limit exceeded |
| 6301 | provider unavailable (channel unavailable) |
| 6302 | symbol unavailable |
| 6303 | provider reject |
| 6304 | price expire time |
| 6305 | amount lt min amount (amount is less than the minimum limit) |
| 6306 | amount gt max amount (amount is greater than the maximum limit) |
| 6307 | outside of hours |
| 6401 | adress already exists |
| 6406 | processing (the request is being processed) |
| 6801 | duplicate request |
| 6802 | profile error |
| 6803 | reach the max limit |
Last Year Sales
| Code | Description (HKD) |
|---|---|
| 1 | HKD 50,000,001 or above |
| 2 | HKD 30,000,001 - 50,000,000 |
| 3 | HKD 10,000,001 - 30,000,000 |
| 4 | HKD 5,000,001 - 10,000,000 |
| 5 | HKD 2,500,001 - 5,000,000 |
| 6 | HKD 0 - 2,500,000 |
Years in Business
| Code | Description |
|---|---|
| 1 | Less than 1 year |
| 2 | 1-5 years |
| 3 | 5-10 years |
| 4 | Over 10 years |
Profile Error Description
| [Business details]Industry cannot be empty! |
|---|
| [Business details]Added industries exceeded limit: 3 |
| [Business details]Industry code cannot be empty! |
| [Business details]Industry code does not exist! |
| [Business details]Sales turnover of last year cannot be empty! |
| [Business details]Incorrect sales turnover of last year input! |
| [Business details]Year(s) in business cannot be empty! |
| [Business details]Incorrect year(s) in business input! |
| [Business details]Location(s) of business cannot be empty! |
| [Business details]Location(s) of business exceeded limit: 3 |
| [Business details]Industry details cannot be empty! |
| [Business details]Industry details exceeded maximum length |
| [Entity details]We only support partnership business in Hong Kong |
| [Entity details]We only support sole proprietorship business in Hong Kong |
| [Entity details]Please enter the ciNumber. |
| [Entity details]Please enter the brNumber. |
| [Entity details]Operating place cannot be empty! |
| [Entity details]Operating address cannot be empty! |
| [Entity details]Operating address exceeded maximum length |
| [Entity details]Company registered place cannot be empty! |
| [Entity details]Company registered place not supported:[area name] |
| [Entity details]Operating place cannot be empty! |
| [Entity details]The operating place is not supported:[area name] |
| [Entity details]Company registered address cannot be empty! |
| [Entity details]Company registered address maximum length |
| [Entity details]Company registered address in English only |
| [Entity details]Website exceeded maximum length |
| [Entity details]Incorrect business type! |
| [Entity details]Business registration certificate number exceeded max length |
| [Entity details]Business registration certificate number cannot be empty |
| [Entity details]Certificate of incorporation number exceeded maximum length |
| [Entity details]Certificate of incorporation number cannot be empty |
| [Entity details]Name of business in English cannot be empty! |
| [Entity details]Name of business in Chinese cannot be empty! |
| [Entity details]Name of business in Chinese exceeded maximum length |
| [Entity details]Name of business in English exceeded maximum length |
| [Entity details]Not allowed option |
| [Entity details]Please upload a valid proof of Certificate of Incorporation |
| [Entity details]Please upload a valid proof of Memorandum and Articles of Association |
| [Entity details]Please upload a valid proof of Business Registration |
| [Entity details]Please upload a valid proof of Partnership Agreement |
| [Entity details]Please upload a valid proof of Certificate of Incumbency |
| [Entity details]Please upload a valid proof of KYC Files |
| [Entity details]Duplicated document |
| [Entity details]Please enter a valid business type. |
| [Entity details]Company incorporation date cannot be empty |
| [Entity details]Company incorporation date cannot be empty be greater than current date:{Corresponding Value} |
| [Entity details]Place of financial regulator cannot be empty! |
| [Entity details]Incorrect place of financial regulator input! |
| [Entity details]Name of regulator cannot be empty! |
| [Entity details]Name of regulator exceeded maximum length |
| [Entity details]Type of license cannot be empty! |
| [Entity details]Type of license exceeded maximum length |
| [Entity details]Incorrect place of incorporation! |
| [Entity details]Sorry, the country/region is not supported yet! We are currently unable to serve your business. Please stay tuned, we will support more countries/regions in the future:placeOfIncorporation |
| [Entity details]We only support partnership business in Hong Kong |
| [Entity details]We only support sole proprietorship business in Hong Kong |
| [Entity details]Place of financial regulator cannot be empty! |
| [Entity details]Incorrect place of financial regulator input! |
| [Entity details]Name of regulator cannot be empty! |
| [Entity details]Name of regulator exceeded maximum length |
| [Entity details]Type of license cannot be empty! |
| [Entity details]Type of license exceeded maximum length |
| [Entity details]Please upload a valid proof of License/Certificate of Financial Institution |
| [Entity details]Place of listing cannot be empty! |
| [Entity details]Incorrect place of listing input! |
| [Entity details]Name of exchange cannot be empty! |
| [Entity details]Name of exchange exceeded maximum length |
| [Entity details]Stock code cannot be empty! |
| [Entity details]Stock code exceeded maximum length |
| [Entity details]Place of government owner cannot be empty! |
| [Entity details]Incorrect place of government owner input! |
| [Key people]Email exceeded maximum length |
| [Key people]Incorrect email address format |
| [Key people]AreaCode exceeded maximum length |
| [Key people]MobileNumber exceeded maximum length |
| [Key people]Incorrect country/region of key people |
| [Key people]Incorrect country/region and idType of key people |
| [Key people]Incorrect idType |
| [Key people]The user’s idv information is incomplete |
| [Key people]Last name in English exceeded maximum length |
| [Key people]Last name in English and first name in English cannot have only one value |
| [Key people]First name in English exceeded maximum length |
| [Key people]Name in Chinese exceeded maximum length |
| [Key people]idNumber exceeded maximum length |
| [Key people]Incorrect gender |
| [Key people]Please upload a valid proof of key people |
| [Key people]Please set a valid quorum |
| [Key people]Id Number[idNumber]was duplicate! |
| [Key people]Signer must be equal or greater than quorum |
| [Key people]Direct number has to be between 1 to 99 |
| [Key people]Partner number has to be between 2 to 6 |
| [Key people]Please add at least one owner |
| [Key people]Please add at most one owner |
| [Key people]Only limited company can create director |
| [Key people]Only limited company can create director |
| [Key people]Only partnership can create partner |
| [Key people]Please select at least one role for user: |
| [Key people]IsOwner is only supported by sole proprietorship |
| [Shareholder]Shareholder structure cannot be empty |
| [Shareholder]Incorrect Level in sharesholder structure, only Zero to Ten Level |
| [Shareholder]Last name in English exceeeded maximum length |
| [Shareholder]First name in English exceeded maximum length |
| [Shareholder]Name in Chinese exceeded maximum length |
| [Shareholder]Shareholder (company) name in English exceeded maximum length |
| [Shareholder]Shareholder (company) name in Chinese exceeded maximum length |
| [Shareholder]Shareholder (company) RegulatorName exceeded maximum length |
| [Shareholder]Shareholder (company) ExchangeName exceeded maximum length |
| [Shareholder]Shareholder (company) Stock code exceeded maximum length |
| [Shareholder]Incorrect ownedSharesPercent |
| [Shareholder]Shareholder type cannot be empty |
| [Shareholder]Please input correct shareholder type:[type] |
| [Shareholder]Shareholder (personal) name in English and Chinese cannot be empty at the same time! |
| [Shareholder]Shareholder (company) name cannot be empty |
| [Shareholder]Shareholder (company) business type cannot be empty |
| [Shareholder]Please input correct business type for the shareholder (company):[businessType] |
| [Shareholder]We only support sole proprietorship business in Hong Kong |
| [Shareholder]We only support partnership business in Hong Kong |
| [Shareholder]Shareholder (company) place of incorporate cannot be empty |
| [Shareholder]Incorrect shareholder (company) place of incorporate |
| [Shareholder]We only support company registered place for partnership and sole proprietorship in Hong Kong only |
| [Shareholder]Last name in English and first name in English cannot have only one value |
| [Shareholder]ParentId cannot be empty |
| [Shareholder]Listed/government owner/financial regulator not support partnership business |
| [Shareholder]Place of financial regulator cannot be empty! |
| [Shareholder]Place of financial regulator not supported! |
| [Shareholder]Name of regulator cannot be empty! |
| [Shareholder]Name of regulator exceeded maximum length |
| [Shareholder]Type of license cannot be empty! |
| [Shareholder]Type of license exceeded maximum length |
| [Shareholder]Listed/government owner not support sole proprietorship business |
| [Shareholder]Place of listing cannot be empty! |
| [Shareholder]Place of listing not supported! |
| [Shareholder]Name of exchange cannot be empty! |
| [Shareholder]Name of exchange exceeded maximum length |
| [Shareholder]Stock code cannot be empty! |
| [Shareholder]Stock code exceeded maximum length |
| [Shareholder]Place of government owner cannot be empty! |
| [Shareholder]Incorrect place of government owner input! |
| [Shareholder]Corresponding shareholder type for sameId[id] is different |
| [Shareholder]Corresponding shareholder name for sameId[id] is different |
| [Shareholder]Incorrect parentId in sharesholder structure |
| [Shareholder]Abnormal shareholder structure |
| [Shareholder]Shareholder structure cannot exceed 10 layers |
| [Shareholder]Shareholder structure is not necessary |
| [Others]Customer type error. |
Exchange order status
| Code | Description | Remark |
|---|---|---|
| SUBMITTED | Submitted | Order Submitted |
| CONVERTING | Redemption | Order redemption |
| SETTLING | Settlement | The exchange is successful and the settlement is carried out |
| SUCCESSFUL | Successful transaction | Order processed successfully |
| FAILED | Transaction Failure | Order processing failed |
Payout order status
| Code | Description | Remark |
|---|---|---|
| SUBMITTED | Submitted | Order Submitted |
| CONVERTING | Exchanging | Order exchanging |
| SETTLING | Settling | Exchange Successful, Proceeding with Settlement |
| SETTLING_FAILED | Settlement Failed | Exchange Successful, Settlement Failed |
| SETTLING_REFUND | Refund Processing | Refunded After Successful Settlement |
| SUCCESSFUL | Successful transaction | Order Processed Successfully |
| FAILED | Transaction Failure | Order Processed Failed |
Deposit order status
| Code | Description | Remark |
|---|---|---|
| SUBMITTED | Submitted | Order Submitted |
| VERIFYING | Order Verification | Upon order submission, a security verification is performed. Applies only to Request Payment. |
| AWAIT_FOR_RECEIVE | Awaiting Payment | The order was created successfully and is currently awaiting payment. This status applies specifically to the Request Payment flow. |
| PAYMENT_VERIFYING | Payment Verification in Progress | Payment has been received by the platform. Initiating security verification. This step applies only to the Request Payment flow. |
| AWAIT_FOR_DECLARATION | Additional Documents Required | Trade documents pending submission. Applicable only to Request Payment transactions. |
| DECLARATION_REVIEW | Document Review in Progress | Document Review in Progress |
| SUCCESS | Transaction Successful | Order Successful |
| FAILED | Transaction Failed | Order Failed |
| CLOSED | Transaction Closed | Order Closed Due to Expiration |
| RETURNING | Processing Refund | Processing Refund |
| RETURNED | Refunded | Refund Processed Successfully |
| IN_PROGRESS | Payment Verification in Progress | Payment has been received by the platform. Initiating security verification. This step applies only to Deposit transactions. |
Order Type
| Code | Description |
|---|---|
| 1 | Deposit |
| 2 | Wallet Transfer |
| 3 | Internal Transfer |
| 4 | Request Payment |
| 5 | Withdraw |
Field Description: amount
This field is used to indicate the transaction amount. The type is string. The specific accuracy requirements are as follows:- Digital Currency : Generally supports accuracy up to 6 decimal places , which is used to meet the accuracy requirements of on-chain transactions;
- Fiat Currency : usually retains up to 2 decimal places , that is, accurate to “cents”;
- Japanese Yen (JPY) : Since Japanese Yen is a currency without decimals, amountit should be an integer and no decimal part is allowed .
Purpose
| Code | Desciption |
|---|---|
| PMT001 | Invoice payments |
| PMT002 | Payment for services |
| PMT003 | Payment for software |
| PMT004 | Payment for imported goods |
| PMT005 | Travel services |
| PMT006 | Transfer to own account |
| PMT007 | Repayment of loans |
| PMT009 | Payment of property rental |
| PMT010 | Information Service Charges |
| PMT011 | Advertising & Public relations-related expenses |
| PMT012 | Royalty fees, trademark fees, patent fees, and copyright fees |
| PMT013 | Fees for brokers, front end fee, commitment fee, guarantee fee and custodian fee |
| PMT014 | Fees for advisors, technical assistance, and academic knowledge, including remuneration for specialists |
| PMT015 | Representative office expenses |
| PMT016 | Tax Payment |
| PMT017 | Transportation fees for goods |
| PMT018 | Construction costs/expenses |
| PMT019 | Insurance Premium |
| PMT020 | General Goods Trades - Offline trade |
| PMT021 | Insurance Claims Payment |
| PMT024 | Medical Treatment |
| PMT025 | Donations |
| PMT026 | Mutual Fund Investment |
| PMT027 | Currency Exchange |
| PMT028 | Advance Payments for Goods |
| PMT029 | Merchant Settlement |
| PMT030 | Repatriation Fund Settlement |