Jump to

• Request
• Response

Retrieves the Child Account by Parent Account Number and Structure key ID

get

/service/lma/structure/v1/childAccounts

This endpoint is used to get the child Accounts by parent account number and Structure key ID.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• isRejected: boolean
  true to get details for rejected modification/record on a structure and false for rest

  Default Value: false
• isSimulationMode: boolean
  true for simulation mode and false for rest

  Default Value: false
• limit: integer
  limit is maximum no of records to be fetched
• offset: integer
  offset is starting no of records to be fetched
• parentAccountNumber(required): string
  Parent Account Number that needs to be fetched
• structureMasterId(required): string
  Id of the structure master that needs to be fetched
• version: string
  Version of the structure to be fetched

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns the child Accounts based on given parent account number and master id.

Body ()

Root Schema : LmmTmStructureDetailsWrapperDTO

Type: object

Show Source

• data: array data

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

Nested Schema : data

Type: array

Show Source

• Array of: object LmmTmStructureDetailsDTO

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

Nested Schema : LmmTmStructureDetailsDTO

Type: object

Show Source

• accountCurrency: string
• accountLevel: integer
• accountNumber: string
• accountType: string
• allowReverseSweep: string
• bookingAccountBranch: string
• bookingAccountCurrency: string
• bookingAccountNumber: string
• branchCode: string
• centralAccountBranch: string
• centralAccountCurrency: string
• centralAccountNumber: string
• eodExecution: string
• id: string
• instructionPriority: integer
• isExternalAccount: string
• isHold: string
• isNominatedAccount: string
• isTwoWay: string
• LmmTmStructureInstructionDTO: array LmmTmStructureInstructionDTO
• LmmTmStructurePaymentDTO: array LmmTmStructurePaymentDTO
• onlineBalanceFetch: string
• parentAccountBranch: string
• parentAccountCurrency: string
• parentAccountNumber: string
• partialReverseSweep: string
• partialTransferAllowed: string
• percentageChildShare: integer
• percentageShare: integer
• ratePickUp: string
• rateType: string
• reallocationMethod: string
• reallocationRequired: string
• reverseSweepFrequency: string
• structureMasterId(required): string
• twowaySweepPriority: integer

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":""
        },
        "structureMasterId":{
            "type":"string",
            "description":""
        },
        "accountNumber":{
            "type":"string",
            "description":""
        },
        "branchCode":{
            "type":"string",
            "description":""
        },
        "accountCurrency":{
            "type":"string",
            "description":""
        },
        "isExternalAccount":{
            "type":"string",
            "description":""
        },
        "parentAccountNumber":{
            "type":"string",
            "description":""
        },
        "parentAccountBranch":{
            "type":"string",
            "description":""
        },
        "parentAccountCurrency":{
            "type":"string",
            "description":""
        },
        "bookingAccountNumber":{
            "type":"string",
            "description":""
        },
        "bookingAccountBranch":{
            "type":"string",
            "description":""
        },
        "bookingAccountCurrency":{
            "type":"string",
            "description":""
        },
        "rateType":{
            "type":"string",
            "description":""
        },
        "accountType":{
            "type":"string",
            "description":""
        },
        "instructionPriority":{
            "type":"integer",
            "description":""
        },
        "isTwoWay":{
            "type":"string",
            "description":""
        },
        "reverseSweepFrequency":{
            "type":"string",
            "description":""
        },
        "twowaySweepPriority":{
            "type":"integer",
            "description":""
        },
        "onlineBalanceFetch":{
            "type":"string",
            "description":""
        },
        "partialReverseSweep":{
            "type":"string",
            "description":""
        },
        "isHold":{
            "type":"string",
            "description":""
        },
        "eodExecution":{
            "type":"string",
            "description":""
        },
        "ratePickUp":{
            "type":"string",
            "description":""
        },
        "reallocationRequired":{
            "type":"string",
            "description":""
        },
        "reallocationMethod":{
            "type":"string",
            "description":""
        },
        "allowReverseSweep":{
            "type":"string",
            "description":""
        },
        "isNominatedAccount":{
            "type":"string",
            "description":""
        },
        "accountLevel":{
            "type":"integer",
            "description":""
        },
        "centralAccountNumber":{
            "type":"string",
            "description":""
        },
        "centralAccountBranch":{
            "type":"string",
            "description":""
        },
        "centralAccountCurrency":{
            "type":"string",
            "description":""
        },
        "percentageShare":{
            "type":"integer",
            "description":""
        },
        "percentageChildShare":{
            "type":"integer",
            "description":""
        },
        "partialTransferAllowed":{
            "type":"string",
            "description":""
        },
        "LmmTmStructureInstructionDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LmmTmStructureInstructionDTO"
            }
        },
        "LmmTmStructurePaymentDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LmmTmStructurePaymentDTO"
            }
        }
    },
    "required":[
        "structureMasterId"
    ]
}

Nested Schema : LmmTmStructureInstructionDTO

Type: array

Show Source

• Array of: object LmmTmStructureInstructionDTO

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

Nested Schema : LmmTmStructurePaymentDTO

Type: array

Show Source

• Array of: object LmmTmStructurePaymentDTO

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

Nested Schema : LmmTmStructureInstructionDTO

Type: object

Show Source

• id: string
• instructionId: string
• instructionPriority: integer
• LmmTmStructureInstructionDetDTO: array LmmTmStructureInstructionDetDTO
• LmmTmStructureInstructionFrequencyDTO: array LmmTmStructureInstructionFrequencyDTO
• structureDetailsId(required): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":""
        },
        "structureDetailsId":{
            "type":"string",
            "description":""
        },
        "instructionId":{
            "type":"string",
            "description":""
        },
        "instructionPriority":{
            "type":"integer",
            "description":""
        },
        "LmmTmStructureInstructionFrequencyDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LmmTmStructureInstructionFrequencyDTO"
            }
        },
        "LmmTmStructureInstructionDetDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LmmTmStructureInstructionDetDTO"
            }
        }
    },
    "required":[
        "structureDetailsId"
    ]
}

Nested Schema : LmmTmStructureInstructionDetDTO

Type: array

Show Source

• Array of: object LmmTmStructureInstructionDetDTO

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

Nested Schema : LmmTmStructureInstructionFrequencyDTO

Type: array

Show Source

• Array of: object LmmTmStructureInstructionFrequencyDTO

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

Nested Schema : LmmTmStructureInstructionDetDTO

Type: object

Show Source

• id: string
• paramName: string
• paramValue: string
• structureInstructionId(required): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":""
        },
        "structureInstructionId":{
            "type":"string",
            "description":""
        },
        "paramName":{
            "type":"string",
            "description":""
        },
        "paramValue":{
            "type":"string",
            "description":""
        }
    },
    "required":[
        "structureInstructionId"
    ]
}

Nested Schema : LmmTmStructureInstructionFrequencyDTO

Type: object

Show Source

• frequencyId: string
• id: string
• structureInstructionId(required): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":""
        },
        "structureInstructionId":{
            "type":"string",
            "description":""
        },
        "frequencyId":{
            "type":"string",
            "description":""
        }
    },
    "required":[
        "structureInstructionId"
    ]
}

Nested Schema : LmmTmStructurePaymentDTO

Type: object

Show Source

• id: string
• interfaceMasterId: string
• LmmTmStructurePaymentDetailDTO: array LmmTmStructurePaymentDetailDTO
• structureDetailsId(required): string
• sweepDirection: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":""
        },
        "structureDetailsId":{
            "type":"string",
            "description":""
        },
        "sweepDirection":{
            "type":"string",
            "description":""
        },
        "interfaceMasterId":{
            "type":"string",
            "description":""
        },
        "LmmTmStructurePaymentDetailDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LmmTmStructurePaymentDetailDTO"
            }
        }
    },
    "required":[
        "structureDetailsId"
    ]
}

Nested Schema : LmmTmStructurePaymentDetailDTO

Type: array

Show Source

• Array of: object LmmTmStructurePaymentDetailDTO

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

Nested Schema : LmmTmStructurePaymentDetailDTO

Type: object

Show Source

• id: string
• paramName: string
• paramValue: string
• structurePaymentId(required): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":""
        },
        "structurePaymentId":{
            "type":"string",
            "description":""
        },
        "paramName":{
            "type":"string",
            "description":""
        },
        "paramValue":{
            "type":"string",
            "description":""
        }
    },
    "required":[
        "structurePaymentId"
    ]
}

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