Créer le profil d’un client
POST /customervault/v1/profiles
Voir notre documentation API complète pour une description intégrale des paramètres requis pour la requête de création de profil.
Un profil contient des informations de base sur votre client, comme son identifiant unique, sa localisation (langue), son nom et ses coordonnées.
Pour créer un profil, vous devez envoyer une requête POST au point de terminaison des profils contenant l’identifiant et la localisation du client; en option, vous pouvez également inclure les données de sa carte, les données de son compte bancaire ou un jeton de paiement à usage unique représentant ces données (qui expire après 15 minutes) et recevoir un jeton de paiement permanent et réutilisable dans la réponse. L’exemple ci-dessous décrit la requête et la réponse POST de base.
Consultez le document de Référence API pour de plus amples renseignements sur les nombreuses autres façons de créer un profil, notamment en utilisant une carte de crédit, un compte bancaire ou un jeton à usage unique.
curl -X POST https://api.test.paysafe.com/customervault/v1/profiles \
-u devcentre322:B-qa2-0-53625f86-302c021476f52bdc9deab7aea876bb28762e62f92fc6712d0214736abf501e9675e55940e83ef77f5c304edc7968 \
-H ’Content-Type: application/json’ \
-d ’ {
"merchantCustomerId":"mycustomer1",
"locale" : "en_US",
"firstName" : "John",
"lastName" : "Smith",
"phone" : "713-444-5555",
"email" : "john.smith@somedomain.com",
"cellPhone" : "713-444-5556"
}'
Avant d’essayer l’exemple ci-dessus, vous devez :
- Remplacez la clé API (après le -u) par la clé API que vous avez reçue.
- Fournissez un numéro d’identification unique pour chaque profil que vous créez.
Avant d’utiliser une carte ou un jeton de paiement à usage unique pour créer un profil, vous devez vérifier s’il est valide en utilisant l’API Paiements par carte. La vérification d’un jeton à usage unique ne l’épuise pas.
| Élément | Type | Requis? | Description |
|---|---|---|---|
| carte | object | Non* | * Requis uniquement lorsqu’une carte ou un jeton de paiement à usage unique est utilisé pour créer un profil. Il s’agit du jeton de paiement à usage unique ou des données de la carte. |
| merchantCustomerId | string | Oui length<=100length<=100 | Il s’agit de l’identifiant que le marchand fournit avec la requête pour sa propre identification interne du client. Cette valeur doit être unique pour chaque client appartenant à un marchand. |
| locale | enum | Oui | Indique la langue du profil. Les valeurs éventuelles sont :
|
| firstName | string | Non length<=80 | Il s’agit du prénom du client. |
| lastName | string | Non length<=80 | Il s’agit du nom de famille du client. |
| phone | string | Non length<=40 | Il s’agit du numéro de téléphone du client. |
| adresse courriel | string | Non length<=255 | Il s’agit de l’adresse courriel du client. |
| cellPhone | string | Non length<=40 | Il s’agit du numéro de téléphone cellulaire du client. |
{
"id" : "716adb4f-6b85-4089-ba9c-d9c0eb649cd7",
"status" : "ACTIVE",
"merchantCustomerId" : "mycustomer1",
"locale" : "en_US",
"firstName" : "John",
"lastName" : "Smith",
"phone" : "713-444-5555",
"cellPhone" : "713-444-5556"
"email" : "john.smith@somedomain.com",
"paymentToken" : "PyhYo1nGKUfWOPj"
}
La réponse contient tous les détails du profil soumis dans la requête et l’identifiant unique du nouveau profil. Notez l’identifiant que vous utiliserez ultérieurement pour mettre à jour le profil et lier l’adresse, la carte et les données bancaires. Les valeurs spécifiques à la réponse sont indiquées ci-dessous.
| Élément | Type | Description |
|---|---|---|
| Id | string | Il s’agit de l’identifiant du profil. |
| paymentToken | string length<=50 | Il s’agit d’un jeton qui représente le client. Il ne s’agit pas d’un jeton de paiement utilisable. |
| status | enum | Il s’agit de l’état de la requête de profil :
|
Le paymentToken dans la réponse ci-dessus ne peut pas être utilisé pour effectuer des paiements. Seul un paymentToken à l’intérieur d’un objet cards est un jeton permanent valide (ou à l’intérieur d’un objet bankAccounts lorsqu’il contient des informations bancaires pour la création d’un profil).