Regionalized Solutions
R24 AMR | Min(s) read
APIs
Please find below the API details for the Limit and Collaterals 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 |
|---|---|---|---|
| updateChinaCollateralReservedFunds | PUT | http://<hostname>:<jboss_port>/cnmb-provider-iris/api/vx.x.x/holdings/cn/accounts/reservedFunds/{reservedFundsId} | Updates an locked event which is linked to a collateral. Values like locked amount and lock period can be updated. |
| getChinaCollateralReservedFunds | GET | http://<hostname>:<jboss_port>/cnmb-provider-iris/api/vx.x.x/holdings/cn/accounts/reservedFunds | Retrieves the list of locked events and its collateral details. These locked events were created as a result of collaterals. |
| getChinaCollateralsPendingForApproval | GET | http://<hostname>:<jboss_port>/cnmb-provider-iris/api/vx.x.x/holdings/cn/customers/collaterals/pendingApprovals | Retrieves the list of pledged/unpledged collaterals pending for approval. |
| approveChinaCustomerCollaterals | PUT | http://<hostname>:<jboss_port>/cnmb-provider-iris/api/vx.x.x/holdings/cn/customers/collaterals/{collateralId}/approvals | Approves an pledged or guarantor collateral. Once the account is pledged as collateral. |
| createChinaCustomerCollaterals | POST | http://<hostname>:<jboss_port>/cnmb-provider-iris/api/vx.x.x/holdings/cn/customers/collaterals | Creates a pledged collateral by specifying the account number linked to the collateral or guarantor collateral by specifying the guarantor for the collateral. Once the account is pledged as collateral. |
| updateChinaCustomerCollaterals | PUT | http://<hostname>:<jboss_port>/cnmb-provider-iris/api/vx.x.x/holdings/cn/customers/collaterals/{collateralId} | Updates a pledged collateral by specifying the account number linked to the collateral or guarantor collateral by specifying the guarantor for the collateral. Once the account is pledged as collateral. |
| createChinaLimits | POST | http://<hostname>:<jboss_port>/cnmb-provider-iris/api/vx.x.x/party/cn/customers/limits | Creates a limit with revoke type information. Revoke type can be conditional revocable or not revocable. |
| getChinaLimits | GET | http://<hostname>:<jboss_port>/cnmb-provider-iris/api/vx.x.x/party/cn/customers/limits | Retrieves the list of limits with details like customer and liability. |
| getChinaLimitsPendingForApproval | GET | http://<hostname>:<jboss_port>/cnmb-provider-iris/api/vx.x.x/party/cn/customers/limits/pendingApprovals | Retrieves the list of limits pending for approval with details like customer and liability. |
| getChinaRejectLimits | GET | http://<hostname>:<jboss_port>/cnmb-provider-iris/api/vx.x.x/party/cn/customers/limits/rejections | Retrieves the list of rejected limits which require additional information. |
| updateChinaLimits | PUT | http://<hostname>:<jboss_port>/cnmb-provider-iris/api/vx.x.x/party/cn/customers/limits/{limitId} | Updates an existing limit with revoke type information. Revoke type can be conditional revocable or not revocable. |
| approveChinaLimits | PUT | http://<hostname>:<jboss_port>/cnmb-provider-iris/api/vx.x.x/party/cn/customers/limits/{limitId}/approvals | Approve a limit with revoke type information. Revoke type can be conditional revocable or not revocable. |
In this topic