REST API for Oracle Banking Virtual Account Management

Generate MT942 statement

post

/service/statement/mt942

This endpoint is used to generate MT942 statement for the given virtual account / entity.

Request

Supported Media Types

application/json
application/xml

Request Body that contains data required for generating statement

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
application/xml
text/csv

201 Response

Returns message of succes or failure

Headers

Location: string

Root Schema : MessageOutDTOCollection

Type: object

Collection of SWIFT / CAMT messages.

Show Source

data: array data
messages: object ResponseDto


{
    "description":"Collection of SWIFT / CAMT messages.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/MessageOutDTO"
            }
        },
        "messages":{
            "$ref":"#/definitions/ResponseDto"
        }
    }
}

Nested Schema : data

Type: array

Show Source

Array of: object MessageOutDTO

SWIFT / CAMT message


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

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

Type: object

SWIFT / CAMT message

Show Source

branch: string
branchDate: string
id: string
makerDtStamp: string(date)
makerId: string
message: string
msgType: string
parentReferenceNo: string
referenceNo: string
virtualAccountNo: string
virtualEntityId: string

Virtual Entity id for accounts


{
    "description":"SWIFT / CAMT message",
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "branch":{
            "type":"string"
        },
        "branchDate":{
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "msgType":{
            "type":"string"
        },
        "parentReferenceNo":{
            "type":"string"
        },
        "referenceNo":{
            "type":"string"
        },
        "virtualAccountNo":{
            "type":"string"
        },
        "makerId":{
            "type":"string"
        },
        "makerDtStamp":{
            "type":"string",
            "format":"date"
        },
        "virtualEntityId":{
            "description":"Virtual Entity id for accounts",
            "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

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

405 Response

Invalid input

500 Response

Internal error

Oracle Account

Oracle Account

Sign in to Cloud

REST API for Oracle Banking Virtual Account Management

Generate MT942 statement

Request

Response

201 Response

400 Response

401 Response

403 Response

405 Response

500 Response