Jump to

• Request
• Response

gets the list of internal or external branches based on banktype

get

/api/1.0/service/lmm/branch/external

gets the list of internal or external branches

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

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

Header Parameters

• sourceCode(required): string
  Source from which request is initiated

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: array data

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

Nested Schema : data

Type: array

Show Source

• Array of: object LmmTmBranchParametersDTO

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

Nested Schema : LmmTmBranchParametersDTO

Type: object

Show Source

• bankCode: string
• bicCode: string
• branchCode: string
• branchCurrency: string
• branchDate: string
• branchName: string
• cityId: string
• countryId: string
• crossBorderHybridPool: string
• crossBorderHybridSweep: string
• crossBorderPool: string
• crossBorderSweep: string
• crossCcyHybridPool: string
• crossCcyHybridSweep: string
• crossCcyPool: string
• crossCcySweep: string
• domesticHybridPool: string
• domesticHybridSweep: string
• domesticPool: string
• domesticSweep: string
• externalSystemId: string
• fax: string
• hostCode: string
• hybrid: string
• isBalanceOnline: string
• latitude: number
• line1: string
• line2: string
• line3: string
• line4: string
• LmmTmBranchAddnParametersDTO: array LmmTmBranchAddnParametersDTO
• LmmTmBranchExternalSystemDTO: array LmmTmBranchExternalSystemDTO
• localClearingCode: string
• longitude: number
• phoneNumber: string
• pool: string
• region: string
• sourceSystem: string
• sourceSystemBranchCode: string
• stateId: string
• sweep: string
• timeZone: string
• zip: string

{
    "type":"object",
    "properties":{
        "bankCode":{
            "type":"string",
            "description":""
        },
        "bicCode":{
            "type":"string",
            "description":""
        },
        "branchCode":{
            "type":"string",
            "description":""
        },
        "branchCurrency":{
            "type":"string",
            "description":""
        },
        "branchName":{
            "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":""
        },
        "branchDate":{
            "type":"string",
            "description":""
        },
        "localClearingCode":{
            "type":"string",
            "description":""
        },
        "zip":{
            "type":"string",
            "description":""
        },
        "hostCode":{
            "type":"string",
            "description":""
        },
        "LmmTmBranchAddnParametersDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LmmTmBranchAddnParametersDTO"
            }
        },
        "LmmTmBranchExternalSystemDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LmmTmBranchExternalSystemDTO"
            }
        }
    }
}

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: string
• id: string
• parameterName: string
• parameterValue: 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: string
• externalSystemId: string
• id: string
• messageType: string
• methodName: string
• networkType: string
• serviceType: 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