REST API for Oracle Banking Virtual Account Management

Get all valid account branch parameters

get

/service/accountbranchparameters

This enpoint is used to get all valid account branch parameters maintained.

Request

Supported Media Types

application/json
application/xml

Query Parameters

accAutoGenerate(optional): string
authStat(optional): string
bbanBankCode(optional): string
bbanBrnCode(optional): string
bbanDataType(optional): string
bbanFormatMsk(optional): string
branchCode(optional): string
branchGroup(optional): string
checkerId(optional): string
checksumAlgorithm(optional): string
corporateSpecificRangeRequired(optional): string
endAccNumber(optional): integer
fixedValue(optional): string
ibanChkDigAlgo(optional): string
ibanCntryCd(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
realCustomerNo(optional): string
recordStat(optional): string
startAccNumber(optional): integer
virtualAccountMask(optional): string

Header Parameters

sourceCode: string

Source from which request is initiated

Response

Supported Media Types

application/json
application/xml

201 Response

Returns message of succes or failure

Headers

Location: string

Root Schema : BranchParametersServiceCollection

Type: object

Collection of account.

Show Source

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

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

Nested Schema : data

Type: array

Show Source

Array of: object BranchParametersServiceDTO

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

Nested Schema : PagingDto

Type: object

Show Source

totalResults(optional): integer

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

Nested Schema : BranchParametersServiceDTO

Type: object

Match All

Show Source

object BranchParametersServiceDTO-allOf[0]

{
    "type":"object",
    "allOf":[
        {
            "type":"object",
            "properties":{
                "branchCode":{
                    "type":"string",
                    "description":"Branch code in which virtual account is created.",
                    "minLength":3,
                    "maxLength":3,
                    "pattern":"^[a-zA-Z0-9]+$"
                },
                "virtualAccountMask":{
                    "type":"string",
                    "description":"Mask for virtual account number",
                    "minLength":0,
                    "maxLength":20,
                    "pattern":"^[bcvtnsfd\\$]*$"
                },
                "checksumAlgorithm":{
                    "type":"string",
                    "description":"Algorithm required to generate checksum."
                },
                "startAccNumber":{
                    "type":"number",
                    "description":"Start serial number of the account",
                    "minLength":0,
                    "maxLength":20,
                    "pattern":"^[0-9]*$"
                },
                "endAccNumber":{
                    "type":"number",
                    "description":"End serial number of the account.",
                    "minLength":0,
                    "maxLength":20,
                    "pattern":"^[0-9]*$"
                },
                "accAutoGenerate":{
                    "type":"string",
                    "description":"Enable/disable auto generation of account number.",
                    "minLength":0,
                    "maxLength":1,
                    "pattern":"^[Y,N]$"
                },
                "ibanCntryCd":{
                    "type":"string",
                    "description":"Country Code.",
                    "minLength":0,
                    "maxLength":3,
                    "pattern":"^$|^[a-zA-Z0-9]+$"
                },
                "ibanChkDigAlgo":{
                    "type":"string",
                    "description":"Algorithm required for IBAN check digit generation",
                    "minLength":0,
                    "maxLength":30
                },
                "bbanFormatMsk":{
                    "type":"string",
                    "description":"BBAN format mask.",
                    "minLength":0,
                    "maxLength":30,
                    "pattern":"^[bszdthli]*$"
                },
                "bbanDataType":{
                    "type":"string",
                    "description":"Data type of each field defined as part of BBAN mask",
                    "minLength":0,
                    "maxLength":30,
                    "pattern":"^[anc]*$"
                },
                "bbanChkDigAlgo":{
                    "type":"string",
                    "description":"Algorithm required for BBAN check digit generation",
                    "minLength":0,
                    "maxLength":30
                },
                "bbanBankCode":{
                    "type":"string",
                    "description":"Bank code should be given if bank code is part of BBAN mask.",
                    "minLength":0,
                    "maxLength":20,
                    "pattern":"^[a-zA-Z0-9]+$"
                },
                "bbanBrnCode":{
                    "type":"string",
                    "description":"Branch code should be given if branch code is part of BBAN mask",
                    "minLength":0,
                    "maxLength":20,
                    "pattern":"^[a-zA-Z0-9]+$"
                },
                "fixedValue":{
                    "type":"string",
                    "description":"",
                    "minLength":0,
                    "maxLength":1,
                    "pattern":"^$|^[a-zA-Z0-9]+$"
                },
                "rateType":{
                    "type":"string",
                    "description":"Rate Type"
                },
                "rateCode":{
                    "type":"string",
                    "description":"Rate Code can be Mid Rate(M) or Buy/Sell Rate(B)",
                    "pattern":"[M,B]",
                    "minLength":0,
                    "maxLength":1
                },
                "normalVariance":{
                    "type":"number",
                    "description":"Variance that is allowed for Exchange Rate (percentage)",
                    "minimum":0,
                    "maximum":100
                },
                "maxVariance":{
                    "type":"number",
                    "description":"Maximum variance allowed for Exchange Rate (percentage)",
                    "minimum":0,
                    "maximum":100
                },
                "amtBlkQueueReq":{
                    "type":"string",
                    "description":"Flag to indicate if queue is required for Amount Block",
                    "pattern":"[Y,N]"
                },
                "txnJnlQueueReq":{
                    "type":"string",
                    "description":"Flag to indicate if queue is required for Transaction Journal",
                    "pattern":"[Y,N]"
                },
                "vaRateType":{
                    "type":"string",
                    "description":"Rate Type for Child Contributions"
                },
                "vaRateCode":{
                    "type":"string",
                    "description":"Rate Code for Child Contributions can be Mid Rate(M) or Buy/Sell Rate(B)",
                    "pattern":"[M,B]",
                    "minLength":0,
                    "maxLength":1
                },
                "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"
                },
                "corporateSpecificRangeRequired":{
                    "type":"string",
                    "description":"Flag to indicate if corporate specific account number range is required or not for the branch",
                    "pattern":"[Y,N]",
                    "minLength":0,
                    "maxLength":1
                },
                "extAccNumberGeneration":{
                    "type":"string",
                    "description":"External Account number Generation Required?",
                    "pattern":"[Y,N]"
                },
                "extIBANGeneration":{
                    "type":"string",
                    "description":"External IBAN Generation Required?",
                    "pattern":"[Y,N]"
                },
                "branchName":{
                    "type":"string",
                    "description":"Name of the Branch for Virtual Account",
                    "minimum":0,
                    "maximum":105
                },
                "branchGroup":{
                    "type":"string",
                    "description":"Branch Group code"
                }
            }
        }
    ]
}

Nested Schema : BranchParametersServiceDTO-allOf[0]

Type: object

Show Source

accAutoGenerate(optional): string

Minimum Length: 0

Maximum Length: 1

Pattern: ^[Y,N]$

Enable/disable auto generation of account number.
amtBlkQueueReq(optional): string

Pattern: [Y,N]

Flag to indicate if queue is required for Amount Block
approverRemarks(optional): string

Remarks made by Approver
authStatus(optional): string

Authorization Status of Virtual Account
bbanBankCode(optional): string

Minimum Length: 0

Maximum Length: 20

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

Bank code should be given if bank code is part of BBAN mask.
bbanBrnCode(optional): string

Minimum Length: 0

Maximum Length: 20

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

Branch code should be given if branch code is part of BBAN mask
bbanChkDigAlgo(optional): string

Minimum Length: 0

Maximum Length: 30

Algorithm required for BBAN check digit generation
bbanDataType(optional): string

Minimum Length: 0

Maximum Length: 30

Pattern: ^[anc]*$

Data type of each field defined as part of BBAN mask
bbanFormatMsk(optional): string

Minimum Length: 0

Maximum Length: 30

Pattern: ^[bszdthli]*$

BBAN format mask.
branchCode(optional): string

Minimum Length: 3

Maximum Length: 3

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

Branch code in which virtual account is created.
branchGroup(optional): string

Branch Group code
branchName(optional): string

Minimum Value: 0

Maximum Value: 105

Name of the Branch for Virtual Account
checkerDateStamp(optional): string

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

Checker ID of Virtual Account
checksumAlgorithm(optional): string

Algorithm required to generate checksum.
corporateSpecificRangeRequired(optional): string

Minimum Length: 0

Maximum Length: 1

Pattern: [Y,N]

Flag to indicate if corporate specific account number range is required or not for the branch
doerRemarks(optional): string

Remarks made by Maker
endAccNumber(optional): number

Minimum Length: 0

Maximum Length: 20

Pattern: ^[0-9]*$

End serial number of the account.
extAccNumberGeneration(optional): string

Pattern: [Y,N]

External Account number Generation Required?
extIBANGeneration(optional): string

Pattern: [Y,N]

External IBAN Generation Required?
fixedValue(optional): string

Minimum Length: 0

Maximum Length: 1

Pattern: ^$|^[a-zA-Z0-9]+$
ibanChkDigAlgo(optional): string

Minimum Length: 0

Maximum Length: 30

Algorithm required for IBAN check digit generation
ibanCntryCd(optional): string

Minimum Length: 0

Maximum Length: 3

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

Country Code.
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
maxVariance(optional): number

Minimum Value: 0

Maximum Value: 100

Maximum variance allowed for Exchange Rate (percentage)
modNo(optional): integer

Version number of Virtual Account
normalVariance(optional): number

Minimum Value: 0

Maximum Value: 100

Variance that is allowed for Exchange Rate (percentage)
onceAuth(optional): string

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

Minimum Length: 0

Maximum Length: 1

Pattern: [M,B]

Rate Code can be Mid Rate(M) or Buy/Sell Rate(B)
rateType(optional): string

Rate Type
recordStatus(optional): string

Record Status of Virtual Account
startAccNumber(optional): number

Minimum Length: 0

Maximum Length: 20

Pattern: ^[0-9]*$

Start serial number of the account
txnJnlQueueReq(optional): string

Pattern: [Y,N]

Flag to indicate if queue is required for Transaction Journal
vaRateCode(optional): string

Minimum Length: 0

Maximum Length: 1

Pattern: [M,B]

Rate Code for Child Contributions can be Mid Rate(M) or Buy/Sell Rate(B)
vaRateType(optional): string

Rate Type for Child Contributions
virtualAccountMask(optional): string

Minimum Length: 0

Maximum Length: 20

Pattern: ^[bcvtnsfd\$]*$

Mask for virtual account number

{
    "type":"object",
    "properties":{
        "branchCode":{
            "type":"string",
            "description":"Branch code in which virtual account is created.",
            "minLength":3,
            "maxLength":3,
            "pattern":"^[a-zA-Z0-9]+$"
        },
        "virtualAccountMask":{
            "type":"string",
            "description":"Mask for virtual account number",
            "minLength":0,
            "maxLength":20,
            "pattern":"^[bcvtnsfd\\$]*$"
        },
        "checksumAlgorithm":{
            "type":"string",
            "description":"Algorithm required to generate checksum."
        },
        "startAccNumber":{
            "type":"number",
            "description":"Start serial number of the account",
            "minLength":0,
            "maxLength":20,
            "pattern":"^[0-9]*$"
        },
        "endAccNumber":{
            "type":"number",
            "description":"End serial number of the account.",
            "minLength":0,
            "maxLength":20,
            "pattern":"^[0-9]*$"
        },
        "accAutoGenerate":{
            "type":"string",
            "description":"Enable/disable auto generation of account number.",
            "minLength":0,
            "maxLength":1,
            "pattern":"^[Y,N]$"
        },
        "ibanCntryCd":{
            "type":"string",
            "description":"Country Code.",
            "minLength":0,
            "maxLength":3,
            "pattern":"^$|^[a-zA-Z0-9]+$"
        },
        "ibanChkDigAlgo":{
            "type":"string",
            "description":"Algorithm required for IBAN check digit generation",
            "minLength":0,
            "maxLength":30
        },
        "bbanFormatMsk":{
            "type":"string",
            "description":"BBAN format mask.",
            "minLength":0,
            "maxLength":30,
            "pattern":"^[bszdthli]*$"
        },
        "bbanDataType":{
            "type":"string",
            "description":"Data type of each field defined as part of BBAN mask",
            "minLength":0,
            "maxLength":30,
            "pattern":"^[anc]*$"
        },
        "bbanChkDigAlgo":{
            "type":"string",
            "description":"Algorithm required for BBAN check digit generation",
            "minLength":0,
            "maxLength":30
        },
        "bbanBankCode":{
            "type":"string",
            "description":"Bank code should be given if bank code is part of BBAN mask.",
            "minLength":0,
            "maxLength":20,
            "pattern":"^[a-zA-Z0-9]+$"
        },
        "bbanBrnCode":{
            "type":"string",
            "description":"Branch code should be given if branch code is part of BBAN mask",
            "minLength":0,
            "maxLength":20,
            "pattern":"^[a-zA-Z0-9]+$"
        },
        "fixedValue":{
            "type":"string",
            "description":"",
            "minLength":0,
            "maxLength":1,
            "pattern":"^$|^[a-zA-Z0-9]+$"
        },
        "rateType":{
            "type":"string",
            "description":"Rate Type"
        },
        "rateCode":{
            "type":"string",
            "description":"Rate Code can be Mid Rate(M) or Buy/Sell Rate(B)",
            "pattern":"[M,B]",
            "minLength":0,
            "maxLength":1
        },
        "normalVariance":{
            "type":"number",
            "description":"Variance that is allowed for Exchange Rate (percentage)",
            "minimum":0,
            "maximum":100
        },
        "maxVariance":{
            "type":"number",
            "description":"Maximum variance allowed for Exchange Rate (percentage)",
            "minimum":0,
            "maximum":100
        },
        "amtBlkQueueReq":{
            "type":"string",
            "description":"Flag to indicate if queue is required for Amount Block",
            "pattern":"[Y,N]"
        },
        "txnJnlQueueReq":{
            "type":"string",
            "description":"Flag to indicate if queue is required for Transaction Journal",
            "pattern":"[Y,N]"
        },
        "vaRateType":{
            "type":"string",
            "description":"Rate Type for Child Contributions"
        },
        "vaRateCode":{
            "type":"string",
            "description":"Rate Code for Child Contributions can be Mid Rate(M) or Buy/Sell Rate(B)",
            "pattern":"[M,B]",
            "minLength":0,
            "maxLength":1
        },
        "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"
        },
        "corporateSpecificRangeRequired":{
            "type":"string",
            "description":"Flag to indicate if corporate specific account number range is required or not for the branch",
            "pattern":"[Y,N]",
            "minLength":0,
            "maxLength":1
        },
        "extAccNumberGeneration":{
            "type":"string",
            "description":"External Account number Generation Required?",
            "pattern":"[Y,N]"
        },
        "extIBANGeneration":{
            "type":"string",
            "description":"External IBAN Generation Required?",
            "pattern":"[Y,N]"
        },
        "branchName":{
            "type":"string",
            "description":"Name of the Branch for Virtual Account",
            "minimum":0,
            "maximum":105
        },
        "branchGroup":{
            "type":"string",
            "description":"Branch Group code"
        }
    }
}

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.