REST API for Oracle Banking Virtual Account Management

Close a statement preference by Entity ID.

patch

/service/statementprefs/{entityId}/close

This endpoint is used for Close a statement preference. Add additional information here for this endpoint.

Request

Supported Media Types

application/json
application/xml

Path Parameters

entityId(required): string

Entity ID of the statement prefs Maintenance

Header Parameters

sourceCode(required): string

Source from which request is initiated

Request body contain statementprefs and Modification no of statementprefs maintenance which need to be closed"

Root Schema : KeyDto

Type: object

Show Source

modNo: integer
remarks: string

{
    "type":"object",
    "properties":{
        "modNo":{
            "type":"integer"
        },
        "remarks":{
            "type":"string"
        }
    }
}

Response

Supported Media Types

application/json
text/csv
application/xml

201 Response

Returns message of success or failure

Headers

Location: string

URL of newly created statement preference

Root Schema : StatementPrefResponseDtoWrapper

Type: object

Show Source

data: object StatementPreferencesDTO
messages: object ResponseDto

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

Nested Schema : StatementPreferencesDTO

Type: object

Match All

Show Source

allOf GenericDto
object StatementPreferencesDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "txnControllerRefNo":{
                    "type":"string",
                    "description":"Transaction Reference ID that is generated for every operation performed"
                },
                "virtualEntityId":{
                    "type":"string",
                    "description":"Virtual Entity ID for which statement preferences is maintained"
                },
                "statementType":{
                    "type":"string",
                    "description":"Type of the statement - Consolidated/Account level",
                    "pattern":"[A,C]"
                },
                "frequency":{
                    "type":"string",
                    "description":"Frequency of statement - Daily/Weekly/Monthly/Quarterly/half yearly/Yearly",
                    "pattern":"[D,W,M,Q,H,Y]"
                },
                "dueOn":{
                    "type":"number",
                    "description":"Statement due date",
                    "pattern":"([0-9]+)?"
                },
                "lastStmntGenDate":{
                    "type":"string"
                },
                "generateMt940":{
                    "type":"string",
                    "description":"Generate MT940 during EOD",
                    "pattern":"[Y,N]"
                },
                "generateMt950":{
                    "type":"string",
                    "description":"Generate MT950 during EOD",
                    "pattern":"[Y,N]"
                },
                "displayIban":{
                    "type":"string",
                    "description":"Display Virtual IBAN in Swift Messages",
                    "pattern":"[Y,N]"
                },
                "generatePdf":{
                    "type":"string",
                    "description":"Generate PDF statement during EOD",
                    "pattern":"[Y,N]"
                },
                "generateCamt053":{
                    "type":"string",
                    "description":"Generate CAMT.053 during EOD",
                    "pattern":"[Y,N]"
                },
                "generateMt942":{
                    "type":"string",
                    "description":"Generate MT942",
                    "pattern":"[Y,N]"
                },
                "genMt942OnMovement":{
                    "type":"string",
                    "description":"Generate MT942 on movement",
                    "pattern":"[Y,N]"
                },
                "mt942RepTxnSince":{
                    "type":"string",
                    "description":"Report transactions since for MT942"
                },
                "mt942GenTime":{
                    "type":"string",
                    "description":"Comma separated time for generating MT942"
                },
                "generateCamt052":{
                    "type":"string",
                    "description":"Generate CAMT.052",
                    "pattern":"[Y,N]"
                },
                "genCamt052OnMovement":{
                    "type":"string",
                    "description":"Generate CAMT.052 on movement",
                    "pattern":"[Y,N]"
                },
                "camt052RepTxnSince":{
                    "type":"string",
                    "description":"Report transactions since for CAMT.052"
                },
                "camt052GenTime":{
                    "type":"string",
                    "description":"Comma separated time for generating CAMT.052"
                }
            },
            "required":[
                "virtualEntityId"
            ]
        }
    ]
}

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 : 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 : StatementPreferencesDTO-allOf[1]

Type: object

Show Source

camt052GenTime: string

Comma separated time for generating CAMT.052
camt052RepTxnSince: string

Report transactions since for CAMT.052
displayIban: string

Pattern: [Y,N]

Display Virtual IBAN in Swift Messages
dueOn: number

Pattern: ([0-9]+)?

Statement due date
frequency: string

Pattern: [D,W,M,Q,H,Y]

Frequency of statement - Daily/Weekly/Monthly/Quarterly/half yearly/Yearly
genCamt052OnMovement: string

Pattern: [Y,N]

Generate CAMT.052 on movement
generateCamt052: string

Pattern: [Y,N]

Generate CAMT.052
generateCamt053: string

Pattern: [Y,N]

Generate CAMT.053 during EOD
generateMt940: string

Pattern: [Y,N]

Generate MT940 during EOD
generateMt942: string

Pattern: [Y,N]

Generate MT942
generateMt950: string

Pattern: [Y,N]

Generate MT950 during EOD
generatePdf: string

Pattern: [Y,N]

Generate PDF statement during EOD
genMt942OnMovement: string

Pattern: [Y,N]

Generate MT942 on movement
lastStmntGenDate: string
mt942GenTime: string

Comma separated time for generating MT942
mt942RepTxnSince: string

Report transactions since for MT942
statementType: string

Pattern: [A,C]

Type of the statement - Consolidated/Account level
txnControllerRefNo: string

Transaction Reference ID that is generated for every operation performed
virtualEntityId(required): string

Virtual Entity ID for which statement preferences is maintained

{
    "type":"object",
    "properties":{
        "txnControllerRefNo":{
            "type":"string",
            "description":"Transaction Reference ID that is generated for every operation performed"
        },
        "virtualEntityId":{
            "type":"string",
            "description":"Virtual Entity ID for which statement preferences is maintained"
        },
        "statementType":{
            "type":"string",
            "description":"Type of the statement - Consolidated/Account level",
            "pattern":"[A,C]"
        },
        "frequency":{
            "type":"string",
            "description":"Frequency of statement - Daily/Weekly/Monthly/Quarterly/half yearly/Yearly",
            "pattern":"[D,W,M,Q,H,Y]"
        },
        "dueOn":{
            "type":"number",
            "description":"Statement due date",
            "pattern":"([0-9]+)?"
        },
        "lastStmntGenDate":{
            "type":"string"
        },
        "generateMt940":{
            "type":"string",
            "description":"Generate MT940 during EOD",
            "pattern":"[Y,N]"
        },
        "generateMt950":{
            "type":"string",
            "description":"Generate MT950 during EOD",
            "pattern":"[Y,N]"
        },
        "displayIban":{
            "type":"string",
            "description":"Display Virtual IBAN in Swift Messages",
            "pattern":"[Y,N]"
        },
        "generatePdf":{
            "type":"string",
            "description":"Generate PDF statement during EOD",
            "pattern":"[Y,N]"
        },
        "generateCamt053":{
            "type":"string",
            "description":"Generate CAMT.053 during EOD",
            "pattern":"[Y,N]"
        },
        "generateMt942":{
            "type":"string",
            "description":"Generate MT942",
            "pattern":"[Y,N]"
        },
        "genMt942OnMovement":{
            "type":"string",
            "description":"Generate MT942 on movement",
            "pattern":"[Y,N]"
        },
        "mt942RepTxnSince":{
            "type":"string",
            "description":"Report transactions since for MT942"
        },
        "mt942GenTime":{
            "type":"string",
            "description":"Comma separated time for generating MT942"
        },
        "generateCamt052":{
            "type":"string",
            "description":"Generate CAMT.052",
            "pattern":"[Y,N]"
        },
        "genCamt052OnMovement":{
            "type":"string",
            "description":"Generate CAMT.052 on movement",
            "pattern":"[Y,N]"
        },
        "camt052RepTxnSince":{
            "type":"string",
            "description":"Report transactions since for CAMT.052"
        },
        "camt052GenTime":{
            "type":"string",
            "description":"Comma separated time for generating CAMT.052"
        }
    },
    "required":[
        "virtualEntityId"
    ]
}

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