Regionalized Solutions
Updated On 05 November 2024 |
Min(s) read
APIs
Please find below the API details for the Deposits module.
The API will only be useable if the module has been licensed by the client.
In the URL, vx.x.x denotes the swagger version that client has licensed.
| Endpoint | Method | URL | Description |
|---|---|---|---|
| simulateTermDepositRedemption | POST | http://<hostname>:<jboss_port>/nzmb-provider-iris/api/vx.x.x/holdings/nz/deposits/termDeposits/redemptions/simulations | Simulates the term deposit redemption for a partial withdrawals or full withdrawal. |
| initiateTermDepositRedemption | POST | http://<hostname>:<jboss_port>/nzmb-provider-iris/api/vx.x.x/holdings/nz/deposits/termDeposits/redemptionInitiation | Initiate term deposit redemption for a partial withdrawal or full withdrawal. |
| approveTermDepositRedemption | PUT | http://<hostname>:<jboss_port>/nzmb-provider-iris/api/vx.x.x/holdings/nz/deposits/termDeposits/redemptionApprovals/{redemptionId} | Approves the term deposit redemption request for a partial withdrawals or full withdrawal. |
| createTermDepositRedemption | POST | http://<hostname>:<jboss_port>/nzmb-provider-iris/api/vx.x.x/holdings/nz/deposits/termDeposits/redemptions | Create and execute term deposit redemption request for a partial withdrawals or full withdrawal. |
| getInitiatedTermDepositRedemptions | GET | http://<hostname>:<jboss_port>/nzmb-provider-iris/api/vx.x.x/holdings/nz/deposits/termDeposits/redemptionInitiation | Retrieves all initiated term deposit redemptions for approval. |
| getTermDepositRedemptions | GET | http://<hostname>:<jboss_port>/nzmb-provider-iris/api/vx.x.x/holdings/nz/deposits/termDeposits/{termDepositId}/redemptions | Retrieves executed redemptions of a term deposit such as multiple partial withdrawals or full withdrawal. |
| deleteTermDepositRedemptionInitiation | DELETE | http://<hostname>:<jboss_port>/nzmb-provider-iris/api/vx.x.x/holdings/nz/deposits/termDeposits/redemptionInitiation/{redemptionId} | Deletes the initiated term deposit redemption for a partial withdrawals or full withdrawal. |
| getCapturedTermDepositNoticeWithdrawals | GET | http://<hostname>:<jboss_port>/nzmb-provider-iris/api/vx.x.x/holdings/nz/deposits/termDeposits/redemptions/{redemptionId} | Retrieves the captured notice redemptions of a term deposit for partial withdrawals or full withdrawal effective future date to amend or cancel. |
| updateTermDepositRedemption | PUT | http://<hostname>:<jboss_port>/nzmb-provider-iris/api/vx.x.x/holdings/nz/deposits/termDeposits/redemptions/{redemptionId} | Amends the term deposit notice redemption request for a partial withdrawals or full withdrawal. |
| Cancel - updateTermDepositRedemption | PUT | http://<hostname>:<jboss_port>/nzmb-provider-iris/api/vx.x.x/holdings/nz/deposits/termDeposits/redemptions/{redemptionId} | Cancels the term deposit notice redemption request for a partial withdrawals or full withdrawal. |
In this topic