Jump to

• Request
• Response

Retrieves the list of bank branch entries

get

/service/v1/bankbranch

This endpoint is used to get the list of bank branch entries.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• bankCode(optional): string
  Bank Code
• bankName(optional): string
  Name of the Bank
• branchName(optional): string
  Name of the Branch
• requestBranchCode(optional): string
  Requested Branch Code

Header Parameters

• appId: string
  Application Id
• authToken(optional): string
  Authorization Token
• branchCode: string
  Branch Code
• contentType(optional): string
  Content Type
• userId: string
  User Id for SMS

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Successfully performs the operation

Body ()

Root Schema : CmcBankBranchCollection

Type: object

Collection of bankname.

Show Source

• data(optional): array data
  List of Bank Branch Objects.
• paging(optional): object PagingDto
  Paging DTO object

{
    "description":"Collection of bankname.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "description":"List of Bank Branch Objects.",
            "items":{
                "$ref":"#/definitions/CmcBankBranchModel"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : data

Type: array

List of Bank Branch Objects.

Show Source

• Array of: object CmcBankBranchModel
  Cmc Bank Branch model.

{
    "type":"array",
    "description":"List of Bank Branch Objects.",
    "items":{
        "$ref":"#/definitions/CmcBankBranchModel"
    }
}

Nested Schema : PagingDto

Type: object

Paging DTO object

Show Source

• totalResults(optional): integer
  Total Results

{
    "description":"Paging DTO object",
    "type":"object",
    "properties":{
        "totalResults":{
            "description":"Total Results",
            "type":"integer"
        }
    }
}

Nested Schema : CmcBankBranchModel

Type: object

Cmc Bank Branch model.

Show Source

• addressLine1(optional): string
  Address line 1.
• addressLine2(optional): string
  Address line 2.
• addressLine3(optional): string
  Address line 3.
• addressLine4(optional): string
  Address line 4.
• bankCode(optional): string
  Bank code
• bankName(optional): string
  Bank name
• branchName(optional): string
  Branch name
• contactPerson(optional): string
  Contact Person
• countryCode(optional): string
  Country code
• designation(optional): string
  Designation
• emailId(optional): string
  Email Id
• fax(optional): string
  Fax
• locationClusterCode(optional): string
  Location Cluster Code
• locationClusterDesc(optional): string
  Location Cluster Description
• locationCode(optional): string
  Location Code
• locationDesc(optional): string
  Location Description
• mobileNo(optional): number
  Consignment Number
• pinCode(optional): string
  Pincode
• requestBranchCode(optional): string
  Branch code
• routingCode(optional): number
  Rounting Code
• stateCode(optional): string
  State Code
• telephone(optional): number
  Telephone

{
    "description":"Cmc Bank Branch model.",
    "type":"object",
    "properties":{
        "addressLine1":{
            "description":"Address line 1.",
            "type":"string"
        },
        "addressLine2":{
            "description":"Address line 2.",
            "type":"string"
        },
        "addressLine3":{
            "description":"Address line 3.",
            "type":"string"
        },
        "addressLine4":{
            "description":"Address line 4.",
            "type":"string"
        },
        "bankCode":{
            "description":"Bank code",
            "type":"string"
        },
        "bankName":{
            "description":"Bank name",
            "type":"string"
        },
        "requestBranchCode":{
            "description":"Branch code",
            "type":"string"
        },
        "branchName":{
            "description":"Branch name",
            "type":"string"
        },
        "contactPerson":{
            "description":"Contact Person",
            "type":"string"
        },
        "countryCode":{
            "description":"Country code",
            "type":"string"
        },
        "designation":{
            "description":"Designation",
            "type":"string"
        },
        "emailId":{
            "description":"Email Id",
            "type":"string"
        },
        "fax":{
            "description":"Fax",
            "type":"string"
        },
        "locationCode":{
            "description":"Location Code",
            "type":"string"
        },
        "mobileNo":{
            "description":"Consignment Number",
            "type":"number"
        },
        "pinCode":{
            "description":"Pincode",
            "type":"string"
        },
        "routingCode":{
            "description":"Rounting Code",
            "type":"number"
        },
        "stateCode":{
            "description":"State Code",
            "type":"string"
        },
        "telephone":{
            "description":"Telephone",
            "type":"number"
        },
        "locationDesc":{
            "description":"Location Description",
            "type":"string"
        },
        "locationClusterCode":{
            "description":"Location Cluster Code",
            "type":"string"
        },
        "locationClusterDesc":{
            "description":"Location Cluster Description",
            "type":"string"
        }
    }
}

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