Appels API typiques

Créer une vérification

L’API Créer une vérification lance une session chez Paysafe pour la vérification de l’identité du client et répond par une URL de redirection.

Cliquez sur Créer une vérification pour consulter la documentation de l’API et apprendre comment envoyer une demande de vérification de l’identité de l’utilisateur à Paysafe.

POST/bankaccountvalidator/v1/verifiedme/accounts/{account_id}/verifications

Paramètre de requête	Description	Type	Obligatoire	Exemple de valeurs
accountId	Il s’agit du numéro de compte marchand.	Chaîne	Oui	123456789
merchantRefNum	Numéro de référence unique pour identifier les transactions en double	Chaîne	Oui	123456677
returnLinksreturnLinks	Le point d’extrémité de l’URL vers lequel rediriger le consommateur. Vous pouvez personnaliser l’URL de retour en fonction de l’état de la transaction. La valeur ‘default’ est obligatoire. Options : default : l’URL de retour par défaut qui sera utilisée si l’URL de retour d’un état spécifique n’est pas définie on_completed : sera utilisé en cas de validation réussie du compte bancaire on_failed : sera utilisé en cas d’échec de la validation du compte bancaire	Tableau	Oui	"returnLinks": [ { "rel": "default", "href": "https://mysite.com/return" }, { "rel": "on_completed", "href": "https://mysite.com/receipt" }, { "rel": " on_failed ", "href": "https://mysite.com/error" } ]
metadata	Les informations transmises dans ce champ dans la requête seront exactement comme dans la réponse	JSON Object	No	"metadata": { "customerId": "879389846335" }
locale	Sert à identifier la langue locale et à présenter l’interface utilisateur dans la langue souhaitée. Si la langue locale choisie n’est pas disponible, la valeur par défaut sera en_CA.	Chaîne (énum)	No	en_CA

Exemple de requête

{



  "merchantRefNum": "1323563",

  "accountId": "PMLE100",

  "locale": "en_CA"

  "returnLinks": [

    {

      "rel": "default",

      "href": "https://mysite.com/return"

    }

  ],

  "metadata": {

    "customerId": "879389846335"

  }



}

Information sur la langue locale

№	Langue locale à transmettre dans la requête	Nom
1	en_CA	English (Canada)
2	fr_CA	Français (Canada)

D’autres informations sur la langue locale sont disponibles sur demande.

Exemple de réponse

{



  "merchantRefNum": "1323563",

  "returnLinks": [

    {

      "rel": "default",

      "href": "https://mysite.com/return"

    }

  ],

  "id": "6a275b7c-6f11-4ed1-ae77-21071724574a",

  "sessionId": "MjM5NWRlMTQtNDE4Yy0xMWU5LWIyMTAtZDY2M2JkODczZDkz",

  "status": "INITIATED",

  "links": [

    {

      "rel": "redirect_bank_validation",

      "href": "https://api.paysafe.com/bankaccountvalidator/v1/verifiedme/redirect?sessionId=MjM5NWRlMTQtNDE4Yy0xMWU5LWIyMTAtZDY2M2JkODczZDkz"

    }

  ],

  "metadata": {

    "customerId": "879389846335"

  }



}

Paramètre de réponse	Description	Type	Obligatoire	Exemple de valeurs
merchantRefNum	Il s’agit du même numéro de référence marchand que celui renvoyé par la requête	Chaîne	Oui	123456789
returnLinksreturnLinks	Il s’agit des mêmes liens de renvoi renvoyés par la requête.	Tableau	oui	"returnLinks": [ { "rel": "default", "href": "https://mysite.com/return" }, { "rel": "on_completed", "href": "https://mysite.com/receipt" }, { "rel": " on_failed ", "href": "https://mysite.com/error" } ]
id	Id de vérification pour cette transaction et à utiliser pour obtenir les informations du client par le biais d’un appel de recherche.	Chaîne	Oui	6a275b7c-6f11-4ed1-ae77-21071724574a
sessionId	Id de session pour l’ensemble du flux	Chaîne	Oui	MjM5NWRlMTQtNDE4Yy0xMWU5LWIyMTAtZDY2M2JkODczZDkz
status	État de la transaction	Chaîne	Oui	INITIATED
links	Pour naviguer vers l’interface utilisateur du vendeur où se trouvent les services bancaires en ligne	Tableau	Oui	"links": [ { "rel": "redirect_bank_validation", "href": "https://api.paysafe.com/bankaccountvalidator/v1/verifiedme/redirect?sessionId=MjM5NWRlMTQtNDE4Yy0xMWU5LWIyMTAtZDY2M2JkODczZDkz" } ]
metadata		JSON Object	non	"metadata": { "customerId": "879389846335" }

Rediriger le client

GET /bankaccountvalidator/v1/redirect?sessionId={sessionId}

Cliquez sur Rediriger le client pour consulter la documentation de l’API et apprendre à rediriger un client afin qu’il puisse valider ses coordonnées bancaires.

Remarque : Comme il s’agit d’une demande de redirection, il n’y a pas de réponse synchrone possible.

Paramètre de réponse	Description	Type	Obligatoire	Exemple de valeurs
sessionId	SessionId fourni dans la réponse de vérification de la création	Chaîne	Oui	MmM2OGNiNWMtMWNmYS0xMWU5LWFiMTQtZDY2M2JkODczZDkz

Recherche des informations sur l’utilisateur

GET/bankaccountvalidator/v1/verifiedme/verifications/{verificationId}

L’API Paysafe Recherche des informations sur l’utilisateur de l’API Vérification d’identité permet à un marchand de récupérer les informations utilisateur du compte bancaire d’un client en l’invitant à saisir ses identifiants bancaires en ligne via une interface utilisateur présentée par Interac. Une fois que le client a vérifié qu’il est titulaire du compte bancaire, le marchand peut alors rechercher les informations relatives à l’utilisateur correspondant.

Paramètre de requête	Description	Type	Obligatoire	Exemple de valeurs
sessionId	Id fourni dans la création de la réponse de vérification	Chaîne	Oui	6a275b7c-6f11-4ed1-ae77-21071724574a

Exemple de requête :/bankaccountvalidator/v1/verifiedme/verifications/6a275b7c-6f11-4ed1-ae77-21071724574a

Paramètre de réponse	Description	Type	Obligatoire	Exemple de valeurs
addresses	Il s’agit de l’adresse de la personne. Voir la section Fichiers d’adresses	Tableau	oui	"addresses": [ { "country": "CA", "streetAddress": "676 RUE FOURNIER", "addressType": "CA", "locality": "SLLE", "postalCode": "J7E 3K9", "region": "QC" } ]
birthdate	Il s’agit de la date de naissance du client	Chaîne	Oui	8/1/1933
singleSource	Indique si le produit à source unique a été utilisé.	boolean	oui	TRUE
dualSource	Indique si le produit à double source a été utilisé.	boolean	oui	FALSE
singleSourceDecision	Il s’agit du résultat du modèle de décision pour le produit à source unique.	boolean	oui	TRUE
dualSourceDecision	Il s’agit du résultat du modèle de décision pour le produit à double source.	boolean	oui	FALSE
uniqueNumber	Il s’agit du numéro de dossier de crédit reçu du fournisseur en aval.	Chaîne	oui	59465419
givenName	Il s’agit du nom donné, récupéré à partir de la sortie verifiedme.	Chaîne	oui	ISABELLE
familyName	Il s’agit du nom de famille extrait de la sortie verifiedme.	Chaîne	oui	CORREIA
ageOfCreditFile3yMoreOlder	Indique si le dossier de crédit date de plus de trois ans.	boolean	oui	TRUE
decision	hyperlien vers la matrice de décision globale	Chaîne	oui	SUCCESS
tradelines	hyperlien vers tradeLines	object	oui	[ { "addressProvinceMatch": "YES", "middleNameMatch": "NOT PROVIDED","NOT PROVIDED", "addressPostalCodeMatch": "YES", "lastNameMatch": "YES", "firstNameMatch": "YES", "addressAsReported": "676,RUE FOURNIER,ST-THER-BLAIN,QC,J7E3K9", "suffixNameMatch": "NOT PROVIDED","NOT PROVIDED", "dateOfBirthMatch": "YES", "addressCityMatch": "YES", "dobAsReported": "1933-08-01", "addressStreetNameMatch": "YES", "nameAsReported": "CORREIA,ISABELLE,C,", "addressCivicMatch": "YES" } ]

Champs d’adresse

Élément	Type	Description
country	Chaîne	country code
streetAddress	Chaîne	Adresse postale au format canadien standard
addressType	Chaîne	Type d’adresse
locality	Chaîne	Emplacement de cette adresse.
postalCode	Chaîne	Code zip ou postal de l’adresse
region	Chaîne	Région de cette adresse

tradeLines

Élément	Type	Valeurs éventuelles	Description
addressProvinceMatch	Chaîne	YES/NO/NOT PROVIDED (OUI/NON/NON FOURNI)	Indique si la province de l’adresse concorde.
middleNameMatch	Chaîne	YES/NO/NOT PROVIDED (OUI/NON/NON FOURNI)	Indique si le deuxième prénom concorde.
addressPostalCodeMatch	Chaîne	YES/NO/NOT PROVIDED (OUI/NON/NON FOURNI)	Indique si le code postal/zip de l’adresse concorde.
lastNameMatch	Chaîne	YES/NO/NOT PROVIDED (OUI/NON/NON FOURNI)	Indique si le nom de famille concorde.
firstNameMatch	Chaîne	YES/NO/NOT PROVIDED (OUI/NON/NON FOURNI)	Indique si le prénom concorde.
addressAsReported	Chaîne		Il s’agit de l’adresse extraite de la sortie du fournisseur en aval.
suffixNameMatch	Chaîne	YES/NO/NOT PROVIDED (OUI/NON/NON FOURNI)	Indique si le nom du suffixe concorde.
dateOfBirthMatch	Chaîne	YES/NO/NOT PROVIDED (OUI/NON/NON FOURNI)	Indique si la date de naissance concorde.
addressCityMatch	Chaîne	YES/NO/NOT PROVIDED (OUI/NON/NON FOURNI)	Indique si la ville de l’adresse concorde.
dobAsReported	Chaîne		Il s’agit de la date de naissance extraite de la sortie du fournisseur en aval.
addressStreetNameMatch	Chaîne	YES/NO/NOT PROVIDED (OUI/NON/NON FOURNI)	Indique si le nom de la rue de l’adresse concorde.
nameAsReported	Chaîne		Il s’agit du nom extrait de la sortie du fournisseur en aval.
addressCivicMatch	Chaîne	YES/NO/NOT PROVIDED (OUI/NON/NON FOURNI)	Indique si le numéro municipal de l’adresse concorde.

Matrice de décision globale

Source unique	Décision de source unique	Double source	Décision à double source	État final
Dossier de crédit trouvé	Échec	Informations commerciales trouvées	Échec	ÉCHEC
Dossier de crédit trouvé	Échec	Informations commerciales trouvées	Succès	SUCCESS
Dossier de crédit trouvé	Succès	Informations commerciales introuvables	Échec	SUCCESS
Dossier de crédit introuvable	Échec	Informations commerciales trouvées	Échec	ÉCHEC
Dossier de crédit introuvable	Échec	Informations commerciales trouvées	Succès	SUCCESS
Dossier de crédit introuvable	Échec	Informations commerciales introuvables	Échec	ÉCHEC

Cette page a-t-elle été utile ?

Sur cette page

Créer une vérification
Information sur la langue locale
Rediriger le client
Recherche des informations sur l’utilisateur

Search Overlay

Appels API typiques

Cette page a-t-elle été utile ?

Merci pour votre réponse!