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