Créer un jeton de prélèvement automatique à usage unique
POST /customervault/v1/achsingleusetokens
L’API Coffre-fort client vous permet de créer des jetons de prélèvement automatique à usage unique, qui peuvent ensuite être utilisés pour traiter des achats et des crédits autonomes par l’intermédiaire de l’API Prélèvement automatique ou en utilisant Paysafe Checkout.
Vous pouvez également utiliser les jetons de prélèvement automatique à usage unique pour d’autres requêtes dans l’API Coffre-fort client, comme la création de profils et de comptes bancaires.
Vous devez générer un nouveau jeton à usage unique pour chaque requête API de prélèvement automatique ou de coffre-fort client que vous souhaitez traiter. Les jetons à usage unique ne sont valides que 15 minutes.
L’exemple ci-dessous montre comment créer un jeton ACH à usage unique. Dans la réponse, vous trouverez une valeur paymentToken à joindre à votre achat par prélèvement automatique ou crédit autonome, ou à vos requêtes Paysafe Checkout.
Pour créer un jeton TEF à usage unique au lieu d’un jeton ACH à usage unique :
- Envoyez la requête au point de terminaison eftsingleusetokens
- Remplacez l’objet achBankAccount par un objet teftBankAccount comme suit :
"eftBankAccount": {
"accountNumber": "5002205",
"accountHolderName": "R. Smith",
"transitNumber": "20250",
"institutionId": "001"
}
Voire notre rubrique Référence API complète pour une description intégrale des paramètres requis.
Avant d’essayer l’exemple ci-dessus, vous devez :
- Remplacez la clé API (après le u) par votre clé API pour jetons à usage unique.
curl -X POST https://api.test.paysafe.com/customervault/v1/achsingleusetokens \
-u OT1625:B-qa2-0-53625f86-302c021476f52bdc9deab7aea876bb28762e62f92fc6712d0214736abf501e9675e55940e83ef77f5c304edc7968 \
-H ’Content-Type: application/json’ \
-d '{
"profile": {
"firstName": "John",
"lastName": "Smith",
"dateOfBirth": {
"year": 1981,
"month": 10,
"day": 24
},
"email": "john.smith@email.com"
},
"achBankAccount": {
"accountNumber": "50557600",
"accountHolderName": "R. Dodson",
"routingNumber": "123456789",
"accountType": "CHECKING"
},
"billingAddress": {
"nickName": "Home",
"street": "100 Queen",
"street2": "Unit 201",
"city": "Toronto",
"zip": "M5H 2N2",
"country": "CA",
"state": "ON"
}
}'
| Valeur | Requis? | Type | Description |
|---|---|---|---|
| profile | object | Il s’agit d’informations facultatives sur le client. | |
| achBankAccount | Oui | object | Il s’agit des coordonnées du compte bancaire, y compris le numéro de compte et le numéro d’acheminement. |
| billingAddress | Oui | object | Il s’agit de l’adresse de facturation du client, y compris la rue, la ville et le pays. |
{
"id": "a02e52c7-c991-4418-966a-b62989cb0eae",
"paymentToken": "SAec6TpEoNVQpbSM",
"timeToLiveSeconds": 899,
"profile": {
"firstName": "John",
"lastName": "Smith",
"dateOfBirth": {
"year": 1981,
"month": 10,
"day": 24
},
"email": "john.smith@email.com"
},
"billingAddress": {
"nickName": "Home",
"street": "100 Queen",
"street2": "Unit 201",
"city": "Toronto",
"zip": "M5H 2N2",
"country": "CA",
"state": "ON"
},
"achBankAccount": {
"accountNumber": "50557600",
"accountHolderName": "R. Dodson",
"routingNumber": "123456789",
"accountType": "CHECKING"
}
}
La réponse contient le paymentToken et une valeur timeToLiveSeconds qui indique le nombre de secondes restantes pour ce jeton de paiement. Les jetons à usage unique durent 15 minutes.
| Valeur | Type | Description |
|---|---|---|
| Id | string | Il s’agit de l’identifiant de la requête. |
| paymentToken | string | Il s’agit du jeton de paiement à usage unique qui représente le compte bancaire ACH et qui sera utilisé pour la requête d’achat/crédit autonome. |
| timeToLiveSeconds | integer | Il s’agit de la durée de validité du jeton à usage unique avant son expiration, en secondes. |
| profile | object | Il s’agit d’informations facultatives sur le client. |
| billingAddress | object | Il s’agit de l’adresse de facturation du client. |
| achBankAccount | object | Il s’agit des données du compte bancaire. |