Skip to content
Longport WhaleLongport Whale
Update Records

Update Records

Query trade-credit change applications and their review records, so the audit team can trace how each limit adjustment was requested and approved.

Request parameters

  • Combine business filters through filters (see the filters field notes below for the optional fields), and use page, page_size, and orderBy to control pagination and sorting.

Business notes

  • Each record represents one trade-credit adjustment application and carries customer information, account type, applicant, requested amount, currency, trade-credit type, origin (such as individual adjustment), and remarks.
  • It records the review status (for example reviewing or passed), review time, reviewer, and limit expiry, forming a complete audit trail of limit changes.
  • Filter by customer, review status, or trade-credit type.

Returns

On success, returns the matched records and pagination info. See the response schema for column meanings.

POSThttps://b-api.lbkrs.com/v1/datasets/risk_trade_credit_applications

Authorization

AuthorizationstringheaderRequired

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

Permission

credit_quota.invalidate_trader_audit_list

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

Request body application/json

filtersobject

Filters. Combines business filters. Omit a filter field to disable that filter.

Child attributes
aaidstring

Client. Filters results by Client.

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.

review_statusstring

Review Status. Filters results by Review Status.

Allowed values: 0 Reviewing, 1 Pass, 2 Rejected, 3 Closed

Values
0
Reviewing
1
Pass
2
Rejected
3
Closed
trade_credit_typestring

Type. Filters results by Type.

Allowed values: 0 Global, 1 Single Currency

Values
0
Global
1
Single Currency
pageinteger

Page. Page number to retrieve, starting from 1.

page_sizeinteger

Page Size. Number of records to return per page.

orderByarray<object>

Order By. Array of sorting rules. Each item defines a sort field and direction.

Responses

HTTP 200On success, returns paginated Trade Limit Review records together with pagination metadata such as the page number, page size, and total record count.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>required

List. Returned value: List of list.

Child attributes
idstring

Record ID. Returned value: Record ID (row primary key); write operations on this record take it as their id.

aaidstring

A/C No.. Returned value: A/C No..

aaid_valstring

A/C No. (raw value). Raw value of aaid. The aaid field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

member_idstring

Client. Returned value: Client.

real_namestring

Name. Returned value: Name.

review_statusstring

Review Status. Returned value: Review Status.

review_status_valstring

Review Status (raw value). Raw value of review_status. The review_status field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

account_typestring

Account Type. Returned value: Account Type.

account_type_valstring

Account Type (raw value). Raw value of account_type. The account_type field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

currencystring

Main Currency. Returned value: Main Currency.

trade_credit_typestring

Type. Returned value: Type.

trade_credit_type_valstring

Type (raw value). Raw value of trade_credit_type. The trade_credit_type field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

apply_amountstring

Requested Amt. Returned value: Requested Amt.

applicantstring

Submitted By. Returned value: Submitted By.

created_atstring

Submitted At. Returned value: Submitted At. The date or time format follows the value returned by the API.

apply_expired_atstring

Trading Limit Expiry Date. Returned value: Trading Limit Expiry Date. The date or time format follows the value returned by the API.

reviewed_bystring

Approved By. Returned value: Approved By.

review_atstring

Approved At. Returned value: Approved At. The date or time format follows the value returned by the API.

remarkstring

Remark. Returned value: Remark.

remark_valstring

Remark (raw value). Raw value of remark. The remark field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

originstring

Source. Returned value: Source.

origin_valstring

Source (raw value). Raw value of origin. The origin field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

totalintegerrequired

Total. Returned value: Total number of matching records, used for pagination.

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