Skip to main content
This object represents a customer who will make payments using your service.

Attributes

id
string
The unique identifier of the customer (MAX 64; MIN 36).Example: faa89e18-5a11-11ed-9b6a-0242ac120002
merchant_customer_id
string
The unique identifier of the customer in the external merchant (MAX 255; MIN 1).Example: 50ca6f06-5a12-11ed-9b6a-0242ac120002
merchant_customer_created_at
timestamp
Customer´s registration date on the merchants platform (MAX 27; MIN 27 ISO 3166-1 ).Example: 2022-05-09T20:46:54.786342Z
first_name
string
The customer’s first name (MAX 255; MIN 1).Example: John
last_name
string
The customer’s last name (MAX 255; MIN 1).Example: Doe
gender
enum
The customer’s gender (MAX 2; MIN 1).Possible enum values: M, F or NB
date_of_birth
string
The customer’s date of birth in the YYYY-MM-DD format (MAX 10; MIN 10).Example: 1990-02-28
email
string
The customer’s e-mail (MAX 255; MIN 3).Example: john.doe@email.com
nationality
enum
The customer’s nationality (MAX 2; MIN 2; ISO 3166-1 ).Possible enum values: Check the Country reference.
country
enum
The customer’s country (MAX 2; MIN 2; ISO 3166-1 ).Possible enum values: Check the Country reference.
document
object
Specifies the customer’s document object, including its number and type.
phone
object
Specifies the customer’s phone number object.
billing_address
object
Specifies the customer’s billing address object.
shipping_address
object
Specifies the customer’s shipping address object.
metadata
array of objects
Specifies a list of custom key–value pairs associated with the customer (for internal references, segmentation, or workflow tags). You can add up to 50 metadata objects.
created_at
timestamp
Customer creation date and time (MAX 27; MIN 27; ISO 8601 ).Example: 2022-05-09T20:46:54.786342Z
updated_at
timestamp
Last customer update date and time (MAX 27; MIN 27; ISO 8601 ).Example: 2022-05-09T20:46:54.786342Z