Jump to

• Request
• Response

Retrieves the accountstructures by virtualMainAcc with account balances and child count

get

/service/accountstructures/{virtualMainAcc}/viewaccountstructure

This endpoint is used to retrieve the account structures by virtualMainAcc.

Request

Supported Media Types

• application/json

Path Parameters

• virtualMainAcc: string
  Natural key of the accountstructures Maintenance

Query Parameters

• limit(optional): integer
  limit is maximum no of records to be fetched
• offset(optional): integer
  offset is starting no of records to be fetched
• parentAcc(optional): string
  Parent Account of the VirtualAccount

Header Parameters

• sourceCode: string
  Source from which request is initiated

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returns the accountstructures based on given id.

Body ()

Root Schema : AccountStructureWithBalanceServiceCollection

Type: object

Collection of accmap.

Show Source

• data(optional): object AccountStructureServiceWithBalanceDTO
• messages(optional): object AccountMapServiceResponseDto
• paging(optional): object PagingDto

{
    "description":"Collection of accmap.",
    "type":"object",
    "properties":{
        "data":{
            "$ref":"#/definitions/AccountStructureServiceWithBalanceDTO"
        },
        "messages":{
            "$ref":"#/definitions/AccountMapServiceResponseDto"
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : AccountStructureServiceWithBalanceDTO

Type: object

Match All

Show Source

• object AccountStructureServiceWithBalanceDTO-allOf[0]

{
    "type":"object",
    "allOf":[
        {
            "type":"object",
            "properties":{
                "realCustomerNo":{
                    "type":"string",
                    "description":"Real Customer Number for which Virtual Account Structure is maintained"
                },
                "realCustomerName":{
                    "type":"string",
                    "description":"Real Customer name for which Virtual Account Structure is maintained"
                },
                "structureCode":{
                    "type":"string",
                    "description":"Code to identify Virtual Account Structure"
                },
                "structureDesc":{
                    "type":"string",
                    "description":"Description of Virtual Account Structure"
                },
                "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":"Real Account Branch for which the VA Structure is mapped"
                },
                "virtualMainAccCcy":{
                    "type":"string",
                    "description":"Currency of Virtual Main Account"
                },
                "virtualMainAccName":{
                    "type":"string",
                    "description":"Currency of Virtual Main Account Name"
                },
                "accountLinkage":{
                    "type":"string",
                    "description":"Linkage Type of the structure with Real Account"
                },
                "virtualMCA":{
                    "type":"string",
                    "description":"Virtual Multi currency Account linked to the Structure"
                },
                "interestCalcRequired":{
                    "type":"string",
                    "description":"Flag to indicate if Interest Calculation is required or not",
                    "pattern":"[Y,N]"
                },
                "balance":{
                    "type":"number",
                    "description":"Effective balance of header account"
                },
                "childCount":{
                    "type":"integer",
                    "description":"Child Count for the header Account"
                },
                "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
                },
                "AccountMapServiceDetailWithBalanceDTO":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/AccountMapServiceDetailWithBalanceDTO"
                    }
                }
            }
        }
    ]
}

Nested Schema : AccountMapServiceResponseDto

Type: object

Show Source

• codes(optional): array codes
• status(optional): string

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

Nested Schema : PagingDto

Type: object

Show Source

• totalResults(optional): integer

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

Nested Schema : AccountStructureServiceWithBalanceDTO-allOf[0]

Type: object

Show Source

• accountLinkage(optional): string
  Linkage Type of the structure with Real Account
• AccountMapServiceDetailWithBalanceDTO(optional): array AccountMapServiceDetailWithBalanceDTO
• balance(optional): number
  Effective balance of header account
• childCount(optional): integer
  Child Count for the header Account
• custChargeAcc(optional): string
  Maximum Length: 35

  Customer charge account
• custChargeAccBrn(optional): string
  Maximum Length: 3

  Customer charge account branch
• custChargeAccCcy(optional): string
  Maximum Length: 3

  Customer charge account Currency
• interestCalcRequired(optional): string
  Pattern: [Y,N]

  Flag to indicate if Interest Calculation is required or not
• realAccountBrn(optional): string
  Real Account Branch for which the VA Structure is mapped
• realAccountNo(optional): string
  Real Account Number for which the VA Structure is mapped
• realCustomerName(optional): string
  Real Customer name for which Virtual Account Structure is maintained
• realCustomerNo(optional): string
  Real Customer Number for which Virtual Account Structure is maintained
• structureCode(optional): string
  Code to identify Virtual Account Structure
• structureDesc(optional): string
  Description of Virtual Account Structure
• virtualMainAcc(optional): string
  Virtual Main/Header Account
• virtualMainAccCcy(optional): string
  Currency of Virtual Main Account
• virtualMainAccName(optional): string
  Currency of Virtual Main Account Name
• virtualMCA(optional): string
  Virtual Multi currency Account linked to the Structure

{
    "type":"object",
    "properties":{
        "realCustomerNo":{
            "type":"string",
            "description":"Real Customer Number for which Virtual Account Structure is maintained"
        },
        "realCustomerName":{
            "type":"string",
            "description":"Real Customer name for which Virtual Account Structure is maintained"
        },
        "structureCode":{
            "type":"string",
            "description":"Code to identify Virtual Account Structure"
        },
        "structureDesc":{
            "type":"string",
            "description":"Description of Virtual Account Structure"
        },
        "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":"Real Account Branch for which the VA Structure is mapped"
        },
        "virtualMainAccCcy":{
            "type":"string",
            "description":"Currency of Virtual Main Account"
        },
        "virtualMainAccName":{
            "type":"string",
            "description":"Currency of Virtual Main Account Name"
        },
        "accountLinkage":{
            "type":"string",
            "description":"Linkage Type of the structure with Real Account"
        },
        "virtualMCA":{
            "type":"string",
            "description":"Virtual Multi currency Account linked to the Structure"
        },
        "interestCalcRequired":{
            "type":"string",
            "description":"Flag to indicate if Interest Calculation is required or not",
            "pattern":"[Y,N]"
        },
        "balance":{
            "type":"number",
            "description":"Effective balance of header account"
        },
        "childCount":{
            "type":"integer",
            "description":"Child Count for the header Account"
        },
        "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
        },
        "AccountMapServiceDetailWithBalanceDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/AccountMapServiceDetailWithBalanceDTO"
            }
        }
    }
}

Nested Schema : AccountMapServiceDetailWithBalanceDTO

Type: array

Show Source

• Array of: object AccountMapServiceDetailWithBalanceDTO

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

Nested Schema : AccountMapServiceDetailWithBalanceDTO

Type: object

Show Source

• balance(optional): number
  Effective balance of virtual account
• childCount(optional): integer
  Child Count for the Virtual Account
• currency(optional): string
  Currency of virtual account
• virtualAccountName(optional): string
  Name of the Virtual Account
• virtualChildAcc(optional): string
  Child account is virtual account, while creating structure it will be mapped to a parrent
• virtualMainAcc(optional): string
  Currency of Virtual Main Account
• virtualParentAcc(optional): string
  Main account of all the virtual account

{
    "type":"object",
    "properties":{
        "virtualMainAcc":{
            "type":"string",
            "description":"Currency of Virtual Main Account"
        },
        "virtualParentAcc":{
            "type":"string",
            "description":"Main account of all the virtual account"
        },
        "virtualChildAcc":{
            "type":"string",
            "description":"Child account is virtual account, while creating structure it will be mapped to a parrent"
        },
        "virtualAccountName":{
            "type":"string",
            "description":"Name of the Virtual Account"
        },
        "balance":{
            "type":"number",
            "description":"Effective balance of virtual account"
        },
        "currency":{
            "type":"string",
            "description":"Currency of virtual account"
        },
        "childCount":{
            "type":"integer",
            "description":"Child Count for the Virtual Account"
        }
    }
}

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(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"
        }
    }
}

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.

500 Response

Internal server error.

Back to Top