Jump to

• Request
• Response

Operation to CloseDealProduct

post

/SecuritiesDealProductDefinitionService/SecuritiesDealProductDefinition/CloseDealProduct

This operation closes the deal product using the SecuritiesDealProductDefinition service.

Request

Header Parameters

• BRANCH(required): string
  Enter Transaction Branch
• ENTITY: string
  Enter Entity ID
• SOURCE(required): string
  Enter Source Code of External System
• USERID(required): string
  Enter User ID

Body ()

Root Schema : CstmsProductDto

Type: object

Show Source

• authstat: string
  Indicates Authstat
• brnRestList: string
  Indicates BrnRestList
• btnBranches: string
  Indicates BtnBranches
• btnMisDetails: string
  Indicates BtnMisDetails
• btnPreferences: string
  Indicates BtnPreferences
• btnUdf: string
  Indicates BtnUdf
• ccyRestList: string
  Indicates CcyRestList
• checker: string
  Indicates Checker
• checkerstamp: string
  Indicates Checkerstamp
• edtmsInstrumentProduct: object EdtmsInstrumentProductDto
• maker: string
  Indicates Maker
• makerstamp: string
  Indicates Makerstamp
• maxrtvari(required): number
  Indicates Stop Limit
• moddesc: string
  Indicates Module Description
• modno: number
  Indicates Modno
• modu: string
  Indicates Report Module
• nrmlrtvari(required): number
  Indicates Override Limit
• onceauth: string
  Indicates Onceauth
• prdcd(required): string
  Indicates Product Code
• prddesc(required): string
  Indicates Product Description
• prdenddt: string
  Indicates End Date
• prdgrp: string
  Indicates Product Group
• prdrmrks: string
  Indicates Remarks
• prdslg: string
  Indicates Slogan
• prdstrtdt: string
  Indicates Start Date
• prdtyp: string
  Indicates Product Type
• prdtypdesc: string
  Indicates Product Type Description
• prodgrpdesc: string
  Indicates Product Group Description
• productMisDetails: object ProductMisDetailsDto
• rtcodeprferd(required): string
  Allowed Values: [ "M", "B" ]

  Indicates Rate Code M - Mid Rate B - Buy /Sell Rate
• rttypeprferd(required): string
  Indicates Rate Type
• txnstat: string
  Indicates Txnstat

{
    "type":"object",
    "required":[
        "maxrtvari",
        "nrmlrtvari",
        "prdcd",
        "prddesc",
        "rtcodeprferd",
        "rttypeprferd"
    ],
    "properties":{
        "prdcd":{
            "type":"string",
            "description":"Indicates Product Code"
        },
        "prddesc":{
            "type":"string",
            "description":"Indicates Product Description"
        },
        "prdslg":{
            "type":"string",
            "description":"Indicates Slogan"
        },
        "prdrmrks":{
            "type":"string",
            "description":"Indicates Remarks"
        },
        "prdenddt":{
            "type":"string",
            "description":"Indicates End Date"
        },
        "prdgrp":{
            "type":"string",
            "description":"Indicates Product Group"
        },
        "modu":{
            "type":"string",
            "description":"Indicates Report Module"
        },
        "nrmlrtvari":{
            "type":"number",
            "description":"Indicates Override Limit"
        },
        "maxrtvari":{
            "type":"number",
            "description":"Indicates Stop Limit"
        },
        "prdtyp":{
            "type":"string",
            "description":"Indicates Product Type"
        },
        "rtcodeprferd":{
            "type":"string",
            "description":"Indicates Rate Code\tM - Mid Rate\tB - Buy /Sell Rate",
            "enum":[
                "M",
                "B"
            ]
        },
        "rttypeprferd":{
            "type":"string",
            "description":"Indicates Rate Type"
        },
        "moddesc":{
            "type":"string",
            "description":"Indicates Module Description"
        },
        "prdstrtdt":{
            "type":"string",
            "description":"Indicates Start Date"
        },
        "prdtypdesc":{
            "type":"string",
            "description":"Indicates Product Type Description"
        },
        "prodgrpdesc":{
            "type":"string",
            "description":"Indicates Product Group Description"
        },
        "btnBranches":{
            "type":"string",
            "description":"Indicates BtnBranches"
        },
        "btnPreferences":{
            "type":"string",
            "description":"Indicates BtnPreferences"
        },
        "btnMisDetails":{
            "type":"string",
            "description":"Indicates BtnMisDetails"
        },
        "btnUdf":{
            "type":"string",
            "description":"Indicates BtnUdf"
        },
        "brnRestList":{
            "type":"string",
            "description":"Indicates BrnRestList"
        },
        "ccyRestList":{
            "type":"string",
            "description":"Indicates CcyRestList"
        },
        "maker":{
            "type":"string",
            "description":"Indicates Maker"
        },
        "makerstamp":{
            "type":"string",
            "description":"Indicates Makerstamp"
        },
        "checker":{
            "type":"string",
            "description":"Indicates Checker"
        },
        "checkerstamp":{
            "type":"string",
            "description":"Indicates Checkerstamp"
        },
        "modno":{
            "type":"number",
            "description":"Indicates Modno"
        },
        "txnstat":{
            "type":"string",
            "description":"Indicates Txnstat"
        },
        "authstat":{
            "type":"string",
            "description":"Indicates Authstat"
        },
        "onceauth":{
            "type":"string",
            "description":"Indicates Onceauth"
        },
        "edtmsInstrumentProduct":{
            "$ref":"#/definitions/EdtmsInstrumentProductDto"
        },
        "productMisDetails":{
            "$ref":"#/definitions/ProductMisDetailsDto"
        }
    }
}

Nested Schema : EdtmsInstrumentProductDto

Type: object

Show Source

• autoExercise: string
  Indicates Auto Exercise Y - on N - Off
• canSettleBeforeExpiry: string
  Indicates Prior Settlement Possible Y - on N - Off
• pdtCodeDesc: string
  Indicates Product Description
• pdtType: string
  Indicates Product Type
• pdtTypeDesc: string
  Indicates Product Type Description
• physicalSettlementPossible: string
  Indicates Physical Settlement Possible Y - on N - Off
• prdcd: string
  Indicates Product Code
• underlyingAssetType: string
  Indicates Asset Type

{
    "type":"object",
    "properties":{
        "prdcd":{
            "type":"string",
            "description":"Indicates Product Code"
        },
        "underlyingAssetType":{
            "type":"string",
            "description":"Indicates Asset Type"
        },
        "physicalSettlementPossible":{
            "type":"string",
            "description":"Indicates Physical Settlement Possible\tY - on\tN - Off"
        },
        "canSettleBeforeExpiry":{
            "type":"string",
            "description":"Indicates Prior Settlement Possible\tY - on\tN - Off"
        },
        "autoExercise":{
            "type":"string",
            "description":"Indicates Auto Exercise\tY - on\tN - Off"
        },
        "pdtCodeDesc":{
            "type":"string",
            "description":"Indicates  Product Description"
        },
        "pdtType":{
            "type":"string",
            "description":"Indicates  Product Type"
        },
        "pdtTypeDesc":{
            "type":"string",
            "description":"Indicates  Product Type Description"
        }
    }
}

Nested Schema : ProductMisDetailsDto

Type: object

Show Source

• cstcd1: string
  Indicates Cstcd1
• cstcd2: string
  Indicates Cstcd2
• cstcd4: string
  Indicates Cstcd4
• cstcd5: string
  Indicates Cstcd5
• defaultMisCodesList: array defaultMisCodesList
• linktogrp: string
  Indicates Linktogrp
• misgrp: string
  Indicates Misgrp
• poolcd: string
  Indicates Poolcd
• prdcd: string
  Indicates Prdcd
• prdcdhid: string
  Indicates Prdcdhid

{
    "type":"object",
    "properties":{
        "linktogrp":{
            "type":"string",
            "description":"Indicates Linktogrp"
        },
        "misgrp":{
            "type":"string",
            "description":"Indicates Misgrp"
        },
        "poolcd":{
            "type":"string",
            "description":"Indicates Poolcd"
        },
        "cstcd1":{
            "type":"string",
            "description":"Indicates Cstcd1"
        },
        "cstcd2":{
            "type":"string",
            "description":"Indicates Cstcd2"
        },
        "cstcd4":{
            "type":"string",
            "description":"Indicates Cstcd4"
        },
        "cstcd5":{
            "type":"string",
            "description":"Indicates Cstcd5"
        },
        "prdcdhid":{
            "type":"string",
            "description":"Indicates Prdcdhid"
        },
        "prdcd":{
            "type":"string",
            "description":"Indicates Prdcd"
        },
        "defaultMisCodesList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DefaultMisCodesDto"
            }
        }
    }
}

Nested Schema : defaultMisCodesList

Type: array

Show Source

• Array of: object DefaultMisCodesDto

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

Nested Schema : DefaultMisCodesDto

Type: object

Show Source

• kyid: string
  Indicates Kyid
• miscd: string
  Indicates Miscd
• miscls: string
  Indicates Miscls
• mistyp: string
  Indicates Mistyp

{
    "type":"object",
    "properties":{
        "mistyp":{
            "type":"string",
            "description":"Indicates Mistyp"
        },
        "miscls":{
            "type":"string",
            "description":"Indicates Miscls"
        },
        "miscd":{
            "type":"string",
            "description":"Indicates Miscd"
        },
        "kyid":{
            "type":"string",
            "description":"Indicates Kyid"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

CloseDealProduct Successfully Performed

Body ()

Root Schema : RESTResponse

Type: object

Show Source

• FCUBS_ERROR_RESP: object FCUBSErrorResponse
• FCUBS_WARNING_RESP: object FCUBSWarnResponse
• Ld-Branch-Params-Full: object LdBranchParamsDto

{
    "type":"object",
    "properties":{
        "Ld-Branch-Params-Full":{
            "$ref":"#/definitions/LdBranchParamsDto"
        },
        "FCUBS_ERROR_RESP":{
            "$ref":"#/definitions/FCUBSErrorResponse"
        },
        "FCUBS_WARNING_RESP":{
            "$ref":"#/definitions/FCUBSWarnResponse"
        }
    }
}

Nested Schema : FCUBSErrorResponse

Type: object

Show Source

• ERROR: array ERROR

{
    "type":"object",
    "properties":{
        "ERROR":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/FCUBSError"
            }
        }
    }
}

Nested Schema : FCUBSWarnResponse

Type: object

Show Source

• WARNING: array WARNING

{
    "type":"object",
    "properties":{
        "WARNING":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/FCUBSWarn"
            }
        }
    }
}

Nested Schema : LdBranchParamsDto

Type: object

Show Source

• accrlvl: string
  Indicates Accrual Level P - Product C - Contract
• apycalc: string
  Indicates Annual Percentage Yield Calculation Required Y - on N - Off
• authstat: string
  Indicates Authstat
• brncd(required): string
  Indicates Branch Code
• brnname: string
  Indicates Branch Name
• btnUdf: string
  Indicates BtnUdf
• checker: string
  Indicates Checker
• checkerstamp: string
  Indicates Checkerstamp
• fieldsList: array fieldsList
• maker: string
  Indicates Maker
• makerstamp: string
  Indicates Makerstamp
• modno: number
  Indicates Modno
• onceauth: string
  Indicates Onceauth
• proctill: string
  Indicates Process Till Next Working Day - 1 S - System Date N - Next Working Day - 1
• sgenmanliq: string
  Indicates Settlement Message At Manual Liquidation Y - on N - Off
• taxcompbasis: string
  Indicates Tax Basis S - Schedule Amount L - Liquidation Amount
• txnstat: string
  Indicates Txnstat
• udfDetailsList: array udfDetailsList
• usrrefinmsgs: string
  Indicates User Reference in Messages Y - on N - Off

{
    "type":"object",
    "required":[
        "brncd"
    ],
    "properties":{
        "brncd":{
            "type":"string",
            "description":"Indicates Branch Code"
        },
        "proctill":{
            "type":"string",
            "description":"Indicates Process Till Next Working Day - 1\tS - System Date\tN - Next Working Day - 1"
        },
        "accrlvl":{
            "type":"string",
            "description":"Indicates Accrual Level\tP - Product\tC - Contract"
        },
        "taxcompbasis":{
            "type":"string",
            "description":"Indicates Tax Basis\tS - Schedule Amount\tL - Liquidation Amount"
        },
        "sgenmanliq":{
            "type":"string",
            "description":"Indicates Settlement Message At Manual Liquidation\tY - on\tN - Off"
        },
        "apycalc":{
            "type":"string",
            "description":"Indicates Annual Percentage Yield Calculation Required\tY - on\tN - Off"
        },
        "brnname":{
            "type":"string",
            "description":"Indicates Branch Name"
        },
        "btnUdf":{
            "type":"string",
            "description":"Indicates BtnUdf"
        },
        "usrrefinmsgs":{
            "type":"string",
            "description":"Indicates User Reference in Messages\tY - on\tN - Off"
        },
        "maker":{
            "type":"string",
            "description":"Indicates Maker"
        },
        "makerstamp":{
            "type":"string",
            "description":"Indicates Makerstamp"
        },
        "checker":{
            "type":"string",
            "description":"Indicates Checker"
        },
        "checkerstamp":{
            "type":"string",
            "description":"Indicates Checkerstamp"
        },
        "modno":{
            "type":"number",
            "description":"Indicates Modno"
        },
        "txnstat":{
            "type":"string",
            "description":"Indicates Txnstat"
        },
        "authstat":{
            "type":"string",
            "description":"Indicates Authstat"
        },
        "onceauth":{
            "type":"string",
            "description":"Indicates Onceauth"
        },
        "udfDetailsList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UdfDetailsDto"
            }
        },
        "fieldsList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UdfFieldsDto"
            }
        }
    }
}

Nested Schema : ERROR

Type: array

Show Source

• Array of: object FCUBSError

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

Nested Schema : FCUBSError

Type: object

Show Source

• ECODE: string
• EDESC: string

{
    "type":"object",
    "properties":{
        "ECODE":{
            "type":"string"
        },
        "EDESC":{
            "type":"string"
        }
    }
}

Nested Schema : WARNING

Type: array

Show Source

• Array of: object FCUBSWarn

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

Nested Schema : FCUBSWarn

Type: object

Show Source

• WCODE: string
• WDESC: string

{
    "type":"object",
    "properties":{
        "WCODE":{
            "type":"string"
        },
        "WDESC":{
            "type":"string"
        }
    }
}

Nested Schema : fieldsList

Type: array

Show Source

• Array of: object UdfFieldsDto

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

Nested Schema : udfDetailsList

Type: array

Show Source

• Array of: object UdfDetailsDto

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

Nested Schema : UdfFieldsDto

Type: object

Show Source

• fldName: string
  Indicates UDF Field Name
• fldVal: string
  Indicates UDF Field Value

{
    "type":"object",
    "properties":{
        "fldName":{
            "type":"string",
            "description":"Indicates UDF Field Name"
        },
        "fldVal":{
            "type":"string",
            "description":"Indicates UDF Field Value"
        }
    }
}

Nested Schema : UdfDetailsDto

Type: object

Show Source

• fielddesc: string
  Indicates Fielddesc
• fldnam(required): string
  Indicates Field Name
• fldval: string
  Indicates Value
• fldvaldesc: string
  Indicates Value Description
• mandatory: string
  Indicates Mandatory

{
    "type":"object",
    "required":[
        "fldnam"
    ],
    "properties":{
        "fldnam":{
            "type":"string",
            "description":"Indicates Field Name"
        },
        "fldval":{
            "type":"string",
            "description":"Indicates Value"
        },
        "fielddesc":{
            "type":"string",
            "description":"Indicates Fielddesc"
        },
        "mandatory":{
            "type":"string",
            "description":"Indicates Mandatory"
        },
        "fldvaldesc":{
            "type":"string",
            "description":"Indicates Value Description"
        }
    }
}

400 Response

Failed while processing request

401 Response

User Not Authorized

405 Response

Method Not Allowed

500 Response

Internal Server Error

Back to Top