Rest API for Oracle Banking Branch

Cash Withdrawal API

post

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

External API to perform cash withdrawal transaction

Request

Supported Media Types

application/json
application/xml

Header Parameters

appId: string

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

Indicates the authorization token generated for the User ID mentioned above.
branchCode: 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: 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
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: 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 creating a Cash withdrawal

Root Schema : CashWithdrawalData

Type: object

User Cash Withdrawal Request

Show Source

cashWithdrawalTransaction: object CashDepositTransaction

Cash Deposit Transaction
demDtls: array demDtls
extSysDtls: object ExtSysDtls

External System Details
sourceCode: string

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

Indicates the Refrerence number of the source system from where the operation is being initiated

{
    "type":"object",
    "description":"User Cash Withdrawal Request",
    "properties":{
        "extSysDtls":{
            "$ref":"#/definitions/ExtSysDtls",
            "description":""
        },
        "cashWithdrawalTransaction":{
            "$ref":"#/definitions/CashDepositTransaction",
            "description":""
        },
        "demDtls":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DenomTxnDtlsModel"
            }
        },
        "sourceCode":{
            "type":"string",
            "description":"Indicates the source system from where the operation is being initiated"
        },
        "sourceRefNo":{
            "type":"string",
            "description":"Indicates the Refrerence number of the source system from where the operation is being initiated"
        }
    }
}

Nested Schema : CashDepositTransaction

Type: object

Cash Deposit Transaction

Match All

Cash Deposit Transaction

Show Source

object CashDepositTransaction-allOf[0]

{
    "type":"object",
    "description":"Cash Deposit Transaction",
    "allOf":[
        {
            "type":"object",
            "properties":{
                "chequeDate":{
                    "type":"string",
                    "format":"date",
                    "description":"Cheque date of the cheque leaf"
                },
                "chequeNumber":{
                    "type":"string",
                    "description":"Cheque Number on the cheque leaf"
                },
                "cashAmount":{
                    "type":"number",
                    "description":"Cash amount in case charge is done by cash"
                },
                "fromAccountBranch":{
                    "type":"string",
                    "description":"Offset Account Branch"
                },
                "fromAccountCcy":{
                    "type":"string",
                    "description":"Offset Account Currency"
                },
                "fromAccountNumber":{
                    "type":"string",
                    "description":"Offset Account Number"
                },
                "fromAccountAmt":{
                    "type":"number",
                    "description":"Transaction Amount"
                },
                "mobileNumber":{
                    "type":"string",
                    "description":"Mobile Number of customer during the transaction is stored here"
                },
                "toAccountBranch":{
                    "type":"string",
                    "description":"Deposit Account Branch"
                },
                "toAccountCcy":{
                    "type":"string",
                    "description":"Deposit Account Currency"
                },
                "toAccountNumber":{
                    "type":"string",
                    "description":"Deposit Account number"
                },
                "toAccountAmt":{
                    "type":"number",
                    "description":"Deposit Amount to Account "
                },
                "txnBranchCode":{
                    "type":"string",
                    "description":"Branch Code in which transaction"
                },
                "txnCustomer":{
                    "type":"string",
                    "description":"Customer Id of the Deposit Account Number"
                },
                "txnDate":{
                    "type":"string",
                    "format":"date",
                    "description":"Branch Date in which transaction has happened"
                },
                "narrative":{
                    "type":"string",
                    "description":"Teller comment provided during the transaction"
                },
                "txnRefNumber":{
                    "type":"string",
                    "description":"Branch Transaction Reference Number for the request"
                },
                "tellerSeqNumber":{
                    "type":"string",
                    "description":"Teller Sequence Number generated during the transaction"
                }
            }
        }
    ]
}

Nested Schema : demDtls

Type: array

Show Source

Array of: object DenomTxnDtlsModel

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

Nested Schema : ExtSysDtls

Type: object

External System Details

Match All

External System Details

Show Source

object ExtSysDtls-allOf[0]

{
    "type":"object",
    "description":"External System Details",
    "allOf":[
        {
            "type":"object",
            "properties":{
                "sourceCode":{
                    "type":"string",
                    "description":"Indicates the source system from where the operation is being initiated"
                },
                "sourceRole":{
                    "type":"string",
                    "description":"This column contains the Role that needs to be used for processing a transaction"
                },
                "sourceRefNo":{
                    "type":"string",
                    "description":"Indicates the transaction source reference number of the Source System from Where the Operation is being initiated"
                },
                "stationId":{
                    "type":"string",
                    "description":"Indicates the station id"
                },
                "txnBranch":{
                    "type":"string",
                    "description":"Branch Code in which transaction has happened"
                }
            }
        }
    ]
}

Nested Schema : CashDepositTransaction-allOf[0]

Type: object

Show Source

cashAmount: number

Cash amount in case charge is done by cash
chequeDate: string(date)

Cheque date of the cheque leaf
chequeNumber: string

Cheque Number on the cheque leaf
fromAccountAmt: number

Transaction Amount
fromAccountBranch: string

Offset Account Branch
fromAccountCcy: string

Offset Account Currency
fromAccountNumber: string

Offset Account Number
mobileNumber: string

Mobile Number of customer during the transaction is stored here
narrative: string

Teller comment provided during the transaction
tellerSeqNumber: string

Teller Sequence Number generated during the transaction
toAccountAmt: number

Deposit Amount to Account
toAccountBranch: string

Deposit Account Branch
toAccountCcy: string

Deposit Account Currency
toAccountNumber: string

Deposit Account number
txnBranchCode: string

Branch Code in which transaction
txnCustomer: string

Customer Id of the Deposit Account Number
txnDate: string(date)

Branch Date in which transaction has happened
txnRefNumber: string

Branch Transaction Reference Number for the request

{
    "type":"object",
    "properties":{
        "chequeDate":{
            "type":"string",
            "format":"date",
            "description":"Cheque date of the cheque leaf"
        },
        "chequeNumber":{
            "type":"string",
            "description":"Cheque Number on the cheque leaf"
        },
        "cashAmount":{
            "type":"number",
            "description":"Cash amount in case charge is done by cash"
        },
        "fromAccountBranch":{
            "type":"string",
            "description":"Offset Account Branch"
        },
        "fromAccountCcy":{
            "type":"string",
            "description":"Offset Account Currency"
        },
        "fromAccountNumber":{
            "type":"string",
            "description":"Offset Account Number"
        },
        "fromAccountAmt":{
            "type":"number",
            "description":"Transaction Amount"
        },
        "mobileNumber":{
            "type":"string",
            "description":"Mobile Number of customer during the transaction is stored here"
        },
        "toAccountBranch":{
            "type":"string",
            "description":"Deposit Account Branch"
        },
        "toAccountCcy":{
            "type":"string",
            "description":"Deposit Account Currency"
        },
        "toAccountNumber":{
            "type":"string",
            "description":"Deposit Account number"
        },
        "toAccountAmt":{
            "type":"number",
            "description":"Deposit Amount to Account "
        },
        "txnBranchCode":{
            "type":"string",
            "description":"Branch Code in which transaction"
        },
        "txnCustomer":{
            "type":"string",
            "description":"Customer Id of the Deposit Account Number"
        },
        "txnDate":{
            "type":"string",
            "format":"date",
            "description":"Branch Date in which transaction has happened"
        },
        "narrative":{
            "type":"string",
            "description":"Teller comment provided during the transaction"
        },
        "txnRefNumber":{
            "type":"string",
            "description":"Branch Transaction Reference Number for the request"
        },
        "tellerSeqNumber":{
            "type":"string",
            "description":"Teller Sequence Number generated during the transaction"
        }
    }
}

Nested Schema : DenomTxnDtlsModel

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 : ExtSysDtls-allOf[0]

Type: object

Show Source

sourceCode: string

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

Indicates the transaction source reference number of the Source System from Where the Operation is being initiated
sourceRole: string

This column contains the Role that needs to be used for processing a transaction
stationId: string

Indicates the station id
txnBranch: string

Branch Code in which transaction has happened

{
    "type":"object",
    "properties":{
        "sourceCode":{
            "type":"string",
            "description":"Indicates the source system from where the operation is being initiated"
        },
        "sourceRole":{
            "type":"string",
            "description":"This column contains the Role that needs to be used for processing a transaction"
        },
        "sourceRefNo":{
            "type":"string",
            "description":"Indicates the transaction source reference number of the Source System from Where the Operation is being initiated"
        },
        "stationId":{
            "type":"string",
            "description":"Indicates the station id"
        },
        "txnBranch":{
            "type":"string",
            "description":"Branch Code in which transaction has happened"
        }
    }
}

Response

Supported Media Types

application/json
application/xml

201 Response

Returns message of succes or failure

Headers

Location: string

URL of newly created Cash Withdrawal Request

Root Schema : APIDTOWrapper

Type: object

Show Source

data: object data
messages: object APIDTO

{
    "type":"object",
    "properties":{
        "messages":{
            "$ref":"#/definitions/APIDTO"
        },
        "data":{
            "type":"object",
            "description":""
        }
    }
}

Nested Schema : data

Type: object

Nested Schema : APIDTO

Type: object

Show Source

codes: array codes
httpStatusCode: string
keyId: string
overrideAuthLevelsReqd: string
requestId: string
status: string

{
    "type":"object",
    "properties":{
        "keyId":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "codes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/APICode"
            }
        },
        "requestId":{
            "type":"string"
        },
        "httpStatusCode":{
            "type":"string"
        },
        "overrideAuthLevelsReqd":{
            "type":"string"
        }
    }
}

Nested Schema : codes

Type: array

Show Source

Array of: object APICode

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

Nested Schema : APICode

Type: object

Show Source

arg: string
args: array args
code: string
desc: string
error: string
information: string
language: string
override: string
overrideAuthLevelsReqd: string
type: string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "desc":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "language":{
            "type":"string"
        },
        "args":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "arg":{
            "type":"string"
        },
        "information":{
            "type":"string"
        },
        "override":{
            "type":"string"
        },
        "error":{
            "type":"string"
        },
        "overrideAuthLevelsReqd":{
            "type":"string"
        }
    }
}

Nested Schema : args

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

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.