Skip to content
Longport WhaleLongport Whale
Client FPS

Query Matched FPS Rules

Returns the FPS (Faster Payment System) risk-control rule configurations that a given securities account has hit.

Request parameters

  • aaid (securities account) is required and specifies the account to query; the backend returns 400 when it is omitted.

Returns

On success, returns the list of FPS risk-control rule configurations the account has hit. See the response definition for field meanings.

GEThttps://b-api.lbkrs.com/risk/v1/hit_fps_configs

Authorization

AuthorizationstringheaderRequired

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

Parameters

aaidstringRequired

A/C No.

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.

Responses

HTTP 200OK
Standard response envelopecodemessagedata
dataobjectdata structure
original_fpsstring

Original FPS value (numeric string).

final_fpsstring

Final FPS value (numeric string).

listarray<object>

Hit FPS rule list. May be an empty array.

Child attributes
config_titlestring
option_namestring
fps_changestring
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