Rest API for Oracle Banking Branch

External Till Service

post

/api-gateway/obremo-srv-branch-teller-services/obremo-srv-branch-teller-services/ob/obbrn/branchteller/v1/tillService

External transaction till update request to perform till updation in Ob Branch

Request

Supported Media Types

application/json
application/xml

Header Parameters

Authorization(required): string

Indicates authorization token generated for the User ID mentioned above
appId(required): string

Indicates a unique code to identify the application sub-domain. The value to be passed for this service as: SRVBRNTLR
authToken: string

Indicates whether authtoken is enabled or not
branchCode(required): string

Indicates the application branch in which the operation is being initiated. The User ID used should have appropriate roles/rights to perform the action/operation in the given Branch.
branchDate(required): string

Indicates the date of the application branch in which the operation is being initiated.
contentType: string

Indicates the media type of the resource being sent in the HTTP message body. This specifies the kind of data being sent by the server or the client. The value to be passed for this service as: application/json
entityId(required): string

Information related to Entity id should be sent as part of request
multiEntityAdmin(required): string

Indicates multiEntityAdmin is enabled or not
sourceCode(required): string

Indicates the source system from where the operation is being initiated.
tenantId: string

Indicates the Tenent ID on the SaaS Deployment.
userId(required): string

Indicates the application User ID which will be used to initiate the operation. This User ID will be stored for audit purpose in the application against the operation. The User ID used here should have the appropriate roles/rights to perform the operation/action.

Request Body that contains data required for performing Till update

Root Schema : ExternalTransactionTillUpdate

Type: object

External Transaction Till Update

Show Source

cashDtls(required): object CashDtls

User Limits Model
extRefNo(required): string

Source Reference number for the transaction
functionCode: string

Function Code for the transaction
inFlowDemDtls: array inFlowDemDtls
outFlowDemDtls: array outFlowDemDtls
sourceCode: string

Source code of the external system
subScreenClass(required): string

Sub screen class code for the transaction
txnBranchCode: string

Txn Branch Code
txnDate(required): string

Transaction date for the transaction
txnRefNo: string

Reference number for the transaction

{
    "type":"object",
    "description":"External Transaction Till Update",
    "required":[
        "subScreenClass",
        "extRefNo",
        "txnDate",
        "cashDtls"
    ],
    "properties":{
        "functionCode":{
            "type":"string",
            "description":"Function Code for the transaction "
        },
        "subScreenClass":{
            "type":"string",
            "description":"Sub screen class code for the transaction "
        },
        "sourceCode":{
            "type":"string",
            "description":"Source code of the external system"
        },
        "extRefNo":{
            "type":"string",
            "description":"Source Reference number for the transaction "
        },
        "txnDate":{
            "type":"string",
            "description":"Transaction date for the transaction "
        },
        "txnRefNo":{
            "type":"string",
            "description":"Reference number for the transaction "
        },
        "txnBranchCode":{
            "type":"string",
            "description":"Txn Branch Code"
        },
        "cashDtls":{
            "$ref":"#/definitions/CashDtls"
        },
        "inFlowDemDtls":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/FXInDenomTxnDtlsModel"
            }
        },
        "outFlowDemDtls":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/FXOutDenomTxnDtlsModel"
            }
        }
    }
}

Nested Schema : CashDtls

Type: object

User Limits Model

Show Source

inflowAmt(required): number

Inflow Amount
inflowCcy(required): string

Inflow CCY
outFlowAmt(required): number

Outflow Amount
outFlowCcy(required): string

Outflow CCY

{
    "type":"object",
    "required":[
        "inflowAmt",
        "inflowCcy",
        "outFlowAmt",
        "outFlowCcy"
    ],
    "description":"User Limits Model",
    "properties":{
        "inflowAmt":{
            "type":"number",
            "description":"Inflow Amount"
        },
        "inflowCcy":{
            "type":"string",
            "description":"Inflow CCY"
        },
        "outFlowAmt":{
            "type":"number",
            "description":"Outflow Amount"
        },
        "outFlowCcy":{
            "type":"string",
            "description":"Outflow CCY"
        }
    }
}

Nested Schema : inFlowDemDtls

Type: array

Show Source

Array of: object FXInDenomTxnDtlsModel

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

Nested Schema : outFlowDemDtls

Type: array

Show Source

Array of: object FXOutDenomTxnDtlsModel

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

Nested Schema : FXInDenomTxnDtlsModel

Type: object

Show Source

denomCode(required): string

Denomination Code that Identifies Each diffrent Denomination That is used in the Bank
denomCodeValue(required): string

Value for each Denomination Code That is used in the Bank
denomType(required): string

Type of Denomination That is used in the Bank
inOutIndicator(required): string

InOut Indicator for Each Denomination
parentId: string

Parent ID for the Transaction
recordId: string

Unique Record Id for the Transaction
tellerId: string

User ID of the User doing the Transaction
units(required): number

No of Units for Each Denomination code
value(required): number

Value of the Denomination for Each Denomination Code

{
    "type":"object",
    "required":[
        "denomCode",
        "denomCodeValue",
        "denomType",
        "inOutIndicator",
        "units",
        "value"
    ],
    "properties":{
        "recordId":{
            "type":"string",
            "description":"Unique Record Id for the Transaction"
        },
        "parentId":{
            "type":"string",
            "description":"Parent ID for the Transaction"
        },
        "denomCode":{
            "type":"string",
            "description":"Denomination Code that Identifies Each diffrent Denomination That is used in the Bank"
        },
        "denomCodeValue":{
            "type":"string",
            "description":"Value for each Denomination Code That is used in the Bank"
        },
        "denomType":{
            "type":"string",
            "description":"Type of Denomination That is used in the Bank"
        },
        "units":{
            "type":"number",
            "description":"No of Units for Each Denomination code"
        },
        "value":{
            "type":"number",
            "description":"Value of the Denomination for Each Denomination Code"
        },
        "inOutIndicator":{
            "type":"string",
            "description":"InOut Indicator for Each Denomination"
        },
        "tellerId":{
            "type":"string",
            "description":"User ID of the User doing the Transaction"
        }
    }
}

Nested Schema : FXOutDenomTxnDtlsModel

Type: object

Show Source

denomCode(required): string

Denomination Code that Identifies Each diffrent Denomination That is used in the Bank
denomCodeValue(required): string

Value for each Denomination Code That is used in the Bank
denomType(required): string

Type of Denomination That is used in the Bank
inOutIndicator(required): string

InOut Indicator for Each Denomination
parentId: string

Parent ID for the Transaction
recordId: string

Unique Record Id for the Transaction
tellerId: string

User ID of the User doing the Transaction
units(required): number

No of Units for Each Denomination code
value(required): number

Value of the Denomination for Each Denomination Code

{
    "type":"object",
    "required":[
        "denomCode",
        "denomCodeValue",
        "denomType",
        "inOutIndicator",
        "units",
        "value"
    ],
    "properties":{
        "recordId":{
            "type":"string",
            "description":"Unique Record Id for the Transaction"
        },
        "parentId":{
            "type":"string",
            "description":"Parent ID for the Transaction"
        },
        "denomCode":{
            "type":"string",
            "description":"Denomination Code that Identifies Each diffrent Denomination That is used in the Bank"
        },
        "denomCodeValue":{
            "type":"string",
            "description":"Value for each Denomination Code That is used in the Bank"
        },
        "denomType":{
            "type":"string",
            "description":"Type of Denomination That is used in the Bank"
        },
        "units":{
            "type":"number",
            "description":"No of Units for Each Denomination code"
        },
        "value":{
            "type":"number",
            "description":"Value of the Denomination for Each Denomination Code"
        },
        "inOutIndicator":{
            "type":"string",
            "description":"InOut Indicator for Each Denomination"
        },
        "tellerId":{
            "type":"string",
            "description":"User ID of the User doing the Transaction"
        }
    }
}

Response

Supported Media Types

application/json
application/xml

201 Response

Returns message of succes or failure.

Root Schema : ExternalTransactionResponseModel

Type: object

Show Source

data: object data

Response Data Received
errors: object errors

Error list to diaplay all the Errors
informations: object informations

Information list to Display all Information Messages
paging: object paging

Page number Information based on the size of the Data
warnings: object warnings

Warnings list to Display all Warnings

{
    "properties":{
        "data":{
            "description":"Response Data Received",
            "type":"object"
        },
        "errors":{
            "description":"Error list to diaplay all the Errors",
            "type":"object"
        },
        "paging":{
            "description":"Page number Information based on the size of the Data",
            "type":"object"
        },
        "warnings":{
            "description":"Warnings list to Display all Warnings",
            "type":"object"
        },
        "informations":{
            "description":"Information list to Display all Information Messages",
            "type":"object"
        }
    }
}

Nested Schema : data

Type: object

Response Data Received

Nested Schema : errors

Type: object

Error list to diaplay all the Errors

Nested Schema : informations

Type: object

Information list to Display all Information Messages

Nested Schema : paging

Type: object

Page number Information based on the size of the Data

Nested Schema : warnings

Type: object

Warnings list to Display all Warnings

400 Response

Bad request error, the server is unable to process the request.

401 Response

Unauthorized request error, invalid credentials.

403 Response

Request denied, no permission to access the request.

405 Response

Request denied, invalid input.

500 Response

Internal server error.