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(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 : AffirmDetailDto

Type: object

Show Source

• affirmRefDate: string
  Indicates Affirmation Reference Date
• affirmRefNo: string
  Indicates Affirmation Reference Number
• affirmRemarks: string
  Indicates Affirmation Remarks
• affirmStatus: string
  Indicates Affirmation Status
• affirmType: string
  Indicates Affirmation Type
• affirmTypeDesc: string
  Indicates Affirmation Type Description
• allowOnlineConfirm: string
  Indicates AllowOnlineConfirm
• authoriseBy: string
  Indicates User Id who has Authorized the creation\modification of Customer Account.
• authStat: string
  Indicates AuthStat
• bookingDate: string
  Indicates Booking Date
• broker: string
  Indicates Broker
• checkerDtStamp: string
  Indicates Checker Date Stamp
• contractRefNo: string
  Indicates Contract Reference
• contstat: string
  Indicates Contstat
• counterparty: string
  Indicates Counterparty
• currency: string
  Indicates Threshold Currency
• latestVersionNo: number
  Indicates LatestVersionNo
• makerDtStamp: string
  Indicates Release Time
• makerId: string
  Indicates Maker ID
• maturityDate: string
  It indictes Maturity Date
• of: string
  Indicates Of
• p: string
  Indicates P
• prnAmt: number
  Indicates Principal Amount
• unconfirmSince: string
  Indicates Unconfirmed Since
• userRefno: string
  Indicates User Reference
• valueDate: string
  Indicates the effective date of the account
• versionNo: number
  Indicates VersionNo
• versionno: string
  Indicates Version
• waiveStatus: string
  Indicates Waive Status

{
    "type":"object",
    "properties":{
        "latestVersionNo":{
            "type":"number",
            "description":"Indicates LatestVersionNo"
        },
        "contstat":{
            "type":"string",
            "description":"Indicates Contstat"
        },
        "authStat":{
            "type":"string",
            "description":"Indicates AuthStat"
        },
        "checkerDtStamp":{
            "type":"string",
            "description":"Indicates Checker Date Stamp"
        },
        "authoriseBy":{
            "type":"string",
            "description":"Indicates User Id who has Authorized the creation\\modification of Customer Account."
        },
        "makerDtStamp":{
            "type":"string",
            "description":"Indicates Release Time"
        },
        "makerId":{
            "type":"string",
            "description":"Indicates Maker ID"
        },
        "affirmRemarks":{
            "type":"string",
            "description":"Indicates  Affirmation Remarks"
        },
        "affirmRefDate":{
            "type":"string",
            "description":"Indicates  Affirmation Reference Date"
        },
        "affirmRefNo":{
            "type":"string",
            "description":"Indicates  Affirmation Reference Number"
        },
        "affirmTypeDesc":{
            "type":"string",
            "description":"Indicates  Affirmation Type Description"
        },
        "affirmType":{
            "type":"string",
            "description":"Indicates  Affirmation Type"
        },
        "waiveStatus":{
            "type":"string",
            "description":"Indicates  Waive Status"
        },
        "affirmStatus":{
            "type":"string",
            "description":"Indicates  Affirmation Status"
        },
        "versionNo":{
            "type":"number",
            "description":"Indicates VersionNo"
        },
        "maturityDate":{
            "type":"string",
            "description":"It indictes Maturity Date"
        },
        "valueDate":{
            "type":"string",
            "description":"Indicates the effective date of the account"
        },
        "unconfirmSince":{
            "type":"string",
            "description":"Indicates  Unconfirmed Since"
        },
        "bookingDate":{
            "type":"string",
            "description":"Indicates  Booking Date"
        },
        "broker":{
            "type":"string",
            "description":"Indicates Broker"
        },
        "prnAmt":{
            "type":"number",
            "description":"Indicates  Principal Amount"
        },
        "userRefno":{
            "type":"string",
            "description":"Indicates  User Reference"
        },
        "currency":{
            "type":"string",
            "description":"Indicates  Threshold Currency"
        },
        "counterparty":{
            "type":"string",
            "description":"Indicates  Counterparty"
        },
        "contractRefNo":{
            "type":"string",
            "description":"Indicates  Contract Reference"
        },
        "of":{
            "type":"string",
            "description":"Indicates Of"
        },
        "p":{
            "type":"string",
            "description":"Indicates P"
        },
        "versionno":{
            "type":"string",
            "description":"Indicates Version"
        },
        "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

• Exer-Master-Full: object ExerMasterDto
• FCUBS_ERROR_RESP: object FCUBSErrorResponse
• FCUBS_WARNING_RESP: object FCUBSWarnResponse

{
    "type":"object",
    "properties":{
        "Exer-Master-Full":{
            "$ref":"#/definitions/ExerMasterDto"
        },
        "FCUBS_ERROR_RESP":{
            "$ref":"#/definitions/FCUBSErrorResponse"
        },
        "FCUBS_WARNING_RESP":{
            "$ref":"#/definitions/FCUBSWarnResponse"
        }
    }
}

Nested Schema : ExerMasterDto

Type: object

Show Source

• advice: string
  Indicates Advice
• charges: string
  Indicates Charges
• cntrccy: string
  Indicates Counter Currency
• cntrdescr: string
  Indicates Counterparty Description
• contccy: string
  Indicates Currency
• contractEventLog: object ContractEventLogDto
• contref(required): string
  Indicates Contract Reference
• counterparty: string
  Indicates Counterparty
• event: string
  Indicates Event
• exerDetail: object ExerDetailDto
• p: string
  Indicates P
• stl: string
  Indicates Stl
• subsysstat: string
  Indicates Subsysstat
• tax: string
  Indicates Tax

{
    "type":"object",
    "required":[
        "contref"
    ],
    "properties":{
        "contref":{
            "type":"string",
            "description":"Indicates Contract Reference"
        },
        "counterparty":{
            "type":"string",
            "description":"Indicates Counterparty"
        },
        "cntrdescr":{
            "type":"string",
            "description":"Indicates Counterparty Description"
        },
        "contccy":{
            "type":"string",
            "description":"Indicates Currency"
        },
        "cntrccy":{
            "type":"string",
            "description":"Indicates Counter Currency"
        },
        "subsysstat":{
            "type":"string",
            "description":"Indicates Subsysstat"
        },
        "advice":{
            "type":"string",
            "description":"Indicates Advice"
        },
        "event":{
            "type":"string",
            "description":"Indicates Event"
        },
        "charges":{
            "type":"string",
            "description":"Indicates Charges"
        },
        "stl":{
            "type":"string",
            "description":"Indicates Stl"
        },
        "tax":{
            "type":"string",
            "description":"Indicates Tax"
        },
        "p":{
            "type":"string",
            "description":"Indicates P"
        },
        "exerDetail":{
            "$ref":"#/definitions/ExerDetailDto"
        },
        "contractEventLog":{
            "$ref":"#/definitions/ContractEventLogDto"
        }
    }
}

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 : ContractEventLogDto

Type: object

Show Source

• authstat: string
  Indicates Authorization Status
• chkdttime: string
  Indicates Date Time
• chkr: string
  Indicates Checker
• contractrefno: string
  Indicates Contract Reference
• eventseqno: number
  Indicates ESN
• makdttime: string
  Indicates Date Time
• maker: string
  Indicates Maker
• txnstat: string
  Indicates Contract Status

{
    "type":"object",
    "properties":{
        "maker":{
            "type":"string",
            "description":"Indicates Maker"
        },
        "makdttime":{
            "type":"string",
            "description":"Indicates Date Time"
        },
        "chkr":{
            "type":"string",
            "description":"Indicates Checker"
        },
        "chkdttime":{
            "type":"string",
            "description":"Indicates Date Time"
        },
        "txnstat":{
            "type":"string",
            "description":"Indicates Contract Status"
        },
        "authstat":{
            "type":"string",
            "description":"Indicates Authorization Status"
        },
        "contractrefno":{
            "type":"string",
            "description":"Indicates Contract Reference"
        },
        "eventseqno":{
            "type":"number",
            "description":"Indicates ESN"
        }
    }
}

Nested Schema : ExerDetailDto

Type: object

Show Source

• bswval: number
  Indicates Swap Value
• contref: string
  Indicates Contref
• exerdate: string
  Indicates Exercise Date
• fxprod: string
  Indicates Foreign Exchange Product
• fxreferenceno: string
  Indicates FX Reference
• optionprm: number
  Indicates Option Premium
• premccy: string
  Indicates Currency
• referate: number
  Indicates Reference Rate
• settlamt: number
  Indicates Settlement Amount
• settlccy: string
  Indicates Settlement Currency
• strikprc: number
  Indicates Strike Price

{
    "type":"object",
    "properties":{
        "contref":{
            "type":"string",
            "description":"Indicates Contref"
        },
        "bswval":{
            "type":"number",
            "description":"Indicates Swap Value"
        },
        "referate":{
            "type":"number",
            "description":"Indicates Reference Rate"
        },
        "exerdate":{
            "type":"string",
            "description":"Indicates Exercise Date"
        },
        "settlamt":{
            "type":"number",
            "description":"Indicates Settlement Amount"
        },
        "fxprod":{
            "type":"string",
            "description":"Indicates Foreign Exchange Product"
        },
        "optionprm":{
            "type":"number",
            "description":"Indicates Option Premium"
        },
        "premccy":{
            "type":"string",
            "description":"Indicates Currency"
        },
        "strikprc":{
            "type":"number",
            "description":"Indicates Strike Price"
        },
        "settlccy":{
            "type":"string",
            "description":"Indicates Settlement Currency"
        },
        "fxreferenceno":{
            "type":"string",
            "description":"Indicates FX Reference"
        }
    }
}

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"
        }
    }
}

400 Response

Failed while processing request

401 Response

User Not Authorized

405 Response

Method Not Allowed

500 Response

Internal Server Error

Back to Top