Bank Name Data Dictionary

Returns the data dictionary for the bank name: the list of options currently available for this field, used as the source of valid values by related endpoints.

Returns

On success, returns the list of dictionary entries under data.values. Request parameters usually use each entry's key, while value is for display. The available options may change with business configuration, so do not hard-code them on the client.

GEThttps://b-api.lbkrs.com/v1/datasets/refs/company_bank_names

Authorization

AuthorizationstringheaderRequired

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

Responses

HTTP 200On success, returns the Bank Name data-dictionary entries. Each entry contains a key for requests and a display value.

Standard response envelopecodemessagedata

dataobjectdata structure

valuesarray<object>

Dictionary Entries. Returned value: List of dictionary entries.

Child attributes

keystring

Key. Returned value: Dictionary key to send to related APIs; do not send the display text.

valuestring

Value. Returned value: Display text for the dictionary entry.

descstring

Description. Usually empty.

colorstring

Color. Returned value: Color.

pkeystring

Parent Key. Usually empty.

messagestring

Usually empty. This field is independent of the outer message field.

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 GET \
  --url 'https://b-api.lbkrs.com/v1/datasets/refs/company_bank_names' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "values": [
      {
        "key": "1",
        "value": "Normal",
        "desc": "",
        "color": "",
        "pkey": ""
      }
    ],
    "message": ""
  }
}