Modify Bank Region

Updates a bank region; fields match the create operation, plus the record id.

Request parameters

Required: id (region ID), name (region), name_en, name_cn, name_hk (region names), icon, priority
Optional: tip_en/tip_cn/tip_hk (tips), tags_en/tags_cn/tags_hk (tags)
See the field definitions for each field's format, value range, and business meaning.

Risk warning

This operation changes customer-facing deposit configuration and may affect the deposit channels and guides users can see. Confirm the target record and parameters before calling.

Result

On success the operation is completed; refer to the 200 response definition for the resulting state and returned data.

POSThttps://b-api.lbkrs.com/atm/modifyRegion

Authorization

AuthorizationstringheaderRequired

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

Permission

atm.region_bank_update

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

Request body application/json

idstringrequired

Region ID. The id of the bank-region record to modify.

namestringrequired

Region. - Bank country/region code

values come from the bank_country_code dynamic enumeration
not editable when editing.

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.