Server-Side Response Objects/
Address

Address

Server-side response object returned directly or within a successful result object from the following requests:
Attributes
companyString

Company name.

country_code_alpha2String

The ISO 3166-1 alpha-2 country code specified in an address. The gateway only uses specific alpha-2 values.

country_code_alpha3String

The ISO 3166-1 alpha-3 country code specified in an address. The gateway only uses specific alpha-3 values.

country_code_numericString

The ISO 3166-1 numeric country code specified in an address. The gateway only uses specific numeric values.

country_nameString

The country name specified in an address. We only accept specific country names.

created_atTime

The date/time the object was created. Returned in UTC.

customer_idString

A string value representing an existing customer in your Vault that owns this address. Use this to look up a single customer.

extended_addressString

The extended address information—such as apartment or suite number.

first_nameString

The first name.

idString

The two-letter value for an address associated with a specific customer ID. The maximum number of addresses per customer is 50.

international_phonemap

The phone number that belongs to the address that is structured with country code and national number.

country_codeString

Country code of phone number. 1-3 digits. Required.

national_numberString

National number of phone number. 4-12 digits. Required.

last_nameString

The last name.

localityString

The locality/city.

phone_numberString

Deprecated.

We recommend using international_phone. This functionality still exists in the gateway but is no longer documented. This parameter will be removed in the future.

postal_codeString

The postal code.

regionString

The state or province.

street_addressString

The street address.

updated_atTime

The date/time the object was last updated. Returned in UTC.