---
updatedAt: 2026-04-29T19:31:01.000Z
agentTools:
  projectIndex: https://docs.vopay.com/llms.txt
---

# gcm/banks/locations

Get a list of supported bank locations.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "version": "2.0",
    "title": "Global Cash Management",
    "description": "The Global Cash Management API allows you to manage your recipient contacts, delivery channels, and delivery methods.",
    "contact": {
      "name": "API Support",
      "email": "help@vopay.com"
    }
  },
  "paths": {
    "/gcm/banks/locations": {
      "get": {
        "description": "Get a list of supported bank locations.",
        "summary": "gcm/banks/locations",
        "tags": [
          "Recipient Lookup Endpoints"
        ],
        "operationId": "BanksLocationsGET",
        "deprecated": false,
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "AccountID": {
                    "description": "Your account ID",
                    "type": "string"
                  },
                  "Key": {
                    "description": "API key for the account",
                    "type": "string"
                  },
                  "Signature": {
                    "description": "Hashed signature for the request",
                    "type": "string"
                  },
                  "Country": {
                    "description": "The country used to filter the list of banks.",
                    "type": "string"
                  },
                  "BankName": {
                    "description": "The bank name used to filter the list of banks.",
                    "type": "string"
                  },
                  "City": {
                    "description": "The city used to filter the list of banks.",
                    "type": "string"
                  },
                  "BranchName": {
                    "description": "The branch name used to filter the list of banks.",
                    "type": "string"
                  }
                },
                "required": [
                  "AccountID",
                  "Key",
                  "Signature",
                  "Country",
                  "BankName"
                ]
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "Success",
                    "ErrorMessage",
                    "BankLocations"
                  ],
                  "properties": {
                    "Success": {
                      "type": "boolean",
                      "description": "True if the request was successful, false if it failed",
                      "example": true
                    },
                    "ErrorMessage": {
                      "type": "string",
                      "description": "Contains a description of the error if the request failed",
                      "example": ""
                    },
                    "BankLocations": {
                      "type": "object",
                      "description": "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.",
                      "x-list-of": "inline",
                      "x-empty-when": "no banks match",
                      "properties": {
                        "0": {
                          "type": "object",
                          "required": [
                            "BicCode",
                            "BankName",
                            "BranchName",
                            "Address",
                            "City",
                            "State",
                            "Phone"
                          ],
                          "properties": {
                            "BicCode": {
                              "type": "string",
                              "description": "The assigned BIC code",
                              "example": "ANZBAUS1XXX"
                            },
                            "BankName": {
                              "type": "string",
                              "description": "The full bank name",
                              "example": "Australia And New Zealand Banking Group Limited"
                            },
                            "BranchName": {
                              "type": "string",
                              "description": "The full branch name",
                              "example": "Australia And New Zealand Banking Group Limited, Sydney"
                            },
                            "Address": {
                              "type": "string",
                              "description": "The branches address",
                              "example": "ANZ Tower, 242 Pitt Street NSW 2000, Australia"
                            },
                            "City": {
                              "type": "string",
                              "description": "The city",
                              "example": "Sydney"
                            },
                            "State": {
                              "type": "string",
                              "description": "The state",
                              "example": "NSW"
                            },
                            "Phone": {
                              "type": "string",
                              "description": "The phone number",
                              "example": "+61 3 9273 5555"
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://earthnode-dev.vopay.com/api/v2"
    }
  ]
}
```