Jump to

• Request
• Response

Operation to AuthorizeDVManulPay

post

/DerivativesManualPaymentService/DerivativesManualPayment/AuthorizeDVManulPay

This operation authorizes the Derivatives Manual Payment using Derivatives Manual Payment 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 : PayMasterDto

Type: object

Show Source

• advice: string
  Indicates Advice
• advices: object AdvicesDto
• amtsett: number
  Indicates Amtsett
• authby: string
  Indicates Authby
• authbydt: string
  Indicates Authbydt
• authstat: string
  Indicates Authstat
• contractRefNo(required): string
  Indicates ContractRefNo
• counterparty: string
  Indicates Counterparty
• counterprtyname: string
  Indicates Counterprtyname
• default1: string
  Indicates Default
• duebreakupList: array duebreakupList
• inptby: string
  Indicates Inptby
• inptdt: string
  Indicates Inptdt
• latestEventSeqNo: number
  Indicates LatestEventSeqNo
• payrem: string
  Indicates Payrem
• prddesc: string
  Indicates Prddesc
• product: string
  Indicates Product
• settlement: string
  Indicates Settlement
• settlements: object SettlementsDto
• subsysstat: string
  Indicates Subsysstat
• transactionDate: string
  Indicates TransactionDate
• transactionRefNo: string
  Indicates TransactionRefNo
• txnstat: string
  Indicates Txnstat
• valueDate(required): string
  Indicates ValueDate

{
    "type":"object",
    "required":[
        "contractRefNo",
        "valueDate"
    ],
    "properties":{
        "default1":{
            "type":"string",
            "description":"Indicates Default"
        },
        "settlement":{
            "type":"string",
            "description":"Indicates Settlement"
        },
        "advice":{
            "type":"string",
            "description":"Indicates Advice"
        },
        "prddesc":{
            "type":"string",
            "description":"Indicates Prddesc"
        },
        "contractRefNo":{
            "type":"string",
            "description":"Indicates ContractRefNo"
        },
        "counterparty":{
            "type":"string",
            "description":"Indicates Counterparty"
        },
        "amtsett":{
            "type":"number",
            "description":"Indicates Amtsett"
        },
        "latestEventSeqNo":{
            "type":"number",
            "description":"Indicates LatestEventSeqNo"
        },
        "payrem":{
            "type":"string",
            "description":"Indicates Payrem"
        },
        "transactionRefNo":{
            "type":"string",
            "description":"Indicates TransactionRefNo"
        },
        "product":{
            "type":"string",
            "description":"Indicates Product"
        },
        "transactionDate":{
            "type":"string",
            "description":"Indicates TransactionDate"
        },
        "valueDate":{
            "type":"string",
            "description":"Indicates ValueDate"
        },
        "counterprtyname":{
            "type":"string",
            "description":"Indicates Counterprtyname"
        },
        "subsysstat":{
            "type":"string",
            "description":"Indicates Subsysstat"
        },
        "authstat":{
            "type":"string",
            "description":"Indicates Authstat"
        },
        "authbydt":{
            "type":"string",
            "description":"Indicates Authbydt"
        },
        "authby":{
            "type":"string",
            "description":"Indicates Authby"
        },
        "txnstat":{
            "type":"string",
            "description":"Indicates Txnstat"
        },
        "inptdt":{
            "type":"string",
            "description":"Indicates Inptdt"
        },
        "inptby":{
            "type":"string",
            "description":"Indicates Inptby"
        },
        "duebreakupList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DuebreakupDto"
            }
        },
        "settlements":{
            "$ref":"#/definitions/SettlementsDto"
        },
        "advices":{
            "$ref":"#/definitions/AdvicesDto"
        }
    }
}

Nested Schema : AdvicesDto

Type: object

Show Source

• chgreqd: string
  Indicates Charges Y - on N - Off
• desc: string
  Indicates Advice Name Description
• gentime: string
  Allowed Values: [ "I", "A" ]

  Indicates Generation Time A - Authorize
• msgtyp(required): string
  Indicates Advice Name
• prior: number
  Indicates Priority 3 - High 2 - Medium 1 - Low
• suprs: string
  Allowed Values: [ "Y", "N" ]

  Indicates Suppress Y - Yes N - No

{
    "type":"object",
    "required":[
        "msgtyp"
    ],
    "properties":{
        "msgtyp":{
            "type":"string",
            "description":"Indicates Advice Name"
        },
        "desc":{
            "type":"string",
            "description":"Indicates Advice Name Description"
        },
        "gentime":{
            "type":"string",
            "description":"Indicates Generation Time\tA - Authorize",
            "enum":[
                "I",
                "A"
            ]
        },
        "suprs":{
            "type":"string",
            "description":"Indicates Suppress\tY - Yes\tN - No",
            "enum":[
                "Y",
                "N"
            ]
        },
        "prior":{
            "type":"number",
            "description":"Indicates Priority\t3 - High\t2 - Medium\t1 - Low"
        },
        "chgreqd":{
            "type":"string",
            "description":"Indicates Charges\tY - on\tN - Off"
        }
    }
}

Nested Schema : duebreakupList

Type: array

Show Source

• Array of: object DuebreakupDto

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

Nested Schema : SettlementsDto

Type: object

Show Source

• compnt: string
  Indicates Compnt
• conrefno(required): string
  Indicates Contract Reference
• contractSettlementList: array contractSettlementList
• extExchangeRateList: array extExchangeRateList
• latevnseqno: number
  Indicates Latevnseqno

{
    "type":"object",
    "required":[
        "conrefno"
    ],
    "properties":{
        "conrefno":{
            "type":"string",
            "description":"Indicates Contract Reference"
        },
        "latevnseqno":{
            "type":"number",
            "description":"Indicates Latevnseqno"
        },
        "compnt":{
            "type":"string",
            "description":"Indicates Compnt"
        },
        "contractSettlementList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ContractSettlementDto"
            }
        },
        "extExchangeRateList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ExtExchangeRateDto"
            }
        }
    }
}

Nested Schema : DuebreakupDto

Type: object

Show Source

• amountDue: number
  Indicates AmountDue
• amountOverdue: number
  Indicates AmountOverdue
• component: string
  Indicates Component
• componentCcy: string
  Indicates ComponentCcy
• contractRefNo: string
  Indicates ContractRefNo
• eventSeqNo: number
  Indicates EventSeqNo
• paymentMasterRefNo: string
  Indicates PaymentMasterRefNo
• payReceive: string
  Indicates PayReceive
• totalDue: number
  Indicates TotalDue

{
    "type":"object",
    "properties":{
        "amountDue":{
            "type":"number",
            "description":"Indicates AmountDue"
        },
        "amountOverdue":{
            "type":"number",
            "description":"Indicates AmountOverdue"
        },
        "totalDue":{
            "type":"number",
            "description":"Indicates TotalDue"
        },
        "component":{
            "type":"string",
            "description":"Indicates Component"
        },
        "componentCcy":{
            "type":"string",
            "description":"Indicates ComponentCcy"
        },
        "contractRefNo":{
            "type":"string",
            "description":"Indicates ContractRefNo"
        },
        "paymentMasterRefNo":{
            "type":"string",
            "description":"Indicates PaymentMasterRefNo"
        },
        "payReceive":{
            "type":"string",
            "description":"Indicates PayReceive"
        },
        "eventSeqNo":{
            "type":"number",
            "description":"Indicates EventSeqNo"
        }
    }
}

Nested Schema : contractSettlementList

Type: array

Show Source

• Array of: object ContractSettlementDto

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

Nested Schema : extExchangeRateList

Type: array

Show Source

• Array of: object ExtExchangeRateDto

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

Nested Schema : ContractSettlementDto

Type: object

Show Source

• acc: string
  Indicates Acc
• accbrn: string
  Indicates Account Branch
• accccy: string
  Indicates Account Currency
• accDesc: string
  Indicates Account Description
• accwithinst1: string
  Indicates Account with Institution 1
• accwithinst2: string
  Indicates Account with Institution 2
• accwithinst3: string
  Indicates Account with Institution 3
• accwithinst4: string
  Indicates Account with Institution 4
• accwithinst5: string
  Indicates Account with Institution 5
• accwithinst6: string
  Indicates Country
• agid: string
  Indicates Agreement Id
• bankprior: string
  Allowed Values: [ "U", "N", "H" ]

  Indicates Banking Priority U - Urgent Payment N - Normal Payment H - Highly Urgent Payments
• beninst1: string
  Indicates Beneficiary Institution 1
• beninst2: string
  Indicates Beneficiary Institution 2
• beninst3: string
  Indicates Beneficiary Institution 3
• beninst4: string
  Indicates Beneficiary Institution 4
• beninst5: string
  Indicates Beneficiary Institution 5
• beninst6: string
  Indicates Country
• chgdet: string
  Indicates Details Of Charge B - Beneficiary - All Charges U - Remitter our Charges O - Remitter all Charges
• compnt: string
  Indicates Component
• countracprefix: string
  Indicates Countracprefix
• countrflg: string
  Indicates Countrflg
• countrprdcat: string
  Indicates Countrprdcat
• countrpryacc: string
  Indicates Counterparty Account
• countrprybic: string
  Indicates Counterparty Bank
• countrprynam: string
  Indicates Counterparty Name
• countrstid: string
  Indicates Countrstid
• custspread: number
  Indicates Customer Spread
• drcrind: string
  Allowed Values: [ "P", "R" ]

  Indicates Debit/Credit P - Credit R - Debit
• eriamt: number
  Indicates Euro In Amount
• ericcy: string
  Indicates Euro In Currency
• exrate: number
  Indicates Exchange Rate
• genmsg: string
  Indicates Generate Message N - Off Y - on
• ibanacno: string
  Indicates IBAN Account Number
• insno: string
  Indicates Number
• instrumentTacInfo1: string
  Indicates InstrumentTacInfo1
• instrumentTacInfo2: string
  Indicates InstrumentTacInfo2
• instrumentTacInfo3: string
  Indicates InstrumentTacInfo3
• instrumentTacInfo4: string
  Indicates InstrumentTacInfo4
• instrumentTacInfo5: string
  Indicates InstrumentTacInfo5
• instrumentTacInfo6: string
  Indicates InstrumentTacInfo6
• instyp: string
  Allowed Values: [ "DRAFT", "CHECK", "MCK" ]

  Indicates Type
• intermediary1: string
  Indicates Intermediary 1
• intermediary2: string
  Indicates Intermediary 2
• intermediary3: string
  Indicates Intermediary 3
• intermediary4: string
  Indicates Intermediary 4
• intermediary5: string
  Indicates Intermediary 5
• intermediary6: string
  Indicates Country
• negorefno: string
  Indicates Negotiation Reference
• negotiatedrate: number
  Indicates Negotiated Cost Rate
• netind: string
  Indicates Netting Indicator N - Off Y - on
• ordcust1: string
  Indicates Ordering Customer 1
• ordcust2: string
  Indicates Ordering Customer 2
• ordcust3: string
  Indicates Ordering Customer 3
• ordcust4: string
  Indicates Ordering Customer 4
• ordcust5: string
  Indicates Ordering Customer 5
• ordcust6: string
  Indicates Country
• ordinst1: string
  Indicates Ordering Institution 1
• ordinst2: string
  Indicates Ordering Institution 2
• ordinst3: string
  Indicates Ordering Institution 3
• ordinst4: string
  Indicates Ordering Institution 4
• ordinst5: string
  Indicates Ordering Institution 5
• ordinst6: string
  Indicates Country
• orgexchrate: number
  Indicates Original Exchange Rate
• payablebank: string
  Indicates Payablebank
• payablebranch: string
  Indicates Payablebranch
• payby: string
  Indicates Payment By I - Instrument C - Clearing M - Message
• paymntdet1: string
  Indicates Details of Payment 1
• paymntdet2: string
  Indicates Details of Payment 2
• paymntdet3: string
  Indicates Details of Payment 3
• paymntdet4: string
  Indicates Details of Payment 4
• posacc: string
  Indicates Post Accounting N - Off Y - on
• ratecd: string
  Allowed Values: [ "B", "M", "S" ]

  Indicates Rate Code B - Buy M - Mid Rate S - Sell
• rcorrs15: string
  Indicates Correspondent 5
• rcvrcorrs1: string
  Indicates Correspondent 1
• rcvrcorrs2: string
  Indicates Correspondent 2
• rcvrcorrs3: string
  Indicates Correspondent 3
• rcvrcorrs4: string
  Indicates Correspondent 4
• rcvrcorrs6: string
  Indicates Country
• receiver: string
  Indicates Receiver
• recvcvr: string
  Indicates Receiver of Cover
• reiminst1: string
  Indicates Reimburse Institution 1
• reiminst2: string
  Indicates Reimburse Institution 2
• reiminst3: string
  Indicates Reimburse Institution 3
• reiminst4: string
  Indicates Reimburse Institution 4
• reiminst5: string
  Indicates Reimburse Institution 5
• reiminst6: string
  Indicates Country
• reportingDtlsAddlinfo1: string
  Indicates ReportingDtlsAddlinfo1
• reportingDtlsAddlinfo2: string
  Indicates ReportingDtlsAddlinfo2
• reportingDtlsAddlinfo3: string
  Indicates ReportingDtlsAddlinfo3
• reportingDtlsAddlinfo4: string
  Indicates ReportingDtlsAddlinfo4
• reportingDtlsAddlinfo5: string
  Indicates ReportingDtlsAddlinfo5
• reportingDtlsAddlinfo6: string
  Indicates ReportingDtlsAddlinfo6
• rtgsnw: string
  Indicates RTGS Network
• settlementDetailList: array settlementDetailList
• sndrtorecv1Cvr: string
  Indicates Sndrtorecv1Cvr
• sndrtorecv2Cvr: string
  Indicates Sndrtorecv2Cvr
• sndrtorecv3Cvr: string
  Indicates Sndrtorecv3Cvr
• sndrtorecv4Cvr: string
  Indicates Sndrtorecv4Cvr
• sndrtorecv5Cvr: string
  Indicates Sndrtorecv5Cvr
• sndrtorecv6: string
  Indicates Information 6
• sndrtorecv6Cvr: string
  Indicates Sndrtorecv6Cvr
• sndtrrcvinfo1: string
  Indicates Information 1
• sndtrrcvinfo2: string
  Indicates Information 2
• sndtrrcvinfo3: string
  Indicates Information 3
• sndtrrcvinfo4: string
  Indicates Information 4
• sndtrrcvinfo5: string
  Indicates Information 5
• source: string
  Indicates Source
• spreaddefn: string
  Allowed Values: [ "A", "B" ]

  Indicates Spread Definition A - Point B - Percentage
• sv: string
  Indicates Sv
• tagccy: string
  Indicates Currency
• transtyp: string
  Allowed Values: [ "C", "O", "B", "D", "M", "X" ]

  Indicates Transfer Type C - Customer Transfer O - Bank Transfer for Own Account B - Bank Transfer D - Direct Debit Advice M - Managers Check X - None V - Customer Transfer With Cover
• ultben1: string
  Indicates Ultimate Beneficiary 1
• ultben2: string
  Indicates Ultimate Beneficiary 2
• ultben3: string
  Indicates Ultimate Beneficiary 3
• ultben4: string
  Indicates Ultimate Beneficiary 4
• ultben5: string
  Indicates Ultimate Beneficiary 5
• ultben6: string
  Indicates Country
• waiveinstcharges: string
  Indicates Waiveinstcharges

{
    "type":"object",
    "properties":{
        "ibanacno":{
            "type":"string",
            "description":"Indicates IBAN Account Number"
        },
        "custspread":{
            "type":"number",
            "description":"Indicates Customer Spread"
        },
        "spreaddefn":{
            "type":"string",
            "description":"Indicates Spread Definition\tA - Point\tB - Percentage",
            "enum":[
                "A",
                "B"
            ]
        },
        "compnt":{
            "type":"string",
            "description":"Indicates Component"
        },
        "tagccy":{
            "type":"string",
            "description":"Indicates Currency"
        },
        "accbrn":{
            "type":"string",
            "description":"Indicates Account Branch"
        },
        "accccy":{
            "type":"string",
            "description":"Indicates Account Currency"
        },
        "exrate":{
            "type":"number",
            "description":"Indicates Exchange Rate"
        },
        "netind":{
            "type":"string",
            "description":"Indicates Netting Indicator\tN - Off\tY - on"
        },
        "ericcy":{
            "type":"string",
            "description":"Indicates Euro In Currency"
        },
        "eriamt":{
            "type":"number",
            "description":"Indicates Euro In Amount"
        },
        "genmsg":{
            "type":"string",
            "description":"Indicates Generate Message\tN - Off\tY - on"
        },
        "ratecd":{
            "type":"string",
            "description":"Indicates Rate Code\tB - Buy\tM - Mid Rate\tS - Sell",
            "enum":[
                "B",
                "M",
                "S"
            ]
        },
        "sv":{
            "type":"string",
            "description":"Indicates Sv"
        },
        "bankprior":{
            "type":"string",
            "description":"Indicates Banking Priority\tU - Urgent Payment\tN - Normal Payment\tH - Highly Urgent Payments",
            "enum":[
                "U",
                "N",
                "H"
            ]
        },
        "rtgsnw":{
            "type":"string",
            "description":"Indicates RTGS Network"
        },
        "payby":{
            "type":"string",
            "description":"Indicates Payment By\tI - Instrument\tC - Clearing\tM - Message"
        },
        "transtyp":{
            "type":"string",
            "description":"Indicates Transfer Type\tC - Customer Transfer\tO - Bank Transfer for Own Account\tB - Bank Transfer\tD - Direct Debit Advice\tM - Managers Check\tX - None\tV - Customer Transfer With Cover",
            "enum":[
                "C",
                "O",
                "B",
                "D",
                "M",
                "X"
            ]
        },
        "instyp":{
            "type":"string",
            "description":"Indicates Type",
            "enum":[
                "DRAFT",
                "CHECK",
                "MCK"
            ]
        },
        "insno":{
            "type":"string",
            "description":"Indicates Number"
        },
        "chgdet":{
            "type":"string",
            "description":"Indicates Details Of Charge\tB - Beneficiary - All Charges\tU - Remitter our Charges\tO - Remitter all Charges"
        },
        "paymntdet1":{
            "type":"string",
            "description":"Indicates Details of Payment 1"
        },
        "paymntdet2":{
            "type":"string",
            "description":"Indicates Details of Payment 2"
        },
        "paymntdet3":{
            "type":"string",
            "description":"Indicates Details of Payment 3"
        },
        "paymntdet4":{
            "type":"string",
            "description":"Indicates Details of Payment 4"
        },
        "sndtrrcvinfo1":{
            "type":"string",
            "description":"Indicates Information 1"
        },
        "sndtrrcvinfo2":{
            "type":"string",
            "description":"Indicates Information 2"
        },
        "sndtrrcvinfo3":{
            "type":"string",
            "description":"Indicates Information 3"
        },
        "sndtrrcvinfo4":{
            "type":"string",
            "description":"Indicates Information 4"
        },
        "sndtrrcvinfo5":{
            "type":"string",
            "description":"Indicates Information 5"
        },
        "recvcvr":{
            "type":"string",
            "description":"Indicates Receiver of Cover"
        },
        "receiver":{
            "type":"string",
            "description":"Indicates Receiver"
        },
        "reiminst1":{
            "type":"string",
            "description":"Indicates Reimburse Institution 1"
        },
        "reiminst2":{
            "type":"string",
            "description":"Indicates Reimburse Institution 2"
        },
        "reiminst3":{
            "type":"string",
            "description":"Indicates Reimburse Institution 3"
        },
        "reiminst4":{
            "type":"string",
            "description":"Indicates Reimburse Institution 4"
        },
        "rcvrcorrs1":{
            "type":"string",
            "description":"Indicates Correspondent 1"
        },
        "rcvrcorrs2":{
            "type":"string",
            "description":"Indicates Correspondent 2"
        },
        "rcvrcorrs3":{
            "type":"string",
            "description":"Indicates Correspondent 3"
        },
        "rcvrcorrs4":{
            "type":"string",
            "description":"Indicates Correspondent 4"
        },
        "intermediary1":{
            "type":"string",
            "description":"Indicates Intermediary 1"
        },
        "intermediary2":{
            "type":"string",
            "description":"Indicates Intermediary 2"
        },
        "intermediary3":{
            "type":"string",
            "description":"Indicates Intermediary 3"
        },
        "intermediary4":{
            "type":"string",
            "description":"Indicates Intermediary 4"
        },
        "accwithinst1":{
            "type":"string",
            "description":"Indicates Account with Institution 1"
        },
        "accwithinst2":{
            "type":"string",
            "description":"Indicates Account with Institution 2"
        },
        "accwithinst3":{
            "type":"string",
            "description":"Indicates Account with Institution 3"
        },
        "accwithinst4":{
            "type":"string",
            "description":"Indicates Account with Institution 4"
        },
        "ordinst1":{
            "type":"string",
            "description":"Indicates Ordering Institution 1"
        },
        "ordinst2":{
            "type":"string",
            "description":"Indicates Ordering Institution 2"
        },
        "ordinst3":{
            "type":"string",
            "description":"Indicates Ordering Institution 3"
        },
        "ordinst4":{
            "type":"string",
            "description":"Indicates Ordering Institution 4"
        },
        "ordcust1":{
            "type":"string",
            "description":"Indicates Ordering Customer 1"
        },
        "ordcust2":{
            "type":"string",
            "description":"Indicates Ordering Customer 2"
        },
        "ordcust3":{
            "type":"string",
            "description":"Indicates Ordering Customer 3"
        },
        "ordcust4":{
            "type":"string",
            "description":"Indicates Ordering Customer 4"
        },
        "beninst1":{
            "type":"string",
            "description":"Indicates Beneficiary Institution 1"
        },
        "beninst2":{
            "type":"string",
            "description":"Indicates Beneficiary Institution 2"
        },
        "beninst3":{
            "type":"string",
            "description":"Indicates Beneficiary Institution 3"
        },
        "beninst4":{
            "type":"string",
            "description":"Indicates Beneficiary Institution 4"
        },
        "ultben1":{
            "type":"string",
            "description":"Indicates Ultimate Beneficiary 1"
        },
        "ultben2":{
            "type":"string",
            "description":"Indicates Ultimate Beneficiary 2"
        },
        "ultben3":{
            "type":"string",
            "description":"Indicates Ultimate Beneficiary 3"
        },
        "ultben4":{
            "type":"string",
            "description":"Indicates Ultimate Beneficiary 4"
        },
        "countracprefix":{
            "type":"string",
            "description":"Indicates Countracprefix"
        },
        "countrprdcat":{
            "type":"string",
            "description":"Indicates Countrprdcat"
        },
        "countrstid":{
            "type":"string",
            "description":"Indicates Countrstid"
        },
        "source":{
            "type":"string",
            "description":"Indicates Source"
        },
        "countrprybic":{
            "type":"string",
            "description":"Indicates Counterparty Bank"
        },
        "countrpryacc":{
            "type":"string",
            "description":"Indicates Counterparty Account"
        },
        "countrprynam":{
            "type":"string",
            "description":"Indicates Counterparty Name"
        },
        "agid":{
            "type":"string",
            "description":"Indicates Agreement Id"
        },
        "posacc":{
            "type":"string",
            "description":"Indicates Post Accounting\tN - Off\tY - on"
        },
        "countrflg":{
            "type":"string",
            "description":"Indicates Countrflg"
        },
        "sndrtorecv6":{
            "type":"string",
            "description":"Indicates Information 6"
        },
        "accwithinst5":{
            "type":"string",
            "description":"Indicates Account with Institution 5"
        },
        "beninst5":{
            "type":"string",
            "description":"Indicates Beneficiary Institution 5"
        },
        "intermediary5":{
            "type":"string",
            "description":"Indicates Intermediary 5"
        },
        "reiminst5":{
            "type":"string",
            "description":"Indicates Reimburse Institution 5"
        },
        "rcorrs15":{
            "type":"string",
            "description":"Indicates Correspondent 5"
        },
        "ordcust5":{
            "type":"string",
            "description":"Indicates Ordering Customer 5"
        },
        "ordinst5":{
            "type":"string",
            "description":"Indicates Ordering Institution 5"
        },
        "ultben5":{
            "type":"string",
            "description":"Indicates Ultimate Beneficiary 5"
        },
        "drcrind":{
            "type":"string",
            "description":"Indicates Debit/Credit\tP - Credit\tR - Debit",
            "enum":[
                "P",
                "R"
            ]
        },
        "accDesc":{
            "type":"string",
            "description":"Indicates Account Description"
        },
        "orgexchrate":{
            "type":"number",
            "description":"Indicates Original Exchange Rate"
        },
        "negotiatedrate":{
            "type":"number",
            "description":"Indicates Negotiated Cost Rate"
        },
        "negorefno":{
            "type":"string",
            "description":"Indicates Negotiation Reference"
        },
        "ordinst6":{
            "type":"string",
            "description":"Indicates Country"
        },
        "ordcust6":{
            "type":"string",
            "description":"Indicates Country"
        },
        "beninst6":{
            "type":"string",
            "description":"Indicates Country"
        },
        "ultben6":{
            "type":"string",
            "description":"Indicates Country"
        },
        "reiminst6":{
            "type":"string",
            "description":"Indicates Country"
        },
        "intermediary6":{
            "type":"string",
            "description":"Indicates Country"
        },
        "rcvrcorrs6":{
            "type":"string",
            "description":"Indicates Country"
        },
        "accwithinst6":{
            "type":"string",
            "description":"Indicates Country"
        },
        "payablebank":{
            "type":"string",
            "description":"Indicates Payablebank"
        },
        "waiveinstcharges":{
            "type":"string",
            "description":"Indicates Waiveinstcharges"
        },
        "payablebranch":{
            "type":"string",
            "description":"Indicates Payablebranch"
        },
        "acc":{
            "type":"string",
            "description":"Indicates Acc"
        },
        "sndrtorecv1Cvr":{
            "type":"string",
            "description":"Indicates Sndrtorecv1Cvr"
        },
        "sndrtorecv2Cvr":{
            "type":"string",
            "description":"Indicates Sndrtorecv2Cvr"
        },
        "sndrtorecv3Cvr":{
            "type":"string",
            "description":"Indicates Sndrtorecv3Cvr"
        },
        "sndrtorecv4Cvr":{
            "type":"string",
            "description":"Indicates Sndrtorecv4Cvr"
        },
        "sndrtorecv5Cvr":{
            "type":"string",
            "description":"Indicates Sndrtorecv5Cvr"
        },
        "sndrtorecv6Cvr":{
            "type":"string",
            "description":"Indicates Sndrtorecv6Cvr"
        },
        "instrumentTacInfo1":{
            "type":"string",
            "description":"Indicates InstrumentTacInfo1"
        },
        "instrumentTacInfo2":{
            "type":"string",
            "description":"Indicates InstrumentTacInfo2"
        },
        "instrumentTacInfo3":{
            "type":"string",
            "description":"Indicates InstrumentTacInfo3"
        },
        "instrumentTacInfo4":{
            "type":"string",
            "description":"Indicates InstrumentTacInfo4"
        },
        "instrumentTacInfo5":{
            "type":"string",
            "description":"Indicates InstrumentTacInfo5"
        },
        "instrumentTacInfo6":{
            "type":"string",
            "description":"Indicates InstrumentTacInfo6"
        },
        "reportingDtlsAddlinfo1":{
            "type":"string",
            "description":"Indicates ReportingDtlsAddlinfo1"
        },
        "reportingDtlsAddlinfo2":{
            "type":"string",
            "description":"Indicates ReportingDtlsAddlinfo2"
        },
        "reportingDtlsAddlinfo3":{
            "type":"string",
            "description":"Indicates ReportingDtlsAddlinfo3"
        },
        "reportingDtlsAddlinfo4":{
            "type":"string",
            "description":"Indicates ReportingDtlsAddlinfo4"
        },
        "reportingDtlsAddlinfo5":{
            "type":"string",
            "description":"Indicates ReportingDtlsAddlinfo5"
        },
        "reportingDtlsAddlinfo6":{
            "type":"string",
            "description":"Indicates ReportingDtlsAddlinfo6"
        },
        "settlementDetailList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SettlementDetailDto"
            }
        }
    }
}

Nested Schema : settlementDetailList

Type: array

Show Source

• Array of: object SettlementDetailDto

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

Nested Schema : SettlementDetailDto

Type: object

Show Source

• bankopercd: string
  Allowed Values: [ "SPAY", "SPRI", "CRED", "SSTD" ]

  Indicates Bank Operation Code SPAY - SPAY SPRI - SPRI CRED - CRED SSTD - SSTD
• compnt: string
  Indicates Compnt
• contrefno: string
  Indicates Contrefno
• envcont1: string
  Indicates Envelope Contents 1
• envcont2: string
  Indicates Envelope Contents 2
• envcont3: string
  Indicates Envelope Contents 3
• envcont4: string
  Indicates Envelope Contents 4
• envcont5: string
  Indicates Envelope Contents 5
• esn: number
  Indicates Esn
• instrcd: string
  Indicates Instruction Code 6
• instrcd1: string
  Indicates Instruction Code 1
• instrcd2: string
  Indicates Instruction Code 2
• instrcd3: string
  Indicates Instruction Code 3
• instrcd4: string
  Indicates Instruction Code 4
• instrcd5: string
  Indicates Instruction Code 5
• itimeind1: string
  Indicates Time Indicator 1
• itimeind2: string
  Indicates Time Indicator 2
• itimeind3: string
  Indicates Time Indicator 3
• regrep1: string
  Indicates Regulatory Report 1 /ORDERRES/ - /ORDERRES/ /BENEFRES/ - /BENEFRES/
• regrep2: string
  Indicates Regulatory Report 2 /ORDERRES/ - /ORDERRES/ /BENEFRES/ - /BENEFRES/
• regrep3: string
  Indicates Regulatory Report 3 /ORDERRES/ - /ORDERRES/ /BENEFRES/ - /BENEFRES/
• trnstypcd: string
  Indicates Transaction Code

{
    "type":"object",
    "properties":{
        "instrcd1":{
            "type":"string",
            "description":"Indicates Instruction Code 1"
        },
        "instrcd2":{
            "type":"string",
            "description":"Indicates Instruction Code 2"
        },
        "instrcd3":{
            "type":"string",
            "description":"Indicates Instruction Code 3"
        },
        "instrcd4":{
            "type":"string",
            "description":"Indicates Instruction Code 4"
        },
        "itimeind1":{
            "type":"string",
            "description":"Indicates Time Indicator 1"
        },
        "itimeind2":{
            "type":"string",
            "description":"Indicates Time Indicator 2"
        },
        "itimeind3":{
            "type":"string",
            "description":"Indicates Time Indicator 3"
        },
        "instrcd5":{
            "type":"string",
            "description":"Indicates Instruction Code 5"
        },
        "contrefno":{
            "type":"string",
            "description":"Indicates Contrefno"
        },
        "esn":{
            "type":"number",
            "description":"Indicates Esn"
        },
        "compnt":{
            "type":"string",
            "description":"Indicates Compnt"
        },
        "bankopercd":{
            "type":"string",
            "description":"Indicates Bank Operation Code\tSPAY - SPAY\tSPRI - SPRI\tCRED - CRED\tSSTD - SSTD",
            "enum":[
                "SPAY",
                "SPRI",
                "CRED",
                "SSTD"
            ]
        },
        "instrcd":{
            "type":"string",
            "description":"Indicates Instruction Code 6"
        },
        "trnstypcd":{
            "type":"string",
            "description":"Indicates Transaction Code"
        },
        "regrep1":{
            "type":"string",
            "description":"Indicates Regulatory Report 1\t/ORDERRES/ - /ORDERRES/\t/BENEFRES/ - /BENEFRES/"
        },
        "regrep2":{
            "type":"string",
            "description":"Indicates Regulatory Report 2\t/ORDERRES/ - /ORDERRES/\t/BENEFRES/ - /BENEFRES/"
        },
        "regrep3":{
            "type":"string",
            "description":"Indicates Regulatory Report 3\t/ORDERRES/ - /ORDERRES/\t/BENEFRES/ - /BENEFRES/"
        },
        "envcont1":{
            "type":"string",
            "description":"Indicates Envelope Contents 1"
        },
        "envcont2":{
            "type":"string",
            "description":"Indicates Envelope Contents 2"
        },
        "envcont3":{
            "type":"string",
            "description":"Indicates Envelope Contents 3"
        },
        "envcont4":{
            "type":"string",
            "description":"Indicates Envelope Contents 4"
        },
        "envcont5":{
            "type":"string",
            "description":"Indicates Envelope Contents 5"
        }
    }
}

Nested Schema : ExtExchangeRateDto

Type: object

Show Source

• amount: number
  Indicates Amount
• component: string
  Indicates Component
• compType: string
  Indicates CompType
• contractRefNo: string
  Indicates ContractRefNo
• currency: string
  Indicates Currency
• eventSeqNo: number
  Indicates EventSeqNo
• exchrt: number
  Indicates Exchrt
• pickupEsn: number
  Indicates PickupEsn
• pricingRecievedOn: string
  Indicates PricingRecievedOn
• pricingSeq: number
  Indicates PricingSeq

{
    "type":"object",
    "properties":{
        "eventSeqNo":{
            "type":"number",
            "description":"Indicates EventSeqNo"
        },
        "component":{
            "type":"string",
            "description":"Indicates Component"
        },
        "currency":{
            "type":"string",
            "description":"Indicates Currency"
        },
        "exchrt":{
            "type":"number",
            "description":"Indicates Exchrt"
        },
        "compType":{
            "type":"string",
            "description":"Indicates CompType"
        },
        "contractRefNo":{
            "type":"string",
            "description":"Indicates ContractRefNo"
        },
        "pickupEsn":{
            "type":"number",
            "description":"Indicates PickupEsn"
        },
        "pricingRecievedOn":{
            "type":"string",
            "description":"Indicates PricingRecievedOn"
        },
        "pricingSeq":{
            "type":"number",
            "description":"Indicates PricingSeq"
        },
        "amount":{
            "type":"number",
            "description":"Indicates Amount"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

AuthorizeDVManulPay Successfully Performed

Body ()

Root Schema : RESTResponse

Type: object

Show Source

• branch-Parameters-Full: object FxBranchParamsDto
• FCUBS_ERROR_RESP: object FCUBSErrorResponse
• FCUBS_WARNING_RESP: object FCUBSWarnResponse

{
    "type":"object",
    "properties":{
        "branch-Parameters-Full":{
            "$ref":"#/definitions/FxBranchParamsDto"
        },
        "FCUBS_ERROR_RESP":{
            "$ref":"#/definitions/FCUBSErrorResponse"
        },
        "FCUBS_WARNING_RESP":{
            "$ref":"#/definitions/FCUBSWarnResponse"
        }
    }
}

Nested Schema : FxBranchParamsDto

Type: object

Show Source

• authstat: string
  Indicates Authstat
• autocnfclsdeal: string
  Indicates Auto Confirm Continuous Linked Settlements Deals Y - on N - Off
• brncd(required): string
  Indicates Branch Code
• btnUdf: string
  Indicates BtnUdf
• checker: string
  Indicates Checker
• checkerstamp: string
  Indicates Checkerstamp
• clsprtcpnt: string
  Indicates Continuous Linked Settlement Participant Y - on N - Off
• desc: string
  Indicates Branch Code Description
• fieldsList: array fieldsList
• maker: string
  Indicates Maker
• makerstamp: string
  Indicates Makerstamp
• modno: number
  Indicates Modno
• msgusrrefno: string
  Indicates User Reference in Messages Y - on N - Off
• onceauth: string
  Indicates Onceauth
• proctil: string
  Indicates Process Till S - System Date N - Next Working Day - 1
• revalatprd: string
  Indicates Revaluation At Product Y - on N - Off
• revalrevpref: string
  Indicates Revaluation Reversal A - Account Revaluation D - Deal Level
• ruledesc: string
  Indicates Settlement Member Description
• settleTrnCd: string
  Indicates SettleTrnCd
• stlmntmbr: string
  Indicates Settlement Member
• tcpyreqd: string
  Indicates T - Copy Y - on N - Off
• txnstat: string
  Indicates Txnstat
• udfDetailsList: array udfDetailsList

{
    "type":"object",
    "required":[
        "brncd"
    ],
    "properties":{
        "brncd":{
            "type":"string",
            "description":"Indicates Branch Code"
        },
        "proctil":{
            "type":"string",
            "description":"Indicates Process Till\tS - System Date\tN - Next Working Day - 1"
        },
        "revalatprd":{
            "type":"string",
            "description":"Indicates Revaluation At Product\tY - on\tN - Off"
        },
        "revalrevpref":{
            "type":"string",
            "description":"Indicates Revaluation Reversal\tA - Account Revaluation\tD - Deal Level"
        },
        "clsprtcpnt":{
            "type":"string",
            "description":"Indicates Continuous Linked Settlement Participant\tY - on\tN - Off"
        },
        "stlmntmbr":{
            "type":"string",
            "description":"Indicates Settlement Member"
        },
        "tcpyreqd":{
            "type":"string",
            "description":"Indicates T - Copy\tY - on\tN - Off"
        },
        "autocnfclsdeal":{
            "type":"string",
            "description":"Indicates Auto Confirm Continuous Linked Settlements Deals\tY - on\tN - Off"
        },
        "msgusrrefno":{
            "type":"string",
            "description":"Indicates User Reference in Messages\tY - on\tN - Off"
        },
        "desc":{
            "type":"string",
            "description":"Indicates Branch Code Description"
        },
        "ruledesc":{
            "type":"string",
            "description":"Indicates Settlement Member Description"
        },
        "btnUdf":{
            "type":"string",
            "description":"Indicates BtnUdf"
        },
        "settleTrnCd":{
            "type":"string",
            "description":"Indicates SettleTrnCd"
        },
        "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 : 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 : 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"
        }
    }
}

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

400 Response

Failed while processing request

401 Response

User Not Authorized

405 Response

Method Not Allowed

500 Response

Internal Server Error

Back to Top