REST API for Oracle Banking Virtual Account Management

Get all valid entity bank parameters

get

/service/entitybankparameters

This endpoint is used to get entity bank parameters.

Request

Supported Media Types

application/json
application/xml

Query Parameters

authStat(optional): string
bankCode(optional): string
checkerId(optional): string
includecloseandunauth(optional): boolean

includecloseandunauth need to be set to fetch summary record, defult value is false
limit(optional): integer

limit is maximum no of records to be fetched
makerId(optional): string
offset(optional): integer

offset is starting no of records to be fetched
recordStat(optional): string
virtualEntityMask(optional): string

Response

Supported Media Types

application/json
application/xml

201 Response

Returns message of succes or failure

Headers

Location: string

Root Schema : EntityBankParametersServiceCollection

Type: object

Collection of bankparameters.

Show Source

data(optional): array data
paging(optional): object PagingDto

{
    "description":"Collection of bankparameters.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/EntityBankParametersServiceDTO"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : data

Type: array

Show Source

Array of: object EntityBankParametersServiceDTO

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

Nested Schema : PagingDto

Type: object

Show Source

totalResults(optional): integer

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer"
        }
    }
}

Nested Schema : EntityBankParametersServiceDTO

Type: object

Match All

Show Source

object EntityBankParametersServiceDTO-allOf[0]

{
    "type":"object",
    "allOf":[
        {
            "type":"object",
            "properties":{
                "bankCode":{
                    "type":"string",
                    "description":"Bank code in which virtual account is created",
                    "minLength":3,
                    "maxLength":4,
                    "pattern":"^[a-zA-Z0-9]+$"
                },
                "virtualEntityMask":{
                    "type":"string",
                    "description":"Mask for virtual Entity identification number",
                    "minLength":1,
                    "maxLength":12,
                    "pattern":"^[an]+$"
                },
                "makerId":{
                    "type":"string",
                    "description":"Maker ID of Virtual Account"
                },
                "makerDateStamp":{
                    "type":"string",
                    "description":"Date and Time when Virtual Account is created or modified or closed or reopened"
                },
                "checkerId":{
                    "type":"string",
                    "description":"Checker ID of Virtual Account"
                },
                "checkerDateStamp":{
                    "type":"string",
                    "description":"Date and Time when some action on Virtual Account is authorized"
                },
                "modNo":{
                    "type":"integer",
                    "description":"Version number of Virtual Account"
                },
                "recordStatus":{
                    "type":"string",
                    "description":"Record Status of Virtual Account"
                },
                "authStatus":{
                    "type":"string",
                    "description":"Authorization Status of Virtual Account"
                },
                "onceAuth":{
                    "type":"string",
                    "description":"Flag that indicated if Virtual Account is authorized once or not"
                },
                "doerRemarks":{
                    "type":"string",
                    "description":"Remarks made by Maker"
                },
                "approverRemarks":{
                    "type":"string",
                    "description":"Remarks made by Approver"
                }
            },
            "required":[
                "bankCode",
                "virtualEntityMask"
            ]
        }
    ]
}

Nested Schema : EntityBankParametersServiceDTO-allOf[0]

Type: object

Show Source

approverRemarks(optional): string

Remarks made by Approver
authStatus(optional): string

Authorization Status of Virtual Account
bankCode: string

Minimum Length: 3

Maximum Length: 4

Pattern: ^[a-zA-Z0-9]+$

Bank code in which virtual account is created
checkerDateStamp(optional): string

Date and Time when some action on Virtual Account is authorized
checkerId(optional): string

Checker ID of Virtual Account
doerRemarks(optional): string

Remarks made by Maker
makerDateStamp(optional): string

Date and Time when Virtual Account is created or modified or closed or reopened
makerId(optional): string

Maker ID of Virtual Account
modNo(optional): integer

Version number of Virtual Account
onceAuth(optional): string

Flag that indicated if Virtual Account is authorized once or not
recordStatus(optional): string

Record Status of Virtual Account
virtualEntityMask: string

Minimum Length: 1

Maximum Length: 12

Pattern: ^[an]+$

Mask for virtual Entity identification number

{
    "type":"object",
    "properties":{
        "bankCode":{
            "type":"string",
            "description":"Bank code in which virtual account is created",
            "minLength":3,
            "maxLength":4,
            "pattern":"^[a-zA-Z0-9]+$"
        },
        "virtualEntityMask":{
            "type":"string",
            "description":"Mask for virtual Entity identification number",
            "minLength":1,
            "maxLength":12,
            "pattern":"^[an]+$"
        },
        "makerId":{
            "type":"string",
            "description":"Maker ID of Virtual Account"
        },
        "makerDateStamp":{
            "type":"string",
            "description":"Date and Time when Virtual Account is created or modified or closed or reopened"
        },
        "checkerId":{
            "type":"string",
            "description":"Checker ID of Virtual Account"
        },
        "checkerDateStamp":{
            "type":"string",
            "description":"Date and Time when some action on Virtual Account is authorized"
        },
        "modNo":{
            "type":"integer",
            "description":"Version number of Virtual Account"
        },
        "recordStatus":{
            "type":"string",
            "description":"Record Status of Virtual Account"
        },
        "authStatus":{
            "type":"string",
            "description":"Authorization Status of Virtual Account"
        },
        "onceAuth":{
            "type":"string",
            "description":"Flag that indicated if Virtual Account is authorized once or not"
        },
        "doerRemarks":{
            "type":"string",
            "description":"Remarks made by Maker"
        },
        "approverRemarks":{
            "type":"string",
            "description":"Remarks made by Approver"
        }
    },
    "required":[
        "bankCode",
        "virtualEntityMask"
    ]
}

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.