APIs
Please find below the API details for the FSCS - Continuity of Access 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 |
---|---|---|---|
createCompensationEligibility | POST | http://<hostname>:<jboss_port>/ukmb-provider-iris/api/vx.x.x/holdings/UK/arrangements/{arrangementId}/compensations | Mark the compensation status for accounts and deposits with the status NFFSTP (Not Fit For Straight Through Payout) . compensation status can be marked either as YES or as NO. |
getUnprotectedFundDetails | GET | http://<hostname>:<jboss_port>/ukmb-provider-iris/api/vx.x.x/holdings/UK/accounts/{accountId}/compensations | Retrieve the details of unprotected funds transferred into unprotected suspense account for all the accounts and deposits. Details includes the fund details. |
getDepositRedemptionDetails | GET | http://<hostname>:<jboss_port>/ukmb-provider-iris/api/vx.x.x/holdings/UK/deposits/{depositId}/compensations | Retrieve the details of deposits redeemed as part of continuity of access. Details include arrangement number. |
createLockedEventReverse | POST | http://<hostname>:<jboss_port>/ukmb-provider-iris/api/vx.x.x/order/uk/events/isaAccounts | Create a reversal for the locked event for unfreezing the account and making the funds available in the customer account up to the compensation limit as per regulation. |
createukModulusCheckParam | POST | http://<hostname>:<jboss_port>/ukmb-provider-iris/api/vx.x.x/reference/uk/accountValidations/bankSortCodes/{bankSortCodeId} | Configure the parameter required for performing account modulus check. The configuration includes assigning the modulus type and weights for a range of bank sort codes. |
In this topic