Address

Address: Update

See also the Address response object.

  1. Python
gateway.address.update("the_customer_id", 'the_address_id', {
    "first_name": "Jenna",
    "last_name": "Smith",
    "company": "Braintree",
    "street_address": "1 E Main St",
    "extended_address": "Suite 403",
    "locality": "Chicago",
    "region": "Illinois",
    "postal_code": "60622",
    "country_code_alpha2": "US"
})
note

In addition to updating an address directly, you can also update an address while updating a customer or updating a payment method.

If the address or customer can't be found, it will throw a NotFoundError exception.

Arguments
address_idrequired, str
The 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.
customer_idrequired, str
A string value representing an existing customer in your Vault.
Additional Parameters
'company'str
Company name. 255 character maximum.
'country_code_alpha2'str

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

'country_code_alpha3'str

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

'country_code_numeric'str

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

'country_name'str

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

'extended_address'str
The extended address information—such as apartment or suite number. 255 character maximum.
'first_name'str
The first name. The first name value must be less than or equal to 255 characters.
'international_phone'
The phone number that belongs to the address that is structured with country code and national number.
'country_code'str
Country code of phone number. 1-3 digits. Required.
'national_number'str
National number of phone number. 4-12 digits. Required.
'last_name'str
The last name. The last name value must be less than or equal to 255 characters.
'locality'str
The locality/city. 255 character maximum.
'phone_number'str

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.

'postal_code'str
The 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'str
The 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.
'street_address'str
The 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.