Skip to content
Longport WhaleLongport Whale
Client Notification

Query FX Conversion Push Notifications

Returns the history of exchange-related push notifications.

Request parameters

  • This endpoint has no required parameters; see the field definitions for optional ones.
  • Pass aaid to filter the push history by a given securities account.

Returns

On success, returns the exchange push-notification history. See the response definition for field meanings.

POSThttps://b-api.lbkrs.com/v1/risk_monitoring/message_exchange_push_history

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

aaidstring

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
dataobject

Currency exchange push notification history.

Child attributes
push_msg_itemarray<object>

Push message list.

Child attributes
post_idstring

Message ID. Can be passed as id to risk_message_detail.

titlestring

Message title. May be an empty string.

msg_typestring

Push channel, such as app or email.

contentstring

Message content. For the email channel this is the HTML body; may be an empty string.

statusinteger

Push status code (integer).

push_by_userstring

Push initiator, such as risk-monitoring.

push_timestring

Push time as a Unix timestamp in seconds.

languagestring

Message language, such as zh-CN.

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