Skip to content
Recurring Investment

Operate Recurring Investment Plan

Pauses, resumes, or ends a recurring investment plan. After a pause, no further debits are made; after a resume, debits continue on the original cycle. Ending a plan cannot be undone, and the plan no longer runs. Ask the Client to confirm again before pausing or ending. On success, call Get Recurring Investment Plan Details again to refresh the state. Orders already created are not affected. On failure, the plan keeps its state. Handle compliance business codes as described and show message to the Client for other errors.

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

POSThttps://api.lbkrs.com/aip/operate

Request body application/x-www-form-urlencoded

idstringrequired

Plan ID

typeintegerrequired

Operation:

  • 1 - Pause
  • 2 - Resume
  • 3 - End
Values
1
2
3

Responses

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

No business fields on success

No nested fields

HTTP 400The service rejected the request because a business rule or input validation failed. Review the business codes and correct the request before retrying.
codeintegerrequired

Business status code, 0 indicates success

messagestringrequired

Human-readable result or error message.

Whale Docs