Jump to

• Request
• Response

Liquidate Online

post

/onliq/liquidateOnline

This endpoint is used to get online liquidation.

Request

Supported Media Types

• application/json
• application/xml

Body ()

Request Body that contains data required for calculating

Root Schema : OnliqWrapperDTO

Type: object

OnliqWrapperDTO

Show Source

• onliq: array onliq
  IC Liquidation Details

{
    "description":"OnliqWrapperDTO",
    "type":"object",
    "properties":{
        "onliq":{
            "description":"IC Liquidation Details",
            "type":"array",
            "items":{
                "$ref":"#/definitions/OnliqDetailsDTO"
            }
        }
    }
}

Nested Schema : onliq

Type: array

IC Liquidation Details

Show Source

• Array of: object OnliqDetailsDTO

{
    "description":"IC Liquidation Details",
    "type":"array",
    "items":{
        "$ref":"#/definitions/OnliqDetailsDTO"
    }
}

Nested Schema : OnliqDetailsDTO

Type: object

Show Source

• accountNumber: string
• branchCode: string
• liquidationDate: string
• productCode: string

{
    "type":"object",
    "properties":{
        "branchCode":{
            "type":"string"
        },
        "accountNumber":{
            "type":"string"
        },
        "productCode":{
            "type":"string"
        },
        "liquidationDate":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of succes or failure

Headers

• Location: string
  URL of newly calculate charges

Body ()

Root Schema : OnliqResponseWrapperDTO

Type: object

OnliqResponseDTO

Show Source

• onliq: array onliq
  IC Liquidation Details

{
    "description":"OnliqResponseDTO",
    "type":"object",
    "properties":{
        "onliq":{
            "description":"IC Liquidation Details",
            "type":"array",
            "items":{
                "$ref":"#/definitions/OnliqResponseDTO"
            }
        }
    }
}

Nested Schema : onliq

Type: array

IC Liquidation Details

Show Source

• Array of: object OnliqResponseDTO
  OnliqResponseDTO.

{
    "description":"IC Liquidation Details",
    "type":"array",
    "items":{
        "$ref":"#/definitions/OnliqResponseDTO"
    }
}

Nested Schema : OnliqResponseDTO

Type: object

OnliqResponseDTO.

Show Source

• errors: array errors
  Error Code List
• msgStat: string
• onliq: object onliq
  IC Calculation Details
• warnings: array warnings
  Warning Code List

{
    "description":"OnliqResponseDTO.",
    "type":"object",
    "properties":{
        "msgStat":{
            "type":"string"
        },
        "onliq":{
            "description":"IC Calculation Details",
            "type":"object",
            "items":{
                "$ref":"#/definitions/OnliqDetailsDTO"
            }
        },
        "warnings":{
            "description":"Warning Code List",
            "type":"array",
            "items":{
                "$ref":"#/definitions/WarningCodeDTO"
            }
        },
        "errors":{
            "description":"Error Code List",
            "type":"array",
            "items":{
                "$ref":"#/definitions/ErrorCodeDTO"
            }
        }
    }
}

Nested Schema : errors

Type: array

Error Code List

Show Source

• Array of: object ErrorCodeDTO

{
    "description":"Error Code List",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ErrorCodeDTO"
    }
}

Nested Schema : onliq

Type: object

IC Calculation Details

Show Source

• Array of: object OnliqDetailsDTO

{
    "description":"IC Calculation Details",
    "type":"object",
    "items":{
        "$ref":"#/definitions/OnliqDetailsDTO"
    }
}

Nested Schema : warnings

Type: array

Warning Code List

Show Source

• Array of: object WarningCodeDTO

{
    "description":"Warning Code List",
    "type":"array",
    "items":{
        "$ref":"#/definitions/WarningCodeDTO"
    }
}

Nested Schema : ErrorCodeDTO

Type: object

Show Source

• errorCode: string
• errorDesc: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorDesc":{
            "type":"string"
        }
    }
}

Nested Schema : OnliqDetailsDTO

Type: object

Show Source

• accountNumber: string
• branchCode: string
• liquidationDate: string
• productCode: string

{
    "type":"object",
    "properties":{
        "branchCode":{
            "type":"string"
        },
        "accountNumber":{
            "type":"string"
        },
        "productCode":{
            "type":"string"
        },
        "liquidationDate":{
            "type":"string"
        }
    }
}

Nested Schema : WarningCodeDTO

Type: object

Show Source

• warningCode: string
• warningDesc: string

{
    "type":"object",
    "properties":{
        "warningCode":{
            "type":"string"
        },
        "warningDesc":{
            "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