Add Bank Card

Add a withdrawal bank card for a customer as an administrator.

Request parameters

Required: member_id (user ID), name (real name), account (bank account), country (country name), bank_en (bank English name), region (region code), name_en (English name)
Optional: bank_id (bank ID), swift_code (SWIFT code), account_type (account type, e.g. ALL/HKD/USD), address (address), remark (remark), bank_code (bank code), account_channel (account channel), fps_id (card FPS ID), review_urls (review document URL list), is_tob (whether from the WAS backend)
See the field definitions for each field's format, allowed values, and business meaning.

Business notes

The new card becomes the customer's withdrawal payee account; verify the account details are accurate.

Risk warning

This operation may change real funds, positions, or transaction state. Confirm the target record and parameters before calling.

Returns

On success returns the created card; see the 200 response for field definitions.

POSThttps://b-api.lbkrs.com/v1/portfolio/withdraw/card/add/by/admin

Authorization

AuthorizationstringheaderRequired

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

Permission

b2b_withdraw.add_withdraw_card

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

Request body application/json

member_idintegerrequired

Member id. Specifies Member id. This field is required.

member_id is the customer ID. It differs from the securities account number account_no and the internal securities account ID aaid; one customer can have multiple securities accounts.

bank_idintegerrequired

Bank id. Specifies Bank id.

namestringrequired

Real name. Specifies Real name. This field is required.

accountstringrequired

Bank account. Specifies Bank account. This field is required.

swift_codestringrequired

Swift code. Specifies Swift code.

account_typestringrequired

Account type, e. Values come from a backend data dictionary (maintained dynamically), not a fixed enum; use the options the service actually returns.

countrystring

Country name. Specifies Country name. This field is required.

addressstring

Address. Specifies Address.

remarkstring

Remark. Specifies Remark.

bank_enstringrequired

Bank English name. Specifies Bank English name. This field is required.

regionstringrequired

Region code. Specifies Region code. This field is required.

name_enstringrequired

English name. Specifies English name. This field is required.

bank_codestring

Bank code. Specifies Bank code.

account_channelstring

Account channel. Specifies Account channel.

fps_idstring

FPS id. Specifies FPS id.

review_urlsarray<string>required

Audit material urls. Specifies Audit material urls.

is_tobboolean

Whether the request originates from the ToB (WAS) admin backend: true if so; false (or omitted) if created via the other admin path.

payee_countrystringrequired

Payee country/region; options come from a backend data dictionary

payee_statestring

Payee state or province

payee_citystring

Payee city

payee_streetstring

Payee street address

payee_buildingstring

Payee building; required when the payee country is the Philippines

payee_postcodestring

Payee postal code

admin_remarkstring

Admin remark; submitted only when adding

audit_frontend_resourceobject

Audit context attached by the caller

Responses

HTTP 200The request was processed successfully. data is the result.

Standard response envelopecodemessagedata

dataobjectdata structure

idinteger

Bank account id. Specifies Bank account id.

bank_idinteger

Bank id. Specifies Bank id.

namestring

Account real name. Specifies Account real name.

accountstring

Bank account. Specifies Bank account.

swift_codestring

Swift code. Specifies Swift code.

account_typestring

Account type. Specifies Account type.

countrystring

Country name. Specifies Country name.

addressstring

Address. Specifies Address.

remarkstring

Remark. Specifies Remark.

regionstring

Region code. Specifies Region code.

bankstring

Bank Chinese name. Specifies Bank Chinese name.

iconstring

Bank icon. Specifies Bank icon.

bank_enstring

Bank English name. Specifies Bank English name.

region_namestring

Region name. Specifies Region name.

name_enstring

Account English name. Specifies Account English name.

bank_codestring

Bank code. Specifies Bank code.

statusinteger

Bank account status. Specifies Bank account status.

Values

0
1
2

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/portfolio/withdraw/card/add/by/admin' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "member_id": 0,
  "bank_id": 0,
  "name": "",
  "account": "",
  "swift_code": "",
  "account_type": "",
  "country": "",
  "address": "",
  "remark": "",
  "bank_en": "",
  "region": "",
  "name_en": "",
  "bank_code": "",
  "account_channel": "",
  "fps_id": "",
  "review_urls": [],
  "is_tob": false
}'

Response

{
  "code": 0,
  "message": "success",
  "data": {}
}