REST API for Oracle Banking Virtual Account Management

Adds a new Ack File to obvam

post

/service/account/h2hAckFile

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

Request

Supported Media Types

application/json
application/xml

Fetches the starting number of the offset records

Root Schema : AckFileDTO

Type: object

Match All

Show Source

object AckFileDTO-allOf[0]

{
    "type":"object",
    "allOf":[
        {
            "type":"object",
            "properties":{
                "fileRefId":{
                    "type":"number",
                    "description":"File Reference ID"
                },
                "ackfileRefId":{
                    "type":"number",
                    "description":"Ack File Reference ID"
                },
                "ackfileName":{
                    "type":"string",
                    "description":"Ack File Name"
                },
                "ackfileChannelName":{
                    "type":"string",
                    "description":"Ack File Channel Name"
                },
                "ackResponseIdentifier":{
                    "type":"string",
                    "description":"Ack Response Identifier"
                },
                "ackfileStatus":{
                    "type":"string",
                    "description":"Ack File Status"
                },
                "chunkSize":{
                    "type":"number",
                    "description":""
                },
                "chunkIndex":{
                    "type":"number",
                    "description":""
                },
                "totalChunks":{
                    "type":"number",
                    "description":""
                },
                "totalRecords":{
                    "type":"integer"
                },
                "recordList":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/AckRecordDTO"
                    }
                }
            },
            "required":[
                "fileRefId",
                "ackfileRefId",
                "ackfileName"
            ]
        }
    ]
}

Nested Schema : AckFileDTO-allOf[0]

Type: object

Show Source

ackfileChannelName(optional): string

Ack File Channel Name
ackfileName: string

Ack File Name
ackfileRefId: number

Ack File Reference ID
ackfileStatus(optional): string

Ack File Status
ackResponseIdentifier(optional): string

Ack Response Identifier
chunkIndex(optional): number
chunkSize(optional): number
fileRefId: number

File Reference ID
recordList(optional): array recordList
totalChunks(optional): number
totalRecords(optional): integer

{
    "type":"object",
    "properties":{
        "fileRefId":{
            "type":"number",
            "description":"File Reference ID"
        },
        "ackfileRefId":{
            "type":"number",
            "description":"Ack File Reference ID"
        },
        "ackfileName":{
            "type":"string",
            "description":"Ack File Name"
        },
        "ackfileChannelName":{
            "type":"string",
            "description":"Ack File Channel Name"
        },
        "ackResponseIdentifier":{
            "type":"string",
            "description":"Ack Response Identifier"
        },
        "ackfileStatus":{
            "type":"string",
            "description":"Ack File Status"
        },
        "chunkSize":{
            "type":"number",
            "description":""
        },
        "chunkIndex":{
            "type":"number",
            "description":""
        },
        "totalChunks":{
            "type":"number",
            "description":""
        },
        "totalRecords":{
            "type":"integer"
        },
        "recordList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/AckRecordDTO"
            }
        }
    },
    "required":[
        "fileRefId",
        "ackfileRefId",
        "ackfileName"
    ]
}

Nested Schema : recordList

Type: array

Show Source

Array of: object AckRecordDTO

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

Nested Schema : AckRecordDTO

Type: object

Show Source

exceptionList(optional): array exceptionList
lineNo(optional): number
recordId(optional): number
status(optional): string

{
    "type":"object",
    "properties":{
        "recordId":{
            "type":"number",
            "description":""
        },
        "lineNo":{
            "type":"number",
            "description":""
        },
        "status":{
            "type":"string",
            "description":""
        },
        "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 : 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":""
        }
    }
}

Response

Supported Media Types

application/json
text/csv
application/xml

201 Response

Returns message of success or failure

Headers

Location: string

File Received

Root Schema : ResponseDtoWrapper

Type: object

Show Source

data(optional): object ResponseResourceSupport
messages(optional): object ResponseDto

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

Nested Schema : ResponseResourceSupport

Type: object

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