Address
Server-side response object returned directly or within a successful result object from the following requests:
Attributes
company
StringCompany name.
countryCodeAlpha2
StringThe ISO 3166-1 alpha-2 country code specified in an address. The gateway only uses specific alpha-2 values.
countryCodeAlpha3
StringThe ISO 3166-1 alpha-3 country code specified in an address. The gateway only uses specific alpha-3 values.
countryCodeNumeric
StringThe ISO 3166-1 numeric country code specified in an address. The gateway only uses specific numeric values.
countryName
StringThe country name specified in an address. We only accept specific country names.
createdAt
StringThe date/time the object was created. Returned in UTC.
customerId
StringA string value representing an existing customer in your Vault that owns this address. Use this to look up a single customer.
extendedAddress
StringThe extended address information—such as apartment or suite number.
firstName
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.
countryCode
StringCountry code of phone number. 1-3 digits. Required.
nationalNumber
StringNational number of phone number. 4-12 digits. Required.
lastName
StringThe last name.
locality
StringThe locality/city.
phoneNumber
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.
postalCode
StringThe postal code.
region
StringThe state or province.
streetAddress
StringThe street address.
updatedAt
StringThe date/time the object was last updated. Returned in UTC.