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，aside 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 |
API Index
| Category | # | API | REST Path |
|---|---|---|---|
| WalletManagementAPI | 1 | Fixed Receiving Address Query | POST /api/v1/wallet/receive-address/query |
| WalletManagementAPI | 2 | Static Receiving Address Query | POST /api/v1/wallet/static-address/query |
| WalletManagementAPI | 3 | Supported Currencies Query | POST /api/v1/wallet/supported/currencies |
| WalletManagementAPI | 4 | Wallet Assets | POST /api/v1/wallet/assets |
| WalletPaymentAPI | 1 | Wallet Transfer | POST /api/v1/payment/transfer |
| WalletPaymentAPI | 2 | Get Signature | POST /api/v1/payment/sign |
| WalletPaymentAPI | 3 | Add Address Whitelist | POST /api/v1/payment/address/whitelist/add |
| WalletPaymentAPI | 4 | Check Address Whitelist | POST /api/v1/payment/address/whitelist/check |
| WalletPaymentAPI | 5 | Delete Address Whitelist | POST /api/v1/payment/address/whitelist/delete |
| WalletPaymentAPI | 6 | Declare Receive Order | POST /api/v1/payment/order/declare |
| WalletPaymentAPI | 7 | Wallet Order Detail | POST /api/v1/payment/order/detail |
| WalletPaymentAPI | 8 | Request Payment Order Declaration | POST /api/v1/payment/order/declare |
| WalletPaymentAPI | 9 | Request Payment Material Supplement | POST /api/v1/payment/order/add/materials |
| WalletPaymentAPI | 10 | Fee Query | POST /api/v1/payment/fee/query |
| WalletPaymentAPI | 11 | Withdraw | POST /api/v1/payment/withdraw |
| WalletPaymentAPI | 12 | Download Statement | POST /api/v1/payment/reconciliation |
| Off-ramp API | 1 | Payout Quote | POST /api/v1/payout/quote |
| Off-ramp API | 2 | Payout Order | POST /api/v1/payout/book |
| Off-ramp API | 3 | Payout Order Enquiry | POST /api/v1/payout/enquiry |
| Off-ramp API | 4 | Payout Re-Settle | POST /api/v1/payout/reSettle |
| Off-ramp API | 5 | Add Beneficiary Bank Account | POST /api/v1/wallet/bank_account/add |
| Off-ramp API | 6 | Update Beneficiary Bank Account | POST /api/v1/wallet/bank_account/update |
| Off-ramp API | 7 | Delete Beneficiary Bank Account | POST /api/v1/wallet/bank_account/del |
| Off-ramp API | 8 | Enquiry Beneficiary Bank Account | POST /api/v1/wallet/bank_account/get |
WalletManagementAPI
1. Fixed Receiving 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 |
{
"walletId": 123456789,
"network": "ETH",
"currency": "USDT"
}
{
"code": 1,
"message": "success",
"data": {
"address": "0x123456789abcdef"
}
}
2. Static Receiving Address Query (StaticAddressQuery)
Interface Overview Query the Request Payment static receiving address of a specified wallet. Request Parameters| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| walletId | int64 | M | Wallet ID |
| network | string | O | Blockchain network: ETH / TRX / SOL / POLY |
| currency | string | O | Currency: USDT / USDC |
| Field Name | Type | Description |
|---|---|---|
| code | int32 | Business response code |
| message | string | Business response message |
| data | Array<StaticAddressData> | Static receiving address list |
| Field Name | Type | Description |
|---|---|---|
| walletId | int64 | Wallet ID |
| network | string | Blockchain network, such as ETH / TRX |
| currency | string | Currency, such as USDT / USDC |
| address | string | Static receiving address |
| qrCodeBase64 | string | QR code image of the address, Base64 encoded, including the data:image/png;base64, prefix. It can be directly used in <img src> |
{
"walletId": 123456789,
"network": "ETH",
"currency": "USDT"
}
{
"code": 1,
"message": "Success",
"data": [
{
"walletId": 123456789,
"network": "ETH",
"currency": "USDT",
"address": "0x9f8b2c1d4e5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c",
"qrCodeBase64": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA..."
}
]
}
3. Supported Currencies Query (SupportedCurrenciesQuery)
Interface Overview Query the currencies, available networks, single-transaction amount range, and currency precision supported by the wallet under a specified business type bywalletId + type. The caller can use this API for pre-validation before creating deposit or withdrawal orders, to avoid submitting unsupported or out-of-limit currency combinations.
Request Parameters
| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| walletId | int64 | M | Wallet ID |
| type | string | M | Business type / limit type: 4 deposit, 3 withdraw |
| Field Name | Type | Description |
|---|---|---|
| code | int32 | Business response code |
| message | string | Business response message |
| data | Array<SupportedCurrenciesQueryData> | Supported currency list; returned when code = 1 |
| Field Name | Type | Description |
|---|---|---|
| type | int32 | Business type / limit type, corresponding to the request type |
| currency | string | Currency, such as USDT / USDC / USD |
| minAmount | string | Minimum single-transaction amount, decimal number in string format |
| maxAmount | string | Maximum single-transaction amount, decimal number in string format |
| networks | Array<string> | Supported blockchain network list for this currency, such as ETH / TRX / SOL |
| precision | int32 | Amount precision, number of decimal places |
{
"walletId": 123456789,
"type": 4
}
{
"code": 1,
"message": "Success",
"data": [
{
"type": 4,
"currency": "USDT",
"minAmount": "10",
"maxAmount": "50000",
"networks": ["ETH", "TRX"],
"precision": 6
},
{
"type": 4,
"currency": "USDC",
"minAmount": "10",
"maxAmount": "50000",
"networks": ["ETH", "SOL"],
"precision": 6
}
]
}
4. Wallet Assets (WalletAssets)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 |
| currency | string | Asset currency: USDT/USDC |
| totalBalance | string | Total balance |
| availableBalance | string | Available balance |
| lockBalance | string | Locked balance |
{
"walletId": 1001
}
{
"code":1,
"message":"success",
"data":{
"walletId":123456789,
"companyName":"RD Tech",
"companyNameCn":"圆币科技",
"walletStatus":1,
"createTime":"2024-05-20T10:00:00Z",
"walletType":1,
"assets":[
{
"network":"ETH",
"currency":"USDT",
"totalBalance":"10.0",
"availableBalance":"10.0",
"lockBalance":"0"
}
],
"exchangeAssets":[
{
"currency":"USDT",
"totalBalance":"10.0",
"availableBalance":"10.0",
"lockBalance":"0"
}
]
}
}
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 |
{
"walletId": 1001,
"targetWalletId": 1002,
"currency": "USDT",
"network": "ETH",
"amount": "1.0",
"extOrderNo": "EXT123456789",
"message": "Transfer Notes"
}
{
"code": 1,
"message": "success",
"data": {
"orderNo": "ORDER123456789"
}
}
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 |
{
"network": "ETH",
"address": "0x123456789abcdef"
}
{
"code": 1,
"message": "Success",
"data":
{
"data": "93fb699d-160e-43a0-b053-817ca4bbdcfd;1746755842000",
"expireTime": 1746755842000
}
}
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 |
[
{
"network": "ETH",
"address": "0x123456789abcdef",
"checkType": 1,
"businessType": 1,
"addressSource": 1,
"walletId":429883231600640,
"remarks":"this is a remark",
"signature":"0x1e2bc15251969197f9ceedd8dc327f1ab0c993a7cd0a12794414b62be653cda410b2cd48950ffb7ee3184dcd13ce0674eefde540ce2983a0c9e91c6c4893cea51b",
"signData":"4553493b-7734-435a-8c93-9ae92e89c99e;1746612121000"
},
{
"network": "ETH",
"address": "0x123456789abcdef",
"checkType": 2,
"businessType": 1,
"addressSource": 1,
"remarks":"this is a remark",
"currency":"USDT",
"walletId":429883231600640
}
]
{
"code": 1,
"message": "Success",
"data": {
"id": 708258726632620032,
"network": "ETH",
"address": "0x022a50AE43baC1FBECC160a01a7eb13c64553d7F6",
"checkType": 1,
"signData": "93fb699d-160e-43a0-b053-817ca4bbdcfd;1746755842000",
"signature": "93fb699d-160e-43a0-b053-817ca4bbdcfd;1746755842000",
"currency": "",
"depositAddress": "",
"amount": "",
"status": "PENDING",
"expireTime": 0,
"businessType": 1,
"addressSource": 1,
"platformName": "",
"remarks": "this is a withdraw 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 |
{
"network": "ETH",
"address": "0x123456789abcdef",
"businessType": 1
}
{
"code": 1,
"message": "success",
"data":
{
"businessType": 1,
"status ": "SUCCESS",
"remarks": "deposit whitelist"
}
}
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 |
{
"network": "ETH",
"address": "0x123456789abcdef",
"businessType": 1
}
{
"code": 1,
"message": "success"
}
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 |
{
"senderAddress": "0x123456789abcdef",
"recipientAddress": "0x987654321fedcba",
"amount": "1000.0",
"network": "ETH",
"currency": "USDT",
"extOrderNo": "EXT123456789"
}
{
"code": 1,
"message": "success"
}
7. Order details (walletOrderDetail)
Interface Overview Query wallet order details. Request Parameters| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| walletId | int64 | M | Wallet ID |
| 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 |
{
"orderNo": "ORDER123456789"
}
{
"code": 1,
"message": "success",
"data": {
"orderNo": "447767487604736",
"extOrderNo": "1744341998597",
"orderType": "PayIn",
"orderStatus": "SUCCESSFUL",
"fromAddress": "0x213F2B229BE4f3FFF88fc874a986b19D79623339",
"toAddress": "0xc496E20b19F009543E49b8512CB990ceb0a230F0",
"toWallet": "429883231600640",
"amount": "17",
"network": "ETH",
"currency": 1744342001561,
"expireTime": 1744342629783,
"createTime": 1744343297296
}
}
8. 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 |
{
"walletId": "429883231600640",
"extOrderNo": "1747626211614",
"senderAddress": "0x213F2B229BE4f3FFF88fc874a986b19D79623339",
"network": "ETH",
"currency": "USDC",
"senderName": "Reflective Method Invocation",
"countryRegion": "HKG",
"contactAddress": "contact address hong kong",
"receiverName": "Reflective Method Invocation",
"message": "request payment msg",
"materials": [{
"productType": "Electronics",
"productName": "Wireless Bluetooth Headphones",
"productPrice": "89.99",
"productCount": "150",
"productUnit": "pcs",
"logisticsTrackingName": "FedEx International Priority",
"logisticsTrackingNo": "FX123456789US"
}],
"amount": "150"
}
{
"code": 1,
"message": "success"
}
9. 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 |
{
"walletId": "429883231600640",
"orderNo": "447767487604736",
"materials": [{
"productType": "Electronics",
"productName": "Wireless Bluetooth Headphones",
"productPrice": "89.99",
"productCount": "150",
"productUnit": "pcs",
"logisticsTrackingName": "FedEx International Priority",
"logisticsTrackingNo": "FX123456789US"
}]
}
{
"code": 1,
"message": "success"
}
10. 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 |
{
"walletId": "429883231600640",
"network": "ETH",
"currency": "USDC",
"payAmount": "666.66"
}
{
"code": 1,
"message": "success",
"data": {
"walletId": "429883231600640",
"network": "ETH",
"currency": "USDC",
"payAmount": "666.66",
"feeAmount": "19.9998",
"receiveAmount": "646.6602"
}
}
11. 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 |
{
"walletId": "429883231600640",
"extOrderNo": "ext-1745477734002",
"network": "ETH",
"currency": "USDC",
"recipientAddress": "0x213F2B229BE4f3FFF88fc874a111b19D79623339",
"message": "Message ttt",
"payAmount": "666.66"
}
{
"code": 1,
"message": "success"
}
12. 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, only supports Fiduciary Account: 1-Fiduciary 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 |
{
"walletId ": 123456789,
"billDate": "20250330",
"modeType": 1,
"accountType": 1,
"currencyType": 1
}
{
"code": 1,
"message": "success",
"data": {
"fileName": "20231123_123456789_Statement_ETHUSDT.zip",
"fileUrl": "https://hk-pro-wallet-private-oss.oss-cn-hongkong.aliyuncs.com/thirdpartybilling/1737925914987610112.zip?Expires=1703216183&OSSAccessKeyId=LTAI5tKJmyxrRXQgpGwhhVnK&Signature=8MXwogxJ0NXBZ3FTS6O97%2B%2FpEiQ%3D"
}
}
Off-ramp API
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 |
| network | string | O | Blockchain Network: ETH/TRX/SOL/POLY |
| 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 |
| network | string | Blockchain Network: ETH/TRX/SOL/POLY |
| 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 |
{
"walletId":1000232233,
"network":"ETH",
"fromCurrency":"USDT",
"fromAmount":"200.12",
"toCurrency":"USD",
"paymentWay":"CHATS",
"feeMode":1
}
{
"code":1,
"message":"Success",
"data":{
"walletId":"429405186232384",
"network":"ETH",
"fromCurrency":"USDT",
"fromAmount":"200.12",
"toCurrency":"USD",
"toAmount":"192.83",
"paymentWay":"CHATS",
"feeMode":1,
"quoteId":"665131773713321985",
"price":"0.9986",
"priceExpireTime":"1736387772381",
"feeAmount":"7",
"feeCurrency":"USD"
}
}
2. Payout order (payoutBook)
Interface Overview Place a payout order based on thequoteId returned by the quote API.
Request Parameters
| Field Name | Type | M / O / CM | Description |
|---|---|---|---|
| walletId | int64 | M | Wallet ID |
| quoteId | int64 | M | Quote ID |
| settlementAccountUID | int64 | M | Settlement account ID, obtained through the bank account enquiry API |
| purpose | string | M | Payment purpose. See Appendix: Purpose |
| extOrderNo | string | M | Unique order ID provided by the business entity. Only numbers, letters, _, -, and * are allowed. Must be unique under the same merchant account |
| Field Name | Type | Description |
|---|---|---|
| code | int32 | Response code |
| message | string | Response message |
| data | PayoutBookData | Payout order result |
| Field Name | Type | Description |
|---|---|---|
| walletId | int64 | Wallet ID |
| quoteId | int64 | Quote ID |
| settlementAccountUID | int64 | Settlement account ID |
| purpose | string | Payment purpose. 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 after deducting 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 the business entity |
{
"walletId": 1000232233,
"quoteId": 665131773713321985,
"settlementAccountUID": 48775048489845,
"purpose": "PMT001",
"extOrderNo": "1234567898"
}
{
"code": 1,
"message": "Success",
"data": {
"walletId": 429405186232384,
"quoteId": 665205920267108353,
"settlementAccountUID": 1236547995462114,
"purpose": "PMT001",
"orderNo": "431513431160832",
"fromCurrency": "USDT",
"fromAmount": "200.12",
"toCurrency": "USD",
"toAmount": "192.83",
"paymentWay": "CHATS",
"feeMode": 1,
"feeAmount": "7",
"feeCurrency": "USD",
"orderStatus": "SUBMITTED",
"createTime": 1736405450558,
"extOrderNo": "1234567898"
}
}
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 |
{
"walletId": 1000232233,
"quoteId": 665131773713321985
}
{
"code":1,
"message":"Success",
"data":{
"walletId":1000232233,
"quoteId":665131773713321985,
"orderNo":"442112731049984",
"fromCurrency":"USDT",
"fromAmount":"200.12",
"toCurrency":"USD",
"toAmount":"192.83",
"tradeFromAmount":"200.12",
"tradeToAmount":"192.83",
"price":"1.142",
"tradePrice":"1.142",
"orderStatus":"SUCCESSFUL",
"createTime":1741580889957,
"finishTime":1741580889957,
"settlementAccountUID":1236547995462114,
"purpose": "PMT001",
"paymentWay":"CHATS",
"feeMode":1,
"feeAmount":"7",
"feeCurrency":"USD",
"extOrderNo":"1234567898"
}
}
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 |
{
"walletId":1000232233,
"orderNo":"442112731049984",
"refundOrderNo":"232112731049984",
"settlementAccountUID":1236547995462114,
"purpose": "PMT001",
"remark":"remark",
"paymentWay":"CHATS",
"feeMode":1
}
{
"code":1,
"message":"Success",
"data":{
"walletId":1000232233,
"orderNo":"442112731049984",
"refundOrderNo":"232112731049984",
"settlementAccountUID":1236547995462114,
"purpose": "PMT001",
"remark":"remark",
"paymentWay":"CHATS",
"feeMode":1,
"amount":"183",
"currency":"USD",
"feeAmount":"7",
"feeCurrency":"USD"
}
}
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 | Alias 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 currency, 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 |
{
"walletId": 4298832316123456,
"alias": "name alias",
"accountOwnership": 2,
"currency": "USD",
"accountType": 2,
"accountName": "narti adiddf",
"accountNumber": "8888888",
"bankId":"003",
"beneficiaryAddress1": "payee address1",
"beneficiaryAddress2": "payee address2",
"beneficiaryAddress3": "HK",
"beneficiarySwiftCode": "DHBKHKHHXXX",
"intermediarySwiftCode": "DHBKHKHHXXX",
"companyCode": "HK1239876654",
"paymentFiles": [
{
"fileKey": "file_key_123",
"fileName": "xxxx.pdf"
}
],
"remark": "remark"
}
{
"code": 1,
"message": "success",
"data":{
"settlementAccountUID": 1236547995462114,
"walletId": 4298832316123456,
"alias": "name alias",
"accountOwnership": 2,
"currency": "USD",
"accountType": 2,
"companyName": "narti adiddf",
"accountNumber": "8888888",
"bankId":"003",
"beneficiaryAddress1": "payee address1",
"beneficiaryAddress2": "payee address2",
"beneficiaryAddress3": "HK",
"beneficiarySwiftCode": "DHBKHKHHXXX",
"intermediarySwiftCode": "DHBKHKHHXXX",
"companyCode": "HK1239876654",
"status": 0,
"paymentFiles": [
{
"fileKey": "file_key_123",
"fileName": "xxxx.pdf",
"fileUrl": "https://xxxxx"
}
],
"remark": "remark"
}
}
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 | Alias 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 currency, 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 |
{
"settlementAccountUID": 1236547995462114,
"walletId": 4298832316123456,
"alias": "name alias",
"accountNumber": "8888888",
"bankId":"003",
"beneficiaryAddress1": "payee address1",
"beneficiaryAddress2": "payee address2",
"beneficiaryAddress3": "HK",
"beneficiarySwiftCode": "DHBKHKHHXXX",
"intermediarySwiftCode": "DHBKHKHHXXX",
"paymentFiles": [
{
"fileKey": "file_key_123",
"fileName": "xxxx.pdf"
}
],
"remark": "remark"
}
{
"code": 1,
"message": "success",
"data": {
"settlementAccountUID": 1236547995462114,
"walletId": 4298832316123456,
"alias": "name alias",
"accountOwnership": 2,
"currency": "USD",
"accountType": 2,
"companyName": "narti adiddf",
"accountNumber": "8888888",
"bankId": "003",
"beneficiaryAddress1": "payee address1",
"beneficiaryAddress2": "payee address2",
"beneficiaryAddress3": "HK",
"beneficiarySwiftCode": "DHBKHKHHXXX",
"intermediarySwiftCode": "DHBKHKHHXXX",
"companyCode": "HK1239876654",
"status": 0,
"paymentFiles": [
{
"fileKey": "file_key_123",
"fileName": "xxxx.pdf",
"fileUrl": "https://xxxxx"
}
],
"remark": "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 |
{
"settlementAccountUID": 1236547995462114,
"walletId": 4298832316123456,
"reason": "del reason"
}
{
"code": 1,
"message": "success"
}
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 currency, 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 |
{
"settlementAccountUID": 1236547995462114,
"walletId": 4298832316123456,
"companyCode": "HK1239876654"
}
{
"code": 1,
"message": "success",
"data": [
{
"settlementAccountUID": 1236547995462114,
"walletId": 4298832316123456,
"alias": "name alias",
"accountOwnership": 2,
"currency": "USD",
"accountType": 2,
"companyName": "narti adiddf",
"accountNumber": "8888888",
"bankId": "003",
"beneficiaryAddress1": "payee address1",
"beneficiaryAddress2": "payee address2",
"beneficiaryAddress3": "HK",
"beneficiarySwiftCode": "DHBKHKHHXXX",
"intermediarySwiftCode": "DHBKHKHHXXX",
"companyCode": "HK1239876654",
"status": 0,
"paymentFiles": [
{
"fileKey": "file_key_123",
"fileName": "xxxx.pdf",
"fileUrl": "https://xxxxx"
}
],
"remark": "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 |
{
"bizType": "ORDER_RESULT_NOTIFICATION",
"data": "base64_encoded_data",
"clientFingerprint": "client_fingerprint_value",
"serverFingerprint": "server_fingerprint_value"
}
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 |
{
"orderNo": "ORDER123456789",
"currency": "USDT",
"network": "ETH",
"status": "SUCCESS",
"amount": "1.0",
"fromAddress": "0x123456789abcdef",
"toAddress": "0x987654321fedcba",
"fromWallet": "123456",
"toWallet": "1234567",
"txHash": "0x123456789abcdef123456789abcdef",
"orderType": "TRANSFER",
"extOrderNo": "EXT123456789"
}
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 |
{
"network":"ETH",
"address": "0x123456789abcdef",
"businessType":1,
"status": "true"
}
2.3 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 currency, 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 |
{
"settlementAccountUID":1236547995462114,
"walletId":4298832316123456,
"alias":"name alias",
"accountOwnership":2,
"currency":"USD",
"accountType":2,
"accountName":"narti adiddf",
"accountNumber":"8888888",
"bankId":"003",
"beneficiaryAddress1":"payee address1",
"beneficiaryAddress2":"payee address2",
"beneficiaryAddress3":"HK",
"beneficiarySwiftCode":"DHBKHKHHXXX",
"intermediarySwiftCode":"DHBKHKHHXXX",
"companyCode":"HK1239876654",
"status":0
}
2.4 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_FAILED with value, used to re-settlement |
| extOrderNo | string | Unique Order ID provided by Business Entities |
{
"walletId":1000232233,
"quoteId":665131773713321985,
"orderNo":"442112731049984",
"fromCurrency":"USDT",
"fromAmount":"200.12",
"toCurrency":"USD",
"toAmount":"192.83",
"tradeFromAmount":"200.12",
"tradeToAmount":"192.83",
"price":"1.142",
"tradePrice":"1.142",
"orderStatus":"SUCCESSFUL",
"createTime":1741580889957,
"finishTime":1741580889957,
"settlementAccountUID":1236547995462114,
"purpose": "PMT001",
"paymentWay":"CHATS",
"feeMode":1,
"feeAmount":"7",
"feeCurrency":"USD",
"extOrderNo":"1234567898"
}
2.5 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 |
{
"walletId":123456789,
"orderNo":"442112731049984",
"refundOrderNo":"442112731049984D1",
"refundAmount":"664.26",
"refundCurrency":"USD",
"refundReason":"refund",
"refundTime":1741580889957
}
2.6 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 |
{
"walletId":1000232233,
"orderNo":"442112731049984",
"refundOrderNo":"232112731049984",
"settlementAccountUID":1236547995462114,
"purpose": "PMT001",
"remark":"remark",
"paymentWay":"CHATS",
"feeMode":1,
"amount":"183",
"currency":"USD",
"feeAmount":"7",
"feeCurrency":"USD",
"createTime":1741580889957,
"finishTime":1741580889957,
"orderStatus":"SUCCESSFUL"
}
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) |
{
"applicationNo":"APP20250529001",
"extApplicationNo":"EXT12345678",
"applicationCreateTime":1685376000,
"applicationStatus":"SUCCESS",
"rejectReason":"",
"companyCode":"CMP123456",
"businessType":1,
"incorpPlace":"HKG",
"ciNumber":"autoHKL05290010",
"brNumber":"autoHKL05290010",
"incorpDate":"2025-05-29",
"nameEn":"RD Technology Limited",
"nameZh":"圆币科技有限公司"
}
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 | address already exists |
| 6406 | processing (the request is being processed) |
| 6801 | duplicate request |
| 6802 | profile error |
| 6803 | reach the max limit |
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, amount should be an integer and no decimal part is allowed .
Purpose
| Code | Description |
|---|---|
| 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 |