Jump to

• Request
• Response

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

Path Parameters

• blockRefNo: string
  blockRefNo that needs to be fetched

Header Parameters

• sourceCode: string
  Source from which request is initiated

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returns the ecablock based on given id.

Body ()

Root Schema : ECABlockMasterServiceWrapperDTO

Type: object

Show Source

• data(optional): object ECABlockServiceQueryMasterDTO

{
    "type":"object",
    "properties":{
        "data":{
            "$ref":"#/definitions/ECABlockServiceQueryMasterDTO"
        }
    }
}

Nested Schema : ECABlockServiceQueryMasterDTO

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "blockRefNo":{
            "type":"string",
            "description":"Block Reference Number ECA number"
        },
        "sourceCode":{
            "type":"string",
            "description":"Source from which request for placing block amounts on these accounts",
            "minLength":1,
            "maxLength":50
        },
        "sourceRefNo":{
            "type":"string",
            "description":"Reference number from the source",
            "minLength":1,
            "maxLength":50
        },
        "effectiveDate":{
            "type":"string",
            "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}",
            "description":"Effective Date from which block is valid"
        },
        "expiryDate":{
            "type":"string",
            "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}",
            "description":"Expiry Date till which block is valid"
        },
        "authStatus":{
            "type":"string",
            "description":"Approval Status",
            "minLength":1,
            "maxLength":1
        },
        "transactionStatus":{
            "type":"string",
            "description":"Block transaction status",
            "minLength":1,
            "maxLength":1
        },
        "txnBranch":{
            "type":"string",
            "description":"Branch where this ECA block is created",
            "minLength":1,
            "maxLength":3
        },
        "failAllOnErr":{
            "type":"string",
            "description":"Flag indicating whether to fail all accounts block processing if any one fails",
            "minLength":1,
            "maxLength":1
        },
        "checkerDtStamp":{
            "type":"string",
            "description":"DateStamp of Authorization"
        },
        "makerDtStamp":{
            "type":"string",
            "description":"DateStamp of Making of the Transaction"
        },
        "checkerId":{
            "type":"string",
            "description":"User id of Authorizer"
        },
        "makerId":{
            "type":"string",
            "description":"User id of Maker"
        },
        "amtBlkQueueReq":{
            "type":"string",
            "description":"Flag to indicate if queue is required for Amount Block"
        },
        "ECABlockServiceQueryDetailDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ECABlockServiceQueryDetailDTO"
            }
        }
    },
    "required":[
        "sourceCode",
        "effectiveDate",
        "expiryDate"
    ]
}

Nested Schema : ECABlockServiceQueryDetailDTO

Type: array

Show Source

• Array of: object ECABlockServiceQueryDetailDTO

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ECABlockServiceQueryDetailDTO"
    }
}

Nested Schema : ECABlockServiceQueryDetailDTO

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "blockRefNo":{
            "type":"string",
            "description":""
        },
        "virtualAccount":{
            "type":"string",
            "description":"Virtual Account number for which block amount will be placed",
            "minLength":1,
            "maxLength":50
        },
        "virtualAccountCcy":{
            "type":"string",
            "description":"Currency of the Virtual Account",
            "minLength":3,
            "maxLength":3
        },
        "requestedAmtInVaCcy":{
            "type":"number",
            "description":"Requested Block Amount based on virtual account details"
        },
        "approvedAmtInVaCcy":{
            "type":"number",
            "description":"Approved Block Amount based on virtual account details"
        },
        "excRateBlockccyVaccy":{
            "type":"number",
            "description":"Exchange Rate specific to virtual Account Currency"
        },
        "blockCcy":{
            "type":"string",
            "description":"Currency in which block amount is placed on this account",
            "minLength":1,
            "maxLength":3
        },
        "requestedAmount":{
            "type":"number",
            "description":"Requested amount for placing block on account"
        },
        "approvedAmount":{
            "type":"number",
            "description":"Approved amount for placing block on account"
        },
        "releasedAmount":{
            "type":"number",
            "description":"Released amount for placing block on account"
        },
        "userInputRemarks":{
            "type":"string",
            "description":"User input remarks",
            "minLength":1,
            "maxLength":50
        },
        "custAccBrn":{
            "type":"string",
            "description":"Virtual Account branch for which block amount will be placed",
            "minLength":1,
            "maxLength":3
        },
        "outstandingBlockAmount":{
            "type":"number",
            "description":"Current outstanding block amount on account"
        },
        "partialBlockRequired":{
            "type":"string",
            "description":"Flag describing if partial block is required or not ",
            "minLength":1,
            "maxLength":1
        },
        "partialReleaseAllowed":{
            "type":"string",
            "description":"Flag describing if partial release is allowed or not",
            "minLength":1,
            "maxLength":1,
            "default":"Y"
        },
        "ecaBlkStatus":{
            "type":"string",
            "description":"",
            "minLength":1,
            "maxLength":10
        },
        "lockedBy":{
            "type":"string",
            "description":"Id of user who is holding the lock on this record currently",
            "minLength":1,
            "maxLength":30
        },
        "realAccountNo":{
            "type":"string",
            "description":"Real account number of corresponding Virtual Account"
        },
        "realAccountBrn":{
            "type":"string",
            "description":"Real account branch of corresponding Virtual Account"
        },
        "realAccCcy":{
            "type":"string",
            "description":"Real account Currency of corresponding Virtual Account"
        },
        "realAccClass":{
            "type":"string",
            "description":"Real account class"
        },
        "amtInRealAccCcy":{
            "type":"number",
            "description":"Amount based on real account details"
        },
        "excRateBlockccyRaccy":{
            "type":"number",
            "description":"Exchange Rate specific to Real Account Currency"
        },
        "accountType":{
            "type":"string",
            "description":"Type of an account"
        },
        "ddaEcaRefNo":{
            "type":"string",
            "description":"DDA ECA Reference Number",
            "minLength":1,
            "maxLength":50
        },
        "ecaSystemName":{
            "type":"string",
            "description":"DDA System Name",
            "minLength":1,
            "maxLength":50
        }
    },
    "required":[
        "virtualAccount",
        "custAccBrn",
        "blockCcy",
        "requestedAmount"
    ]
}

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

Back to Top