diff --git a/api-docs/apiLive.htm b/api-docs/apiLive.htm index 41ad457d9..bc0c43e2d 100644 --- a/api-docs/apiLive.htm +++ b/api-docs/apiLive.htm @@ -629,6 +629,54 @@
+ Blocks Savings account from all types of credit and debit transactions +
+POST https://Domain Name/api/v1/savingsaccounts/{savingsId}?command=block
+ POST savingsaccount/1?command=block
+Content-Type: application/json
+Request Body:
+{
+}
+
+
+{
+ "officeId":1,
+ "clientId":1,
+ "savingsId":1,
+ "resourceId":1,
+ "changes":{
+ "subStatus":{
+ "id":400,
+ "code":"SavingsAccountSubStatusEnum.block",
+ "value":"Block",
+ "none":false,
+ "inactive":false,
+ "dormant":false,
+ "escheat":false,
+ "block":true,
+ "blockCredit":false,
+ "blockDebit":false
+ }
+ }
+}
+
+ + Unblock a blocked account. On unblocking account, user can perform debit and credit transactions +
+POST https://Domain Name/api/v1/savingsaccounts/{savingsId}?command=unblock
+ POST savingsaccount/1?command=unblock
+Content-Type: application/json
+Request Body:
+{
+}
+
+
+{
+ "officeId":1,
+ "clientId":1,
+ "savingsId":1,
+ "resourceId":1,
+ "changes":{
+ "subStatus":{
+ "id":0,
+ "code":"SavingsAccountSubStatusEnum.none",
+ "value":"None",
+ "none":true,
+ "inactive":false,
+ "dormant":false,
+ "escheat":false,
+ "block":false,
+ "blockCredit":false,
+ "blockDebit":false
+ }
+ }
+}
+
+ + Savings account will be blocked from all types of credit transactions. +
+POST https://Domain Name/api/v1/savingsaccounts/{savingsId}?command=blockCredit
+ POST savingsaccount/1?command=blockCredit
+Content-Type: application/json
+Request Body:
+{
+}
+
+
+{
+ "officeId":1,
+ "clientId":1,
+ "savingsId":1,
+ "resourceId":1,
+ "changes":{
+ "subStatus":{
+ "id":500,
+ "code":"SavingsAccountSubStatusEnum.blockcredit",
+ "value":"BlockCredit",
+ "none":false,
+ "inactive":false,
+ "dormant":false,
+ "escheat":false,
+ "block":false,
+ "blockCredit":true,
+ "blockDebit":false
+ }
+ }
+}
+
+ It unblocks the Saving account's credit operations. Now all types of credits can be transacted to Savings account +
+POST https://Domain Name/api/v1/savingsaccounts/{savingsId}?command=unblockCredit
+ POST savingsaccount/1?command=unblockCredit
+Content-Type: application/json
+Request Body:
+{
+}
+
+
+{
+ "officeId":1,
+ "clientId":1,
+ "savingsId":1,
+ "resourceId":1,
+ "changes":{
+ "subStatus":{
+ "id":0,
+ "code":"SavingsAccountSubStatusEnum.none",
+ "value":"None",
+ "none":true,
+ "inactive":false,
+ "dormant":false,
+ "escheat":false,
+ "block":false,
+ "blockCredit":false,
+ "blockDebit":false
+ }
+ }
+}
+
+ All types of debit operations from Savings account wil be blocked
+POST https://Domain Name/api/v1/savingsaccounts/{savingsId}?command=blockDebit
+ POST savingsaccount/1?command=blockDebit
+Content-Type: application/json
+Request Body:
+{
+}
+
+
+{
+ "officeId":1,
+ "clientId":1,
+ "savingsId":1,
+ "resourceId":1,
+ "changes":{
+ "subStatus":{
+ "id":600,
+ "code":"SavingsAccountSubStatusEnum.blockdebit",
+ "value":"BlockDebit",
+ "none":false,
+ "inactive":false,
+ "dormant":false,
+ "escheat":false,
+ "block":false,
+ "blockCredit":false,
+ "blockDebit":true
+ }
+ }
+}
+
+ It unblocks the Saving account's debit operations. Now all types of debits can be transacted from Savings account +
+POST https://Domain Name/api/v1/savingsaccounts/{savingsId}?command=unblockDebit
+ POST savingsaccount/1?command=unblockDebit
+Content-Type: application/json
+Request Body:
+{
+}
+
+
+{
+ "officeId":1,
+ "clientId":1,
+ "savingsId":1,
+ "resourceId":1,
+ "changes":{
+ "subStatus":{
+ "id":0,
+ "code":"SavingsAccountSubStatusEnum.none",
+ "value":"None",
+ "none":true,
+ "inactive":false,
+ "dormant":false,
+ "escheat":false,
+ "block":false,
+ "blockCredit":false,
+ "blockDebit":false
+ }
+ }
+}
+
+ Hold amount enables the user to hold/block/lien the specified amount from the account
+POST https://Domain Name/api/v1/savingsaccounts/4/transactions?command=holdAmount
+ POST savingsaccounts/4/transactions?command=holdAmount
+Content-Type: application/json
+Request Body:
+{
+ transactionDate:"15 June 2017",
+ transactionAmount:"200",
+ locale:"en",
+ dateFormat:"dd MMMM yyyy"
+}
+
+
+{
+ "officeId":1,
+ "clientId":2,
+ "savingsId":4,
+ "resourceId":35
+}
+
+ Release amount removes the hold/block/lien already placed on an amount in the account.
+POST https://Domain Name/api/v1/savingsaccounts/4/transactions/35?command=releaseAmount
+ POST savingsaccounts/4/transactions/35?command=releaseAmount
+Content-Type: application/json
+No Request Body:
+{
+
+}
+
+
+{
+ "officeId":1,
+ "clientId":2,
+ "savingsId":4,
+ "resourceId":36
+}
+
+