Skip to content
Longport WhaleLongport Whale
Bank Region List

Add Bank Region

Add Bank Region.

Request parameters

  • Required: name (Region), name_en (Region Name (English)), name_cn (Region Name (Simplified Chinese)), name_hk (Region Name (Traditional Chinese)), icon (Icon), priority (Priority)
  • Optional: tip_en (Tip (English)), tip_cn (Tip (Simplified Chinese)), tip_hk (Tip (Traditional Chinese)), tags_en (Tags (English)), tags_cn (Tags (Simplified Chinese)), tags_hk (Tags (Traditional Chinese))
  • 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/addRegion

Authorization

Authorizationstringheaderatm.region_bank_updateRequired

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

Request body application/json

namestringrequired

Region. Bank country/region code; values come from the bank_country_code dynamic enumeration and are not fixed.

Call GET /v1/datasets/refs/bank_country_code to retrieve the current data dictionary, and use the returned entry's key as this field's value.

name_enstringrequired

Region Name (English). Specifies Region Name (English). This field is required.

name_cnstringrequired

Region Name (Simplified Chinese). Specifies Region Name (Simplified Chinese). This field is required.

name_hkstringrequired

Region Name (Traditional Chinese). Specifies Region Name (Traditional Chinese). This field is required.

iconstringrequired

Icon. Specifies Icon. This field is required.

prioritystringrequired

Priority. A numeric string from 1 to 999.

tip_enstring

Tip (English). Specifies Tip (English).

tip_cnstring

Tip (Simplified Chinese). Specifies Tip (Simplified Chinese).

tip_hkstring

Tip (Traditional Chinese). Specifies Tip (Traditional Chinese).

tags_enstring

Tags (English). Specifies Tags (English).

tags_cnstring

Tags (Simplified Chinese). Specifies Tags (Simplified Chinese).

tags_hkstring

Tags (Traditional Chinese). Specifies Tags (Traditional Chinese).

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