Create/Modify Rival Broker Info

Creates or edits a counterparty broker record (currently V2). Pass id only when editing. name and app_name are multilingual fields, submitted separately as _en, _cn, and _hk.

Request parameters

Required: market (market), name_en/name_cn/name_hk (multilingual channel broker name), app_name_en/app_name_cn/app_name_hk (multilingual broker app name), stock_limit (transfer stock-count limit), code (broker code), contact (contact person), is_has_attachment (whether attachments exist), tpl_email (transfer email template key), show_name (own-side broker display name), priority (priority), state (status)
Optional: id (counterparty broker record ID), contact_phone, contact_email, icon (broker logo), website, file_list (attachment file list), audit_frontend_resource (caller-provided audit context)
See the field descriptions for the format, value range, and business meaning of each field.

Business notes

Counterparty brokers identify the connecting broker for customer transfer-in/transfer-out. is_has_attachment uses the atm_brokers_attachment dynamic enum.

Risk warning

This operation changes live counterparty broker configuration. Verify the audit context and confirm the parameters before calling.

Result

On success, the counterparty broker record is created or edited. The resulting state and returned data follow the 200 response definition.

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

Authorization

AuthorizationstringheaderRequired

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

Permission

cmbc.broker_rival

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

Request body application/json

idstring

Rival Broker Record ID. Passed only when editing an existing record; omitted when creating.

marketstringrequired

Market of the counterparty broker. Options are provided by the backend market data dictionary; use the options the service returns. Locked to us and read-only for US tenants.

Allowed values: us US market, cn Shanghai/Shenzhen market, hk Hong Kong market, sg Singapore market

Values

us: US Market
cn: CN Market
hk: HK Market
sg: SG Market

name_enstringrequired

Channel Broker (English). Specifies Channel Broker (English). This field is required.

name_cnstringrequired

Channel Broker (Simplified Chinese). Specifies Channel Broker (Simplified Chinese). This field is required.

name_hkstringrequired

Channel Broker (Traditional Chinese). Specifies Channel Broker (Traditional Chinese). This field is required.

app_name_enstringrequired

Broker App Name (English). Specifies Broker App Name (English). This field is required.

app_name_cnstringrequired

Broker App Name (Simplified Chinese). Specifies Broker App Name (Simplified Chinese). This field is required.

app_name_hkstringrequired

Broker App Name (Traditional Chinese). Specifies Broker App Name (Traditional Chinese). This field is required.

stock_limitintegerrequired

Stock Number Limited. Specifies Stock Number Limited. This field is required.

codestringrequired

Code. Specifies Code. This field is required.

contactstringrequired

Contact. Specifies Contact. This field is required.

is_has_attachmentstringrequired

Any Attachment. A radio field whose value comes from the keys of ref atm_brokers_attachment. When it is 1, website is optional and contact_phone/contact_email are required; for other values, the opposite applies.

Allowed values: 1 Yes, 0 No

Values

1: Yes
0: No

contact_phonestring

Contact Phone. Required when is_has_attachment indicates an attachment is present; must match the regex ^[A-Za-z0-9,.-+\s]+$.

contact_emailstring

Contact Email. Required when is_has_attachment indicates there is an attachment; must be in email format.

tpl_emailstringrequired

Template Key for Transfer Email. Specifies Template Key for Transfer Email. This field is required.

iconstring

Broker Logo. Specifies Broker Logo.

show_namestringrequired

Display Name of Our Broker. A radio field.

Allowed values: 1 Name of Counter Company, 0 Name of channel broker

Values

1: Name Of Counter Company
0: Name Of Channel Broker

websitestring

Website Address. Required when is_has_attachment indicates no attachment.

priorityintegerrequired

Priority. Processing priority. Interpret the value and sort order according to the allowed-value definitions. This field is required.

statestringrequired

State. 1 = Enable, 2 = Disable; defaults to 1.

Values

1: Enable
2: Disable

file_listarray<string>

Attachment File List. Array of file keys returned after uploading files for review_urls.

audit_frontend_resourceobject

Audit Context. Auto-appended by the client for audit-log display; not a business field.

nameobject

Localized name object with zh-CN, zh-HK, en; also flattened into name_cn/name_hk/name_en. Send the object together with the flattened fields, using the same values.

Child attributes

zh-CNstring

Channel broker name (Simplified Chinese).

zh-HKstring

Channel broker name (Traditional Chinese).

enstring

Channel broker name (English).

app_nameobject

Localized app-name object with zh-CN, zh-HK, en; also flattened into app_name_cn/app_name_hk/app_name_en. Send the object together with the flattened fields, using the same values.

Child attributes

zh-CNstring

Broker app name (Simplified Chinese).

zh-HKstring

Broker app name (Traditional Chinese).

enstring

Broker app name (English).

account_limitstring

Account limit; multiple values are joined with / on submit.

icon_typestring

Icon type. Options come from a backend data dictionary.

Responses

HTTP 200The request was processed successfully. The response data does not contain additional business fields.