1. Home
  2. Docs
  3. BankPay
  4. API
  5. Addresses


Address object

    "city_locality": "Tampa",
    "country_code": "US",
    "line_1": "123 Main St.",
    "line_2": "Suite 100",
    "state_province": "FL",
    "postal_code": "33603"
  • city_locality string

City, district, suburb, town, or village.

  • country_code string

Two-letter country code as defined by ISO 3166-1 alpha-2.

  • line_1 string

Address line 1 (e.g., street or PO Box).

  • line_2 string

Address line 2 (e.g., apartment, suite, unit, or building).

  • state_province string

State, province, county, or region.

  • postal_code string

ZIP or Postal code.

Address field restrictions

FieldRestrictionsMin SizeMax Size
city_localityLetters, spaces, hyphens, periods and apostrophes only130
country_codeISO 3166-1 alpha-222
line_1Letters, digits, spaces, special characters039*
line_2Letters, digits, spaces, special characters039*
state_provinceLetters, digits, spaces, special characters22
postal_codeAlphanumeric + spaces59
  • line_1 and line_2 combined must not exceed 39 characters.


Currently, there are no endpoints to retrieve or affect addresses directly.

Back to Top

How can we help?