Jump to

• Request
• Response

Operation to CreateFXLink

post

/FXLinkService/FXLink/CreateFXLink

This operation creates the FX link.

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

Type: object

Show Source

• action(required): string
  Indicates Action
• buysell(required): string
  Indicates Buysell
• counterparty: number
  Indicates Counterparty
• exchRate: number
  Indicates ExchRate
• fxReferenceNo(required): string
  Indicates FxReferenceNo
• initiateDlnk: string
  Indicates InitiateDlnk
• linkedReferenceNo(required): string
  Indicates Linked Reference No
• linkedSeqNo: number
  Indicates LinkedSeqNo
• moduleCode: string
  Indicates Module Code
• rejectReason: string
  Indicates RejectReason
• sourceSystem(required): string
  Indicates Source Code
• txnAmt(required): number
  Indicates TxnAmt
• txnCcy(required): string
  Indicates TxnCcy
• txnDate(required): string
  Indicates TxnDate

{
    "type":"object",
    "required":[
        "action",
        "buysell",
        "fxReferenceNo",
        "linkedReferenceNo",
        "sourceSystem",
        "txnAmt",
        "txnCcy",
        "txnDate"
    ],
    "properties":{
        "fxReferenceNo":{
            "type":"string",
            "description":"Indicates FxReferenceNo"
        },
        "linkedReferenceNo":{
            "type":"string",
            "description":"Indicates Linked Reference No"
        },
        "linkedSeqNo":{
            "type":"number",
            "description":"Indicates LinkedSeqNo"
        },
        "sourceSystem":{
            "type":"string",
            "description":"Indicates Source Code"
        },
        "moduleCode":{
            "type":"string",
            "description":"Indicates Module Code"
        },
        "action":{
            "type":"string",
            "description":"Indicates Action"
        },
        "buysell":{
            "type":"string",
            "description":"Indicates Buysell"
        },
        "txnCcy":{
            "type":"string",
            "description":"Indicates TxnCcy"
        },
        "txnAmt":{
            "type":"number",
            "description":"Indicates TxnAmt"
        },
        "txnDate":{
            "type":"string",
            "description":"Indicates TxnDate"
        },
        "counterparty":{
            "type":"number",
            "description":"Indicates  Counterparty"
        },
        "exchRate":{
            "type":"number",
            "description":"Indicates ExchRate"
        },
        "rejectReason":{
            "type":"string",
            "description":"Indicates RejectReason"
        },
        "initiateDlnk":{
            "type":"string",
            "description":"Indicates InitiateDlnk"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

CreateFXLink 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