Generic API's
Please find below the API details for the Registered Plan module.
The API will only be useable if the module has been licenced by the client.
| API Name | Description | Domain | Method | URL | Resource | Operation Id | End Point Description |
|---|---|---|---|---|---|---|---|
| holdings-ca-regsiteredPlans-service | APIs to create, update, simulate and retrieve the registered plan products such as RRSP, RRIF, TFSA, etc | holdings | GET | /holdings/ca/portfolios/{portfolioId} | CARGPL.API.PORTFOLIO.DETAILS.1.0.0 | getCaPortfolioDetails | Retrieve the details of the registered plan products such as plan type, plan group, plan id, plan value, settlement account, etc based on portfolio id. |
| holdings | GET | /holdings/ca/portfolios/{portfolioId} | CARGPL.API.PORTFOLIO.DETAILS.1.1.0 | getCaPortfolioDetails | Retrieve the details of the registered plan products such as plan type, plan group, plan id, plan value, settlement account, etc based on portfolio id. | ||
| holdings | GET | /holdings/ca/registeredPlans/{portfolioId}/{taxYear}/transactions | CARGPL.API.GET.TRANSACTION.DETAILS.1.0.0 | getCaRegisteredPlansTransactions | Reterive the details of the contribution and withdrawal towards registered plan account such as amount, ccy, value date, etc based on plan id | ||
| order-ca-regsiteredPlans-service | Canadian reference APIs to retrieve the plan types, plan transaction codes, contributions, withdrawals and reversals | order | POST | /order/ca/payments/registeredPlans/contributions | FUNDS.TRANSFER,CARGPL.API.CONTR.1.0.0 | createCaRegisteredPlanContributions | Create contribution towards registered plan products through online banking |
| order | POST | /order/ca/payments/registeredPlans/withdrawals | FUNDS.TRANSFER,CARGPL.API.WD.1.0.0 | createCaRegisteredPlanWithdrawals | Create withdrawal from registered plan product through online banking | ||
| order | DELETE | /order/ca/payments/registeredPlans/contributions/{contributionId} | FUNDS.TRANSFER,CARGPL.API.CONTR.1.0.0 | reverseCaRegisteredPlanContributions | Cancellation of contribution from registered plan products through online banking | ||
| order | DELETE | /order/ca/payments/registeredPlans/withdrawals/{withdrawalId} | FUNDS.TRANSFER,CARGPL.API.WD.1.0.0 | reverseCaRegisteredPlanWithdrawals | Cancellation of withdrawal from registered plan product through online banking | ||
| order-ca-standingOrders-service | API to perform create/update/cancel Standing order (recurring transfer) instructions | order | POST | /order/ca/standingOrders/{standingOrderId}/registeredPlans/contributions | STANDING.ORDER,CARGPL.API.CONTR.1.0.0 | createCaStandingOrderContribution | Create standing order instruction for periodic contributions through online banking |
| order | DELETE | /order/ca/standingOrders/{standingOrderId}/registeredPlans/contributions | STANDING.ORDER,CARGPL.API.CONTR.1.0.0 | reverseCaStandingOrderContribution | Reverse standing order instruction for periodic contributions through online banking | ||
| reference-ca-regsiteredPlans-service | Canadian reference APIs to retrieve the plan types, plan transaction codes, contributions, withdrawals and reversals | reference | GET | /reference/ca/registeredPlans/planGroups/{planGroupId}/planTypes | CARGPL.API.GET.PLAN.TYPES.1.0.0 | getCaPlanTypes | Retrieves the list of registered plan types for a given plan group |
| reference | GET | /reference/ca/registeredPlans/planTypes/{planTypeId}/transactioncodes | CARGPL.API.GET.PLAN.TXNS.1.0.0 | getCaPlanTransactionCodes | Retrieves the list of registered plan transaction codes for a given registered plan type |
Field Name
|
Application/Table name
In this topic