Address: Update
- Node
gateway.address.update("theCustomerId", "theAddressId", {
firstName: "Jenna",
lastName: "Smith",
company: "Braintree",
streetAddress: "1 E Main St",
extendedAddress: "Suite 403",
locality: "Chicago",
region: "Illinois",
postalCode: "60622",
countryCodeAlpha2: "US"
}, (err, result) => {
});
Note
In addition to updating an address directly, you can also update an address while
updating a customer or
updating a payment method.
notFoundError
.
Arguments
addressId
required, StringThe two-letter value for an address associated with a specific customer ID. The maximum number of addresses per customer is 50. You must pass
customer_id
, then address_id
in order to successfully update this value.customerId
required, StringA string value representing an existing customer in your Vault.
Additional Parameters
company
StringCompany name. 255 character maximum.
countryCodeAlpha2
StringThe ISO 3166-1 alpha-2 country code specified in an address. The gateway only accepts specific alpha-2 values.
countryCodeAlpha3
StringThe ISO 3166-1 alpha-3 country code specified in an address. The gateway only accepts specific alpha-3 values.
countryCodeNumeric
StringThe ISO 3166-1 numeric country code specified in an address. The gateway only accepts specific numeric values.
countryName
StringThe country name specified in an address. We only accept specific country names.
extendedAddress
StringThe extended address information—such as apartment or suite number. 255 character maximum.
firstName
StringThe first name. The first name value must be less than or equal to 255 characters.
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. The last name value must be less than or equal to 255 characters.
locality
StringThe locality/city. 255 character maximum.
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. Postal code must be a string of 4-9 alphanumeric characters, optionally separated by a dash or a space. Spaces and hyphens are ignored.
region
StringThe state or province. For PayPal addresses, the region must meet PayPal's state restrictions; for all other payment methods, it must be less than or equal to 255 characters.
streetAddress
StringThe street address. 255 character maximum. Required when used to create payment methods or transactions that perform verification when AVS rules are configured to require street address.