Créer une vérification de compte bancaire
POST /bankaccountvalidator/v1/accounts/account_id/verifications
Une demande de vérification de compte bancaire permet aux marchands de demander la vérification d’un compte bancaire en envoyant des informations sur le client à Paysafe, ainsi que quelques autres paramètres. La réponse à la requête POST contiendra une URL de redirection qui permettra au client de sélectionner une banque et de vérifier qu’il possède bien le(s) compte(s) bancaire(s).
Pour procéder à la vérification d’un compte bancaire, vous devez initier une requête POST au point de terminaison des vérifications.
Voir notre documentation complète d’API pour une description intégrale des paramètres requis pour la demande de paiement.
curl -X https://api.test.paysafe.com/bankaccountvalidator/v1/accounts/123456789/verifications \
-u devcentre322:B-qa2-0-53625f86-302c021476f52bdc9deab7aea876bb28762e62f92fc6712d0214736abf501e9675e55940e83ef77f5c304edc7968 \
-H ’Content-Type: application/json’ \
-d ’{
"merchantRefNum": "1323563",
"profile": {
"firstName":"John",
"middleName": "James",
"lastName" : "Smith",
"locale": "en_CA"
},
"accountTypes": [
"SAVING",
"CHEQUING"
],
"currencyCodes": [
"CAD",
"USD"
],
"returnLinks": [
{
"rel": "default",
"href": "https://mysite.com/return"
}
],
"bankscheme": "EFT"
}’
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.
- Remplacer la clé API (après le -u) par la clé API que vous avez reçue.
- Fournir un numéro de référence unique pour chaque transaction.
La requête contient les paramètres suivants :
| Élément | Élément enfant | Type | Requis? | Description |
|---|---|---|---|---|
| merchantRefNum | string | Oui | 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. | |
| profile | object | Oui | Il s’agit d’informations sur le profil du client. | |
| firstName | string length<=80 | Oui | Il s’agit du prénom du client. | |
| middleName | string length<=80 | Non | Il s’agit du deuxième prénom du client. | |
| lastName | string length<=80 | Oui | Il s’agit du nom de famille du client. | |
| locale | enum | Non | Indique la langue de l’interface utilisateur. Les valeurs possibles sont les suivantes :
| |
| accountTypes | array | Non | Voici la liste des types de comptes bancaires qui seront présentés. Les valeurs éventuelles sont :
Si ce paramètre n’est pas inclus, la réponse par défaut renverra les comptes d’épargne/de chèques admissibles aux TEF. | |
| currencyCodes | array | Non | Il s’agit de la devise des comptes bancaires qui seront présentés. Les valeurs éventuelles sont :
Si ce paramètre n’est pas inclus, la réponse par défaut renverra les comptes en devise CAD/USD. | |
| returnLinksreturnLinks | ensemble d’objets | Oui | 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 par défaut est obligatoire. | |
| rel | enum | Oui | 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 | Oui | L’URL vers laquelle le client sera redirigé. | |
| bankScheme | enum | Oui | Il s’agit du système bancaire pour lequel le marchand souhaite valider le compte. Les valeurs éventuelles sont :
|
{
"merchantRefNum": "1323563",
"profile": {
"firstName":"John",
"middleName": "James",
"lastName" : "Smith",
"locale": "en_CA"
},
"accountTypes": [
"SAVING",
"CHEQUING"
],
"currencyCodes": [
"CAD",
"USD"
],
"returnLinks": [
{
"rel": "default",
"href": "https://mysite.com/return"
}
],
"bankscheme": "ACH",
"id": "6a275b7c-6f11-4ed1-ae77-21071724574a",
"sessionId": "MjM5NWRlMTQtNDE4Yy0xMWU5LWIyMTAtZDY2M2JkODczZDkz",
"status": "INITIATED",
"links": [
{
"rel": "redirect_bank_validation",
"href": "https://api.paysafe.com/bankaccountvalidator/v1/redirect?sessionId=MjM5NWRlMTQtNDE4Yy0xMWU5LWIyMTAtZDY2M2JkODczZDkz"
}
]
}
Les paramètres de réponse non contenus dans la requête sont décrits ci-dessous :
| Élément | Élément enfant | Type | Description |
|---|---|---|---|
| Id | string length<=36 | Identifiant unique pour cette opération de vérification du compte bancaire. Cet identifiant peut être utilisé pour rechercher la vérification ultérieurement. | |
| sessionId | string length<=36 | Identifiant de session unique pour cette opération. Cet identifiant de session est utilisé dans l’URL de redirection pour que le client puisse valider son compte bancaire. | |
| status | enum | Il s’agit de l’état de la requête. Les valeurs éventuelles sont :
| |
| 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é. |