Jump to

• Request
• Response

Operation to CreateInstruction

post

/LBSettlementInstructionService/LBSettlementInstruction/CreateInstruction

Request

Header Parameters

• BRANCH(required): string
  Enter Transaction Branch
• ENTITY: string
  Enter Entity ID
• MSGID: string
  Enter Message ID
• PASSWORD: string
  Enter Password
• SOURCE(required): string
  Enter Source Code of External System
• USERID(required): string
  Enter User ID

Body ()

Root Schema : OltmsInstrHdrDto

Type: object

Show Source

• accDetBody1: object AccDetBody1Dto
• accDetBody2: object AccDetBody2Dto
• accDetBody3: object AccDetBody3Dto
• authstat: string
  Indicates Authstat
• branch(required): string
  Indicates Branch
• checker: string
  Indicates Checker
• checkerstamp: string
  Indicates Checkerstamp
• counterparty(required): string
  Indicates Counterparty
• covClrDet: object CovClrDetDto
• cptytyp: string
  Allowed Values: [ "C", "B" ]

  Indicates Cptytyp
• currency(required): string
  Indicates Currency
• custname: string
  Indicates Custname
• ddPartBody: object DdPartBodyDto
• gfcid: string
  Indicates Gfcid
• maker: string
  Indicates Maker
• makerstamp: string
  Indicates Makerstamp
• modno: number
  Indicates Modno
• module(required): string
  Indicates Module
• msgDetBody1: object MsgDetBody1Dto
• onceauth: string
  Indicates Onceauth
• payPartBody1: object PayPartBody1Dto
• payPartBody2: object PayPartBody2Dto
• productcode(required): string
  Indicates Productcode
• rcvNotBody: object RcvNotBodyDto
• sequencenumber: number
  Indicates Sequencenumber
• shortname: string
  Indicates Shortname
• ssimnemonic: string
  Indicates Ssimnemonic
• txnstat: string
  Indicates Txnstat

{
    "type":"object",
    "required":[
        "branch",
        "counterparty",
        "currency",
        "module",
        "productcode"
    ],
    "properties":{
        "ssimnemonic":{
            "type":"string",
            "description":"Indicates Ssimnemonic"
        },
        "sequencenumber":{
            "type":"number",
            "description":"Indicates Sequencenumber"
        },
        "productcode":{
            "type":"string",
            "description":"Indicates Productcode"
        },
        "currency":{
            "type":"string",
            "description":"Indicates Currency"
        },
        "counterparty":{
            "type":"string",
            "description":"Indicates Counterparty"
        },
        "module":{
            "type":"string",
            "description":"Indicates Module"
        },
        "branch":{
            "type":"string",
            "description":"Indicates Branch"
        },
        "cptytyp":{
            "type":"string",
            "description":"Indicates Cptytyp",
            "enum":[
                "C",
                "B"
            ]
        },
        "shortname":{
            "type":"string",
            "description":"Indicates Shortname"
        },
        "custname":{
            "type":"string",
            "description":"Indicates Custname"
        },
        "gfcid":{
            "type":"string",
            "description":"Indicates Gfcid"
        },
        "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"
        },
        "accDetBody1":{
            "$ref":"#/definitions/AccDetBody1Dto"
        },
        "accDetBody2":{
            "$ref":"#/definitions/AccDetBody2Dto"
        },
        "accDetBody3":{
            "$ref":"#/definitions/AccDetBody3Dto"
        },
        "msgDetBody1":{
            "$ref":"#/definitions/MsgDetBody1Dto"
        },
        "payPartBody1":{
            "$ref":"#/definitions/PayPartBody1Dto"
        },
        "payPartBody2":{
            "$ref":"#/definitions/PayPartBody2Dto"
        },
        "rcvNotBody":{
            "$ref":"#/definitions/RcvNotBodyDto"
        },
        "ddPartBody":{
            "$ref":"#/definitions/DdPartBodyDto"
        },
        "covClrDet":{
            "$ref":"#/definitions/CovClrDetDto"
        }
    }
}

Nested Schema : AccDetBody1Dto

Type: object

Show Source

• chacccy: string
  Indicates Chacccy
• chargeaccount: string
  Indicates Chargeaccount
• chgacbrn: string
  Indicates Chgacbrn
• instrtypepay: string
  Allowed Values: [ "O", "T" ]

  Indicates Instrtypepay
• instrtyperec: string
  Allowed Values: [ "O", "T" ]

  Indicates Instrtyperec
• payaccbrn: string
  Indicates Payaccbrn
• payacccif: string
  Indicates Payacccif
• payaccount: string
  Indicates Payaccount
• payaccountccy: string
  Indicates Payaccountccy
• paymentbypay(required): string
  Allowed Values: [ "I", "M" ]

  Indicates Paymentbypay
• paymentbyrec(required): string
  Allowed Values: [ "I", "M" ]

  Indicates Paymentbyrec
• recvaccbrn: string
  Indicates Recvaccbrn
• recvacccif: string
  Indicates Recvacccif
• recvaccount: string
  Indicates Recvaccount
• recvaccountccy: string
  Indicates Recvaccountccy
• transferbypay: string
  Allowed Values: [ "B", "C" ]

  Indicates Transferbypay
• transferbyrecv: string
  Allowed Values: [ "B", "C" ]

  Indicates Transferbyrecv

{
    "type":"object",
    "required":[
        "paymentbypay",
        "paymentbyrec"
    ],
    "properties":{
        "chgacbrn":{
            "type":"string",
            "description":"Indicates Chgacbrn"
        },
        "chargeaccount":{
            "type":"string",
            "description":"Indicates Chargeaccount"
        },
        "chacccy":{
            "type":"string",
            "description":"Indicates Chacccy"
        },
        "recvaccbrn":{
            "type":"string",
            "description":"Indicates Recvaccbrn"
        },
        "recvaccount":{
            "type":"string",
            "description":"Indicates Recvaccount"
        },
        "recvaccountccy":{
            "type":"string",
            "description":"Indicates Recvaccountccy"
        },
        "payaccbrn":{
            "type":"string",
            "description":"Indicates Payaccbrn"
        },
        "payaccount":{
            "type":"string",
            "description":"Indicates Payaccount"
        },
        "payaccountccy":{
            "type":"string",
            "description":"Indicates Payaccountccy"
        },
        "instrtyperec":{
            "type":"string",
            "description":"Indicates Instrtyperec",
            "enum":[
                "O",
                "T"
            ]
        },
        "instrtypepay":{
            "type":"string",
            "description":"Indicates Instrtypepay",
            "enum":[
                "O",
                "T"
            ]
        },
        "transferbyrecv":{
            "type":"string",
            "description":"Indicates Transferbyrecv",
            "enum":[
                "B",
                "C"
            ]
        },
        "transferbypay":{
            "type":"string",
            "description":"Indicates Transferbypay",
            "enum":[
                "B",
                "C"
            ]
        },
        "recvacccif":{
            "type":"string",
            "description":"Indicates Recvacccif"
        },
        "payacccif":{
            "type":"string",
            "description":"Indicates Payacccif"
        },
        "paymentbyrec":{
            "type":"string",
            "description":"Indicates Paymentbyrec",
            "enum":[
                "I",
                "M"
            ]
        },
        "paymentbypay":{
            "type":"string",
            "description":"Indicates Paymentbypay",
            "enum":[
                "I",
                "M"
            ]
        }
    }
}

Nested Schema : AccDetBody2Dto

Type: object

Show Source

• bankopercd: string
  Indicates Bankopercd
• coverby: string
  Allowed Values: [ "M" ]

  Indicates Coverby
• covrreq: string
  Indicates Covrreq
• eriCcy: string
  Indicates EriCcy
• generateddmsg: string
  Indicates Generateddmsg
• generateReceiveNotice: string
  Indicates GenerateReceiveNotice
• trncodetype: string
  Indicates Trncodetype

{
    "type":"object",
    "properties":{
        "trncodetype":{
            "type":"string",
            "description":"Indicates Trncodetype"
        },
        "bankopercd":{
            "type":"string",
            "description":"Indicates Bankopercd"
        },
        "generateReceiveNotice":{
            "type":"string",
            "description":"Indicates GenerateReceiveNotice"
        },
        "generateddmsg":{
            "type":"string",
            "description":"Indicates Generateddmsg"
        },
        "covrreq":{
            "type":"string",
            "description":"Indicates Covrreq"
        },
        "coverby":{
            "type":"string",
            "description":"Indicates Coverby",
            "enum":[
                "M"
            ]
        },
        "eriCcy":{
            "type":"string",
            "description":"Indicates EriCcy"
        }
    }
}

Nested Schema : AccDetBody3Dto

Type: object

Show Source

• chargesDetails: string
  Indicates ChargesDetails
• desc: string
  Indicates Desc
• instrcd1: string
  Indicates Instrcd1
• instrcd2: string
  Indicates Instrcd2
• instrcd3: string
  Indicates Instrcd3
• instrcd4: string
  Indicates Instrcd4
• instrcd5: string
  Indicates Instrcd5
• instrcd6: string
  Indicates Instrcd6
• usdclrnet: string
  Indicates Usdclrnet

{
    "type":"object",
    "properties":{
        "chargesDetails":{
            "type":"string",
            "description":"Indicates ChargesDetails"
        },
        "usdclrnet":{
            "type":"string",
            "description":"Indicates Usdclrnet"
        },
        "instrcd6":{
            "type":"string",
            "description":"Indicates Instrcd6"
        },
        "instrcd5":{
            "type":"string",
            "description":"Indicates Instrcd5"
        },
        "instrcd4":{
            "type":"string",
            "description":"Indicates Instrcd4"
        },
        "instrcd3":{
            "type":"string",
            "description":"Indicates Instrcd3"
        },
        "instrcd2":{
            "type":"string",
            "description":"Indicates Instrcd2"
        },
        "instrcd1":{
            "type":"string",
            "description":"Indicates Instrcd1"
        },
        "desc":{
            "type":"string",
            "description":"Indicates Desc"
        }
    }
}

Nested Schema : CovClrDetDto

Type: object

Show Source

• account: string
  Indicates Account
• accountPrefix: string
  Indicates AccountPrefix
• bankcode: string
  Indicates Bankcode
• desc: string
  Indicates Desc
• extcoveraccount: string
  Indicates Extcoveraccount
• extcoverbankcode: string
  Indicates Extcoverbankcode
• extcovercptyacprefix: string
  Indicates Extcovercptyacprefix
• extcoverpartyname: string
  Indicates Extcoverpartyname
• extrecvaccount: string
  Indicates Extrecvaccount
• extrecvbankcode: string
  Indicates Extrecvbankcode
• extrecvcptyacprefix: string
  Indicates Extrecvcptyacprefix
• extrecvpartyname: string
  Indicates Extrecvpartyname
• name: string
  Indicates Name

{
    "type":"object",
    "properties":{
        "bankcode":{
            "type":"string",
            "description":"Indicates Bankcode"
        },
        "desc":{
            "type":"string",
            "description":"Indicates Desc"
        },
        "accountPrefix":{
            "type":"string",
            "description":"Indicates AccountPrefix"
        },
        "account":{
            "type":"string",
            "description":"Indicates Account"
        },
        "name":{
            "type":"string",
            "description":"Indicates Name"
        },
        "extrecvbankcode":{
            "type":"string",
            "description":"Indicates Extrecvbankcode"
        },
        "extcovercptyacprefix":{
            "type":"string",
            "description":"Indicates Extcovercptyacprefix"
        },
        "extcoveraccount":{
            "type":"string",
            "description":"Indicates Extcoveraccount"
        },
        "extcoverpartyname":{
            "type":"string",
            "description":"Indicates Extcoverpartyname"
        },
        "extcoverbankcode":{
            "type":"string",
            "description":"Indicates Extcoverbankcode"
        },
        "extrecvcptyacprefix":{
            "type":"string",
            "description":"Indicates Extrecvcptyacprefix"
        },
        "extrecvaccount":{
            "type":"string",
            "description":"Indicates Extrecvaccount"
        },
        "extrecvpartyname":{
            "type":"string",
            "description":"Indicates Extrecvpartyname"
        }
    }
}

Nested Schema : DdPartBodyDto

Type: object

Show Source

• crecodedesc: string
  Indicates Crecodedesc
• credAcNo: string
  Indicates CredAcNo
• creditoracct1: string
  Indicates Creditoracct1
• creditoracct2: string
  Indicates Creditoracct2
• creditoracct3: string
  Indicates Creditoracct3
• creditoracct4: string
  Indicates Creditoracct4
• creditoracct5: string
  Indicates Creditoracct5
• creditorbank1: string
  Indicates Creditorbank1
• creditorbank2: string
  Indicates Creditorbank2
• creditorbank3: string
  Indicates Creditorbank3
• creditorbank4: string
  Indicates Creditorbank4
• creditorbank5: string
  Indicates Creditorbank5
• dbtrAcc: string
  Indicates DbtrAcc
• debtoracct1: string
  Indicates Debtoracct1
• debtoracct2: string
  Indicates Debtoracct2
• debtoracct3: string
  Indicates Debtoracct3
• debtoracct4: string
  Indicates Debtoracct4
• debtoracct5: string
  Indicates Debtoracct5
• debtorbank1: string
  Indicates Debtorbank1
• debtorbank2: string
  Indicates Debtorbank2
• debtorbank3: string
  Indicates Debtorbank3
• debtorbank4: string
  Indicates Debtorbank4
• debtorbank5: string
  Indicates Debtorbank5
• desc: string
  Indicates Desc

{
    "type":"object",
    "properties":{
        "credAcNo":{
            "type":"string",
            "description":"Indicates CredAcNo"
        },
        "crecodedesc":{
            "type":"string",
            "description":"Indicates Crecodedesc"
        },
        "creditoracct5":{
            "type":"string",
            "description":"Indicates Creditoracct5"
        },
        "creditoracct4":{
            "type":"string",
            "description":"Indicates Creditoracct4"
        },
        "creditoracct3":{
            "type":"string",
            "description":"Indicates Creditoracct3"
        },
        "creditoracct2":{
            "type":"string",
            "description":"Indicates Creditoracct2"
        },
        "creditoracct1":{
            "type":"string",
            "description":"Indicates Creditoracct1"
        },
        "creditorbank5":{
            "type":"string",
            "description":"Indicates Creditorbank5"
        },
        "creditorbank4":{
            "type":"string",
            "description":"Indicates Creditorbank4"
        },
        "creditorbank3":{
            "type":"string",
            "description":"Indicates Creditorbank3"
        },
        "creditorbank2":{
            "type":"string",
            "description":"Indicates Creditorbank2"
        },
        "creditorbank1":{
            "type":"string",
            "description":"Indicates Creditorbank1"
        },
        "dbtrAcc":{
            "type":"string",
            "description":"Indicates DbtrAcc"
        },
        "desc":{
            "type":"string",
            "description":"Indicates Desc"
        },
        "debtoracct5":{
            "type":"string",
            "description":"Indicates Debtoracct5"
        },
        "debtoracct4":{
            "type":"string",
            "description":"Indicates Debtoracct4"
        },
        "debtoracct3":{
            "type":"string",
            "description":"Indicates Debtoracct3"
        },
        "debtoracct2":{
            "type":"string",
            "description":"Indicates Debtoracct2"
        },
        "debtoracct1":{
            "type":"string",
            "description":"Indicates Debtoracct1"
        },
        "debtorbank5":{
            "type":"string",
            "description":"Indicates Debtorbank5"
        },
        "debtorbank4":{
            "type":"string",
            "description":"Indicates Debtorbank4"
        },
        "debtorbank3":{
            "type":"string",
            "description":"Indicates Debtorbank3"
        },
        "debtorbank2":{
            "type":"string",
            "description":"Indicates Debtorbank2"
        },
        "debtorbank1":{
            "type":"string",
            "description":"Indicates Debtorbank1"
        }
    }
}

Nested Schema : MsgDetBody1Dto

Type: object

Show Source

• regrep1: string
  Indicates Regrep1
• regrep2: string
  Indicates Regrep2
• regrep3: string
  Indicates Regrep3
• sendrtorecv1: string
  Indicates Sendrtorecv1
• sendrtorecv2: string
  Indicates Sendrtorecv2
• sendrtorecv3: string
  Indicates Sendrtorecv3
• sendrtorecv4: string
  Indicates Sendrtorecv4
• sendrtorecv5: string
  Indicates Sendrtorecv5
• sendrtorecv6: string
  Indicates Sendrtorecv6

{
    "type":"object",
    "properties":{
        "regrep3":{
            "type":"string",
            "description":"Indicates Regrep3"
        },
        "regrep2":{
            "type":"string",
            "description":"Indicates Regrep2"
        },
        "regrep1":{
            "type":"string",
            "description":"Indicates Regrep1"
        },
        "sendrtorecv6":{
            "type":"string",
            "description":"Indicates Sendrtorecv6"
        },
        "sendrtorecv5":{
            "type":"string",
            "description":"Indicates Sendrtorecv5"
        },
        "sendrtorecv4":{
            "type":"string",
            "description":"Indicates Sendrtorecv4"
        },
        "sendrtorecv3":{
            "type":"string",
            "description":"Indicates Sendrtorecv3"
        },
        "sendrtorecv2":{
            "type":"string",
            "description":"Indicates Sendrtorecv2"
        },
        "sendrtorecv1":{
            "type":"string",
            "description":"Indicates Sendrtorecv1"
        }
    }
}

Nested Schema : PayPartBody1Dto

Type: object

Show Source

• benefInst: string
  Indicates BenefInst
• benefInstitution1: string
  Indicates BenefInstitution1
• benefInstitution2: string
  Indicates BenefInstitution2
• benefInstitution3: string
  Indicates BenefInstitution3
• benefInstitution4: string
  Indicates BenefInstitution4
• benefInstitution5: string
  Indicates BenefInstitution5
• desc: string
  Indicates Desc
• ordcust1: string
  Indicates Ordcust1
• ordcust2: string
  Indicates Ordcust2
• ordcust3: string
  Indicates Ordcust3
• ordcust4: string
  Indicates Ordcust4
• ordcust5: string
  Indicates Ordcust5
• orderingInstitution1: string
  Indicates OrderingInstitution1
• orderingInstitution2: string
  Indicates OrderingInstitution2
• orderingInstitution3: string
  Indicates OrderingInstitution3
• orderingInstitution4: string
  Indicates OrderingInstitution4
• orderingInstitution5: string
  Indicates OrderingInstitution5
• ultben: string
  Indicates Ultben
• ultben1: string
  Indicates Ultben1
• ultben2: string
  Indicates Ultben2
• ultben3: string
  Indicates Ultben3
• ultben4: string
  Indicates Ultben4
• ultben5: string
  Indicates Ultben5
• utilbenfdesc: string
  Indicates Utilbenfdesc

{
    "type":"object",
    "properties":{
        "orderingInstitution5":{
            "type":"string",
            "description":"Indicates OrderingInstitution5"
        },
        "orderingInstitution4":{
            "type":"string",
            "description":"Indicates OrderingInstitution4"
        },
        "orderingInstitution3":{
            "type":"string",
            "description":"Indicates OrderingInstitution3"
        },
        "orderingInstitution2":{
            "type":"string",
            "description":"Indicates OrderingInstitution2"
        },
        "orderingInstitution1":{
            "type":"string",
            "description":"Indicates OrderingInstitution1"
        },
        "ultben":{
            "type":"string",
            "description":"Indicates Ultben"
        },
        "utilbenfdesc":{
            "type":"string",
            "description":"Indicates Utilbenfdesc"
        },
        "ultben5":{
            "type":"string",
            "description":"Indicates Ultben5"
        },
        "ultben4":{
            "type":"string",
            "description":"Indicates Ultben4"
        },
        "ultben3":{
            "type":"string",
            "description":"Indicates Ultben3"
        },
        "ultben2":{
            "type":"string",
            "description":"Indicates Ultben2"
        },
        "ultben1":{
            "type":"string",
            "description":"Indicates Ultben1"
        },
        "benefInst":{
            "type":"string",
            "description":"Indicates BenefInst"
        },
        "desc":{
            "type":"string",
            "description":"Indicates Desc"
        },
        "benefInstitution5":{
            "type":"string",
            "description":"Indicates BenefInstitution5"
        },
        "benefInstitution4":{
            "type":"string",
            "description":"Indicates BenefInstitution4"
        },
        "benefInstitution3":{
            "type":"string",
            "description":"Indicates BenefInstitution3"
        },
        "benefInstitution2":{
            "type":"string",
            "description":"Indicates BenefInstitution2"
        },
        "benefInstitution1":{
            "type":"string",
            "description":"Indicates BenefInstitution1"
        },
        "ordcust5":{
            "type":"string",
            "description":"Indicates Ordcust5"
        },
        "ordcust4":{
            "type":"string",
            "description":"Indicates Ordcust4"
        },
        "ordcust3":{
            "type":"string",
            "description":"Indicates Ordcust3"
        },
        "ordcust2":{
            "type":"string",
            "description":"Indicates Ordcust2"
        },
        "ordcust1":{
            "type":"string",
            "description":"Indicates Ordcust1"
        }
    }
}

Nested Schema : PayPartBody2Dto

Type: object

Show Source

• accinst: string
  Indicates Accinst
• accwithinst5: string
  Indicates Accwithinst5
• accwithinstn1: string
  Indicates Accwithinstn1
• accwithinstn2: string
  Indicates Accwithinstn2
• accwithinstn3: string
  Indicates Accwithinstn3
• accwithinstn4: string
  Indicates Accwithinstn4
• desc: string
  Indicates Desc
• instcodedesc: string
  Indicates Instcodedesc
• intermed1: string
  Indicates Intermed1
• intermed2: string
  Indicates Intermed2
• intermediary: string
  Indicates Intermediary
• intermediary1: string
  Indicates Intermediary1
• intermediary3: string
  Indicates Intermediary3
• intermediary4: string
  Indicates Intermediary4
• intreiminst1: string
  Indicates Intreiminst1
• intreiminst2: string
  Indicates Intreiminst2
• intreiminst3: string
  Indicates Intreiminst3
• intreiminst4: string
  Indicates Intreiminst4
• intReimInst5: string
  Indicates IntReimInst5
• rcvrcorresp1: string
  Indicates Rcvrcorresp1
• rcvrcorresp2: string
  Indicates Rcvrcorresp2
• rcvrcorresp3: string
  Indicates Rcvrcorresp3
• rcvrcorresp4: string
  Indicates Rcvrcorresp4
• rcvrCorresp5: string
  Indicates RcvrCorresp5

{
    "type":"object",
    "properties":{
        "intermediary":{
            "type":"string",
            "description":"Indicates Intermediary"
        },
        "instcodedesc":{
            "type":"string",
            "description":"Indicates Instcodedesc"
        },
        "intermed1":{
            "type":"string",
            "description":"Indicates Intermed1"
        },
        "intermediary4":{
            "type":"string",
            "description":"Indicates Intermediary4"
        },
        "intermediary3":{
            "type":"string",
            "description":"Indicates Intermediary3"
        },
        "intermed2":{
            "type":"string",
            "description":"Indicates Intermed2"
        },
        "intermediary1":{
            "type":"string",
            "description":"Indicates Intermediary1"
        },
        "rcvrCorresp5":{
            "type":"string",
            "description":"Indicates RcvrCorresp5"
        },
        "rcvrcorresp4":{
            "type":"string",
            "description":"Indicates Rcvrcorresp4"
        },
        "rcvrcorresp3":{
            "type":"string",
            "description":"Indicates Rcvrcorresp3"
        },
        "rcvrcorresp2":{
            "type":"string",
            "description":"Indicates Rcvrcorresp2"
        },
        "rcvrcorresp1":{
            "type":"string",
            "description":"Indicates Rcvrcorresp1"
        },
        "intReimInst5":{
            "type":"string",
            "description":"Indicates IntReimInst5"
        },
        "intreiminst4":{
            "type":"string",
            "description":"Indicates Intreiminst4"
        },
        "intreiminst3":{
            "type":"string",
            "description":"Indicates Intreiminst3"
        },
        "intreiminst2":{
            "type":"string",
            "description":"Indicates Intreiminst2"
        },
        "intreiminst1":{
            "type":"string",
            "description":"Indicates Intreiminst1"
        },
        "accinst":{
            "type":"string",
            "description":"Indicates Accinst"
        },
        "desc":{
            "type":"string",
            "description":"Indicates Desc"
        },
        "accwithinst5":{
            "type":"string",
            "description":"Indicates Accwithinst5"
        },
        "accwithinstn4":{
            "type":"string",
            "description":"Indicates Accwithinstn4"
        },
        "accwithinstn3":{
            "type":"string",
            "description":"Indicates Accwithinstn3"
        },
        "accwithinstn2":{
            "type":"string",
            "description":"Indicates Accwithinstn2"
        },
        "accwithinstn1":{
            "type":"string",
            "description":"Indicates Accwithinstn1"
        }
    }
}

Nested Schema : RcvNotBodyDto

Type: object

Show Source

• intermed5: string
  Indicates Intermed5
• ordcust5: string
  Indicates Ordcust5
• ordinst1: string
  Indicates Ordinst1
• recvintermediary1: string
  Indicates Recvintermediary1
• recvintermediary2: string
  Indicates Recvintermediary2
• recvintermediary3: string
  Indicates Recvintermediary3
• recvintermediary4: string
  Indicates Recvintermediary4
• recvorderingcust1: string
  Indicates Recvorderingcust1
• recvorderingcust2: string
  Indicates Recvorderingcust2
• recvorderingcust3: string
  Indicates Recvorderingcust3
• recvorderingcust4: string
  Indicates Recvorderingcust4
• recvorderinginstn1: string
  Indicates Recvorderinginstn1
• recvorderinginstn2: string
  Indicates Recvorderinginstn2
• recvorderinginstn3: string
  Indicates Recvorderinginstn3
• recvorderinginstn4: string
  Indicates Recvorderinginstn4

{
    "type":"object",
    "properties":{
        "ordcust5":{
            "type":"string",
            "description":"Indicates Ordcust5"
        },
        "recvorderingcust4":{
            "type":"string",
            "description":"Indicates Recvorderingcust4"
        },
        "recvorderingcust3":{
            "type":"string",
            "description":"Indicates Recvorderingcust3"
        },
        "recvorderingcust2":{
            "type":"string",
            "description":"Indicates Recvorderingcust2"
        },
        "recvorderingcust1":{
            "type":"string",
            "description":"Indicates Recvorderingcust1"
        },
        "ordinst1":{
            "type":"string",
            "description":"Indicates Ordinst1"
        },
        "recvorderinginstn4":{
            "type":"string",
            "description":"Indicates Recvorderinginstn4"
        },
        "recvorderinginstn3":{
            "type":"string",
            "description":"Indicates Recvorderinginstn3"
        },
        "recvorderinginstn2":{
            "type":"string",
            "description":"Indicates Recvorderinginstn2"
        },
        "recvorderinginstn1":{
            "type":"string",
            "description":"Indicates Recvorderinginstn1"
        },
        "intermed5":{
            "type":"string",
            "description":"Indicates Intermed5"
        },
        "recvintermediary4":{
            "type":"string",
            "description":"Indicates Recvintermediary4"
        },
        "recvintermediary3":{
            "type":"string",
            "description":"Indicates Recvintermediary3"
        },
        "recvintermediary2":{
            "type":"string",
            "description":"Indicates Recvintermediary2"
        },
        "recvintermediary1":{
            "type":"string",
            "description":"Indicates Recvintermediary1"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

CreateInstruction Successfully Performed

Body ()

Root Schema : RESTResponseSuccess

Type: object

Show Source

• fcubsWarningResp: object FCUBSWarnResponse
• margincomponent: object MarginComponentDto

{
    "type":"object",
    "properties":{
        "margincomponent":{
            "description":"Indicates margincomponent",
            "$ref":"#/definitions/MarginComponentDto"
        },
        "fcubsWarningResp":{
            "description":"Indicates fcubsWarningResp",
            "$ref":"#/definitions/FCUBSWarnResponse"
        }
    }
}

Nested Schema : FCUBSWarnResponse

Type: object

Show Source

• warning: array warning
  Indicates Warning

{
    "type":"object",
    "properties":{
        "warning":{
            "type":"array",
            "description":"Indicates Warning",
            "items":{
                "$ref":"#/definitions/FCUBSWarn"
            }
        }
    }
}

Nested Schema : MarginComponentDto

Type: object

Show Source

• amountType: string
  Indicates AmountType
• authstat: string
  Indicates Authstat
• bookDate: string
  Indicates BookDate
• branchCode: string
  Indicates BranchCode
• calculate: string
  Indicates Calculate
• checker: string
  Indicates Checker
• checkerstamp: string
  Indicates Checkerstamp
• component(required): string
  Indicates Component
• componentDesc: string
  Indicates ComponentDesc
• componentType: string
  Indicates ComponentType
• contractRefNo(required): string
  Indicates ContractRefNo
• currency: string
  Indicates Currency
• customerName: string
  Indicates CustomerName
• customerNo(required): string
  Indicates CustomerNo
• facilityName: string
  Indicates FacilityName
• facilityRefNo: string
  Indicates FacilityRefNo
• maker: string
  Indicates Maker
• makerstamp: string
  Indicates Makerstamp
• marginCcyList: array marginCcyList
• modno: number
  Indicates Modno
• onceauth: string
  Indicates Onceauth
• prdtypeDesc: string
  Indicates PrdtypeDesc
• product: string
  Indicates Product
• productDesc: string
  Indicates ProductDesc
• productType: string
  Indicates ProductType
• purposeOfSyndication: string
  Indicates PurposeOfSyndication
• txnstat: string
  Indicates Txnstat
• userRefNo: string
  Indicates UserRefNo
• valueDate: string
  Indicates ValueDate

{
    "type":"object",
    "required":[
        "component",
        "contractRefNo",
        "customerNo"
    ],
    "properties":{
        "branchCode":{
            "type":"string",
            "description":"Indicates BranchCode"
        },
        "contractRefNo":{
            "type":"string",
            "description":"Indicates ContractRefNo"
        },
        "customerNo":{
            "type":"string",
            "description":"Indicates CustomerNo"
        },
        "component":{
            "type":"string",
            "description":"Indicates Component"
        },
        "currency":{
            "type":"string",
            "description":"Indicates Currency"
        },
        "componentType":{
            "type":"string",
            "description":"Indicates ComponentType"
        },
        "amountType":{
            "type":"string",
            "description":"Indicates AmountType"
        },
        "userRefNo":{
            "type":"string",
            "description":"Indicates UserRefNo"
        },
        "customerName":{
            "type":"string",
            "description":"Indicates CustomerName"
        },
        "facilityRefNo":{
            "type":"string",
            "description":"Indicates FacilityRefNo"
        },
        "componentDesc":{
            "type":"string",
            "description":"Indicates ComponentDesc"
        },
        "bookDate":{
            "type":"string",
            "description":"Indicates BookDate"
        },
        "valueDate":{
            "type":"string",
            "description":"Indicates ValueDate"
        },
        "product":{
            "type":"string",
            "description":"Indicates Product"
        },
        "productDesc":{
            "type":"string",
            "description":"Indicates ProductDesc"
        },
        "facilityName":{
            "type":"string",
            "description":"Indicates FacilityName"
        },
        "productType":{
            "type":"string",
            "description":"Indicates ProductType"
        },
        "prdtypeDesc":{
            "type":"string",
            "description":"Indicates PrdtypeDesc"
        },
        "purposeOfSyndication":{
            "type":"string",
            "description":"Indicates PurposeOfSyndication"
        },
        "calculate":{
            "type":"string",
            "description":"Indicates Calculate"
        },
        "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"
        },
        "marginCcyList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/MarginCcyDto"
            }
        }
    }
}

Nested Schema : warning

Type: array

Indicates Warning

Show Source

• Array of: object FCUBSWarn

{
    "type":"array",
    "description":"Indicates Warning",
    "items":{
        "$ref":"#/definitions/FCUBSWarn"
    }
}

Nested Schema : FCUBSWarn

Type: object

Show Source

• wcode: string
  Indicates Warning Code
• wdesc: string
  Indicates Warning Description

{
    "type":"object",
    "properties":{
        "wcode":{
            "type":"string",
            "description":"Indicates Warning Code"
        },
        "wdesc":{
            "type":"string",
            "description":"Indicates Warning Description"
        }
    }
}

Nested Schema : marginCcyList

Type: array

Show Source

• Array of: object MarginCcyDto

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

Nested Schema : MarginCcyDto

Type: object

Show Source

• branchCode: string
  Indicates BranchCode
• component: string
  Indicates Component
• contractRefNo: string
  Indicates ContractRefNo
• currency(required): string
  Indicates Currency
• currencyDesc: string
  Indicates CurrencyDesc
• customerNo: string
  Indicates CustomerNo
• marginEffdateList: array marginEffdateList

{
    "type":"object",
    "required":[
        "currency"
    ],
    "properties":{
        "currency":{
            "type":"string",
            "description":"Indicates Currency"
        },
        "branchCode":{
            "type":"string",
            "description":"Indicates BranchCode"
        },
        "customerNo":{
            "type":"string",
            "description":"Indicates CustomerNo"
        },
        "contractRefNo":{
            "type":"string",
            "description":"Indicates ContractRefNo"
        },
        "component":{
            "type":"string",
            "description":"Indicates Component"
        },
        "currencyDesc":{
            "type":"string",
            "description":"Indicates CurrencyDesc"
        },
        "marginEffdateList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/MarginEffdateDto"
            }
        }
    }
}

Nested Schema : marginEffdateList

Type: array

Show Source

• Array of: object MarginEffdateDto

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

Nested Schema : MarginEffdateDto

Type: object

Show Source

• branchCode: string
  Indicates BranchCode
• component: string
  Indicates Component
• contractRefNo: string
  Indicates ContractRefNo
• currency: string
  Indicates Currency
• customerNo: string
  Indicates CustomerNo
• effectiveDate(required): string
  Indicates EffectiveDate
• lastChangeTimestamp: string
  Indicates LastChangeTimestamp
• marginRateList: array marginRateList
• recalcReqd: string
  Indicates RecalcReqd

{
    "type":"object",
    "required":[
        "effectiveDate"
    ],
    "properties":{
        "branchCode":{
            "type":"string",
            "description":"Indicates BranchCode"
        },
        "customerNo":{
            "type":"string",
            "description":"Indicates CustomerNo"
        },
        "component":{
            "type":"string",
            "description":"Indicates Component"
        },
        "contractRefNo":{
            "type":"string",
            "description":"Indicates ContractRefNo"
        },
        "currency":{
            "type":"string",
            "description":"Indicates Currency"
        },
        "lastChangeTimestamp":{
            "type":"string",
            "description":"Indicates LastChangeTimestamp"
        },
        "recalcReqd":{
            "type":"string",
            "description":"Indicates RecalcReqd"
        },
        "effectiveDate":{
            "type":"string",
            "description":"Indicates EffectiveDate"
        },
        "marginRateList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/MarginRateDto"
            }
        }
    }
}

Nested Schema : marginRateList

Type: array

Show Source

• Array of: object MarginRateDto

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

Nested Schema : MarginRateDto

Type: object

Show Source

• branchCode: string
  Indicates BranchCode
• component: string
  Indicates Component
• contractRefNo: string
  Indicates ContractRefNo
• currency: string
  Indicates Currency
• customerNo: string
  Indicates CustomerNo
• effectiveDate: string
  Indicates EffectiveDate
• fromBasisAmt: number
  Indicates FromBasisAmt
• margin: number
  Indicates Margin
• marginRate(required): number
  Indicates MarginRate
• marginRecordStatus: string
  Indicates MarginRecordStatus
• participantMarginList: array participantMarginList
• seqNo: number
  Indicates SeqNo
• toBasisAmt: number
  Indicates ToBasisAmt
• totalRate: number
  Indicates TotalRate

{
    "type":"object",
    "required":[
        "marginRate"
    ],
    "properties":{
        "margin":{
            "type":"number",
            "description":"Indicates Margin"
        },
        "component":{
            "type":"string",
            "description":"Indicates Component"
        },
        "effectiveDate":{
            "type":"string",
            "description":"Indicates EffectiveDate"
        },
        "customerNo":{
            "type":"string",
            "description":"Indicates CustomerNo"
        },
        "marginRate":{
            "type":"number",
            "description":"Indicates MarginRate"
        },
        "fromBasisAmt":{
            "type":"number",
            "description":"Indicates FromBasisAmt"
        },
        "contractRefNo":{
            "type":"string",
            "description":"Indicates ContractRefNo"
        },
        "toBasisAmt":{
            "type":"number",
            "description":"Indicates ToBasisAmt"
        },
        "branchCode":{
            "type":"string",
            "description":"Indicates BranchCode"
        },
        "seqNo":{
            "type":"number",
            "description":"Indicates SeqNo"
        },
        "marginRecordStatus":{
            "type":"string",
            "description":"Indicates MarginRecordStatus"
        },
        "currency":{
            "type":"string",
            "description":"Indicates Currency"
        },
        "totalRate":{
            "type":"number",
            "description":"Indicates TotalRate"
        },
        "participantMarginList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ParticipantMarginDto"
            }
        }
    }
}

Nested Schema : participantMarginList

Type: array

Show Source

• Array of: object ParticipantMarginDto

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

Nested Schema : ParticipantMarginDto

Type: object

Show Source

• assetRatio: number
  Indicates AssetRatio
• brncode: string
  Indicates Brncode
• ccy: string
  Indicates Ccy
• component: string
  Indicates Component
• contactrefnum: string
  Indicates Contactrefnum
• customer: string
  Indicates Customer
• effectdate: string
  Indicates Effectdate
• frmbasisamt: number
  Indicates Frmbasisamt
• margin: number
  Indicates Margin
• marginrat: number
  Indicates Marginrat
• participant: string
  Indicates Participant
• partName: string
  Indicates PartName
• tobasisamt: number
  Indicates Tobasisamt
• totalRate: number
  Indicates TotalRate

{
    "type":"object",
    "properties":{
        "brncode":{
            "type":"string",
            "description":"Indicates Brncode"
        },
        "ccy":{
            "type":"string",
            "description":"Indicates Ccy"
        },
        "component":{
            "type":"string",
            "description":"Indicates Component"
        },
        "contactrefnum":{
            "type":"string",
            "description":"Indicates Contactrefnum"
        },
        "customer":{
            "type":"string",
            "description":"Indicates Customer"
        },
        "effectdate":{
            "type":"string",
            "description":"Indicates Effectdate"
        },
        "frmbasisamt":{
            "type":"number",
            "description":"Indicates Frmbasisamt"
        },
        "margin":{
            "type":"number",
            "description":"Indicates Margin"
        },
        "marginrat":{
            "type":"number",
            "description":"Indicates Marginrat"
        },
        "participant":{
            "type":"string",
            "description":"Indicates Participant"
        },
        "tobasisamt":{
            "type":"number",
            "description":"Indicates Tobasisamt"
        },
        "partName":{
            "type":"string",
            "description":"Indicates PartName"
        },
        "assetRatio":{
            "type":"number",
            "description":"Indicates AssetRatio"
        },
        "totalRate":{
            "type":"number",
            "description":"Indicates TotalRate"
        }
    }
}

400 Response

Failed while processing request

Body ()

Root Schema : RESTResponseFailure

Type: object

Show Source

• fcubsErrorResp: object FCUBSErrorResponse

{
    "type":"object",
    "properties":{
        "fcubsErrorResp":{
            "description":"Indicates fcubsErrorResp",
            "$ref":"#/definitions/FCUBSErrorResponse"
        }
    }
}

Nested Schema : FCUBSErrorResponse

Type: object

Show Source

• error: array error
  Indicates Errors

{
    "type":"object",
    "properties":{
        "error":{
            "type":"array",
            "description":"Indicates Errors",
            "items":{
                "$ref":"#/definitions/FCUBSError"
            }
        }
    }
}

Nested Schema : error

Type: array

Indicates Errors

Show Source

• Array of: object FCUBSError

{
    "type":"array",
    "description":"Indicates Errors",
    "items":{
        "$ref":"#/definitions/FCUBSError"
    }
}

Nested Schema : FCUBSError

Type: object

Show Source

• ecode: string
  Indicates Error Code
• edesc: string
  Indicates Error Description

{
    "type":"object",
    "properties":{
        "ecode":{
            "type":"string",
            "description":"Indicates Error Code"
        },
        "edesc":{
            "type":"string",
            "description":"Indicates Error Description"
        }
    }
}

401 Response

User Not Authorized

405 Response

Method Not Allowed

500 Response

Internal Server Error

Back to Top