Jump to

• Request
• Response

Operation to AuthorizePayment

post

/ForeignExchangePaymentService/ForeignExchangePayment/AuthorizePayment

This operation authorizes the Foreign Exchange Payment contract using ForeignExchangePayment 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 : PaymentDetailDto

Type: object

Show Source

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

AuthorizePayment 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