Jump to

• Request
• Response

Create ECA Block

get

/service/v1/createEca

This endpoint is used to create ECA Block.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• action(optional): string
  Operation/Event Code
• chargeCode(optional): string
  Charge Code
• forceBlk(optional): string
  Force Block
• partialBlkReqd(optional): string
  Partial Block Requested
• refNo: string
  Finance Reference Number

Header Parameters

• appId: string
  application Id
• branchCode: string
  Branch Code
• userId: string
  User Id

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of success or failure

Body ()

Root Schema : EcaBlockAmountDetailsCollection

Type: object

Eca blocked amount response collection

Show Source

• ecaAccAmtDetails(optional): array ecaAccAmtDetails
  Eca account amount details
• ecaErrorDetails(optional): array ecaErrorDetails
  Eca error details
• status(optional): string
  Eca block status

{
    "description":"Eca blocked amount response collection",
    "type":"object",
    "properties":{
        "status":{
            "description":"Eca block status",
            "type":"string"
        },
        "ecaAccAmtDetails":{
            "description":"Eca account amount details",
            "type":"array",
            "items":{
                "$ref":"#/definitions/EcaBlockAmountDetails"
            }
        },
        "ecaErrorDetails":{
            "description":"Eca error details",
            "type":"array",
            "items":{
                "$ref":"#/definitions/EcaErrorDetails"
            }
        }
    }
}

Nested Schema : ecaAccAmtDetails

Type: array

Eca account amount details

Show Source

• Array of: object EcaBlockAmountDetails
  Eca blocked amount response collection

{
    "description":"Eca account amount details",
    "type":"array",
    "items":{
        "$ref":"#/definitions/EcaBlockAmountDetails"
    }
}

Nested Schema : ecaErrorDetails

Type: array

Eca error details

Show Source

• Array of: object EcaErrorDetails
  Eca error code collection

{
    "description":"Eca error details",
    "type":"array",
    "items":{
        "$ref":"#/definitions/EcaErrorDetails"
    }
}

Nested Schema : EcaBlockAmountDetails

Type: object

Eca blocked amount response collection

Show Source

• accountNo(optional): string
  Account number
• approvedBlkAmount(optional): number
  Approved blocked amount
• ecaRefNo(optional): string
  ECA Ref No
• effectiveDate(optional): string
  Effective Date
• refNo(optional): string
  Transaction reference number
• requestedBlkAmount(optional): number
  Requested blocked amount

{
    "description":"Eca blocked amount response collection",
    "type":"object",
    "properties":{
        "refNo":{
            "description":"Transaction reference number",
            "type":"string"
        },
        "accountNo":{
            "description":"Account number",
            "type":"string"
        },
        "requestedBlkAmount":{
            "description":"Requested blocked amount",
            "type":"number"
        },
        "approvedBlkAmount":{
            "description":"Approved blocked amount",
            "type":"number"
        },
        "ecaRefNo":{
            "description":"ECA Ref No",
            "type":"string"
        },
        "effectiveDate":{
            "description":"Effective Date",
            "type":"string"
        }
    }
}

Nested Schema : EcaErrorDetails

Type: object

Eca error code collection

Show Source

• errorCode(optional): string
  Error code
• errorDesc(optional): string
  Error description

{
    "description":"Eca error code collection",
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"Error code",
            "type":"string"
        },
        "errorDesc":{
            "description":"Error description",
            "type":"string"
        }
    }
}

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

Back to Top