Jump to

• Request
• Response

Retrieves the accountstructures by ID

get

/service/accountstructures/download

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

Request

Supported Media Types

• application/json

Query Parameters

• structureCode: string
  structure code of the structure that needs to be fetched

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 structure code.

Body ()

Root Schema : AccountMapDownloadWrapperDTO

Type: object

Show Source

• data(optional): array data

{
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/AccountMapDownloadDTO"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object AccountMapDownloadDTO

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

Nested Schema : AccountMapDownloadDTO

Type: object

Show Source

• branchCode(optional): string
• branchName(optional): string
• entityID(optional): string
• entityName(optional): string
• parentAccount(optional): string
• parentAccountIBAN(optional): string
• parentAccountName(optional): string
• structureLevel(optional): integer
• virtualAccount(optional): string
• virtualAccountAvailableBalance(optional): number
• virtualAccountCurrency(optional): string
• virtualAccountIBAN(optional): string
• virtualAccountName(optional): string

{
    "type":"object",
    "properties":{
        "structureLevel":{
            "type":"integer",
            "description":""
        },
        "virtualAccount":{
            "type":"string",
            "description":""
        },
        "virtualAccountIBAN":{
            "type":"string",
            "description":""
        },
        "virtualAccountName":{
            "type":"string",
            "description":""
        },
        "virtualAccountCurrency":{
            "type":"string",
            "description":""
        },
        "virtualAccountAvailableBalance":{
            "type":"number",
            "description":""
        },
        "branchCode":{
            "type":"string",
            "description":""
        },
        "branchName":{
            "type":"string",
            "description":""
        },
        "entityID":{
            "type":"string",
            "description":""
        },
        "entityName":{
            "type":"string",
            "description":""
        },
        "parentAccount":{
            "type":"string",
            "description":""
        },
        "parentAccountIBAN":{
            "type":"string",
            "description":""
        },
        "parentAccountName":{
            "type":"string",
            "description":""
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error

Back to Top