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.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.

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).

Values
yes
Yes
no
No
support_exchangestringrequired

Same as above; ultimately merged into json_config.

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