Braintree::Address.create()

See also the Braintree::Address response object.

The only attribute required to create an address is the customer_id. Addresses stored in the Vault need to be associated to a customer. You cannot 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.

result = Braintree::Address.create(
  :customer_id         => '131866',
  :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'
)
Ruby
Parameters
:company

Company name. 255 character maximum.

:country_code_alpha2

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

:country_code_alpha3

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

:country_code_numeric

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

:country_name

The country name specified in an address. Braintree only accepts specific country names.

:customer_id
Required

The identification value of the customer. The value must be less than or equal to 36 characters. Valid characters are letters, numbers, - and _. The words "all" and "new" currently cannot be used.

:extended_address

The extended address information—such as apartment or suite number. 255 character maximum.

:first_name

The first name. The first name value must be less than or equal to 255 characters.

:last_name

The last name. The last name value must be less than or equal to 255 characters.

:locality

The locality/city. 255 character maximum.

:postal_code

The postal code. Postal code must be a string of 5 or 9 alphanumeric digits, optionally separated by a dash or a space. Spaces, hyphens, and all other special characters are ignored.

:region

The state or province. The region must be a 2-letter abbreviation and must be less than or equal to 255 characters.

:street_address

The street address. Maximum 255 characters, and must contain at least 1 digit. Required when used to create payment methods or transactions that perform verification when AVS rules are configured to require street address.


Still Have Questions?

If you can’t find an answer, give us a call at 877.434.2894 or email our Support team.