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: [email protected]
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.
document_number string
The customer's document number (MAX 40; MIN 3).
Example: 1093333333
document_type enum
The customer's document type (MAX 6; MIN 2).
Possible enum values: Check the
Country reference.
phone object
Specifies the customer's phone number object.
country_code string
The country calling code of the customer's phone (MAX 3; MIN 1). Possible values: Check the
Country reference.
Example: 57
number string
The customer's phone number, without the country code (MAX 32; MIN 1).
Example: 3132450765
billing_address object
Specifies the customer's billing address object.
address_line_1 string
The primary billing address line of the customer (MAX 255; MIN 3).
Example: Calle 34 # 56 - 78
address_line_2 string
The secondary billing address line of the customer (MAX 255; MIN 3).
Example: Apartamento 502, Torre I
city string
The city considered for the billing address (MAX 255; MIN 3).
Example: Bogotá
country enum
The country considered for the billing address (MAX 2; MIN 2; ISO 3166-1).
Possible enum values: Check the Country reference.
state string
The state considered for the billing address (MAX 255; MIN 3; ISO 3166-2).
Example: Cundinamarca
zip_code string
The zipcode considered for the billing address (MAX 11; MIN 4).
Example: 111111
neighborhood string
The neighborhood of the address line of the customer(MAX 255; MIN 2)
Example: Barrio 11
shipping_address object
Specifies the customer's shipping address object.
address_line_1 string
The primary shipping address line of the customer (MAX 255; MIN 3).
Example: Calle 34 # 56 - 78
address_line_2 string
The secondary shipping address line of the customer (MAX 255; MIN 3).
Example: Apartamento 502, Torre I
city string
The city considered for the shipping address (MAX 255; MIN 3).
Example: Bogotá
country enum
The country considered for the shipping address (MAX 2; MIN 2; ISO
3166-1).
Possible enum values: Check the Country reference.
state string
The state considered for the shipping address (MAX 255; MIN 3; ISO 3166-2).
Example: Cundinamarca
zip_code string
The zipcode considered for the shipping address (MAX 10; MIN 5).
Example: 111111
neighborhood string
The neighborhood of the address line of the customer(MAX 255; MIN 2)
Example: Barrio 11
metadata array of objects
Specifies a list of metadata objects. You can add up to 50 metadata objects.
metadata object object
Specifies a metadata key and the respective value.
key string
Specifies one metadata key.
Example: age
value string
Specifies the value for the defined metadata key.
Example: 28
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