Skip to content
Credit Parameters

Add Account Credit Config (Submit for Review)

Creates a per-account (user-level) credit configuration for a specified securities account and submits it for review.

Request parameters

  • Account scope: member_id (member id) and aaid (securities account) locate the target customer; both required.
  • Credit subject: credit_type and credit_currency define the scope of the credit configuration.
  • Limits and coefficients: applicable, auto_credit_limit, credit_coefficient, ccf, credit_fps, and related fields describe the credit limits and calculation parameters.
  • Coefficient rules: credit_coefficient_rule_list is an optional tiered credit-coefficient rule set; when supplied, also set is_enable_credit_coefficient_rule to true.
  • See the field descriptions for each field's format, range, and business meaning.

Business notes

This endpoint does not take effect immediately: a successful submission creates an approval ticket, and the configuration is applied only after the ticket is approved. The ticket id is returned in data.ticket_id of the 200 response.

Risk warning

This operation adds a real customer credit configuration that, once approved, affects the customer's available credit limit. Confirm the target customer and credit parameters before calling.

Result

On success an approval ticket is created and its id returned in data.ticket_id; the configuration takes effect only after the ticket is approved.

POSThttps://b-api.lbkrs.com/risk/v1/account_credit_cfg/add_review

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

member_idstringrequired

Member ID of the target client, used to locate the client being credited. 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.

aaidstringrequired

A/C No. of the target client. This field is required.

Pass the internal numeric ID of the customer's securities account (aaid), not the securities account number account_no (such as H00000000) or the customer ID member_id. One customer can have multiple aaid values.

credit_typestringrequired

Credit type. The value comes from the credit-type data dictionary. This field is required.

Example: 1 denotes Margin Credit Limit.

credit_currencystringrequired

Currency of the credit limit. This field is required.

applicableintegerrequired

Maximum credit amount that can be submitted from the app; must be a multiple of 1000. This field is required.

auto_credit_limitintegerrequired

Maximum limit for system auto-approval; must be a multiple of 1000. This field is required.

net_asset_ratiostring

Declared net-asset-value multiple, passed as a string. Required only when credit_type is 1 (Margin Credit Limit); omit for other credit types.

credit_fpsnumberrequired

Account fundamental analysis factor (FPS), ranging from 0 to 1. Required only when credit_type is 1 (Margin Credit Limit).

credit_coefficientnumber

Credit coefficient of the account, passed as a decimal number.

ccfnumberrequired

Credit conversion factor (CCF), passed as a decimal. It is entered as a percentage (0–100) and must be divided by 100 before submission; for example, submit 1 for 100%. This field is required.

auto_creditbooleanrequired

Whether auto-credit is enabled: true to enable, false to disable. This field is required.

is_enable_credit_coefficient_ruleboolean

Whether tiered credit-coefficient rules are enabled. Set to true when credit_coefficient_rule_list is non-empty.

credit_coefficient_rule_listarray<object>required

Array of tiered credit-coefficient rules. Each item maps a value range of a given metric (such as client net assets) to a credit coefficient. Omit or pass an empty array when no tiered rules are configured.

Child attributes
typestring

Metric type matched by the rule; the value comes from the credit-coefficient-rule-type dictionary, for example 0 for client net assets.

coefficientstring

Credit coefficient applied when this range is matched.

left_operatorstring

Comparison operator for the lower bound; use the "unlimited" marker when the bound is open.

right_operatorstring

Comparison operator for the upper bound; use the "unlimited" marker when the bound is open.

left_valuestring

Value of the lower bound; may be empty when the lower bound is unlimited.

right_valuestring

Value of the upper bound; may be empty when the upper bound is unlimited.

di_discount_factorstring

DI discount factor; submitted only for tenants with position-calculation parameters enabled and a specific credit type.

margin_multiplierstring

Margin multiplier; submitted under the same condition as the DI discount factor.

equity_cap_multiplierstring

Equity cap multiplier; submitted under the same condition as the DI discount factor.

cash_discount_ratestring

Cash discount rate; submitted under the same condition as the DI discount factor.

dynamic_credit_limit_adjustment_statusboolean

Whether dynamic credit-limit adjustment is enabled; shown and submitted only for Longbridge-internal tenants.

max_dynamic_credit_limitnumber

Upper bound of dynamic credit-limit adjustment; submitted when dynamic adjustment is enabled.

min_dynamic_credit_limitnumber

Lower bound of dynamic credit-limit adjustment; submitted when dynamic adjustment is enabled.

Responses

HTTP 200The request was processed successfully. An approval ticket is created, and data.ticket_id contains the generated ticket ID.
Standard response envelopecodemessagedata
dataobjectdata structure

Result of the review submission.

ticket_idstring

ID of the approval ticket created after submission; use it to track the approval progress.

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