Currency Setup · Whale Docs

POSThttps://b-api.lbkrs.com/v1/datasets/atm_currency_configs

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

filtersobject

Combines business filters. Omit a filter field to disable that filter.

Child attributes

currency_isostring

Filters results by Currency code.

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

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

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Currency Setup records together with pagination metadata such as the page number, page size, and total record count.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

Returned value: List of list.

Child attributes

idstring

Returned value: Unique identifier of the current record.

account_channelstring

Returned value: Account Channel.

currency_isostring

Returned value: Currency code.

standard_moneystring

Returned value: Standard Currency.

abbrev_name_cnstring

Returned value: Abbreviation In Simplified Chinese.

abbrev_name_hkstring

Returned value: Abbreviation In Traditional Chinese.

name_cnstring

Returned value: Full Name In Simplified Chinese.

name_hkstring

Returned value: Full Name In Traditional Chinese.

currencystring

Returned value: Displayed Currency.

iconstring

Returned value: Icon.

min_exchange_amountstring

Returned value: Minimum Exchange Amount.

min_withdrawal_amountstring

Returned value: Minimum Withdrawal Amount.

min_cash_amountstring

Returned value: Cash Amount.

app_showstring

Returned value: Asset Display.

support_withdrawstring

Returned value: Withdrawal Function.

support_depositstring

Returned value: Deposit Feature.

support_exchangestring

Returned value: Exchange Feature.

exchange_rate_precisionstring

Returned value: Exchange Rate Precision.

amount_precisionstring

Returned value: Amount Precision.

amount_round_modestring

Returned value: Retrieval Logic.

amount_round_mode_valstring

Raw value of amount_round_mode. The amount_round_mode field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

created_atstring

Returned value: Created Time. The date or time format follows the value returned by the API.

updated_atstring

Returned value: Update Time. The date or time format follows the value returned by the API.

remarksstring

Returned value: Remark.

totalintegerrequired

Returned value: Total number of matching records, used for pagination.

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

Request

curl --request POST \
  --url 'https://b-api.lbkrs.com/v1/datasets/atm_currency_configs' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "page": 1,
  "page_size": 20
}'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "20",
        "account_channel": "longport_test",
        "currency_iso": "AUD",
        "standard_money": "no",
        "abbrev_name_cn": "澳元",
        "abbrev_name_hk": "澳元",
        "name_cn": "澳大利亚元",
        "name_hk": "澳大利亞元",
        "currency": "AUD",
        "icon": "AUD",
        "min_exchange_amount": "3.00",
        "min_withdrawal_amount": "12.00",
        "min_cash_amount": "0.00",
        "app_show": "yes",
        "support_withdraw": "yes",
        "support_deposit": "yes",
        "support_exchange": "yes",
        "exchange_rate_precision": "2",
        "amount_precision": "2",
        "amount_round_mode": "Rounding Off",
        "amount_round_mode_val": "round",
        "created_at": "1655956642",
        "updated_at": "1783972827",
        "remarks": ""
      }
    ],
    "total": 15
  }
}