Ajouter une carte à un profil
POST /customervault/v1/profiles/profile_id/cards
Voir notre documentation API complète pour une description intégrale des paramètres requis pour la requête de création d’une carte.
L’API Coffre-fort client vous permet de stocker plusieurs cartes de crédit dans le profil de votre client. Pour la facturation, chaque carte de crédit peut être associée à une adresse différente ou toutes les cartes de crédit peuvent être associées à la même adresse de facturation, en fonction des besoins de votre entreprise.
Pour ajouter une carte de crédit à un profil et l’associer à l’adresse que vous venez de créer, vous devez utiliser l’identifiant du profil (716adb4f-6b85-4089-ba9c-d9c0eb649cd7 dans l’exemple précédent) et envoyer une requête POST au point de terminaison du profil concerné. Le corps du message POST contient les informations relatives à la carte et un paramètre billingAddressId contenant l’identifiant de l’adresse à laquelle vous souhaitez associer la carte (81ffcddf-ad82-40d2-aaa0-c4f9c376ad65 dans l’exemple précédent).
curl -X POST https://api.test.paysafe.com/customervault/v1/profiles/716adb4f-6b85-4089-ba9c-d9c0eb649cd7/cards \
-u devcentre322:B-qa2-0-53625f86-302c021476f52bdc9deab7aea876bb28762e62f92fc6712d0214736abf501e9675e55940e83ef77f5c304edc7968 \
-H 'Content-Type: application/json' \
-d ' {
"nickName":"Personal Visa",
"holderName" : "John Smith",
"cardNum" : "4530910000012345",
"cardExpiry" : {
"month" : 12,
"year" : 2019
},
"billingAddressId" : "81ffcddf-ad82-40d2-aaa0-c4f9c376ad65"
}'
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.
- Remplacez l’identifiant du profil et les valeurs billingAddressId par les valeurs d’identification renvoyées lors de la création d’un exemple de profil et d’adresse.
| Élément | Type | Requis? | Description |
|---|---|---|---|
| billingAddressIdbillingAddressId | string | Non | Il s’agit de l’identifiant renvoyé lors de la création de l’adresse. Il s’agit de l’adresse associée à la carte. |
| accountId | string | Non | Il s’agit d’un identifiant de compte marchand (FMA) fourni par le marchand et qui sera lié à la carte de cette requête. Par exemple : 1002370290. |
| cardExpiry | object | Oui | Il s’agit de la date d’expiration de la carte. Les paramètres suivants sont requis :
|
| cardNum | string | Oui | Il s’agit du numéro de la carte. |
| defaultCardIndicator | boolean | Non | Il s’agit de l’indicateur qui marque cette carte comme étant la carte par défaut du profil. |
| holderName | string | Oui | Il s’agit du nom du titulaire de la carte. |
| merchantRefNum | string | Non | Il s’agit de l’identification de la carte du marchand. |
| nickName | string | Non | Il s’agit d’un alias pour cette adresse défini par le client, p. ex. « adresse personnelle ». |
{
"id" : "178ae2b8-85a5-4761-b1dd-4f14ac73571b",
"status" : "ACTIVE",
"holderName" : "John Smith",
"cardBin" : "453091",
"lastDigits" : "2345",
"cardExpiry" : {
"month" : 12,
"year" : 2019
},
"cardType" : "VI",
"cardCategory":"CREDIT",
"paymentToken" : "CaBP0abDKgROjYU",
"billingAddressId" : "81ffcddf-ad82-40d2-aaa0-c4f9c376ad65",
"defaultCardIndicator" : false
}
Les paramètres de réponse non contenus dans la requête sont décrits ci-dessous :
| Élément | Type | Description |
|---|---|---|
| Id | string | Il s’agit de l’identifiant de la carte renvoyé dans la réponse. |
| cardType | enum | Il s’agit de la marque de carte. Les valeurs éventuelles sont :
|
| cardCategory | enum | Ceci indique la catégorie de carte. Les valeurs éventuelles sont :
|
| paymentToken | string | Il s’agit d’un jeton qui représente la carte et qui est renvoyé dans la réponse. |