Add Currency Config

Create a currency setting, used to configure withdrawal, FX, precision, and display parameters for a new currency.

Request parameters

Required: currency_iso (three-letter currency code), currency (currency identifier), icon, logo, support_withdraw, support_exchange, min_withdrawal_amount, min_exchange_amount, exchange_rate_precision, amount_precision, amount_round_mode, standard_money (whether it is the base currency), abbreviation_multi_name (localized short name), multi_name (localized full name), json_config (display and business toggles)
Optional: cash_amount (minimum deposit amount), remarks
See each field's definition for its format, value range, and business meaning.

Business notes

support_withdraw and support_exchange are merged into json_config on submission. abbreviation_multi_name, multi_name, and json_config are all JSON strings. Allowed values for amount_round_mode come from the ref atm_ref_amount_round_mode.

Risk warning

This operation adds an available currency and its funding-business configuration and may affect the deposit, withdrawal, and FX capabilities visible to customers. Confirm the parameters before calling.

Result

On success the currency setting is created; see the 200 response definition for the returned content.

POSThttps://b-api.lbkrs.com/atm/currency/config

Authorization

AuthorizationstringheaderRequired

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

Permission

atm.update_current_config

The Broker ACCESS_TOKEN must be granted the permission above, or the call will be rejected.

Request body application/json

currency_isostringrequired

A three-letter currency code.

Values

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

currencystringrequired

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

iconstringrequired

This field is required.

logostringrequired

This field is required.

cash_amountstring

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

min_withdrawal_amountstringrequired

This field is required.

min_exchange_amountstringrequired

This field is required.

exchange_rate_precisionnumberrequired

This field is required.

amount_precisionstringrequired

Specifies Amount Precision. This field is required.

Values

0: 0 decimal places
1: 1 decimal place
2: 2 decimal places

amount_round_modestringrequired

An enumerated field whose values come from ref atm_ref_amount_round_mode.

Values

round: Rounding Off
truncate: Truncate Without Rounding

standard_moneystringrequired

Specifies Standard Money. This field is required.

Values

yes: Yes
no: 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.