Address

Address: Create

See also the Address response object.

The only attribute required to create an address is the customerId. Addresses stored in the Vault need to be associated to a customer. You can't specify Address ID. It is always generated by the gateway as two alphanumeric characters. Address IDs are unique to the customer, so multiple customers can have the same address ID.

There is a limit of 50 addresses that can be saved per customer. Addresses can also be created with a payment method or created with a customer and a payment method.

  1. PHP
$result = $gateway->address()->create([
  'customerId'        => '131866',
  'firstName'         => 'Jenna',
  'lastName'          => 'Smith',
  'company'           => 'Braintree',
  'streetAddress'     => '1 E Main St',
  'extendedAddress'   => 'Suite 403',
  'locality'          => 'Chicago',
  'region'            => 'Illinois',
  'postalCode'        => '60622',
  'countryCodeAlpha2' => 'US'
]);

If the address or customer can't be found, you'll receive a Braintree\Exception\NotFound exception.

Arguments
customerIdrequired, string
A string value representing an existing customer in your Vault that you want to create an address for.
Additional Parameters
'company'string
Company name. 255 character maximum.
'countryCodeAlpha2'string

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

'countryCodeAlpha3'string

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

'countryCodeNumeric'string

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

'countryName'string

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

'extendedAddress'string
The extended address information—such as apartment or suite number. 255 character maximum.
'firstName'string
The first name. The first name value must be less than or equal to 255 characters.
'internationalPhone'
The phone number that belongs to the address that is structured with country code and national number.
'countryCode'string
Country code of phone number. 1-3 digits. Required.
'nationalNumber'string
National number of phone number. 4-12 digits. Required.
'lastName'string
The last name. The last name value must be less than or equal to 255 characters.
'locality'string
The locality/city. 255 character maximum.
'phoneNumber'string

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.

'postalCode'string
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'string
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.
'streetAddress'string
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.