Address
Address: Create
See also the 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 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.
- Python
$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, it will throw a NotFoundError
exception.
Arguments
customer_id
required, strAdditional Parameters
'company'
strThe ISO 3166-1 alpha-2 country code specified in an address. The gateway only accepts specific alpha-2 values.
The ISO 3166-1 alpha-3 country code specified in an address. The gateway only accepts specific alpha-3 values.
The ISO 3166-1 numeric country code specified in an address. The gateway only accepts specific numeric values.
The country name specified in an address. We only accept specific country names.
'first_name'
str'last_name'
str'locality'
strDeprecated.
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.
'region'
str