Recherche d’une vérification de compte bancaire
GET /bankaccountvalidator/v1/accounts/account_id/verifications/verification_id
Une demande de vérification de compte bancaire permet aux marchands de récupérer un jeton de paiement à usage unique qui représente le compte bancaire du client, après que ce dernier a validé qu’il est titulaire de ce compte. Ce jeton de paiement est valide pendant 15 minutes et peut être utilisé pour plusieurs types de requêtes dans les API Paysafe, notamment :
- Traiter un crédit autonome dans l’API de prélèvement automatique pour compléter la demande d’encaissement du client sur son compte bancaire (un compte bancaire TEF dans l’exemple ci-dessous)
- Créer un jeton de paiement permanent dans l’API coffre-fort client que vous pouvez ensuite utiliser de manière répétée pour traiter les requêtes dans l’API de prélèvement automatique
Pour traiter une demande de vérification de compte bancaire, vous devez initier une requête GET au point de terminaison des vérifications.
Voir notre documentation complète d’API pour une description complète des paramètres requis pour la demande de recherche de la vérification du compte bancaire.
curl -X GET https://api.test.paysafe.com/bankaccountvalidator/v1/accounts/123456789/verifications/6a275b7c-6f11-4ed1-ae77-21071724574a \
-u devcentre322:B-qa2-0-53625f86-302c021476f52bdc9deab7aea876bb28762e62f92fc6712d0214736abf501e9675e55940e83ef77f5c304edc7968 \
-H ’Content-Type: application/json’
Avant d’essayer l’exemple, vous devez :
- Remplacez le numéro de compte (123456789) dans l’URL par le numéro de compte test que vous avez reçu.
- Remplacez l’identifiant de vérification (6a275b7c-6f11-4ed1-ae77-21071724574a) par l’identifiant que vous avez reçu en réponse à la demande de vérification du compte bancaire.
- Remplacer la clé API (après le -u) par la clé API que vous avez reçue.
{
"merchantRefNum": "1323563",
"accountTypes": [
"SAVING",
"CHEQUING"
],
"currencyCodes": [
"CAD",
"USD"
],
"returnLinks": [
{
"rel": "default",
"href": "https://mysite.com/return"
}
],
"links": [
{
"rel": "redirect_bank_validation",
"href": "https://api.paysafe.com/bankaccountvalidator/v1/verifications/6a275b7c-6f11-4ed1-ae77-21071724574a/redirect"
}
],
"id": "6a275b7c-6f11-4ed1-ae77-21071724574a",
"sessionId": "MmM2OGNiNWMtMWNmYS0xMWU5LWFiMTQtZDY2M2JkODczZDkz",
"status": "SUCCESS",
"eft": {
"accountHolderName": "John Smith",
"institutionId": "001",
"transitNumber": "25039",
"lastDigits": "01",
"accountType": "SAVING",
"paymentToken": "8Y9u7WR3E32EB09J"
},
"profile": {
"firstName":"John",
"middleName": "James",
"lastName" : "Smith",
"locale": "en_CA"
}
}
La réponse comporte les paramètres suivants :
| Élément | Élément enfant | Type | Description |
|---|---|---|---|
| merchantRefNum | string | Il s’agit du numéro de référence du marchand, créé par ce dernier, et soumis dans le cadre de la requête. Un numéro de référence unique du marchand doit être fourni pour chaque transaction. | |
| accountTypes | array | Voici la liste des types de comptes bancaires qui seront présentés. Les valeurs éventuelles sont :
| |
| currencyCodes | array | Il s’agit de la devise des comptes bancaires qui seront présentés. Les valeurs éventuelles sont :
| |
| returnLinksreturnLinks | ensemble d’objets | Il s’agit de points de terminaison URL vers lesquels rediriger le client. Vous pouvez personnaliser l’URL de retour en fonction de l’état de la transaction. La valeur default est obligatoire. | |
| rel | enum | Il s’agit du type de lien, qui permet de cibler différents points de terminaison en fonction de l’état final de la transaction. La relation de lien décrit comment ce lien est lié à l’appel précédent. Les valeurs éventuelles sont :
| |
| href | string | L’URL vers laquelle le client sera redirigé. | |
| links | object | Il s’agit d’un ensemble de liens liés à la ressource. | |
| rel | string | Il s’agit du lien vers le point de terminaison à la fin de la transaction. Les valeurs éventuelles sont :
| |
| href | string | L’URL vers laquelle le client sera redirigé. | |
| Id | string length<=36 | Identifiant unique pour cette opération de vérification du compte bancaire. | |
| sessionId | string length<=36 | Identifiant de session unique pour cette opération. | |
| status | enum | Il s’agit de l’état de la requête. Les valeurs éventuelles sont :
| |
| tef | object | ||
| accountHolderName | string length<=30 | Il s’agit du nom du titulaire du compte. | |
| institutionId | string length=3 | Il s’agit du numéro d’institution à 3 chiffres de la succursale bancaire du client. | |
| transitNumber | string length=5 | Il s’agit du numéro de transit à 5 chiffres de la succursale bancaire du client. | |
| lastDigits | string length=2 | Il s’agit des deux derniers chiffres du numéro de compte bancaire. | |
| accountType | enum | Il s’agit du type de compte bancaire. Les valeurs éventuelles sont :
| |
| paymentToken | string length<=50 | Il s’agit du jeton à usage unique représentant le compte bancaire. Il est valide pendant 15 minutes, après quoi il expire. | |
| profile | object | Il s’agit d’informations sur le profil du client. | |
| firstName | string length<=80 | Il s’agit du prénom du client. | |
| middleName | string length<=80 | Il s’agit du deuxième prénom du client. | |
| lastName | string length<=80 | Il s’agit du nom de famille du client. | |
| locale | enum | Indique la langue de l’interface utilisateur. Les valeurs possibles sont les suivantes :
|