Skip to content
Longport WhaleLongport Whale
Notification History

Notification History

Query the history of completed FX reminders, so the risk team can review how each debit-balance reminder was handled from trigger to closure.

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 a closed FX reminder and carries an ID, counter channel, customer channel account, currency, and processing status.
  • It records the debit amount before and after, and the convertible other-currency amount before and after, showing the change across the conversion.
  • It also includes the trigger date, due date, and completion date; filter by customer, trigger date, completion date, or status.

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_alert_histories

Authorization

AuthorizationstringheaderRequired

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

Permission

margin_call.risk_debt_history_info_query

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

Please Select A/C. Filters results by Please Select A/C.

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.

end_timestring

Completed At. Filters results by Completed At.

statusstring

Stauts. Filters results by Stauts.

Allowed values: 5 Auto Completed (System), 6 Manual FX (User), 7 Auto FX

Values
5
Auto Completed (System)
6
Manual FX (User)
7
Auto FX
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 History Record 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.

account_channelstring

Account Channel. Returned value: Account Channel.

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.

debt_currencystring

Currency. Returned value: Currency.

debt_amountstring

Debit Balance Amt (Before). Returned value: Debit Balance Amt (Before).

new_debt_amountstring

Debit Balance Amt (After). Returned value: Debit Balance Amt (After).

own_amountstring

Other Currency Available Amt (Before). Returned value: Other Currency Available Amt (Before).

new_own_amountstring

Other Currency Available Amt (After). Returned value: Other Currency Available Amt (After).

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.

alert_end_timestring

Due Date. Returned value: Due Date. The date or time format follows the value returned by the API.

end_timestring

Completed At. Returned value: Completed 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