Jump to

• Request
• Response

Operation to CreatePayment

post

/ForeignExchangePaymentService/ForeignExchangePayment/CreatePayment

This operation creates the payment using the Foreign Exchange Payment 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 : PaymentDetailDto

Type: object

Show Source

• authstat(optional): string
  Indicates Authorization Status U - Unauthorized A - Authorized
• botamt(optional): number
  Indicates Bought Amount
• botccy(optional): string
  Indicates Bought Currency
• brn(optional): string
  Indicates Brn
• brokerage(optional): string
  Indicates Brokerage
• buysellind(optional): string
  Indicates Buy / Sell B - Buy S - Sell
• charges(optional): string
  Indicates Charges
• checkerstamp(optional): string
  Indicates Date Time
• checkid(optional): string
  Indicates Checker ID
• contccy(optional): string
  Indicates Currency
• contref(optional): string
  Indicates Contract Reference
• contrefnum(optional): string
  Indicates Contract Reference
• counterparty(optional): string
  Indicates Counterparty
• countrprynam(optional): string
  Indicates Counterparty Name
• dealer(optional): string
  Indicates Dealer
• default1(optional): string
  Indicates Default
• esn(optional): number
  Indicates Event Sequence Number
• esnlog(optional): number
  Indicates ESN
• event(optional): string
  Indicates Event
• evntseqno(optional): number
  Indicates Serial Number
• extrefno(optional): string
  Indicates Source Reference
• fccref(optional): string
  Indicates Contract Reference
• fields(optional): string
  Indicates Fields
• latevnseqno(optional): number
  Indicates Latevnseqno
• latverno(optional): number
  Indicates Latverno
• lcy(optional): number
  Indicates Local Currency
• liqcanc(optional): string
  Indicates Liquidation/Cancellation C - Cancellation L - Liquidation
• makerid(optional): string
  Indicates Maker Id
• makerstamp(optional): string
  Indicates Date Time
• mis(optional): string
  Indicates Mis
• orgbotamt(optional): number
  Indicates Original Bought Amount
• orgbotccy(optional): string
  Indicates Original Bought Currency
• orgexrate(optional): number
  Indicates Original Exchange Rate
• orgsoldamt(optional): number
  Indicates Original Sold Currency
• orgsoldccy(optional): string
  Indicates Original Sold Currency
• outstamt(optional): number
  Indicates Outstanding Amount
• plccy(optional): string
  Indicates Profit and Loss Currency
• prdcd(optional): string
  Indicates Product Code
• premdisamt(optional): number
  Indicates Premium/Discount Amount
• premdiscind(optional): string
  Indicates Premium/Discount
• recalc(optional): string
  Indicates Recalc
• refno: string
  Indicates Reference Number
• rejectReason(optional): string
  Indicates Reject Reason
• remarks(optional): string
  Indicates Remarks
• revcheckerdtstamp(optional): string
  Indicates Date Time
• revcheckerid(optional): string
  Indicates Reversal Checker ID
• reversal(optional): string
  Indicates Reversal
• revlmeth(optional): string
  Indicates Revaluation Method
• revmakerdtstamp(optional): string
  Indicates Date Time
• revmakerid(optional): string
  Indicates Reversal Maker ID
• seqNo(optional): number
  Indicates SeqNo
• sequenceNo(optional): number
  Indicates SequenceNo
• setseqno(optional): number
  Indicates the Settlement Sequence Number
• setseqno2(optional): number
  Indicates Settlement Sequence Number
• settlement(optional): string
  Indicates Settlement
• settlementInstrDesc(optional): string
  Indicates Settlement Instruction Description
• settlementInstrDesc2(optional): string
  Indicates Settlement Instruction Description
• soldamt(optional): number
  Indicates Sold Amount
• soldccy(optional): string
  Indicates Sold Currency
• spotlcye(optional): number
  Indicates Spot Local Currency Equivalent
• subsysstat(optional): string
  Indicates Subsysstat
• swpchrgrt(optional): number
  Indicates Swpchrgrt
• tax(optional): string
  Indicates Tax
• txnstat(optional): string
  Indicates Status A - Active V - Reversed Y - Yet to be Initiated L - Liquidated H - Hold K - Cancelled
• userrefno(optional): string
  Indicates User Reference
• valdt(optional): string
  Indicates Value Date
• verno(optional): number
  Indicates Version Number
• xrate2(optional): number
  Indicates Deal Rate

{
    "type":"object",
    "required":[
        "refno"
    ],
    "properties":{
        "refno":{
            "type":"string",
            "description":"Indicates Reference Number"
        },
        "latevnseqno":{
            "type":"number",
            "description":"Indicates Latevnseqno"
        },
        "userrefno":{
            "type":"string",
            "description":"Indicates User Reference"
        },
        "latverno":{
            "type":"number",
            "description":"Indicates Latverno"
        },
        "prdcd":{
            "type":"string",
            "description":"Indicates Product Code"
        },
        "counterparty":{
            "type":"string",
            "description":"Indicates Counterparty"
        },
        "contccy":{
            "type":"string",
            "description":"Indicates Currency"
        },
        "extrefno":{
            "type":"string",
            "description":"Indicates Source Reference"
        },
        "xrate2":{
            "type":"number",
            "description":"Indicates Deal Rate"
        },
        "revlmeth":{
            "type":"string",
            "description":"Indicates Revaluation Method"
        },
        "spotlcye":{
            "type":"number",
            "description":"Indicates Spot Local Currency Equivalent"
        },
        "dealer":{
            "type":"string",
            "description":"Indicates Dealer"
        },
        "lcy":{
            "type":"number",
            "description":"Indicates Local Currency"
        },
        "esn":{
            "type":"number",
            "description":"Indicates Event Sequence Number"
        },
        "contref":{
            "type":"string",
            "description":"Indicates Contract Reference"
        },
        "verno":{
            "type":"number",
            "description":"Indicates Version Number"
        },
        "buysellind":{
            "type":"string",
            "description":"Indicates Buy / Sell\tB - Buy\tS - Sell"
        },
        "botccy":{
            "type":"string",
            "description":"Indicates Bought Currency"
        },
        "botamt":{
            "type":"number",
            "description":"Indicates Bought Amount"
        },
        "soldccy":{
            "type":"string",
            "description":"Indicates Sold Currency"
        },
        "plccy":{
            "type":"string",
            "description":"Indicates Profit and Loss Currency"
        },
        "soldamt":{
            "type":"number",
            "description":"Indicates Sold Amount"
        },
        "fccref":{
            "type":"string",
            "description":"Indicates Contract Reference"
        },
        "makerid":{
            "type":"string",
            "description":"Indicates Maker Id"
        },
        "makerstamp":{
            "type":"string",
            "description":"Indicates Date Time"
        },
        "checkid":{
            "type":"string",
            "description":"Indicates Checker ID"
        },
        "checkerstamp":{
            "type":"string",
            "description":"Indicates Date Time"
        },
        "esnlog":{
            "type":"number",
            "description":"Indicates ESN"
        },
        "txnstat":{
            "type":"string",
            "description":"Indicates Status\tA - Active\tV - Reversed\tY - Yet to be Initiated\tL - Liquidated\tH - Hold\tK - Cancelled"
        },
        "authstat":{
            "type":"string",
            "description":"Indicates Authorization Status\tU - Unauthorized\tA - Authorized"
        },
        "contrefnum":{
            "type":"string",
            "description":"Indicates Contract Reference"
        },
        "evntseqno":{
            "type":"number",
            "description":"Indicates Serial Number"
        },
        "orgbotccy":{
            "type":"string",
            "description":"Indicates Original Bought Currency"
        },
        "orgsoldccy":{
            "type":"string",
            "description":"Indicates Original Sold Currency"
        },
        "orgbotamt":{
            "type":"number",
            "description":"Indicates Original Bought Amount"
        },
        "orgsoldamt":{
            "type":"number",
            "description":"Indicates Original Sold Currency"
        },
        "orgexrate":{
            "type":"number",
            "description":"Indicates Original Exchange Rate"
        },
        "remarks":{
            "type":"string",
            "description":"Indicates Remarks"
        },
        "valdt":{
            "type":"string",
            "description":"Indicates Value Date"
        },
        "outstamt":{
            "type":"number",
            "description":"Indicates Outstanding Amount"
        },
        "liqcanc":{
            "type":"string",
            "description":"Indicates Liquidation/Cancellation\tC - Cancellation\tL - Liquidation"
        },
        "premdisamt":{
            "type":"number",
            "description":"Indicates Premium/Discount Amount"
        },
        "premdiscind":{
            "type":"string",
            "description":"Indicates Premium/Discount"
        },
        "subsysstat":{
            "type":"string",
            "description":"Indicates Subsysstat"
        },
        "default1":{
            "type":"string",
            "description":"Indicates Default"
        },
        "recalc":{
            "type":"string",
            "description":"Indicates Recalc"
        },
        "revcheckerid":{
            "type":"string",
            "description":"Indicates Reversal Checker ID"
        },
        "revmakerid":{
            "type":"string",
            "description":"Indicates Reversal Maker ID"
        },
        "revcheckerdtstamp":{
            "type":"string",
            "description":"Indicates Date Time"
        },
        "revmakerdtstamp":{
            "type":"string",
            "description":"Indicates Date Time"
        },
        "reversal":{
            "type":"string",
            "description":"Indicates Reversal"
        },
        "event":{
            "type":"string",
            "description":"Indicates Event"
        },
        "brokerage":{
            "type":"string",
            "description":"Indicates Brokerage"
        },
        "settlement":{
            "type":"string",
            "description":"Indicates Settlement"
        },
        "charges":{
            "type":"string",
            "description":"Indicates Charges"
        },
        "tax":{
            "type":"string",
            "description":"Indicates Tax"
        },
        "mis":{
            "type":"string",
            "description":"Indicates Mis"
        },
        "fields":{
            "type":"string",
            "description":"Indicates Fields"
        },
        "countrprynam":{
            "type":"string",
            "description":"Indicates Counterparty Name"
        },
        "brn":{
            "type":"string",
            "description":"Indicates Brn"
        },
        "rejectReason":{
            "type":"string",
            "description":"Indicates Reject Reason"
        },
        "settlementInstrDesc":{
            "type":"string",
            "description":"Indicates Settlement Instruction Description"
        },
        "settlementInstrDesc2":{
            "type":"string",
            "description":"Indicates Settlement Instruction Description"
        },
        "seqNo":{
            "type":"number",
            "description":"Indicates SeqNo"
        },
        "sequenceNo":{
            "type":"number",
            "description":"Indicates SequenceNo"
        },
        "setseqno":{
            "type":"number",
            "description":"Indicates the Settlement Sequence Number"
        },
        "setseqno2":{
            "type":"number",
            "description":"Indicates Settlement Sequence Number"
        },
        "swpchrgrt":{
            "type":"number",
            "description":"Indicates Swpchrgrt"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

successful operation

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

201 Response

CreatePayment Successfully Performed

400 Response

Failed while processing request

401 Response

User Not Authorized

405 Response

Method Not Allowed

500 Response

Internal Server Error

Back to Top