Create Customer

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

This request creates a customer resource. You need to provide several parameters of the customer in the request body, including the unique identifier of the customer in the external merchant, personal information, as well as billing and shipping addresses.

Creating a customer generates a customer id that can be used to initialize the checkout.

🚧

Important

There are certain objects that are not mandatory when creating a "Customer". However the more information you provide, the approval, conversion and fraud prevention rates will be positively impacted.

Body Params
string
required

The unique identifier of the customer in the external merchant (MAX 255; MIN 3).

date-time

Customer's registration date on the merchants platform (MAX 27; MIN 27; ISO 8601)

string

The customer's first name (MAX 255; MIN 3).

string

The customer's last name (MAX 255; MIN 3).

string

The customer's gender.

string

The customer's date of birth in the YYYY-MM-DD format (MAX 10; MIN 10).

string

The customer's e-mail (MAX 255; MIN 3).

string
enum

The customer's nationality (MAX 2; MIN 2; ISO 3166-1).

string
enum

The customer's country (MAX 2; MIN 2; ISO 3166-1).

document
object

Specifies the customer's document object, including its number and type. This object is not mandatory. However, if you send this information, the payment experience will be enhanced for your user.

phone
object

Specifies the customer's phone number object. This object is not mandatory. However, if you send this information, the payment experience will be enhanced for your user.

billing_address
object

Specifies the customer's billing address object. This object is not mandatory. However, if you send this information, the payment experience will be enhanced for your user.

shipping_address
object

Specifies the customer's shipping address object. This object is not mandatory. However, if you send this information, the payment experience will be enhanced for your user.

metadata
array of objects

Specifies a list of metadata objects. You can add up to 50 metadata objects.

metadata
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json