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.

CountryCodeAlpha2string

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

CountryCodeAlpha3string

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

CountryCodeNumericstring

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

CountryNamestring

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

CreatedAtDateTime

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

CustomerIdstring

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

ExtendedAddressstring

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

FirstNamestring

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.

InternationalPhonemap

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

CountryCodestring

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

NationalNumberstring

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

LastNamestring

The last name.

Localitystring

The locality/city.

PhoneNumberstring

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.

PostalCodestring

The postal code.

Regionstring

The state or province.

StreetAddressstring

The street address.

UpdatedAtDateTime

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