API Documentation

Address

An address is a postal address for a specific customer. A customer can have up to 2 different types of addresses. If a customer has only one Address, that is what is returned. Mailing address is only required if different from residential address.

Note: For debit card mailing address, only the first 30 characters of Line 1 and Line 2 are sent to the card manufacturer.

address Object

Represents a postal address for a customer.

details

Property Data Type
(length)
Description
addressType string (50) Valid values include:
  • Mailing Primary. Also used by merchant POS and AFD.
  • Residence Secondary. PO Box should not be used as a residence address.
addressLine1 string (100) Note: DPS clients are limited to 76 characters
addressLine2 string (100) Note: DPS clients are limited to 76 characters
addressLine3 string (100) Note: DPS clients are limited to 76 characters
addressLine4 string (100) Note: DPS clients are limited to 76 characters
city string (50)
state string (2) 2-character code for a US state. e.g.: IA
postalCode string (9)
country string (50) Must be US
isActive boolean

Ready to start a conversation?

Email Us