REST API for Oracle Banking Virtual Account Management

Download Transaction Enquiry

post

/service/txnEnquiryDownload

This API returns a base64 encoded CSV file containing Transaction Enquiry details based on input parameters.

Request

Supported Media Types

application/json
application/xml

Header Parameters

sourceCode(required): string

Source from which request is initiated

Request body contains data required to create generate CSV file

Root Schema : EnquiryInputDTO

Type: object

Match All

Show Source

object EnquiryInputDTO-allOf[0]

{
    "type":"object",
    "allOf":[
        {
            "type":"object",
            "properties":{
                "virtualAccount":{
                    "type":"string",
                    "description":"Virtual Account Number that is being enquired"
                },
                "virtualIdentifier":{
                    "type":"string",
                    "description":"Virtual Identifier that is being enquired"
                },
                "drCr":{
                    "type":"string",
                    "description":"Debit/Credit Indicator",
                    "pattern":"[D,C]"
                },
                "transactionCcy":{
                    "type":"string",
                    "description":"Transaction currency"
                },
                "sourceCode":{
                    "type":"string",
                    "description":"Source Code"
                },
                "transactionFrom":{
                    "type":"string",
                    "description":"Source of Transaction",
                    "pattern":"[J,I]"
                },
                "includeHierarchy":{
                    "type":"string",
                    "description":"Flag to determine if Child Virtual Accounts to be included",
                    "pattern":"[Y,N]"
                },
                "fromDate":{
                    "type":"string",
                    "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}",
                    "description":"Date from when the transactions have to be fetched"
                },
                "toDate":{
                    "type":"string",
                    "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}",
                    "description":"Date till when the transactions have to be fetched"
                }
            },
            "required":[
                "fromDate",
                "toDate"
            ]
        }
    ]
}

Nested Schema : EnquiryInputDTO-allOf[0]

Type: object

Show Source

drCr: string

Pattern: [D,C]

Debit/Credit Indicator
fromDate(required): string

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

Date from when the transactions have to be fetched
includeHierarchy: string

Pattern: [Y,N]

Flag to determine if Child Virtual Accounts to be included
sourceCode: string

Source Code
toDate(required): string

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

Date till when the transactions have to be fetched
transactionCcy: string

Transaction currency
transactionFrom: string

Pattern: [J,I]

Source of Transaction
virtualAccount: string

Virtual Account Number that is being enquired
virtualIdentifier: string

Virtual Identifier that is being enquired

{
    "type":"object",
    "properties":{
        "virtualAccount":{
            "type":"string",
            "description":"Virtual Account Number that is being enquired"
        },
        "virtualIdentifier":{
            "type":"string",
            "description":"Virtual Identifier that is being enquired"
        },
        "drCr":{
            "type":"string",
            "description":"Debit/Credit Indicator",
            "pattern":"[D,C]"
        },
        "transactionCcy":{
            "type":"string",
            "description":"Transaction currency"
        },
        "sourceCode":{
            "type":"string",
            "description":"Source Code"
        },
        "transactionFrom":{
            "type":"string",
            "description":"Source of Transaction",
            "pattern":"[J,I]"
        },
        "includeHierarchy":{
            "type":"string",
            "description":"Flag to determine if Child Virtual Accounts to be included",
            "pattern":"[Y,N]"
        },
        "fromDate":{
            "type":"string",
            "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}",
            "description":"Date from when the transactions have to be fetched"
        },
        "toDate":{
            "type":"string",
            "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}",
            "description":"Date till when the transactions have to be fetched"
        }
    },
    "required":[
        "fromDate",
        "toDate"
    ]
}

Response

Supported Media Types

application/json
application/xml
text/csv

201 Response

Returns message of success or failure

Headers

Location: string

Root Schema : AdviceResponse

Type: object

Advice Response

Show Source

documentInbase64: string

Document in Base64
documentNature: string

Document Content Type for the document
documentReferenceId: string

Document Id for the document

{
    "description":"Advice Response",
    "type":"object",
    "properties":{
        "documentReferenceId":{
            "description":"Document Id for the document",
            "type":"string"
        },
        "documentInbase64":{
            "description":"Document in Base64",
            "type":"string"
        },
        "documentNature":{
            "description":"Document Content Type for the document",
            "type":"string"
        }
    }
}

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