Praxis Wiki logo

Objects Customer Data


The customer data data object represents the customer's billing information, which is typically required for the card payment processing.

STRUCTURE

✓ - required value
? - optional, value or null
✕ - always appears as null

Variable Type Cashier API Direct/HPF API Description
country varchar(2) ISO 3166-1 alpha-2 country code (US, MT, IT, GB, DE etc.)
first_name varchar(25) Customer's first name
last_name varchar(25) Customer's last name
dob date ? MM/DD/YYYY, customer's date of birth
email varchar(50) Customer's email
phone int(20) ? Numeric only, must include country area code (international format)
zip varchar(12) ? Postal Code of the customer. Required for US and CA. Can provide values for other countries. Limited to 12 alphanumeric characters only.
state varchar(3) ? State/Province where the customer resides. Required for countries: US, CA and AU. 2 or 3 characters ISO format.
city varchar(50) ? City of the customer
address varchar(100) ? Customer's address
profile int(2) ? Customer's profile level. Different profile levels may be used to configure the transaction and payment method limits

EXAMPLE

{
    "country": "GB",
    "first_name": "John",
    "last_name": "Johnson",
    "dob": "12\/31\/1980",
    "email": "[email protected]",
    "phone": 44201112222,
    "zip": "WC2N 5DU",
    "state": "JS",
    "city": "London",
    "address": "Random st., 12\/3",
    "profile": 1
}