Customer object

Customers are objects that represent the customer details. The billing address is stored within the customer model. Using the customer model with transactions is not required but can be useful for tracking returning customers or tracking customers along multiple eCommerce sites you might operate. Cards are automatically stored in the customer model creating an overview of which cards belong to which customer.

Customer requirements

A customer object is required in the following scenarios:

• 3DS payment

• Purchase using Klarna payment method

• Purchase using Vipps payment method

• Purchase using MobilePay payment method

• Swish

• PayPal, Wallets

• Cards

The table below details the mapping of the mandatory and optional fields for ecom APMs and wallets.

Customer Object - Mandatory/Optional Fields Table:

APMs	PayPal Managed Path	PayPal Connected path	Klarna ecomm	Swish	Google Pay	Apple Pay	MobilePay	Vipps
Delivery Status	DEPLOYED	DEPLOYED	DEPLOYED	DEPLOYED	DEPLOYED	DEPLOYED	DEPLOYED	DEPLOYED
Environment	PRODUCTION	PRODUCTION	PRODUCTION	PRODUCTION	PRODUCTION	PRODUCTION	PRODUCTION	PRODUCTION
Customer information
First Name	R	R	R	R	O	R	R	R
Last Name	R	R	R	R	O	R	R	R
Phone	R	R	R	O	O	R	O	O
Email	R	R	R	R	O	R	R	R
Tax identification number	O	O	R	O	O	O	O	O
Shipping information
Address line 1	R	R	R	R	O	R	R	R
Address line 2	O	O	O	O	O	O	O	O
Address line 3	O	O	O	O	O	O	O	O
Postal Code	R	R	R	R	O	O	R	R
City	R	R	R	R	O	O	R	R
Country	R	R	R	R	O	O	R	R
Province/ State	R	R	O	O	O	O	O	O
Billing information
Address line 1	R	R	O	O	O	R	O	O
Address line 2	O	O	O	O	O	O	O	O
Address line 3	O	O	O	O	O	O	O	O
Postal Code	R	R	O	O	O	O	O	O
City	R	R	O	O	O	O	O	O
Country	R	R	O	O	O	O	O	O
Province/ State	R	R	O	O	O	O	O

Creating a customer

Customers can be created by sending a POST call to the create customer endpoint depending on the environment your account is set in.

Make sure that all required fields are provided in their correct formats, else the page will fail once the Customer tries to submit a payment with it. The field requirements below take priority over the API schema described in the Customer API reference.

Here is an example request with the required fields for creating a customer for 3-D Secure:

{
    "billing": {
        "address_1": "Street 1",
        "city": "Amsterdam",
        "country_code": "NL",
        "first_name": "John",
        "last_name": "Gilmore",
        "postal_code": "1016 AB",
        "state": "NH"
    },
    "email_address": "[e-mail]",
    "entity_id": "{entityId}",
    "phone_number": "31123456789",
}

The response for creating the customer will look like this:

{
    "id": "string",
    "billing": {
        "address_1": "Street 1",
        "city": "Amsterdam",
        "country_code": "NL",
        "first_name": "John",
        "last_name": "Gilmore",
        "postal_code": "1016 AB",
        "state": "NH"
    },
    "created_at": "2020-07-01",
    "email_address": "[e-mail]",
    "entity_id": "{entityId}",
    "phone_number": "31123456789",
    "updated_at": "2020-07-01"
}