Address
Server-side response object returned directly or within a successful result object from the following requests:
Attributes
company
StringCompany name.
country_code_alpha2
StringThe ISO 3166-1 alpha-2 country code specified in an address. The gateway only uses specific alpha-2 values.
country_code_alpha3
StringThe ISO 3166-1 alpha-3 country code specified in an address. The gateway only uses specific alpha-3 values.
country_code_numeric
StringThe ISO 3166-1 numeric country code specified in an address. The gateway only uses specific numeric values.
country_name
StringThe country name specified in an address. We only accept specific country names.
created_at
TimeThe date/time the object was created. Returned in UTC.
customer_id
StringA string value representing an existing customer in your Vault that owns this address. Use this to look up a single customer.
extended_address
StringThe extended address information—such as apartment or suite number.
first_name
StringThe first name.
id
StringThe two-letter value for an address associated with a specific customer ID. The maximum number of addresses per customer is 50.
The phone number that belongs to the address that is structured with country code and national number.
country_code
StringCountry code of phone number. 1-3 digits. Required.
national_number
StringNational number of phone number. 4-12 digits. Required.
last_name
StringThe last name.
locality
StringThe locality/city.
phone_number
StringDeprecated.
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_code
StringThe postal code.
region
StringThe state or province.
street_address
StringThe street address.
updated_at
TimeThe date/time the object was last updated. Returned in UTC.