Skip to content
Recurring Investment

Get My Recurring Investment Plans

Returns the Client's fund recurring investment plans by status with cursor pagination, together with the plan count and total invested amounts by currency, for the My Recurring Investments page. Pass an empty cursor on the first request and the cursor from the previous page afterwards. is_end of true means there are no more. When the Client selects a plan, call Get Recurring Investment Plan Details with its id.

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

Parameters

statusintegerquery

Filter by plan status:

  • 0 - All
  • 1 - Active
  • 2 - Paused
  • 3 - Ended

0123

cursorstringquery

Pagination cursor. Pass an empty string on the first request

page_sizeintegerquery

Number of records per page. Broker App passes 10

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get my recurring investment plans” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
plansarray<object>

Plans on the current page

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
cursorstring

Cursor for the next page

is_endboolean

Whether this is the last page

plan_countinteger

Number of plans. Broker App shows it next to the Active tab

total_invested_amountsobject

Total invested amount by currency, keyed by currency with the amount as the value. Convert to one currency to show the total

Whale Docs