Address
Server-side response object returned directly or within a successful result object from the following requests:
Attributes
getCompany()
stringCompany name.
getCountryCodeAlpha2()
stringThe ISO 3166-1 alpha-2 country code specified in an address. The gateway only uses specific alpha-2 values.
getCountryCodeAlpha3()
stringThe ISO 3166-1 alpha-3 country code specified in an address. The gateway only uses specific alpha-3 values.
getCountryCodeNumeric()
stringThe ISO 3166-1 numeric country code specified in an address. The gateway only uses specific numeric values.
getCountryName()
stringThe country name specified in an address. We only accept specific country names.
getCreatedAt()
CalendarThe date/time the object was created. Returned in UTC.
getCustomerId()
stringA string value representing an existing customer in your Vault that owns this address. Use this to look up a single customer.
getExtendedAddress()
stringThe extended address information—such as apartment or suite number.
getFirstName()
stringThe first name.
getId()
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.
getCountryCode()
stringCountry code of phone number. 1-3 digits. Required.
getNationalNumber()
stringNational number of phone number. 4-12 digits. Required.
getLastName()
stringThe last name.
getLocality()
stringThe locality/city.
getPhoneNumber()
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.
getPostalCode()
stringThe postal code.
getRegion()
stringThe state or province.
getStreetAddress()
stringThe street address.
getUpdatedAt()
CalendarThe date/time the object was last updated. Returned in UTC.