Regionalized Solutions
Updated On 08 January 2025 |
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 |
|---|---|---|---|
| getHKRolloverdeposits | GET | http://<hostname>:<jboss_port>/<iris_war>/api/vx.x.x/holdings/hk/deposits/termDeposits/pendings | Retrieve the details of deposits that are due for rollover with incremental funding. Details to be retrieved include deposit number, product details, etc. |
| createDepositParameters | POST | http://<hostname>:<jboss_port>/<iris_war>/api/vx.x.x/settings/hk/companies/{companyId}/deposits | Create the parameter to define the deposit product groups. configurations include defining the campaign deposit product groups and the regular deposit product groups offered by the banks. |
| initiateDepositFunding | POST | http://<hostname>:<jboss_port>/<iris_war>/api/v3.0.0/holdings/hk/paymentOrders/deposits/fundings | Fund a deposit account manually using payment order and validate transaction amount with threshold amount of a particular currency. |
| initiateDepositPayout | POST | http://<hostname>:<jboss_port>/hkmb-provider-iris/api/vx.x.x/holdings/hk/paymentOrders/deposits/payouts | Payout the deposit account manually. |
| getHkDepositDetails | GET | http://<hostname>:<jboss_port>/<iris_war>/api/vx.x.x/holdings/hk/deposits | Retrieves the details of the deposit account. MI Type is a mandatory parameter to be passed. |
The mandatory parameter for getHkDepositDetails is MI Type.
The optional parameters for getHkDepositDetails are:
- Account Number.
- Primary Account Number.
- Customer Id.
- Currency.
- Maturity Date.
- Settlement Flag.
The output parameters for getHkDepositDetails are:
- Arrangement Id.
- Account Number.
- Primary Account Number.
- Account Type.
- Primary Owner.
- Primary Owner Name.
- Telephone No.
- Officer.
- Currency.
- MI type.
- Is Call Deposit.
- Settlement Flag.
- Settlement Account.
- Settlement Currency.
- Posting Restriction.
- Term.
- Base Date.
- Maturity Date.
In this topic