Skip to content
Funding Notices

Get Funding Notices

Returns the notices for the funding pages. The Broker App fetches them when the Client opens the withdrawal page and shows them as a notification bar at the top of the page. The same list also drives in-app funding notices.

Before showing a notice, filter it on the client: notice_type is 2 (withdrawal page), account_channel matches the current channel, the current time is between show_begin and show_end, and region_ids and region_bank_ids match the selected receiving bank card. Sort by priority in descending order and handle closing according to client_display_way. For notices whose client_display_way is 2, the Broker App must remember the closed notice itself and stop showing it.

GEThttps://api.lbkrs.com/v2/portfolio/atm/notices

Parameters

account_channelstringheader

Broker channel

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get Funding Notices” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>

Notices

Child attributes
idinteger

Notice id. Use it to remember which notices the Client has closed

titlestring

Notice title

descriptionstring

Notice body

linkstring

Page to open when the Client selects the notice. When empty, the notice is not selectable

buttonstring

Button label for the notice. When empty, the Broker App uses its default label

notice_typeinteger

Notice type:

  • 2 - Withdrawal notice

The withdrawal page shows only notices whose notice_type is 2.

account_channelstring

Broker channel the notice applies to. Show only notices that match the current channel

region_idsstring

Applicable bank card regions, separated by commas, such as HONGKONG,SINGAPORE. all means every region. Match it exactly against region of the selected receiving bank card

region_bank_idsstring

Applicable bank ids, separated by commas. -1 means every bank. Match it exactly against the bank id of the selected receiving bank card

region_idstring

Legacy region field. Use it when region_ids is absent; it follows the same rules

region_bank_idinteger

Legacy bank id field. Use it when region_bank_ids is absent

client_display_wayinteger

Display mode:

  • 1 - Closable; shown again after refresh
  • 2 - Closable; never shown again after the Client closes it
  • 3 - Not closable; always shown
Values
1
2
3
priorityinteger

Priority. Higher values are shown first

show_begininteger

Display start time, as a Unix timestamp in seconds

show_endinteger

Display end time, as a Unix timestamp in seconds. Do not show the notice when the current time is outside show_begin to show_end

Whale Docs