Recipient Lookup Endpoints

gcm/banks/locations

Get a list of supported bank 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

Request body application/x-www-form-urlencoded

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

Countrystring required

The country used to filter the list of banks.

BankNamestring required

The bank name used to filter the list of banks.

Citystring

The city used to filter the list of banks.

BranchNamestring

The branch name used to filter the list of banks.

Response

Successboolean required

True if the request was successful, false if it failed

ErrorMessagestring required

Contains a description of the error if the request failed

Example response

{
  "Success": true,
  "BankLocations": {
    "0": {
      "BicCode": "ANZBAUS1XXX",
      "BankName": "Australia And New Zealand Banking Group Limited",
      "BranchName": "Australia And New Zealand Banking Group Limited, Sydney",
      "Address": "ANZ Tower, 242 Pitt Street NSW 2000, Australia",
      "City": "Sydney",
      "State": "NSW",
      "Phone": "+61 3 9273 5555"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.