Documentation

BankPay

BankPay

  2. Home
  4. BankPay
  6. API
  8. Addresses

Addresses

Address object

{
    "city_locality": "Tampa",
    "country_code": "US",
    "line_1": "123 Main St.",
    "line_2": "Suite 100",
    "state_province": "FL",
    "postal_code": "33603"
}
Data Data type Description
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

Field Restrictions Min Size Max Size
city_locality

Alphanumeric and special characters. Must contain only uppercase letters (A-Z), lowercase letters (a-z), numbers (0-9), period (.), apostrophe ('), dash (-), comma (,), and spaces.

1 30
country_code

ISO 3166-1 alpha-2

 2 2
line_1

Alphanumeric and special characters. Must contain only uppercase letters (A-Z), lowercase letters (a-z), numbers (0-9), period (.), apostrophe ('), dash (-), number (#), ampersand (&), slash (/), comma (,), and spaces.

0 39*
line_2

Alphanumeric and special characters. Must contain only uppercase letters (A-Z), lowercase letters (a-z), numbers (0-9), period (.), apostrophe ('), dash (-), number (#), ampersand (&), slash (/), comma (,), and spaces.

0 39*
state_province

ISO 3166-2:US

 2 2
postal_code

Alphanumeric and spaces.

 5 9

  • line_1 and line_2 combined must not exceed 39 characters.

Actions

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

Back to Top

Was this article helpful to you? Yes No

How can we help?