Skip to main content

2026/03/06

Release DateDescription of ProductVersion
2025/05/08First DraftV0.1.0
2025/06/11Adding companyCode and walletType as request parameters to the WalletList interfaceV0.1.1
2025/07/31Update PayoutModel parameters from symbol,aside to fromAmount,toAmount and merge AgentModel;Add BankId parameter to bank accountV0.1.2
2025/08/18The payee removes the paymentWayV0.1.3
2025/09/26The system now adds support for SOL and PLOY chainsV0.1.4
2025/10/21Added PayoutModel parameters extOrderNoV0.1.5
2026/03/06The payee supports third-party non identical namesV0.1.6

API Index

Category#APIREST Path
WalletManagementAPI1Fixed Receiving Address QueryPOST /api/v1/wallet/receive-address/query
WalletManagementAPI2Static Receiving Address QueryPOST /api/v1/wallet/static-address/query
WalletManagementAPI3Supported Currencies QueryPOST /api/v1/wallet/supported/currencies
WalletManagementAPI4Wallet AssetsPOST /api/v1/wallet/assets
WalletPaymentAPI1Wallet TransferPOST /api/v1/payment/transfer
WalletPaymentAPI2Get SignaturePOST /api/v1/payment/sign
WalletPaymentAPI3Add Address WhitelistPOST /api/v1/payment/address/whitelist/add
WalletPaymentAPI4Check Address WhitelistPOST /api/v1/payment/address/whitelist/check
WalletPaymentAPI5Delete Address WhitelistPOST /api/v1/payment/address/whitelist/delete
WalletPaymentAPI6Declare Receive OrderPOST /api/v1/payment/order/declare
WalletPaymentAPI7Internal TransferPOST /api/v1/payment/internal-transfer
WalletPaymentAPI8Wallet Order DetailPOST /api/v1/payment/order/detail
WalletPaymentAPI9Request Payment Order DeclarationPOST /api/v1/payment/order/declare
WalletPaymentAPI10Request Payment Material SupplementPOST /api/v1/payment/order/add/materials
WalletPaymentAPI11Fee QueryPOST /api/v1/payment/fee/query
WalletPaymentAPI12WithdrawPOST /api/v1/payment/withdraw
WalletPaymentAPI13Download StatementPOST /api/v1/payment/reconciliation
Off-ramp API1Payout QuotePOST /api/v1/payout/quote
Off-ramp API2Payout OrderPOST /api/v1/payout/book
Off-ramp API3Payout Order EnquiryPOST /api/v1/payout/enquiry
Off-ramp API4Payout Re-SettlePOST /api/v1/payout/reSettle
Off-ramp API5Add Beneficiary Bank AccountPOST /api/v1/wallet/bank_account/add
Off-ramp API6Update Beneficiary Bank AccountPOST /api/v1/wallet/bank_account/update
Off-ramp API7Delete Beneficiary Bank AccountPOST /api/v1/wallet/bank_account/del
Off-ramp API8Enquiry Beneficiary Bank AccountPOST /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 NameTypeM / O / CMDescription
walletIdint64MWallet ID
networkstringMBlockchain network: ETH/TRX/SOL/POLY
currencystringMCurrency: USDT/USDC
Response Parameters
Field NameTypeDescription
codeint64Response code, indicating the result of request processing, such as 1 for success, and other values ​​for different error conditions
messagestringResponse message, providing detailed processing information or error Description
dataReceiveAddressQueryDataPayment address query data
ReceiveAddressQueryData Field Description
Field NameTypeDescription
addressstringPayment address
Request Example
{
  "walletId": 123456789,
  "network": "ETH",
  "currency": "USDT"
}
Response Example
{
  "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 NameTypeM / O / CMDescription
walletIdint64MWallet ID
networkstringOBlockchain network: ETH / TRX / SOL / POLY
currencystringOCurrency: USDT / USDC
Response Parameters
Field NameTypeDescription
codeint32Business response code
messagestringBusiness response message
dataArray<StaticAddressData>Static receiving address list
StaticAddressData Field Description
Field NameTypeDescription
walletIdint64Wallet ID
networkstringBlockchain network, such as ETH / TRX
currencystringCurrency, such as USDT / USDC
addressstringStatic receiving address
qrCodeBase64stringQR code image of the address, Base64 encoded, including the data:image/png;base64, prefix. It can be directly used in <img src>
Request Example
{
  "walletId": 123456789,
  "network": "ETH",
  "currency": "USDT"
}
Response Example
{
  "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 by walletId + 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 NameTypeM / O / CMDescription
walletIdint64MWallet ID
typestringMBusiness type / limit type: 4 deposit, 3 withdraw
Response Parameters
Field NameTypeDescription
codeint32Business response code
messagestringBusiness response message
dataArray<SupportedCurrenciesQueryData>Supported currency list; returned when code = 1
SupportedCurrenciesQueryData Field Description
Field NameTypeDescription
typeint32Business type / limit type, corresponding to the request type
currencystringCurrency, such as USDT / USDC / USD
minAmountstringMinimum single-transaction amount, decimal number in string format
maxAmountstringMaximum single-transaction amount, decimal number in string format
networksArray<string>Supported blockchain network list for this currency, such as ETH / TRX / SOL
precisionint32Amount precision, number of decimal places
Request Example
{
  "walletId": 123456789,
  "type": 4
}
Response Example
{
  "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 NameTypeM / O / CMDescription
walletIdint64MWallet ID
Response Parameters
Field NameTypeDescription
codeint32Response code, indicating the result of request processing, such as 1 for success, and other values ​​for different error conditions
messagestringResponse message, providing detailed processing information or error Description
dataWalletDetailDtoWallet details data
WalletDetailDto Field Description
Field NameTypeDescription
walletIdint64Wallet ID
companyNamestringCompany Name
companyNameCnstringChinese company name
walletStatusint32Wallet Status:
1-Available 2-Freeze
createTimestringWallet creation time
walletTypeint32Wallet Type: 1- Main wallet 2-Sub-wallet
assetsAssetDtoCustodied Assets List
exchangeAssetsAssetDtoTrading Assets List
AssetDto Field Description
Field NameTypeDescription
networkstringBlockchain network, which represents the network to which the asset belongs Trading assets do not have this field; e.g.ETH/TRX/SOL/POLY
currencystringAsset currency: USDT/USDC
totalBalancestringTotal balance
availableBalancestringAvailable balance
lockBalancestringLocked balance
Request Example
{
  "walletId": 1001
}
Response Example
{
  "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 NameTypeM / O / CMDescription
walletIdint64MID of the wallet from which the transfer is made
targetWalletIdint64MID of the wallet to be transferred
currencystringMTransfer currency: USDT/USDC
networkstringMTransfer currency network: ETH/TRX/SOL/POLY
amountstringMTransfer Amount
extOrderNostringMExternal Order ID(Unique)
messagestringOTransfer Notes
Response Parameters
Field NameTypeDescription
codeint32Response code, indicating the result of request processing, such as 1 for success, and other values ​​for different error conditions
messagestringResponse message, indicating the Description or error information of the transfer operation
dataWalletTransferDataData of transfer operations
WalletTransferData Field Description
Field NameTypeDescription
orderNostringRD Order Number
Request Example
{
  "walletId": 1001,
  "targetWalletId": 1002,
  "currency": "USDT",
  "network": "ETH",
  "amount": "1.0",
  "extOrderNo": "EXT123456789",
  "message": "Transfer Notes"
}
Response Example
{
  "code": 1,
  "message": "success",
  "data": {
    "orderNo": "ORDER123456789"
  }
}

2. Get Signature (getSignData)

Interface Overview Get the signature. Request Parameters
Field NameTypeM / O / CMDescription
networkstringMBlockchain network: ETH/TRX/SOL/POLY
addressstringMAddress to be added to the Whitelist
Response Parameters
Field NameTypeDescription
codeint32Response code, indicating the result of request processing, such as 1 for success, and other values ​​for different error conditions
messagestringResponse message, indicating the result of the operation or error information
dataSignDataSignature response data
SignData Field Description
Field NameTypeDescription
datastringSignature Data
expireTimeint64Signature expiry time
Request Example
{
  "network": "ETH",
  "address": "0x123456789abcdef"
}
Response Example
{
  "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 NameTypeM / O / CMDescription
networkstringMBlockchain network: ETH/TRX/SOL/POLY
addressstringMAddress to add
checkTypeint32MCheck Type: 1-Signature check 2-Transaction check
signDatastringCMSignature information, required when the check type is signature
signaturestringCMSignature result, required when the check type is signature
currencystringCMCheck type is required for transactions. Receipt currency: USDT/USDC
walletIdint64MReceiving wallet ID
businessTypeint32MBusiness Type: 1-deposit 2-withdraw
addressSourceint32MAddress Source Type: 1-Personal wallet 2-Exchange/custodian platform
platformNamestringCMThe name of the exchange/custodian platform. Required when the address source type is 2
remarksstringORemark
Response Parameters
Field NameTypeDescription
codeint32Response code, indicating the result of request processing, such as 1 for success, and other values ​​for different error conditions
messagestringResponse message, indicating the result of the operation or error information
dataWhiteListApiDtoWhitelist Add Result
WhiteListApiDto Field Description
Field NameTypeDescription
idint64Request ID
networkstringBlockchain network: ETH/TRX/SOL/POLY
addressstringAddress to add
checkTypeint32Check Type: 1-Signature check 2-Small transfer check
signDatastringData to be signed
signaturestringsign
currencystringCurrency for small transfers: USDT/USDC
depositAddressstringSmall amount transfer payment address
amountstringAmount required for small transfers
statusstringstate: SUCCESS、FAIL、PENDING、PENDING_DEPOSIT
expireTimeint64Small amount transfer deadline
businessTypeint32Business Type: 1-deposit 2-withdraw
addressSourceint32Address Source Type: 1-Personal wallet 2-Exchange/custodian platform
platformNamestringName of the exchange/custodian platform
remarksstringRemark
Request Example
[
{
  "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
}
]
Response Example
{
    "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 NameTypeM / O / CMDescription
addressstringMCheck if the address is in the whitelist.
networkstringMBlockchain network: ETH/TRX/SOL/POLY
businessTypeint32MBusiness Type: 1-deposit 2-withdraw
Response Parameters
Field NameTypeDescription
codeint32Response code, indicating the result of request processing, such as 1 for success, and other values ​​for different error conditions
messagestringResponse message, providing detailed error information or status Description
dataCheckWhiteListDtoWhitelist check results
CheckWhiteListDto Field Description
Field NameTypeDescription
statusstringStatus:
SUCCESS, FAIL, PENDING, PENDING_DEPOSIT,NOT_EXIST
businessTypeint32Business Type: 1-deposit 2-withdraw
remarksstringRemark
Request Example
{
  "network": "ETH",
  "address": "0x123456789abcdef",
  "businessType": 1
}
Response Example
{
  "code": 1,
  "message": "success",
  "data":
  {
    "businessType": 1,
    "status ": "SUCCESS",
    "remarks": "deposit whitelist"
  }
}

5. DeleteAddressWhitelist(deleteAddressWhitelist)

Interface Overview Delete the address whitelist. Request Parameters
Field NameTypeM / O / CMDescription
networkstringMBlockchain network: ETH/TRX/SOL/POLY
addressstringMWhitelist of addresses to be deleted
businessTypeint32MBusiness Type: 1-deposit 2-withdraw
Response Parameters
Field NameTypeDescription
codeint32Response code, indicating the result of request processing, such as 1 for success, and other values ​​for different error conditions
messagestringResponse message, indicating the result of the operation or error information
Request Example
{
  "network": "ETH",
  "address": "0x123456789abcdef",
  "businessType": 1
}
Response Example
{
  "code": 1,
  "message": "success"
}

6. Declare Receive Order(declareReceiveOrder)

Interface Overview Declare a payment order. Request Parameters
Field NameTypeM / O / CMDescription
senderAddressstringMPayer Address
recipientAddressstringMRecipient Address
amountstringMAmount, indicating the deposit amount
networkstringMBlockchain network: ETH/TRX/SOL/POLY
currencystringMCurrency: USDT/USDC
extOrderNostringMExternal Order ID (Globally Unique)
Response Parameters
Field NameTypeDescription
codeint32Response code, indicating the result of request processing, such as 1 for success, and other values ​​for different error conditions
messagestringResponse message, indicating the result of the operation or error information
Request Example
{
  "senderAddress": "0x123456789abcdef",
  "recipientAddress": "0x987654321fedcba",
  "amount": "1000.0",
  "network": "ETH",
  "currency": "USDT",
  "extOrderNo": "EXT123456789"
}
Response Example
{
  "code": 1,
  "message": "success"
}

7. Internal Transfer(internalTransfer)

Interface Overview Execute internal transfer operation. Request Parameters
Field NameTypeM / O / CMDescription
walletIdint64MWallet ID
internalTransferTypeint32MInternal transfer type: 1-Transfer Custodied Assets to Trading Assets
networkstringCMSource Asset’s Network: ETH/TRX/SOL/POLY, required when transfer type is 1
currencystringMCurrency: USDT/USDC
amountstringMAmount
extOrderNostringMExternal order ID(Globally Unique)
Response Parameters
Field NameTypeDescription
codeint32Response code, indicating the result of request processing, such as 1 for success, and other values ​​for different error conditions
messagestringResponse message, providing detailed processing information or error Description
dataInternalTransferDataData of internal transfer operations
InternalTransferData Field Description
Field NameTypeDescription
orderNostringTransfer order number
Request Example
{
  "walletId": 1001,
  "internalTransferType": 1,
  "network": "ETH",
  "currency": "USDT",
  "amount": "1.0",
  "extOrderNo": "EXT123456789"
}
Response Example
{
  "code": 1,
  "message": "success",
  "data": {
    "orderNo": "ORDER123456789"
  }
}

8. Order details (walletOrderDetail)

Interface Overview Query wallet order details. Request Parameters
Field NameTypeM / O / CMDescription
walletIdint64MWallet ID
orderNostringCMOrder number Either “orderNo” or “extOrderNo” must be provided
extOrderNostringCMExternal order number, Either “orderNo” or “extOrderNo” must be provided
Response Parameters
Field NameTypeDescription
codeint32Response code, indicating the result of request processing, such as 1 for success, and other values ​​for different error conditions
messagestringResponse message, providing detailed error information or processing result Description
dataWalletOrderDetailDataOrder details data
WalletOrderDetailData Field Description
Field NameTypeDescription
orderNostringOrder Number
extOrderNostringExternal order number
orderTypestringOrder Type
orderStatusstringSee Appendix: Deposit Order Status
fromAddressstringInitiator address
fromWalletstringSource wallet
toAddressstringRecipient Address
toWalletstringTarget wallet
amountstringAmount
networkstringBlockchain network: ETH/TRX/SOL/POLY
currencystringCurrency: USDT/USDC
expireTimeint64Order expiration time
createTimeint64Order creation time
Request Example
{
  "orderNo": "ORDER123456789"
}
Response Example
{
    "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
    }
}

9. Request Payment Order Declaration (payinOrderDeclare)

Interface Overview Submit a Request Payment deposit order Request Parameters
Field NameTypeM / O / CMDescription
walletIdint64MDeposit wallet ID
extOrderNostringMExternal order ID(Unique)
senderAddressstringMPayer wallet address
networkstringMBlockchain network: ETH/TRX/SOL/POLY
currencystringMCurrency: USDT/USDC
amountstringMDeclared amount
Note: The declared amount must exactly match the final deposit amount
senderNamestringMPayer Name
countryRegionstringMPlease refer to the Country/Region ISO 3166 Code. e.g.HKG
contactAddressstringMPayer contact address
receiverNamestringMRecipient Merchant Name
messagestringORemark
orderMaterialsObjectOCollection of Material Declaration Objects for Order Return
productTypestringMProduct Type
productNamestringMProduct Name
productPricestringMProduct Price
productCountstringMProduct Quantity
productUnitstringMProduct Unit
logisticsTrackingNamestringOLogistics Company Name
logisticsTrackingNostringOTracking number
Response Parameters
Field NameTypeDescription
codeint32Response code, indicating the result of request processing
messagestringResponse message, indicating the result of the operation or error information
Request Example
{
	"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"
}
Response Example
{
  "code": 1,
  "message": "success"
}

10. Request Payment order material supplement (addRequestPaymentMaterials)

Interface Overview Submit order and add product information and other materials Request Parameters
Field NameTypeM / O / CMDescription
walletIdint64MDeposit wallet ID
orderNostringMOrder ID
productTypestringMProduct Type
productNamestringMProduct Name
productPricestringMProduct Prices
productCountstringMQuantity of products
productUnitstringMCommodity Unit
logisticsTrackingNamestringOLogistics Company Name
logisticsTrackingNostringOLogistics tracking number
Response Parameters
Field NameTypeDescription
codeint32Response code, indicating the result of request processing
messagestringResponse message, indicating the result of the operation or error information
Request Example
{
	"walletId": "429883231600640",
	"orderNo": "447767487604736",
	"materials": [{
		"productType": "Electronics",
		"productName": "Wireless Bluetooth Headphones",
		"productPrice": "89.99",
		"productCount": "150",
		"productUnit": "pcs",
		"logisticsTrackingName": "FedEx International Priority",
		"logisticsTrackingNo": "FX123456789US"
	}]
}
Response Example
{
  "code": 1,
  "message": "success"
}
 

11. Fee Query (feeQuery)

Interface Overview Fee Inquiry Interface for querying Transaction Fees. Request Parameters
Field NameTypeM / O / CMDescription
orderTypeint32MSee Appendix: Order Type
walletIdint64MWallet ID
networkstringMBlockchain network: ETH/TRX/SOL/POLY
currencystringMCurrency: USDT/USDC
payAmountstringMOrder amount
Response Parameters
Field NameTypeDescription
codeint32Response code, indicating the result of request processing, such as 1 for success, and other values ​​for different error conditions
messagestringResponse message, indicating the result of the operation or error information
dataFee Details
Fee details field Description
Field NameTypeDescription
walletIdint64Wallet ID
networkstringBlockchain network: ETH/TRX/SOL/POLY
currencystringCurrency: USDT/USDC
payAmountstringOrder amount
feeAmountstringService Fee
receiveAmountstringAmount Received
Request Example
{
  "walletId": "429883231600640",
  "network": "ETH",
  "currency": "USDC",
  "payAmount": "666.66"
}
Response Example
{
  "code": 1,
  "message": "success",
  "data": {
    "walletId": "429883231600640",
    "network": "ETH",
    "currency": "USDC",
    "payAmount": "666.66",
    "feeAmount": "19.9998",
    "receiveAmount": "646.6602"
  }
}

12. Withdraw order(withdraw)

Interface Overview Create a withdrawal order Request Parameters
Field NameTypeM / O / CMDescription
walletIdint64MWallet ID
extOrderNostringMExternal order ID(Unique)
networkstringMBlockchain network: ETH/TRX/SOL/POLY
currencystringMCurrency: USDT/USDC
payAmountstringMThe order amount supports up to 6 decimal places
recipientAddressstringMRecipient Blockchain Address
recipientNamestringMRecipient Name
messagestringORemark
Response Parameters
Field NameTypeDescription
codeint32Response code, indicating the result of request processing, such as 1 for success, and other values ​​for different error conditions
messagestringResponse message, indicating the result of the operation or error information
Request Example
{
  "walletId": "429883231600640",
  "extOrderNo": "ext-1745477734002",
  "network": "ETH",
  "currency": "USDC",
  "recipientAddress": "0x213F2B229BE4f3FFF88fc874a111b19D79623339",
  "message": "Message ttt",
  "payAmount": "666.66"
}
Response Example
{
    "code": 1,
    "message": "success"
}

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 NameTypeM / O / CMDescription
walletIdint64MWallet ID
billDatestringMBilling Date (YYYYMMDD)
modeTypeint32MAuthorization mode: 1- Direct connection mode (download the current wallet statement) 2-Authorization mode (download current wallet and sub-wallet statements)
accountTypeint32MAccount Type: 1-Custody Account 2-Trading Account
currencyTypeint32MCurrency 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)
Response Parameters
Field NameTypeDescription
codeint32Response code, indicating the result of request processing
messagestringResponse message, indicating the result of the operation or error information
dataWalletBillDataStatement Information
WalletBillData Field Description
Field NameTypeDescription
fileNamestringFile name
fileUrlstringDownload address of the zip package of the statement
Request Example
{
    "walletId ": 123456789,
    "billDate": "20250330",
    "modeType": 1,
    "accountType": 1,
    "currencyType": 1
}
Response Example
{
  "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"
  }
}

ConvertAPI

PayoutModel

1. Quote(payoutQuote)

Interface Overview Used to obtain the price of a specified currency pair Request Parameters
Field NameTypeM / O / CMDescription
walletIdint64MWallet ID
fromCurrencystringMFrom Currency: USDT,USDC
fromAmountstringCMFrom Amount, supports 2 decimal places At least one of fromAmount or toAmount must be provided
toCurrencystringMTo Currency: USD
toAmountstringCMTo Amount, supports 2 decimal places At least one of fromAmount or toAmount must be provided
paymentWaystringMPayment Method:RDT/CHATS
feeModeint32CMThis 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)
Response Parameters
Field NameTypeDescription
codeint32Response code, indicating the result of request processing, such as 1 for success, and other values ​​for different error conditions
messagestringResponse message, providing detailed processing information or error Description
dataPayoutQuoteDataPrice and Transfer-Related Data
PayoutQuoteData Field Description
Field NameTypeDescription
walletIdint64Wallet ID
fromCurrencystringFrom Currency: USDT,USDC
fromAmountstringFrom Amount
toCurrencystringTo Currency: USD
toAmountstringTo Amount(Subtract Service fee )
paymentWaystringPayment Method:RDT/CHATS
feeModeint32Fee Deduction Mode:
1 - Shared by both sender and receiver (SHAR)
2 - Borne entirely by the payer (OUR)
quoteIdint64Inquiry ID
pricestringprice
priceExpireTimestringPrice Expiration Time
feeAmountstringService fee
feeCurrencystringFee Currency
Request Example
{
	"walletId":1000232233,
	"fromCurrency":"USDT",
	"fromAmount":"200.12",
	"toCurrency":"USD",
	"paymentWay":"CHATS",
	"feeMode":1
}
Response Example
{
  "code":1,
  "message":"Success",
  "data":{
    "walletId":"429405186232384",
    "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 the quoteId returned by the quote API. Request Parameters
Field NameTypeM / O / CMDescription
walletIdint64MWallet ID
quoteIdint64MQuote ID
settlementAccountUIDint64MSettlement account ID, obtained through the bank account enquiry API
purposestringMPayment purpose. See Appendix: Purpose
extOrderNostringMUnique order ID provided by the business entity. Only numbers, letters, _, -, and * are allowed. Must be unique under the same merchant account
Response Parameters
Field NameTypeDescription
codeint32Response code
messagestringResponse message
dataPayoutBookDataPayout order result
PayoutBookData Field Description
Field NameTypeDescription
walletIdint64Wallet ID
quoteIdint64Quote ID
settlementAccountUIDint64Settlement account ID
purposestringPayment purpose. See Appendix: Purpose
orderNostringOrder number
fromCurrencystringFrom currency: USDT / USDC
fromAmountstringFrom amount
toCurrencystringTo currency: USD
toAmountstringTo amount after deducting service fee
paymentWaystringPayment method: RDT / CHATS
feeModeint32Fee deduction mode: 1 - shared by both sender and receiver (SHAR); 2 - borne entirely by the payer (OUR)
feeAmountstringService fee
feeCurrencystringFee currency
orderStatusstringSee Appendix: Payout Order Status
createTimeint64Order creation time
extOrderNostringUnique order ID provided by the business entity
Request Example
{
  "walletId": 1000232233,
  "quoteId": 665131773713321985,
  "settlementAccountUID": 48775048489845,
  "purpose": "PMT001",
  "extOrderNo": "1234567898"
}
Response Example
{
  "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 NameTypeM / O / CMDescription
walletIdint64MWallet ID
orderNostringCMAt least one of orderNo or quoteId must be provided
quoteIdint64CMAt least one of orderNo or quoteId must be provided
Response Parameters
Field NameTypeDescription
codeint32Response code, indicating the result of request processing, such as 1 for success, and other values ​​for different error conditions
messagestringResponse message, providing detailed processing information or error Description
dataPayoutDataOrder query data
PayoutData Field Description
Field NameTypeDescription
walletIdint64Wallet ID
quoteIdint64Inquiry ID
orderNostringOrder Number
fromCurrencystringFrom Currency: USDT,USDC
fromAmountstringFrom Amount
toCurrencystringTo Currency: USD
toAmountstringTo Amount(Subtract Service fee )
tradeFromAmountstringTransaction amount
tradeToAmountstringTransaction amount
pricestringOrder price
tradePricestringTransaction price
orderStatusstringSee Appendix:Payout order status
createTimeint64Order creation time
finishTimeint64Order completion time
errorMsgstringOrder failure reason
settlementAccountUIDint64Settlement Account ID(Unique)
purposestringSee Appendix: Purpose
paymentWaystringPayment Method:RDT/CHATS
feeModeint32Fee 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.
feeAmountstringService fee
feeCurrencystringFee Currency
refundOrderNostringRefund order no when the order fail
refundAmountstringRefund amount when the order fail
refundCurrencystringRefund currency when the order fail
extOrderNostringUnique Order ID provided by Business Entities
Request Example
{
	"walletId": 1000232233,
	"quoteId": 665131773713321985
}
Response Example
{
  "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 NameTypeM / O / CMDescription
walletIdint64MWallet ID
orderNostringMPayout Order no
refundOrderNostringMReturn Order no
settlementAccountUIDint64MSettlement Account ID(Unique)
purposestringMSee Appendix: Purpose
remarkstringMRemark
paymentWaystringMPayment Method:RDT/CHATS
feeModeint32OFee 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.
Response Parameters
Field NameTypeDescription
codeint32Response code, indicating the result of request processing, such as 1 for success, and other values ​​for different error conditions
messagestringResponse message, providing detailed processing information or error Description
dataPayoutReSettleDataRe-settle order data
PayoutReSettleData Field Description
Field NameTypeDescription
walletIdint64Wallet ID
orderNostringPayout Order no
refundOrderNostringReturn Order no
settlementAccountUIDint64Settlement Account ID(Unique)
purposestringSee Appendix: Purpose
remarkstringRemark
paymentWaystringPayment Method:RDT/CHATS
feeModeint32Fee Deduction Mode:
1-Shared by both sender and receiver (SHAR)
2-Borne entirely by the payer (OUR)
amountstringRe-settlement Amount
currencyint64Re-settlemen currency
feeAmountstringService fee
feeCurrencystringFee Currency
Request Example
{
	"walletId":1000232233,
	"orderNo":"442112731049984",
	"refundOrderNo":"232112731049984",
	"settlementAccountUID":1236547995462114,
	"purpose": "PMT001",
	"remark":"remark",
    "paymentWay":"CHATS",
	"feeMode":1
}
Example Response
{
  "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 NameTypeM / O / CMDescription
walletIdint64MWallet ID
aliasstringMAlias of this bank account
accountOwnershipint32MOwnership 1-own account 2-other account 3=Third party
currencystringMFiat currency, eg: USD
accountTypeint32MBank Account Type 1-RD Wallet 2-Bank Account
companyNamestringMCompany name accountOwnership=2,this name must be same with the name in the company profile
accountNumberstringMRD Wallet Id or Bank account number
bankIdstringMHK Bank Id,example:003
beneficiaryAddress1stringCMAddress (Line 1) of the receiving party(Chinese characters are not allowed) *Mandatory when accountType=2
beneficiaryAddress2stringCMAddress (Line 2) of the receiving party(Chinese characters are not allowed) *Mandatory when accountType=2
beneficiaryAddress3stringCMAddress (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
beneficiarySwiftCodestringCMUnique 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
intermediarySwiftCodestringOIntermediate 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.)
companyCodestringCMCompany profile code *Mandatory when accountOwnership=2
paymentFilesArray<FileInfo>CMProof of payment *Mandatory when accountOwnership=3
remarkstringOremark Optional when accountOwnership=3
Response Parameters
Field NameTypeDescription
codeint32Response code, indicating the result of request processing, such as 1 for success, and other values ​​for different error conditions
messagestringResponse message, indicating the result of the operation or error information
dataBankAccountDataBank account information
BankAccountData Field Description
Field NameTypeDescription
settlementAccountUIDint64Bank account unique id
walletIdint64Wallet ID
aliasstringAlias of bank account
accountOwnershipint32Ownership 1-own account 2-other account
currencystringFiat currency, eg: USD
accountTypeint32Bank Account type 1-RD Wallet 2-Bank Account
companyNamestringCompany name
accountNumberstringRD Wallet Id or Bank account number
bankIdstringHK Bank Id,example:003
beneficiaryAddress1stringAddress (Line 1) of the receiving party(Chinese characters are not allowed)
beneficiaryAddress2stringAddress (Line 2) of the receiving party(Chinese characters are not allowed)
beneficiaryAddress3stringAddress (Line 3) of the receiving party Country / Region of address must be specified. Please refer to the Country/Region ISO 3166 Code
beneficiarySwiftCodestringUnique 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.)
intermediarySwiftCodestringIntermediate 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.)
companyCodestringCompany profile code
statusint32Status 0-Processing 1-Success 2-Fail
paymentFilesArray<FileInfo>Proof of payment
remarkstringremark
FileInfo Field Description
Field NameTypeDescription
fileKeystringAfter calling the upload interface, it will return
fileNamestring
fileUrlstringAfter calling the upload interface, it will return and the URL will be updated regularly
Request Example
{
    "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"
}
Response Example
{
    "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 NameTypeM / O / CMDescription
walletIdint64MWallet ID
settlementAccountUIDint64MBank account unique id
aliasstringOAlias of this bank account
accountNumberstringORD Wallet Id or Bank account number
bankIdstringOHK Bank Id,example:003
beneficiaryAddress1stringOAddress (Line 1) of the receiving party(Chinese characters are not allowed)
beneficiaryAddress2stringOAddress (Line 2) of the receiving party(Chinese characters are not allowed)
beneficiaryAddress3stringOAddress (Line 3) of the receiving party Country / Region of address must be specified. Please refer to the Country/Region ISO 3166 Code
beneficiarySwiftCodestringOUnique 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.)
intermediarySwiftCodestringOIntermediate 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.)
paymentFilesArray<FileInfo>CMProof of payment *Mandatory when accountOwnership=3
remarkstringOremark Optional when accountOwnership=3
Response Parameters
Field NameTypeDescription
codeint32Response code, indicating the result of request processing, such as 1 for success, and other values ​​for different error conditions
messagestringResponse message, indicating the result of the operation or error information
dataBankAccountDataBank account information
BankAccountData Field Description
Field NameTypeDescription
settlementAccountUIDint64Bank account unique id
walletIdint64Wallet ID
aliasstringAlias of bank account
accountOwnershipint32Ownership 1-own account 2-other account
currencystringFiat currency, eg: USD
accountTypeint32Bank Account type 1-RD Wallet 2-Bank Account
companyNamestringCompany name
accountNumberstringRD Wallet Id or Bank account number
bankIdstringHK Bank Id,example:003
beneficiaryAddress1stringAddress (Line 1) of the receiving party(Chinese characters are not allowed)
beneficiaryAddress2stringAddress (Line 2) of the receiving party(Chinese characters are not allowed)
beneficiaryAddress3stringAddress (Line 3) of the receiving party Country / Region of address must be specified .Please refer to the Country/Region ISO 3166 Code
beneficiarySwiftCodestringUnique 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.)
intermediarySwiftCodestringIntermediate 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.)
companyCodestringCompany profile code
statusint32Status 0-Processing 1-Success 2-Fail
paymentFilesArray<FileInfo>Proof of payment
remarkstringremark
Request Example
{
    "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"
}
Response Example
{
  "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 NameTypeM / O / CMDescription
walletIdint64MWallet ID
settlementAccountUIDint64MBank account unique id
reasonstringMThe reason of deletion
Response Parameters
Field NameTypeDescription
codeint32Response code, indicating the result of request processing, such as 1 for success, and other values ​​for different error conditions
messagestringResponse message, indicating the result of the operation or error information
Request Example
{
    "settlementAccountUID": 1236547995462114,
    "walletId": 4298832316123456,
    "reason": "del reason"
}
Response Example
{
    "code": 1,
    "message": "success"
}

8. Enquiry Beneficiary Bank Account(getBankAccount)

Interface Overview Enquiry the bank account of beneficiary Request Parameters
Field NameTypeM / O / CMDescription
walletIdint64MWallet ID
settlementAccountUIDint64OBank account unique id
companyCodestringOCompany profile code
Response Parameters
Field NameTypeDescription
codeint32Response code, indicating the result of request processing, such as 1 for success, and other values ​​for different error conditions
messagestringResponse message, indicating the result of the operation or error information
dataBankAccountData listBank account information
BankAccountData Field Description
Field NameTypeDescription
settlementAccountUIDint64Bank account unique id
walletIdint64Wallet ID
aliasstringAlias of bank account
accountOwnershipint32Ownership 1-own account 2-other account 3=Third party
currencystringFiat currency, eg: USD
accountTypeint32Bank Account type 1-RD Wallet 2-Bank Account
companyNamestringCompany name
accountNumberstringRD Wallet Id or Bank account number
bankIdstringHK Bank Id,example:003
beneficiaryAddress1stringAddress (Line 1) of the receiving party(Chinese characters are not allowed)
beneficiaryAddress2stringAddress (Line 2) of the receiving party(Chinese characters are not allowed)
beneficiaryAddress3stringAddress (Line 3) of the receiving party Country / Region of address must be specified Please refer to the Country/Region ISO 3166 Code
beneficiarySwiftCodestringUnique 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.)
intermediarySwiftCodestringIntermediate 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.)
companyCodestringCompany profile code
statusint32Status 0-Processing 1-Success 2-Fail
paymentFilesArray<FileInfo>Proof of payment
remarkstringremark
Request Example
{
    "settlementAccountUID": 1236547995462114,
    "walletId": 4298832316123456,
    "companyCode": "HK1239876654"
}
Response Example
{
  "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 NameTypeM / O / CMDescription
bizTypeOpenBizTypeMBusiness type, specify the callback business type
databytesMBusiness binary data, the actual business content in the callback
clientFingerprintstringMClient certificate fingerprint, used to verify the client identity of the callback request
serverFingerprintstringMServer certificate fingerprint, used to verify the server identity of the callback request
OpenBizType Enumeration Description
Enumeration ValuesDescription
_BIZ_TYPE_UNKNOWNUnknown business type
ORDER_RESULT_NOTIFICATIONOrder result notification
WHITELIST_RESULT_NOTIFICATIONWhitelist result notification
EXCHANGE_BIZ_TYPE_NOTIFICATIONTransaction business type notification
WALLET_OPEN_NOTIFICATIONWallet account opening result notification
Request Example
{
  "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 NameTypeDescription
orderNostringOrder Number
currencystringCurrency: USDT/USDC
networkstringBlockchain network: ETH/TRX/SOL/POLY
statusstringOrder Status
amountstringAmount
fromAddressstringInitiator address
fromWalletstringSource wallet
toAddressstringRecipient Address
toWalletstringTarget wallet
txHashstringTransaction Hash
orderTypestringOrder Type
extOrderNostringExternal order number
Sample Data
{
  "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 NameTypeDescription
networkstringBlockchain network: ETH/TRX/SOL/POLY
addressstringaddress
businessTypeint32Business Type: 1-deposit 2-withdraw
statusstringStatus: true,false
Sample Data
{
  "network":"ETH",
  "address": "0x123456789abcdef",
  "businessType":1,
  "status": "true"
}

2.3 Add Bank Account Result Notification

Field Description
Field NameTypeDescription
settlementAccountUIDint64Bank account unique id
walletIdint64Wallet ID
aliasstringAlias of bank account
accountOwnershipint32Ownership 1-own account 2-other account
currencystringFiat currency, eg: USD
accountTypeint32Bank Account type 1-RD Wallet 2-Bank Account
accountNamestringCompany name
accountNumberstringRD Wallet Id or Bank account number
bankIdstringHK Bank Id,example:003
beneficiaryAddress1stringAddress (Line 1) of the receiving party(Chinese characters are not allowed)
beneficiaryAddress2stringAddress (Line 2) of the receiving party(Chinese characters are not allowed)
beneficiaryAddress3stringAddress (Line 3) of the receiving party Country / Region of address must be specified Please refer to the Country/Region ISO 3166 Code
beneficiarySwiftCodestringUnique 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.)
intermediarySwiftCodestringIntermediate 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.)
companyCodestringCompany profile code
statusint32Status 0-Processing 1-Success 2-Fail
Sample Data
{
  "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 NameTypeDescription
walletIdint64Wallet ID
quoteIdint64Inquiry ID
orderNostringOrder Number
fromCurrencystringFrom Currency: USDT,USDC
fromAmountstringFrom Amount
toCurrencystringTo Currency: USD
toAmountstringTo Amount(Subtract Service fee )
tradeFromAmountstringTransaction amount
tradeToAmountstringTransaction amount
pricestringOrder price
tradePricestringTransaction price
orderStatusstringSee Appendix:Payout order status
createTimeint64Order creation time
finishTimeint64Order completion time
errorMsgstringOrder failure reason
settlementAccountUIDint64Settlement Account ID(Unique)
purposestringSee Appendix: Purpose
paymentWaystringPayment Method:RDT/CHATS
feeModeint32Fee 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.
feeAmountstringService fee
feeCurrencystringFee Currency
refundOrderNostringPayout order status is SETTLING_FAILED with value, used to re-settlement
extOrderNostringUnique Order ID provided by Business Entities
Sample 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"
}

2.5 Payout Refund Result Notification

Field Description
Field NameTypeDescription
walletIdint64Wallet ID
orderNostringOrder Number
refundOrderNostringRefund Order Number
refundAmountstringRefund Amount
refundCurrencystringRefund Currency
refundReasonstringRefund Reason
Sample Data
{
      "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 NameTypeDescription
walletIdint64Wallet ID
orderNostringOrder Number
refundOrderNostringRefund Order Number
settlementAccountUIDint64Settlement Account ID(Unique)
purposestringSee Appendix: Purpose
remarkstringremark
paymentWaystringPayment Method:RDT/CHATS
feeModeint32Fee 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.
amountstringamount
currencyint64currency
feeAmountstringService fee
feeCurrencystringFee Currency
Sample 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",
    "createTime":1741580889957,
    "finishTime":1741580889957,
    "orderStatus":"SUCCESSFUL"
}

2.8 Enterprise Application Result Notification

Field Description
Field NameTypeDescription
applicationNostringRD application number
extApplicationNostringExternal application number
applicationCreateTimeint64Application creation time (milliseconds timestamp)
applicationStatusstringApplication status: IN_PROGRESS, SUCCESS, FAIL
rejectReasonstringRejection reason (if the application is rejected)
companyCodestringCompany code
businessTypeint32Business type: 1 - Limited Company 2 - Partnership 3 - Sole Proprietorship
incorpPlacestringCompany registration place, e.g.: HKG
ciNumberstringCompany registration certificate number
brNumberstringBusiness Registration Certificate number
incorpDatestringCompany registration date, format: yyyy-MM-dd
nameEnstringCompany English name
nameZhstringCompany local name (Chinese name)
Sample Data
{
  "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

CodeDescription
1success
6001failed General service failure
6002parameter error
6003order not exist (order does not exist)
6004order duplicate (Duplicate order)
6005no permissions
6006assets not exists
6101wallet account not exists
6102wallet insufficient fund
6103wallet status invalid (wallet account invalid)
6104recipient wallet unavailable(Receiving wallet is not available)
6105recipient wallet not exists(The receiving wallet does not exist)
6109Daily payment limit exceeded
6110Monthly collection limit exceeded
6301provider unavailable (channel unavailable)
6302symbol unavailable
6303provider reject
6304price expire time
6305amount lt min amount (amount is less than the minimum limit)
6306amount gt max amount (amount is greater than the maximum limit)
6307outside of hours
6401address already exists
6406processing (the request is being processed)
6801duplicate request
6802profile error
6803reach the max limit

Exchange order status

CodeDescriptionRemark
SUBMITTEDSubmittedOrder Submitted
CONVERTINGRedemptionOrder redemption
SETTLINGSettlementThe exchange is successful and the settlement is carried out
SUCCESSFULSuccessful transactionOrder processed successfully
FAILEDTransaction FailureOrder processing failed

Payout order status

CodeDescriptionRemark
SUBMITTEDSubmittedOrder Submitted
CONVERTINGExchangingOrder exchanging
SETTLINGSettlingExchange Successful, Proceeding with Settlement
SETTLING_FAILEDSettlement FailedExchange Successful, Settlement Failed
SETTLING_REFUNDRefund ProcessingRefunded After Successful Settlement
SUCCESSFULSuccessful transactionOrder Processed Successfully
FAILEDTransaction FailureOrder Processed Failed

Deposit order status

CodeDescriptionRemark
SUBMITTEDSubmittedOrder Submitted
VERIFYINGOrder VerificationUpon order submission, a security verification is performed. Applies only to Request Payment.
AWAIT_FOR_RECEIVEAwaiting PaymentThe order was created successfully and is currently awaiting payment. This status applies specifically to the Request Payment flow.
PAYMENT_VERIFYINGPayment Verification in ProgressPayment has been received by the platform. Initiating security verification. This step applies only to the Request Payment flow.
AWAIT_FOR_DECLARATIONAdditional Documents RequiredTrade documents pending submission. Applicable only to Request Payment transactions.
DECLARATION_REVIEWDocument Review in ProgressDocument Review in Progress
SUCCESSTransaction SuccessfulOrder Successful
FAILEDTransaction FailedOrder Failed
CLOSEDTransaction ClosedOrder Closed Due to Expiration
RETURNINGProcessing RefundProcessing Refund
RETURNEDRefundedRefund Processed Successfully
IN_PROGRESSPayment Verification in ProgressPayment has been received by the platform. Initiating security verification. This step applies only to Deposit transactions.

Order Type

CodeDescription
1Deposit
2Wallet Transfer
3Internal Transfer
4Request Payment
5Withdraw

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 .
Please strictly control the amount format according to the currency type to avoid precision errors or interface processing exceptions.

Purpose

CodeDescription
PMT001Invoice payments
PMT002Payment for services
PMT003Payment for software
PMT004Payment for imported goods
PMT005Travel services
PMT006Transfer to own account
PMT007Repayment of loans
PMT009Payment of property rental
PMT010Information Service Charges
PMT011Advertising & Public relations-related expenses
PMT012Royalty fees, trademark fees, patent fees, and copyright fees
PMT013Fees for brokers, front end fee, commitment fee, guarantee fee and custodian fee
PMT014Fees for advisors, technical assistance, and academic knowledge, including remuneration for specialists
PMT015Representative office expenses
PMT016Tax Payment
PMT017Transportation fees for goods
PMT018Construction costs/expenses
PMT019Insurance Premium
PMT020General Goods Trades - Offline trade
PMT021Insurance Claims Payment
PMT024Medical Treatment
PMT025Donations
PMT026Mutual Fund Investment
PMT027Currency Exchange
PMT028Advance Payments for Goods
PMT029Merchant Settlement
PMT030Repatriation Fund Settlement

Country/Region Code

Country/Region Code