Skip to content
Credit Parameters

Modify Global Credit Config (Submit for Review)

Modify a global (tenant-wide) credit configuration and submit it for review.

A global credit configuration applies to the entire tenant rather than to an individual client, so the request body has no account-scoped fields such as member_id or aaid. Identify the record to modify with id alone.

The change does not take effect immediately. On success, an approval ticket is created and the modification is applied only after the ticket is approved. The ticket ID is returned in data.ticket_id of the 200 response.

Request parameters

  • Target record: id identifies the global credit configuration to modify and is required.
  • Credit subject: credit_type (Credit Type) and credit_currency (Currency).
  • Limits and coefficients: applicable, auto_credit_limit, credit_coefficient, ccf, and credit_fps describe the credit limits and calculation parameters.
  • Coefficient rules: credit_coefficient_rule_list is an optional set of tiered credit-coefficient rules; when rules are supplied, also set is_enable_credit_coefficient_rule to true.
  • Dynamic adjustment: when dynamic_credit_limit_adjustment_status is enabled, provide max_dynamic_credit_limit and min_dynamic_credit_limit.
  • Audit context: audit_frontend_resource is caller-provided audit context recorded for this modification.
  • See each field for its format, allowed values, and business meaning.

Result

On success, an approval ticket is created and its ID is returned in data.ticket_id. The modification takes effect only after the ticket is approved.

POSThttps://b-api.longbridge.xyz/risk/v1/global_credit_cfg/modify_review

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

idstringrequired

ID of the global credit configuration record to modify. This field is required.

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_fpsnumber

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

ccfnumberrequired

Credit conversion factor (CCF), passed as a decimal. It is entered as a percentage (0100) 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.

credit_coefficientnumberrequired

Default credit multiplier coefficient. 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>

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.

audit_frontend_resourceobject

Caller-provided audit context recorded for this modification (for example, a snapshot of the record before the change).

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