REST API for Oracle Banking Virtual Account Management

Adds a new File to obvam

post

/service/account/handoffProcess

This endpoint is used to add a new File to obvam.

Request

Supported Media Types

application/json

Fetches the starting number of the offset records

Root Schema : FileDetailsDTO

Type: object

Match All

Show Source

object FileDetailsDTO-allOf[0]

{
    "type":"object",
    "allOf":[
        {
            "type":"object",
            "properties":{
                "fileRefId":{
                    "type":"number",
                    "description":"File Reference ID"
                },
                "internalRefId":{
                    "type":"string",
                    "description":"Internal Reference Id"
                },
                "workflowInstanceId":{
                    "type":"string",
                    "description":"Workflow Instance Id"
                },
                "fileStatus":{
                    "type":"string",
                    "description":"Status of File"
                },
                "cacheVersion":{
                    "type":"integer",
                    "description":"Cache Version"
                },
                "fileOriginalName":{
                    "type":"string",
                    "description":"File Original Name"
                },
                "fileModifiedName":{
                    "type":"string",
                    "description":"File modified Name"
                },
                "fileSize":{
                    "type":"integer",
                    "format":"int64",
                    "description":"Size of file for parsing"
                },
                "formatName":{
                    "type":"string"
                },
                "createdBy":{
                    "type":"string",
                    "description":"Indicates the system who have created the file"
                },
                "createdDate":{
                    "type":"string",
                    "format":"date",
                    "description":"File Creation Date"
                },
                "modifiedBy":{
                    "type":"string",
                    "description":"Indicate the user who modified the file"
                },
                "modifiedDate":{
                    "type":"string",
                    "format":"date"
                },
                "transactionId":{
                    "type":"string"
                },
                "transactionName":{
                    "type":"string"
                },
                "transactionModNo":{
                    "type":"integer"
                },
                "formatId":{
                    "type":"string"
                },
                "formatModNo":{
                    "type":"integer"
                },
                "channelId":{
                    "type":"string"
                },
                "channelModNo":{
                    "type":"integer"
                },
                "corporateId":{
                    "type":"string"
                },
                "corporateModNo":{
                    "type":"integer"
                },
                "corporateRef":{
                    "type":"string"
                },
                "totalRecords":{
                    "type":"integer"
                },
                "successRecords":{
                    "type":"integer"
                },
                "failedRecords":{
                    "type":"integer"
                },
                "totalAmount":{
                    "type":"number"
                },
                "totalAmountCurrency":{
                    "type":"string"
                },
                "messageId":{
                    "type":"string",
                    "description":""
                },
                "initiatingPartyName":{
                    "type":"string",
                    "description":""
                },
                "initiatingPartyId":{
                    "type":"string",
                    "description":""
                },
                "initiatingPartyCD":{
                    "type":"string",
                    "description":""
                },
                "initiatingPartyAddress":{
                    "type":"object",
                    "description":"",
                    "additionalProperties":{
                        "type":"string"
                    }
                },
                "groupStatus":{
                    "type":"string",
                    "description":""
                },
                "groupStatusReasonCode":{
                    "type":"string",
                    "description":""
                },
                "noOfHandoff":{
                    "type":"integer",
                    "description":""
                },
                "handoffId":{
                    "type":"string",
                    "description":""
                },
                "corelationLevel":{
                    "type":"string",
                    "description":""
                },
                "recordPersist":{
                    "type":"boolean",
                    "description":""
                },
                "chunkSize":{
                    "type":"number",
                    "description":""
                },
                "chunkIndex":{
                    "type":"number",
                    "description":""
                },
                "totalChunks":{
                    "type":"number",
                    "description":""
                },
                "retryCount":{
                    "type":"integer",
                    "description":""
                },
                "retryForChunk":{
                    "type":"array",
                    "items":{
                        "type":"integer"
                    }
                },
                "fieldData":{
                    "type":"object",
                    "description":"",
                    "additionalProperties":{
                        "type":"string"
                    }
                },
                "recordList":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/RecordDTO"
                    }
                },
                "exceptionList":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/ExceptionDetailDTO"
                    }
                }
            },
            "required":[
                "fileRefId",
                "initiatingPartyId"
            ]
        }
    ]
}

Nested Schema : FileDetailsDTO-allOf[0]

Type: object

Show Source

cacheVersion(optional): integer

Cache Version
channelId(optional): string
channelModNo(optional): integer
chunkIndex(optional): number
chunkSize(optional): number
corelationLevel(optional): string
corporateId(optional): string
corporateModNo(optional): integer
corporateRef(optional): string
createdBy(optional): string

Indicates the system who have created the file
createdDate(optional): string(date)

File Creation Date
exceptionList(optional): array exceptionList
failedRecords(optional): integer
fieldData(optional): object fieldData

Additional Properties Allowed: additionalProperties
fileModifiedName(optional): string

File modified Name
fileOriginalName(optional): string

File Original Name
fileRefId: number

File Reference ID
fileSize(optional): integer(int64)

Size of file for parsing
fileStatus(optional): string

Status of File
formatId(optional): string
formatModNo(optional): integer
formatName(optional): string
groupStatus(optional): string
groupStatusReasonCode(optional): string
handoffId(optional): string
initiatingPartyAddress(optional): object initiatingPartyAddress

Additional Properties Allowed: additionalProperties
initiatingPartyCD(optional): string
initiatingPartyId: string
initiatingPartyName(optional): string
internalRefId(optional): string

Internal Reference Id
messageId(optional): string
modifiedBy(optional): string

Indicate the user who modified the file
modifiedDate(optional): string(date)
noOfHandoff(optional): integer
recordList(optional): array recordList
recordPersist(optional): boolean
retryCount(optional): integer
retryForChunk(optional): array retryForChunk
successRecords(optional): integer
totalAmount(optional): number
totalAmountCurrency(optional): string
totalChunks(optional): number
totalRecords(optional): integer
transactionId(optional): string
transactionModNo(optional): integer
transactionName(optional): string
workflowInstanceId(optional): string

Workflow Instance Id

{
    "type":"object",
    "properties":{
        "fileRefId":{
            "type":"number",
            "description":"File Reference ID"
        },
        "internalRefId":{
            "type":"string",
            "description":"Internal Reference Id"
        },
        "workflowInstanceId":{
            "type":"string",
            "description":"Workflow Instance Id"
        },
        "fileStatus":{
            "type":"string",
            "description":"Status of File"
        },
        "cacheVersion":{
            "type":"integer",
            "description":"Cache Version"
        },
        "fileOriginalName":{
            "type":"string",
            "description":"File Original Name"
        },
        "fileModifiedName":{
            "type":"string",
            "description":"File modified Name"
        },
        "fileSize":{
            "type":"integer",
            "format":"int64",
            "description":"Size of file for parsing"
        },
        "formatName":{
            "type":"string"
        },
        "createdBy":{
            "type":"string",
            "description":"Indicates the system who have created the file"
        },
        "createdDate":{
            "type":"string",
            "format":"date",
            "description":"File Creation Date"
        },
        "modifiedBy":{
            "type":"string",
            "description":"Indicate the user who modified the file"
        },
        "modifiedDate":{
            "type":"string",
            "format":"date"
        },
        "transactionId":{
            "type":"string"
        },
        "transactionName":{
            "type":"string"
        },
        "transactionModNo":{
            "type":"integer"
        },
        "formatId":{
            "type":"string"
        },
        "formatModNo":{
            "type":"integer"
        },
        "channelId":{
            "type":"string"
        },
        "channelModNo":{
            "type":"integer"
        },
        "corporateId":{
            "type":"string"
        },
        "corporateModNo":{
            "type":"integer"
        },
        "corporateRef":{
            "type":"string"
        },
        "totalRecords":{
            "type":"integer"
        },
        "successRecords":{
            "type":"integer"
        },
        "failedRecords":{
            "type":"integer"
        },
        "totalAmount":{
            "type":"number"
        },
        "totalAmountCurrency":{
            "type":"string"
        },
        "messageId":{
            "type":"string",
            "description":""
        },
        "initiatingPartyName":{
            "type":"string",
            "description":""
        },
        "initiatingPartyId":{
            "type":"string",
            "description":""
        },
        "initiatingPartyCD":{
            "type":"string",
            "description":""
        },
        "initiatingPartyAddress":{
            "type":"object",
            "description":"",
            "additionalProperties":{
                "type":"string"
            }
        },
        "groupStatus":{
            "type":"string",
            "description":""
        },
        "groupStatusReasonCode":{
            "type":"string",
            "description":""
        },
        "noOfHandoff":{
            "type":"integer",
            "description":""
        },
        "handoffId":{
            "type":"string",
            "description":""
        },
        "corelationLevel":{
            "type":"string",
            "description":""
        },
        "recordPersist":{
            "type":"boolean",
            "description":""
        },
        "chunkSize":{
            "type":"number",
            "description":""
        },
        "chunkIndex":{
            "type":"number",
            "description":""
        },
        "totalChunks":{
            "type":"number",
            "description":""
        },
        "retryCount":{
            "type":"integer",
            "description":""
        },
        "retryForChunk":{
            "type":"array",
            "items":{
                "type":"integer"
            }
        },
        "fieldData":{
            "type":"object",
            "description":"",
            "additionalProperties":{
                "type":"string"
            }
        },
        "recordList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/RecordDTO"
            }
        },
        "exceptionList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ExceptionDetailDTO"
            }
        }
    },
    "required":[
        "fileRefId",
        "initiatingPartyId"
    ]
}

Nested Schema : exceptionList

Type: array

Show Source

Array of: object ExceptionDetailDTO

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

Nested Schema : fieldData

Type: object

Additional Properties Allowed

Show Source

string

{
    "type":"object",
    "description":"",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : initiatingPartyAddress

Type: object

Additional Properties Allowed

Show Source

string

{
    "type":"object",
    "description":"",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : recordList

Type: array

Show Source

Array of: object RecordDTO

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

Nested Schema : retryForChunk

Type: array

Show Source

Array of: integer

{
    "type":"array",
    "items":{
        "type":"integer"
    }
}

Nested Schema : ExceptionDetailDTO

Type: object

Show Source

CreatedDate(optional): string(date)
exceptionArgs(optional): string
exceptionCode(optional): string
lineNo(optional): integer

{
    "type":"object",
    "properties":{
        "exceptionCode":{
            "type":"string",
            "description":""
        },
        "exceptionArgs":{
            "type":"string",
            "description":""
        },
        "lineNo":{
            "type":"integer",
            "description":""
        },
        "CreatedDate":{
            "type":"string",
            "format":"date",
            "description":""
        }
    }
}

Nested Schema : RecordDTO

Type: object

Show Source

convertedAmount(optional): number
convertedCurrency(optional): string
createdBy(optional): string
createdDate(optional): string(date)
exceptionList(optional): array exceptionList
fieldData(optional): object fieldData

Additional Properties Allowed: additionalProperties
fileRefId(optional): number
fxRate(optional): number
modifiedBy(optional): string
modifiedDate(optional): string(date)
recordId(optional): number
statusCodes(optional): string
transactionId(optional): string
transactionModNo(optional): integer
txnStatus(optional): string

{
    "type":"object",
    "properties":{
        "recordId":{
            "type":"number",
            "description":""
        },
        "fileRefId":{
            "type":"number",
            "description":""
        },
        "modifiedBy":{
            "type":"string",
            "description":""
        },
        "modifiedDate":{
            "type":"string",
            "format":"date"
        },
        "txnStatus":{
            "type":"string",
            "description":""
        },
        "statusCodes":{
            "type":"string",
            "description":""
        },
        "transactionId":{
            "type":"string",
            "description":""
        },
        "transactionModNo":{
            "type":"integer",
            "description":""
        },
        "createdDate":{
            "type":"string",
            "format":"date"
        },
        "createdBy":{
            "type":"string",
            "description":""
        },
        "fxRate":{
            "type":"number",
            "description":""
        },
        "convertedCurrency":{
            "type":"string",
            "description":""
        },
        "convertedAmount":{
            "type":"number",
            "description":""
        },
        "fieldData":{
            "type":"object",
            "description":"",
            "additionalProperties":{
                "type":"string"
            }
        },
        "exceptionList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ExceptionDetailDTO"
            }
        }
    }
}

Nested Schema : exceptionList

Type: array

Show Source

Array of: object ExceptionDetailDTO

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

Nested Schema : fieldData

Type: object

Additional Properties Allowed

Show Source

string

{
    "type":"object",
    "description":"",
    "additionalProperties":{
        "type":"string"
    }
}

Response

Supported Media Types

application/json

201 Response

Returns message of succes or failure

Headers

Location: string

File Received

Root Schema : ResponseDtoWrapper

Type: object

Show Source

messages(optional): object ResponseDto

{
    "type":"object",
    "properties":{
        "messages":{
            "$ref":"#/definitions/ResponseDto"
        }
    }
}

Nested Schema : ResponseDto

Type: object

Show Source

codes(optional): array codes
id(optional): string
requestId(optional): string
status(optional): 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(optional): string
args(optional): array args
Code(optional): string
Desc(optional): string
Language(optional): string
Type(optional): 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

Adds a new File to obvam

Request

Response

201 Response

400 Response

401 Response

403 Response

405 Response

500 Response