Jump to

• Request
• Response

Initiate interest liquidation for a virtual account

post

/service/interestLiq

This endpoint is used to initiate interest liquidation for a virtual account.

Request

Supported Media Types

• application/json

Header Parameters

• sourceCode: string
  Source from which request is initiated

Body ()

Request body that contains details required to create interest liquidation request for a virtual account

Root Schema : InterestLiquidationSaveDTO

Type: object

Show Source

• liquidationAmount(optional): number
  Amount to be liquidated
• sourceReferenceNo(optional): string
  Source Reference number of Virtual Account Interest Liquidation Request
• virtualAccountNo(optional): string
  Virtual Account number for which Interest Liquidation is requested

{
    "type":"object",
    "properties":{
        "sourceReferenceNo":{
            "type":"string",
            "description":"Source Reference number of Virtual Account Interest Liquidation Request"
        },
        "virtualAccountNo":{
            "type":"string",
            "description":"Virtual Account number for which Interest Liquidation is requested"
        },
        "liquidationAmount":{
            "type":"number",
            "description":"Amount to be liquidated"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : InterestLiquidationWrapperDTO

Type: object

Show Source

• data(optional): object InterestLiquidationServiceDTO
• messages(optional): object InterestLiquidationResponseDTO

{
    "type":"object",
    "properties":{
        "messages":{
            "$ref":"#/definitions/InterestLiquidationResponseDTO"
        },
        "data":{
            "$ref":"#/definitions/InterestLiquidationServiceDTO"
        }
    }
}

Nested Schema : InterestLiquidationServiceDTO

Type: object

Show Source

• accountCurrency(optional): string
  Account Currency Type of the Interest
• authStatus(optional): string
  Authorization status of Virtual Account Interest Liquidation Request
• branchCode(optional): string
  BranchCode number of the VirtualAccount
• checkerDateStamp(optional): string(date)
  Checker Date time stamp of Virtual Account Interest Liquidation Request
• CheckerId(optional): string
  Checker of Virtual Account Interest Liquidation Request
• liquidationAmount(optional): number
  Liquidated interest amount
• makerDateStamp(optional): string(date)
  Maker Date time stamp of Virtual Account Interest Liquidation Request
• makerId(optional): string
  Maker of Virtual Account Interest Liquidation Request
• referenceNo(optional): string
  Source Reference number of Virtual Account Interest Liquidation Request
• sourceReferenceNo(optional): string
  Source Reference number of Virtual Account Interest Liquidation Request
• virtualAccountNo(optional): string
  Virtual Account number for which Interest Liquidation is requested

{
    "type":"object",
    "properties":{
        "referenceNo":{
            "type":"string",
            "description":"Source Reference number of Virtual Account Interest Liquidation Request"
        },
        "sourceReferenceNo":{
            "type":"string",
            "description":"Source Reference number of Virtual Account Interest Liquidation Request"
        },
        "virtualAccountNo":{
            "type":"string",
            "description":"Virtual Account number for which Interest Liquidation is requested"
        },
        "branchCode":{
            "type":"string",
            "description":"BranchCode number of the VirtualAccount"
        },
        "accountCurrency":{
            "type":"string",
            "description":"Account Currency Type of the Interest"
        },
        "liquidationAmount":{
            "type":"number",
            "description":"Liquidated interest amount"
        },
        "makerId":{
            "type":"string",
            "description":"Maker of Virtual Account Interest Liquidation Request"
        },
        "CheckerId":{
            "type":"string",
            "description":"Checker of Virtual Account Interest Liquidation Request"
        },
        "makerDateStamp":{
            "type":"string",
            "format":"date",
            "description":"Maker Date time stamp of Virtual Account Interest Liquidation Request"
        },
        "checkerDateStamp":{
            "type":"string",
            "format":"date",
            "description":"Checker Date time stamp of Virtual Account Interest Liquidation Request"
        },
        "authStatus":{
            "type":"string",
            "description":"Authorization status of Virtual Account Interest Liquidation Request"
        }
    }
}

Nested Schema : InterestLiquidationResponseDTO

Type: object

Show Source

• codes(optional): array codes
• status(optional): string

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

Nested Schema : codes

Type: array

Show Source

• Array of: object InterestLiquidationResponseCode

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

Nested Schema : InterestLiquidationResponseCode

Type: object

Show Source

• Code(optional): string
• Desc(optional): string
• Language(optional): string
• Type(optional): string

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

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