Skip to content
Currency Setup

Add Currency Config

Add Currency Config.

Request parameters

  • Required: currency_iso (Currency ISO), currency (Currency), icon (Icon), logo (Logo), support_withdraw (Support Withdraw), support_exchange (Support Exchange), min_withdrawal_amount (Min Withdrawal Amount), min_exchange_amount (Min Exchange Amount), exchange_rate_precision (Exchange Rate Precision), amount_precision (Amount Precision), amount_round_mode (Amount Round Mode), standard_money (Standard Money), abbreviation_multi_name (Abbreviation Multi Name), multi_name (Multi Name), json_config (JSON Config)
  • Optional: cash_amount (Min Cash Amount), remarks (Remarks)
  • See each field for its format, allowed values, and business meaning.

Result

On success, the endpoint completes the operation. See the 200 response schema for returned data and subsequent state information.

POSThttps://b-api.longbridge.xyz/atm/currency/config

Authorization

AuthorizationstringheaderRequired

Send the Broker ACCESS_TOKEN as Authorization: Bearer <token>.

Request body application/json

currency_isostringrequired

A dropdown with enum sourced from ref atm_ref_currency_iso.

Allowed values: USD, HKD, SGD, CNY, AUD, JPY, GBP, EUR, CAD, MYR, AMD, BGN, BTN, BWP, BZD, CDF, CHF, DKK, GHS, GMD, GNF, HRK, HUF, ILS, INR, IQD, IRR, ISK, LRD, LYD, MOP, RUB, UAH, UGX, UYI, UYU, UZS, XAF, XOF, XSU, YER, IDR, TWD, THB, KRW, NZD

USD · USDHKD · HKDSGD · SGDCNY · CNYAUD · AUDJPY · JPYGBP · GBPEUR · EURCAD · CADMYR · MYRAMD · AMDBGN · BGNBTN · BTNBWP · BWPBZD · BZDCDF · CDFCHF · CHFDKK · DKKGHS · GHSGMD · GMDGNF · GNFHRK · HRKHUF · HUFILS · ILSINR · INRIQD · IQDIRR · IRRISK · ISKLRD · LRDLYD · LYDMOP · MOPRUB · RUBUAH · UAHUGX · UGXUYI · UYIUYU · UYUUZS · UZSXAF · XAFXOF · XOFXSU · XSUYER · YERIDR · IDRTWD · TWDTHB · THBKRW · KRWNZD · NZD

currencystringrequired

Currency code used for this request. This field is required.

iconstringrequired

Specifies Icon. This field is required.

logostringrequired

Specifies Logo. This field is required.

cash_amountstring

Required only when support_deposit=yes; otherwise left empty by the client.

support_withdrawstringrequired

Before submission it is moved from a top-level request field into json_config and no longer appears separately in the final body (listed here as the pre-submission form field).

Allowed values:

  • yes - Yes
  • no - No

yes · Yesno · No

support_exchangestringrequired

Same as above; ultimately merged into json_config.

Allowed values:

  • yes - Yes
  • no - No

yes · Yesno · No

min_withdrawal_amountstringrequired

Specifies Min Withdrawal Amount. This field is required.

min_exchange_amountstringrequired

Specifies Min Exchange Amount. This field is required.

exchange_rate_precisionnumberrequired

Specifies Exchange Rate Precision. This field is required.

amount_precisionstringrequired

Specifies Amount Precision. This field is required.

Allowed values:

  • 0 - 0 decimal places
  • 1 - 1 decimal place
  • 2 - 2 decimal places

0 · 0 decimal places1 · 1 decimal place2 · 2 decimal places

amount_round_modestringrequired

A dropdown whose enum comes from ref atm_ref_amount_round_mode.

Allowed values:

  • round - Rounding Off
  • truncate - Truncate Without Rounding

round · Rounding Offtruncate · Truncate Without Rounding

standard_moneystringrequired

Specifies Standard Money. This field is required.

Allowed values:

  • yes - Yes
  • no - No

yes · Yesno · No

remarksstring

Remarks saved with this operation.

abbreviation_multi_namestringrequired

A JSON string {zh-CN, zh-HK, en} assembled from the request field abbrev_name_cn/abbrev_name_hk/currency fields.

multi_namestringrequired

A JSON string {zh-CN, zh-HK, en}, assembled from the request fields name_cn/name_hk/currency.

json_configstringrequired

A JSON string {app_show, support_withdraw, support_exchange, support_deposit}, assembled from the request fields of the same names.

Responses

HTTP 200The request was processed successfully. The response data does not contain additional business fields.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 400Bad request. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 401The user is not authenticated, or the login session has expired.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 403The current account is not authorized to use this feature. Grant the required permission to the account in User Permission.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 408The request timed out. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

Whale Docs