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
• Stfincle-Full: object StfincleDto

{
    "type":"object",
    "properties":{
        "Stfincle-Full":{
            "$ref":"#/definitions/StfincleDto"
        },
        "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 : StfincleDto

Type: object

Show Source

• authstat: string
  Indicates Authstat
• checker: string
  Indicates Checker
• checkerstamp: string
  Indicates Checkerstamp
• description: string
  Indicates Description
• fcEndDate(required): string
  Indicates End Date
• fcStartDate(required): string
  Indicates Start Date
• finCycle(required): string
  Indicates Financial Cycle
• maker: string
  Indicates Maker
• makerstamp: string
  Indicates Makerstamp
• modno: number
  Indicates Modno
• onceauth: string
  Indicates Onceauth
• stprdcdsList: array stprdcdsList
• txnstat: string
  Indicates Txnstat
• udf: string
  Indicates Udf

{
    "type":"object",
    "required":[
        "fcEndDate",
        "fcStartDate",
        "finCycle"
    ],
    "properties":{
        "finCycle":{
            "type":"string",
            "description":"Indicates Financial Cycle"
        },
        "fcStartDate":{
            "type":"string",
            "description":"Indicates Start Date"
        },
        "description":{
            "type":"string",
            "description":"Indicates Description"
        },
        "fcEndDate":{
            "type":"string",
            "description":"Indicates End Date"
        },
        "udf":{
            "type":"string",
            "description":"Indicates Udf"
        },
        "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"
        },
        "stprdcdsList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/StprdcdsDto"
            }
        }
    }
}

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

Type: array

Show Source

• Array of: object StprdcdsDto

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

Nested Schema : StprdcdsDto

Type: object

Show Source

• fcEndDate(required): string
  Indicates End Date
• fcStartDate: string
  Indicates Start Date
• finCycle: string
  Indicates FinCycle
• periodCode(required): string
  Indicates Period Code

{
    "type":"object",
    "required":[
        "fcEndDate",
        "periodCode"
    ],
    "properties":{
        "periodCode":{
            "type":"string",
            "description":"Indicates Period Code"
        },
        "fcStartDate":{
            "type":"string",
            "description":"Indicates Start Date"
        },
        "fcEndDate":{
            "type":"string",
            "description":"Indicates End Date"
        },
        "finCycle":{
            "type":"string",
            "description":"Indicates FinCycle"
        }
    }
}

400 Response

Failed while processing request

401 Response

User Not Authorized

405 Response

Method Not Allowed

500 Response

Internal Server Error

Back to Top