Skip to content
Supported Bank Setups

Update Region Bank

Updates a supported bank record identified by id; fields match the create operation.

Request parameters

  • Required: id (record ID), params (bank details)
  • 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.

PUThttps://b-api.lbkrs.com/v1/atm/region/bank

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_regionbanks.regionbanks_update

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

Request body application/json

idstringrequired

Record ID. Record ID associated with this request.

paramsobjectrequired

Bank details.

Child attributes
regionstring

Region code of the bank, e.g. HK.

namestring

Bank name in Simplified Chinese.

name_hkstring

Bank name in Traditional Chinese.

name_enstring

Bank name in English.

bank_codestring

Bank code.

swift_codestring

SWIFT code.

prioritystring

Sort priority; larger numbers come first.

account_lengthstring

Bank account number length.

deposit_witness_statestring

Whether deposit witnessing is supported; 0 = no.

is_allow_bind_cardinteger

Whether binding cards is allowed: 0 no, 1 yes.

bank_group_idstring

Bank group ID; 0 means none.

addressstring

Bank address.

iconstring

Icon URL.

logostring

Logo URL.

left_backgroundstring

Card left background colour, e.g. #ffffff.

right_backgroundstring

Card right background colour, e.g. #ffffff.

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