REST API for Oracle Banking Virtual Account Management

Linking or Delinking a virtual account in the existing Account Structure

put

/service/accountstructures/modifystructure

This endpoint is used to update an existing account structures to link or delink an virtual account.

Request

Supported Media Types

application/json
application/xml

Header Parameters

sourceCode(required): string

Source from which request is initiated

Request Body that contains data required for updating an existing accountstructures

Root Schema : AccountLinkDelinkRequestDTO

Type: object

AccountStructure Link/Delink Request DTO

Show Source

custChargeAcc: string

Maximum Length: 35

Customer charge account
custChargeAccBrn: string

Maximum Length: 3

Customer charge account branch
custChargeAccCcy: string

Maximum Length: 3

Customer charge account Currency
delinkAccountList: array delinkAccountList

Virtual Account List to be Delinked
interestCalcRequired: string

Flag to indicate if Interest Calculation is required or not
linkAccountList: array linkAccountList

Virtual Account List to be Linked
structureCode: string

Structure Code
structureDesc: string

Descripton about Virtual Account Structure
virtualMainAcc: string

Virtual Main/Header Account

{
    "description":"AccountStructure Link/Delink Request DTO",
    "type":"object",
    "properties":{
        "virtualMainAcc":{
            "description":"Virtual Main/Header Account",
            "type":"string"
        },
        "interestCalcRequired":{
            "description":"Flag to indicate if Interest Calculation is required or not",
            "type":"string"
        },
        "structureCode":{
            "description":"Structure Code",
            "type":"string"
        },
        "structureDesc":{
            "description":"Descripton about Virtual Account Structure",
            "type":"string"
        },
        "custChargeAcc":{
            "type":"string",
            "description":"Customer charge account",
            "maxLength":"35"
        },
        "custChargeAccBrn":{
            "type":"string",
            "description":"Customer charge account branch",
            "maxLength":"3"
        },
        "custChargeAccCcy":{
            "type":"string",
            "description":"Customer charge account Currency",
            "maxLength":"3"
        },
        "linkAccountList":{
            "description":"Virtual Account List to be Linked",
            "type":"array",
            "items":{
                "$ref":"#/definitions/VirtualAccDetailsDTO"
            }
        },
        "delinkAccountList":{
            "description":"Virtual Account List to be Delinked",
            "type":"array",
            "items":{
                "$ref":"#/definitions/VirtualAccDetailsDTO"
            }
        }
    }
}

Nested Schema : delinkAccountList

Type: array

Virtual Account List to be Delinked

Show Source

Array of: object VirtualAccDetailsDTO

{
    "description":"Virtual Account List to be Delinked",
    "type":"array",
    "items":{
        "$ref":"#/definitions/VirtualAccDetailsDTO"
    }
}

Nested Schema : linkAccountList

Type: array

Virtual Account List to be Linked

Show Source

Array of: object VirtualAccDetailsDTO

{
    "description":"Virtual Account List to be Linked",
    "type":"array",
    "items":{
        "$ref":"#/definitions/VirtualAccDetailsDTO"
    }
}

Nested Schema : VirtualAccDetailsDTO

Type: object

Show Source

virtualAccountNumber: string

Virtual Account Number
virtualParentAcc: string

Parent Account Number of the VirtualAccount

{
    "type":"object",
    "properties":{
        "virtualParentAcc":{
            "type":"string",
            "description":"Parent Account Number of the VirtualAccount"
        },
        "virtualAccountNumber":{
            "type":"string",
            "description":"Virtual Account Number"
        }
    }
}

Response

Supported Media Types

application/json
text/csv
application/xml

200 Response

Returns updated accountstructures

Root Schema : AccountMapServiceResponseWrapperDTO

Type: object

Show Source

data: object AccountMapMasterServiceDTO
messages: object AccountMapServiceResponseDto

{
    "type":"object",
    "properties":{
        "messages":{
            "$ref":"#/definitions/AccountMapServiceResponseDto"
        },
        "data":{
            "$ref":"#/definitions/AccountMapMasterServiceDTO"
        }
    }
}

Nested Schema : AccountMapMasterServiceDTO

Type: object

Match All

Show Source

object AccountMapMasterServiceDTO-allOf[0]

{
    "type":"object",
    "allOf":[
        {
            "type":"object",
            "properties":{
                "realCustomerNo":{
                    "type":"string",
                    "description":"Real Customer Number for which Virtual Account Structure is maintained"
                },
                "structureCode":{
                    "type":"string",
                    "description":"Code to identify Virtual Account Structure",
                    "minLength":"1",
                    "maxLength":"20"
                },
                "structureDesc":{
                    "type":"string",
                    "description":"Description of Virtual Account Structure",
                    "minLength":"0",
                    "maxLength":"35"
                },
                "virtualMainAcc":{
                    "type":"string",
                    "description":"Virtual Main/Header Account"
                },
                "realAccountNo":{
                    "type":"string",
                    "description":"Real Account Number for which the VA Structure is mapped"
                },
                "realAccountBrn":{
                    "type":"string",
                    "description":"Branch of the Real Account Number"
                },
                "accountLinkage":{
                    "type":"string",
                    "description":"Type of real account number to be linked. Account or group level.",
                    "pattern":"[A,G]"
                },
                "accountGroupId":{
                    "type":"string",
                    "description":"Virtual Multi-Currency Account Number"
                },
                "interestCalcRequired":{
                    "type":"string",
                    "description":"Flag to indicate if Interest Calculation is required or not",
                    "pattern":"[Y,N]"
                },
                "creationDate":{
                    "type":"string",
                    "description":"Structure creation date"
                },
                "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"
                },
                "AccountMapDetailServiceDTO":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/AccountMapDetailServiceDTO"
                    }
                }
            }
        }
    ]
}

Nested Schema : AccountMapServiceResponseDto

Type: object

Show Source

codes: array codes
status: string

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "codes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/AccountMapServiceResponseCode"
            }
        }
    }
}

Nested Schema : AccountMapMasterServiceDTO-allOf[0]

Type: object

Show Source

accountGroupId: string

Virtual Multi-Currency Account Number
accountLinkage: string

Pattern: [A,G]

Type of real account number to be linked. Account or group level.
AccountMapDetailServiceDTO: array AccountMapDetailServiceDTO
approverRemarks: string

Remarks made by Approver
authStatus: string

Authorization Status of Virtual Account
checkerDateStamp: string

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

Checker ID of Virtual Account
creationDate: string

Structure creation date
doerRemarks: string

Remarks made by Maker
interestCalcRequired: string

Pattern: [Y,N]

Flag to indicate if Interest Calculation is required or not
makerDateStamp: string

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

Maker ID of Virtual Account
modNo: integer

Version number of Virtual Account
onceAuth: string

Flag that indicated if Virtual Account is authorized once or not
realAccountBrn: string

Branch of the Real Account Number
realAccountNo: string

Real Account Number for which the VA Structure is mapped
realCustomerNo: string

Real Customer Number for which Virtual Account Structure is maintained
recordStatus: string

Record Status of Virtual Account
structureCode: string

Minimum Length: 1

Maximum Length: 20

Code to identify Virtual Account Structure
structureDesc: string

Minimum Length: 0

Maximum Length: 35

Description of Virtual Account Structure
virtualMainAcc: string

Virtual Main/Header Account

{
    "type":"object",
    "properties":{
        "realCustomerNo":{
            "type":"string",
            "description":"Real Customer Number for which Virtual Account Structure is maintained"
        },
        "structureCode":{
            "type":"string",
            "description":"Code to identify Virtual Account Structure",
            "minLength":"1",
            "maxLength":"20"
        },
        "structureDesc":{
            "type":"string",
            "description":"Description of Virtual Account Structure",
            "minLength":"0",
            "maxLength":"35"
        },
        "virtualMainAcc":{
            "type":"string",
            "description":"Virtual Main/Header Account"
        },
        "realAccountNo":{
            "type":"string",
            "description":"Real Account Number for which the VA Structure is mapped"
        },
        "realAccountBrn":{
            "type":"string",
            "description":"Branch of the Real Account Number"
        },
        "accountLinkage":{
            "type":"string",
            "description":"Type of real account number to be linked. Account or group level.",
            "pattern":"[A,G]"
        },
        "accountGroupId":{
            "type":"string",
            "description":"Virtual Multi-Currency Account Number"
        },
        "interestCalcRequired":{
            "type":"string",
            "description":"Flag to indicate if Interest Calculation is required or not",
            "pattern":"[Y,N]"
        },
        "creationDate":{
            "type":"string",
            "description":"Structure creation date"
        },
        "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"
        },
        "AccountMapDetailServiceDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/AccountMapDetailServiceDTO"
            }
        }
    }
}

Nested Schema : AccountMapDetailServiceDTO

Type: array

Show Source

Array of: object AccountMapDetailServiceDTO

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

Nested Schema : AccountMapDetailServiceDTO

Type: object

Show Source

virtualChildAcc: string
virtualMainAcc: string
virtualParentAcc: string

{
    "type":"object",
    "properties":{
        "virtualMainAcc":{
            "type":"string",
            "description":""
        },
        "virtualParentAcc":{
            "type":"string",
            "description":""
        },
        "virtualChildAcc":{
            "type":"string",
            "description":""
        }
    }
}

Nested Schema : codes

Type: array

Show Source

Array of: object AccountMapServiceResponseCode

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

Nested Schema : AccountMapServiceResponseCode

Type: object

Show Source

Code: string
Desc: string
Language: string
Type: string

{
    "type":"object",
    "properties":{
        "Code":{
            "type":"string"
        },
        "Desc":{
            "type":"string"
        },
        "Type":{
            "type":"string"
        },
        "Language":{
            "type":"string"
        }
    }
}

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.