Previous Next JavaScript must be enabled to correctly display this content

## Gets the List of External Branches

get

/service/lmm/branch/external

This endpoint is used get the list of external branches based on bank type.

### Request

Supported Media Types

- application/json
- application/xml

Query Parameters

- authStat(optional): string
- bankCode(optional): string
- branchCode(optional): string
- branchName(optional): string
- includecloseandunauth(optional): boolean
  includecloseandunauth need to be set to fetch summary record, defult value is false
- isExternal(optional): string
- limit(optional): integer
  limit is maximum no of records to be fetched
- offset(optional): integer
  offset is starting no of records to be fetched
- recordStat(optional): string

Back to Top

### Response

Supported Media Types

- application/json
- application/xml

#### 200 Response

Successful operation.
Body ()
Root Schema : LmmTmBranchParametersCollection
Type: `object`
Collection of branchparameters.
Show Source

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

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

Nested Schema : data
Type: `array`
Show Source

- Array of: object LmmTmBranchParametersDTO

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

Nested Schema : PagingDto
Type: `object`
Show Source

- totalResults(optional): integer

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

Nested Schema : LmmTmBranchParametersDTO
Type: `object`
Match All
Show Source

- allOf GenericDto
- object LmmTmBranchParametersDTO-allOf[1]

    {
        "type":"object",
        "allOf":[
            {
                "$ref":"#/definitions/GenericDto"
            },
            {
                "type":"object",
                "properties":{
                    "bankCode":{
                        "type":"string",
                        "description":""
                    },
                    "bicCode":{
                        "type":"string",
                        "description":""
                    },
                    "branchCode":{
                        "type":"string",
                        "description":""
                    },
                    "branchCurrency":{
                        "type":"string",
                        "description":""
                    },
                    "branchName":{
                        "type":"string",
                        "description":""
                    },
                    "branchDate":{
                        "type":"string",
                        "description":""
                    },
                    "isExternal":{
                        "type":"string",
                        "description":""
                    },
                    "cityId":{
                        "type":"string",
                        "description":""
                    },
                    "countryId":{
                        "type":"string",
                        "description":""
                    },
                    "crossBorderHybridPool":{
                        "type":"string",
                        "description":""
                    },
                    "crossBorderHybridSweep":{
                        "type":"string",
                        "description":""
                    },
                    "crossBorderPool":{
                        "type":"string",
                        "description":""
                    },
                    "crossBorderSweep":{
                        "type":"string",
                        "description":""
                    },
                    "crossCcyHybridPool":{
                        "type":"string",
                        "description":""
                    },
                    "crossCcyHybridSweep":{
                        "type":"string",
                        "description":""
                    },
                    "crossCcyPool":{
                        "type":"string",
                        "description":""
                    },
                    "crossCcySweep":{
                        "type":"string",
                        "description":""
                    },
                    "domesticHybridPool":{
                        "type":"string",
                        "description":""
                    },
                    "domesticHybridSweep":{
                        "type":"string",
                        "description":""
                    },
                    "domesticPool":{
                        "type":"string",
                        "description":""
                    },
                    "domesticSweep":{
                        "type":"string",
                        "description":""
                    },
                    "externalSystemId":{
                        "type":"string",
                        "description":""
                    },
                    "fax":{
                        "type":"string",
                        "description":""
                    },
                    "hybrid":{
                        "type":"string",
                        "description":""
                    },
                    "isBalanceOnline":{
                        "type":"string",
                        "description":""
                    },
                    "latitude":{
                        "type":"number",
                        "description":""
                    },
                    "line1":{
                        "type":"string",
                        "description":""
                    },
                    "line2":{
                        "type":"string",
                        "description":""
                    },
                    "line3":{
                        "type":"string",
                        "description":""
                    },
                    "line4":{
                        "type":"string",
                        "description":""
                    },
                    "longitude":{
                        "type":"number",
                        "description":""
                    },
                    "phoneNumber":{
                        "type":"string",
                        "description":""
                    },
                    "pool":{
                        "type":"string",
                        "description":""
                    },
                    "region":{
                        "type":"string",
                        "description":""
                    },
                    "sourceSystem":{
                        "type":"string",
                        "description":""
                    },
                    "sourceSystemBranchCode":{
                        "type":"string",
                        "description":""
                    },
                    "stateId":{
                        "type":"string",
                        "description":""
                    },
                    "sweep":{
                        "type":"string",
                        "description":""
                    },
                    "timeZone":{
                        "type":"string",
                        "description":""
                    },
                    "hostCode":{
                        "type":"string",
                        "description":""
                    },
                    "zip":{
                        "type":"string",
                        "description":""
                    },
                    "entityID":{
                        "type":"string",
                        "description":""
                    },
                    "entityName":{
                        "type":"string",
                        "description":""
                    },
                    "today":{
                        "type":"string"
                    },
                    "prevWorkingDay":{
                        "type":"string"
                    },
                    "nextWorkingDay":{
                        "type":"string"
                    },
                    "LmmTmBranchAddnParametersDTO":{
                        "type":"array",
                        "items":{
                            "$ref":"#/definitions/LmmTmBranchAddnParametersDTO"
                        }
                    },
                    "LmmTmBranchExternalSystemDTO":{
                        "type":"array",
                        "items":{
                            "$ref":"#/definitions/LmmTmBranchExternalSystemDTO"
                        }
                    }
                },
                "required":[
                    "bankCode",
                    "branchCode",
                    "branchCurrency",
                    "branchName",
                    "cityId"
                ]
            }
        ]
    }

Nested Schema : GenericDto
Match All
Show Source

- object GenericDto-allOf[0]
  Discriminator: `resource_type`

    {
        "allOf":[
            {
                "type":"object",
                "discriminator":"resource_type"
            }
        ]
    }

Nested Schema : GenericDto-allOf[0]
Type: `object`
Discriminator: `resource_type`
Nested Schema : LmmTmBranchParametersDTO-allOf[1]
Type: `object`
Show Source

- bankCode: string
- bicCode(optional): string
- branchCode: string
- branchCurrency: string
- branchDate(optional): string
- branchName: string
- cityId: string
- countryId(optional): string
- crossBorderHybridPool(optional): string
- crossBorderHybridSweep(optional): string
- crossBorderPool(optional): string
- crossBorderSweep(optional): string
- crossCcyHybridPool(optional): string
- crossCcyHybridSweep(optional): string
- crossCcyPool(optional): string
- crossCcySweep(optional): string
- domesticHybridPool(optional): string
- domesticHybridSweep(optional): string
- domesticPool(optional): string
- domesticSweep(optional): string
- entityID(optional): string
- entityName(optional): string
- externalSystemId(optional): string
- fax(optional): string
- hostCode(optional): string
- hybrid(optional): string
- isBalanceOnline(optional): string
- isExternal(optional): string
- latitude(optional): number
- line1(optional): string
- line2(optional): string
- line3(optional): string
- line4(optional): string
- LmmTmBranchAddnParametersDTO(optional): array LmmTmBranchAddnParametersDTO
- LmmTmBranchExternalSystemDTO(optional): array LmmTmBranchExternalSystemDTO
- longitude(optional): number
- nextWorkingDay(optional): string
- phoneNumber(optional): string
- pool(optional): string
- prevWorkingDay(optional): string
- region(optional): string
- sourceSystem(optional): string
- sourceSystemBranchCode(optional): string
- stateId(optional): string
- sweep(optional): string
- timeZone(optional): string
- today(optional): string
- zip(optional): string

    {
        "type":"object",
        "properties":{
            "bankCode":{
                "type":"string",
                "description":""
            },
            "bicCode":{
                "type":"string",
                "description":""
            },
            "branchCode":{
                "type":"string",
                "description":""
            },
            "branchCurrency":{
                "type":"string",
                "description":""
            },
            "branchName":{
                "type":"string",
                "description":""
            },
            "branchDate":{
                "type":"string",
                "description":""
            },
            "isExternal":{
                "type":"string",
                "description":""
            },
            "cityId":{
                "type":"string",
                "description":""
            },
            "countryId":{
                "type":"string",
                "description":""
            },
            "crossBorderHybridPool":{
                "type":"string",
                "description":""
            },
            "crossBorderHybridSweep":{
                "type":"string",
                "description":""
            },
            "crossBorderPool":{
                "type":"string",
                "description":""
            },
            "crossBorderSweep":{
                "type":"string",
                "description":""
            },
            "crossCcyHybridPool":{
                "type":"string",
                "description":""
            },
            "crossCcyHybridSweep":{
                "type":"string",
                "description":""
            },
            "crossCcyPool":{
                "type":"string",
                "description":""
            },
            "crossCcySweep":{
                "type":"string",
                "description":""
            },
            "domesticHybridPool":{
                "type":"string",
                "description":""
            },
            "domesticHybridSweep":{
                "type":"string",
                "description":""
            },
            "domesticPool":{
                "type":"string",
                "description":""
            },
            "domesticSweep":{
                "type":"string",
                "description":""
            },
            "externalSystemId":{
                "type":"string",
                "description":""
            },
            "fax":{
                "type":"string",
                "description":""
            },
            "hybrid":{
                "type":"string",
                "description":""
            },
            "isBalanceOnline":{
                "type":"string",
                "description":""
            },
            "latitude":{
                "type":"number",
                "description":""
            },
            "line1":{
                "type":"string",
                "description":""
            },
            "line2":{
                "type":"string",
                "description":""
            },
            "line3":{
                "type":"string",
                "description":""
            },
            "line4":{
                "type":"string",
                "description":""
            },
            "longitude":{
                "type":"number",
                "description":""
            },
            "phoneNumber":{
                "type":"string",
                "description":""
            },
            "pool":{
                "type":"string",
                "description":""
            },
            "region":{
                "type":"string",
                "description":""
            },
            "sourceSystem":{
                "type":"string",
                "description":""
            },
            "sourceSystemBranchCode":{
                "type":"string",
                "description":""
            },
            "stateId":{
                "type":"string",
                "description":""
            },
            "sweep":{
                "type":"string",
                "description":""
            },
            "timeZone":{
                "type":"string",
                "description":""
            },
            "hostCode":{
                "type":"string",
                "description":""
            },
            "zip":{
                "type":"string",
                "description":""
            },
            "entityID":{
                "type":"string",
                "description":""
            },
            "entityName":{
                "type":"string",
                "description":""
            },
            "today":{
                "type":"string"
            },
            "prevWorkingDay":{
                "type":"string"
            },
            "nextWorkingDay":{
                "type":"string"
            },
            "LmmTmBranchAddnParametersDTO":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/LmmTmBranchAddnParametersDTO"
                }
            },
            "LmmTmBranchExternalSystemDTO":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/LmmTmBranchExternalSystemDTO"
                }
            }
        },
        "required":[
            "bankCode",
            "branchCode",
            "branchCurrency",
            "branchName",
            "cityId"
        ]
    }

Nested Schema : LmmTmBranchAddnParametersDTO
Type: `array`
Show Source

- Array of: object LmmTmBranchAddnParametersDTO

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

Nested Schema : LmmTmBranchExternalSystemDTO
Type: `array`
Show Source

- Array of: object LmmTmBranchExternalSystemDTO

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

Nested Schema : LmmTmBranchAddnParametersDTO
Type: `object`
Show Source

- branchParametersId(optional): string
- id(optional): string
- parameterName(optional): string
- parameterValue(optional): string

    {
        "type":"object",
        "properties":{
            "branchParametersId":{
                "type":"string",
                "description":""
            },
            "id":{
                "type":"string",
                "description":""
            },
            "parameterName":{
                "type":"string",
                "description":""
            },
            "parameterValue":{
                "type":"string",
                "description":""
            }
        }
    }

Nested Schema : LmmTmBranchExternalSystemDTO
Type: `object`
Show Source

- branchParametersId(optional): string
- externalSystemId(optional): string
- id(optional): string
- messageType(optional): string
- methodName(optional): string
- networkType(optional): string
- serviceType(optional): string

    {
        "type":"object",
        "properties":{
            "branchParametersId":{
                "type":"string",
                "description":""
            },
            "externalSystemId":{
                "type":"string",
                "description":""
            },
            "id":{
                "type":"string",
                "description":""
            },
            "messageType":{
                "type":"string",
                "description":""
            },
            "methodName":{
                "type":"string",
                "description":""
            },
            "networkType":{
                "type":"string",
                "description":""
            },
            "serviceType":{
                "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