REST API for Oracle Banking Treasury Management

Operation to SummaryQueryBranch

post

/TRBranchDetailsService/TRBranchDetails/SummaryQueryBranch

This operation summarises the branch details using the TRBranchDetails 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

Root Schema : SttmTrBranchDto

Type: object

Show Source

authstat: string

Indicates Authstat
backValueDays: number

Indicates BackValueDays
bckvalchkreqd: string

Indicates Bckvalchkreqd
branchCode(required): string

Indicates BranchCode
branchName: string

Indicates BranchName
checker: string

Indicates Checker
checkerstamp: string

Indicates Checkerstamp
cidif: string

Indicates Cidif
currcycle: string

Indicates Currcycle
currentPeriod: string

Indicates CurrentPeriod
cutoffTime: number

Indicates CutoffTime
defbnkopcd: string

Indicates Defbnkopcd
description: string

Indicates Description
individualTaxCertReqd: string

Indicates IndividualTaxCertReqd
intswapcust: string

Indicates Intswapcust
lcyMsgPrefList: array lcyMsgPrefList
lcyMsgType: string

Indicates LcyMsgType
maker: string

Indicates Maker
makerstamp: string

Indicates Makerstamp
modno: number

Indicates Modno
netsuspgl: string

Indicates Netsuspgl
onceauth: string

Indicates Onceauth
parentBranch: string

Indicates ParentBranch
prcdPrvsAvbleRate: string

Indicates PrcdPrvsAvbleRate
telex: string

Indicates Telex
trckprevyrprls: string

Indicates Trckprevyrprls
txnstat: string

Indicates Txnstat

{
    "type":"object",
    "required":[
        "branchCode"
    ],
    "properties":{
        "branchCode":{
            "type":"string",
            "description":"Indicates BranchCode"
        },
        "parentBranch":{
            "type":"string",
            "description":"Indicates ParentBranch"
        },
        "netsuspgl":{
            "type":"string",
            "description":"Indicates Netsuspgl"
        },
        "backValueDays":{
            "type":"number",
            "description":"Indicates BackValueDays"
        },
        "bckvalchkreqd":{
            "type":"string",
            "description":"Indicates Bckvalchkreqd"
        },
        "defbnkopcd":{
            "type":"string",
            "description":"Indicates Defbnkopcd"
        },
        "individualTaxCertReqd":{
            "type":"string",
            "description":"Indicates IndividualTaxCertReqd"
        },
        "intswapcust":{
            "type":"string",
            "description":"Indicates Intswapcust"
        },
        "telex":{
            "type":"string",
            "description":"Indicates Telex"
        },
        "branchName":{
            "type":"string",
            "description":"Indicates BranchName"
        },
        "cidif":{
            "type":"string",
            "description":"Indicates Cidif"
        },
        "trckprevyrprls":{
            "type":"string",
            "description":"Indicates Trckprevyrprls"
        },
        "description":{
            "type":"string",
            "description":"Indicates Description"
        },
        "lcyMsgType":{
            "type":"string",
            "description":"Indicates LcyMsgType"
        },
        "currcycle":{
            "type":"string",
            "description":"Indicates Currcycle"
        },
        "currentPeriod":{
            "type":"string",
            "description":"Indicates CurrentPeriod"
        },
        "cutoffTime":{
            "type":"number",
            "description":"Indicates CutoffTime"
        },
        "prcdPrvsAvbleRate":{
            "type":"string",
            "description":"Indicates PrcdPrvsAvbleRate"
        },
        "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"
        },
        "lcyMsgPrefList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LcyMsgPrefDto"
            }
        }
    }
}

Nested Schema : lcyMsgPrefList

Type: array

Show Source

Array of: object LcyMsgPrefDto

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

Nested Schema : LcyMsgPrefDto

Type: object

Show Source

branch: string

Indicates Branch
lcymsgtyp: string

Allowed Values: [ "S", "M", "P" ]

Indicates Lcymsgtyp
module(required): string

Indicates Module
moduleDesc: string

Indicates ModuleDesc

{
    "type":"object",
    "required":[
        "module"
    ],
    "properties":{
        "branch":{
            "type":"string",
            "description":"Indicates Branch"
        },
        "lcymsgtyp":{
            "type":"string",
            "description":"Indicates Lcymsgtyp",
            "enum":[
                "S",
                "M",
                "P"
            ]
        },
        "module":{
            "type":"string",
            "description":"Indicates Module"
        },
        "moduleDesc":{
            "type":"string",
            "description":"Indicates ModuleDesc"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

SummaryQueryBranch Successfully Performed

Root Schema : RESTResponse

Type: object

Show Source

FCUBS_ERROR_RESP: object FCUBSErrorResponse
FCUBS_WARNING_RESP: object FCUBSWarnResponse
Ld-Branch-Params-Full: object LdBranchParamsDto

{
    "type":"object",
    "properties":{
        "Ld-Branch-Params-Full":{
            "$ref":"#/definitions/LdBranchParamsDto"
        },
        "FCUBS_ERROR_RESP":{
            "$ref":"#/definitions/FCUBSErrorResponse"
        },
        "FCUBS_WARNING_RESP":{
            "$ref":"#/definitions/FCUBSWarnResponse"
        }
    }
}

Nested Schema : FCUBSErrorResponse

Type: object

Show Source

ERROR: 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 : LdBranchParamsDto

Type: object

Show Source

accrlvl: string

Indicates Accrual Level P - Product C - Contract
apycalc: string

Indicates Annual Percentage Yield Calculation Required Y - on N - Off
authstat: string

Indicates Authstat
brncd(required): string

Indicates Branch Code
brnname: string

Indicates Branch Name
btnUdf: string

Indicates BtnUdf
checker: string

Indicates Checker
checkerstamp: string

Indicates Checkerstamp
fieldsList: array fieldsList
maker: string

Indicates Maker
makerstamp: string

Indicates Makerstamp
modno: number

Indicates Modno
onceauth: string

Indicates Onceauth
proctill: string

Indicates Process Till Next Working Day - 1 S - System Date N - Next Working Day - 1
sgenmanliq: string

Indicates Settlement Message At Manual Liquidation Y - on N - Off
taxcompbasis: string

Indicates Tax Basis S - Schedule Amount L - Liquidation Amount
txnstat: string

Indicates Txnstat
udfDetailsList: array udfDetailsList
usrrefinmsgs: string

Indicates User Reference in Messages Y - on N - Off

{
    "type":"object",
    "required":[
        "brncd"
    ],
    "properties":{
        "brncd":{
            "type":"string",
            "description":"Indicates Branch Code"
        },
        "proctill":{
            "type":"string",
            "description":"Indicates Process Till Next Working Day - 1\tS - System Date\tN - Next Working Day - 1"
        },
        "accrlvl":{
            "type":"string",
            "description":"Indicates Accrual Level\tP - Product\tC - Contract"
        },
        "taxcompbasis":{
            "type":"string",
            "description":"Indicates Tax Basis\tS - Schedule Amount\tL - Liquidation Amount"
        },
        "sgenmanliq":{
            "type":"string",
            "description":"Indicates Settlement Message At Manual Liquidation\tY - on\tN - Off"
        },
        "apycalc":{
            "type":"string",
            "description":"Indicates Annual Percentage Yield Calculation Required\tY - on\tN - Off"
        },
        "brnname":{
            "type":"string",
            "description":"Indicates Branch Name"
        },
        "btnUdf":{
            "type":"string",
            "description":"Indicates BtnUdf"
        },
        "usrrefinmsgs":{
            "type":"string",
            "description":"Indicates User Reference in Messages\tY - on\tN - Off"
        },
        "maker":{
            "type":"string",
            "description":"Indicates Maker"
        },
        "makerstamp":{
            "type":"string",
            "description":"Indicates Makerstamp"
        },
        "checker":{
            "type":"string",
            "description":"Indicates Checker"
        },
        "checkerstamp":{
            "type":"string",
            "description":"Indicates Checkerstamp"
        },
        "modno":{
            "type":"number",
            "description":"Indicates Modno"
        },
        "txnstat":{
            "type":"string",
            "description":"Indicates Txnstat"
        },
        "authstat":{
            "type":"string",
            "description":"Indicates Authstat"
        },
        "onceauth":{
            "type":"string",
            "description":"Indicates Onceauth"
        },
        "udfDetailsList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UdfDetailsDto"
            }
        },
        "fieldsList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UdfFieldsDto"
            }
        }
    }
}

Nested Schema : ERROR

Type: array

Show Source

Array of: object FCUBSError

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

Nested Schema : FCUBSError

Type: object

Show Source

ECODE: string
EDESC: string

{
    "type":"object",
    "properties":{
        "ECODE":{
            "type":"string"
        },
        "EDESC":{
            "type":"string"
        }
    }
}

Nested Schema : WARNING

Type: array

Show Source

Array of: object FCUBSWarn

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

Nested Schema : FCUBSWarn

Type: object

Show Source

WCODE: string
WDESC: string

{
    "type":"object",
    "properties":{
        "WCODE":{
            "type":"string"
        },
        "WDESC":{
            "type":"string"
        }
    }
}

Nested Schema : 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"
        }
    }
}

400 Response

Failed while processing request

401 Response

User Not Authorized

405 Response

Method Not Allowed

500 Response

Internal Server Error