REST API for Oracle Banking Virtual Account Management

Get Transaction Enquiry

get

/service/obvamStatementServices

This API returns Transaction Enquiry records based on the parameters provided.

Request

Supported Media Types

application/json
application/xml

Query Parameters

accountType(optional): string
authStat(optional): string
drCr(optional): string
fromDate: string

Pattern: [0-9]{4}[-][0-9]{2}[-][0-9]{2}
includeHierarchy(optional): string

Pattern: [Y,N]

Default Value: N
limit(optional): integer

limit is maximum no of records to be fetched
offset(optional): integer

offset is starting no of records to be fetched
processingRefNo(optional): string
sourceCode(optional): string
toDate: string

Pattern: [0-9]{4}[-][0-9]{2}[-][0-9]{2}
transactionCcy(optional): string
transactionFrom(optional): string
transactionStatus(optional): string
trnCode(optional): string
trnDate(optional): string
valueDate(optional): string
virtualAccount(optional): string
virtualIdentifier(optional): string

Response

Supported Media Types

application/json
text/csv
application/xml

201 Response

Returns message of success or failure

Headers

Location: string

Root Schema : EntriesServiceDTOCollection

Type: object

Collection of entries.

Show Source

data(optional): array data
paging(optional): object PagingDto

{
    "description":"Collection of entries.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/EntriesServiceDTO"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : data

Type: array

Show Source

Array of: object EntriesServiceDTO

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

Nested Schema : PagingDto

Type: object

Show Source

totalResults(optional): integer

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer"
        }
    }
}

Nested Schema : EntriesServiceDTO

Type: object

Match All

Show Source

object EntriesServiceDTO-allOf[0]

{
    "type":"object",
    "allOf":[
        {
            "type":"object",
            "properties":{
                "processingRefNo":{
                    "type":"string",
                    "description":"Processing Reference Number of the transaction"
                },
                "serialNo":{
                    "type":"number",
                    "description":"Serial Number"
                },
                "transactionStatus":{
                    "type":"string",
                    "description":"Transaction Status"
                },
                "trnCode":{
                    "type":"string",
                    "description":"Transaction Code"
                },
                "txnDesc":{
                    "type":"string",
                    "description":"Transaction Code Description"
                },
                "runningBalance":{
                    "type":"number",
                    "description":"Running Balance"
                },
                "drCr":{
                    "type":"string",
                    "description":"Debit/Credit indicator"
                },
                "virtualAccount":{
                    "type":"string",
                    "description":"Virtual Account Number"
                },
                "virtualIdentifier":{
                    "type":"string",
                    "description":"Virtual Identifier"
                },
                "accountCcy":{
                    "type":"string",
                    "description":"Virtual Account Currency"
                },
                "accountCcyAmount":{
                    "type":"number",
                    "description":"Amount in Virtual Account Currency"
                },
                "transactionCcy":{
                    "type":"string",
                    "description":"Transaction Currency"
                },
                "transactionAmount":{
                    "type":"number",
                    "description":"Transaction Amount"
                },
                "trnDate":{
                    "type":"string",
                    "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}",
                    "description":"Transaction Date"
                },
                "valueDate":{
                    "type":"string",
                    "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}",
                    "description":"Value Date"
                },
                "addlText":{
                    "type":"string",
                    "description":"Customer narrative information received from External System or User can also enter the addl text during transactions"
                },
                "exchRate":{
                    "type":"number",
                    "description":"Exchange Rate"
                },
                "reconciliationRefNo":{
                    "type":"string",
                    "description":"Reconciliation Reference Number"
                },
                "sourceCode":{
                    "type":"string",
                    "description":"Source Code"
                },
                "sourceRefNo":{
                    "type":"string",
                    "description":"Source Reference Number"
                },
                "showInStmt":{
                    "type":"string",
                    "description":"Show in statement"
                },
                "stmtDate":{
                    "type":"string",
                    "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}",
                    "description":"Statement Date"
                },
                "accountType":{
                    "type":"string",
                    "description":"Account Type"
                },
                "transactionFrom":{
                    "type":"string",
                    "description":"Source of transaction (Journal/Internal Transfer)"
                },
                "realAccountNo":{
                    "type":"string",
                    "description":"Real Account Number"
                },
                "realAccountBrn":{
                    "type":"string",
                    "description":"Branch code of Real Account Number"
                },
                "realAccCcy":{
                    "type":"string",
                    "description":"Currency of Real Account Number"
                },
                "excRateTxccyRaccy":{
                    "type":"number",
                    "description":"Exchange rate between Transaction Currency and Real Account Currency"
                },
                "amtInRealAccCcy":{
                    "type":"number",
                    "description":"Transaction Amount in Real Account Currency"
                },
                "realAccClass":{
                    "type":"string",
                    "description":"Account Class of Real Account Number"
                },
                "authStat":{
                    "type":"string",
                    "description":"Authorization Status"
                }
            }
        }
    ]
}

Nested Schema : EntriesServiceDTO-allOf[0]

Type: object

Show Source

accountCcy(optional): string

Virtual Account Currency
accountCcyAmount(optional): number

Amount in Virtual Account Currency
accountType(optional): string

Account Type
addlText(optional): string

Customer narrative information received from External System or User can also enter the addl text during transactions
amtInRealAccCcy(optional): number

Transaction Amount in Real Account Currency
authStat(optional): string

Authorization Status
drCr(optional): string

Debit/Credit indicator
exchRate(optional): number

Exchange Rate
excRateTxccyRaccy(optional): number

Exchange rate between Transaction Currency and Real Account Currency
processingRefNo(optional): string

Processing Reference Number of the transaction
realAccCcy(optional): string

Currency of Real Account Number
realAccClass(optional): string

Account Class of Real Account Number
realAccountBrn(optional): string

Branch code of Real Account Number
realAccountNo(optional): string

Real Account Number
reconciliationRefNo(optional): string

Reconciliation Reference Number
runningBalance(optional): number

Running Balance
serialNo(optional): number

Serial Number
showInStmt(optional): string

Show in statement
sourceCode(optional): string

Source Code
sourceRefNo(optional): string

Source Reference Number
stmtDate(optional): string

Pattern: [0-9]{4}[-][0-9]{2}[-][0-9]{2}

Statement Date
transactionAmount(optional): number

Transaction Amount
transactionCcy(optional): string

Transaction Currency
transactionFrom(optional): string

Source of transaction (Journal/Internal Transfer)
transactionStatus(optional): string

Transaction Status
trnCode(optional): string

Transaction Code
trnDate(optional): string

Pattern: [0-9]{4}[-][0-9]{2}[-][0-9]{2}

Transaction Date
txnDesc(optional): string

Transaction Code Description
valueDate(optional): string

Pattern: [0-9]{4}[-][0-9]{2}[-][0-9]{2}

Value Date
virtualAccount(optional): string

Virtual Account Number
virtualIdentifier(optional): string

Virtual Identifier

{
    "type":"object",
    "properties":{
        "processingRefNo":{
            "type":"string",
            "description":"Processing Reference Number of the transaction"
        },
        "serialNo":{
            "type":"number",
            "description":"Serial Number"
        },
        "transactionStatus":{
            "type":"string",
            "description":"Transaction Status"
        },
        "trnCode":{
            "type":"string",
            "description":"Transaction Code"
        },
        "txnDesc":{
            "type":"string",
            "description":"Transaction Code Description"
        },
        "runningBalance":{
            "type":"number",
            "description":"Running Balance"
        },
        "drCr":{
            "type":"string",
            "description":"Debit/Credit indicator"
        },
        "virtualAccount":{
            "type":"string",
            "description":"Virtual Account Number"
        },
        "virtualIdentifier":{
            "type":"string",
            "description":"Virtual Identifier"
        },
        "accountCcy":{
            "type":"string",
            "description":"Virtual Account Currency"
        },
        "accountCcyAmount":{
            "type":"number",
            "description":"Amount in Virtual Account Currency"
        },
        "transactionCcy":{
            "type":"string",
            "description":"Transaction Currency"
        },
        "transactionAmount":{
            "type":"number",
            "description":"Transaction Amount"
        },
        "trnDate":{
            "type":"string",
            "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}",
            "description":"Transaction Date"
        },
        "valueDate":{
            "type":"string",
            "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}",
            "description":"Value Date"
        },
        "addlText":{
            "type":"string",
            "description":"Customer narrative information received from External System or User can also enter the addl text during transactions"
        },
        "exchRate":{
            "type":"number",
            "description":"Exchange Rate"
        },
        "reconciliationRefNo":{
            "type":"string",
            "description":"Reconciliation Reference Number"
        },
        "sourceCode":{
            "type":"string",
            "description":"Source Code"
        },
        "sourceRefNo":{
            "type":"string",
            "description":"Source Reference Number"
        },
        "showInStmt":{
            "type":"string",
            "description":"Show in statement"
        },
        "stmtDate":{
            "type":"string",
            "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}",
            "description":"Statement Date"
        },
        "accountType":{
            "type":"string",
            "description":"Account Type"
        },
        "transactionFrom":{
            "type":"string",
            "description":"Source of transaction (Journal/Internal Transfer)"
        },
        "realAccountNo":{
            "type":"string",
            "description":"Real Account Number"
        },
        "realAccountBrn":{
            "type":"string",
            "description":"Branch code of Real Account Number"
        },
        "realAccCcy":{
            "type":"string",
            "description":"Currency of Real Account Number"
        },
        "excRateTxccyRaccy":{
            "type":"number",
            "description":"Exchange rate between Transaction Currency and Real Account Currency"
        },
        "amtInRealAccCcy":{
            "type":"number",
            "description":"Transaction Amount in Real Account Currency"
        },
        "realAccClass":{
            "type":"string",
            "description":"Account Class of Real Account Number"
        },
        "authStat":{
            "type":"string",
            "description":"Authorization Status"
        }
    }
}

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.