Skip to content
v1.0.0 (2026-09-03 16:35)

Exchange Currency ​

Interface Description ​

  • Path: /client/member/exchange-currency
  • Method: POST
  • Description: Allow members to manually exchange their balance from one currency to another. The exchange rate is based on the system's currency rates.

Request Parameters ​

ParameterTypeRequiredDescription
fromCurrencyStringYesOriginal currency code (e.g. USD)
toCurrencyStringYesTarget currency code (e.g. CNY)
amountNumberYesThe amount of the original currency to exchange

Request Example ​

POST /client/member/exchange-currency

json
{
  "fromCurrency": "USD",
  "toCurrency": "CNY",
  "amount": 100
}

Response Parameters ​

ParameterTypeDescription
codeNumberStatus code, 0 means success
msgStringMessage
dataObjectExchange result
data.exchangedAmountNumberThe final obtained amount of the target currency
data.rateNumberThe applied exchange rate

Response Example ​

json
{
  "code": 0,
  "msg": "兑换成功",
  "data": {
    "exchangedAmount": 720,
    "rate": 7.2
  }
}

Common Error Codes and Messages ​

When code != 0, it means the request has failed. Below are the common msg prompts and their causes:

Error msgCause Analysis
parameter_errorMissing required parameters, amount format is incorrect (must be a number), or the submitted data format is unsupported (JSON and Form-Data are supported).
Failed: FromCurrency or ToCurrency must be the base currencyThe exchange must involve the system's "Base Currency". Direct cross-exchange between two non-base currencies is not allowed.
Failed: The exchange amount exceeds the wallet balanceThe user's wallet balance for the original currency (fromCurrency) is insufficient to cover the exchange amount.
verify_failed: unauthorized
or verify_failed: invalid base token
No valid credentials provided. Please ensure that the Authorization: Bearer <Your_Member_Token> header is correctly included in the request.
Failed: cannot_convert_same_currencyfromCurrency and toCurrency are identical. Exchanging the same currency is not allowed.
Failed: amount_must_be_positiveThe submitted amount must be greater than 0.
Failed: rate_not_found_for_xxxThe system could not find the exchange rate configuration for the specified currency. An unsupported currency code may have been entered.