Skip to content
Longport WhaleLongport Whale
Client Notification

FX Reminder Query

Query the currently pending FX (currency-exchange) reminders, so the risk team can monitor single-currency debit balances and arrange conversions to repay them.

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

  • When a customer owes a balance in one currency but has usable funds in others, the system raises an FX reminder.
  • Each record carries customer information, trigger time, the owed currency and amount, the available amount, whether auto-exchange applies, and the processing status.
  • Filter by customer, trigger date, update time, auto-exchange flag, or status to follow up on pending reminders.

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_debt_alerts

Authorization

AuthorizationstringheaderRequired

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

Permission

margin_call.risk_debt_info

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.

alert_timestring

Triggered At. Filters results by Triggered At.

updated_atstring

Updated At. Filters results by Updated At.

is_autostring

Auto Convert. Filters results by Auto Convert.

Allowed values: true Open, false Closed

Values
true
Open
false
Closed
statusstring

Status. Filters results by Status.

Allowed values: 0 Pending, 5 Closed/ Completed, 2 FX - PENDING, 1 FX - PENDING APPROVAL, 3 FX - FAIL

Values
0
Pending
5
Closed/ Completed
2
FX - PENDING
1
FX - PENDING APPROVAL
3
FX - FAIL
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 FX Reminder Query 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

ID. Returned value: Unique identifier of the current record.

aaidstring

Client. Returned value: Client.

aaid_valstring

Client (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.

debt_currencystring

Currency. Returned value: Currency.

debt_amountstring

Debit Balance Amt. Returned value: Debit Balance Amt.

own_amountstring

Other Currency Available Amt. Returned value: Other Currency Available Amt.

is_autostring

Auto Convert. Returned value: Indicates whether auto convert.

is_auto_valstring

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

statusstring

Status. Returned value: Status.

status_valstring

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

alert_timestring

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

updated_atstring

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

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