Skip to content
Recurring Investment

Get Recurring Investment Plan Details

Returns the settings and execution summary of one recurring investment plan (cycle, debit day, amount per installment, amount and installments invested, next debit time, and status) for the plan details page and for prefilling the edit page when modifying a plan.

When you call this endpoint through WhaleCore requestService(), set requiresTradeToken to true.

GEThttps://api.lbkrs.com/v2/aip/detail

Parameters

idstringqueryRequired

Plan ID

counter_idstringquery

Fund ID (counter_id), a fund code in the form UT/HK/.... You can pass it together with id

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get recurring investment plan details” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
planobject

Fund recurring investment plan

Child attributes
idstring

Plan ID

counter_idstring

Fund ID (counter_id)

namestring

Fund name

isinstring

Fund ISIN

currencystring

Investment currency (the fund settlement currency)

cycleinteger

Investment cycle:

  • 1 - Daily
  • 2 - Weekly
  • 3 - Every two weeks
  • 4 - Monthly
Values
1
2
3
4
cycle_dayinteger

Debit day: 1-5 (Monday to Friday) for weekly and biweekly cycles; 1-31 for monthly, where 32 means the last day of the month. Not used for the daily cycle

invest_amountstring

Amount per installment

invested_amountstring

Total amount invested so far

invested_countinteger

Number of installments invested so far

next_invest_timeinteger

Next debit time. Do not show it when the plan is paused or ended, as a Unix timestamp in seconds

statusinteger

Plan status:

  • 1 - Active
  • 2 - Paused
  • 3 - Ended
Values
1
2
3
Whale Docs