REST API for Oracle Banking Virtual Account Management Cloud Service

Get all valid obvam-statement-services

post

/service/accStatement

This endpoints is used to generate account statements for an entity.

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 a new obvam-statement-services.

Root Schema : StatementInDTO

Type: object

Match All

Show Source

allOf GenericDto
object StatementInDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "virtualEntity":{
                    "type":"string",
                    "description":"Virtual entity for which the account statement has to be generated."
                },
                "virtualAccountNumber":{
                    "type":"string",
                    "description":"Virtual account number for which the account statement has to be generated. Please give ALL for consolidated report"
                },
                "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":[
                "virtualEntity",
                "fromDate",
                "toDate"
            ]
        }
    ]
}

Nested Schema : GenericDto

Match All

Show Source

object GenericDto-allOf[0]

Discriminator: resource_type

{
    "allOf":[
        {
            "type":"object",
            "discriminator":"resource_type"
        }
    ]
}

Nested Schema : GenericDto-allOf[0]

Type: object

Discriminator: resource_type

Nested Schema : StatementInDTO-allOf[1]

Type: object

Show Source

fromDate(required): string

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

Date from when the transactions have to be fetched
toDate(required): string

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

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

Virtual account number for which the account statement has to be generated. Please give ALL for consolidated report
virtualEntity(required): string

Virtual entity for which the account statement has to be generated.

{
    "type":"object",
    "properties":{
        "virtualEntity":{
            "type":"string",
            "description":"Virtual entity for which the account statement has to be generated."
        },
        "virtualAccountNumber":{
            "type":"string",
            "description":"Virtual account number for which the account statement has to be generated. Please give ALL for consolidated report"
        },
        "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":[
        "virtualEntity",
        "fromDate",
        "toDate"
    ]
}

Response

Supported Media Types

application/json
text/csv
application/xml

201 Response

Returns message of succes or failure

Headers

Location: string

Root Schema : StatementAdviceDTOCollection

Type: object

Collection of entries.

Show Source

data: object AdviceResponse

Advice Response
messages: object ResponseDto

{
    "description":"Collection of entries.",
    "type":"object",
    "properties":{
        "data":{
            "$ref":"#/definitions/AdviceResponse"
        },
        "messages":{
            "$ref":"#/definitions/ResponseDto"
        }
    }
}

Nested 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"
        }
    }
}

Nested Schema : ResponseDto

Type: object

Show Source

codes: array codes
id: string
requestId: string
status: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "codes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ResponseCode"
            }
        },
        "requestId":{
            "type":"string"
        }
    }
}

Nested Schema : codes

Type: array

Show Source

Array of: object ResponseCode

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

Nested Schema : ResponseCode

Type: object

Show Source

arg: string
args: array args
Code: string
Desc: string
Language: 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"
        }
    }
}

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