Jump to

• Request
• Response

Deletes the ECA block identified by given block reference number

delete

/service/ecablock/{blockRefNo}

This endpoint is used to delete the ECA block identified by given ID.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• blockRefNo(required): string
  blockRefNo of the ecablock maintenance

Header Parameters

• sourceCode(required): string
  Source from which request is initiated

Back to Top

Response

Supported Media Types

• application/json
• application/xml
• text/csv

200 Response

Successful operation.

Body ()

Root Schema : ECABlockServiceResponseDTO

Type: object

Show Source

• data: object ECABlockServiceQueryMasterDTO
• messages: object ECAServiceResponseDto

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

Nested Schema : ECABlockServiceQueryMasterDTO

Type: object

Show Source

• amtBlkQueueReq: string
  Flag to indicate if queue is required for Amount Block
• authStatus: string
  Minimum Length: 1

  Maximum Length: 1

  Approval 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: 1

  Maximum Length: 1

  Flag 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: 1

  Maximum Length: 50

  Source from which request for placing block amounts on these accounts
• sourceRefNo: string
  Minimum Length: 1

  Maximum Length: 50

  Reference number from the source
• transactionStatus: string
  Minimum Length: 1

  Maximum Length: 1

  Block transaction status
• txnBranch: 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 : ECAServiceResponseDto

Type: object

Show Source

• codes: array codes
• httpStatusCode: string
• status: string

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "httpStatusCode":{
            "type":"string"
        },
        "codes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ECAServiceResponseCode"
            }
        }
    }
}

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: 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: 1

  Maximum Length: 3

  Currency in which block amount is placed on this account
• blockRefNo: string
• custAccBrn(required): string
  Minimum Length: 1

  Maximum Length: 3

  Virtual Account branch for which block amount will be placed
• ddaEcaRefNo: string
  Minimum Length: 1

  Maximum Length: 50

  DDA ECA Reference Number
• ecaBlkStatus: string
  Minimum Length: 1

  Maximum Length: 10
• ecaSystemName: string
  Minimum Length: 1

  Maximum Length: 50

  DDA System Name
• excRateBlockccyRaccy: number
  Exchange Rate specific to Real Account Currency
• excRateBlockccyVaccy: number
  Exchange Rate specific to virtual Account Currency
• lockedBy: string
  Minimum Length: 1

  Maximum Length: 30

  Id of user who is holding the lock on this record currently
• outstandingBlockAmount: number
  Current outstanding block amount on account
• partialBlockRequired: string
  Minimum Length: 1

  Maximum Length: 1

  Flag describing if partial block is required or not
• partialReleaseAllowed: string
  Minimum Length: 1

  Maximum Length: 1

  Default Value: Y

  Flag 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: 1

  Maximum Length: 50

  User input remarks
• virtualAccount(required): string
  Minimum Length: 1

  Maximum Length: 50

  Virtual Account number for which block amount will be placed
• virtualAccountCcy: 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"
    ]
}

Nested Schema : codes

Type: array

Show Source

• Array of: object ECAServiceResponseCode

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

Nested Schema : ECAServiceResponseCode

Type: object

Show Source

• Code: string
• Desc: string
• Language: string
• Type: string

{
    "type":"object",
    "properties":{
        "Code":{
            "type":"string"
        },
        "Desc":{
            "type":"string"
        },
        "Type":{
            "type":"string"
        },
        "Language":{
            "type":"string"
        }
    }
}

202 Response

Accepted

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