Adds a new ECA Block
post
/service/ecablock
This endpoint is used to add a new ECA block.
Request
Supported Media Types
- application/json
- application/xml
Header Parameters
-
sourceCode(required): string
Source from which request is initiated
Request Body that contains data required for creating a new ecaBlock
Root Schema : ECABlockServiceMasterDTO
Type:
Show Source
object-
amtBlkQueueReq:
string
Flag to indicate if queue is required for Amount Block
-
ECABlockServiceDetailDTO:
array ECABlockServiceDetailDTO
-
effectiveDate(required):
string
Pattern:
[0-9]{4}[-][0-9]{2}[-][0-9]{2}Effective Date from which block is valid -
expiryDate(required):
string
Pattern:
[0-9]{4}[-][0-9]{2}[-][0-9]{2}Expiry Date till which block is valid -
failAllOnErr:
string
Minimum Length:
1Maximum Length:1Flag indicating whether to fail all accounts block processing if any one fails -
sourceCode(required):
string
Minimum Length:
1Maximum Length:50Source from which request for placing block amounts on these accounts -
sourceRefNo:
string
Minimum Length:
1Maximum Length:50Reference number from the source -
txnBranch:
string
Minimum Length:
1Maximum Length:3Branch where this ECA block is created
Nested Schema : ECABlockServiceDetailDTO
Type:
Show Source
object-
accountType:
string
Type of an account
-
amtInRealAccCcy:
number
Amount based on real account details
-
approvedAmount:
number
Approved amount for placing block on account
-
approvedAmtInVaCcy:
number
Approved Block Amount based on virtual account details
-
blockCcy(required):
string
Minimum Length:
1Maximum Length:3Currency in which block amount is placed on this account -
custAccBrn(required):
string
Minimum Length:
1Maximum Length:3Virtual Account branch for which block amount will be placed -
ecaBlkStatus:
string
Minimum Length:
1Maximum Length:10 -
ecaSystemName:
string
Minimum Length:
1Maximum Length:50DDA System Name -
excRateBlockccyRaccy:
number
Exchange Rate specific to Real Account Currency
-
excRateBlockccyVaccy:
number
Exchange Rate specific to virtual Account Currency
-
outstandingBlockAmount:
number
Current outstanding block amount on account
-
partialBlockRequired:
string
Minimum Length:
1Maximum Length:1Flag describing if partial block is required or not -
partialReleaseAllowed:
string
Minimum Length:
1Maximum Length:1Default Value:YFlag describing if partial release is allowed or not -
releasedAmount:
number
Released amount for placing block on account
-
requestedAmount(required):
number
Requested amount for placing block on account
-
requestedAmtInVaCcy:
number
Requested Block Amount based on virtual account details
-
userInputRemarks:
string
Minimum Length:
1Maximum Length:50User input remarks -
virtualAccount(required):
string
Minimum Length:
1Maximum Length:50Virtual Account number for which block amount will be placed -
virtualAccountCcy:
string
Minimum Length:
3Maximum Length:3Currency of the Virtual Account
Response
Supported Media Types
- application/json
- application/xml
- text/csv
201 Response
Returns message of success or failure
Headers
-
Location: string
URL of newly created ecaBlock
Nested Schema : ECABlockServiceQueryMasterDTO
Type:
Show Source
object-
amtBlkQueueReq:
string
Flag to indicate if queue is required for Amount Block
-
authStatus:
string
Minimum Length:
1Maximum Length:1Approval Status -
blockRefNo:
string
Block Reference Number ECA number
-
checkerDtStamp:
string
DateStamp of Authorization
-
checkerId:
string
User id of Authorizer
-
ECABlockServiceQueryDetailDTO:
array ECABlockServiceQueryDetailDTO
-
effectiveDate(required):
string
Pattern:
[0-9]{4}[-][0-9]{2}[-][0-9]{2}Effective Date from which block is valid -
expiryDate(required):
string
Pattern:
[0-9]{4}[-][0-9]{2}[-][0-9]{2}Expiry Date till which block is valid -
failAllOnErr:
string
Minimum Length:
1Maximum Length:1Flag indicating whether to fail all accounts block processing if any one fails -
makerDtStamp:
string
DateStamp of Making of the Transaction
-
makerId:
string
User id of Maker
-
sourceCode(required):
string
Minimum Length:
1Maximum Length:50Source from which request for placing block amounts on these accounts -
sourceRefNo:
string
Minimum Length:
1Maximum Length:50Reference number from the source -
transactionStatus:
string
Minimum Length:
1Maximum Length:1Block transaction status -
txnBranch:
string
Minimum Length:
1Maximum Length:3Branch where this ECA block is created
Nested Schema : ECABlockServiceQueryDetailDTO
Type:
Show Source
object-
accountType:
string
Type of an account
-
amtInRealAccCcy:
number
Amount based on real account details
-
approvedAmount:
number
Approved amount for placing block on account
-
approvedAmtInVaCcy:
number
Approved Block Amount based on virtual account details
-
blockCcy(required):
string
Minimum Length:
1Maximum Length:3Currency in which block amount is placed on this account -
blockRefNo:
string
-
custAccBrn(required):
string
Minimum Length:
1Maximum Length:3Virtual Account branch for which block amount will be placed -
ddaEcaRefNo:
string
Minimum Length:
1Maximum Length:50DDA ECA Reference Number -
ecaBlkStatus:
string
Minimum Length:
1Maximum Length:10 -
ecaSystemName:
string
Minimum Length:
1Maximum Length:50DDA System Name -
excRateBlockccyRaccy:
number
Exchange Rate specific to Real Account Currency
-
excRateBlockccyVaccy:
number
Exchange Rate specific to virtual Account Currency
-
lockedBy:
string
Minimum Length:
1Maximum Length:30Id of user who is holding the lock on this record currently -
outstandingBlockAmount:
number
Current outstanding block amount on account
-
partialBlockRequired:
string
Minimum Length:
1Maximum Length:1Flag describing if partial block is required or not -
partialReleaseAllowed:
string
Minimum Length:
1Maximum Length:1Default Value:YFlag describing if partial release is allowed or not -
realAccCcy:
string
Real account Currency of corresponding Virtual Account
-
realAccClass:
string
Real account class
-
realAccountBrn:
string
Real account branch of corresponding Virtual Account
-
realAccountNo:
string
Real account number of corresponding Virtual Account
-
releasedAmount:
number
Released amount for placing block on account
-
requestedAmount(required):
number
Requested amount for placing block on account
-
requestedAmtInVaCcy:
number
Requested Block Amount based on virtual account details
-
userInputRemarks:
string
Minimum Length:
1Maximum Length:50User input remarks -
virtualAccount(required):
string
Minimum Length:
1Maximum Length:50Virtual Account number for which block amount will be placed -
virtualAccountCcy:
string
Minimum Length:
3Maximum Length:3Currency of the Virtual Account
202 Response
Accepted
400 Response
Malformed syntax.
401 Response
Request does not have sufficient credentials.
403 Response
Request is not authorized.
405 Response
Invalid input
500 Response
Internal error