Rest API for Oracle Banking Branch

Account Transfer API

post

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

Account Transfer

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 Account transfer transaction

Root Schema : ExternalFtTxnDSModel

Type: object

User Limits Model

Show Source

addDtls: object AdditionalTransactionDetails

Additional Configuration Master Model
chequeDate: string(date)

Cheque date of the cheque leaf
chequeNumber: string

Cheque Number on the cheque leaf
demDtls: array demDtls
extSysDtls: object ExtSysDtls

External System Details
fromAccountAmt: number

Amount that is Transfered from the Account
fromAccountBranch: string

Account Branch from which the funds are Transfered
fromAccountCcy: string

Account Currency in which the funds are Transfered
fromAccountNumber: string

Account Number from which the funds are Sent
mobileNumber: string

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

Teller comment provided during the transaction
toAccountAmt: number

Amount that is Credited to the Account
toAccountBranch: string

Account Branch of the account receiving funds
toAccountCcy: string

Account Currency of the account receiving funds
toAccountNumber: string

Account Number that is receiving funds
txnBranchCode: string

Branch Code in which transaction has happened
txnCustomer: string

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

Transaction Date on which the transaction is done
txnDtls: object TransactionDetails

Transaction Master Model
txnRefNumber: string

Branch Transaction Reference Number for the request

{
    "type":"object",
    "description":"User Limits Model",
    "properties":{
        "chequeDate":{
            "type":"string",
            "format":"date",
            "description":"Cheque date of the cheque leaf"
        },
        "chequeNumber":{
            "type":"string",
            "description":"Cheque Number on the cheque leaf"
        },
        "fromAccountBranch":{
            "type":"string",
            "description":"Account Branch from which the funds are Transfered"
        },
        "fromAccountCcy":{
            "type":"string",
            "description":"Account Currency in which the funds are Transfered"
        },
        "fromAccountNumber":{
            "type":"string",
            "description":"Account Number from which the funds are Sent"
        },
        "fromAccountAmt":{
            "type":"number",
            "description":"Amount that is Transfered from the Account"
        },
        "mobileNumber":{
            "type":"string",
            "description":"Mobile Number of customer during the transaction is stored here"
        },
        "narrative":{
            "type":"string",
            "description":"Teller comment provided during the transaction"
        },
        "toAccountBranch":{
            "type":"string",
            "description":"Account Branch of the account receiving funds"
        },
        "toAccountCcy":{
            "type":"string",
            "description":"Account Currency of the account receiving funds"
        },
        "toAccountNumber":{
            "type":"string",
            "description":"Account Number that is receiving funds"
        },
        "toAccountAmt":{
            "type":"number",
            "description":"Amount that is Credited to the Account"
        },
        "txnBranchCode":{
            "type":"string",
            "description":"Branch Code in which transaction has happened"
        },
        "txnCustomer":{
            "type":"string",
            "description":"Customer Id of the Debit Account Number"
        },
        "txnRefNumber":{
            "type":"string",
            "description":"Branch Transaction Reference Number for the request"
        },
        "txnDate":{
            "type":"string",
            "format":"date",
            "description":"Transaction Date on which the transaction is done"
        },
        "addDtls":{
            "$ref":"#/definitions/AdditionalTransactionDetails"
        },
        "txnDtls":{
            "$ref":"#/definitions/TransactionDetails"
        },
        "extSysDtls":{
            "$ref":"#/definitions/ExtSysDtls",
            "description":""
        },
        "demDtls":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DenomTxnDtlsModel"
            }
        }
    }
}

Nested Schema : AdditionalTransactionDetails

Type: object

Additional Configuration Master Model

Show Source

adviceName: string

Advice Name
cashInOutIndicator: string

Cash In/Out Indicator Possible Values I,O, IO (FX case)
crossCcyEnabled: string

crossCcyEnabled Indicator Possible Values N,Y
ejLoggingRequired: string

Teller Sq required/logged Default Value Y Possible Values Y-Yes, N-No
ejTxnAmtMapping: string

EJ TXN Amount Mapping Possible Values FROM or TO
ejTxnCcyMapping: string

EJ TXN Currency Mapping Possible Values FROM or TO
email: string

email of the Customer Involved in the Transaction
hostMultiTripId: string

Unique ID to identify the Trips with Host
hostStatus: string

Host Status during Transaction
ignoreApproval: boolean

Default Value: false

ignore approval or not
ignoreWarning: boolean

Default Value: false

ignore warning or not
isAdvice: string

Default Value: N

is advice generation required or not
isExternal: boolean

Default Value: false

Is External call
isFetchAccImages: string

isFetchAccImages Indicator Possible Values N,Y
isNewChargesEnabled: string

isNewChargesEnabled Indicator Possible Values N,Y
isObpayApproval: string

Default Value: Y

is it obpay approval
isObpayReversalApproval: string

Default Value: N

is it reversal obpay approval
isReversal: string

Default Value: N

is it reversal
isReversalAdvice: string

Default Value: N

is reversal advice generation required or not
isTotChargesReq: string

isTotChargesReq Indicator Possible Values N,Y
mandatorySignatureFlag: string

Mandatory Signature Flag
mobile: string

Mobile number of the Customer Involved in the Transaction
orchestratorId: string

Orchestrator Id
ovdDefault: boolean

Default Value: false

Override Default
paymentAccount: string

Payment Account
reversalButton: string

Default Value: N

Reversal button
rsp: string

Reversal Supported Possible Values Y-Yes, N-No
signatureVerifyIndicator: string

Indiactes if Signature Verification is Needed for the Transaction
tillUpdate: boolean

Default Value: true

Till Update
txnBranchCcy: string

Currency of the Branch in which Transaction is Done
txnBranchCode: string

Branch Code in which Transaction is Done
txnBranchDate: string(date)

Date of the Branch in which Transaction is Done
txnDate: string

Branch Date in which transaction has happened
txnType: string

Type of the Transaction That is Done

{
    "type":"object",
    "description":"Additional Configuration Master Model",
    "properties":{
        "signatureVerifyIndicator":{
            "type":"string",
            "description":"Indiactes if Signature Verification is Needed for the Transaction"
        },
        "hostStatus":{
            "type":"string",
            "description":"Host Status during Transaction"
        },
        "hostMultiTripId":{
            "type":"string",
            "description":"Unique ID to identify the Trips with Host"
        },
        "txnBranchCcy":{
            "type":"string",
            "description":"Currency of the Branch in which Transaction is Done"
        },
        "txnBranchDate":{
            "type":"string",
            "format":"date",
            "description":"Date of the Branch in which Transaction is Done"
        },
        "txnType":{
            "type":"string",
            "description":"Type of the Transaction That is Done"
        },
        "cashInOutIndicator":{
            "type":"string",
            "description":"Cash In/Out Indicator Possible Values  I,O, IO (FX case)"
        },
        "ejLoggingRequired":{
            "type":"string",
            "description":"Teller Sq required/logged  Default Value Y Possible Values Y-Yes, N-No"
        },
        "ejTxnAmtMapping":{
            "type":"string",
            "description":"EJ TXN Amount Mapping Possible Values FROM or TO"
        },
        "ejTxnCcyMapping":{
            "type":"string",
            "description":"EJ TXN Currency Mapping Possible Values FROM or TO"
        },
        "adviceName":{
            "type":"string",
            "description":"Advice Name"
        },
        "orchestratorId":{
            "type":"string",
            "description":"Orchestrator Id"
        },
        "rsp":{
            "type":"string",
            "description":"Reversal Supported Possible Values Y-Yes, N-No"
        },
        "isReversal":{
            "type":"string",
            "description":"is it reversal",
            "default":"N"
        },
        "isObpayApproval":{
            "type":"string",
            "description":"is it obpay approval",
            "default":"Y"
        },
        "isObpayReversalApproval":{
            "type":"string",
            "description":"is it reversal obpay approval",
            "default":"N"
        },
        "isAdvice":{
            "type":"string",
            "description":"is advice generation required or not",
            "default":"N"
        },
        "isReversalAdvice":{
            "type":"string",
            "description":"is reversal advice generation required or not",
            "default":"N"
        },
        "reversalButton":{
            "type":"string",
            "description":"Reversal button",
            "default":"N"
        },
        "ignoreApproval":{
            "type":"boolean",
            "description":"ignore approval or not",
            "default":false
        },
        "ignoreWarning":{
            "type":"boolean",
            "description":"ignore warning or not",
            "default":false
        },
        "isExternal":{
            "type":"boolean",
            "description":"Is External call",
            "default":false
        },
        "tillUpdate":{
            "type":"boolean",
            "description":"Till Update",
            "default":true
        },
        "ovdDefault":{
            "type":"boolean",
            "description":"Override Default",
            "default":false
        },
        "crossCcyEnabled":{
            "type":"string",
            "description":"crossCcyEnabled Indicator Possible Values N,Y"
        },
        "isTotChargesReq":{
            "type":"string",
            "description":"isTotChargesReq Indicator Possible Values  N,Y"
        },
        "isNewChargesEnabled":{
            "type":"string",
            "description":"isNewChargesEnabled Indicator Possible Values  N,Y"
        },
        "isFetchAccImages":{
            "type":"string",
            "description":"isFetchAccImages Indicator Possible Values  N,Y"
        },
        "mobile":{
            "type":"string",
            "description":"Mobile number of the Customer Involved in the Transaction"
        },
        "email":{
            "type":"string",
            "description":"email of the Customer Involved in the Transaction"
        },
        "txnBranchCode":{
            "type":"string",
            "description":"Branch Code in which Transaction is Done"
        },
        "mandatorySignatureFlag":{
            "type":"string",
            "description":"Mandatory Signature Flag"
        },
        "paymentAccount":{
            "type":"string",
            "description":"Payment Account"
        },
        "txnDate":{
            "type":"string",
            "description":"Branch Date in which transaction has happened"
        }
    }
}

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 : TransactionDetails

Type: object

Transaction Master Model

Show Source

accountType: string

Account Type of the Account involved in the Transaction
assignmentMode: string

Assigment Mode of the Request
authoriserComments: string

Authoriser Comments to be Captured for the Transaction
eventCode: string

Event Code to identify the Events occuring in the Transaction
functionCode: string

Unique Function Code to Identify the Type of Transaction
inflowAmt: number

Inflow Amount
inflowCcy: string

Inflow Currency received in which the transaction is Done
multiAuthResponseFlag: string

multiAuth Authorizer approval status flag
onlineOfflineTxn: string

Offline Support Default Value N No
outflowAmt: number

Outflow Amount
outflowCcy: string

Outflow Currency paid out for the Transaction Done
overrideConfirmFlag: string

Identifies if the Overrides are confirmwed by the User
requestStatus: string

Status of the Request Received
ruleSuccessFlag: string

Default Value: N

RuleBased authorisation success flag
sourceRefNumber: string

Unique Reference number Generated by External System
subScreenClass: string

Identifies the type of business process under a function Id
supervisorId: string

Unique Supervisor Id for Approval
tellerSeqNumber: string

Teller Sequence Number generated during the transaction
tvOpen: string

Default Value: N

flag for till Vault Open Screen
txnAmount: string

Amount for which the transaction is Processes
txnBranchCcy: string

Currency of the Branch in which transaction has happened
txnBranchCode: string

Branch Code in which transaction has happened
txnBranchDate: string(date)

Date of the Branch in which transaction has happened
txnCcy: string

Currency in which Transaction is Happening
txnId: string

Unique Transaction ID of the Request
txnRefNumber: string

Branch Transaction Reference Number for the request
userComments: string

User Comments to be captured for the transaction
vamApplicable: string

Default Value: N

Vam account or not

{
    "type":"object",
    "description":"Transaction Master Model",
    "properties":{
        "functionCode":{
            "type":"string",
            "description":"Unique Function Code to Identify the Type of Transaction"
        },
        "subScreenClass":{
            "type":"string",
            "description":"Identifies the type of business process under a function Id"
        },
        "txnBranchCode":{
            "type":"string",
            "description":"Branch Code in which transaction has happened"
        },
        "txnBranchCcy":{
            "type":"string",
            "description":"Currency of the Branch in which transaction has happened"
        },
        "txnBranchDate":{
            "type":"string",
            "format":"date",
            "description":"Date of the Branch in which transaction has happened"
        },
        "requestStatus":{
            "type":"string",
            "description":"Status of the Request Received"
        },
        "assignmentMode":{
            "type":"string",
            "description":"Assigment Mode of the Request"
        },
        "txnId":{
            "type":"string",
            "description":"Unique Transaction ID of the Request"
        },
        "txnRefNumber":{
            "type":"string",
            "description":"Branch Transaction Reference Number for the request"
        },
        "tellerSeqNumber":{
            "type":"string",
            "description":"Teller Sequence Number generated during the transaction"
        },
        "overrideConfirmFlag":{
            "type":"string",
            "description":"Identifies if the Overrides are confirmwed by the User"
        },
        "ruleSuccessFlag":{
            "type":"string",
            "description":"RuleBased authorisation success flag",
            "default":"N"
        },
        "supervisorId":{
            "type":"string",
            "description":"Unique Supervisor Id for Approval"
        },
        "onlineOfflineTxn":{
            "type":"string",
            "description":"Offline Support Default Value N No"
        },
        "userComments":{
            "type":"string",
            "description":"User Comments to be captured for the transaction"
        },
        "authoriserComments":{
            "type":"string",
            "description":"Authoriser Comments to be Captured for the Transaction"
        },
        "eventCode":{
            "type":"string",
            "description":"Event Code to identify the Events occuring in the Transaction"
        },
        "accountType":{
            "type":"string",
            "description":"Account Type of the Account involved in the Transaction"
        },
        "txnAmount":{
            "type":"string",
            "description":"Amount for which the transaction is Processes"
        },
        "txnCcy":{
            "type":"string",
            "description":"Currency in which Transaction is Happening"
        },
        "sourceRefNumber":{
            "type":"string",
            "description":"Unique Reference number Generated by External System"
        },
        "vamApplicable":{
            "type":"string",
            "description":"Vam account or not",
            "default":"N"
        },
        "inflowCcy":{
            "type":"string",
            "description":"Inflow Currency received in which the transaction is Done"
        },
        "inflowAmt":{
            "type":"number",
            "description":"Inflow Amount"
        },
        "outflowCcy":{
            "type":"string",
            "description":"Outflow Currency paid out for the Transaction Done"
        },
        "outflowAmt":{
            "type":"number",
            "description":"Outflow Amount"
        },
        "multiAuthResponseFlag":{
            "type":"string",
            "description":"multiAuth Authorizer approval status flag"
        },
        "tvOpen":{
            "type":"string",
            "description":"flag for till Vault Open Screen",
            "default":"N"
        }
    }
}

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

Create Account Transfer description

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.