Rest API for Oracle Banking Branch

External Transaction Till Service

post

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

External transaction request along with Till update

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: 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 any external Api transaction

Root Schema : ExternalTransaction

Type: object

Contains data required for any external Api transaction

Show Source

BatchOpenCloseReqd: string

Pattern: [Y,N]

Indicates whether batch to be open and closed for the transaction.
cashDS: object CashTxnDS

User Limits Model
chargeDtls: array chargeDtls
chargePickupReqd: string

Pattern: [Y,N]

Indicates whether charge pickup is required or not
customFlds: array customFlds
demDtls: array demDtls
DenomUpdReqd: string

Pattern: [Y,N]

Indicates whether denomination update is required or not .
extRefNo: string

Source Reference number for the transaction
functionCode: string

Function Code for the transaction
fxDemDtls: object FxDenomTxnDtls

Fx Denomination transaction Details
isFxWalkin: string

Pattern: [Y,N]

Indicates whether transaction is an FX walk-in txn
onlyJournalEntry: string

Pattern: [Y,N]

Indicates if transaction should not be processed and just put into electronic journal.
overrideDtls: array overrideDtls
sourceCode: string

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

Sub screen class code for the transaction
txnBranchCcy: string

Txn Branch Currency
txnDate: string

Transaction date for the transaction
txnDSDtls: object TransactionDSDtls

Transaction Data segment details model
txnRefNo: string

Reference number for the transaction

{
    "type":"object",
    "description":"Contains data required for any external Api transaction",
    "required":[
        "subScreenClass"
    ],
    "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 "
        },
        "txnRefNo":{
            "type":"string",
            "description":"Reference number for the transaction "
        },
        "txnDate":{
            "type":"string",
            "description":"Transaction date for the transaction "
        },
        "txnBranchCcy":{
            "type":"string",
            "description":"Txn Branch Currency"
        },
        "isFxWalkin":{
            "type":"string",
            "description":"Indicates whether transaction is an FX walk-in txn  ",
            "pattern":"[Y,N]"
        },
        "chargePickupReqd":{
            "type":"string",
            "description":"Indicates whether charge pickup is required or not",
            "pattern":"[Y,N]"
        },
        "BatchOpenCloseReqd":{
            "type":"string",
            "description":"Indicates whether batch to be open and closed for the transaction. ",
            "pattern":"[Y,N]"
        },
        "DenomUpdReqd":{
            "type":"string",
            "description":"Indicates whether denomination update is required or not . ",
            "pattern":"[Y,N]"
        },
        "onlyJournalEntry":{
            "type":"string",
            "description":"Indicates if transaction should not be processed and just put into electronic journal. ",
            "pattern":"[Y,N]"
        },
        "txnDSDtls":{
            "$ref":"#/definitions/TransactionDSDtls"
        },
        "overrideDtls":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/BaseOutcomeModel"
            }
        },
        "cashDS":{
            "$ref":"#/definitions/CashTxnDS"
        },
        "chargeDtls":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PrcDtls"
            }
        },
        "demDtls":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DenomTxnDtls"
            }
        },
        "fxDemDtls":{
            "$ref":"#/definitions/FxDenomTxnDtls"
        },
        "customFlds":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/customObj"
            }
        }
    }
}

Nested Schema : CashTxnDS

Type: object

User Limits Model

Show Source

AccountNo: string

Account Number
beneficiaryAddress1: string

beneficiaryAddress1
beneficiaryAddress2: string

beneficiaryAddress2
beneficiaryAddress3: string

beneficiaryAddress3
beneficiaryAddress4: string

beneficiaryAddress4
beneficiaryName: string

beneficiaryName
cashAmount: number

Cash Amount
cashAmt: number

Cash Amount
cashAmtCcy: string

Cash Amount Curreny
chequeDate: string(date)

Cheque Date
chequeNumber: string

Cheque Number
createdBy: string

Created By
createdTs: string(date)

Created time stamp
datasegment: string

CCA Name
ejId: string

EJ ID
emailId: string

Email
eventCode: string

Event Code
exchangeRate: number

Exchange Rate
fromAccountAmt: number

Amount Sold
fromAccountBranch: string

From Account Branch
fromAccountCcy: string

CURRENCY SOLD
fromAccountNumber: string

From Account Number
functionCode: string

Function Code
identificationNumber: string

Identification Number
identificationType: string

Identification Type
mobileNumber: string

Mobile Number
narrative: string

Narrative
negotiatedExchangeRate: number

Negotiated Exchange Rate
negotiationReferenceNumber: string

negotiation Reference Number
netAccountAmt: number

netAccountAmt
netAccountCcy: string

NetAccountCcy
orginalExchangeRate: number

Orginal Exchange Rate
originalExchangeRate: number

Original Exchange Rate
payee: string

Payee
productCode: string

Product Code
recievedAccountAmt: number

recievedAccountAmt
recievedAccountCcy: string

recievedAccountCcy
recordId: string

Unique ID for the record
referenceNumber: string

Reference No
rejectCode: string

Reject Code
reversalDate: string(date)

Reversal Date
stationId: string

Station ID
tellerId: string

TellerId
toAccountAmt: number

To Account Amount
toAccountBranch: string

To Account Branch
toAccountCcy: string

To Account Currency
toAccountNumber: string

To Account Number
totalCharges: number

TOTAL CHARGES
txnBranchCode: string

Txn Branch Code
txnControllerRefNo: string

Txn ref no from UI
txnCustomer: string

Txn Customer
txnDate: string(date)

Txn Date
txnRefNumber: string

Transaction Ref. No
txnSeqNumber: number

Teller Sl No
uniqueIdentifierNumber: string

Unique Identifier No
uniqueIdentifierType: string

Unique Identifier Type
updatedBy: string

Updated By
updatedTs: string(date)

Updated timestamp
userRefNumber: string

User Reference No
valueDate: string(date)

Value Date
versionNumber: number

Version No

{
    "type":"object",
    "description":"User Limits Model",
    "properties":{
        "datasegment":{
            "type":"string",
            "description":"CCA Name"
        },
        "fromAccountAmt":{
            "type":"number",
            "description":"Amount Sold"
        },
        "fromAccountCcy":{
            "type":"string",
            "description":"CURRENCY SOLD "
        },
        "toAccountCcy":{
            "type":"string",
            "description":"To Account Currency"
        },
        "beneficiaryName":{
            "type":"string",
            "description":"beneficiaryName"
        },
        "beneficiaryAddress1":{
            "type":"string",
            "description":"beneficiaryAddress1"
        },
        "beneficiaryAddress2":{
            "type":"string",
            "description":"beneficiaryAddress2"
        },
        "beneficiaryAddress3":{
            "type":"string",
            "description":"beneficiaryAddress3"
        },
        "beneficiaryAddress4":{
            "type":"string",
            "description":"beneficiaryAddress4"
        },
        "identificationType":{
            "type":"string",
            "description":"Identification Type"
        },
        "identificationNumber":{
            "type":"string",
            "description":"Identification Number"
        },
        "exchangeRate":{
            "type":"number",
            "description":"Exchange Rate"
        },
        "originalExchangeRate":{
            "type":"number",
            "description":"Original Exchange Rate"
        },
        "negotiatedExchangeRate":{
            "type":"number",
            "description":"Negotiated Exchange Rate"
        },
        "negotiationReferenceNumber":{
            "type":"string",
            "description":"negotiation Reference Number"
        },
        "recievedAccountCcy":{
            "type":"string",
            "description":"recievedAccountCcy"
        },
        "recievedAccountAmt":{
            "type":"number",
            "description":"recievedAccountAmt"
        },
        "totalCharges":{
            "type":"number",
            "description":"TOTAL CHARGES "
        },
        "cashAmount":{
            "type":"number",
            "description":"Cash Amount"
        },
        "netAccountCcy":{
            "type":"string",
            "description":"NetAccountCcy"
        },
        "netAccountAmt":{
            "type":"number",
            "description":"netAccountAmt"
        },
        "narrative":{
            "type":"string",
            "description":"Narrative"
        },
        "txnControllerRefNo":{
            "type":"string",
            "description":"Txn ref no from UI"
        },
        "recordId":{
            "type":"string",
            "description":"Unique ID for the record"
        },
        "cashAmtCcy":{
            "type":"string",
            "description":"Cash Amount Curreny"
        },
        "cashAmt":{
            "type":"number",
            "description":"Cash Amount"
        },
        "chequeDate":{
            "type":"string",
            "format":"date",
            "description":"Cheque Date"
        },
        "chequeNumber":{
            "type":"string",
            "description":"Cheque Number"
        },
        "eventCode":{
            "type":"string",
            "description":"Event Code"
        },
        "ejId":{
            "type":"string",
            "description":"EJ ID"
        },
        "emailId":{
            "type":"string",
            "description":"Email"
        },
        "fromAccountBranch":{
            "type":"string",
            "description":"From Account Branch"
        },
        "fromAccountNumber":{
            "type":"string",
            "description":"From Account Number"
        },
        "mobileNumber":{
            "type":"string",
            "description":"Mobile Number"
        },
        "orginalExchangeRate":{
            "type":"number",
            "description":"Orginal Exchange Rate"
        },
        "payee":{
            "type":"string",
            "description":"Payee"
        },
        "productCode":{
            "type":"string",
            "description":"Product Code"
        },
        "reversalDate":{
            "type":"string",
            "format":"date",
            "description":"Reversal Date"
        },
        "stationId":{
            "type":"string",
            "description":"Station ID"
        },
        "toAccountBranch":{
            "type":"string",
            "description":"To Account Branch"
        },
        "toAccountNumber":{
            "type":"string",
            "description":"To Account Number"
        },
        "toAccountAmt":{
            "type":"number",
            "description":"To Account Amount"
        },
        "txnBranchCode":{
            "type":"string",
            "description":"Txn Branch Code"
        },
        "functionCode":{
            "type":"string",
            "description":"Function Code"
        },
        "txnCustomer":{
            "type":"string",
            "description":"Txn Customer"
        },
        "tellerId":{
            "type":"string",
            "description":"TellerId"
        },
        "txnDate":{
            "type":"string",
            "format":"date",
            "description":"Txn Date"
        },
        "txnRefNumber":{
            "type":"string",
            "description":"Transaction Ref. No"
        },
        "txnSeqNumber":{
            "type":"number",
            "description":"Teller Sl No"
        },
        "uniqueIdentifierNumber":{
            "type":"string",
            "description":"Unique Identifier No"
        },
        "uniqueIdentifierType":{
            "type":"string",
            "description":"Unique Identifier Type"
        },
        "userRefNumber":{
            "type":"string",
            "description":"User Reference No"
        },
        "valueDate":{
            "type":"string",
            "format":"date",
            "description":"Value Date"
        },
        "versionNumber":{
            "type":"number",
            "description":"Version No"
        },
        "referenceNumber":{
            "type":"string",
            "description":"Reference No"
        },
        "rejectCode":{
            "type":"string",
            "description":"Reject Code"
        },
        "createdBy":{
            "type":"string",
            "description":"Created By"
        },
        "createdTs":{
            "type":"string",
            "format":"date",
            "description":"Created time stamp"
        },
        "updatedBy":{
            "type":"string",
            "description":"Updated By"
        },
        "updatedTs":{
            "type":"string",
            "format":"date",
            "description":"Updated timestamp"
        },
        "AccountNo":{
            "type":"string",
            "description":"Account Number"
        }
    }
}

Nested Schema : chargeDtls

Type: array

Show Source

Array of: object PrcDtls

Charge pricing details

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

Nested Schema : customFlds

Type: array

Show Source

Array of: object customObj

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

Nested Schema : demDtls

Type: array

Show Source

Array of: object DenomTxnDtls

Denomination Transaction Details

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

Nested Schema : FxDenomTxnDtls

Type: object

Fx Denomination transaction Details

Show Source

inFlowDemDtls: array inFlowDemDtls

Cash Inflow Denomination Details
outFlowDemDtls: array outFlowDemDtls

Cash Outflow Denomination Details

{
    "type":"object",
    "description":"Fx Denomination transaction Details",
    "properties":{
        "inFlowDemDtls":{
            "type":"array",
            "description":"Cash Inflow Denomination Details",
            "items":{
                "$ref":"#/definitions/FXInDenomTxnDtlsModel"
            }
        },
        "outFlowDemDtls":{
            "type":"array",
            "description":"Cash Outflow Denomination Details",
            "items":{
                "$ref":"#/definitions/FXOutDenomTxnDtlsModel"
            }
        }
    }
}

Nested Schema : overrideDtls

Type: array

Show Source

Array of: object BaseOutcomeModel

Base Model

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

Nested Schema : TransactionDSDtls

Type: object

Transaction Data segment details model

Show Source

accountType: string

Account Type
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
eventCode: string

Event Code
hostMultiTripId: string

Host Multitrip ID
hostStatus: string

Host Status
ignoreApproval: boolean

Default Value: false

ignore approval or not
ignoreWarning: boolean

Default Value: false

ignore warning or not
inflowAmt: number

Inflow Amount
inflowCcy: string

Inflow Currency
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

mandatorySignatureFlag Indicator Possible Values N,Y
mobile: string

Mobile number
onlineOfflineTxn: string

Offline Support Default Value N No
orchestratorId: string

Orchestrator Id
outflowAmt: number

Outflow Amount
outflowCcy: string

Outflow Currency
ovdDefault: boolean

Default Value: false

Override Default
overrideConfirmFlag: string

Override confirm flag
reversalButton: string

Default Value: N

Reversal button
rsp: string

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

Signature Verify Indicator
tillUpdate: boolean

Default Value: true

Till Update
txnBranchCcy: string

Txn Branch Currency
txnBranchCode: string

Transaction Branch Code
txnBranchDate: string

Txn Branch Date
txnType: string

Transaction Type

{
    "type":"object",
    "description":"Transaction Data segment details model",
    "properties":{
        "txnBranchCode":{
            "type":"string",
            "description":"Transaction Branch Code"
        },
        "inflowCcy":{
            "type":"string",
            "description":"Inflow Currency"
        },
        "inflowAmt":{
            "type":"number",
            "description":"Inflow Amount"
        },
        "outflowCcy":{
            "type":"string",
            "description":"Outflow Currency"
        },
        "outflowAmt":{
            "type":"number",
            "description":"Outflow Amount"
        },
        "overrideConfirmFlag":{
            "type":"string",
            "description":"Override confirm flag"
        },
        "accountType":{
            "type":"string",
            "description":"Account Type"
        },
        "onlineOfflineTxn":{
            "type":"string",
            "description":"Offline Support Default Value N No"
        },
        "eventCode":{
            "type":"string",
            "description":"Event Code"
        },
        "signatureVerifyIndicator":{
            "type":"string",
            "description":"Signature Verify Indicator"
        },
        "hostStatus":{
            "type":"string",
            "description":"Host Status"
        },
        "hostMultiTripId":{
            "type":"string",
            "description":"Host Multitrip ID"
        },
        "txnBranchCcy":{
            "type":"string",
            "description":"Txn Branch Currency"
        },
        "txnBranchDate":{
            "type":"string",
            "description":"Txn Branch Date"
        },
        "txnType":{
            "type":"string",
            "description":"Transaction Type"
        },
        "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"
        },
        "mandatorySignatureFlag":{
            "type":"string",
            "description":"mandatorySignatureFlag Indicator Possible Values  N,Y"
        },
        "mobile":{
            "type":"string",
            "description":"Mobile number"
        },
        "email":{
            "type":"string",
            "description":"email"
        }
    }
}

Nested Schema : PrcDtls

Type: object

Charge pricing details

Show Source

chargeAmt: number

Charge Amount
chargeBasis: string

Indicates the charge basis
chargeByCash: string

Indicates if charge is collected by cash
chargeCategory: string

Indicates the charge category
chargeCcy: string

Charge Currency
chargeCode: string

Charge Code
chargeCreditAccount: string

Indicates the account to which charges will be credited
chargeDebitAccount: string

Indicates the account from which charges are debited
chargeDebitLeg: string

Charge debit leg (Whom)
chargeDescription: string

Charge Description
chargeId: string

Pick up Charge id to use in accounting
chargeSharing: string

Identifies if the charge is shared Between the Accounts Involved
chgCrTxnCode: string

Indicates the charge credit transaction code
chgDrTxnCode: string

Indicates the charge debit transaction Code
detailsId: string

Pickup Charge details Id to use in accounting
exchangeRate: number

Exchange rate for the charges
maxChgAmount: number

Indicates maximum charge amount
maxChgPct: number

Indicates the maximum charge percentage
minChgAmount: number

Indicates the minimum charge amount
minChgPct: number

Indicates the minimum charge percentage
minMaxValidationCriteria: string

Indicates the minimum and maximum value criteria
originalChargeAmt: number

Original Charge Amount
parentId: string

parent id
priceRuleId: string

Indicates pricing rule Id
waiver: string

Waiver

{
    "type":"object",
    "description":"Charge pricing details",
    "properties":{
        "chargeCode":{
            "type":"string",
            "description":"Charge Code"
        },
        "parentId":{
            "type":"string",
            "description":"parent id"
        },
        "chargeCcy":{
            "type":"string",
            "description":"Charge Currency"
        },
        "chargeDescription":{
            "type":"string",
            "description":"Charge Description"
        },
        "originalChargeAmt":{
            "type":"number",
            "description":"Original Charge Amount"
        },
        "chargeAmt":{
            "type":"number",
            "description":"Charge Amount"
        },
        "waiver":{
            "type":"string",
            "description":"Waiver"
        },
        "chargeDebitLeg":{
            "type":"string",
            "description":"Charge debit leg (Whom)"
        },
        "detailsId":{
            "type":"string",
            "description":"Pickup Charge details Id to use in accounting"
        },
        "chargeId":{
            "type":"string",
            "description":"Pick up Charge id to use in accounting "
        },
        "chargeSharing":{
            "type":"string",
            "description":"Identifies if the charge is shared Between the Accounts Involved"
        },
        "exchangeRate":{
            "type":"number",
            "description":"Exchange rate for the charges"
        },
        "minMaxValidationCriteria":{
            "type":"string",
            "description":"Indicates the minimum and maximum value criteria"
        },
        "maxChgAmount":{
            "type":"number",
            "description":"Indicates maximum charge amount"
        },
        "maxChgPct":{
            "type":"number",
            "description":"Indicates the maximum charge percentage"
        },
        "minChgAmount":{
            "type":"number",
            "description":"Indicates the minimum charge amount"
        },
        "minChgPct":{
            "type":"number",
            "description":"Indicates the minimum charge percentage"
        },
        "chgCrTxnCode":{
            "type":"string",
            "description":"Indicates the charge credit transaction code"
        },
        "chgDrTxnCode":{
            "type":"string",
            "description":"Indicates the charge debit transaction Code"
        },
        "chargeCreditAccount":{
            "type":"string",
            "description":"Indicates the account to which charges will be credited"
        },
        "chargeDebitAccount":{
            "type":"string",
            "description":"Indicates the account from which charges are debited"
        },
        "chargeCategory":{
            "type":"string",
            "description":"Indicates the charge category"
        },
        "chargeBasis":{
            "type":"string",
            "description":"Indicates the charge basis"
        },
        "chargeByCash":{
            "type":"string",
            "description":"Indicates if charge is collected by cash"
        },
        "priceRuleId":{
            "type":"string",
            "description":"Indicates pricing rule Id"
        }
    }
}

Nested Schema : customObj

Type: object

Nested Schema : DenomTxnDtls

Type: object

Denomination Transaction Details

Show Source

denomCode(required): string

Demon Code
denomCodeValue(required): string

Demon Code Value
denomType(required): string

Demon Type
inOutIndicator(required): string

InOut Indicator
openingBalance: number

Cash Balance
openingCount: number

Cash Count
parentId: string

Parent ID
recordId: string

Unique ID for the record
tellerId: string

User ID
units(required): number

Units
value(required): number

Value

{
    "type":"object",
    "description":"Denomination Transaction Details",
    "required":[
        "denomCode",
        "denomCodeValue",
        "denomType",
        "inOutIndicator",
        "units",
        "value"
    ],
    "properties":{
        "recordId":{
            "type":"string",
            "description":"Unique ID for the record"
        },
        "parentId":{
            "type":"string",
            "description":"Parent ID"
        },
        "denomCode":{
            "type":"string",
            "description":"Demon Code"
        },
        "denomCodeValue":{
            "type":"string",
            "description":"Demon Code Value"
        },
        "denomType":{
            "type":"string",
            "description":"Demon Type"
        },
        "units":{
            "type":"number",
            "description":"Units"
        },
        "value":{
            "type":"number",
            "description":"Value"
        },
        "inOutIndicator":{
            "type":"string",
            "description":"InOut Indicator"
        },
        "tellerId":{
            "type":"string",
            "description":"User ID"
        },
        "openingBalance":{
            "type":"number",
            "description":"Cash Balance"
        },
        "openingCount":{
            "type":"number",
            "description":"Cash Count"
        }
    }
}

Nested Schema : inFlowDemDtls

Type: array

Cash Inflow Denomination Details

Show Source

Array of: object FXInDenomTxnDtlsModel

{
    "type":"array",
    "description":"Cash Inflow Denomination Details",
    "items":{
        "$ref":"#/definitions/FXInDenomTxnDtlsModel"
    }
}

Nested Schema : outFlowDemDtls

Type: array

Cash Outflow Denomination Details

Show Source

Array of: object FXOutDenomTxnDtlsModel

{
    "type":"array",
    "description":"Cash Outflow Denomination Details",
    "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"
        }
    }
}

Nested Schema : BaseOutcomeModel

Type: object

Base Model

Show Source

code: string

Code
description: string

Description
language: string

Language
type: string

Type

{
    "type":"object",
    "description":"Base Model",
    "properties":{
        "code":{
            "type":"string",
            "description":"Code"
        },
        "description":{
            "type":"string",
            "description":"Description"
        },
        "type":{
            "type":"string",
            "description":"Type"
        },
        "language":{
            "type":"string",
            "description":"Language"
        }
    }
}

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.