Jump to

• Request
• Response

Operation to CloseFXAffirm

post

/ForeignExchangeContractAffirmationService/ForeignExchangeContractAffirmation/CloseFXAffirm

This operation closes 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 Affirmation Status
• affirmType(optional): string
  Indicates Affirmation Type
• affirmTypeDesc(optional): string
  Indicates Affirmation Type Description
• allowOnlineConfirm(optional): string
  Indicates AllowOnlineConfirm
• authoriseBy(optional): string
  Indicates User Id who has Authorized the creation\modification of Customer Account.
• authStat(optional): string
  Indicates AuthStat
• bookingDate(optional): string
  Indicates Booking Date
• broker(optional): string
  Indicates Broker
• checkerDtStamp(optional): string
  Indicates Checker Date Stamp
• contractRefNo(optional): string
  Indicates Contract Reference
• contstat(optional): string
  Indicates Contstat
• counterparty(optional): string
  Indicates Counterparty
• currency(optional): string
  Indicates Threshold Currency
• latestVersionNo(optional): number
  Indicates LatestVersionNo
• makerDtStamp(optional): string
  Indicates Release Time
• makerId(optional): string
  Indicates Maker ID
• maturityDate(optional): string
  It indictes Maturity Date
• of(optional): string
  Indicates Of
• p(optional): string
  Indicates P
• prnAmt(optional): number
  Indicates Principal Amount
• unconfirmSince(optional): string
  Indicates Unconfirmed Since
• userRefno(optional): string
  Indicates User Reference
• valueDate(optional): string
  Indicates the effective date of the account
• versionNo(optional): number
  Indicates VersionNo
• versionno(optional): string
  Indicates Version
• waiveStatus(optional): 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

CloseFXAffirm Successfully Performed

Body ()

Root Schema : RESTResponse

Type: object

Show Source

• FCUBS_ERROR_RESP(optional): object FCUBSErrorResponse
• FCUBS_WARNING_RESP(optional): object FCUBSWarnResponse
• Ld-Branch-Params-Full(optional): 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(optional): array ERROR

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

Nested Schema : FCUBSWarnResponse

Type: object

Show Source

• WARNING(optional): array WARNING

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

Nested Schema : LdBranchParamsDto

Type: object

Show Source

• accrlvl(optional): string
  Indicates Accrual Level P - Product C - Contract
• apycalc(optional): string
  Indicates Annual Percentage Yield Calculation Required Y - on N - Off
• 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
• fieldsList(optional): array fieldsList
• maker(optional): string
  Indicates Maker
• makerstamp(optional): string
  Indicates Makerstamp
• modno(optional): number
  Indicates Modno
• onceauth(optional): string
  Indicates Onceauth
• proctill(optional): string
  Indicates Process Till Next Working Day - 1 S - System Date N - Next Working Day - 1
• sgenmanliq(optional): string
  Indicates Settlement Message At Manual Liquidation Y - on N - Off
• taxcompbasis(optional): string
  Indicates Tax Basis S - Schedule Amount L - Liquidation Amount
• txnstat(optional): string
  Indicates Txnstat
• udfDetailsList(optional): array udfDetailsList
• usrrefinmsgs(optional): 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(optional): string
• EDESC(optional): 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(optional): string
• WDESC(optional): 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(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