Jump to

• Request
• Response

Operation to DeleteFXAffirm

post

/ForeignExchangeContractAffirmationService/ForeignExchangeContractAffirmation/DeleteFXAffirm

This operation deletes the Foreign Exchange contract affirmation using the ForeignExchangeContractAffirmation service.

Request

Header Parameters

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

Body ()

Root Schema : AffirmDetailDto

Type: object

Show Source

• affirmRefDate(optional): string
  Indicates Affirmation Reference Date
• affirmRefNo(optional): string
  Indicates Affirmation Reference Number
• affirmRemarks(optional): string
  Indicates Affirmation Remarks
• affirmStatus(optional): string
  Indicates AffirmStatus
• affirmType(optional): string
  Indicates Affirmation Type
• affirmTypeDesc(optional): string
  Indicates Affirmation Type Description
• allowOnlineConfirm(optional): string
  Indicates AllowOnlineConfirm
• authstat(optional): string
  Indicates Authstat
• bookingDate(optional): string
  Indicates Booking Date
• botAmt(optional): number
  Indicates Bought Amount
• botCurrency(optional): string
  Indicates Bought Currency
• botValueDate(optional): string
  Indicates Bought Value Date
• broker(optional): string
  Indicates Broker
• checkerId(optional): string
  Indicates User Id who has Authorized the creation\modification of Customer Account.
• chkdttime(optional): string
  Indicates Checker Date Stamp
• contractRefNo(optional): string
  Indicates Contract Reference
• contstat(optional): string
  Indicates Contstat
• counterparty(optional): string
  Indicates Counterparty
• exRate(optional): number
  v
• externalRefNo(optional): string
  Indicates External Reference
• latestVersionNo(optional): number
  Indicates LatestVersionNo
• makerdt(optional): string
  Indicates Release Time
• makerId(optional): string
  Indicates Maker ID
• of(optional): string
  Indicates Of
• p(optional): string
  Indicates P
• soldAmount(optional): number
  Indicates Sold Amount
• soldCurrency(optional): string
  Indicates Sold Currency
• soldValueDate(optional): string
  Indicates Sold Value Date
• unconfirmSince(optional): string
  Indicates Unconfirmed Since
• userRefNo(optional): string
  Indicates User Reference
• versionNo(optional): number
  Indicates VersionNo
• vrno(optional): string
  Indicates Version
• waiveStatus(optional): string
  Indicates WaiveStatus

{
    "type":"object",
    "properties":{
        "contractRefNo":{
            "type":"string",
            "description":"Indicates  Contract Reference"
        },
        "userRefNo":{
            "type":"string",
            "description":"Indicates  User Reference"
        },
        "counterparty":{
            "type":"string",
            "description":"Indicates  Counterparty"
        },
        "externalRefNo":{
            "type":"string",
            "description":"Indicates  External Reference"
        },
        "botCurrency":{
            "type":"string",
            "description":"Indicates  Bought Currency"
        },
        "broker":{
            "type":"string",
            "description":"Indicates Broker"
        },
        "botAmt":{
            "type":"number",
            "description":"Indicates  Bought Amount"
        },
        "exRate":{
            "type":"number",
            "description":"v"
        },
        "soldCurrency":{
            "type":"string",
            "description":"Indicates  Sold Currency"
        },
        "bookingDate":{
            "type":"string",
            "description":"Indicates  Booking Date"
        },
        "soldAmount":{
            "type":"number",
            "description":"Indicates  Sold Amount"
        },
        "botValueDate":{
            "type":"string",
            "description":"Indicates  Bought Value Date"
        },
        "soldValueDate":{
            "type":"string",
            "description":"Indicates  Sold Value Date"
        },
        "unconfirmSince":{
            "type":"string",
            "description":"Indicates  Unconfirmed Since"
        },
        "affirmStatus":{
            "type":"string",
            "description":"Indicates AffirmStatus"
        },
        "waiveStatus":{
            "type":"string",
            "description":"Indicates WaiveStatus"
        },
        "affirmType":{
            "type":"string",
            "description":"Indicates  Affirmation Type"
        },
        "affirmTypeDesc":{
            "type":"string",
            "description":"Indicates  Affirmation Type Description"
        },
        "affirmRefNo":{
            "type":"string",
            "description":"Indicates  Affirmation Reference Number"
        },
        "affirmRefDate":{
            "type":"string",
            "description":"Indicates  Affirmation Reference Date"
        },
        "affirmRemarks":{
            "type":"string",
            "description":"Indicates  Affirmation Remarks"
        },
        "versionNo":{
            "type":"number",
            "description":"Indicates VersionNo"
        },
        "authstat":{
            "type":"string",
            "description":"Indicates Authstat"
        },
        "contstat":{
            "type":"string",
            "description":"Indicates Contstat"
        },
        "latestVersionNo":{
            "type":"number",
            "description":"Indicates LatestVersionNo"
        },
        "vrno":{
            "type":"string",
            "description":"Indicates Version"
        },
        "of":{
            "type":"string",
            "description":"Indicates Of"
        },
        "p":{
            "type":"string",
            "description":"Indicates P"
        },
        "makerId":{
            "type":"string",
            "description":"Indicates Maker ID"
        },
        "makerdt":{
            "type":"string",
            "description":"Indicates Release Time"
        },
        "checkerId":{
            "type":"string",
            "description":"Indicates User Id who has Authorized the creation\\modification of Customer Account."
        },
        "chkdttime":{
            "type":"string",
            "description":"Indicates Checker Date Stamp"
        },
        "allowOnlineConfirm":{
            "type":"string",
            "description":"Indicates AllowOnlineConfirm"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

DeleteFXAffirm Successfully Performed

Body ()

Root Schema : RESTResponse

Type: object

Show Source

• FCUBS_ERROR_RESP(optional): object FCUBSErrorResponse
• FCUBS_WARNING_RESP(optional): object FCUBSWarnResponse
• Se-Branch-Params-Full(optional): object SeBranchParamsDto

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

Nested Schema : FCUBSErrorResponse

Type: object

Show Source

• error(optional): array error
  Indicates Errors

{
    "type":"object",
    "properties":{
        "error":{
            "type":"array",
            "description":"Indicates Errors",
            "items":{
                "$ref":"#/definitions/FCUBSError"
            }
        }
    }
}

Nested Schema : FCUBSWarnResponse

Type: object

Show Source

• warning(optional): array warning
  Indicates Warning

{
    "type":"object",
    "properties":{
        "warning":{
            "type":"array",
            "description":"Indicates Warning",
            "items":{
                "$ref":"#/definitions/FCUBSWarn"
            }
        }
    }
}

Nested Schema : SeBranchParamsDto

Type: object

Show Source

• accrlvl(optional): string
  Indicates Accrual Level P - Portfolio H - Holding
• accvdtmvacrsmnths(optional): string
  Allowed Values: [ "Y", "N" ]

  Indicates Accounting Value Date Y - Yes N - No
• authstat(optional): string
  Indicates Authstat
• brncd: string
  Indicates Branch Code
• brnname(optional): string
  Indicates Branch Name
• btnUdf(optional): string
  Indicates BtnUdf
• checker(optional): string
  Indicates Checker
• checkerstamp(optional): string
  Indicates Checkerstamp
• cpnmvacrsmnths(optional): string
  Allowed Values: [ "Y", "N" ]

  Indicates Coupon Plotting Y - Yes N - No
• deallvlaccr(optional): string
  Indicates Interest Accrual Level Y - Deal N - Position
• fieldsList(optional): array fieldsList
• maker(optional): string
  Indicates Maker
• makerstamp(optional): string
  Indicates Makerstamp
• modno(optional): number
  Indicates Modno
• onceauth(optional): string
  Indicates Onceauth
• proctillnwd(optional): string
  Indicates Process Till Next Working day Y - on N - Off
• revallvl(optional): string
  Indicates Revaluation Level P - Portfolio H - Holding
• txnstat(optional): string
  Indicates Txnstat
• udfDetailsList(optional): array udfDetailsList

{
    "type":"object",
    "required":[
        "brncd"
    ],
    "properties":{
        "brncd":{
            "type":"string",
            "description":"Indicates Branch Code"
        },
        "proctillnwd":{
            "type":"string",
            "description":"Indicates Process Till Next Working day\tY - on\tN - Off"
        },
        "accvdtmvacrsmnths":{
            "type":"string",
            "description":"Indicates Accounting Value Date\tY - Yes\tN - No",
            "enum":[
                "Y",
                "N"
            ]
        },
        "cpnmvacrsmnths":{
            "type":"string",
            "description":"Indicates Coupon Plotting\tY - Yes\tN - No",
            "enum":[
                "Y",
                "N"
            ]
        },
        "revallvl":{
            "type":"string",
            "description":"Indicates Revaluation Level\tP - Portfolio\tH - Holding"
        },
        "btnUdf":{
            "type":"string",
            "description":"Indicates BtnUdf"
        },
        "deallvlaccr":{
            "type":"string",
            "description":"Indicates Interest Accrual Level\tY - Deal\tN - Position"
        },
        "brnname":{
            "type":"string",
            "description":"Indicates Branch Name"
        },
        "accrlvl":{
            "type":"string",
            "description":"Indicates Accrual Level\tP - Portfolio\tH - Holding"
        },
        "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

Indicates Errors

Show Source

• Array of: object FCUBSError

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

Nested Schema : FCUBSError

Type: object

Show Source

• ecode(optional): string
  Indicates Error Code
• edesc(optional): string
  Indicates Error Description

{
    "type":"object",
    "properties":{
        "ecode":{
            "type":"string",
            "description":"Indicates Error Code"
        },
        "edesc":{
            "type":"string",
            "description":"Indicates Error Description"
        }
    }
}

Nested Schema : warning

Type: array

Indicates Warning

Show Source

• Array of: object FCUBSWarn

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

Nested Schema : FCUBSWarn

Type: object

Show Source

• wcode(optional): string
  Indicates Warning Code
• wdesc(optional): string
  Indicates Warning Description

{
    "type":"object",
    "properties":{
        "wcode":{
            "type":"string",
            "description":"Indicates Warning Code"
        },
        "wdesc":{
            "type":"string",
            "description":"Indicates Warning Description"
        }
    }
}

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(optional): string
  Indicates UDF Field Name
• fldVal(optional): 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(optional): string
  Indicates Fielddesc
• fldnam: string
  Indicates Field Name
• fldval(optional): string
  Indicates Value
• fldvaldesc(optional): string
  Indicates Value Description
• mandatory(optional): 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