---
title: "gcm/banks/locations"
method: GET
path: "/gcm/banks/locations"
tags: ["Recipient Lookup Endpoints"]
---

# gcm/banks/locations

`GET /gcm/banks/locations`

## Request

- Base URL: `https://earthnode-dev.vopay.com/api/v2`
- URL: `https://earthnode-dev.vopay.com/api/v2/gcm/banks/locations`
- Auth: none declared

Get a list of supported bank locations.

## Request body `application/x-www-form-urlencoded`

- object
  - `AccountID` string, required: Your account ID
  - `Key` string, required: API key for the account
  - `Signature` string, required: Hashed signature for the request
  - `Country` string, required: The country used to filter the list of banks.
  - `BankName` string, required: The bank name used to filter the list of banks.
  - `City` string: The city used to filter the list of banks.
  - `BranchName` string: The branch name used to filter the list of banks.

## Response `200`

- object
  - `Success` boolean, required: True if the request was successful, false if it failed
  - `ErrorMessage` string, required: Contains a description of the error if the request failed
  - `BankLocations` object, required: Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Empty {} when no items. All the bank locations found for the given parameters.
    - `0` object
      - `BicCode` string, required: The assigned BIC code
      - `BankName` string, required: The full bank name
      - `BranchName` string, required: The full branch name
      - `Address` string, required: The branches address
      - `City` string, required: The city
      - `State` string, required: The state
      - `Phone` string, required: The phone number

---

[API](https://skmtc.dev/vopay/apis/global-cash-management.md) - [All operations](https://skmtc.dev/vopay/apis/global-cash-management/llms.txt) - [OpenAPI document](https://skmtc.dev/vopay/apis/global-cash-management/revisions/1b58a7445906?raw)