L'objet client

Cet objet représente un client qui effectuera des paiements via votre service.

Attributs

id chaîne
L'identifiant unique du client (MAX 64 ; MIN 36).
Exemple: faa89e18-5a11-11ed-9b6a-0242ac120002

merchant_customer_id chaîne
L'identifiant unique du client chez le commerçant externe (MAX 255 ; MIN 1).
Exemple : 50ca6f06-5a12-11ed-9b6a-0242ac120002

merchant_customer_created_at timestamp
Date d’enregistrement du client sur la plate-forme des commerçants (MAX 27 ; MIN 27) ISO 3166-1).
Exemple: 2022-05-09T20:46:54.786342Z

first_name chaîne
Le prénom du client (MAX 255 ; MIN 1).
Exemple : John

last_name chaîne
Nom de famille du client (MAX 255 ; MIN 1).
Exemple : Doe

gender enum
Le Genre du client (MAX 2 ; MIN 1).
Valeurs possibles : M, F ou NB

date_of_birth chaîne
La date de naissance du client au format AAAA-MM-JJ (MAX 10 ; MIN 10).
Exemple : 1990-02-28

email chaîne
L'e-mail du client (MAX 255 ; MIN 3).
Exemple : [email protected]

nationality enum
Nationalité du client (MAX 2 ; MIN 2 ; ISO 3166-1).
Valeurs possibles : Voir la référence du pays.

country enum
Pays du client (MAX 2 ; MIN 2 ; ISO 3166-1).
Valeurs possibles : Voir la référence du pays.

document objet

Spécifie l'objet document du client, y compris son numéro et son type.

document_number chaîne
Le numéro de document du client (MAX 40 ; MIN 3).
Exemple : 1093333333

document_type enum
Le type de document du client (MAX 6 ; MIN 2).
Valeurs possibles de l'énumération : Vérifier la référence du pays.

phone objet

Spécifie l'objet numéro de téléphone du client.

country_code chaîne
Le code d'appel du pays du téléphone du client (MAX 3 ; MIN 1). Valeurs possibles : Vérifier le Référence des pays.
Exemple : 57

number chaîne
Le numéro de téléphone du client, sans l'indicatif du pays (MAX 32 ; MIN 1).
Exemple : 3132450765

billing_address objet

Spécifie l'objet adresse de facturation du client.

address_line_1 chaîne
Ligne principale de l'adresse de facturation du client (MAX 255 ; MIN 3).
Exemple : Calle 34 # 56 - 78

address_line_2 chaîne
Ligne de l'adresse de facturation secondaire du client (MAX 255 ; MIN 3).
Exemple : Apartamento 502, Torre I

city chaîne
La ville considérée pour l'adresse de facturation (MAX 255 ; MIN 3).
Exemple : Bogota

country enum
Le pays considéré pour l'adresse de facturation (MAX 2 ; MIN 2 ; ISO 3166-1).
Valeurs possibles : Voir la référence du pays.

state chaîne
État considéré pour l'adresse de facturation (MAX 255 ; MIN 3 ; ISO 3166-2).
Exemple : Cundinamarca

zip_code chaîne
Le code postal pris en compte pour l'adresse de facturation (MAX 11 ; MIN 4).
Exemple : 111111

neighborhood chaîne
Le voisinage de la ligne d'adresse du client (MAX 255 ; MIN 2)
Exemple : Barrio 11

shipping_address objet

Spécifie l'objet adresse de livraison du client.

address_line_1 chaîne
Ligne de l'adresse de livraison principale du client (MAX 255 ; MIN 3).
Exemple : Calle 34 # 56 - 78

address_line_2 chaîne
Ligne de l'adresse de livraison secondaire du client (MAX 255 ; MIN 3).
Exemple : Apartamento 502, Torre I

city chaîne
La ville considérée pour l'adresse de livraison (MAX 255 ; MIN 3).
Exemple : Bogota

country enum
Le pays considéré pour l'adresse de livraison (MAX 2 ; MIN 2 ; ISO 3166-1).
Valeurs possibles : Voir la référence du pays.

state chaîne
État considéré pour l'adresse de livraison (MAX 255 ; MIN 3 ; ISO 3166-2).
Exemple : Cundinamarca

zip_code chaîne
Le code postal pris en compte pour l'adresse de livraison (MAX 10 ; MIN 5).
Exemple : 111111

neighborhood chaîne
Le voisinage de la ligne d'adresse du client (MAX 255 ; MIN 2)
Exemple : Barrio 11

metadata tableau d'objets

Spécifie une liste de paires clé-valeur personnalisées associées au client (pour les références internes, la segmentation ou les balises de flux de travail). Vous pouvez ajouter jusqu'à 50 objets de métadonnées.

metadata object objet

Spécifie une clé de métadonnées et la valeur correspondante.

A utiliser pour attacher un contexte défini par le commerçant (par exemple : crm_id, segment). Évitez d'envoyer des données sensibles ou personnelles.

key chaîne
Spécifie une clé de métadonnées.
Exemple : âge

value chaîne
Spécifie la valeur de la clé de métadonnées définie.
Exemple : 28

created_at timestamp
Date et heure de création du client (MAX 27 ; MIN 27 ; ISO 8601).
Exemple: 2022-05-09T20:46:54.786342Z

updated_at timestamp
Date et heure de la dernière mise à jour du client (MAX 27 ; MIN 27 ; ISO 8601).
Exemple: 2022-05-09T20:46:54.786342Z