Upload
others
View
1
Download
0
Embed Size (px)
Citation preview
Guide de référence de l ’API pour les Services Web
mai 2019
Version 1.0
Le présent manuel et le support électronique qui l’accompagne sont des produits exclusifs de Paysafe Holdings UK Limited. Leur us-age est réservé aux utilisateurs autorisés du produit.
© 1999-2018 Paysafe Holdings UK Limited. Tous droits réservés.
Les renseignements que contient le présent document sont susceptibles d’être modifiés sans préavis. Le logiciel décrit dans le présent document est fourni sous licence et ne peut être utilisé ou copié que conformément aux conditions du contrat de licence. Aucune par-tie du présent manuel ne peut être reproduite ni transférée sous quelque forme que ce soit ou par quelque moyen que ce soit sans le consentement écrit explicite de Paysafe Holdings UK Limited.
Les autres noms, marques de commerce, et marques déposées appartiennent à leur propriétaire respectif.
Paysafe Holdings UK Limited n’offre aucune garantie explicite ou implicite concernant ce produit, sa qualité marchande, ou son adéquation à un usage particulier autre que les garanties explicitement décrites dans le contrat de licence du produit. Pour obtenir de plus amples renseignements à ce sujet, veuillez communiquer avec Paysafe Holdings UK Limited – www.paysafe.com
Table des matières
1 Services Web de PaysafeQue sont les Services Web de Paysafe? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
Les Services Web sont compatibles avec les prélèvements automatiques . . . . . . . . . . . . . . . . . . . . . 1-1Les Services Web sont compatibles avec les cartes de crédit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2Les Services Web sont compatibles avec le service de consultation des données . . . . . . . . . . . . . . 1-3
Exigences système . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3Accéder aux WSDL et aux liens Paysafe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4
Prélèvement automatique . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4Carte de crédit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4Service de consultation des données . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4
Tests des Services Web de Paysafe. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4Caractéristiques de sécurité . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5
AVS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5CVD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6Base de données des éléments négatifs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-63D Secure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-7
Utilisation du présent guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-7Cible. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-7Fonctionnalités . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-7Symboles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-7
2 Transactions par prélèvement automatique (débit direct)Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1Exemple – .NET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2Bâtir des requêtes de facturation ou de crédit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4
Exemple de facturation – C# . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4Diagramme de transaction ddCheckRequestV1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-6Éléments de transaction ddCheckRequestV1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-7
Considérations spéciales relatives aux éléments de prélèvement automatique. . . . . . . . . . . . 2-13Création de requêtes updateShippingInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-14
Exemple de transaction updateShippingInfo – C#. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-14Diagramme de transaction ddShippingRequestV1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-16Éléments de transaction ddShippingRequestV1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-16
Création de lookupRequest (requêtes de consultation) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-18Exemple de transaction lookupRequest – C# . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-18Diagramme de transaction ddLookupRequestV1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-20Éléments de transaction ddLookupRequestV1. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-20
Création de mandateRequest pour BACS (requêtes de mandat) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-22
Guide de référence de l’API pour les Services Web 1.0 III
mai 2019
Création de mandateRequest pour SEPA (requêtes de mandat) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-22Exemple de transaction mandateRequest – C#. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-23Diagramme de transaction ddMandateRequestV1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-24Éléments de transaction ddMandateRequestV1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-25
Création de changeStatusRequest (requêtes de modification d’état) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-28Exemple de transaction changeStatusRequest – C# . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-28Diagramme de transaction ddChangeStatusRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-29Éléments de transaction ddChangeStatusRequestV1. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-29
Création de updateMandateRequest (mise à jour du mandat) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-30Exemple de transaction updateMandateRequest – C# . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-31Diagramme de transaction ddUpdateMandateRequestV1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-31Éléments de transaction ddUpdateMandateRequestV1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-32
Traitement de la réponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-33
3 Transactions par carte de crédit ou de débitIntroduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1.Exemple – .NET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3Bâtir des requêtes d’achat, d’autorisation ou de vérification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-4
Exemple de transaction d’achat – C#. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-5Diagramme de transaction ccAuthRequestV1. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-7Éléments de transaction ccAuthRequestV1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-8Paires étiquette/valeur addendumData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-19
Bâtir des requêtes d’inversion d’autorisation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-20Exemple d’une transaction d’inversion d’autorisation – C# . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-20Diagramme de transaction ccAuthReversalRequestV1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-21Éléments de transaction ccAuthReversalRequestV1. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-22
Bâtir des requêtes de règlement et de crédit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-23Exemple de règlement – C#. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-23Diagramme de transaction ccPostAuthRequestV1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-25Éléments de transaction ccPostAuthRequestV1. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-25
Bâtir des requêtes de données mémorisées . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-27Exemple d’autorisation à partir de données mémorisées – C# . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-27Diagramme de transaction ccStoredDataRequestV1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-29Éléments de transaction ccStoredDataRequestV1. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-29
Bâtir des requêtes d’annulation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-31Exemple d’annulation de règlement – C# . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-31Diagramme de transaction ccCancelRequestV1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-32Éléments de transaction ccCancelRequestV1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-33
Bâtir des requêtes de paiement/crédit indépendant. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-34Exemple de paiement – C# . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-34Diagramme de transaction ccPaymentRequestV1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-36Éléments de transaction ccPaymentRequestV1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-36
Bâtir des requêtes de consultation des données. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-39Exemple de consultation des données – C# . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-40Diagramme de transaction ccTxnLookupRequestV1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-41
IV
mai 2019
Éléments de transaction ccTxnLookupRequestV1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-41Bâtir des requêtes de consultation d’inscription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-43
Exemple de consultation d’inscription – C#. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-43Diagramme de transaction ccEnrollmentLookupRequestV1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-45Éléments de transaction ccEnrollmentLookupRequestV1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-45
Bâtir des requêtes d’authentification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-46Exemple d’authentification – C# . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-46Diagramme de transaction ccAuthenticateRequestV1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-47Éléments de transaction ccAuthenticateRequestV1. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-48
Traitement de la réponse. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-49Paires étiquette/valeur detail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-56Paires étiquette/valeur pour addendumResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-57Codes de devises . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-57
4 Transactions du service de consultation des donnéesIntroduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1
WSDL et liens ILS Paysafe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1Exemple .NET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2Bâtir des requêtes ILS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3
ILS – C# . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3Diagramme de transaction ilsLookupRequestV1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5Éléments de transaction ilsLookupRequestV1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5
Traitement de la réponse. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-7Diagramme de transaction ilsLookupResponseV1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-9Contenu de l’élément de réponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-11
Détails dans la réponse aux requêtes d’autorisation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-12Détails dans la réponse aux requêtes de règlement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-12Détails dans la réponse aux requêtes de crédit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-13Détails dans la réponse aux requêtes de rétrofacturation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-13Détails dans la réponse aux requêtes de prélèvement automatique (débit direct) . . . . . . . . . 4-14
Codes de motif . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-15Codes de motifs de rétrofacturation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-15Codes de motif de requête de récupération. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-17Codes de motifs de rétrofacturation et de requête de récupération pour Discover . . . . . . . . . . . . . 4-17
A Utilisation de la méthode HTTP PostIntroduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1Requêtes relatives à un prélèvement automatique . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1
facturation/crédit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1Exemple HTML – Facturation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-2
updateShippingInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-4Exemple HTML – updateShippingInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-4
ddLookupRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-5Exemple HTML – lookupRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-6
Guide de référence de l’API pour les Services Web 1.0 V
mai 2019
ddMandateRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-7Exemple HTML – mandateRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-8
changeStatusRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-9Exemple HTML – changeStatusRequest. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-10
updateMandateRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-10Exemple HTML – updateMandateRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-11
Requêtes relatives à une carte de crédit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-12Achat, autorisation et vérification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-12
Exemple HTML – Autorisation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-13Inversion d’autorisation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-15
Exemple HTML – Inversion d’autorisation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-16Règlement et crédit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-17
Exemple HTML – Règlement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-17Autorisation ou achat à partir de données mémorisées . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-18
Exemple HTML – Autorisation à partir de données mémorisées . . . . . . . . . . . . . . . . . . . . . . . . . . . A-19Annuler un règlement, un crédit, un paiement, ou un crédit indépendant. . . . . . . . . . . . . . . . . . . . . . A-20
Exemple HTML – Annuler. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-21Requête de paiement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-22
Exemple HTML – Paiement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-23Consultation des données. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-24
Exemple HTML – Consultation des données . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-25Consultation d’inscription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-26
Exemple HTML – Consultation d’inscription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-26Authentification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-27
Exemple HTML – Authentification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-28Requêtes relatives au service de consultation des données . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-29
Exemple HTML – ILS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-30HTTP Post – Exemples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-31
HTTP Post – Réponses aux requêtes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-31
B Codes de réponseAperçu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-1
Codes de réponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-1Codes d’action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-23Codes de refus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-23
C Codes géographiquesCodes de province . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-1Codes d’état. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-2Codes de pays. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-3
VI
CHAPTER 1
Services Web de Paysafe
Que sont les Services Web de Paysafe?Les Services Web reposent sur une technologie permettant aux applications de communiquer entre elles d’une manière indépendante des plateformes et des langages de programmation. Un Service Web est une interface de logiciel qui décrit une collection d’opérations auxquelles on peut accéder sur le réseau à l’aide de messages XML uniformisés. Il utilise des protocoles écrits en langage XML pour décrire une opération à exécuter ou des données à échanger avec un autre Service Web. Les Services Web sont bâtis selon des normes ouvertes comme SOAP et WSDL.
Les Services Web de Paysafe offrent les avantages suivants :
• Les marchands peuvent s’intégrer facilement à l’API des Services Web, en se servant de leur plate-forme et de leur langage préférés.
• Les marchands peuvent automatiser les opérations afin d’éviter de saisir les renseignements manuellement à l’aide de la page Web de Paysafe.
• Les marchands peuvent fonctionner indépendamment des modifications et des mises à jour faites sur le site Web de Paysafe.
Les Services Web sont compatibles avec les prélèvements automatiquesPaysafe prend actuellement en charge les Services Web suivants en ce qui concerne les prélèvements automatiques :
Tableau 1-1 : Opérations de prélèvement automatique
Opération Description
charge (facturation) Vous permet de transférer des fonds du compte bancaire d’un client vers votre compte de marchand. Cette transaction se fait en temps réel, bien que le réseau bancaire ne transfère les fonds que trois à cinq jours plus tard.
credit (crédit) Vous permet de transférer des fonds de votre compte de marchand directement au compte ban-caire du client. Cette transaction se fait en temps réel, bien que le réseau bancaire ne transfère les fonds que trois à cinq jours plus tard.
updateShippingInfo Vous permet de transmettre l’information d’expédition, y compris le numéro de suivi, lorsque vous avez expédié la marchandise pour laquelle vous avez déjà traité une transaction de factur-ation.
lookupRequest Vous permet de produire un rapport à l’aide de l’API pour une plage de temps que vous précisez, afin de recevoir les données concernant les transactions de charge et de credit par prélèvement automatique qui sont traitées par votre compte de marchand.
mandateRequest Vous permet de créer un mandat pour le compte bancaire d’un client et de le déposer à sa ban-que, afin que vous puissiez transférer des fonds du compte bancaire du client vers votre compte commercial. Le réseau bancaire traite généralement le mandat en cinq jours.
changeStatusRequest Vous permet de changer l’état d’une transaction de facturation, de crédit ou de mandat.
updateMandateRequest Vous permet de mettre à jour les informations contenues dans un mandat existant.
Guide de référence de l’API pour les Services Web 1.0 1-1
Services Web de Paysafe mai 2019
Les Services Web sont compatibles avec les cartes de créditPaysafe prend actuellement en charge les Services Web suivants pour les cartes de crédit :
La disponibilité des types d’opérations par prélèvement automatique est attribuée aux marchands sur une base individuelle, puisque ce ne sont pas toutes les banques des marchands qui acceptent toutes les opérations. Si vous avez des questions, communiquez avec votre gestionnaire de compte.
Tableau 1-2 : Opérations par carte de crédit
Opération Description
Authorization (autorisation)
Vous permet de confirmer qu’une carte de crédit existe et que les fonds sont suffisants pour couvrir un achat, sans toutefois régler les fonds dans votre compte de marchand.
Purchase (achat) Autorise et règle un montant demandé sur une carte de crédit.
Verification (véri-fication)
Vous permet d’exécuter une vérification AVS ou CVD de la carte de crédit, sans imputer un montant sur cette carte.
Authorization Reversal (inver-sion d’autorisa-tion)
Vous permet d’inverser une partie ou la totalité d’une autorisation existante, pourvu qu’aucun règle-ment (complet ou partiel) n’ait été traité à l'égard de cette autorisation. Ce type de transaction ne fonctionne pas pour les transactions d'achat ; cette transaction n’est utilisée que pour les autorisations.
Credit (crédit) Vous permet d’émettre un crédit pour un montant qui a déjà été réglé.
Settlement (règle-ment)
Vous permet de régler le montant d’une autorisation existante, en créditant le montant autorisé de la carte de crédit à votre compte de marchand.
Stored Data Authorization (autorisation à partir de données mémorisées)
Vous permet d’autoriser un montant sur la carte de crédit d’un client à l’aide des données sur le client qui sont mémorisées dans notre base de données. Vous n’avez qu’à fournir le minimum de renseigne-ments, ce qui vous permet de gagner du temps et de réduire les efforts.
Stored Data Purchase (achat à partir de données mémorisées)
Vous permet d’autoriser et de régler un montant sur la carte de crédit d’un client à l’aide de données sur le client qui sont mémorisées dans notre base de données. Vous n’avez qu’à fournir le minimum de ren-seignements, ce qui vous permet de gagner du temps et de réduire les efforts.
Cancel (annula-tion)
Vous permet d’annuler une transaction de crédit, de règlement, de paiement, ou de crédit indépendant. Vous pouvez annuler une de ces transactions pourvu qu’elle soit En attente, ce qui est habituellement le cas avant minuit le jour où la requête est faite. Dans certains cas, vous pouvez trouver des transactions de crédit plus anciennes En attente.
Payment (paie-ment)
Vous permet de créditer un montant sur la carte de crédit d’un client. La transaction de paiement n’est pas liée à une autorisation existante antérieure ; le montant de la transaction n’est donc pas limité de cette manière.
Independent Credit (crédit indépendant)
Vous permet de créditer un montant sur la carte de crédit d’un client. La transaction de crédit indépen-dant n’est pas liée à une autorisation existante antérieure ; le montant de la transaction n’est donc pas limité de cette manière.
Information Lookup (consultation des données)
Vous permet de produire un rapport à l’aide de l’API pour une plage de temps que vous précisez, afin de recevoir les données concernant les transactions traités par un compte de marchand.
Enrollment Lookup (consulta-tion d’inscription)
Vous permet d’établir si la carte de crédit du client est inscrite à notre programme 3D Secure.REMARQUE : Cette opération est prise en charge uniquement pour 3D Secure 1.0.2.
1-2
mai 2019 Les Services Web sont compatibles avec le service de consultation des données
Les Services Web sont compatibles avec le service de consultation desdonnées
Paysafe prend actuellement en charge les Services Web suivants :
Exigences systèmeL’API de SOAP a été testé dans les environnements clients suivants :
Pour obtenir plus de détails :
• J2SE ou J2EE 1.3.1 ou version plus récente (1.4.X recommandée) Sun Microsystems, Inc. http://java.sun.com/downloads/index.html
• Apache Axis 1.4, The Apache Software Foundation http://www.apache.org/dyn/closer.cgi/ws/axis/1_4
• Apache Axis2, 1.2, The Apache Software Foundationhttp://ws.apache.org/axis2/1_2/contents.html
• Microsoft .NET Framework Version 1.1/2.0 Microsoft Corporation http://www.microsoft.com/net
Authentication (authentification)
Vous permet d’envoyer une requête d’authentification afin qu’un titulaire de carte inscrit au programme 3D Secure puisse authentifier sa carte auprès de l’émetteur de la carte avant que vous traitiez une autorisation. REMARQUE : Cette opération est prise en charge uniquement pour 3D Secure 1.0.2.
La disponibilité des types d’opérations pour les cartes de crédit est attribuée aux marchands sur une base individuelle, puisque ce ne sont pas toutes les banques des marchands qui acceptent toutes les opérations. Si vous avez des questions, communiquez avec votre gestionnaire de compte.
Tableau 1-3 : Opération du service de consultation des données
Opération Description
Information Lookup Service (service de consultation des données)
Vous permet de produire un rapport à l’aide de l’API pour une plage de temps que vous pré-cisez, afin de recevoir les données concernant les autorisations, les règlements, les crédits et les rétrofacturations traités par un compte de marchand.
Tableau 1-4 : Environnements clients
Client SOAP Environnement de programmation
Environnement opérationnel
Microsoft .NET 1.1 et 2.0 Frame-work
Microsoft Visual Studio .NET 2003 Microsoft Windows Server 2003 et Windows XP
Apache Axis 1.4 Java (J2SE 1.4.X et versions plus récentes)
Linux et Microsoft Windows XP, Server 2003
Apache Axis 2.0 Java (J2SE 1.4.X et 1.5.X) Linux et Microsoft Windows XP, Server 2003
Tableau 1-2 : Opérations par carte de crédit
Opération Description
Guide de référence de l’API pour les Services Web 1.0 1-3
Services Web de Paysafe mai 2019
Accéder aux WSDL et aux liens Paysafe
Prélèvement automatiqueWSDL :
https://webservices.optimalpayments.com/directdebitWS/DirectDebitService/v1?wsdl
Service Web :
https://webservices.optimalpayments.com/directdebitWS/DirectDebitService/v1
Publication HTTP :
https://webservices.optimalpayments.com/directdebitWS/DirectDebitServlet/v1
Carte de créditWSDL :
https://webservices.optimalpayments.com/creditcardWS/CreditCardService/v1?wsdl
Service Web :
https://webservices.optimalpayments.com/creditcardWS/CreditCardService/v1
Publication HTTP :
https://webservices.optimalpayments.com/creditcardWS/CreditCardServlet/v1
Service de consultation des donnéesWSDL :
https://webservices.optimalpayments.com/ilsWS/IlsService/v1?wsdl
Service Web :
https://webservices.optimalpayments.com/ilsWS/IlsService/v1
Publication HTTP :
https://webservices.optimalpayments.com/ilsWS/IlsServlet/v1
Tests des Services Web de PaysafeAprès avoir terminé la configuration de votre application orientée Services Web, veuillez communiquer avec notre équipe de soutien technique pour obtenir des instructions relatives au test des appels API.
• Courriel : [email protected]
• Téléphone : 1 888 709-8753
Peu importe le client SOAP que vous choisissez, il doit prendre en charge la messagerie de style documents.
1-4
mai 2019 Caractéristiques de sécurité
Caractéristiques de sécurité Dans le cas de certaines transactions (achat, par exemple), Paysafe offre des caractéristiques supplé-mentaires qui permettent au marchand de se prémunir contre l’utilisation frauduleuse des cartes.
• Système de vérification d’adresse (AVS)
• Données de validation des cartes (CVD)
• Base de données des éléments négatifs
• 3D Secure
AVSPaysafe gère les vérifications d’adresse (AVS) lorsque la banque émettrice prend cette caractéristique en charge. Le système AVS vérifie si l’adresse fournie par le client qui se sert d’une carte correspond à l’adresse de facturation associée à cette carte par la banque émettrice. Il est plus difficile de se servir d’une carte de manière frauduleuse puisque pour se servir d’une carte volée, il faut aussi connaître l’adresse de facturation associée à la carte. En outre, si les marchandises doivent être livrées, le march-and peut exiger qu’elles le soient à l’adresse de facturation associée à la carte.
Paysafe configure chaque mode de paiement avec un ensemble acceptable de codes de retour AVS. Si la banque retourne un code qui n’est pas acceptable compte tenu du mode de paiement, la requête est alors rejetée en renvoyant une erreur Échec d’autorisation. Lorsqu’une erreur Échec d’autorisation est retournée en réponse à une requête de transaction et qu’un numéro d’autorisation est inclus dans la réponse, l’échec a été causé par la vérification AVS. Vous pouvez consulter le code AVS retourné pour établir le motif exact pour lequel la vérification AVS a échoué. Paysafe retourne les codes suivants, dans l’élément avsResponse, à l’application du marchand en réponse à la requête de transaction ; les codes A, N et E indiquent un échec AVS :
Tableau 1-5 : Codes AVS
Lettre du code
Explication
A L’adresse correspond, mais le code Zip ne correspond pas.
B La vérification AVS n’a pas été faite pour la transaction internationale. Le format du code postal est invalide ou l'information relative à l'adresse n'a pas été fournie.
E Le système AVS ne prend pas cette industrie en charge.
M Correspondance de l’adresse et du code postal pour les transactions internationales.
N Aucun élément de l’adresse ne correspond.
Q Réponse inconnue de l'émetteur/banknet switch.
R Réessayer. Le système est incapable de faire le traitement.
S L’AVS n’est pas pris en charge.
U L’information sur l’adresse n’est pas disponible.
W Le code Zip de neuf chiffres correspond, mais l’adresse ne correspond pas.
X Exact. Correspondance entre le code Zip de neuf chiffres et l’adresse.
Y Oui. Correspondance entre le code Zip de cinq chiffres et l’adresse.
Z Le code Zip de cinq chiffres correspond, mais l’adresse ne correspond pas.
Guide de référence de l’API pour les Services Web 1.0 1-5
Services Web de Paysafe mai 2019
Lorsque vous vous êtes inscrit à Paysafe, votre compte a été configuré pour faire des vérifications AVS automatiques. Paysafe n’accepte les transactions que si les codes de retour AVS permis sont retournés.
Il existe trois exceptions AVS, ce qui peut avoir un effet sur les décisions que vous prenez à l’égard des vérifications AVS ayant échoué :
• Le système AVS n’est pas toujours fiable. De faux résultats peuvent être retournés si la personne a déménagé, par exemple, ou parce que certaines personnes inscrivent des codes Zip à cinq chiffres tandis que d’autres inscrivent des codes Zip à neuf chiffres.
• Le système AVS offre une prise en charge internationale limitée. Par conséquent, si vous décidez de n’expédier qu’aux adresses qui retournent de bons résultats AVS, vous pourriez exclure par ail-leurs des transactions valides.
• Plusieurs banques émettrices aux États-Unis, mais pas toutes, prennent AVS en charge. Par conséquent, même si vous ne faites des affaires qu’avec des clients américains, vous ne pourrez pas toujours vous fier à la disponibilité du système AVS.
CVDLa valeur CVD est un nombre à trois ou quatre chiffres imprimé sur la carte de crédit, mais qui n’appa-raît pas sur la bande magnétique. Par conséquent, la valeur n’est pas imprimée sur les reçus ou les états de compte, ce qui réduit la possibilité de fraude en se servant de l’information imprimée. La car-actéristique CVD, conçue précisément pour les transactions où une carte n’est pas utilisée, est une exi-gence de Paysafe. Nous prenons en charge la caractéristique CVD partout où les banques émettrices le font.
Lorsqu’un client saisit les renseignements relatifs à sa carte et au titulaire de la carte, la valeur CVD est demandée en même temps. Un indicateur parmi les quatre indicateurs suivants signale l’état d’une requête CVD :
• Not provided (non fournie) – Le client n’a pas fourni la valeur CVD.
• Provided (fournie) – Le client a fourni la valeur CVD. Lorsque cet indicateur est choisi, la valeur CVD est fournie.
• Illegible (illisible) – Le client prétend que la valeur CVD est illisible.
• Not present (absent) – Le client prétend que la valeur CVD n’apparaît pas sur la carte.
Base de données des éléments négatifsPaysafe gère une base de données des éléments négatifs qui offre une protection supplémentaire con-tre la mauvaise utilisation des cartes et les requêtes de transaction inappropriées. Le numéro de la carte ou l'adresse de courriel est entré dans la base de données des éléments négatifs pour les motifs suivants :
• Une rétrofacturation liée au numéro de la carte ou à l’adresse de courriel a été faite.
• Le numéro de la carte, ou l’adresse de courriel, a été utilisé, ou vraisemblablement utilisé, dans le contexte d’une activité frauduleuse.
Votre compte est configuré pour la mise en œuvre automatique de cette caractéristique de sécurité et toutes les requêtes de transactions où on tente de se servir du numéro de la carte ou de l'adresse de courriel se trouvant dans la base de données des éléments négatifs ne seront pas traitées.
1-6
mai 2019 3D Secure
3D SecurePaysafe prend en charge 3D Secure, un programme d’authentification des titulaires de cartes en ligne conçu pour rendre les transactions d’achat sur Internet plus sécuritaires par la confirmation de l’identité du titulaire au moment de l’achat et avant que le marchand soumette la demande d’autorisation. Le pro-gramme est actuellement compatible avec plusieurs types de cartes, notamment Visa (Vérifié par Visa), Mastercard (SecureCode) et American Express (SafeKey). Les autorisations traitées au moyen de 3D Secure sont garanties contre la plupart des types de litiges courants relativement à la rétrofacturation.
Paysafe est conformé à 3DS version 2.1.0.
• Les opérations Enrollment Lookup (consultation d’inscription) et Authentication (authentifica-tion) de cette API prennent en charge uniquement 3D Secure version 1.0.2.
• Les opérations d’Authorization (autorisation) et Purchase (achat) acceptent les champs d’authen-tification de 3D Secure version 2. Voir Bâtir des requêtes d’achat, d’autorisation ou de vérification on page 3-4 pour plus de détails.
• Pour utiliser les champs d’authentification 3D Secure 2, vous devez d’abord intégrer l’API 3D Secure 2 (une API RESTful).
Utilisation du présent guide Le présent guide d’utilisation décrit les fonctions importantes du système. Chaque section contient un aperçu des fonctions, lesquelles sont ensuite détaillées par procédures et selon la marche à suivre.
CibleCe guide d’utilisation s’adresse aux marchands de Paysafe faisant usage de notre API des Services Web afin de traiter des demandes de transactions avec Paysafe.
FonctionnalitésIl se peut que ce guide présente l’explication de certaines caractéristiques auxquelles vous n’avez pas accès. L’accès auxdites fonctionnalités est octroyé aux marchands sur une base individuelle. Si vous avez des questions, communiquez avec votre gestionnaire de compte.
SymbolesCe guide d’utilisation fait appel aux symboles suivants pour mettre en évidence certains élé-ments importants :
Tableau 1-6 : Symboles
Symbole Description
Cette icône remarque précède une astuce ou un conseil pour l’utilisation de l’application de traitement des transactions de manière plus efficace.
Cette icône attention précède un avertissement relatif aux actions pouvant entraîner des conséquences impor-tantes.
Cette icône accès précède un avertissement relatif aux fonctionnalités qui pourraient être disponibles unique-ment pour certaines configurations du marchands.
Guide de référence de l’API pour les Services Web 1.0 1-7
Services Web de Paysafe mai 2019
1-8
CHAPTER 2
Transactions par prélèvementautomatique (débit direct)
IntroductionCe chapitre décrit comment traiter les transactions de prélèvement automatique à l’aide du Service Web de Paysafe. Les opérations suivantes sont prises en charge :
*SEPA = espace unique de paiement en euros
Tableau 2-1 : Opérations prises en charge
Opération Description Pour Type de requête
charge (facturation) Vous permet de transférer des fonds du compte bancaire d’un client vers votre compte de marchand. Cette transaction se fait en temps réel, bien que le réseau bancaire ne transfère les fonds que trois à cinq jours plus tard.
• EFT• ACH• BACS• SEPA*
Consultez la rubrique Bâtir des requêtes de facturation ou de crédit à la page 2-4.credit (crédit) Vous permet de transférer des fonds de votre
compte de marchand directement au compte bancaire du client. Cette transaction se fait en temps réel, bien que le réseau bancaire ne transfère les fonds que trois à cinq jours plus tard.
• EFT• ACH• BACS• SEPA
updateShippingInfo Vous permet de transmettre l’information d’expédition, y compris le numéro de suivi, lor-sque vous avez expédié la marchandise pour laquelle vous avez déjà traité une transaction de facturation.
• EFT• ACH• SEPA
Consultez la rubrique Création de requêtes updateShippingInfo à la page 2-14.
lookupRequest Vous permet de produire un rapport à l’aide de l’API pour une plage de temps que vous préci-sez, afin de recevoir les données concernant les transactions de charge et de credit par prélève-ment automatique qui sont traitées par votre compte de marchand.
• EFT• ACH• BACS• SEPA
Consultez la rubrique Création de lookupRequest (requêtes de con-sultation) à la page 2-18.
mandateRequest Vous permet de créer un mandat pour le compte bancaire d’un client et de le déposer à sa banque, afin que vous puissiez transférer des fonds du compte bancaire du client vers votre compte commercial. Le réseau bancaire traite généralement le mandat en cinq jours.
• BACS• SEPA
Consultez la rubrique Création de mandateRequest pour BACS (requêtes de mandat) à la page 2-22.
changeStatusRequest Vous permet de changer l’état d’une transac-tion de facturation, de crédit ou de mandat.
• EFT• ACH• BACS• SEPA
Consultez la rubrique Création de changeStatusRequest (requêtes de modification d’état) à la page 2-28.
updateMandateRequest Vous permet de mettre à jour les informations contenues dans un mandat existant.
• SEPA Consultez la rubrique Création de updateMandateRequest (mise à jour du mandat) à la page 2-30.
Guide de référence de l’API pour les Services Web 1.0 2-1
Transactions par prélèvement automatique (débit direct) mai 2019
• Les transactions charge et credit acceptent l’objet de document ddCheckRequestV1.
• La transaction updateShippingInfo accepte l’objet de document ddShippingRequestV1.
• La transaction lookup accepte l’objet de document ddLookupRequestV1.
• La transaction mandat accepte l’objet de document ddMandateRequestV1.
• La transaction changeStatus accepte l’objet de document ddChangeStatusRequestV1.
• La transaction updateMandate accepte l’objet de document ddUpdateMandateRequestV1.
• Toutes les opérations retournent une réponse ddCheckResponseV1.
Exemple – .NET
Pour bâtir l’exemple pour .NET :
1. Créez un nouveau projet.
La disponibilité des types d’opérations par prélèvement automatique est attribuée aux marchands sur une base individuelle, puisque ce ne sont pas toutes les banques des marchands qui acceptent toutes les opérations. Si vous avez des questions, communiquez avec votre gestionnaire de compte.
2-2
mai 2019 Exemple – .NET
2. Ajoutez une référence Web.
3. Saisissez l’URL WSDL et cliquez sur le bouton Ajouter une référence.
Le client Web est maintenant créé.
Guide de référence de l’API pour les Services Web 1.0 2-3
Transactions par prélèvement automatique (débit direct) mai 2019
4. Bâtissez la requête de prélèvement automatique et traitez la réponse.
• Consultez la rubrique Bâtir des requêtes de facturation ou de crédit à la page 2-4.
• Consultez la rubrique Création de requêtes updateShippingInfo à la page 2-14.
• Consultez la rubrique Traitement de la réponse à la page 2-33.
Bâtir des requêtes de facturation ou de créditLes requêtes charge et credit requièrent l’objet de document ddCheckRequestV1. La présente rubrique décrit la structure d’une requête ddCheckRequestV1 et la façon de la bâtir. Pour obtenir des détails sur les éléments requis, consultez le Tableau 2-2 : Éléments de transaction ddCheckRequestV1 à la page 2-7.
Exemple de facturation – C#Voici un exemple de transaction charge en C#.
// Prepare the call to the Direct Debit Web ServiceDDCheckRequestV1 ddCheckRequest = new DDCheckRequestV1();ddCheckRequest.amount = "10.00";MerchantAccountV1 merchantAccount = new MerchantAccountV1();merchantAccount.accountNum = "12345678";merchantAccount.storeID = "myStoreID";merchantAccount.storePwd = "myStorePWD";ddCheckRequest.merchantAccount = merchantAccount;CheckV1 check = new CheckV1();check.routingNum = "123456789";check.accountNum = "987654321";check.accountType = BankAccountTypeV1.PC;check.bankName = "Chase";check.checkNum = 12;check.payee = "ACME Inc.";ddCheckRequest.check = check;BillingDetailsV1 billingDetails = new BillingDetailsV1();billingDetails.firstName = "Jane";billingDetails.lastName = "Jones";billingDetails.street = "123 Main Street";billingDetails.city = "LA";billingDetails.country = CountryV1.US;billingDetails.zip = "90210";billingDetails.phone = "555-555-5555";billingDetails.checkPayMethod = CheckPayMethodV1.WEB;ddCheckRequest.billingDetails = billingDetails;//Perform the Web Services call to process the chargeDirectDebitServiceV1 ddService = new DirectDebitServiceV1();DDCheckResponseV1 ddTxnResponse = ddService.charge(ddCheckRequest);
// Print out the resultString responseTxt = ddTxnResponse.code + " - " + ddTxnResponse.decision +
" - " + ddTxnResponse.description;responseTxt += "Details:" + Environment.NewLine;if (ddTxnResponse.detail != null)
Pour convertir cette requête en requête credit, il suffit de remplacer la valeur « charge » (soulignée ci-dessous) par « credit ».
2-4
mai 2019 Exemple de facturation – C#
{for (int i = 0; i < ddTxnResponse.detail.Length; i++){
responseTxt += " - " + ddTxnResponse.detail[i].tag + " - " +ddTxnResponse.detail[i].value + Environment.NewLine;
}}responseTxt = responseTxt.Replace("\n", Environment.NewLine);System.Console.WriteLine(responseTxt);if (DecisionV1.ACCEPTED.Equals(ddTxnResponse.decision)){
System.Console.WriteLine("Transaction Successful.");}else{
System.Console.WriteLine("Transaction Failed with decision: " +ddTxnResponse.decision);
}
Guide de référence de l’API pour les Services Web 1.0 2-5
Transactions par prélèvement automatique (débit direct) mai 2019
Diagramme de transaction ddCheckRequestV1L’objet de document ddCheckRequestV1 respecte la structure suivante :
2-6
mai 2019 Éléments de transaction ddCheckRequestV1
Éléments de transaction ddCheckRequestV1
L’objet de document ddCheckRequestV1 peut contenir les éléments suivants :
Ce type de requête est utilisé dans le cadre de divers plans de prélèvements automatiques. Consultez le Tableau 2-3 : Exigences supplémentaires pour les éléments de prélèvement automatique à la page 2-13 pour en savoir plus sur les différents éléments requis.
Tableau 2-2 : Éléments de transaction ddCheckRequestV1
Élément Élément enfant
Requis Type Description
merchantAccount accountNum Oui ChaîneMax = 10
Il s’agit du numéro de compte de march-and.
storeID Oui Chaîne Max = 80
Il s’agit de l’identifiant du magasin traitant la transaction ; il sert à authentifier la requête. Paysafe le définit et le fournit au marchand comme élément du processus d’intégration.
storePwd Oui ChaîneMax = 20
Il s’agit du mot de passe du magasin trai-tant la transaction ; il sert à authentifier la requête. Paysafe le définit et le fournit au marchand comme élément du processus d’intégration.
merchantRefNum Conditionnel ChaîneMax = 40
Il s’agit d’un numéro d’identification (ID) unique, associé à chaque requête. La valeur est créée par le marchand et envoyée en tant qu’élément de la requête. Cette valeur n’est retournée qu’en réponse à une looku-pRequest.
amount Oui ChaîneMax =9999999.99
Il s’agit du montant de la requête de trans-action. REMARQUE : Ce champ nécessite une val-eur non nulle pour le premier chiffre et deux chiffres après la virgule. Une excep-tion est faite dans le cas où un zéro est par lui-même (par exemple, 0,99).
check accountType Facultatif Énumération Il s’agit du type de compte chèque utilisé pour la transaction. Les valeurs possibles sont :• PC (Compte chèque personnel)• PS (Compte épargne personnel)• PL (Compte prêt personnel)• BC (Compte chèque commercial)• BS (Compte épargne commercial)• BL (Compte prêt commercial)
REMARQUE : Si cet élément n’est pas spécifié, la valeur par défaut est PC.
bankName Facultatif Chaîne Max = 40
Il s’agit du nom de la banque du client, là où cette transaction est publiée.
checkNum Oui LongMax = 8
Il s’agit du numéro de série du chèque fourni au moment de la requête de transac-tion.
Guide de référence de l’API pour les Services Web 1.0 2-7
Transactions par prélèvement automatique (débit direct) mai 2019
accountNum Oui ChaîneMax = 17Si IBAN, Max = 32
Il s’agit du numéro du compte bancaire du client.Pour les transactions SEPA, il s’agit du numéro IBAN (numéro de compte bancaire international) du client.REMARQUE : La valeur ne peut être fixée a 0 (zéro). Il doit contenir uniquement des car-actères alphanumériques.
routingNum Oui ChaîneMin = 6Max = 9Si BIC, Min = 8Max = 11
Pour les comptes en dollars américains, il s’agit du numéro d’acheminement à neuf chiffres de la banque du client. Pour les comptes en livres anglaises, il s’agit du code de tri à six chiffres de la banque du client.Pour les comptes en dollars canadiens, ce numéro est composé de l'ID de l'institution à trois chiffres suivi du numéro de transit à cinq chiffres de la succursale bancaire du client. Ils doivent être saisis dans cet ordre. N’insérez pas d’espaces ou de tirets. Pour les transactions SEPA, il s’agit du code BIC (code identificateur de banque) du compte bancaire du client. Si vous n’avez pas le BIC , vous pouvez soumettre la val-eur suivante, qui est sensible à la casse: EMPTYBICREMARQUE : La valeur ne peut être fixée a 0 (zéro). Il doit contenir uniquement des car-actères alphanumériques.
payee Conditionnel ChaîneMax = 81
Il s’agit du descripteur qui apparaîtra sur le relevé bancaire du client. Il n’est requis que pour les transactions credit.Si vous entrez une valeur pour ce champ, celle-ci servira de descripteur sur le relevé. Si vous n’entrez pas une valeur pour ce champ, une valeur par défaut, configurée pour le compte de marchand, servira de descripteur sur le relevé.
bankCountry Conditionnel Énumération Il s’agit du pays dans lequel la banque est située. Consultez la rubrique Codes de pays à la page C-3 pour connaître les bons codes à utiliser. Cet élément n’est requis que pour certains pays.
bankCity Conditionnel ChaîneMax = 40
Il s’agit de la ville dans laquelle la banque est située. Cet élément n’est requis que pour certains pays.
mandateRefer-ence
Conditionnel ChaîneMax = 10Pour SEPA, Max = 35Pour BIC,Max = 10
Ceci est la référence du mandat permettant de porter les frais au compte bancaire. Cette valeur est retournée pour le paramètre mandateReference en réponse à la ddMandateRequestV1.Pour SEPA cet élément est requis.
Tableau 2-2 : Éléments de transaction ddCheckRequestV1 (suite)
Élément Élément enfant
Requis Type Description
2-8
mai 2019 Éléments de transaction ddCheckRequestV1
billingDetails checkPayMethod Facultatif Énumération Il s’agit du type de paiement. Les valeurs possibles sont :• WEB (compte chèque personnel
seulement) • TEL (compte chèque personnel
seulement)• PPD (compte chèque personnel
seulement) • CCD (compte chèque commercial
seulement)
REMARQUE : Si cet élément n’est pas spécifié, la valeur par défaut est WEB. La valeur ne peut être fixée à WEB ou TEL pour les requêtes de crédit.
firstName Conditionnel ChaîneMax = 40
Il s’agit du prénom du client. Requis si checkPayMethod est réglé à WEB ou TEL.
lastName Conditionnel Chaîne Max = 40
Il s’agit du nom de famille du client.Requis si accountType est réglé à PC, PS, ou PL.
companyName Conditionnel ChaîneMax = 50
Il s’agit du nom de l’entreprise. Requis si accountType est réglé à BC, BS, ou BL.
street Oui ChaîneMax = 50
Il s’agit de la première ligne de l’adresse municipale du client.
street2 Facultatif ChaîneMax = 50
Il s’agit de la deuxième ligne de l’adresse municipale du client.
city Oui ChaîneMax = 40
Il s’agit de la ville de résidence du client.
state/region Conditionnel Si state (État), alors ÉnumérationSi region (région), alors chaîneMax = 40
Il s’agit de l’État, de la province ou de la région de résidence du client. Fournir state pour les adresses à l’intérieur des États-Unis ou du Canada. Fournir region pour les adresses à l’extérieur des États-Unis ou du Canada. Consultez la rubrique Annexe C : Codes géo-graphiques pour connaître les bons codes à utiliser.
country Oui Énumération Il s’agit du pays de résidence du client. Con-sultez la rubrique Codes de pays à la page C-3 pour connaître les bons codes à utiliser.
zip Facultatif ChaîneMax = 10
Si le pays est États-Unis, il s'agit du code Zip du client ; sinon, il s'agit de son code postal.
phone Oui ChaîneMax = 40
Il s’agit du numéro de téléphone du client.
email Facultatif ChaîneMax = 100
Il s’agit de l’adresse de courriel du client.
Tableau 2-2 : Éléments de transaction ddCheckRequestV1 (suite)
Élément Élément enfant
Requis Type Description
Guide de référence de l’API pour les Services Web 1.0 2-9
Transactions par prélèvement automatique (débit direct) mai 2019
personalID idNumber Facultatif ChaîneMax = 20
Il s’agit du numéro de l’ID fourni pour l’élé-ment idType.
idType Facultatif Énumération Il s’agit du type d’ID utilisé pour identifier le propriétaire du compte bancaire. Les valeurs possibles sont :• DL (permis de conduire) • SS (ID gouvernemental)• MI (ID militaire)• GN (ID général)
state/region Facultatif Si state (État), alors ÉnumérationSi region (région), alors ChaîneMax = 40
Il s’agit de l’État, de la province ou de la région qui a émis l’ID. Fournir state pour les adresses à l’intérieur des États-Unis ou du Canada. Fournir region pour les adresses à l’extérieur des États-Unis ou du Canada. Consultez la rubrique Annexe C : Codes géo-graphiques pour connaître les bons codes à utiliser.
country Facultatif ChaîneLongueur = 2
Il s’agit du pays d’émission de l’ID. Les val-eurs possibles sont :• CA (Canada)• US (États-Unis)
expiry Facultatif L’élément enfant expiry a trois autres élé-ments enfants.
Élément enfant de expiry
day Facultatif Entier Longueur = 2
Il s’agit du jour d’expiration de l’ID.
month Facultatif Entier Longueur = 2
Il s’agit du mois d’expiration de l’ID.
year Conditionnel Entier Longueur = 4
Il s’agit de l’année d’expiration de l’ID.Cet élément est requis si l’élément expiry est inclus.
socialSecurityNumber Facultatif ChaîneMax = 12
Il s’agit du numéro d’assurance sociale du client.
dateOfBirth Facultatif Il s’agit de la date de naissance du client.
year Conditionnel ChaîneMax = 41900–9999
Il s’agit de l’année de naissance du client.
month Conditionnel ChaîneMax = 12
Il s’agit du mois de naissance du client.
day Conditionnel ChaîneMax = 31
Il s’agit du jour de naissance du client.
Tableau 2-2 : Éléments de transaction ddCheckRequestV1 (suite)
Élément Élément enfant
Requis Type Description
2-10
mai 2019 Éléments de transaction ddCheckRequestV1
shippingDetails carrier Facultatif Énumération Il s’agit du transporteur de l’envoi. Les valeurs possibles sont :• APC = APC Overnight• APS = AnPost• CAD = Service postal du Canada• DHL• FEX = FedEx• RML = Royal Mail• UPS = United Parcel Service• USPS = United States Postal Service• OTHER = Autre
trackingNumber Facultatif Chaîne
Max = 50
Il s’agit du numéro de suivi d’expédition fourni par le transporteur.
shipMethod Facultatif Énumération Il s’agit du mode d’expédition. Les valeurs possibles sont :• N = Jour suivant/de nuit• T = Deux jours• C = Coût le plus bas• O = Autre
firstName Facultatif Chaîne
Max = 40
Il s’agit du prénom du destinataire.
lastName Facultatif Chaîne
Max = 40
Il s’agit du nom de famille du destinataire.
street Facultatif Chaîne
Max = 50
Il s’agit de la première ligne de l’adresse municipale du destinataire.
street2 Facultatif Chaîne
Max = 50
Il s’agit de la deuxième ligne de l’adresse municipale du destinataire.
city Facultatif Chaîne
Max = 40
Il s’agit de la ville de résidence du destinataire.
state/region Facultatif Si state (État), alors Énumération
Si region (région), alors ChaîneMax = 40
Il s’agit de l’État, de la province ou de la région de résidence du destinataire.
Fournir la liste des États ou provinces pour les adresses à l’intérieur des États-Unis ou du Canada.
Consultez la rubrique Annexe C : Codes géo-graphiques pour connaître les bons codes à utiliser.
country Facultatif Énumération Il s’agit du pays de résidence du destina-taire. Consultez la rubrique Codes de pays à la page C-3 pour connaître les bons codes à utiliser.
zip Facultatif Chaîne
Max = 10
Si le pays est États-Unis, il s'agit du code Zip du destinataire ; sinon, il s'agit de son code postal.
Tableau 2-2 : Éléments de transaction ddCheckRequestV1 (suite)
Élément Élément enfant
Requis Type Description
Guide de référence de l’API pour les Services Web 1.0 2-11
Transactions par prélèvement automatique (débit direct) mai 2019
phone Facultatif Chaîne
Max = 40
Il s’agit du numéro de téléphone du destina-taire.
email Facultatif Chaîne
Max = 100
Il s’agit de l’adresse de courriel du destina-taire.
customerIP Facultatif ChaîneMax = 50
Il s’agit de l’adresse IP du client.
productType Facultatif Énumération Il s’agit du type de produit vendu. Les valeurs possibles sont :• P (Biens matériels) • D (Produits numériques)• C (Contenu numérisé) • G (Bon-cadeau ou argent électronique) • S (Logiciel contributif) • M (Numérique et Matériel) • R (Réapprovisionnement de compte)
txnAppliedTo Non Cet élément ne s’applique pas aux transac-tions par prélèvement automatique.
confirmationNumber Conditionnel ChaîneMax = 15
Il s’agit du numéro de confirmation retourné par Paysafe en réponse à la requête initiale.N’incluez cet élément que si vous utilisez ddCheckRequestV1 pour traiter une requête credit.
targetVirtualAccount Non Cet élément ne s’applique pas aux transac-tions par prélèvement automatique.
checkRiskService Non Cet élément ne s’applique pas aux transac-tions par prélèvement automatique.
txnDate Facultatif dateTime Il s’agit de la date et de l’heure auxquelles la transaction a eu lieu.Pour les charge, credit, ou mandateReq-uest, cette valeur peut indiquer la date et l’heure à laquelle la transaction aura lieu.Pour les transactions SEPA, cette valeur indique la prochaine date de paiement. Celle-ci doit accorder un délai d’au moins deux jours ouvrables. REMARQUE : La date de paiement sera retournée dans la paire tag/value, dans l’élément detail de la réponse (consultez le Tableau 2-10 : Éléments de réponse ddCheckResponseV1 à la page 2-34).
sdk version Conditionnel ChaîneMax = 20
Il s’agit de la version de SDK utilisée, le cas échéant.Requis si l’élément sdk est fourni.
platform Conditionnel ChaîneMax = 10
Il s’agit de la langue d’intégration de SDK utilisée (par ex., Java, .NET). Requis si l’élément sdk est fourni.
Tableau 2-2 : Éléments de transaction ddCheckRequestV1 (suite)
Élément Élément enfant
Requis Type Description
2-12
mai 2019 Éléments de transaction ddCheckRequestV1
Considérations spéciales relatives aux éléments de prélèvement automatiqueCertains marchands sont intégrés à des processeurs ayant des exigences concernant certains éléments obligatoires. Si tel est le cas, les règles suivantes s’appliquent:
provider Conditionnel ChaîneMax = 20
Il s’agit de l’auteur de SDK utilisé. Réglez cette valeur à « op » lorsque le SDK est fourni par Paysafe.Requis si l’élément sdk est fourni.
origin Facultatif Énumération Il s'agit de l’origine de la requête. Les valeurs possibles sont :• Sans fil• Réseau filaire
addendumData tag Facultatif ChaîneMax = 30
Il s’agit de données supplémentaires que le marchand peut inclure dans la requête de transaction.
value Facultatif ChaîneMax = 1024
Il s’agit de données supplémentaires que le marchand peut inclure dans la requête de transaction.
Tableau 2-3 : Exigences supplémentaires pour les éléments de prélèvement automatique
Élément Transactions réguliers
Transactions garanties
Transactions SEPA
check.accountType Facultatif Requis Facultatif
check.bankName Facultatif Requis Facultatif
check.checkNum Requis Requis Facultatif
check.payee Facultatif Facultatif Requis
check.bankCountry Conditionnel Conditionnel Facultatif
check.bankCity Conditionnel Conditionnel Facultatif
check.mandateReference Conditionnel Conditionnel Requis pour les débits seulement
billingDetails.firstName Conditionnel Requis Requis
billingDetails.lastName Conditionnel Requis Requis
billingDetails.companyName Conditionnel Conditionnel Facultatif
billingDetails.state Conditionnel Requis Facultatif
billingDetails.zip Facultatif Requis Requis
billingDetails.phone Facultatif Requis Facultatif
billingDetails.email Facultatif Requis Requis
customerIP Facultatif Requis Facultatif
dateOfBirth.year Facultatif Requis Facultatif
Tableau 2-2 : Éléments de transaction ddCheckRequestV1 (suite)
Élément Élément enfant
Requis Type Description
Guide de référence de l’API pour les Services Web 1.0 2-13
Transactions par prélèvement automatique (débit direct) mai 2019
Création de requêtes updateShippingInfo
La transaction updateShippingInfo requiert l’objet de document ddShippingRequestV1. La présente rubrique décrit la structure d’une requête ddShippingRequestV1 et la façon de la bâtir. Pour obtenir des détails sur les éléments requis, consultez le Tableau 2-4 : Éléments de transaction ddShippingRequestV1 à la page 2-16.
Exemple de transaction updateShippingInfo – C#Voici un exemple de transaction updateShippingInfo en C#.
// Prepare the call to the Direct Debit Web ServiceDDShippingRequestV1 ddShippingRequest = new DDShippingRequestV1();MerchantAccountV1 merchantAccount = new MerchantAccountV1();merchantAccount.accountNum = "12345678";merchantAccount.storeID = "myStoreID";merchantAccount.storePwd = "myStorePwd";ddShippingRequest.merchantAccount = merchantAccount;ddShippingRequest.confirmationNumber = "123456"; // A valid confirmation number from a previous settle auth or purchaseddShippingRequest.carrier = CarrierV1.FEX; // FedexddShippingRequest.shipMethod = ShipMethodV1.T;ddShippingRequest.shipMethodSpecified = true;ddShippingRequest.trackingNumber = "555666888999";ddShippingRequest.firstName = "Jeanne";ddShippingRequest.lastName = "Tremblay";ddShippingRequest.street = "123 rue Principale";ddShippingRequest.city = "Alma";ddShippingRequest.country = CountryV1.CA;ddShippingRequest.countrySpecified = true;ddShippingRequest.zip = "G0W 1G0";ddShippingRequest.email = "[email protected]";
dateOfBirth.month Facultatif Requis Facultatif
dateOfBirth.day Facultatif Requis Facultatif
personalID.idNumber Facultatif Requis Facultatif
personalID.state Facultatif Requis Facultatif
socialSecurityNumber Facultatif Requis Facultatif
Votre gestionnaire de compte vous informera si vous êtes intégré à ce type de processeur et si vous êtes admissible au traitement par prélèvement automatique garantie.
Tous les éléments facultatifs qui requièrent des types de données non nullables (ordinaires) (par ex., int ou enum) doivent avoir leur attribut specified établi à true lorsque les valeurs sont fixées pour ces éléments. Consultez l’élément shipMethod dans l’exemple ci-dessous.
Tableau 2-3 : Exigences supplémentaires pour les éléments de prélèvement automatique (suite)
Élément Transactions réguliers
Transactions garanties
Transactions SEPA
2-14
mai 2019 Exemple de transaction updateShippingInfo – C#
//Perform the Web Services call to update the shipping infoDirectDebitServiceV1 ddService = new DirectDebitServiceV1();DDCheckResponseV1 ddTxnResponse =ddService.updateShippingInfo(ddShippingRequest);// Print out the resultString responseTxt = ddTxnResponse.code + " - " + ddTxnResponse.decision + " - " +
ddTxnResponse.description;responseTxt += "Details:" + Environment.NewLine;if (ddTxnResponse.detail != null){
for (int i = 0; i < ddTxnResponse.detail.Length; i++){
responseTxt += " - " + ddTxnResponse.detail[i].tag + " - " +ddTxnResponse.detail[i].value + Environment.NewLine;
}}responseTxt = responseTxt.Replace("\n", Environment.NewLine);System.Console.WriteLine(responseTxt);if (DecisionV1.ACCEPTED.Equals(ddTxnResponse.decision)){
System.Console.WriteLine("Transaction Successful.");}else{
System.Console.WriteLine("Transaction Failed with decision: " +ddTxnResponse.decision);
}
Guide de référence de l’API pour les Services Web 1.0 2-15
Transactions par prélèvement automatique (débit direct) mai 2019
Diagramme de transaction ddShippingRequestV1L’objet de document ddShippingRequestV1 respecte la structure suivante :
Éléments de transaction ddShippingRequestV1L’objet de document ddShippingRequestV1 peut contenir les éléments suivants :
Tableau 2-4 : Éléments de transaction ddShippingRequestV1
Élément Élément enfant Requis Type Description
merchantAccount accountNum Oui ChaîneMax = 10
Il s’agit du numéro de compte de marchand.
2-16
mai 2019 Éléments de transaction ddShippingRequestV1
storeID Oui Chaîne Max = 80
Il s’agit de l’identifiant du magasin traitant la transaction ; il sert à authentifier la requête. Paysafe le définit et le fournit au marchand comme élément du processus d’intégration.
storePwd Oui ChaîneMax = 20
Il s’agit du mot de passe du magasin traitant la transaction ; il sert à authentifier la requête. Paysafe le définit et le fournit au marchand comme élément du processus d’intégration.
carrier Oui Énumération Il s’agit du transporteur de l’envoi. Les valeurs possibles sont :• APC = APC Overnight• APS = AnPost• CAD = Service postal du Canada• DHL• FEX = FedEx• RML = Royal Mail• UPS = United Parcel Service• USPS = United States Postal Service• AUTRE
trackingNumber Oui ChaîneMax = 50
Il s’agit du numéro de suivi d’expédition fourni par le transporteur.
confirmationNumber Oui ChaîneMax = 15
Il s’agit du numéro de confirmation retourné par Paysafe.
shipMethod Facultatif Énumération Il s’agit du mode d’expédition. Les valeurs possibles sont :• N = Jour suivant/de nuit• T = Deux jours• C = Coût le plus bas• O = Autre
firstName Facultatif ChaîneMax = 40
Il s’agit du prénom du client.
lastName Facultatif Chaîne Max = 40
Il s’agit du nom de famille du client.
street Facultatif ChaîneMax = 50
Il s’agit de la première ligne de l’adresse municipale du client.
street2 Facultatif ChaîneMax = 50
Il s’agit de la deuxième ligne de l’adresse municipale du client.
city Facultatif ChaîneMax = 40
Il s’agit de la ville de résidence du client.
state/region Facultatif Si state (État), alors ÉnumérationSi region (région), alors ChaîneMax = 40
Il s’agit de l’État, de la province ou de la région de résidence du client. Fournir state pour les adresses à l’intérieur des États-Unis ou du Canada. Fournir region pour les adresses à l’extérieur des États-Unis ou du Canada. Consultez la rubrique Annexe C : Codes géo-graphiques pour connaître les bons codes à utiliser.
Tableau 2-4 : Éléments de transaction ddShippingRequestV1 (suite)
Élément Élément enfant Requis Type Description
Guide de référence de l’API pour les Services Web 1.0 2-17
Transactions par prélèvement automatique (débit direct) mai 2019
Création de lookupRequest (requêtes de consultation)La requête de consultation du prélèvement automatique vous permet de produire un rapport à l’aide de l’API pour une plage de temps que vous précisez, afin de recevoir les données concernant les trans-actions de facturation et de crédit par prélèvement automatique qui sont traitées par votre compte de marchand.
Exemple de transaction lookupRequest – C#Voici un exemple de transaction ddLookupRequest en C#.
// Prepare the call to the Direct Debit Web ServiceDDLookupRequestV1 ddLookupRequest = new DDLookupRequestV1();MerchantAccountV1 merchantAccount = new MerchantAccountV1();merchantAccount.accountNum = "12345678";merchantAccount.storeID = "myStoreID";merchantAccount.storePwd = "myStorePWD";ddLookupRequest.merchantAccount = merchantAccount;ddLookupRequest.confirmationNumber = "123456789";DateV1 startDate = new DateV1();startDate.year = "2012";startDate.month = "08";startDate.day = "15";startDate.hour = "11";startDate.minute = "00";startDate.second = "00";ddLookupRequest.startDate = startDate;ddLookupRequest.startDateSpecified = true;DateV1 endDate = new DateV1();endDate.year = "2012";endDate.month = "08";endDate.day = "15";endDate.hour = "14";endDate.minute = "00";endDate.second = "00";ddLookupRequest.endDate = endDate;ddLookupRequest.endDateSpecified = true;
//Perform the Web Services call to process the chargeDirectDebitServiceV1 ddService = new DirectDebitServiceV1();DDCheckResponseV1 ddCheckResponse = ddService.lookup(ddLookupRequest);
country Facultatif Énumération Il s’agit du pays de résidence du client. Con-sultez la rubrique Codes de pays à la page C-3 pour connaître les bons codes à utiliser.
zip Facultatif ChaîneMax = 10
Si le pays est États-Unis, il s'agit du code Zip du client ; sinon, il s'agit de son code postal.
phone Facultatif ChaîneMax = 40
Il s’agit du numéro de téléphone du client.
email Facultatif ChaîneMax = 100
Il s’agit de l’adresse de courriel du client.
Tableau 2-4 : Éléments de transaction ddShippingRequestV1 (suite)
Élément Élément enfant Requis Type Description
2-18
mai 2019 Exemple de transaction lookupRequest – C#
// Print out the resultString responseTxt = ddCheckResponse.code + " - " + ddCheckResponse.decision;responseTxt += "Transactions:" + Environment.NewLine;if (ddCheckResponse.transaction != null){ for (int i = 0; i < ddCheckResponse.transaction.Length; i++) { responseTxt += " - confirmationNumber: " + ddCheckResponse.transaction[i].confirmationNumber + Environment.NewLine; responseTxt += " - merchantRefNum: " + ddCheckResponse.transaction[i].merchantRefNum + Environment.NewLine; responseTxt += " - txnTime: " + ddCheckResponse.transaction[i].txnTime + Environment.NewLine; responseTxt += " - amount: " + ddCheckResponse.transaction[i].amount + Environment.NewLine; StatusV1 status = ddCheckResponse.transaction[i].status; if (status != null){ responseTxt += " - status: " + status.code + Environment.NewLine; responseTxt += " - status effective date:" + status.effectiveDate + Environment.NewLine; } responseTxt += Environment.NewLine; }}responseTxt = responseTxt.Replace("\n", Environment.NewLine);System.Console.WriteLine(responseTxt);if (DecisionV1.ACCEPTED.Equals(ddCheckResponse.decision)){ System.Console.WriteLine("Transaction Found.");}else{ System.Console.WriteLine("Transaction Failed or Not Found with decision: " + ddCheckResponse.decision);}
Guide de référence de l’API pour les Services Web 1.0 2-19
Transactions par prélèvement automatique (débit direct) mai 2019
Diagramme de transaction ddLookupRequestV1L’objet de document ddLookupRequestV1 respecte la structure suivante :
Éléments de transaction ddLookupRequestV1L’objet de document ddLookupRequestV1 peut contenir les éléments suivants :
Tableau 2-5 : Éléments de transaction ddLookupRequestV1
Élément Élément enfant
Requis Type Description
merchantAccount accountNum Oui ChaîneMax = 10
Il s’agit du numéro de compte de marchand.
storeID Oui Chaîne Max = 80
Il s’agit de l’identifiant du magasin traitant la transaction ; il sert à authentifier la requête. Paysafe le définit et le fournit au marchand comme élément du processus d’intégration.
storePwd Oui ChaîneMax = 20
Il s’agit du mot de passe du magasin traitant la transaction ; il sert à authentifier la requête. Paysafe le définit et le fournit au marchand comme élément du processus d’intégration.
confirmationNumber Facultatif ChaîneMax = 15
Il s’agit du numéro de confirmation retourné par Paysafe en réponse à la requête initiale.N’incluez cet élément que si vous voulez effectuer une recherche à l’aide de ce champ. Ce champ a préséance sur le champ merchantRefNum.
2-20
mai 2019 Éléments de transaction ddLookupRequestV1
merchantRefNum Conditionnel ChaîneMax = 40
Il s’agit d’un numéro d’identification (ID) unique, associé à chaque requête. La valeur est créée par le marchand et envoyée en tant qu’élément de la requête.
startDate year Oui IntMax = 9999
Il s’agit de l’année fixée pour le début de la recherche.
month Oui IntMin = 1Max = 12
Il s’agit du mois fixé pour le début de la recherche.
day Oui IntMin = 1Max = 31
Il s’agit du jour fixé pour le début de la recherche.
hour Oui IntMin = 0Max = 23
Il s’agit de l’heure fixée pour le début de la recherche.
minute Oui IntMin = 0Max = 59
Il s’agit de la minute fixée pour le début de la recherche.
second Oui IntMin = 0Max = 59
Il s’agit de la seconde fixée pour le début de la recherche.
endDate year Oui IntMax = 9999
Il s’agit de l’année fixée pour la fin de la recherche.
month Oui IntMin = 1Max = 12
Il s’agit du mois fixé pour la fin de la recher-che.
day Oui IntMin = 1Max = 31
Il s’agit du jour fixé pour la fin de la recher-che.
hour Oui IntMin = 0Max = 23
Il s’agit de l’heure fixée pour la fin de la recherche.
minute Oui IntMin = 0Max = 59
Il s’agit de la minute fixée pour la fin de la recherche.
second Oui IntMin = 0Max = 59
Il s’agit de la seconde fixée pour la fin de la recherche.
Tableau 2-5 : Éléments de transaction ddLookupRequestV1 (suite)
Élément Élément enfant
Requis Type Description
Guide de référence de l’API pour les Services Web 1.0 2-21
Transactions par prélèvement automatique (débit direct) mai 2019
Création de mandateRequest pour BACS (requêtes de mandat)
La demande de mandat de prélèvements automatiques vous permet de créer un mandat pour le compte bancaire d’un client et de le déposer à sa banque, afin que vous puissiez transférer des fonds du compte bancaire du client vers votre compte commercial.
Lorsque vous soumettez une ddMandateRequestV1, Paysafe retournera une valeur pour le paramètre mandateReference dans la réponse. Il s’agit de la valeur entrée dans la requête ou une valeur générée automatiquement par le système Paysafe. Vous aurez besoin de cette valeur dans l’élément man-dateReference (qui est un élément enfant de l’élément check) lorsque vous traiterez des demandes de facturation à l’aide de la ddCheckRequestV1.
La valeur mandateReference doit contenir dix caractères. Si vous entrez une valeur de moins de dix car-actères, le système Paysafe insérera des chiffres “ 0 ” avant celle-ci jusqu’à ce qu’elle compte 10 car-actères. Par exemple, la valeur “ ABCDEFG ” deviendra “ 000ABCDEFG “. Si vous n’entrez aucune valeur, le système Paysafe en générera une et la retournera dans la réponse.
Initialement, l’état du mandat est réglé à W (En attente). Lorsque ce dernier est mis en lot, l’état passe à C (Lot complet). À ce stade, le mandat ne peut pas être utilisé pour effectuer des prélèvements automatiques. Le réseau bancaire traite généralement le mandat en cinq jours. Après ce délai, et une fois le mandat mis en lot, Paysafe fait passer l’état du mandat à AP (Mandat approuvé). Le mandat peut alors être utilisé pour autoriser des prélèvements automatiques dans le compte bancaire à l’intention duquel il a été créé. Si la facture est postdatée en définissant la valeur txnDate dans la requête ddCheck-RequestV1, le mandat peut être utilisé même s’il n’est pas activé, dans la mesure où la valeur txnDate a été définie de façon à fixer un délai d’au moins cinq jours ouvrables, le temps que le mandat devienne actif. Afin de faciliter ce processus, la date d’activation du mandat est indiquée dans l’élément effective-Date en réponse à la requête ddMandateRequestV1.
Les mandats sont automatiquement mis en lot le jour ouvrable suivant, sauf si la valeur autoSend n’est pas réglée à Y, auquel cas le mandat demeurera à l’état PCA (Approbation du client en attente). Cet état intermédiaire et facultatif, antérieur à l’état W, vous donne l’occasion d’effectuer d’autres vérifications relatives au client, ou encore permet au client de vérifier l’information reçue par mandateReference avant de continuer. Vous pouvez ensuite faire passer l’état du mandat de PCA à W en effectuant une requête changeStatus ou en utilisant le module d’administration du marchand de Paysafe.
Création de mandateRequest pour SEPA (requêtes de mandat)Avant d’effectuer un prélèvement automatique SEPA, vous devez préalablement avoir établi une entente de mandat avec votre client et indiquer l’ID de référence du mandat dans l’élément man-dateReference. L’ID de référence du mandat peut contenir jusqu’à 35 caractères.
Les mandats de prélèvements automatiques SEPA sont activés dès qu’ils sont créés par le marchand. Après avoir envoyé une requête ddMandateRequest, vous pouvez donc immédiatement envoyer une requête ddCheckRequest.
Pour en savoir plus consultez le SEPA Direct Debit Merchant Implementation Guide (en anglais), qui con-tient plus d’information sur la logique métier et les processus associés au prélèvement automatique SEPA.
Les mandats de prélèvements automatiques ne sont pas nécessaires pour les crédits SEPA.
2-22
mai 2019 Exemple de transaction mandateRequest – C#
Exemple de transaction mandateRequest – C#Voici un exemple de transaction ddMandateRequest en C#.
// Prepare the call to the Direct Debit Web ServiceDDMandateRequestV1 ddMandateRequest = new DDMandateRequestV1();MerchantAccountV1 merchantAccount = new MerchantAccountV1();merchantAccount.accountNum = "12345678";merchantAccount.storeID = "myStoreID";merchantAccount.storePwd = "myStorePWD";ddCheckRequest.merchantAccount = merchantAccount;CheckV1 check = new CheckV1();check.routingNum = "123456789";check.accountNum = "987654321";check.bankName = "Chase";check.payee = "ACME Inc.";ddMandateRequest.check = check;BillingDetailsV1 billingDetails = new BillingDetailsV1();billingDetails.firstName = "Jeanne";billingDetails.lastName = "Tremblay";billingDetails.street = "123 rue Principale";billingDetails.city = "Alma";billingDetails.country = CountryV1.CA;billingDetails.zip = "G0W 1G0";billingDetails.phone = "555-555-5555";billingDetails.checkPayMethod = CheckPayMethodV1.WEB;ddMandateRequest.billingDetails = billingDetails;ddMandateRequest.autoSend = "Y";//Perform the Web Services call to process the chargeDirectDebitServiceV1 ddService = new DirectDebitServiceV1();DDCheckResponseV1 ddTxnResponse = ddService.mandate(ddCheckRequest);
// Print out the resultString responseTxt = ddTxnResponse.code + " - " + ddTxnResponse.decision +
" - " + ddTxnResponse.description;responseTxt += "Details:" + Environment.NewLine;if (ddTxnResponse.detail != null){
for (int i = 0; i < ddTxnResponse.detail.Length; i++){
responseTxt += " - " + ddTxnResponse.detail[i].tag + " - " +ddTxnResponse.detail[i].value + Environment.NewLine;
}}responseTxt = responseTxt.Replace("\n", Environment.NewLine);System.Console.WriteLine(responseTxt);if (DecisionV1.ACCEPTED.Equals(ddTxnResponse.decision)){
System.Console.WriteLine("Transaction Successful.");}else{
System.Console.WriteLine("Transaction Failed with decision: " +ddTxnResponse.decision);
}
Guide de référence de l’API pour les Services Web 1.0 2-23
Transactions par prélèvement automatique (débit direct) mai 2019
Diagramme de transaction ddMandateRequestV1L’objet de document ddMandateRequestV1 respecte la structure suivante :
2-24
mai 2019 Éléments de transaction ddMandateRequestV1
Éléments de transaction ddMandateRequestV1L’objet de document ddMandateRequestV1 peut contenir les éléments suivants :
Tableau 2-6 : Éléments de transaction ddMandateRequestV1
Element Child Element Required Type Description
merchantAccount accountNum Oui ChaîneMax = 10
Il s’agit du numéro de compte de marchand.
storeID Oui Chaîne Max = 80
Il s’agit de l’identifiant du magasin traitant la transaction ; il sert à authentifier la requête. Paysafe le définit et le fournit au marchand comme élément du processus d’intégration.
storePwd Oui ChaîneMax = 20
Il s’agit du mot de passe du magasin traitant la transaction ; il sert à authentifier la requête. Paysafe le définit et le fournit au marchand comme élément du processus d’intégration.
merchantRefNum Conditionnel ChaîneMax = 40
Il s’agit d’un numéro d’identification (ID) unique, associé à chaque requête. La valeur est créée par le marchand et envoyée en tant qu’élément de la requête.
check accountType Oui Énumération Il s’agit du type de compte chèque utilisé pour la transaction. Les valeurs possibles sont :• PC (Compte chèque personnel)• PS (Compte épargne personnel)• PL (Compte prêt personnel)• BC (Compte chèque commercial)• BS (Compte épargne commercial)• BL (Compte prêt commercial)
REMARQUE : Si cet élément n’est pas spécifié, la valeur par défaut est PC.
bankName Facultatif Chaîne Max = 40
Il s’agit du nom de la banque du client, là où cette transaction est publiée.
checkNum Oui LongMax = 8
Il s’agit du numéro de série du chèque fourni au moment de la requête de transaction.
accountNum Oui ChaîneMax = 17
Il s’agit du numéro du compte bancaire du client.Pour les transactions SEPA, il s’agit du numéro IBAN (numéro de compte bancaire international) du client.
routingNum Oui ChaîneMin = 6Max = 9Si BIC, Min = 8Max = 11
Pour les comptes en livres anglaises, il s’agit du code de tri à six chiffres de la banque du client.Pour les transactions SEPA, il s’agit du code BIC (code identificateur de banque) du compte bancaire du client. Si vous n’avez pas le BIC , vous pouvez soumettre la valeur suiv-ante, qui est sensible à la casse: EMPTYBIC
Guide de référence de l’API pour les Services Web 1.0 2-25
Transactions par prélèvement automatique (débit direct) mai 2019
payee Facultatif ChaîneMax = 81
Il s’agit du descripteur qui apparaîtra sur le relevé bancaire du client. Il n’est requis que pour les transactions credit. Si vous entrez une valeur pour ce champ, celle-ci servira de descripteur sur le relevé. Si vous n’entrez pas une valeur pour ce champ, une valeur par défaut, configurée pour le compte de marchand, servira de descripteur sur le relevé.
bankCountry Conditionnel Énumération Il s’agit du pays dans lequel la banque est située. Consultez la rubrique Codes de pays à la page C-3 pour connaître les bons codes à utiliser. Cet élément n’est requis que pour certains pays.
bankCity Conditionnel ChaîneMax = 40
Il s’agit de la ville dans laquelle la banque est située. Cet élément n’est requis que pour certains pays.
mandateReference Facultatif ChaîneMax = 10
Il s’agit de la référence du mandat permet-tant de porter les frais au compte. Vous pou-vez définir vous-même la valeur mandateReference lorsque vous effectuez la requête. Si vous n’entrez aucune valeur dans ce champ, le système Paysafe en générera une et la retournera dans la réponse.Pour les transactions SEPA, cet élément est obligatoire. Le marchand doit créer sa pro-pre valeur mandateReference.
billingDetails checkPayMethod Facultatif Énumération Il s’agit du type de paiement. Les valeurs possibles sont :• WEB (compte chèque personnel
seulement) • TEL (compte chèque personnel
seulement)• PPD (compte chèque personnel
seulement) • CCD (compte chèque commercial
seulement)
REMARQUE : Si cet élément n’est pas spécifié, la valeur par défaut est WEB.
firstName Conditionnel ChaîneMax = 40
Il s’agit du prénom du client. Requis si checkPayMethod est réglé à WEB ou TEL.
lastName Conditionnel Chaîne Max = 40
Il s’agit du nom de famille du client.Requis si accountType est réglé à PC, PS, ou PL.
companyName Conditionnel ChaîneMax = 50
Il s’agit du nom de l’entreprise. Requis si accountType est réglé à BC, BS, ou BL.
street Facultatif ChaîneMax = 50
Il s’agit de la première ligne de l’adresse municipale du client.
street2 Facultatif ChaîneMax = 50
Il s’agit de la deuxième ligne de l’adresse municipale du client.
Tableau 2-6 : Éléments de transaction ddMandateRequestV1 (suite)
Element Child Element Required Type Description
2-26
mai 2019 Éléments de transaction ddMandateRequestV1
city Facultatif ChaîneMax = 40
Il s’agit de la ville de résidence du client.
state/region Conditionnel Si state (État), alors ÉnumérationSi region (région), alors chaîneMax = 40
Il s’agit de l’État, de la province ou de la région de résidence du client. Fournir state pour les adresses à l’intérieur des États-Unis ou du Canada. Fournir region pour les adresses à l’extérieur des États-Unis ou du Canada. Consultez la rubrique Annexe C : Codes géo-graphiques pour connaître les bons codes à utiliser.
country Facultatif Énumération Il s’agit du pays de résidence du client. Con-sultez la rubrique Codes de pays à la page C-3 pour connaître les bons codes à utiliser.
zip Facultatif ChaîneMax = 10
Si le pays est États-Unis, il s'agit du code Zip du client ; sinon, il s'agit de son code postal.
phone Facultatif ChaîneMax = 40
Il s’agit du numéro de téléphone du client.
email Facultatif ChaîneMax = 100
Il s’agit de l’adresse de courriel du client.
customerIP Facultatif ChaîneMax = 50
Il s’agit de l’adresse IP du client.
txnDate Facultatif dateTime Il s’agit de la date et de l’heure auxquelles la transaction a eu lieu.Pour les charge, credit, ou mandateRequest, cette valeur peut indiquer la date et l’heure à laquelle la transaction aura lieu.
autoSend Facultatif Booléen Ceci détermine le moment où le mandat sera envoyé à la banque.Les valeurs possibles sont :• Y = Oui – L’état du mandat sera réglé à W
(En attente), prêt à être envoyé à la ban-que.
• N = Non – L’état du mandat restera réglé à PCA (Approbation client en attente), et ce dernier ne sera pas envoyé à la banque.
Si l’état autoSend est réglé à N, le mandat peut par la suite être changé pour W à l’aide de la demande de changeStatus. Le mandat sera alors acheminé à la banque lors du pro-chain envoi (consultez la rubrique Création de changeStatusRequest (requêtes de modifi-cation d’état) à la page 2-28).REMARQUE : Pour les transactions SEPA, cette valeur doit être réglée à Y. L’état du mandat sera AP (Mandat approuvé).
addendumData tag Facultatif ChaîneMax = 30
Il s’agit de données supplémentaires que le marchand peut inclure dans la requête de transaction.
value Facultatif ChaîneMax = 1024
Il s’agit de données supplémentaires que le marchand peut inclure dans la requête de transaction.
Tableau 2-6 : Éléments de transaction ddMandateRequestV1 (suite)
Element Child Element Required Type Description
Guide de référence de l’API pour les Services Web 1.0 2-27
Transactions par prélèvement automatique (débit direct) mai 2019
Création de changeStatusRequest (requêtes de modification d’état)
Une demande de modification d’état vous permet de modifier l’état de certains prélèvements automa-tiques. Vous pouvez apporter les modifications suivantes :
Paysafe répond à votre demande de modification d’état par une ddCheckResponseV1. Dans cette réponse, le confirmationNumber indique quelle demande a été mise à jour (charge, credit, ou mandate-Request), et vous permet de confirmer le nouvel état de la transaction que vous avez mise à jour. Pour obtenir plus de détails, consultez la rubrique Traitement de la réponse à la page 2-33.
Exemple de transaction changeStatusRequest – C#Voici un exemple de transaction ddChangeStatusRequest en C#.
// Prepare the call to the Direct Debit Web ServiceDDChangeStatusRequestV1 ddChangeStatusRequest = new DDChangeStatusRequestV1();MerchantAccountV1 merchantAccount = new MerchantAccountV1();merchantAccount.accountNum = "12345678";merchantAccount.storeID = "myStoreID";
Tableau 2-7 : Modification d’état
Solution Type de requête État initial État obtenu
Prélèvement automatique au Royaume-Uni (BACS)
• mandateRequest (mandat)
• PCA – Approbation du client en attente
• W – En attente• X – Annulée
Prélèvement automatique au Royaume-Uni (BACS)
• charge (facturation)• credit (crédit)• mandateRequest
(mandat)
• W – En attente • X – Annulée
Prélèvement automatique au Royaume-Uni (marchands passerelle)
• charge (facturation)• credit (crédit)• mandateRequest
(mandat)
• C – Lot complet• CL – Transaction traitée
• RE – Retournée
REMARQUE : Utiliser seulement lorsque votre ban-que rejette la transaction et lorsque vous n’avez pas obtenu de rapport BACS. Comptez 5 jours ouvrables après la fin de la transaction, puis communiquez avec le soutien technique avant d’effectuer la demande de modification.
EFT (TEF)/ACH (CCA) • charge (facturation)• credit (crédit)
• C – Lot complet • X – Annulée
REMARQUE : Possible seulement si la requête n’a pas encore été envoyée à la banque.
Prélèvement automatique SEPA
• mandateRequest (mandat)
• AP – Active • X – Annulée
Prélèvement automatique SEPA
• charge (facturation) • W – En attente• C – Lot complet
• X – Annulée
REMARQUE : Un prélèvement automatique SEPA peut être annulé seulement avant son date d’exécution.
2-28
mai 2019 Diagramme de transaction ddChangeStatusRequest
merchantAccount.storePwd = "myStorePWD";ddChangeStatusRequest.merchantAccount = merchantAccount;ddChangeStatusRequest.confirmationNumber = "123456"; // A valid confirmation number from a previous mandate or echeck;ddChangeStatusRequest.status = "C";//Perform the Web Services call to process the chargeDirectDebitServiceV1 ddService = new DirectDebitServiceV1();DDCheckResponseV1 ddTxnResponse = ddService.changeStatus(ddCheckRequest);
// Print out the resultString responseTxt = ddTxnResponse.code + " - " + ddTxnResponse.decision +
" - " + ddTxnResponse.description;responseTxt += "Details:" + Environment.NewLine;if (ddTxnResponse.detail != null){
for (int i = 0; i < ddTxnResponse.detail.Length; i++){
responseTxt += " - " + ddTxnResponse.detail[i].tag + " - " +ddTxnResponse.detail[i].value + Environment.NewLine;
}}responseTxt = responseTxt.Replace("\n", Environment.NewLine);System.Console.WriteLine(responseTxt);if (DecisionV1.ACCEPTED.Equals(ddTxnResponse.decision)){
System.Console.WriteLine("Transaction Successful.");}else{
System.Console.WriteLine("Transaction Failed with decision: " +ddTxnResponse.decision);
}
Diagramme de transaction ddChangeStatusRequestL’objet de document ddChangeStatusRequestV1 respecte la structure suivante :
Éléments de transaction ddChangeStatusRequestV1L’objet de document ddChangeStatusRequestV1 peut contenir les éléments suivants :
Guide de référence de l’API pour les Services Web 1.0 2-29
Transactions par prélèvement automatique (débit direct) mai 2019
Création de updateMandateRequest (mise à jour du mandat)
Vous pouvez modifier un mandat existant en effectuant une demande de modification de mandat. En réalité, vous créez un nouveau mandat à partir des informations du mandat existant, mais en y ajout-ant de nouvelles informations (par exemple, un nouveau numéro de compte bancaire).
Lorsque vous soumettez une requête ddUpdateMandateRequestV1, Paysafe règle l’état du mandat à T (Transférée). Un nouveau mandat est créé à partir des informations du mandat existant. Cependant, les trois valeurs suivantes ne sont pas modifiées si vous les précisez dans la demande de modification :
• mandateReference
• accountNum
• routingNum
Tableau 2-8 : Éléments de transaction ddChangeStatusRequestV1
Element Child Element Required Type Description
merchantAccount accountNum Oui ChaîneMax = 10
Il s’agit du numéro de compte de marchand.
storeID Oui Chaîne Max = 80
Il s’agit de l’identifiant du magasin traitant la transaction ; il sert à authentifier la requête. Paysafe le définit et le fournit au marchand comme élément du processus d’intégration.
storePwd Oui ChaîneMax = 20
Il s’agit du mot de passe du magasin traitant la transaction ; il sert à authentifier la requête. Paysafe le définit et le fournit au marchand comme élément du processus d’intégration.
confirmationNumber Conditionnel ChaîneMax = 15
Cette valeur indique la transaction pour laquelle vous avez demandé une modifica-tion d’état.Il s’agit du confirmationNumber retourné par Paysafe en réponse à la requête initiale.
status Oui Énumération Il s’agit du nouveau code d’état de la transac-tion. Les valeurs possibles sont :• C – Complété • RE – Retourné• W – En attente• X – Annulée
addendumData tag Facultatif ChaîneMax = 30
Il s’agit de données supplémentaires que le marchand peut inclure dans la requête de transaction.
value Facultatif ChaîneMax = 1024
Il s’agit de données supplémentaires que le marchand peut inclure dans la requête de transaction.
Seuls les marchands qui traitent des prélèvements automatiques SEPA peuvent effectuer ce type de requête.
2-30
mai 2019 Exemple de transaction updateMandateRequest – C#
Si vous le précisez dans la demande, les nouvelles valeurs entrées relativement à ces éléments sont importées dans le nouveau mandat.
L’état du nouveau mandat sera identique à celui du mandat existant, soit PCA (Approbation du client en attente) ou AP (Mandat approuvé). Le nouveau mandat sera lié au mandat existant, de sorte que le système sache que les informations du mandat existant ont été transférées dans le nouveau mandat.
Paysafe répond à votre demande de modification de mandat par une réponse ddCheckResponseV1. Dans cette réponse, la valeur confirmationNumber sert à identifier le nouveau mandat.
Exemple de transaction updateMandateRequest – C#Voici un exemple de transaction ddUpdateMandateRequest en C#.
// Prepare the call to the Direct Debit Web ServiceDDUpdateMandateRequestV1 ddUpdateMandateRequest = new DDUpdateMandateRequestV1();MerchantAccountV1 merchantAccount = new MerchantAccountV1();merchantAccount.accountNum = "12345678";merchantAccount.storeID = "myStoreID";merchantAccount.storePwd = "myStorePWD";ddUpdateMandateRequest.merchantAccount = merchantAccount;ddUpdateMandateRequest.confirmationNumber = "123456"; // A valid confirmation number from a previous mandate or echeck;ddUpdateMandateRequest.mandateReference = "NL95ZZZ999999991458_TEST7A";//Perform the Web Services call to process the chargeDirectDebitServiceV1 ddService = new DirectDebitServiceV1();DDCheckResponseV1 ddTxnResponse = ddService.updateMandate(ddCheckRequest);
// Print out the resultString responseTxt = ddTxnResponse.code + " - " + ddTxnResponse.decision +
" - " + ddTxnResponse.description;responseTxt += "Details:" + Environment.NewLine;if (ddTxnResponse.detail != null){
for (int i = 0; i < ddTxnResponse.detail.Length; i++){
responseTxt += " - " + ddTxnResponse.detail[i].tag + " - " +ddTxnResponse.detail[i].value + Environment.NewLine;
}}responseTxt = responseTxt.Replace("\n", Environment.NewLine);System.Console.WriteLine(responseTxt);if (DecisionV1.ACCEPTED.Equals(ddTxnResponse.decision)){
System.Console.WriteLine("Transaction Successful.");}else{
System.Console.WriteLine("Transaction Failed with decision: " +ddTxnResponse.decision);
}
Diagramme de transaction ddUpdateMandateRequestV1L’objet de document ddUpdateMandateRequestV1 respecte la structure suivante :
Guide de référence de l’API pour les Services Web 1.0 2-31
Transactions par prélèvement automatique (débit direct) mai 2019
Éléments de transaction ddUpdateMandateRequestV1L’objet de document ddUpdateMandateRequestV1 peut contenir les éléments suivants :
Table 2-9: Éléments de transaction ddUpdateMandateRequestV1
Élément Élément enfant Requis Type Description
merchantAccount accountNum Oui ChaîneMax = 10
Il s’agit du numéro de compte de marchand.
storeID Oui Chaîne Max = 80
Il s’agit de l’identifiant du magasin traitant la transaction ; il sert à authentifier la requête. Paysafe le définit et le fournit au marchand comme élément du processus d’intégration.
storePwd Oui ChaîneMax = 20
Il s’agit du mot de passe du magasin traitant la transaction ; il sert à authentifier la requête. Paysafe le définit et le fournit au marchand comme élément du processus d’intégration.
confirmationNumber Facultatif ChaîneMax = 15
Cette valeur indique le mandat que vous voulez modifier.Il s’agit du numéro de confirmation retourné par Paysafe en réponse à la requête initiale.
mandateReference Facultatif ChaîneMax = 10Pour SEPA, Max = 35
Il s’agit de la référence du mandat permettant de porter les frais au compte. Cette valeur est retournée pour le paramètre mandateReference en réponse à la requête ddMandateRequestV1. Vous devrez peut-être modifier la valeur mandateReference, par exemple, si les modal-ités de facturation ont changé et que les autres informations dans le mandat demeurent identiques.
accountNum Conditionnel ChaîneMax = 17Si IBAN, Max = 32
Pour les transactions SEPA, il s’agit du numéro IBAN (numéro de compte bancaire interna-tional) du client.Vous devrez peut-être modifier la valeur accountNum, par exemple, si les frais sont désormais portés à un compte différent de la même banque (c.-à-d., il n’est pas nécessaire de modifier le code BIC).
2-32
mai 2019 Traitement de la réponse
* Au moins un des trois éléments suivants doit être indiqué dans la requête : mandateReference, accountNum ou routingNum.
Traitement de la réponseUne transaction ddCheckResponseV1 respecte la structure suivante :
Les éléments suivants sont pertinents dans le cas d’une réponse ddCheckResponseV1 :
routingNum Conditionnel ChaîneMin = 6Max = 9Si BIC, Min = 8Max = 11
Pour les transactions SEPA, il s’agit du code BIC (code identificateur de banque) du compte bancaire du client. Si vous n’avez pas le BIC , vous pouvez soumettre la valeur sui-vante, qui est sensible à la casse: EMPTYBICVous devrez peut-être modifier la valeur routingNum, par exemple, si un client a changé de banque. Dans ce cas, il faudra aussi modifier la valeur accountNum.
Table 2-9: Éléments de transaction ddUpdateMandateRequestV1 (suite)
Élément Élément enfant Requis Type Description
Guide de référence de l’API pour les Services Web 1.0 2-33
Transactions par prélèvement automatique (débit direct) mai 2019
Tableau 2-10 : Éléments de réponse ddCheckResponseV1
Élément Élément enfant Requis Type Description
requestId Facultatif Il s’agit du seul numéro d’identification unique envoyé par Paysafe pour un enregistrement si ce dernier a été traité dans un fichier séquentiel.
confirmationNumber Oui ChaîneMax = 15
Il s’agit du numéro de confirmation retourné par Paysafe.Si cette valeur est retournée en réponse à une ddMandateRequestV1, elle sert à identifier le nouveau mandat.
merchantRefNum Conditionnel ChaîneMax = 40
Il s’agit d’un numéro d’identification (ID) unique, associé à chaque requête. La valeur est créée par le marchand et envoyée en tant qu’élément de la requête. Cette valeur n’est retournée qu’en réponse à une lookupRequest.
mandateReference Oui ChaîneMax = 20
Ceci est la référence du mandat retournée par Paysafe. Il s’agit de la val-eur entrée dans la requête ou, si celle-ci était erronée, d’une valeur générée par le système Paysafe.Pour les transactions SEPA, ceci est la référence du mandat créée par le marchand dans la requête.
decision Oui Énumération Il s’agit de l’état de la transaction. Une des valeurs suivantes sera retournée :• Accepted – La transaction a été
traitée.• Error – La tentative de transaction a
échoué en raison d’une erreur.• Declined – La transaction a été
refusée avant qu’elle soit envoyée pour traitement.
• Not Found – La requête de consulta-tion ne correspond à aucun résultat.
code Oui Entier Il s’agit d’un code numérique servant à catégoriser la réponse. Consultez la rubrique Codes de réponse à la page B-1.
actionCode Facultatif Énumération Cela indique l’action à effectuer. Les valeurs suivantes sont possibles :• C = Erreur de paramètre du client. Les
renseignements fournis par le client sont incorrects. Confirmez les rensei-gnements auprès du client.
• D = Ne pas réessayer. Les tentatives subséquentes échoueront.
• M = Erreur de paramètre du march-and. Les renseignements fournis par votre application sont incorrects. Vérifiez vos renseignements.
• R = Réessayer. Le problème est tem-poraire. La prochaine tentative réus-sira probablement.
2-34
mai 2019 Traitement de la réponse
description Facultatif ChaîneMax = 100
Il s’agit de la description accessible à l’utilisateur de l’élément code.
detail tag Facultatif ChaîneMax = 1024
Il s’agit de la classification de l’élément détail.
value Facultatif ChaîneMax = 30
Il s’agit de la description du détail.
txnTime Oui dateTime Il s’agit de la date et de l’heure du trait-ement de la transaction par Paysafe.
status Facultatif
code Conditionnel Énumération Il s’agit de l’état de la première transac-tion qui correspond à la requête de con-sultation.Les valeurs possibles sont :• AP – Mandat approuvé (Approved
mandate)• C – Lot complet (Complete batch)• CB – Récupérée (Clawed back)• CL – Transaction traitée (Cleared
transaction)• DE – Refusée (Declined)• DI – Contestée (Disputed) • E – Erreur lot (Error batch)• EX – Expirée (Expired)• F – Échec (Failed)• GR – Bon pour renversement (Good
for reversal)• MI – Intervention manuelle requise
(Manual intervention required)• PCA – Approbation du client en
attente (Pending customer approval)• PR1 – Re-Présentée 1 (Re-Presented
1)• PR2 – Re-Présentée 2 (Re-Presented
2)• PX – Annulation en attente (Pending
cancel)• RE – Retournée (Returned)• REF – Rejet définitif (Rejected final)• RV – Inversée (Reversed)• T – Transférée (Transferred)• W – En attente (Pending)• X – Annulée (Cancelled)
Tableau 2-10 : Éléments de réponse ddCheckResponseV1 (suite)
Élément Élément enfant Requis Type Description
Guide de référence de l’API pour les Services Web 1.0 2-35
Transactions par prélèvement automatique (débit direct) mai 2019
effectiveDate Conditionnel dateTime • Il s’agit de la date et de l’heure où l’état de la requête de consultation entre en vigueur.
• Lorsqu’elle est indiquée dans la paire tag/value pour l’élément detail d’une réponse à une requête de mandat, ceci est la date à laquelle le mandat devient actif (cinq jours après la mise en lot). Vous pouvez soumettre une demande de prélèvement à cette date à minuit ou postdater le prélèvement en réglant la valeur txn-Time à cette date ou à une date ultérieure. Si vous soumettez une demande de prélèvement dont la date est antérieure à la date d’entrée en vigueur du mandat, indiquée par la valeur effectiveDate, vous obtien-drez un message d’erreur.
currency Facultatif Chaîne La valeur figure dans les codes de devises du Tableau 3-15 : Codes de devises à la page 3-57. Cette valeur n’est retournée qu’en réponse à une looku-pRequest.
amount Facultatif ChaîneMax =999999999,99
Il s’agit du montant de la première transaction qui correspond à la requête de consultation.
transaction Facultatif Cette valeur n’est retournée qu’en réponse à une lookupRequest. Toutes les transactions qui correspondent à la requête de consultation sont retournées ici.
confirmationNumber Conditionnel ChaîneMax = 15
Il s’agit du numéro de confirmation retourné par Paysafe pour une transac-tion précédente.
merchantRefNum Facultatif ChaîneMax = 255
Il s’agit d’un numéro d’identification (ID) unique, associé à chaque requête. La valeur est créée par le marchand et envoyée en tant qu’élément de la requête. Cette valeur n’est retournée qu’en réponse à une lookupRequest.
txnTime Conditionnel dateTime Il s’agit de la date et de l’heure du trait-ement de la transaction par Paysafe.
status Conditionnel On retrouve les éléments code et effec-tiveDate pour la transaction. Pour obte-nir des détails, consultez l’élément status présenté dans le tableau ci-des-sus.
amount Conditionnel ChaîneMax =999999999,99
Il s’agit du montant de la requête de transaction.
Tableau 2-10 : Éléments de réponse ddCheckResponseV1 (suite)
Élément Élément enfant Requis Type Description
2-36
mai 2019 Traitement de la réponse
Pour traiter la réponse :
1. Obtenez les détails de la réponse qui sont accessibles à partir des modes get() de la réponse.
String responseTxt = ddTxnResponse.code + " - " + ddTxnResponse.decision + " - " + ddTxnResponse.description;
responseTxt += "Details:" + Environment.NewLine;if (ddTxnResponse.detail != null){
for (int i = 0; i < ddTxnResponse.detail.Length; i++){
responseTxt += " - " + ddTxnResponse.detail[i].tag + " - " +ddTxnResponse.detail[i].value + Environment.NewLine;
}}responseTxt = responseTxt.Replace("\n", Environment.NewLine);System.Console.WriteLine(responseTxt);if (DecisionV1.ACCEPTED.Equals(ddTxnResponse.decision)){
System.Console.WriteLine("Transaction Successful.");}else{
System.Console.WriteLine("Transaction Failed with decision: " +ddTxnResponse.decision);
}
2. Traitez la réponse en fonction de l’élément decision. Vous insérez le code de gestion approprié à votre application. Vous pouvez également consulter l’élément code pour obtenir un contrôle plus serré de votre application. Pour obtenir plus de détails, consultez la rubrique Codes de réponse à la page B-1.
Guide de référence de l’API pour les Services Web 1.0 2-37
Transactions par prélèvement automatique (débit direct) mai 2019
2-38
CHAPTER 3
Transactions par carte de crédit oude débit
IntroductionCe chapitre décrit comment traiter les transactions par carte de crédit ou de débit à l’aide du Service Web de traitement des transactions. Les opérations suivantes sont prises en charge :
Tableau 3-1 : Opérations prises en charge
Opération Description Type de requête
Authorization (autorisation)
Vous permet d’autoriser un montant sur la carte de crédit ou de débit d’un client. Le montant autorisé doit être réglé au cours d’une transaction de règlement ultérieure.
Consultez la rubrique Bâtir des requêtes d’achat, d’autorisation ou de vérification à la page 3-4.
Purchase (achat) Vous permet d’autoriser et de régler un montant sur la carte de crédit ou de débit d’un client à l’aide d’une seule transaction.
Verification (vérifi-cation)
Vous permet d’exécuter une vérification AVS ou CVD sur la carte de crédit d’un client, sans imputer de montant sur cette carte.
Authorization Reversal (inversion d’autorisation)
Vous permet d’inverser une partie ou la totalité d’une autori-sation existante, pourvu qu’aucun règlement (complet ou par-tiel) n’ait été traité à l'égard de cette autorisation. Ce type de transaction ne fonctionne pas pour les transactions d'achat ; cette transaction n’est utilisée que pour les autorisations.
Consultez la rubrique Bâtir des requêtes d’inversion d’autorisation à la page 3-20.
Credit (crédit) Vous permet d’annuler le débit d’un montant déjà réglé sur une carte de crédit ou de débit. Vous pouvez créditer la total-ité ou une partie d’un règlement existant. Consultez la rubrique Bâtir des
requêtes de règlement et de crédit à la page 3-23.Settlement (règle-
ment)Vous permet de régler un montant qui a préalablement été autorisé sur une carte de crédit ou de débit. Vous pouvez régler la totalité ou une partie d’une autorisation existante.
Stored Data Authorization (autorisation à par-tir de données mémorisées)
Vous permet d’autoriser un montant sur la carte de crédit ou de débit d’un client à l’aide des données sur le client qui sont mémorisées dans notre base de données. Vous n’avez qu’à fournir le minimum de renseignements, ce qui vous permet de gagner du temps et de réduire les efforts. Consultez la rubrique Bâtir des
requêtes de données mémorisées à la page 3-27.Stored Data
Purchase (achat partir de données mémorisées)
Vous permet d’autoriser et de régler un montant sur la carte de crédit ou de débit d’un client à l’aide de données sur le cli-ent qui sont mémorisées dans notre base de données. Vous n’avez qu’à fournir le minimum de renseignements, ce qui vous permet de gagner du temps et de réduire les efforts.
Cancel (annula-tion)
Vous permet d’annuler une transaction de crédit, de règle-ment, de paiement, ou de crédit indépendant. Vous pouvez annuler une de ces transactions pourvu qu’elle soit En attente, ce qui est habituellement le cas avant minuit le jour où la requête est faite. Dans certains cas, vous pouvez trouver des transactions de crédit plus anciennes En attente.
Consultez la rubrique Bâtir des requêtes d’annulation à la page 3-31.
Guide de référence de l’API pour les Services Web 1.0 3-1
Transactions par carte de crédit ou de débit mai 2019
• Les opérations Authorization, Purchase et Verification acceptent l’objet de document ccAuthRe-questV1.
• Les opérations Authorization Reversal acceptent l’objet de document ccAuthReversalRequestV1.
• Les opérations de Settlement et Credit acceptent l’objet de document ccPostAuthRequestV1.
• Les opérations Stored Data acceptent l’objet de document ccStoredDataRequestV1.
• Les opérations Cancel Settle, Cancel credit et Cancel payment acceptent l’objet de document ccCancelRequestV1.
• L’opération Payment et Independent Credit acceptent l’objet de document ccPaymentRequestV1.
• L’opération Information Lookup accepte l’objet de document ccTxnLookupRequestV1.
• L’opération Enrollment Lookup accepte l’objet de document ccEnrollmentLookupRequestV1.
• L’opération Authentication accepte l’objet de document ccAuthenticateRequestV1.
• Toutes les opérations retournent une réponse ccTxnResponseV1.
Payment (paie-ment)
Vous permet de créditer un montant sur la carte de crédit ou de débit d’un client. La transaction de paiement n’est pas liée à une autorisation existante antérieure ; le montant de la transaction n’est donc pas limité de cette manière. Consultez la rubrique Bâtir
des requêtes de paie-ment/crédit indépendant à la page 3-34.Independent
Credit (crédit indépendant)
Vous permet de créditer un montant sur la carte de crédit d’un client. La transaction de crédit indépendant n’est pas liée à une autorisation existante antérieure ; le montant de la trans-action n’est donc pas limité de cette manière.
Information Lookup (consultation des données)
Vous permet de produire un rapport à l’aide de l’API pour une plage de temps que vous précisez, afin de recevoir les don-nées concernant les transactions traités par un compte de marchand.
Consultez la rubrique Bâtir des requêtes de consultation des données à la page 3-39.
Enrollment Lookup (consultation d’inscription)
Vous permet d’établir si la carte de crédit du client est inscrite à notre programme 3D Secure.REMARQUE : Cette opération est prise en charge uniquement pour 3D Secure 1.0.2.
Consultez la rubrique Bâtir des requêtes de consultation d’inscription à la page 3-43.
Authentication (authentification)
Vous permet d'envoyer une requête d'authentification, afin de valider le mot de passe d’un titulaire de carte dans le cas des cartes de crédit inscrites au programme 3D Secure. REMARQUE : Cette opération est prise en charge uniquement pour 3D Secure 1.0.2.
Consultez la rubrique Bâtir des requêtes d’authentification à la page 3-46.
La disponibilité des types d’opérations pour les cartes de crédit est attribuée aux marchands sur une base individuelle, puisque ce ne sont pas toutes les banques des marchands qui acceptent toutes les opérations. Si vous avez des questions, communiquez avec votre gestionnaire de compte.
Tableau 3-1 : Opérations prises en charge (suite)
Opération Description Type de requête
3-2
mai 2019 .Exemple – .NET
.Exemple – .NET
Pour bâtir l’exemple pour .NET :
1. Créez un nouveau projet.
2. Ajoutez une référence Web.
Guide de référence de l’API pour les Services Web 1.0 3-3
Transactions par carte de crédit ou de débit mai 2019
3. Saisissez l’URL WSDL et cliquez sur le bouton Ajouter une référence.
Le client Web est maintenant créé.
4. Bâtissez la requête et traitez la réponse :
• Consultez la rubrique Bâtir des requêtes d’achat, d’autorisation ou de vérification à la page 3-4.
• Consultez la rubrique Bâtir des requêtes d’inversion d’autorisation à la page 3-20.
• Consultez la rubrique Bâtir des requêtes de règlement et de crédit à la page 3-23.
• Consultez la rubrique Bâtir des requêtes de données mémorisées à la page 3-27.
• Consultez la rubrique Bâtir des requêtes d’annulation à la page 3-31.
• Consultez la rubrique Bâtir des requêtes de paiement/crédit indépendant à la page 3-34.
• Consultez la rubrique Bâtir des requêtes de consultation d’inscription à la page 3-43.
• Consultez la rubrique Bâtir des requêtes d’authentification à la page 3-46.
• Consultez la rubrique Traitement de la réponse à la page 3-49.
Bâtir des requêtes d’achat, d’autorisation ou de vérificationLes requêtes Purchase, Authorization et Verification requièrent l’objet de document ccAuthRequestV1. La présente rubrique décrit la structure d’une ccAuthRequestV1 et la façon de la bâtir. Pour obtenir des
3-4
mai 2019 Exemple de transaction d’achat – C#
détails sur les éléments requis, consultez le Tableau 3-2 : Éléments de transaction ccAuthRequestV1 à la page 3-8.
Exemple de transaction d’achat – C#
Voici un exemple de transaction d’achat en C#.
//Prepare the call to the Credit Card Web ServiceCCAuthRequestV1 ccAuthRequest = new CCAuthRequestV1();MerchantAccountV1 merchantAccount = new MerchantAccountV1();merchantAccount.accountNum = "12345678";merchantAccount.storeID = "myStoreID";merchantAccount.storePwd = "myStorePWD";ccAuthRequest.merchantAccount = merchantAccount;ccAuthRequest.merchantRefNum = "Ref-12345";ccAuthRequest.amount = "10.00";CardV1 card = new CardV1();card.cardNum = "4653111111111111";CardExpiryV1 cardExpiry = new CardExpiryV1();cardExpiry.month = 11;cardExpiry.year = 2006;card.cardExpiry = cardExpiry;card.cardType = CardTypeV1.VI;card.cardTypeSpecified = true;card.cvdIndicator = 1;card.cvdIndicatorSpecified = true;card.cvd = "111";ccAuthRequest.card = card;BillingDetailsV1 billingDetails = new BillingDetailsV1();billingDetails.cardPayMethod = CardPayMethodV1.WEB; //WEB = Card Number ProvidedbillingDetails.cardPayMethodSpecified = true;billingDetails.firstName = "Jeanne";billingDetails.lastName = "Tremblay";billingDetails.street = "123 rue Principale";billingDetails.city = "Alma";billingDetails.Item = (object) StateV1.QC; // QuébecbillingDetails.country = CountryV1.CA; // CanadabillingDetails.countrySpecified = true;billingDetails.zip = "G0W 1G0";billingDetails.phone = "555-555-5555";billingDetails.email = "[email protected]";ccAuthRequest.billingDetails = billingDetails;ccAuthRequest.customerIP = "127.0.0.1";ccAuthRequest.productType = ProductTypeV1.M; //M = Both Digital and Physical(e.g., software downloaded followed by media shipment)ccAuthRequest.productTypeSpecified = true;
Tous les éléments facultatifs qui requièrent des types de données non nullables (ordinaires) (par ex., int ou enum) doivent avoir leur attribut specified établi à true lorsque les valeurs sont fixées pour ces éléments. Consultez l’élément cardType dans l’exemple ci-dessous.
Pour convertir cette requête en requête d’autorisation ou de vérification, il suffit de remplacer la valeur « ccPurchase » (soulignée ci-dessous) par « ccAuthorize » ou « ccVerification » respectivement.
Guide de référence de l’API pour les Services Web 1.0 3-5
Transactions par carte de crédit ou de débit mai 2019
// Perform the Web Services call for the purchaseCreditCardServiceV1 ccService = new CreditCardServiceV1();CCTxnResponseV1 ccTxnResponse = ccService.ccPurchase(ccAuthRequest);
// Print out the resultString responseTxt = ccTxnResponse.code + " - " + ccTxnResponse.decision + " - "
+ ccTxnResponse.description + Environment.NewLine;
if (ccTxnResponse.detail != null) {
for (int i = 0; i < ccTxnResponse.detail.Length; i++) {
responseTxt += " - " + ccTxnResponse.detail[i].tag + " - " +ccTxnResponse.detail[i].value + Environment.NewLine;
}}responseTxt = responseTxt.Replace("\n", Environment.NewLine);System.Console.WriteLine(responseTxt);if (DecisionV1.ACCEPTED.Equals(ccTxnResponse.decision)){
System.Console.WriteLine("Transaction Successful.");}else{
System.Console.WriteLine("Transaction Failed with decision: " +ccTxnResponse.decision);
}
3-6
mai 2019 Diagramme de transaction ccAuthRequestV1
Diagramme de transaction ccAuthRequestV1Une transaction ccAuthRequestV1 respecte la structure suivante :
Guide de référence de l’API pour les Services Web 1.0 3-7
Transactions par carte de crédit ou de débit mai 2019
Éléments de transaction ccAuthRequestV1L’objet de document ccAuthRequestV1 peut contenir les éléments suivants :
Tableau 3-2 : Éléments de transaction ccAuthRequestV1
Élément Élément enfant Requis Type Description
merchantAccount accountNum Oui ChaîneMax = 10
Il s’agit du numéro de compte de marchand.
storeID Oui Chaîne Max = 80
Il s’agit de l’identifiant du magasintraitant la transaction ; il sert à authentifier la requête. Paysafe ledéfinit et le fournit au marchand comme élément du processus d’intégration.
storePwd Oui ChaîneMax = 20
Il s’agit du mot de passe du magasin traitant la transaction ; ilsert à authentifier la requête. Pay-safe le définit et le fournit au marchand comme élément du processus d’intégration.
merchantRefNum Oui ChaîneMax = 255
Il s’agit d’un numéro d’identifica-tion (ID) unique, associé à chaquerequête. La valeur est créée par lemarchand et envoyée en tant qu’élément de la requête.
customerTokenId Pour usage interne seulement.
amount Oui ChaîneMax =999999999.99
Il s’agit du montant de la requête de transaction. REMARQUE : Bien qu’elle soit obligatoire, cette valeur sera ignorée dans le cas d’une transac-tion ccVerification.
card cardNum Oui Chaîne Min = 8Max = 20
Il s’agit du numéro de la carte util-isée pour la transaction.
cardExpiry Oui L'élément enfant cardExpiry a deux autres éléments enfants – month et year.
Élément enfant de cardExpiry
month Oui Entier Max = 2
Il s’agit du mois d’expiration de la carte de crédit.
year Oui EntierLongueur = 4
Il s’agit de l’année d’expiration dela carte de crédit.
3-8
mai 2019 Éléments de transaction ccAuthRequestV1
cardType Facultatif Énumération Il s’agit du type de carte utilisée pour la transaction. Les valeurs possibles sont :• AM = American Express• DC = Diners Club• DI = Discover• JC = JCB• MC = Mastercard• MD = Maestro• SF = Swiff• SO = Solo• VD = Visa Debit• VE = Visa Electron• VI = Visa
issueNum Facultatif Entier Max = 2
Le numéro à un ou deux chiffres situé à l’avant de la carte, après son numéro.
REMARQUE : L’élément issueNumpeut uniquement être utilisé lor-sque cardType correspond à MD (Maestro) ou SO (Solo).
cvdIndicator Facultatif Entier Longueur = 1
Il s’agit de l’état de l’information de lavaleur CVD. Les valeurs possibles sont :• 0 – Le client n’a pas fourni de
valeur. • 1 – Le client a fourni une valeur.• 2 – La valeur est illisible. • 3 – La valeur n’apparaît pas sur
la carte.
REMARQUE : L’élément cvdIndi-cator est obligatoire dans le cas d’une transaction ccVerification. Aussi, veuillez prendre note que même si cet élément est facultatif,il est requis lorsque plusieurs véri-fications sont liées aux risques et nous vous conseillons fortement de l’inclure pour éviter les trans-actions en échec.
cvd Conditionnel ChaîneLongueur = 3 ou 4
Le code de sécurité à trois ou qua-tre chiffres situé sur la carte, aprèsson numéro. Ce code n’apparaît pas sur les documents imprimés.
REMARQUE : L’élément cvd est obligatoire lorsque la valeur de l’élément cvdIndicator est 1.
Tableau 3-2 : Éléments de transaction ccAuthRequestV1 (suite)
Élément Élément enfant Requis Type Description
Guide de référence de l’API pour les Services Web 1.0 3-9
Transactions par carte de crédit ou de débit mai 2019
authentication
Utilisez cet élément uniquement dans le cas des requêtes ccAutho-rize ou ccPurchase.
indicator Facultatif Entier Valeur = 1
Il s’agit du code indicateur de commerce électronique, une val-eur à deux chiffres retournée par l’émetteur de la carte de crédit indiquant si le titulaire de la cartea été authentifié avec succès. Les valeurs possibles sont :
Visa/Amex/JCB• 05 – Identifie une transaction
authentifiée avec succès.• 06 – Identifie une tentative de
transaction authentifiée.• 07 – Identifie une transaction
qui n’a pas été authentifiée.
Mastercard• 01 – Identifie une transaction
qui n’a pas été authentifiée.• 02 – Identifie une transaction
authentifiée avec succès.
Cette valeur est retournée dans l’élément enfant eci de l’élément tdsAuthenticateResponse de la réponse ccTxnResponseV1 à votre requête ccAuthenticateRequestV1.
cavv Facultatif ChaîneMax = 80
Il s’agit de la valeur de vérificationde l’authentification du titulaire de la carte.
Cette valeur est retournée dans l’élément enfant cavv de l’élémenttdsAuthenticateResponse de la réponse ccTxnResponseV1 à votre requête ccAuthenticateRequestV1.
xid Facultatif ChaîneMax = 80
Il s’agit de l’identifiant de transac-tion retourné par l’émetteur de lacarte.
Cette valeur est retournée dans l’élément enfant xid de l’élément tdsAuthenticateResponse de la réponse ccTxnResponseV1 à votre requête ccAuthenticateRequestV1.
REMARQUE : Ceci n’existe que pour 3D Secure 1.0.2.
enrollmentStatus Facultatif Énumération Cela indique si le titulaire de la carte est inscrit ou non à 3D Secure. Les valeurs possibles sont:• Y – Authentification disponible• N – Titulaire de la carte non
inscrit• U – Authentification non dis-
ponible• E – Erreur
REMARQUE : Ceci n’existe que pour 3D Secure 1.0.2.
Tableau 3-2 : Éléments de transaction ccAuthRequestV1 (suite)
Élément Élément enfant Requis Type Description
3-10
mai 2019 Éléments de transaction ccAuthRequestV1
authenticationStatus Facultatif Énumération Cela indique le résultat de la requête d’authentification. Les valeurs possibles sont :• Y – Le titulaire de la carte a
authentifié avec succès sa carteauprès de l’émetteur.
• A – Le titulaire de la carte a tenté de l'authentifier.
• N – Le titulaire de la carte n’a pas réussi à authentifier sa carte auprès de l’émetteur.
• U – L’authentification par l’émetteur de la carte n’était pas disponible.
• E – Erreur• R – Transaction rejetée
REMARQUE : La valeur R n’existe que pour 3D Secure 2.
directoryServerTransactionId Facultatif ChaîneMax = 36
Il s'agit de l'ID de transaction de serveur unique requis pour Mastercard.REMARQUE : Ceci n’existe que pour 3D Secure 2 et n’est requis que pour la marque Mastercard.
threeDSecureVersion Facultatif ChaîneMax = 5Min = 8
Ceci est la version du protocole 3DSecure.REMARQUE : Si aucune version n’est spécifiée dans la requête, la valeur par défaut est 1.0.2 et est répercutée dans la réponse.
authCode Facultatif ChaîneMax = 50
Il s’agit du code d’autorisation attribué par la banque émettrice et retourné par Paysafe pour une transaction antérieure. REMARQUE : N’incluez cet élé-ment que si Paysafe vous demande de le faire.
billingDetails cardPayMethod Facultatif Énumération Il s’agit de comment la carte a étéprésentée pour la transaction. Lesvaleurs possibles sont :• WEB – Numéro de la carte
fourni en ligne• TEL – Numéro de la carte fourni
par téléphone• P – Transaction avec carte• PD – Transaction avec carte dif-
féré• D – Différé
REMARQUE : N’incluez cet élé-ment que si Paysafe vous demande de le faire.
firstName Facultatif Chaîne Max = 40
Il s’agit du prénom du client.
Tableau 3-2 : Éléments de transaction ccAuthRequestV1 (suite)
Élément Élément enfant Requis Type Description
Guide de référence de l’API pour les Services Web 1.0 3-11
Transactions par carte de crédit ou de débit mai 2019
lastName Facultatif Chaîne Max = 40
Il s’agit du nom de famille du cli-ent.
street Facultatif ChaîneMax = 50
Il s’agit de la première ligne de l’adresse municipale du client.
REMARQUE : L’élément street estobligatoire lorsque vous faites le traitement d’une transaction ccVerification.
street2 Facultatif ChaîneMax = 50
Il s’agit de la deuxième ligne de l’adresse municipale du client.
city Facultatif ChaîneMax = 40
Il s’agit de la ville de résidence duclient.
state/region Facultatif Si state (État), ÉnumérationSi region (région), alors ChaîneMax = 40
Il s’agit de l’État, de la province oude la région de résidence du cli-ent.
Fournir la liste des États ou prov-inces pour les adresses à l’intérieur des États-Unis ou du Canada. Fournir la liste des régions pour les adresses à l’extérieur des États-Unis ou du Canada.
Consultez la rubrique Annexe C : Codes géographiques pour con-naître les bons codes à utiliser.
country Facultatif Énumération Il s’agit du pays de résidence du client. Consultez la rubrique Codes de pays à la page C-3 pour connaître les bons codes à utiliser.
zip Obligatoire ChaîneMax = 10
Si le pays est États-Unis, il s'agit du code Zip du client ; sinon, il s'agit de son code postal.
phone Facultatif ChaîneMax = 40
Il s’agit du numéro de téléphone du client.
email Facultatif ChaîneMax = 100
Il s’agit de l’adresse de courriel duclient.
shippingDetails carrier Facultatif Énumération Il s’agit du transporteur de l’envoi.Les valeurs possibles sont :• APC = APC Overnight• APS = AnPost• CAD = Service postal du Canada• DHL• FEX = FedEx• RML = Royal Mail• UPS = United Parcel Service• USPS = United States Postal
Service• AUTRE
Tableau 3-2 : Éléments de transaction ccAuthRequestV1 (suite)
Élément Élément enfant Requis Type Description
3-12
mai 2019 Éléments de transaction ccAuthRequestV1
shipMethod Facultatif Énumération Le mode d'expédition. Les valeurs possibles sont :• N = Jour suivant/de nuit• T = Deux jours• C = Coût le plus bas• O = Autre
firstName Facultatif ChaîneMax = 40
Il s’agit du prénom du destina-taire.
lastName Facultatif ChaîneMax = 40
Il s’agit du nom de famille du des-tinataire.
street Facultatif ChaîneMax = 50
Il s’agit de la première ligne de l’adresse municipale du destina-taire.
street2 Facultatif Chaîne Max = 50
Il s’agit de la deuxième ligne de l’adresse municipale du destina-taire.
city Facultatif ChaîneMax = 40
Il s’agit de la ville de résidence dudestinataire.
state/region Facultatif Si state (État), ÉnumérationSi region (région), alors ChaîneMax = 40
Il s’agit de l’État, de la province oude la région de résidence du desti-nataire.
Fournir la liste des États ou prov-inces pour les adresses à l’intérieur des États-Unis ou du Canada. Fournir la liste des régions pour les adresses à l’extérieur des États-Unis ou du Canada.
Consultez la rubrique Annexe C : Codes géographiques pour con-naître les bons codes à utiliser.
country Facultatif Énumération Il s’agit du pays de résidence du destinataire.
zip Facultatif ChaîneMax = 10
Si le pays est États-Unis, il s'agit du code Zip du destinataire ; sinon, il s'agit de son code postal.
phone Facultatif ChaîneMax = 40
Il s’agit du numéro de téléphone du destinataire.
email Facultatif ChaîneMax = 100
Il s’agit de l’adresse de courriel dudestinataire.
Tableau 3-2 : Éléments de transaction ccAuthRequestV1 (suite)
Élément Élément enfant Requis Type Description
Guide de référence de l’API pour les Services Web 1.0 3-13
Transactions par carte de crédit ou de débit mai 2019
recurring Facultatif REMARQUE : Vous ne pouvez pasinclure à la fois l’élément recur-ring et l’élément storedCredentialdans la même demande d’autori-sation. Paysafe recommande d’utiliser storedCredential.
recurringIndicator Conditionnel Énumération Utilisez ce paramètre pour indiquer s’il s’agit d’une transac-tion initiale ou d’une répétition detransaction d’un client précis pour lequel vous traiterez des transactions récurrentes.
Selon la passerelle de traitement que vous utilisez, si la valeur pourune répétition de transaction est fixée à R, la passerelle pourra êtreplus indulgente à l’égard de cer-taines exigences comme les don-nées CVD ou les renseignements concernant l’adresse, en autori-sant la requête sans ces données.
Les valeurs possibles sont :• I – Initiale récurrente • R – Ultérieure récurrente
originalConfirmationNumber Conditionnel ChaîneMax = 15
Si c’est une transaction récur-rente, il s’agit du numéro de con-firmation renvoyé par Paysafe pour la transaction initiale de la série. Si cette valeur est incluse, Paysafe pourra identifier de façonplus précise une Autorisation à régler ou un Règlement à créditer,si l’une de ces transactions est requise à l’avenir.
previousConfirmationNumber Conditionnel Chaîne Max = 15
Si c’est une transaction récur-rente, il s’agit du numéro de con-firmation renvoyé par Paysafe pour la transaction la plus récentede la série. Si cette valeur est incluse, Paysafe pourra identifier de façon plus précise une Autori-sation à régler ou un Règlement àcréditer, si l’une de ces transac-tions est requise à l’avenir.
Tableau 3-2 : Éléments de transaction ccAuthRequestV1 (suite)
Élément Élément enfant Requis Type Description
3-14
mai 2019 Éléments de transaction ccAuthRequestV1
storedCredential Facultatif Ce paramètre est utilisé pour identifier les demandes d’autori-sation qui utilisent des numéros de carte de crédit stockés par les marchands, afin d’améliorer les taux d’autorisation et de réduire la fraude. REMARQUE : Vous ne pouvez pas inclure à la fois l’élément recur-ring et l’élément storedCredential dans la même demande d’autori-sation. Paysafe recommande d’utiliser storedCredential.Si vous n’envoyez pas cet élémentet que vous envoyez l’élément recurringIndicator avec la valeur R, type sera réglé par défaut sur RECURRING et occurrence sera réglé par défaut sur SUBSEQUENT.Si recurringIndicator est envoyé avec la valeur I, type sera réglé pardéfaut sur RECURRING et occur-rence sera réglé par défaut sur INI-TIAL.
type Facultatif Énumération Ceci spécifie le type de requête encours. Les valeurs possibles sont :• ADHOC – Requête ad hoc initiée
par le consommateur• TOPUP – Requête non planifiée
lancée par un marchand lor-sque le solde d’un consomma-teur est inférieur à une limite fixée
• RECURRING – Demande récur-rente planifiée, initiée par le marchand
occurrence Facultatif Énumération Ceci spécifie si cette requête est initiale (INITIAL) ou récurrente (RECURRING). Les valeurs pos-sibles sont :• INITIAL – Utilisé lorsque c’est la
première fois que le consom-mateur utilise cette carte de crédit
• RECURRING – Utilisé lorsque le consommateur utilise cette carte de crédit pour des requêtes ultérieures
REMARQUE : La valeur de la cartecvd est requise lorsque ce paramètre est définie sur INITIAL.
customerIP Facultatif ChaîneMax = 50
Il s’agit de l’adresse IP du client.
Tableau 3-2 : Éléments de transaction ccAuthRequestV1 (suite)
Élément Élément enfant Requis Type Description
Guide de référence de l’API pour les Services Web 1.0 3-15
Transactions par carte de crédit ou de débit mai 2019
productType Facultatif Énumération Il s’agit du type de produit vendu.Les valeurs possibles sont :• P (Biens matériels) • D (Produits numériques)• C (Contenu numérisé) • G (Bon-cadeau ou argent élec-
tronique) • S (Logiciel contributif) • M (Numérique et Matériel) • R (Réapprovisionnement de
compte)
targetVirtualAccount Non Cet élément ne s’applique pas auxtransactions de cartes de crédit.
cardRiskService Non Pour fins à l’interne seulement.
dupeCheck Facultatif Booléen Cela valide que la requête n’est pas en double. On considère qu’une requête est en double lor-sque cardNum, amount et merchantRefNum sont identiques.
sdk version Conditionnel ChaîneMax = 20
Il s’agit de la version de SDK util-isée, le cas échéant.
Requis si l’élément sdk est fourni.
platform Conditionnel ChaîneMax = 10
Il s’agit de la langue d’intégration de SDK utilisée (par ex., Java, .NET).
Requis si l’élément sdk est fourni.
provider Conditionnel ChaîneMax = 20
Il s’agit de l’auteur de SDK utilisé.Réglez cette valeur à « op » lor-sque le SDK est fourni par Paysafe.
Requis si l’élément sdk est fourni.
addendumData tag Facultatif ChaîneMax = 30
Il s’agit de données supplémen-taires qui peuvent être incluses dans la requête de transaction. Consultez la rubrique Paires éti-quette/valeur addendumData à lapage 3-19 pour obtenir plus de détails.
value Facultatif ChaîneMax = 1024
Il s’agit de données supplémen-taires qui peuvent être incluses dans la requête de transaction. Consultez la rubrique Paires éti-quette/valeur addendumData à lapage 3-19 pour obtenir plus de détails.
Tableau 3-2 : Éléments de transaction ccAuthRequestV1 (suite)
Élément Élément enfant Requis Type Description
3-16
mai 2019 Éléments de transaction ccAuthRequestV1
merchantDescriptorREMARQUE : Ce paramètre n’est pas pris en charge par toutes les passerelles de traite-ment. Communiquez avec votre gestionnaire de compte pour obtenir plus de détails.
dynamicDescriptor Facultatif ChaîneMax = 25
Il s’agit du descripteur du march-and qui apparaîtra sur le relevé decarte de crédit du client.
phone Facultatif ChaîneMax = 13
Il s’agit du numéro de téléphone du marchand qui sera joint au descripteur du marchand sur le relevé de carte de crédit du client.
accordDREMARQUE : N’incluez cet élément que si Paysafe vous demande de le faire.
financingType Conditionnel Énumération Ceci est le type de financement offert. Les valeurs possibles sont :• D – Financement par paiement
différé • E – Financement en paiements
égaux
plan Conditionnel ChaîneMax = 3
Ceci est le numéro du plan pour cette opération de financement.
gracePeriod Facultatif Entier Max = 2
Ceci est la période de grâce, en mois, associée aux transactions de paiements différés.
term Facultatif Entier Max = 2
Ceci le nombre de paiements, à raison d’un par mois, associé aux transactions de paiements égaux.
description Facultatif ChaîneMax = 255
Il s’agit d’une description de la transaction, fournie par le march-and.
cardEntryMode Facultatif Énumération Il s’agit de la méthode utilisée pour recueillir les renseignementssur la carte. Les valeurs possibles sont :• SWIPED – Un lecteur de carte a
été utilisé.• MANUAL – Le numéro de la
carte a été saisi manuellement.
geoLocation Facultatif Il s’agit de l’emplacement géo-graphique où la transaction mobile a été effectuée.
latitude Conditionnel ChaîneMax = 24
Il s’agit de la latitude à laquelle latransaction mobile a été effectuée(par ex., 44.903889).
longitude Conditionnel ChaîneMax = 24
Il s’agit de la longitude à laquelle la transaction mobile a été effec-tuée. (par ex., -77.255123).
walletTransactionId Pour usage interne seulement.
profile dateOfBirth Conditionnel Ce champ vous permet d’enregis-trer la date de naissance du titu-laire, si vous en avez. Il peut être utilisé pour aider à authentifier l’identité du client avec un servicede validation par une tierce par-tie.
Tableau 3-2 : Éléments de transaction ccAuthRequestV1 (suite)
Élément Élément enfant Requis Type Description
Guide de référence de l’API pour les Services Web 1.0 3-17
Transactions par carte de crédit ou de débit mai 2019
Élément enfant de dateOfBirth
day Oui Entier Min = 1Max = 31
Il s’agit du jour de naissance du client.
month Oui Entier Min = 1Max = 12
Il s’agit du mois de naissance du client.
year Oui Entier Min = 1900Max = 9999
Il s’agit de l’année de naissance duclient.
visaAdditionalAuthData REMARQUE : Cet élément est pris en charge pour Visa et Mastercard. Le destinataire est réputé être lapersonne ou la partie ayant une relation contractuelle avec le marchand ou l’institution financière. Celui-ci peut ne pas être le titulaire de la carte. Par exemple, il pourrait s’agir d’un parent qui verse desfonds dans le compte d’épargne de son enfant. Par conséquent, les informations ne devraient pas êtrerecueillies à partir de la page de titulaire de la carte, mais devraient plutôt être transmises en arrière-plan, à partir des dossiers du marchand.Incluez cet élément si votre code de catégorie de marchand est 6012 et votre adresse commerciale enregistrée est au Royaume-Uni. Si vous avez des questions, contactez votre gestionnaire de compte.Tous les champs sont facultatifs, mais des amendes peuvent s’appliquer si les données ne sont pas systématiquement fournies et si les rétrofacturations persistent.
recipientDateOfBirth Facultatif
Élément enfant de recipientDateOfBirth
day Conditionnel Entier Min = 1Max = 31
Il s’agit du jour de naissance du destinataire.
month Conditionnel Entier Min = 1Max = 12
Il s’agit du mois de naissance du destinataire.
year Conditionnel Entier Min = 1900Max = 9999
Il s’agit de l’année de naissance dudestinataire.
recipientZip Facultatif ChaîneMax = 10
Il s’agit du code postal du destina-taire. REMARQUE : Les trois derniers caractères ne sont pas transmis au réseau bancaire.
recipientLastname Facultatif ChaîneMax = 40
Il s’agit du nom de famille du des-tinataire. REMARQUE : Seuls les six pre-miers caractères sont transmis auréseau bancaire.
Tableau 3-2 : Éléments de transaction ccAuthRequestV1 (suite)
Élément Élément enfant Requis Type Description
3-18
mai 2019 Paires étiquette/valeur addendumData
Paires étiquette/valeur addendumData
Le tableau suivant contient les paires étiquette/valeur compatibles avec l’élément addendumData.
recipientAccountNumber Facultatif ChaîneMax = 25
Il s’agit du numéro du compte du destinataire, par exemple le numéro du contrat de prêt ou l’ID de client. Si le destinataire utilise une carte prépayée, le numéro complet de la carte peut être transmis. REMARQUE : Seuls les six pre-miers caractères et les quatre der-niers caractères sont envoyés au réseau bancaire. Ceux-ci sont masqués dans le module d’administration et dans les rap-ports, conformément à la norme PCI (Payment Card Industry).
Certaines passerelles de traitement peuvent ne pas prendre en charge toutes les paires éti-quette/valeur addendumData. Communiquez avec votre gestionnaire de compte pour obtenir plus de détails.
Tableau 3-3 : Paires étiquette/valeur addendumData
Étiquette Valeur
CUST_ACCT_OPEN_DATE Il s’agit de la date à laquelle le compte de marchand a été ouvert.Format = aaaammjj
CUSTOMER_ID Il s’agit d’un numéro d’identification utilisé par le marchand. Longueur maxi-mum de 64 caractères numériques.
CUSTOMER_SESSION_ID Cette chaîne est utilisée pour lancer un appel de consultation à l’aide d’un pro-fileur de dispositif. La même chaîne doit être utilisée comme identifiant de ses-sion dans le JavaScript de profil sur la page HTML que vous présentez à votre client afin de profiler le dispositif. Les caractères acceptés sont : [a-z][A-Z][_][-]
KEYWORD Cette valeur peut correspondre au texte choisi par le marchand, par exemple, utilisé pour les fins de rapports dans le module d’administration de Paysafe. Vous pouvez par exemple vous en servir comme étiquette pour identifier la transaction ou le produit acheté à votre site.• Longueur maximum de 255 caractères alphanumériques. • Peut être précisé plus d’une fois en utilisant une valeur différente chaque fois. • Valide pour les objets CCAuthRequestV1 et CCStoredDataRequestV1.
MERCHANT_COUNTRY_CODE Il s’agit d’un code de pays à deux caractères. La valeur n’est pas validée.
MERCHANT_SIC_CODE Il s’agit du code ISO standard applicable à l’industrie (SIC) du marchand. C’est une chaîne numérique composée de quatre caractères.
MERCHANT_ZIP_CODE Longueur maximum de 10 caractères alphanumériques.
Tableau 3-2 : Éléments de transaction ccAuthRequestV1 (suite)
Élément Élément enfant Requis Type Description
Guide de référence de l’API pour les Services Web 1.0 3-19
Transactions par carte de crédit ou de débit mai 2019
Bâtir des requêtes d’inversion d’autorisationLes requêtes d’inversion d’autorisation vous permettent d’inverser une partie ou la totalité d’une autor-isation existante, pourvu qu’aucun règlement (complet ou partiel) n’ait été traité à l’égard de cette autorisation.
Les requêtes Authorization Reversal requièrent l’objet de document ccAuthReversalRequestV1. La présente rubrique décrit la structure d’une requête ccAuthReversalRequestV1 et la façon de la bâtir. Pour obtenir des détails sur les éléments requis, consultez le Tableau 3-4 : Éléments de transaction ccAuthReversalRequestV1 à la page 3-22.
Exemple d’une transaction d’inversion d’autorisation – C#Voici un exemple de transaction d’inversion d’autorisation en C#.
//Prepare the call to the Credit Card Web ServiceCCAuthReversalRequestV1 authReversalRequest = new CCAuthReversalRequestV1();MerchantAccountV1 merchantAccount = new MerchantAccountV1();merchantAccount.accountNum = "12345678";merchantAccount.storeID = "myStoreID";merchantAccount.storePwd = "myStorePWD";authReversalRequest.merchantAccount = merchantAccount;
PRODUCT_TYPE Il s’agit du type de produit acheté. Les valeurs possibles sont :• P – Biens matériels• D – Produits numériques• C – Contenu numérisé• G – Bon-cadeau ou argent électronique• S – Logiciel contributif• M – Numérique et matériel• R – Réapprovisionnement de compte (par ex., renouvellement d’abonne-
ment)
PRODUCT_CODE Il s’agit du code de produit de l’article acheté. Longueur maximum de 18 car-actères alphanumériques.
SERVICE_REQUEST_CURRENCYREMARQUE : Cette paire étiquette/valeur peut être ajoutée à l’objet de document ccAu-thRequestV1 uniquement (c.-à-d. dans le cas des requêtes de transaction d’autorisation, d’achat et de vérification de carte).
Ajoutez cette paire étiquette/valeur afin de faire inclure la devise du compte de marchand dans la réponse de transaction.Les valeurs possibles sont :• on• off
USER_DATA_04 Il s’agit d’un champ défini par l’utilisateur. Longueur maximum de 255 car-actères alphanumériques.
USER_DATA_05 Il s’agit d’un champ défini par l’utilisateur. Longueur maximum de 255 car-actères alphanumériques.
USER_DATA_06 Il s’agit d’un champ défini par l’utilisateur. Longueur maximum de 255 car-actères alphanumériques.
Vous pouvez seulement vous servir des transactions d’inversion d’autorisation pour inverser les autor-isations. Vous ne pouvez pas inverser les transactions d’achat.
Tableau 3-3 : Paires étiquette/valeur addendumData (suite)
Étiquette Valeur
3-20
mai 2019 Diagramme de transaction ccAuthReversalRequestV1
authReversalRequest.confirmationNumber = "115147689";authReversalRequest.merchantRefNum = "AR2";authReversalRequest.reversalAmount = "18.00";
// Perform the Web Services call for the Auth ReversalCreditCardServiceV1 ccService = new CreditCardServiceV1();CCTxnResponseV1 ccTxnResponse = ccService.ccAuthorizeReversal(authReversalRequest);
// Print out the resultString responseTxt = ccTxnResponse.confirmationNumber + " - " + ccTxnResponse.code + " - " + ccTxnResponse.decision + " - " + ccTxnResponse.description;responseTxt += Environment.NewLine;responseTxt += "Details:" + Environment.NewLine;if (ccTxnResponse.detail != null){
for (int i = 0; i < ccTxnResponse.detail.Length; i++){
responseTxt += " - " + ccTxnResponse.detail[i].tag + " - " + ccTxnResponse.detail[i].value + Environment.NewLine;
}}responseTxt = responseTxt.Replace("\n", Environment.NewLine);System.Console.WriteLine(responseTxt);consoleTextBox.Text = responseTxt;if (DecisionV1.ACCEPTED.Equals(ccTxnResponse.decision)){
System.Console.WriteLine("Transaction Successful.");}else{
System.Console.WriteLine("Transaction Failed with decision: " + ccTxnResponse.decision);}
Diagramme de transaction ccAuthReversalRequestV1Une transaction ccAuthReversalRequestV1 respecte la structure suivante :
Guide de référence de l’API pour les Services Web 1.0 3-21
Transactions par carte de crédit ou de débit mai 2019
Éléments de transaction ccAuthReversalRequestV1L’objet de document ccAuthReversalRequestV1 contient les éléments suivants :
Tableau 3-4 : Éléments de transaction ccAuthReversalRequestV1
Élément Élément enfant
Requis Type Description
merchantAccount accountNum Oui ChaîneMax = 10
Il s’agit du numéro de compte de marchand.
storeID Oui Chaîne Max = 80
Il s’agit de l’identifiant du magasin traitant la transaction ; il sert à authentifier la requête. Paysafe le définit et le fournit au marchand comme élément du processus d’intégration.
storePwd Oui ChaîneMax = 20
Il s’agit du mot de passe du magasin traitant la transaction ; il sert à authentifier la requête. Paysafe le définit et le fournit au marchand comme élément du processus d’intégration.
confirmationNumber Oui ChaîneMax = 15
Il s’agit du numéro de confirmation renvoyé par Paysafe pour l’autorisation que vous voulez inverser.
merchantRefNum Oui ChaîneMax = 255
Il s’agit d’un numéro d’identification (ID) unique, associé à chaque requête. La valeur est créée par le marchand et envoyée en tant qu’élément de la requête.
3-22
mai 2019 Bâtir des requêtes de règlement et de crédit
Bâtir des requêtes de règlement et de créditLes requêtes de règlement et de crédit requièrent l’objet de document ccPostAuthRequestV1. La présente rubrique décrit la structure d’une requête ccPostAuthRequestV1 et la façon de la bâtir. Pour obtenir des détails sur les éléments requis, consultez le Tableau 3-5 : Éléments de transaction ccPostAu-thRequestV1 à la page 3-25.
Exemple de règlement – C#Voici un exemple de règlement en C#.
//Prepare the call to the Credit Card Web ServiceCCPostAuthRequestV1 ccPostAuthRequest = new CCPostAuthRequestV1();ccPostAuthRequest.confirmationNumber = "123456";MerchantAccountV1 merchantAccount = new MerchantAccountV1();merchantAccount.accountNum = "12345678";merchantAccount.storeID= "myStoreID";merchantAccount.storePwd = "myStorePWD";ccPostAuthRequest.merchantAccount = merchantAccount;ccPostAuthRequest.merchantRefNum = "Ref-12345";
reversalAmount Facultatif ChaîneMax =999999999.99
Il s’agit du montant de l’autorisation initiale que vous voulez inverser. Si vous omettez cet élément, le montant total de l’autorisation ini-tiale sera inversé.REMARQUE : Certaines passerelles de traite-ment peuvent ne pas prendre en charge les inversions d’autorisation partielles. Communi-quez avec votre gestionnaire de compte pour obtenir plus de détails.
addendumData tag Facultatif ChaîneMax = 30
Il s’agit de données supplémentaires qui peu-vent être incluses dans la requête de transac-tion. Consultez la rubrique Paires étiquette/valeur addendumData à la page 3-19 pour obtenir plus de détails.
value Facultatif ChaîneMax = 1024
Il s’agit de données supplémentaires qui peu-vent être incluses dans la requête de transac-tion. Consultez la rubrique Paires étiquette/valeur addendumData à la page 3-19 pour obtenir plus de détails.
geoLocation Facultatif Il s’agit de l’emplacement géographique où la transaction mobile a été effectuée.
latitude Conditionnel ChaîneMax = 24
Il s’agit de la latitude à laquelle la transaction mobile a été effectuée (par ex., 44.903889).
longitude Conditionnel ChaîneMax = 24
Il s’agit de la longitude à laquelle la transaction mobile a été effectuée. (par ex., -77.255123).
Pour convertir cette requête en requête de crédit, il suffit de remplacer la valeur « ccSettlement » (souligné ci-dessous) par « ccCredit ».
Tableau 3-4 : Éléments de transaction ccAuthReversalRequestV1 (suite)
Élément Élément enfant
Requis Type Description
Guide de référence de l’API pour les Services Web 1.0 3-23
Transactions par carte de crédit ou de débit mai 2019
ccPostAuthRequest.amount = "10.00";
// Perform the Web Service call for the SettlementCreditCardServiceV1 ccService = new CreditCardServiceV1();CCTxnResponseV1 ccTxnResponse = ccService.ccSettlement(ccPostAuthRequest);
// Print out the resultString responseTxt = ccTxnResponse.code + " - " + ccTxnResponse.decision +
" - " + ccTxnResponse.description ;responseTxt += "Details:" + Environment.NewLine;
if (ccTxnResponse.detail != null) {
for (int i = 0; i < ccTxnResponse.detail.Length; i++) {
responseTxt += " - " + ccTxnResponse.detail[i].tag + " - " +ccTxnResponse.detail[i].value + Environment.NewLine;
}}responseTxt = responseTxt.Replace("\n", Environment.NewLine);System.Console.WriteLine(responseTxt);
if (DecisionV1.ACCEPTED.Equals(ccTxnResponse.decision)){
System.Console.WriteLine("Transaction Successful.");}else{
System.Console.WriteLine("Transaction Failed with decision: " +ccTxnResponse.decision);
}
3-24
mai 2019 Diagramme de transaction ccPostAuthRequestV1
Diagramme de transaction ccPostAuthRequestV1L’objet de document ccPostAuthRequestV1 respecte la structure suivante :
Éléments de transaction ccPostAuthRequestV1L’objet de document ccPostAuthRequestV1 peut contenir les éléments suivants :
Tableau 3-5 : Éléments de transaction ccPostAuthRequestV1
Élément Élément enfant Requis Type Description
merchantAccount accountNum Oui ChaîneMax = 10
Il s’agit du numéro de compte de march-and.
storeID Oui Chaîne Max = 20
Il s’agit de l’identifiant du magasin traitant la transaction ; il sert à authentifier la requête. Paysafe le définit et le fournit au marchand comme élément du processus d’intégration.
storePwd Oui ChaîneMax = 20
Il s’agit du mot de passe du magasin trai-tant la transaction ; il sert à authentifier la requête. Paysafe le définit et le fournit au marchand comme élément du processus d’intégration.
confirmationNumber Oui ChaîneMax = 15
Il s’agit du numéro de confirmation retourné par Paysafe pour la requête ini-tiale.
Guide de référence de l’API pour les Services Web 1.0 3-25
Transactions par carte de crédit ou de débit mai 2019
merchantRefNum Oui ChaîneMax = 40
Il s’agit d’un numéro d’identification (ID) unique, associé à chaque requête. La val-eur est créée par le marchand et envoyée en tant qu’élément de la requête.
amount Facultatif ChaîneMax =999999999.99
Il s’agit du montant de la requête de trans-action. Vous pouvez régler la totalité ou une partie d’une autorisation. Vous pou-vez créditer la totalité ou une partie d’un règlement.
origMerchantTxn Conditionnel ChaîneMax = 255
Il s’agit du numéro d’identification de la transaction de règlement du marchand qui a été traitée au moyen de l’API de paie-ment direct et qui est maintenant créditée au moyen de l'API des Services Web.
dupeCheck Facultatif Booléen Cela valide que la requête n’est pas en double. On considère qu’une requête est en double lorsque cardNum, amount et merchantRefNum sont identiques.
sdk version Conditionnel ChaîneMax = 20
Il s’agit de la version de SDK utilisée, le cas échéant.Requis si l’élément sdk est fourni.
platform Conditionnel ChaîneMax = 10
Il s’agit de la langue d’intégration de SDK utilisée (par ex., Java, .NET). Requis si l’élément sdk est fourni.
provider Conditionnel ChaîneMax = 20
Il s’agit de l’auteur de SDK utilisé. Réglez cette valeur à « op » lorsque le SDK est fourni par Paysafe.Requis si l’élément sdk est fourni.
addendumData tag Facultatif ChaîneMax = 30
Il s’agit de données supplémentaires qui peuvent être incluses dans la requête de transaction. Consultez la rubrique Paires étiquette/valeur addendumData à la page 3-19 pour obtenir plus de détails.
value Facultatif ChaîneMax = 1024
Il s’agit de données supplémentaires qui peuvent être incluses dans la requête de transaction. Consultez la rubrique Paires étiquette/valeur addendumData à la page 3-19 pour obtenir plus de détails.
geoLocation Facultatif Il s’agit de l’emplacement géographique où la transaction mobile a été effectuée.
latitude Conditionnel ChaîneMax = 24
Il s’agit de la latitude à laquelle la transac-tion mobile a été effectuée (par ex., 44.903889).
longitude Conditionnel ChaîneMax = 24
Il s’agit de la longitude à laquelle la trans-action mobile a été effectuée. (par ex., -77.255123).
accordDREMARQUE : N’incluez cet élément que si Paysafe vous demande de le faire.
Facultatif Vous pouvez inclure l’élément accordD seulement si vous l’avez déjà fourni dans la requête d’autorisation que vous com-plétez actuellement et si vous voulez changer un ou plusieurs termes spécifiques dans les éléments enfants.
Tableau 3-5 : Éléments de transaction ccPostAuthRequestV1 (suite)
Élément Élément enfant Requis Type Description
3-26
mai 2019 Bâtir des requêtes de données mémorisées
Bâtir des requêtes de données mémoriséesLes requêtes d’autorisation et d’achat faites à partir de données mémorisées requièrent l’objet de doc-ument ccStoredDataRequestV1. La présente rubrique décrit la structure d’une requête ccStoredData-RequestV1 et la façon de la bâtir. Pour obtenir des détails sur les éléments requis, consultez le Tableau 3-6 : Éléments de transaction ccStoredDataRequestV1 à la page 3-29.
Les requêtes à partir de données mémorisées vous permettent d’effectuer des autorisations de cartes de crédit et des achats en fournissant un minimum de renseignements sur le client. Les requêtes à par-tir de données mémorisées exigent un numéro de confirmation provenant d’une autorisation et d’un achat fait précédemment.
Ce numéro de confirmation permet à Paysafe d’obtenir de sa base de données la plupart des données requises pour la transaction.
Exemple d’autorisation à partir de données mémorisées – C#Voici un exemple d’autorisation à partir de données mémorisées en C#.
//Prepare the call to the Credit Card Web ServiceMerchantAccountV1 merchantAccount = new MerchantAccountV1();merchantAccount.accountNum = "12345678";
financingType Conditionnel Énumération Ceci est le type de financement offert. Les valeurs possibles sont :• D – Financement par paiement différé • E – Financement en paiements égaux
plan Conditionnel ChaîneMax = 3
Ceci est le numéro du plan pour cette opération de financement.
gracePeriod Facultatif Entier Max = 2
Ceci est la période de grâce, en mois, asso-ciée aux transactions de paiements dif-férés.
term Facultatif Entier Max = 2
Ceci le nombre de paiements, à raison d’un par mois, associé aux transactions de paiements égaux.
La durée maximale de validité d’un numéro de confirmation est de 24 mois.
Si vous traitez une requête de données mémorisées à l’aide d’un numéro de confirmation d’une trans-action incluant l’élément visaAdditionalAuthData (consultez le Tableau 3-2 : Éléments de transaction ccAuthRequestV1 à la page3-8), cette information sera incluse dans la nouvelle requête. Toutefois, si vous ajoutez l’élément visaAdditionalAuthData séparément à la nouvelle requête, il remplacera toutes les données similaires associées au numéro de confirmation, pour cette requête uniquement.
Pour convertir cette requête en requête d’achat à partir de données mémorisées, il suffit de remplacer la valeur « ccStoredDataAuthorize » (soulignée ci-dessous) par « ccStoredDataPurchase ».
Tableau 3-5 : Éléments de transaction ccPostAuthRequestV1 (suite)
Élément Élément enfant Requis Type Description
Guide de référence de l’API pour les Services Web 1.0 3-27
Transactions par carte de crédit ou de débit mai 2019
merchantAccount.storeID = "myStoreID";merchantAccount.storePwd = "myStorePWD"; CCStoredDataRequestV1 ccStoredDataRequest = new CCStoredDataRequestV1();ccStoredDataRequest.confirmationNumber = "111374429";ccStoredDataRequest.amount = "97.97";ccStoredDataRequest.merchantRefNum = "jim55";ccStoredDataRequest.merchantAccount = merchantAccount; // Perform the Web Service call for the Stored Data TransactionCreditCardServiceV1 ccService = new CreditCardServiceV1();CCTxnResponseV1 ccTxnResponse = ccService.ccStoredDataAuthorize(ccStoredDataRequest);String responseTxt = ""; // Print out the resultif (ccTxnResponse.detail != null){
for (int i = 0; i < ccTxnResponse.detail.Length; i++){
responseTxt += " - " + ccTxnResponse.detail[i].tag + " - " +ccTxnResponse.detail[i].value + Environment.NewLine;}
}responseTxt = responseTxt.Replace("\n", Environment.NewLine);System.Console.WriteLine(responseTxt);if (DecisionV1.ACCEPTED.Equals(ccTxnResponse.decision)){
System.Console.WriteLine("Transaction Successful.");}else{
System.Console.WriteLine("Transaction Failed with decision: " +ccTxnResponse.decision);
}
3-28
mai 2019 Diagramme de transaction ccStoredDataRequestV1
Diagramme de transaction ccStoredDataRequestV1L’objet de document ccStoredDataRequestV1 respecte la structure suivante :
Éléments de transaction ccStoredDataRequestV1L’objet de document ccStoredDataRequestV1 peut contenir les éléments suivants :
Tableau 3-6 : Éléments de transaction ccStoredDataRequestV1
Élément Élément enfant Requis Type Description
merchantAccount accountNum Requis ChaîneMax = 10
Il s’agit du numéro de compte de marchand.
storeID Requis Chaîne Max = 20
Il s’agit de l’identifiant du magasin traitant la transaction ; il sert à authentifier la requête. Paysafe le définit et le fournit au marchand comme élément du processus d’intégration.
storePwd Requis ChaîneMax = 20
Il s’agit du mot de passe du magasin traitant la transaction ; il sert à authentifier la requête. Paysafe le définit et le fournit au marchand comme élément du processus d’intégration.
merchantRefNum Requis ChaîneMax = 255
Il s’agit d’un numéro d’identification (ID) unique, associé à chaque requête. La valeur est créée par le marchand et envoyée en tant qu’élément de la requête.
Guide de référence de l’API pour les Services Web 1.0 3-29
Transactions par carte de crédit ou de débit mai 2019
confirmationNumber Requis ChaîneMax = 15
Il s’agit du numéro de confirmation retourné par Paysafe pour la requête ini-tiale.REMARQUE : Le confirmationNumber peut avoir une période maximale de 24 mois.
amount Requis ChaîneMax =999999999.99
Il s’agit du montant de la requête de trans-action.
cardExpiry month Facultatif Entier Max = 2
Il s’agit du mois d’expiration de la carte de crédit.Utilisez cet élément pour inclure l’informa-tion mise à jour sur la date d’expiration de la carte de crédit, lorsque requise, qui sera incluse avec le reste des données de la transaction.
year Facultatif EntierLongueur = 4
Il s’agit de l’année d’expiration de la carte de crédit.Utilisez cet élément pour inclure l’informa-tion mise à jour sur la date d’expiration de la carte de crédit, lorsque requise, qui sera incluse avec le reste des données de la transaction.
cvdIndicator Facultatif Entier Longueur = 1
Il s’agit de l’état de l’information de la valeur CVD. Les valeurs possibles sont :• 0 – Le client n’a pas fourni de valeur. • 1 – Le client a fourni une valeur.• 2 – La valeur est illisible. • 3 – La valeur n’apparaît pas sur la carte.
cvd Conditionnel ChaîneLongueur = 3 ou 4
Le code de sécurité à trois ou quatre chiffres situé sur la carte, après son numéro. Ce code n’apparaît pas sur les documents imprimés.
Lorsque l’on fournit la valeur CVD pour effectuer une requête à partir de données mémorisées, la transaction bénéficie de la protection complète offerte par le procédé CVD. Cependant, vous ne devez jamais enregistrer les données CVD des clients : elles doivent être fournies par le client pour chaque requête.
REMARQUE : L’élément cvd est obligatoire lorsque la valeur de l’élément cvdIndicator est 1.
storedCredential Facultatif Ce paramètre est utilisé pour identifier les demandes d’autorisation qui utilisent des numéros de carte de crédit stockés par Pay-safe. Dans ce cas, ce sont les informations de carte associées à un numéro de confir-mation retournées dans la réponse à une précédente autorisation réussie.
Tableau 3-6 : Éléments de transaction ccStoredDataRequestV1 (suite)
Élément Élément enfant Requis Type Description
3-30
mai 2019 Bâtir des requêtes d’annulation
Bâtir des requêtes d’annulationUtilisez l’objet de document ccCancelRequestV1 pour annuler les transactions Settle, Credit, Payment, and Independent Credit. La présente rubrique décrit la structure d’une requête ccCancelRequestV1 et la façon de la bâtir. Pour obtenir des détails sur les éléments requis, consultez le Tableau 3-7 : Éléments de transaction ccCancelRequestV1 à la page 3-33.
Exemple d’annulation de règlement – C#Voici un exemple d’annulation de règlement en C#.
//Prepare the call to the Credit Card Web Service
type Facultatif Énumération Ceci spécifie le type de requête en cours. Les valeurs possibles sont :• ADHOC – Requête ad hoc initiée par le
consommateur• TOPUP – Requête non planifiée lancée
par un marchand lorsque le solde d’un consommateur est inférieur à une limite fixée
• RECURRING – Demande récurrente plani-fiée, initiée par le marchand
REMARQUE : La valeur par défaut est ADHOC.
occurrence Facultatif Énumération Ceci spécifie si cette requête est initiale (INI-TIAL) ou récurrente (RECURRING). Les valeurs possibles sont :• INITIAL – Utilisé lorsque c’est la première
fois que le consommateur utilise cette carte de crédit
• SUBSEQUENT – Utilisé lorsque le con-sommateur utilise cette carte de crédit pour des requêtes ultérieures
REMARQUE : La valeur par défaut est SUB-SEQUENT. La valeur de la carte cvd est req-uise lorsque ce paramètre est définie sur INITIAL.
addendumData tag Facultatif ChaîneMax = 30
Il s’agit de données supplémentaires qui peuvent être incluses dans la requête de transaction. Consultez la rubrique Paires étiquette/valeur addendumData à la page 3-19 pour obtenir plus de détails.
value Facultatif ChaîneMax = 1024
Il s’agit de données supplémentaires qui peuvent être incluses dans la requête de transaction. Consultez la rubrique Paires étiquette/valeur addendumData à la page 3-19 pour obtenir plus de détails.
Pour convertir cette requête en requête d’annulation de crédit, de paiement, ou de crédit indépendant, il suffit de remplacer la valeur « ccCancelSettle » (souligné ci-dessous) par « ccCancelCredit », « ccCancelPayment », ou « ccCancelIndependentCredit » respectivement.
Tableau 3-6 : Éléments de transaction ccStoredDataRequestV1 (suite)
Élément Élément enfant Requis Type Description
Guide de référence de l’API pour les Services Web 1.0 3-31
Transactions par carte de crédit ou de débit mai 2019
CCCancelRequestV1 ccCancelRequest = new CCCancelRequestV1();MerchantAccountV1 merchantAccount = new MerchantAccountV1();merchantAccount.accountNum = "12345678";merchantAccount.storeID= "myStoreID";merchantAccount.storePwd = "myStorePWD";ccCancelRequest.merchantAccount = merchantAccount;ccCancelRequest.confirmationNumber = "123456";
// Perform the Web Services call for the cancel settleCreditCardServiceV1 ccService = new CreditCardServiceV1();CCTxnResponseV1 ccTxnResponse = ccService.ccCancelSettle(ccCancelRequest);
// Print out the resultString responseTxt = ccTxnResponse.code + " - " + ccTxnResponse.decision +
" - " + ccTxnResponse.description ;responseTxt += "Details:" + Environment.NewLine;if (ccTxnResponse.detail != null) {
for (int i = 0; i < ccTxnResponse.detail.Length; i++) {
responseTxt += " - " + ccTxnResponse.detail[i].tag + " - " +ccTxnResponse.detail[i].value + Environment.NewLine;
}}responseTxt = responseTxt.Replace("\n", Environment.NewLine);System.Console.WriteLine(responseTxt);
if (DecisionV1.ACCEPTED.Equals(ccTxnResponse.decision)){
System.Console.WriteLine("Transaction Successful.");}else{
System.Console.WriteLine("Transaction Failed with decision: " +ccTxnResponse.decision);
}
Diagramme de transaction ccCancelRequestV1L’objet de document ccCancelRequestV1 respecte la structure suivante :
3-32
mai 2019 Éléments de transaction ccCancelRequestV1
Éléments de transaction ccCancelRequestV1L’objet de document ccCancelRequestV1 peut contenir les éléments suivants :
Tableau 3-7 : Éléments de transaction ccCancelRequestV1
Élément Élément enfant Requis Type Description
merchantAccount accountNum Oui ChaîneMax = 10
Il s’agit du numéro de compte de marchand.
storeID Oui Chaîne Max = 20
Il s’agit de l’identifiant du magasin traitant la transaction ; il sert à authentifier la requête. Paysafe le définit et le fournit au marchand comme élément du processus d’intégration.
storePwd Oui ChaîneMax = 20
Il s’agit du mot de passe du magasin traitant la transaction ; il sert à authentifier la requête. Paysafe le définit et le fournit au marchand comme élément du processus d’intégration.
confirmationNumber Oui ChaîneMax = 15
Il s’agit du numéro de confirmation retourné par Paysafe pour la requête initiale de règle-ment ou de crédit.
sdk version Conditionnel ChaîneMax = 20
Il s’agit de la version de SDK utilisée, le cas échéant.Requis si l’élément sdk est fourni.
platform Conditionnel ChaîneMax = 10
Il s’agit de la langue d’intégration de SDK utilisée (par ex., Java, .NET). Requis si l’élément sdk est fourni.
Guide de référence de l’API pour les Services Web 1.0 3-33
Transactions par carte de crédit ou de débit mai 2019
Bâtir des requêtes de paiement/crédit indépendantLe paiement et le crédit indépendant requièrent l’objet de document ccPaymentRequestV1. La présente rubrique décrit la structure d’une requête ccPaymentRequestV1 et la façon de la bâtir. Pour obtenir des détails sur les éléments requis, consultez le Tableau 3-8 : Éléments de transaction ccPaymentRequestV1 à la page 3-36.
Exemple de paiement – C#
Voici un exemple de paiement en C#.
//Prepare the call to the Credit Card Web ServiceCCPaymentRequestV1 ccPaymentRequest = new CCPaymentRequestV1();MerchantAccountV1 merchantAccount = new MerchantAccountV1();merchantAccount.accountNum = "12345678";merchantAccount.storeID = "myStoreID";merchantAccount.storePwd = "myStorePWD";ccPaymentRequest.merchantAccount = merchantAccount;ccPaymentRequest.merchantRefNum = "Ref-12345";
provider Conditionnel ChaîneMax = 20
Il s’agit de l’auteur de SDK utilisé. Réglez cette valeur à « op » lorsque le SDK est fourni par Paysafe.Requis si l’élément sdk est fourni.
addendumData tag Facultatif ChaîneMax = 30
Il s’agit de données supplémentaires qui peuvent être incluses dans la requête de transaction. Consultez la rubrique Paires éti-quette/valeur addendumData à la page 3-19 pour obtenir plus de détails.
value Facultatif ChaîneMax = 1024
Il s’agit de données supplémentaires qui peuvent être incluses dans la requête de transaction. Consultez la rubrique Paires éti-quette/valeur addendumData à la page 3-19 pour obtenir plus de détails.
geoLocation Facultatif Il s’agit de l’emplacement géographique où la transaction mobile a été effectuée.
latitude Conditionnel ChaîneMax = 24
Il s’agit de la latitude à laquelle la transaction mobile a été effectuée (par ex., 44.903889).
longitude Conditionnel ChaîneMax = 24
Il s’agit de la longitude à laquelle la transac-tion mobile a été effectuée. (par ex., -77.255123).
Tous les éléments facultatifs qui requièrent des types de données non nullables (ordinaires) (par ex., int ou enum) doivent avoir leur attribut specified établi à true lorsque les valeurs sont fixées pour ces éléments. Consultez l’élément cardType dans l’exemple ci-dessous.
Pour convertir cette requête en requête de crédit indépendant, il suffit de remplacer la valeur « ccPayment » (souligné ci-dessous) par « ccIndependentCredit ».
Tableau 3-7 : Éléments de transaction ccCancelRequestV1 (suite)
Élément Élément enfant Requis Type Description
3-34
mai 2019 Exemple de paiement – C#
ccPaymentRequest.amount = "10.00";CardV1 card = new CardV1();card.cardNum = "4653111111111111";CardExpiryV1 cardExpiry = new CardExpiryV1();cardExpiry.month = 11;cardExpiry.year = 2006;card.cardExpiry = cardExpiry;card.cardType = CardTypeV1.VI;card.cardTypeSpecified = true;card.cvdIndicator = 1;card.cvdIndicatorSpecified = true;card.cvd = "111";ccPaymentRequest.card = card;BillingDetailsV1 billingDetails = new BillingDetailsV1();billingDetails.cardPayMethod = CardPayMethodV1.WEB; //WEB = Card Number ProvidedbillingDetails.cardPayMethodSpecified = true;billingDetails.firstName = "Jeanne";billingDetails.lastName = "Tremblay";billingDetails.street = "123 rue Principale";billingDetails.city = "Alma";billingDetails.Item = (object)StateV1.QC; // QuébecbillingDetails.country = CountryV1.CA; // CanadabillingDetails.countrySpecified = true;billingDetails.zip = "90210";billingDetails.phone = "555-555-5555";billingDetails.email = "[email protected]";ccPaymentRequest.billingDetails = billingDetails;
// Perform the Web Services call for the payment requestCreditCardServiceV1 ccService = new CreditCardServiceV1();CCTxnResponseV1 ccTxnResponse = ccService.ccPayment(ccPaymentRequest);
// Print out the resultString responseTxt ccTxnResponse.code + " - " + ccTxnResponse.decision + " - "
+ ccTxnResponse.description ;
responseTxt += "Details:" + Environment.NewLine;
if (ccTxnResponse.detail != null){
for (int i = 0; i < ccTxnResponse.detail.Length; i++){
responseTxt += " - " + ccTxnResponse.detail[i].tag + " - " +ccTxnResponse.detail[i].value + Environment.NewLine;
}
}responseTxt = responseTxt.Replace("\n", Environment.NewLine);System.Console.WriteLine(responseTxt);if (DecisionV1.ACCEPTED.Equals(ccTxnResponse.decision)){
System.Console.WriteLine("Transaction Successful.");}else{
System.Console.WriteLine("Transaction Failed with decision: " +ccTxnResponse.decision);
}}
Guide de référence de l’API pour les Services Web 1.0 3-35
Transactions par carte de crédit ou de débit mai 2019
catch (WebException we){
consoleTextBox.Text += we.Message.ToString();consoleTextBox.Refresh();
}
Diagramme de transaction ccPaymentRequestV1Une transaction ccPaymentRequestV1 respecte la structure suivante :
Éléments de transaction ccPaymentRequestV1 L’objet de document ccPaymentRequestV1 peut contenir les éléments suivants :
Tableau 3-8 : Éléments de transaction ccPaymentRequestV1
Élément Élément enfant Requis Type Description
merchantAccount accountNum Oui ChaîneMax = 10
Il s’agit du numéro de compte de marchand.
storeID Oui Chaîne Max = 80
Il s’agit de l’identifiant du magasin traitant la transaction ; il sert à authentifier la requête. Paysafe le définit et le fournit au marchand comme élément du processus d’intégration.
storePwd Oui ChaîneMax = 20
Il s’agit du mot de passe du magasin traitant la transaction ; il sert à authentifier la requête. Paysafe le définit et le fournit au marchand comme élément du processus d’intégration.
3-36
mai 2019 Éléments de transaction ccPaymentRequestV1
merchantRefNum Oui ChaîneMax = 40
Il s’agit d’un numéro d’identification (ID) unique, associé à chaque requête. La valeur est créée par le marchand et envoyée en tant qu’élément de la requête.
customerTokenId Pour usage interne seulement.
amount Oui Chaîne Il s’agit du montant de la requête de transac-tion. Le montant maximum pour les marchands est configuré sur une base individuelle. Il s’applique à chaque transaction et au maxi-mum quotidien de la carte de crédit. Com-muniquez avec votre gestionnaire de compte pour obtenir plus de détails.
card cardNum Oui Chaîne
Min = 8
Max = 20
Il s’agit du numéro de la carte utilisée pour la transaction.
cardExpiry Oui L'élément enfant cardExpiry a deux autres éléments enfants – month et year.
Élément enfant de cardExpiry
month Oui Entier
Max = 2
Il s’agit du mois d’expiration de la carte de crédit.
year Oui Entier
Longueur = 4
Il s’agit de l’année d’expiration de la carte de crédit.
cardType Facultatif Énumération Il s’agit du type de carte utilisée pour la transaction. Les valeurs possibles sont :• AM = American Express• DC = Diners Club• DI = Discover• JC = JCB• MC = Mastercard• MD = Maestro• SO = Solo• VD = Visa Debit• VE = Visa Electron• VI = Visa
issueNum Facultatif Entier
Max = 2
Le numéro à un ou deux chiffres situé à l’avant de la carte, après son numéro.
REMARQUE : L’élément issueNum peut uniquement être utilisé lorsque cardType correspond à MD (Maestro) ou SO (Solo).
Tableau 3-8 : Éléments de transaction ccPaymentRequestV1 (suite)
Élément Élément enfant Requis Type Description
Guide de référence de l’API pour les Services Web 1.0 3-37
Transactions par carte de crédit ou de débit mai 2019
cvdIndicator Facultatif Entier
Longueur = 1
Il s’agit de l’état de l’information de la valeur CVD. Les valeurs possibles sont :• 0 – Le client n’a pas fourni de valeur. • 1 – Le client a fourni une valeur.• 2 – La valeur est illisible. • 3 – La valeur n’apparaît pas sur la carte.
REMARQUE : Même si cet élément est facul-tatif, il est requis dans le cas de plusieurs vérifications liées aux risques et nous vous conseillons fortement de l’inclure pour éviter les transactions en échec.
cvd Conditionnel Chaîne
Longueur = 3 ou 4
Le code de sécurité à trois ou quatre chiffres situé sur la carte, après son numéro. Ce code n’apparaît pas sur les documents imprimés.
REMARQUE : L’élément cvd est obligatoire lorsque la valeur de l’élément cvdIndicator est 1.
billingDetails cardPayMethod Pour usage interne seulement.
firstName Facultatif Chaîne Max = 40
Il s’agit du prénom du client.
lastName Facultatif Chaîne Max = 40
Il s’agit du nom de famille du client.
street Facultatif ChaîneMax = 50
Il s’agit de la première ligne de l’adresse municipale du client.
street2 Facultatif ChaîneMax = 50
Il s’agit de la deuxième ligne de l’adresse municipale du client.
city Facultatif ChaîneMax = 40
Il s’agit de la ville de résidence du client.
state/region Facultatif Si state (État), ÉnumérationSi region (région), alors ChaîneMax = 40
Il s’agit de l’État, de la province ou de la région de résidence du client. Fournir la liste des États ou provinces pour les adresses à l’intérieur des États-Unis ou du Canada. Fournir la liste des régions pour les adresses à l’extérieur des États-Unis ou du Canada. Consultez la rubrique Annexe C : Codes géo-graphiques pour connaître les bons codes à utiliser.
country Facultatif Énumération Il s’agit du pays de résidence du client. Con-sultez la rubrique Codes de pays à la page C-3 pour connaître les bons codes à utiliser.
zip Obligatoire ChaîneMax = 10
Si le pays est États-Unis, il s'agit du code Zip du client ; sinon, il s'agit de son code postal.
phone Facultatif ChaîneMax = 40
Il s’agit du numéro de téléphone du client.
Tableau 3-8 : Éléments de transaction ccPaymentRequestV1 (suite)
Élément Élément enfant Requis Type Description
3-38
mai 2019 Bâtir des requêtes de consultation des données
Bâtir des requêtes de consultation des donnéesLa requête de consultation des données vous permet de produire un rapport à l’aide de l’API pour une plage de temps que vous précisez, afin de recevoir les données concernant les transactions traités par votre compte de marchand.
Par exemple, vous pouvez vouloir déterminer le résultat d’une transaction qui a eu un temps mort, n’ayant pas de retour de réponse, ou le résultat d’une transaction en lot qui est refusée à une date ultérieure.
Vous pouvez rechercher les types de transactions suivants :
• autorisation
• achat
• règlement
• crédit
• paiement/crédit indépendant
email Facultatif ChaîneMax = 100
Il s’agit de l’adresse de courriel du client.
sdk version Conditionnel ChaîneMax = 20
Il s’agit de la version de SDK utilisée, le cas échéant.Requis si l’élément sdk est fourni.
platform Conditionnel ChaîneMax = 10
Il s’agit de la langue d’intégration de SDK utilisée (par ex., Java, .NET). Requis si l’élément sdk est fourni.
provider Conditionnel ChaîneMax = 20
Il s’agit de l’auteur de SDK utilisé. Réglez cette valeur à « op » lorsque le SDK est fourni par Paysafe. Requis si l’élément sdk est fourni.
authCode Facultatif ChaîneMax = 50
Il s’agit du code d’autorisation attribué par la banque émettrice et retourné par Paysafe pour une transaction antérieure. REMARQUE : N’incluez cet élément que si Paysafe vous demande de le faire.
previousConfirma-tionNumber
Facultatif ChaîneMax = 20
il s’agit du numéro de confirmation pour une autorisation existante antérieure.REMARQUE : N’incluez cet élément que si Paysafe vous demande de le faire.
addendumData tag Facultatif ChaîneMax = 30
Il s’agit de données supplémentaires qui peuvent être incluses dans la requête de transaction. Consultez la rubrique Paires étiquette/valeur addendumData à la page 3-19 pour obtenir plus de détails.
value Facultatif ChaîneMax = 1024
Il s’agit de données supplémentaires qui peuvent être incluses dans la requête de transaction. Consultez la rubrique Paires étiquette/valeur addendumData à la page 3-19 pour obtenir plus de détails.
Tableau 3-8 : Éléments de transaction ccPaymentRequestV1 (suite)
Élément Élément enfant Requis Type Description
Guide de référence de l’API pour les Services Web 1.0 3-39
Transactions par carte de crédit ou de débit mai 2019
Exemple de consultation des données – C#Voici un exemple de consultation des données en C#.
// Prepare the call to the Credit Card Web ServiceCCTxnLookupRequestV1 ccTxnLookupRequest = new CCTxnLookupRequestV1();MerchantAccountV1 merchantAccount = new MerchantAccountV1();merchantAccount.accountNum = "12345678";merchantAccount.storeID = "myStoreID";merchantAccount.storePwd = "myStorePWD";ccTxnLookupRequest.merchantAccount = merchantAccount;ccTxnLookupRequest.merchantRefNum = "123456789";
DateV1 startDate = new DateV1();startDate.year = "2012";startDate.month = "08";startDate.day = "15";startDate.hour = "11";startDate.minute = "00";startDate.second = "00";ccTxnLookupRequest.startDate = startDate;
DateV1 endDate = new DateV1();endDate.year = "2012";endDate.month = "08";endDate.day = "15";endDate.hour = "14";endDate.minute = "00";endDate.second = "00";ccTxnLookupRequest.endDate = endDate;
//Perform the Web Services call to process the requestCreditCardServiceV1 ccService = new CreditCardServiceV1();CCTxnResponseV1 ccTxnResponse = ccService.ccTxnLookup(ccTxnLookupRequest);// Print out the resultString responseTxt = ccTxnResponse.code + " - " + ccTxnResponse.decision;responseTxt += "Transactions:" + Environment.NewLine;if (ccTxnResponse.transaction != null){ for (int i = 0; i < ccTxnResponse.txnLookupResult.length; i++) { responseTxt += " - confirmationNumber: " + ccTxnResponse.txnLookupResult[i].confirmationNumber + Environment.NewLine; responseTxt += " - decison: " + ccTxnResponse.txnLookupResult[i].decision + Environment.NewLine; responseTxt += " - code: " + ccTxnResponse.txnLookupResult[i].code + Environment.NewLine; responseTxt += " - transaction type: " + ccTxnResponse.txnLookupResult[i].tranType + Environment.NewLine; responseTxt += " - transaction time: " + ccTxnResponse.txnLookupResult[i].txnTime + Environment.NewLine; responseTxt += " - merchantRefNum: " + ccTxnResponse.txnLookupResult[i].merchantRefNum + Environment.NewLine;responseTxt += " - card ending: " + ccTxnResponse.txnLookupResult[i].cardEnding + Environment.NewLine; responseTxt += " - card ending: " + ccTxnResponse.txnLookupResult[i].cardEnding + Environment.NewLine;
3-40
mai 2019 Diagramme de transaction ccTxnLookupRequestV1
CardExpiryV1 expiry = ccTxnResponse.txnLookupResult[i].cardExpiry; responseTxt += " - card expiry: " + expiry.month + "/" + expiry.year + Environment.NewLine; responseTxt += Environment.NewLine + Environment.NewLine; }
System.Console.WriteLine(responseTxt);}
Diagramme de transaction ccTxnLookupRequestV1Une transaction ccTxnLookupRequestV1 respecte la structure suivante :
Éléments de transaction ccTxnLookupRequestV1L’objet de document ccTxnLookupRequestV1 peut contenir les éléments suivants :
Table 3-9: Éléments de transaction ccTxnLookupRequestV1
Élément Élément enfant Requis Type Description
merchantAccount accountNum Oui ChaîneMax = 10
Il s’agit du numéro de compte de march-and.
storeID Oui Chaîne Max = 20
Il s’agit de l’identifiant du magasin traitant la transaction ; il sert à authentifier la requête. Paysafe le définit et le fournit au marchand comme élément du processus d’intégration.
Guide de référence de l’API pour les Services Web 1.0 3-41
Transactions par carte de crédit ou de débit mai 2019
storePwd Oui ChaîneMax = 20
Il s’agit du mot de passe du magasin trai-tant la transaction ; il sert à authentifier la requête. Paysafe le définit et le fournit au marchand comme élément du processus d’intégration.
confirmationNumber Facultatif ChaîneMax = 15
This is the confirmation number returned by Paysafe in response to the original request. Include this element only if you want to search using this field. This field takes precedence over the merchantRefNum field.REMARQUE : Si vous incluez cet élément, vous n’avez pas à spécifier les éléments startDate ou endDate.
netbanxReference Facultatif Chaîne Il s’agit d’un numéro de transaction utilisé pour identifier certaines transactions existantes.REMARQUE : Si vous incluez cet element, vous devez spécifier les éléments startDate et endDate.
merchantRefNum Facultatif ChaîneMax = 255
Il s’agit d’un numéro d’identification (ID) unique, associé à chaque requête. La val-eur est créée par le marchand et envoyée en tant qu’élément de la requête.REMARQUE : Si vous incluez cet element, vous devez spécifier les éléments startDate et endDate.
startDate year Conditionnel IntMax = 9999
Il s’agit de l’année fixée pour le début de la recherche.
month Conditionnel IntMin = 1Max = 12
Il s’agit du mois fixé pour le début de la recherche.
day Conditionnel IntMin = 1Max = 31
Il s’agit du jour fixé pour le début de la recherche.
hour Conditionnel IntMin = 0Max = 23
Il s’agit de l’heure fixée pour le début de la recherche.
minute Conditionnel IntMin = 0Max = 59
Il s’agit de la minute fixée pour le début de la recherche.
second Conditionnel IntMin = 0Max = 59
Il s’agit de la seconde fixée pour le début de la recherche.
endDate year Conditionnel IntMax = 9999
Il s’agit de l’année fixée pour la fin de la recherche.
month Conditionnel IntMin = 1Max = 12
Il s’agit du mois fixé pour la fin de la recher-che.
Table 3-9: Éléments de transaction ccTxnLookupRequestV1 (suite)
Élément Élément enfant Requis Type Description
3-42
mai 2019 Bâtir des requêtes de consultation d’inscription
Bâtir des requêtes de consultation d’inscriptionUtilisez la requête de consultation d’inscription afin d’établir si la carte de crédit du titulaire de la carte est inscrite au programme 3D Secure. Les requêtes de consultation d’inscription exigent l’objet de doc-ument ccEnrollmentLookupRequestV1. La présente rubrique décrit la structure d’une requête ccEnroll-mentLookupRequestV1 et la façon de la bâtir. Pour obtenir des détails sur les éléments requis, consultez le Tableau 3-10 : Éléments de transaction ccEnrollmentLookupRequestV1 à la page 3-45.
Exemple de consultation d’inscription – C#Voici un exemple de consultation d’inscription en C#.
//Prepare the call to the Credit Card Web ServiceCCEnrollmentLookupRequestV1 enrollmentLookupRequest = new CCEnrollmentLookupRequestV1();MerchantAccountV1 merchantAccount = new MerchantAccountV1();merchantAccount.accountNum = "12345678";merchantAccount.storeID = "myStoreID";merchantAccount.storePwd = "myStorePWD";enrollmentLookupRequest.merchantAccount = merchantAccount;
enrollmentLookupRequest.merchantRefNum = "Ref-12345";enrollmentLookupRequest.amount = "97.97";
CardV1 card = new CardV1();card.cardNum = "4653111111111111";CardExpiryV1 cardExpiry = new CardExpiryV1();
day Conditionnel IntMin = 1Max = 31
Il s’agit du jour fixé pour la fin de la recher-che.
hour Conditionnel IntMin = 0Max = 23
Il s’agit de l’heure fixée pour la fin de la recherche.
minute Conditionnel IntMin = 0Max = 59
Il s’agit de la minute fixée pour la fin de la recherche.
second Conditionnel IntMin = 0Max = 59
Il s’agit de la seconde fixée pour la fin de la recherche.
Cette opération est prise en charge uniquement pour 3D Secure 1.0.2. Voir https://developer.pay-safe.com/en/rest-apis/3d-secure-2/getting-started/introduction-to-3d-secure-2/ pour plus d’informa-tions sur l’utilisation de 3D Secure 2.
Tous les éléments facultatifs qui requièrent des types de données non nullables (ordinaires) (par ex., int ou enum) doivent avoir leur attribut specified établi à true lorsque les valeurs sont fixées pour ces éléments. Consultez l’élément cardType dans l’exemple ci-dessous.
Table 3-9: Éléments de transaction ccTxnLookupRequestV1 (suite)
Élément Élément enfant Requis Type Description
Guide de référence de l’API pour les Services Web 1.0 3-43
Transactions par carte de crédit ou de débit mai 2019
cardExpiry.month = 11;cardExpiry.year = 2013;card.cardExpiry = cardExpiry;card.cardType = CardTypeV1.VI;card.cardTypeSpecified = true;enrollmentLookupRequest.card = card;
// Perform the Web Services call for the TDS Enrollment LookupCreditCardServiceV1 ccService = new CreditCardServiceV1();CCTxnResponseV1 ccTxnResponse = ccService.ccTDSLookup(enrollmentLookupRequest);
// Print out the resultString responseTxt = ccTxnResponse.confirmationNumber + " - " + ccTxnResponse.code + " - " + ccTxnResponse.decision + " - " + ccTxnResponse.description;responseTxt += Environment.NewLine;responseTxt += "Details:" + Environment.NewLine;if (ccTxnResponse.detail != null){
for (int i = 0; i < ccTxnResponse.detail.Length; i++){
responseTxt += " - " + ccTxnResponse.detail[i].tag + " - " + ccTxnResponse.detail[i].value + Environment.NewLine;
}}responseTxt += "TDSResponse:" + Environment.NewLine;if (ccTxnResponse.tdsResponse != null){
responseTxt += " - " + ccTxnResponse.tdsResponse.acsURL + Environment.NewLine;
responseTxt += " - " + ccTxnResponse.tdsResponse.paymentRequest + Environment.NewLine;
responseTxt += " - " + ccTxnResponse.tdsResponse.enrollmentStatus + Environment.NewLine;
responseTxt += " - " + ccTxnResponse.tdsResponse.eci + Environment.NewLine;}responseTxt = responseTxt.Replace("\n", Environment.NewLine);System.Console.WriteLine(responseTxt);consoleTextBox.Text = responseTxt;if (DecisionV1.ACCEPTED.Equals(ccTxnResponse.decision)){
System.Console.WriteLine("Transaction Successful.");}else{
System.Console.WriteLine("Transaction Failed with decision: " + ccTxnResponse.decision);}
3-44
mai 2019 Diagramme de transaction ccEnrollmentLookupRequestV1
Diagramme de transaction ccEnrollmentLookupRequestV1Une transaction ccEnrollmentLookupRequestV1 respecte la structure suivante :
Éléments de transaction ccEnrollmentLookupRequestV1L’objet de document ccEnrollmentLookupRequestV1 peut contenir les éléments suivants :
Tableau 3-10 : Éléments de transaction ccEnrollmentLookupRequestV1
Élément Élément enfant Requis Type Description
merchantAccount accountNum Oui ChaîneMax = 10
Il s’agit du numéro de compte de marchand.
storeID Oui Chaîne Max = 20
Il s’agit de l’identifiant du magasin traitant la transaction ; il sert à authentifier la requête. Paysafe le définit et le fournit au marchand comme élément du processus d’intégration.
storePwd Oui ChaîneMax = 20
Il s’agit du mot de passe du magasin traitant la transaction ; il sert à authentifier la requête. Paysafe le définit et le fournit au marchand comme élément du processus d’intégration.
merchantRefNum Oui ChaîneMax = 255
Il s’agit d’un numéro d’identification (ID) unique, associé à chaque requête. La valeur est créée par le marchand et envoyée en tant qu’élément de la requête.
amount Oui ChaîneMax =999999999.99
Il s’agit du montant de la requête de transac-tion. REMARQUE : Bien que l’élément amount soit obligatoire dans le cas d’une transaction Enrollment Lookup, le montant n’est pas imputé à la carte de crédit.
card cardNum Oui Chaîne Min = 8Max = 20
Il s’agit du numéro de la carte utilisée pour la transaction.
cardExpiry Oui L'élément enfant cardExpiry a deux autres éléments enfants – month et year.
Guide de référence de l’API pour les Services Web 1.0 3-45
Transactions par carte de crédit ou de débit mai 2019
Bâtir des requêtes d’authentificationUtilisez la requête d’authentification pour permettre au titulaire de la carte d’authentifier sa carte auprès de l’émetteur et de récupérer les valeurs requises pour l’élément authentication d’une transac-tion ccAuthRequestV1. Les requêtes d’authentication requièrent l’objet de document ccAuthenticateRe-questV1. La présente rubrique décrit la structure d’une requête ccAuthenticateRequestV1 et la façon de la bâtir. Pour obtenir des détails sur les éléments requis, consultez le Tableau 3-11 : Éléments de trans-action ccAuthenticateRequestV1 à la page 3-48.
Exemple d’authentification – C#Voici un exemple d’authentification en C#.
//Prepare the call to the Credit Card Web Service
Élément enfant de cardExpiry
month Oui Entier Max = 2
Il s’agit du mois d’expiration de la carte de crédit.
year Oui EntierLongueur = 4
Il s’agit de l’année d’expiration de la carte de crédit.
cardType Facultatif Énumération Il s’agit du type de carte utilisée pour la transaction. Les valeurs possibles sont :• JC = JCB• MC = Mastercard• VI = Visa
issueNum Facultatif Entier Max = 2
Le numéro à un ou deux chiffres situé à l’avant de la carte, après son numéro.REMARQUE : L’élément issueNum n’est pas utilisé pour ce type de requête.
cvdIndicator Facultatif Entier Longueur = 1
Il s’agit de l’état de l’information de la valeur CVD. Les valeurs possibles sont :• 0 – Le client n’a pas fourni de valeur. • 1 – Le client a fourni une valeur.• 2 – La valeur est illisible. • 3 – La valeur n’apparaît pas sur la carte.
REMARQUE : L’élément cvdIndicator n’est pas utilisé pour ce type de requête.
cvd Conditionnel ChaîneLongueur = 3 ou 4
Le code de sécurité à trois ou quatre chiffres situé sur la carte, après son numéro. Ce code n’apparaît pas sur les documents imprimés.REMARQUE : L’élément cvd n’est pas utilisé pour ce type de requête.
Cette opération est prise en charge uniquement pour 3D Secure 1.0.2. Voir https://developer.pay-safe.com/en/rest-apis/3d-secure-2/getting-started/introduction-to-3d-secure-2/ pour plus d’informa-tions sur l’utilisation de 3D Secure 2.
Tableau 3-10 : Éléments de transaction ccEnrollmentLookupRequestV1 (suite)
Élément Élément enfant Requis Type Description
3-46
mai 2019 Diagramme de transaction ccAuthenticateRequestV1
CCAuthenticateRequestV1 authenticateRequest = new CCAuthenticateRequestV1();MerchantAccountV1 merchantAccount = new MerchantAccountV1();merchantAccount.accountNum = "12345678";merchantAccount.storeID = "myStoreID";merchantAccount.storePwd = "myStorePWD";authenticateRequest.merchantAccount = merchantAccount;authenticateRequest.confirmationNumber = "myConfirmationNumber";authenticateRequest.paymentResponse = "myPaymentResponse";
// Perform the Web Services call for the authenticationCreditCardServiceV1 ccService = new CreditCardServiceV1();CCTxnResponseV1 ccTxnResponse = ccService.ccTDSAuthenticate(authenticateRequest);
// Print out the resultString responseTxt = ccTxnResponse.confirmationNumber + " - " +ccTxnResponse.code + " - " + ccTxnResponse.decision + " - " +
ccTxnResponse.description;responseTxt += Environment.NewLine;responseTxt += "Details:" + Environment.NewLine; if (ccTxnResponse.detail != null){
for (int i = 0; i < ccTxnResponse.detail.Length; i++){
responseTxt += " - " + ccTxnResponse.detail[i].tag + " - " +ccTxnResponse.detail[i].value + Environment.NewLine;
}}responseTxt = responseTxt.Replace("\n", Environment.NewLine);System.Console.WriteLine(responseTxt);consoleTextBox.Text = responseTxt;
if (DecisionV1.ACCEPTED.Equals(ccTxnResponse.decision)){
System.Console.WriteLine("Transaction Successful.");}else{
System.Console.WriteLine("Transaction Failed with decision: " +ccTxnResponse.decision);
}
Diagramme de transaction ccAuthenticateRequestV1Une transaction ccAuthenticateRequestV1 respecte la structure suivante :
Guide de référence de l’API pour les Services Web 1.0 3-47
Transactions par carte de crédit ou de débit mai 2019
Éléments de transaction ccAuthenticateRequestV1L’objet de document ccAuthenticateRequestV1 peut contenir les éléments suivants :
Tableau 3-11 : Éléments de transaction ccAuthenticateRequestV1
Élément Élément enfant Requis Type Description
merchantAccount accountNum Oui ChaîneMax = 10
Il s’agit du numéro de compte de marchand.
storeID Oui Chaîne Max = 20
Il s’agit de l’identifiant du magasin traitant la transaction; il sert à authentifier la requête. Paysafe le définit et le fournit au marchand comme élément du processus d’intégration.
storePwd Oui ChaîneMax = 20
Il s’agit du mot de passe du magasin traitant la transaction; il sert à authentifier la requête. Paysafe le définit et le fournit au marchand comme élément du processus d’intégration.
confirmationNumber Oui ChaîneMax = 15
Il s’agit du numéro de confirmation de ccTxn-ResponseV1 retourné par Paysafe en réponse à ccEnrollmentLookupRequestV1.
paymentResponse Oui Chaîne Il s’agit de la réponse d’authentification de paiement retournée par la banque émettrice au moyen du navigateur Web de votre client une fois qu’il a fourni ses renseignements d’authentification. Il s’agit d’une réponse codée générée par le logiciel d’ACS de l’émetteur. La signature électronique sera vérifiée par Paysafe pour s’assurer qu’elle a été générée par un émetteur légitime.
merchantRefNum Facultatif ChaîneMax = 255
Il s’agit d’un numéro d’identification (ID) unique, associé à chaque requête. La valeur est créée par le marchand et envoyée en tant qu’élément de la requête.
3-48
mai 2019 Traitement de la réponse
Traitement de la réponseUne transaction ccTxnResponseV1 respecte la structure suivante :
Guide de référence de l’API pour les Services Web 1.0 3-49
Transactions par carte de crédit ou de débit mai 2019
Les éléments suivants sont pertinents dans le cas d’une réponse ccTxnResponseV1 :
Tableau 3-12 : Éléments d’une transaction ccTxnResponseV1
Élément Élément enfant Requis Type Description
confirmationNumber Oui ChaîneMax = 15
Il s’agit du numéro de confirmation retourné par Paysafe.
merchantRefNum Facultatif ChaîneMax = 255
Il s’agit du numéro d’identification unique qui a été créé par le marchand et soumis dans la requête.
childAccountNum Facultatif ChaîneMax = 10
Il s’agit du numéro de compte de marchand enfant et il n’est fourni que si la transaction a été traitée au moyen d’un compte principal.
decision Oui Énumération Il s’agit de l’état de la transaction. Une des valeurs suivantes sera retournée :• Accepted – La transaction a été
traitée.• Error – La tentative de transaction a
échoué en raison d’une erreur.• Declined – La transaction a été
refusée avant qu’elle soit envoyée pour traitement.
• Hold – La transaction a été mis en attente en raison de considérations de risque.
code Oui Entier Il s’agit d’un code numérique servant à catégoriser la réponse. Consultez la rubrique Codes de réponse à la page B-1.
actionCode Facultatif Énumération Ceci indique l’action que l’appelant devrait effectuer. Les valeurs possibles sont :• C = Erreur de paramètre du client.
Les renseignements fournis par le client sont incorrects. Confirmez les renseignements auprès du cli-ent.
• D = Ne pas réessayer. Les tentatives subséquentes échoueront.
• M = Erreur de paramètre du march-and. Les renseignements fournis par votre application sont incor-rects. Vérifiez vos renseignements.
• R = Réessayer. Le problème est tem-poraire. La prochaine tentative réussira probablement.
description Oui ChaîneMax = 1024
Il s’agit de la description accessible à l’utilisateur de l’élément code.
authCode Facultatif ChaîneMax = 20
Il s’agit du code d’autorisation attribué par la banque émettrice et retourné par Paysafe.
3-50
mai 2019 Traitement de la réponse
avsResponse Facultatif Énumération Il s’agit de la réponse AVS de l’émet-teur de la carte. Les valeurs possibles sont :• X – Exact. Correspondance entre le
code Zip de neuf chiffres et l’adresse.
• Y – Oui. Correspondance entre le code Zip de cinq chiffres et l’adresse.
• A – L’adresse correspond, mais le code Zip ne correspond pas.
• W – Le code Zip de neuf chiffres cor-respond, mais l’adresse ne corre-spond pas.
• Z – Le code Zip de cinq chiffres cor-respond, mais l’adresse ne corre-spond pas.
• N – Aucun élément de l’adresse ne correspond.
• U – L’information sur l’adresse n’est pas disponible.
• R – Réessayer. Le système est inca-pable de faire le traitement.
• S – L’AVS n’est pas pris en charge.• E – L’AVS n’est pas pris en charge
dans le cas de cette industrie. • B – L’AVS n’a pas été exécuté.• Q – Réponse inconnue de l'émet-
teur/banknet switch.
cvdResponse Facultatif Énumération Il s’agit de la réponse à l’élément cvd-Value soumis dans la requête de transaction. Les valeurs possibles sont :• M (Match) – La valeur CVD fournie
correspond à la valeur CVD asso-ciée à la carte.
• N (No Match) – La valeur CVD fournie ne correspond pas à la val-eur CVD associée à la carte.
• P (Not Processed) – La valeur CVD n’a pas été traitée.
• Q (Unknown Response) – Aucun résultat n’a été reçu concernant la valeur CVD.
• S (Not Present) – Le CVD devrait apparaître sur la carte. Toutefois, le titulaire de la carte a indiqué qu’il n’y était pas.
• U – L’émetteur n’est pas certifié ou il n’a pas fourni les clés de chiffre-ment Visa.
Tableau 3-12 : Éléments d’une transaction ccTxnResponseV1 (suite)
Élément Élément enfant Requis Type Description
Guide de référence de l’API pour les Services Web 1.0 3-51
Transactions par carte de crédit ou de débit mai 2019
detail tag Facultatif ChaîneMax = 30
Il s’agit de la paire étiquette/valeur retournée comme composante de l’élément detail. Consultez la rubrique Paires étiquette/valeur detail à la page 3-56 pour obtenir plus de détails.
value Facultatif ChaîneMax = 1024
txnTime Oui dateTime Il s’agit de la date et de l’heure aux-quelles la transaction a été traitée par Paysafe.
duplicateFound Oui Booléen Cela indique si cette transaction est une transaction en double, lor-squ’une vérification en double a été demandée.
duplicateTransactionResponse
Facultatif CCTxnRespon-seV1
Si un enregistrement en double est repéré, cet élément contient les détails de cet enregistrement.
tdsResponseCet élément et ses élé-ments enfants sont seulement retournés en réponse à la requête de transaction ccEnrollmentLookup-RequestV1.
acsURL Facultatif ChaîneMax = 255
Cette URL est totalement qualifiée pour inviter le consommateur à exécuter la transaction Requête d’authentification de paiement.
paymentRequest Facultatif Chaîne Il s’agit d’une requête d’authentifica-tion de paiement générée par le sys-tème de traitement de l’authentification du marchand (MAPS).
enrollmentStatus Oui Énumération Cela indique si le titulaire de la carte est inscrit ou non à 3D Secure. Les valeurs possibles sont :• Y – Authentification disponible• N – Titulaire de la carte non inscrit• U – Authentification non disponible• E – Erreur
Tableau 3-12 : Éléments d’une transaction ccTxnResponseV1 (suite)
Élément Élément enfant Requis Type Description
3-52
mai 2019 Traitement de la réponse
eci Facultatif Énumération Visa/JCB• 05 – Identifie une transaction
authentifiée avec succès.• 06 – Identifie une tentative de
transaction authentifiée.• 07 – Identifie une transaction qui
n’a pas été authentifiée.
Mastercard• 01 – Identifie une transaction qui
n’a pas été authentifiée.• 02 – Identifie une transaction
authentifiée avec succès.
Si le titulaire de la carte n’est pas inscrit au système 3D Secure, vous pouvez utiliser la valeur de cet indica-teur de commerce électronique pour l’élément enfant de l’indicateur indi-cator de l’élément authentication dans votre requête d’autorisation ou d’achat ccAuthRequestV1.Toutefois, si le titulaire de la carte est inscrit au système 3D Secure, utilisez la valeur eci de l’élément tdsAuthenti-cateResponse ci-dessous.
tdsAuthenticateResponseCet élément et ses élé-ments enfants sont seulement retournés en réponse à la requête de transaction ccAuthenticateRequestV1.
status Oui Énumération Cela indique le résultat de la requête d’authentification. Les valeurs possibles sont :• Y – Le titulaire de la carte a authen-
tifié avec succès sa carte auprès de l’émetteur.
• A – Le titulaire de la carte a tenté de l'authentifier.
• N – Le titulaire de la carte n’a pas réussi à authentifier sa carte auprès de l’émetteur.
• U – L’authentification par l’émet-teur de la carte n’était pas dis-ponible.
• E – Erreur
cavv Facultatif ChaîneMax = 80
Il s’agit de la valeur de vérification de l’authentification du titulaire de la carte qui a été retournée par l’émet-teur de la carte. Utilisez cette valeur pour l’élément enfant de indicator de l’élément authentication dans une requête ccAuthRequestV1.
signatureVerifica-tion
Oui Énumération Cela indique si l’élément paymen-tResponse qui a été soumis dans la requête d’authentification a réussi les vérifications d’intégrité. Les valeurs possibles sont : • Y – Toutes les vérifications de trans-
action et de signature ont été réussies.
• N – Au moins une vérification de transaction ou de signature a échoué.
Tableau 3-12 : Éléments d’une transaction ccTxnResponseV1 (suite)
Élément Élément enfant Requis Type Description
Guide de référence de l’API pour les Services Web 1.0 3-53
Transactions par carte de crédit ou de débit mai 2019
xid Facultatif ChaîneMax = 80
Il s’agit d’un identifiant de transaction retourné en réponse à une requête d’authentification ccAuthenticateReq-uestV1.
eci Facultatif Énumération Utilisez la valeur de l’élément enfant de l’indicateur de commerce électro-nique indicator de l’élément authenti-cation dans votre requête d’autorisation ou d’achat ccAuthRe-questV1.Visa/JCB• 05 – Identifie une transaction
authentifiée avec succès.• 06 – Identifie une tentative de
transaction authentifiée.• 07 – Identifie une transaction qui
n’a pas été authentifiée.
Mastercard• 01 – Identifie une transaction qui
n’a pas été authentifiée.• 02 – Identifie une transaction
authentifiée avec succès.
lbCascading Facultatif Cet élément fournit l’information con-cernant les transactions qui ont été essayées de nouveau à cause du part-age de la charge.
retryCount Conditionnel Entier Il s’agit du nombre de fois que Paysafe a essayé la transaction de nouveau.
originalCode Conditionnel Entier Le code de réponse original retourné par le système qui a poussé Paysafe à essayer la transaction de nouveau.
addendumResponse Facultatif Cet élément permet à Paysafe de retourner au marchand certaines val-eurs particulières à la passerelle.
service Conditionnel Chaîne
Max = 50
Il s’agit du fournisseur de services qui fournit les valeurs pour la paire éti-quette/valeur.
detail Conditionnel Il peut exister plusieurs éléments detail, au besoin.
Élément enfant de detail
tag Conditionnel Chaîne
Max = 30
Il s’agit de la paire étiquette/valeur retournée en tant qu’élément de addendumResponse. Consultez la rubrique Paires étiquette/valeur pour addendumResponse à la page 3-57 pour obtenir plus de détails.
value Conditionnel Chaîne
Max = 30
amount Facultatif ChaîneMax=999999999,99
Il s’agit du montant de la requête de transaction.
Tableau 3-12 : Éléments d’une transaction ccTxnResponseV1 (suite)
Élément Élément enfant Requis Type Description
3-54
mai 2019 Traitement de la réponse
tranTypeREMARQUE : L’élément tranType est renvoyée uniquement en réponse à une requête ccTxnLooku-pRequestV1.
Facultatif Énumération Il s’agit du type de transaction pour laquelle vous avez fait une recherche.Les valeurs possibles sont :• A – Authorization (autorisation)• S – Settlement (règlement)• P – Purchase (achat)• CR – Credit (crédit)• PY – Payment (paiement)• N – Independent Credit (crédit
indépendant)
cardEndingREMARQUE : L’élément cardEnding est renvoyée uniquement en réponse à une requête ccTxnLooku-pRequestV1.
Facultatif ChaîneMax = 4
Il s’agit des quatre derniers chiffres de la carte utilisée pour cette transac-tion.
cardExpiryREMARQUE : L’élément cardExpiry est renvoyée uniquement en réponse à une requête ccTxnLooku-pRequestV1.
Facultatif
month Conditionnel Entier Max = 2
Il s’agit du mois d’expiration de la carte de crédit.
year Conditionnel EntierLongueur = 4
Il s’agit de l’année d’expiration de la carte de crédit.
netbanxReferenceREMARQUE : L’élément netbanxReference est ren-voyée uniquement en réponse à une requête ccTxnLookupRequestV1.
Facultatif ChaîneMax = 18
Il s’agit d’un numéro de transaction utilisé pour identifier certaines trans-actions existantes.
txnLookupResultREMARQUE : L’élément txnLookupResult est ren-voyée uniquement en réponse à une requête ccTxnLookupRequestV1.
Conditionnel Ceci contient tous les éléments conte-nus dans la ccTxnResponseV1 stan-dard qui aurait été retournés dans la requête intiale, en plus des éléments dans cette tableau qui sont identifiés comme étant seulement retournés dans la réponse à ccTxnLookupRe-questV1 (par ex., tranType).
profile id Facultatif ChaîneMax = 50
card Conditionnel
Élément enfant de card
id Conditionnel ChaîneMax = 50
Il s’agit de l’ID de la carte retournée par Paysafe, qui permet d’identifier la carte du profil.
lastFourDigits Conditionnel Entier Il s’agit des quatre derniers chiffres du numéro de carte associé au profil.
paymentToken Conditionnel ChaîneMax = 50
Il s’agit du jeton généré par Paysafe qui représente la carte.
Tableau 3-12 : Éléments d’une transaction ccTxnResponseV1 (suite)
Élément Élément enfant Requis Type Description
Guide de référence de l’API pour les Services Web 1.0 3-55
Transactions par carte de crédit ou de débit mai 2019
Pour traiter la réponse :
1. Obtenez les détails de la réponse qui sont accessibles à partir des modes get() de la réponse.
String responseTxt = ccTxnResponse.code + " - " + ccTxnResponse.decision + " - " + ccTxnResponse.description ;
responseTxt += "Details:" + Environment.NewLine;if (ccTxnResponse.detail != null) {
for (int i = 0; i < ccTxnResponse.detail.Length; i++) {
responseTxt += " - " + ccTxnResponse.detail[i].tag + " - " +ccTxnResponse.detail[i].value + Environment.NewLine;
}}responseTxt = responseTxt.Replace("\n", Environment.NewLine);System.Console.WriteLine(responseTxt);
if (DecisionV1.ACCEPTED.Equals(ccTxnResponse.decision)){
System.Console.WriteLine("Transaction Successful.");}else{
System.Console.WriteLine("Transaction Failed with decision: " +ccTxnResponse.decision);
}
2. Traitez la réponse en fonction de l’élément decision. Vous insérez le code de gestion approprié à votre application. Vous pouvez également consulter l’élément code pour obtenir un contrôle plus serré de votre application. Pour obtenir plus de détails, consultez la rubrique Codes de réponse à la page B-1.
Paires étiquette/valeur detail
Le tableau suivant contient les paires étiquette/valeur compatibles avec l’élément data.
Certaines passerelles de traitement peuvent ne pas prendre en charge toutes les paires éti-quette/valeur detail. Communiquez avec votre gestionnaire de compte pour obtenir plus de détails.
Tableau 3-13 : Paires étiquette/valeur detail
Étiquette Valeur
CurrencyCode Cette valeur est retournée si l’élément étiquette addendumData de la transac-tion initiale a été réglé à SERVICE_REQUEST_CURRENCY.La valeur figure dans les codes de devises du Tableau 3-15 : Codes de devises à la page 3-57.
BalanceResponse Cette valeur correspond au solde d’une carte-cadeau, lorsqu'une carte-cadeau a été utilisée pour la transaction initiale. Veuillez noter que le signe décimal des devises est sous-entendu ; par exemple, « 16500 » en dollars = 165,00 $.
3-56
mai 2019 Paires étiquette/valeur pour addendumResponse
Paires étiquette/valeur pour addendumResponse
Le tableau suivant contient les paires étiquette/valeur compatibles avec l’élément addendumRe-sponse.
Codes de devises
Certaines passerelles de traitement peuvent ne pas prendre en charge toutes les paires éti-quette/valeur pour addendumResponse. Communiquez avec votre gestionnaire de compte pour obtenir plus de détails.
Tableau 3-14 : Paires étiquette/valeur pour addendumResponse
Étiquette Service Valeur
BATCH_NUMBER DJN Il s’agit de votre numéro de lot.
EFFECTIVE_DATE DJN Il s’agit de la date du dépôt bancaire associé à la transaction. Format = AAMMJJ
SEQ_NUMBER DJN Il s’agit de votre numéro de séquence.
TERMINAL_ID DJN Il s’agit de l’ID de votre terminal.
Tableau 3-15 : Codes de devises
Code Devise
ARS Peso argentin
AUD Dollar australien
BGN Lev bulgare
BRL Réal brésilien
CAD Dollar canadien
CHF Franc suisse
CZK Couronne tchèque
DKK Couronne danoise
EUR Euro
GBP Livre sterling
HKD Dollar de Hong Kong
HUF Forint hongrois
ILS Nouveau Shekel israélien
ISK Couronne islandaise
JPY Yen
MXN Peso mexicain
NOK Couronne norvégienne
NZD Dollar néo-zélandais
Guide de référence de l’API pour les Services Web 1.0 3-57
Transactions par carte de crédit ou de débit mai 2019
PLN Zloty polonais
RON Leu roumain
SEK Couronne suédoise
SGD Dollar de Singapour
THB Baht
TWD Nouveau dollar de Taïwan
USD Dollar américain
ZAR Rand
Tableau 3-15 : Codes de devises (suite)
Code Devise
3-58
CHAPTER 4
Transactions du service deconsultation des données
IntroductionL’opération du service de consultation des données (ILS) vous permet de produire un rapport à l’aide de l’API pour une plage de temps que vous précisez, afin de recevoir les données concernant les autor-isations, les règlements, les crédits et les rétrofacturations qui sont traités par un compte de marchand. Vous pouvez utiliser l’élément type pour combiner un ou plusieurs types de transaction dans une même requête. Consultez le Tableau 4-1 : Éléments de transaction ilsLookupRequestV1 à la page 4-5 pour en connaître davantage à propos de l’élément type.
Ce chapitre décrit comment traiter l’opération ILS à l’aide du Service Web de traitement des transac-tions.
• L’opération ILS accepte un objet de document ilsLookupRequestV1.
• L’opération ILS retourne une réponse ilsLookupResponseV1.
WSDL et liens ILS PaysafeWSDL :
https://webservices.optimalpayments.com/ilsWS/IlsService/v1?wsdl
Service Web :
https://webservices.optimalpayments.com/ilsWS/IlsService/v1
Publication HTTP :
https://webservices.optimalpayments.com/ilsWS/IlsServlet/v1
La période maximale couverte dans une requête ILS est de 24 heures.
Guide de référence de l’API pour les Services Web 1.0 4-1
Transactions du service de consultation des données mai 2019
Exemple .NET
Pour bâtir l’exemple pour .NET :
1. Créez un nouveau projet.
2. Ajoutez une référence Web.
4-2
mai 2019 Bâtir des requêtes ILS
3. Saisissez l’URL WSDL et cliquez sur le bouton Ajouter une référence.
Le client Web est maintenant créé.
4. Bâtissez la requête et traitez la réponse : Consultez la rubrique Bâtir des requêtes ILS à la page 4-3.
Bâtir des requêtes ILSLes requêtes ILS requièrent l’objet de document ilsLookupRequestV1. La présente rubrique décrit la structure d’une requête ilsLookupRequestV1 et la façon de la bâtir. Pour obtenir des détails sur les élé-ments requis, consultez le Tableau 4-1 : Éléments de transaction ilsLookupRequestV1 à la page 4-5.
ILS – C#Voici un exemple de ILS en C#.
//Prepare the call to the Credit Card Web ServiceILSLookupRequestV1 ilsLookupRequest = new ILSLookupRequestV1();MerchantAccountV1 merchantAccount = new MerchantAccountV1();merchantAccount.accountNum = "12345678";merchantAccount.storeID = "myStoreID";merchantAccount.storePwd = "myStorePWD";
Guide de référence de l’API pour les Services Web 1.0 4-3
Transactions du service de consultation des données mai 2019
DateV1 startDate = new DateV1();startDate.year = 2008;startDate.month = 11;startDate.day = 3;startDate.hour = 0;startDate.minute = 0;startDate.second = 0;
DateV1 endDate = new DateV1();endDate.year = 2008;endDate.month = 11;endDate.day = 3;endDate.hour = 14;endDate.minute = 40;endDate.second = 59;
RequestTypeV1[] txnTypes = new RequestTypeV1[1];txnTypes[0] = RequestTypeV1.settlements;
IlsLookupRequestV1 req = new IlsLookupRequestV1();req.merchantAccount = merchantAccount;req.startDate = startDate;req.endDate = endDate;req.type = txnTypes;
System.Console.WriteLine("Sending request...");
IlsServiceV1 ilsService = new IlsServiceV1();IlsLookupResponseV1 response = null;
response = ilsService.ilsLookup( req );
System.Console.WriteLine("Response received: ");String responseTxt = "";
if( response != null ){
responseTxt += "Decision: " + response.decision + Environment.NewLine;responseTxt += "Description: " + response.description +
Environment.NewLine;
if( response.decision == DecisionV1.ACCEPTED ){
responseTxt += "Authorizations: " + response.transactions.authorizations + Environment.NewLine;
responseTxt += "Settlements: " + response.transactions.settlements + Environment.NewLine;
responseTxt += "Chargebacks: " + response.transactions.chargebacks + Environment.NewLine;
responseTxt += "Credits: " + response.transactions.credits + Environment.NewLine;
}}
System.Console.WriteLine( responseTxt );
4-4
mai 2019 Diagramme de transaction ilsLookupRequestV1
Diagramme de transaction ilsLookupRequestV1Une transaction ilsLookupRequestV1 respecte la structure suivante :
Éléments de transaction ilsLookupRequestV1L’objet de document ilsLookupRequestV1 contient les éléments suivants :
Tableau 4-1 : Éléments de transaction ilsLookupRequestV1
Élément Élément enfant Requis Type Description
merchantAccount accountNum Oui ChaîneMax = 10
Il s’agit du numéro de compte de marchand.
storeID Oui Chaîne Max = 80
Il s’agit de l’identifiant du magasin traitant la transaction; il sert à authentifier la requête. Pay-safe le définit et le fournit au marchand comme élément du processus d’intégration.
storePwd Oui ChaîneMax = 20
Il s’agit du mot de passe du magasin traitant la transaction; il sert à authentifier la requête. Pay-safe le définit et le fournit au marchand comme élément du processus d’intégration.
startDate year Oui EntierMax = 9999
Il s’agit de l’année fixée pour le début de la recherche.
Guide de référence de l’API pour les Services Web 1.0 4-5
Transactions du service de consultation des données mai 2019
month Oui Entier Min = 1Max = 12
Il s’agit du mois fixé pour le début de la recher-che.
day Oui EntierMin = 1Max = 31
Il s’agit du jour fixé pour le début de la recher-che.
hour Oui EntierMin = 0Max = 23
Il s’agit de l’heure fixée pour le début de la recherche.
minute Oui Entier Min = 0Max = 59
Il s’agit de la minute fixée pour le début de la recherche.
second Oui EntierMin = 0Max = 59
Il s’agit de la seconde fixée pour le début de la recherche.
endDate year Oui EntierMax = 9999
Il s’agit de l’année fixée pour la fin de la recher-che.
month Oui Entier Min = 1Max = 12
Il s’agit du mois fixé pour la fin de la recherche.
day Oui EntierMin = 1Max = 31
Il s’agit du jour fixé pour la fin de la recherche.
hour Oui EntierMin = 0Max = 23
Il s’agit de l’heure fixée pour la fin de la recher-che.
minute Oui Entier Min = 0Max = 59
Il s’agit de la minute fixée pour la fin de la recherche.
second Oui EntierMin = 0Max = 59
Il s’agit de la seconde fixée pour la fin de la recherche.
type Oui Énumération Il s’agit du type de transaction pour laquelle vous faites une recherche de données. Les val-eurs possibles sont :• authorizations (autorisations)• settlements (règlements)• credits (crédits)• chargebacks (rétrofacturations)• dd-charge (facturation par débit direct)• dd-credit (crédit par débit direct)• dd-charge-bacs (retourne l‘élément mandat-
eReference)• dd-credit-bacs (retourne l‘élément mandat-
eReference)• dd-mandate-bacs (retourne les éléments
mandateReference et effectiveDate)
Tableau 4-1 : Éléments de transaction ilsLookupRequestV1 (suite)
Élément Élément enfant Requis Type Description
4-6
mai 2019 Traitement de la réponse
Traitement de la réponseVoici un exemple d’une requête ilsLookupResponseV1 typique concernant une transaction réussie. Consultez le Tableau 4-2 : Éléments de transaction ilsLookupResponseV1 à la page 4-9 pour obtenir la description des paramètres retournés.
<ilsLookupResponseV1 xmlns="http://www.optimalpayments.com/ils/xmlschema/v1"><decision>ACCEPTED</decision><description/><merchantAccount>10000400036</merchantAccount><currency>USD</currency><startDate>
<year>2011</year><month>2</month>
ccOptions Facultatif Énumération Pour usage interne seulement.
ddOptions Facultatif
dateType Facultatif Énumération Ceci précise la nature de l’état de la transaction recherchée. Les valeurs possibles sont :• initiation – La recherche sera effectuée sur
toutes les chèques présentés durant la péri-ode indiquée. Si la valeur dateType n’est pas indiquée, il s’agit de la valeur par défaut.
• status_change – La recherche sera effectuée sur toutes les chèques dont l’état a changé durant la période indiquée.
status Facultatif Énumération La requête de consultation n’enverra que les transactions dont l’état est indiqué ici. Lorsque cette valeur est combinée à l’élément status_change, seuls les enregistrements ayant l’état indiqué durant la période seront retournés. Si cet élément n’est pas indiqué, les transac-tions sont retournées, quel que soit l’état.Les valeurs possibles sont :• Presented (Présentée) • Represented (Représentée) • Returned (Retournée) • Pending Customer Approval (Approbation cli-
ent en attente)• Pending (En attente)• Active (Actif)• Declined (Refusée)• Cancelled (Annulée)• Failed (Échec)• Cleared (Traitée)
La période maximale couverte dans une requête ILS est de 24 heures.
Tableau 4-1 : Éléments de transaction ilsLookupRequestV1 (suite)
Élément Élément enfant Requis Type Description
Guide de référence de l’API pour les Services Web 1.0 4-7
Transactions du service de consultation des données mai 2019
<day>5</day><hour>0</hour><minute>0</minute><second>0</second>
</startDate><endDate>
<year>2011</year><month>3</month><day>5</day><hour>23</hour><minute>59</minute><second>59</second>
</endDate><txnType>
<code>authorizations</code><count>2</count>
</txnType><txnType><code>settlements</code>
<count>2</count></txnType><txnType>
<code>credits</code><count>1</count>
</txnType><txnType>
<code>chargebacks</code><count>1</count>
</txnType><transactions childFma='1000201930'>
<authorizations>100052493|FS|2011-02-05 09:57:54|test 123|111.65</authorizations><settlements>100052493|C|2011-02-05 09:57:55|test 123|111.65</settlements><credits>116883988|C|2011-03-02 15:17:09|test 123|5.0|102318569|USD</credits><chargebacks>368237|100052493|test 123|test 123|1111|2011-02-05|111.65|USD|111.65|30|40003610000160100052493|100000|1||2008-02-05</chargebacks>
</transactions><transactions childFma='1000201931'>
<authorizations>100052493|FS|2011-02-05 09:57:54|test 123|88.00</authorizations><settlements>100052493|C|2011-02-05 09:57:55|test 123|88.00</settlements>
</transactions></ilsLookupResponseV1>
Ce qui suit est un exemple d'une valeur typique ilsLookupResponseV1 en cas de transaction rejetée. Dans cet exemple, un code de marchand ou un mot de passe erroné a été entré.
<ilsLookupResponseV1 xmlns="http://www.optimalpayments.com/ils/xmlschema/v1"> <decision>REJECTED</decision> <description>Invalid Credentials</description></ilsLookupResponseV1>
4-8
mai 2019 Diagramme de transaction ilsLookupResponseV1
Diagramme de transaction ilsLookupResponseV1Une transaction ilsLookupResponseV1 respecte la structure suivante :
Les éléments suivants sont pertinents dans le cas d’une réponse ilsLookupResponseV1 :
Tableau 4-2 : Éléments de transaction ilsLookupResponseV1
Élément Élément enfant Requis Type Description
decision Oui Énumération Il s’agit de l’état de la transaction. Une des val-eurs suivantes sera retournée :• Accepted – La transaction a été traitée.• Error – La tentative de transaction a échoué
en raison d’une erreur.• Rejected – La requête a été rejetée, à cause
des justificatifs d’identité invalides du marchand, par exemple.
description Oui ChaîneMax = 1024
Si la décision retournée est Error ou Rejected, il s’agit d’une description de l’erreur.
merchantAccount Oui ChaîneMax = 10
Il s’agit du numéro de compte de marchand.
currency Oui ChaîneLongueur = 3
Il s’agit de la devise du compte de marchand.
startDate year Oui EntierMax = 9999
Il s’agit de l’année fixée pour la date de début de la recherche.
month Oui Entier Min = 1Max = 12
Il s’agit du mois fixé pour la date de début de la recherche.
day Oui EntierMin = 1Max = 31
Il s’agit du jour fixé pour la date de début de la recherche.
Guide de référence de l’API pour les Services Web 1.0 4-9
Transactions du service de consultation des données mai 2019
hour Oui EntierMin = 0Max = 23
Il s’agit de l’heure fixée pour l’heure de début de la recherche.
minute Oui Entier Min = 0Max = 59
Il s’agit de la minute fixée pour l’heure de début de la recherche.
second Oui EntierMin = 0Max = 59
Il s’agit de la seconde fixée pour l’heure de début de la recherche.
endDate year Oui EntierMax = 9999
Il s’agit de l’année fixée pour la date de fin de la recherche.
month Oui Entier Min = 1Max = 12
Il s’agit du mois fixé pour la date de fin de la recherche.
day Oui EntierMin = 1Max = 31
Il s’agit du jour fixé pour la date de fin de la recherche.
hour Oui EntierMin = 0Max = 23
Il s’agit de l’heure fixée pour l’heure de la fin de la recherche.
minute Oui Entier Min = 0Max = 59
Il s’agit de la minute fixée pour l’heure de la fin de la recherche.
second Oui EntierMin = 0Max = 59
Il s’agit de la seconde fixée pour l’heure de la fin de la recherche.
txnType code Oui Chaîne Il s’agit du type de transaction pour laquelle vous avez fait une recherche de données. Les valeurs possibles sont :• authorizations (autorisations)• settlements (règlements)• credits (crédits)• chargebacks (rétrofacturations)• dd-charge (facturation)• dd-credit (crédit)• dd-charge-bacs (inclut l‘élément mandat-
eReference)• dd-credit-bacs (inclut l‘élément mandat-
eReference)• dd-mandate-bacs (inclut les éléments
mandateReference et effectiveDate)
count Oui Entier Il s’agit du numéro de type de transaction retourné dans l’élément code ci-dessus. Chaque élément code retourné possède son propre count.
transactions Facultatif
Tableau 4-2 : Éléments de transaction ilsLookupResponseV1 (suite)
Élément Élément enfant Requis Type Description
4-10
mai 2019 Contenu de l’élément de réponse
Contenu de l’élément de réponsePaysafe peut, sans préavis, lorsque nécessaire, ajouter des éléments de détails additionnels à chacun des types de réponses des transactions décrites ci-dessous (autorisations, règlements, crédits et rétro-facturations).
Ces éléments de détails seront ajoutés à la fin de la liste actuelle d’éléments séparés par des barres ver-ticales, comme l’illustre l’exemple ci-dessous.
<ilsLookupResponseV1 xmlns="http://www.optimalpayments.com/ils/xmlschema/v1">…
<transactions childFma='1000201930'><authorizations>100052493|FS|2011-02-05 09:57:54|test 123|111.65|added element|added element</authorizations><settlements>100052493|C|2011-02-05 09:57:55|test 123|111.65|added element|added element</settlements><credits>116883988|C|2011-03-02 15:17:09|test 123|5.0|102318569|USD|added element|added element</credits><chargebacks>368237|100052493|test 123|test 123|1111|2011-02-05
Attribut de transactions
childFma Conditionnel ChaîneMax = 10
Il s’agit du numéro de compte de marchand enfant et il n’est fourni que si le compte déter-miné comme élément merchantAccount est un compte principal.
authorizations Facultatif Chaîne Chaque instance de authorizations contient plus de détails. Consultez la rubrique Détails dans la réponse aux requêtes d’autorisation à la page 4-12 pour obtenir une description.
settlements Facultatif Chaîne Chaque instance de settlements contient plus de détails. Consultez la rubrique Détails dans la réponse aux requêtes de règlement à la page 4-12 pour obtenir une description.
credits Facultatif Chaîne Chaque instance de credits contient plus de détails. Consultez la rubrique Détails dans la réponse aux requêtes de crédit à la page 4-13 pour obtenir une description.
chargebacks Facultatif Chaîne Chaque instance de chargebacks contient plus de détails. Consultez la rubrique Détails dans la réponse aux requêtes de rétrofactura-tion à la page 4-13 pour obtenir une descrip-tion.
dd-charge Facultatif Chaîne Chaque instance de dd-charge, dd-credit, dd-charge-bacs, dd-credit-bacs, et dd-mandate-bacs contient plus de détails. Consultez la rubrique Détails dans la réponse aux requêtes de prélèvement automatique (débit direct) à la page 4-14 pour obtenir une description.
dd-credit Facultatif Chaîne
dd-charge-bacs Facultatif Chaîne
dd-credit-bacs Facultatif Chaîne
dd-mandate-bacs Facultatif Chaîne
Tableau 4-2 : Éléments de transaction ilsLookupResponseV1 (suite)
Élément Élément enfant Requis Type Description
Guide de référence de l’API pour les Services Web 1.0 4-11
Transactions du service de consultation des données mai 2019
|111.65|USD|111.65|30|40003610000160100052493|100000|1||2008-02-05|added element</chargebacks>
…</ilsLookupResponseV1>
Détails dans la réponse aux requêtes d’autorisationLes détails suivants peuvent être retournés pour une requête d’autorisation :
Détails dans la réponse aux requêtes de règlementLes détails suivants peuvent être retournés pour une requête de règlement :
Il incombe au marchand de s’assurer que son intégration pour la requête ilsLookupRequestV1 n’est pas touchée de façon négative lorsque Paysafe ajoute des éléments de détails addition-nels.
Tableau 4-3 : Détails dans la réponse aux requêtes d’autorisation
Paramètre Description
Record Sequence (séquence des enregis-trements)
Il s’agit du numéro de confirmation de la transaction qui a été attribué par Paysafe.
Authorization Status (état de l’autorisa-tion)
Il s’agit de l’état de l’autorisation. Les valeurs possibles sont :• A – Autorisée• FS – Complètement réglée• AS – Partiellement réglée
Transaction Date/Time (date et heure de la transaction)
Il s’agit de la date et de l’heure du traitement de l’autorisation.
Merchant Transaction ID (ID de transac-tion du marchand)
Il s’agit de l’ID de transaction qui a été attribué par le marchand à l’autorisation.
Amount (montant) Il s’agit du montant de l’autorisation.
Tableau 4-4 : Détails dans la réponse aux requêtes de règlement
Paramètre Description
Record Sequence (séquence des enregis-trements)
Il s’agit du numéro de confirmation de la transaction qui a été attribué par Paysafe.
Settlement Status (état du règlement) Il s’agit de l’état actuel de la transaction de règlement. Les valeurs possibles sont :• B – Mise en lot• E – Erreur• P – En attente• C – Complétée• K – Annulée• HO – En suspens• DE – Refusée• MI – Manuelle
Transaction Date/Time (date et heure de la transaction)
Il s’agit de la date et de l’heure du traitement du règlement.
Merchant Transaction ID (ID de transac-tion du marchand)
Il s’agit de l’ID de transaction qui a été attribué par le marchand au règlement.
Amount (montant) Il s’agit du montant du règlement.
4-12
mai 2019 Contenu de l’élément de réponse
Détails dans la réponse aux requêtes de créditLes détails suivants peuvent être retournés pour une requête de crédit :
Détails dans la réponse aux requêtes de rétrofacturationLes détails suivants peuvent être retournés pour une requête de rétrofacturation :
Tableau 4-5 : Détails dans la réponse aux requêtes de crédit
Paramètre Description
Record Sequence (séquence des enregistrements)
Il s’agit du numéro de confirmation de la transaction qui a été attribué par Paysafe.
Credit Status (état du crédit) Il s’agit de l’état du règlement maintenant crédité. Les valeurs possibles sont :• B – Mise en lot• E – Erreur• P – En attente• C – Complétée• K – Annulée• HO – En suspens• DE – Refusée• MI – Manuelle
Transaction Date/Time (date et heure de la transaction)
Il s’agit de la date et de l’heure du traitement du crédit.
Merchant Transaction ID (ID de trans-action du marchand)
Il s’agit de l’ID de transaction qui a été attribué au crédit par le marchand.
Amount (montant) Il s’agit du montant du crédit.
Settlement Record Sequence (séquence des enregistrements de règlements)
Il s’agit du numéro de confirmation initialement attribué au règlement qui a été crédité.
Tableau 4-6 : Détails dans la réponse aux requêtes de rétrofacturation
Paramètre Description
Chargeback ID (ID de rétrofacturation) Il s’agit de l’ID d’enregistrement dans notre système de gestion des litiges. Chaque rétrofacturation possède un ID d’enregistrement unique permettant de l’identifier.
Authorization Transaction ID (ID de transaction d’autorisation)
Il s’agit de l’ID de transaction que Paysafe a attribué à la requête d’autorisation ini-tiale.
Authorization Merchant Transaction ID (ID de transaction d’autorisation du marchand)
Il s’agit de l’ID de transaction qui a été attribué par le marchand à la transaction d’autorisation initiale.
Settlement Merchant Transaction ID (ID de transaction de règlement du march-and)
Il s’agit de l’ID de transaction qui a été attribué par le marchand au règlement ayant fait l’objet d’une rétrofacturation.
Card Ending (fin de la carte) Il s’agit des quatre derniers chiffres de la carte de crédit utilisée pour la transaction d’autorisation initiale.
Original Settlement Date (date initiale de règlement)
Il s’agit de la date du règlement de la transaction d’autorisation initiale. Format = aaaa-mm-jj
Original Settlement Amount (montant du règlement initial)
Il s’agit du montant du règlement appliqué sur la transaction d’autorisation initiale.
Currency Code (code de devise) Il s’agit de la devise du compte de marchand.
Guide de référence de l’API pour les Services Web 1.0 4-13
Transactions du service de consultation des données mai 2019
Détails dans la réponse aux requêtes de prélèvement automatique (débit direct)Les détails suivants peuvent être retournés pour une requête de prélèvement automatique :
Chargeback Amount (montant de la rétrofacturation)
Il s’agit du montant de la rétrofacturation du règlement.
Reason Code (code de motif) Il s’agit du motif pour lequel la transaction a fait l’objet d’une rétrofacturation. Con-sultez la rubrique Codes de motif à la page 4-15 pour obtenir l’explication des codes.
ARN Il s’agit du numéro de référence de l’acquéreur, un numéro d’identification de référence unique attribué à chaque transaction de règlement par l’acquéreur.
Original Authorization Code (code d’autorisation initial)
Il s’agit du code d’autorisation attribué par la banque émettrice et retourné par Pay-safe lorsque la transaction a été traitée à l’aide du protocole de paiement direct.
CBTY Code (code CBTY) Il s’agit du type de rétrofacturation. Les valeurs possibles sont :• 1 – Rétrofacturation• 2 – Inversion de rétrofacturation• C – Avis de risque seulement • D – Refacturation refusée/perdue • RET – Demande de récupération
Disputed Flag (indicateur de litige) Cet indicateur signale qu’une transaction est en litige. Les valeurs possibles sont :• Null (nul)• Yes (oui)
FMA Posting Date (date de publication FMA)
Il s’agit de la date à laquelle la rétrofacturation a été publiée dans le compte de marchand.Format = aaaa-mm-jj
Tableau 4-7 : Détails dans la réponse aux requêtes de prélèvement automatique
Paramètre Description
Echeck ID (ID de prélèvement automa-tique)
Il s’agit du numéro de confirmation de la transaction qui a été attribué par Paysafe.
Echeck Status (L’état du chèque électro-nique)
Il s’agit de l’état actuel de la transaction de prélèvement automatique.Les valeurs possibles sont :• AP – Mandat approuvé• C – Lot complet• CL – Transaction traitée• DE – Refusée • E – Erreur lot • F – Échec • PR1 – Présentée 1• PR2 – Présentée 2 • RE – Rejetée• REF – Rejet définitif • RF – Remboursée • RV – Inversée • W – En attente d'être mis en lot• X – Annulée (Cancelled)
Presentation Date (Date de présentation) Il s’agit de la date et de l’heure du traitement de la transaction.
Tableau 4-6 : Détails dans la réponse aux requêtes de rétrofacturation (suite)
Paramètre Description
4-14
mai 2019 Codes de motif
Codes de motif
Codes de motifs de rétrofacturationUn des codes de motif de rétrofacturation suivant peut être retourné dans la réponse chargebacks :
Merchant Transaction ID (ID de transac-tion du marchand)
Il s’agit de l’ID de transaction qui a été attribué par le marchand à la transaction.
Amount (Montant) Il s’agit du montant de la requête de transaction. Cette valeur sera réglé à 0,0 si txnType a été fixé à dd-mandate-bacs.
Filtered Status (État filtré ) Lorsque l’élément enfant dateType de ddOptions est réglé à “ initiation ” (la valeur par défaut), cette valeur est la même que la valeur Echeck Status ci-dessus dans le présent tableau.Lorsque l’élément enfant dateType de ddOptions est réglé à “ status_change “, il s’agit de l’état utilisé pour effectuer la recherche. Voici les états retournés pour chaque scénario de recherche.Présentée (Presented)• C
Représentée (Represented)• PR1• PR2
Retournée (Returned)• RE• REF
Latest Status Update Time (Heure de la dernière mise à jour de l’état)
Il s’agit de la date et de l’heure de la dernière mise à jour de l’état.
Return Code (Code de retour) Il s’agit du code de retour si le mandat ou la requête a été retourné par le réseau ban-caire.REMARQUE : Cette valeur est retournée uniquement pour dd-charge-bacs, dd-credit-bacs, et dd-mandate-bacs.
Bank Reference (Référence de la banque) Il s’agit de la référence complète envoyé au réseau bancaire.• Pour dd-mandate-bacs, ce sera le mandateReference à 10 caractères.• Pour dd-charge-bacs, ce sera 18 caractères composé du mandateReference à 10
caractères et l’ID de prélèvement automatique (charge) à 8 caractères
REMARQUE : Cette valeur est retournée uniquement pour dd-charge-bacs, dd-credit-bacs, et dd-mandate-bacs.
Tableau 4-8 : Codes de motif de rétrofacturation Visa/Mastercard
Marque de la carte Code Description
MC 01 Les données de la transaction demandée n’ont pas été reçues.
MC 02 L’article demandé est illisible.
MC 07 Fichier de bulletin d’avis.
MC 08 L'autorisation demandée ou requise n'a pas été obtenue.
MC 12 Numéro de compte inexistant.
Tableau 4-7 : Détails dans la réponse aux requêtes de prélèvement automatique
Paramètre Description
Guide de référence de l’API pour les Services Web 1.0 4-15
Transactions du service de consultation des données mai 2019
VI 30 Services non fournis ou marchandise non reçue.
MC 31 Montant de transaction différent.
MC 34 Traitement en double.
MC 35 Carte non valide ou expirée.
MC 37 Transaction frauduleuse de commande par courrier ou par téléphone.
MC 40 Traitement frauduleux de transaction.
MC 41 Transaction récurrente annulée.
VI 41 Transaction récurrente annulée.
MC 42 Facturation en retard.
MC 47 Transaction hors limite, non autorisée et frauduleuse.
MC 49 Activités douteuses du marchand.
MC 50 Crédit publié en tant que débit.
MC 53 Litige avec le titulaire de la carte, marchandise défectueuse ou non conforme à la descrip-tion.
VI 53 Marchandise non conforme à la description ou défectueuse.
MC 54 Litige avec le titulaire de la carte – Non classifié ailleurs (É.-U. seulement).
MC 55 Marchandise non reçue.
VI 57 Transactions frauduleuses multiples.
MC 59 Services non rendus.
MC 60 Crédit non traité.
VI 60 Copie demandée illisible.
MC 62 Transaction falsifiée, fraude au point de vente liée à la bande magnétique.
VI 62 Transaction falsifiée.
MC 63 Le titulaire de la carte ne reconnaît pas la transaction – Fraude possible.
VI 71 Requête d’autorisation refusée ou autorisation refusée.
VI 72 Aucune autorisation ou transaction hors limite.
VI 73 Carte expirée.
VI 74 Facturation en retard.
VI 75 Le titulaire de la carte ne reconnaît pas la transaction.
VI 76 Code de transaction inexact.
VI 77 Numéro de compte différent.
VI 79 Les données de la transaction demandée n’ont pas été reçues.
Tableau 4-8 : Codes de motif de rétrofacturation Visa/Mastercard (suite)
Marque de la carte Code Description
4-16
mai 2019 Codes de motif de requête de récupération
Codes de motif de requête de récupérationLa réponse chargebacks à la requête de récupération peut retourner un code de motif parmi les codes suivants :
Codes de motifs de rétrofacturation et de requête de récupération pour Discover
Un des codes de motif de rétrofacturation ou de la requête de récupération suivant peut être retourné dans la réponse chargebacks :
VI 80 Montant de transaction ou numéro de compte inexact.
VI 81 Transaction frauduleuse – Transaction avec carte.
VI 82 Traitement en double.
VI 83 Transaction frauduleuse – Transaction sans carte.
VI 85 Crédit non traité.
VI 86 Paiement par d’autres moyens.
Tableau 4-9 : Codes de motif de récupération Visa/Mastercard
Marque de la carte Code Description
MC 05 Soutien des rétrofacturations – Le titulaire de la carte conteste le montant facturé.
MC 21 Demande d’information du titulaire de la carte – Ne reconnaît pas la transaction (nom du marchand, ville, État ou province ou date).
MC 22 Demande d’information du titulaire de la carte – En désaccord avec la facturation.
MC 23 Demande d’information du titulaire de la carte – Requiert l’information pour ses dossiers personnels.
MC 24 Demande d’information du titulaire de la carte – Code d’absence de motif.
VI 28 Le titulaire demande une copie avec signature.
VI 29 Requête pour obtenir les documents T&E.
VI 30 Litige avec le titulaire de la carte, le titulaire de la carte demande une facture de vente.
VI 33 Procédure judiciaire ou analyse de fraude.
VI 34 Requête multiple de copie.
MC 41 Procédure judiciaire ou analyse de fraude – Vérification de signature.
MC 42 Rétrofacturation potentielle ou documents de conformité.
MC 43 Procédure judiciaire ou analyse de fraude – Vérification d’empreinte.
Tableau 4-8 : Codes de motif de rétrofacturation Visa/Mastercard (suite)
Marque de la carte Code Description
Guide de référence de l’API pour les Services Web 1.0 4-17
Transactions du service de consultation des données mai 2019
Tableau 4-10 : Codes de motifs de rétrofacturation et de requête de récupération pour Discover
Code Description
AL Le titulaire de la carte conteste la validité d’un achat réalisé avec la carte dans une compagnie aérienne.
AP Le titulaire de la carte conteste la validité de plusieurs paiements récurrents sur la carte après l’expiration ou l’annulation de l’entente pour ces paiements.
AW Montant de transaction inexact ou numéro de compte/montant de transaction différent
CA Le titulaire de la carte conteste la validité d’une transaction d’avance d’argent ou d’excédent de caisse autre qu’une transaction dans un guichet automatique Discover.
CD Le titulaire de la carte conteste la validité d’une transaction avec la carte parce que la transaction aurait dû être un crédit plutôt qu’un débit associé à un achat.
RG Le titulaire de la carte conteste la validité d’un achat réalisée avec la carte faute d’avoir reçu les biens ou les ser-vices.
UA11 Transaction par bande magnétique – La signature du titulaire de la carte n’a pas été obtenue.
UA12 Transaction par bande magnétique – La signature n’est pas valide.
UA18 Transaction par bande magnétique – Le reçu de la transaction est illisible.
UA21 Transaction saisie au clavier – La signature du titulaire de la carte n’a pas été obtenue.
UA22 Transaction saisie au clavier – La signature n’est pas valide.
UA23 Transaction saisie au clavier – L’impression de la carte n’est pas valide.
UA28 Transaction saisie au clavier – Les documents de la transaction sont illisibles.
RN1, RN2
Le titulaire de la carte affirme ne pas avoir reçu un crédit escompté d’un marchand ou avoir reçu un crédit insuff-isant.
DP Le titulaire de la carte affirme avoir reçu plusieurs fois la même facture pour un seul achat.
RM Le titulaire de la carte conteste la validité d’un achat réalisé avec la carte parce que les biens ou les services rendus par le marchand ne respectent pas la qualité ou les conditions précisées dans le contrat de vente.
NA L’émetteur de la carte conteste un achat effectué avec la carte parce que le marchand n’a pas obtenu d’autorisation pour le montant de la transaction qui est source de litige, selon ce qu’indiquent les données de la vente.
UA01 Le titulaire ou l’émetteur de la carte conteste la validité d’un achat avec la carte parce que le marchand n’a pas envoyé de requête d’autorisation.
CR Le titulaire de la carte conteste la validité d’une transaction avec la carte parce qu’il a annulé sa réservation auprès du marchand.
NC Le titulaire de la carte conteste la validité d’un achat réalisé avec la carte, et aucun autre code de motif ne s’appli-que.
DA L’émetteur de la carte conteste la validité d’un achat réalisé avec la carte parce que le marchand a reçu un refus d’autorisation et que l’émetteur ne peut donc pas réclamer le montant de la vente au titulaire de la carte.
EX Le titulaire ou l’émetteur de la carte conteste la validité d’un achat réalisé avec la carte parce que la carte a expiré le jour de la transaction ou avant celle-ci et que le marchand n’a pas obtenu d’autorisation pour cette transaction.
IC Le titulaire ou l’émetteur de la carte conteste un achat réalisé avec la carte parce que les documents de la transac-tion reçus après une demande de récupération sont illisibles ou qu’ils ne présentent pas une impression valide de la carte (le cas échéant).
IN Le titulaire de la carte conteste une transaction parce que le numéro de la carte fourni par le marchand n’est pas valide.
4-18
mai 2019 Codes de motifs de rétrofacturation et de requête de récupération pour Discover
IS Le titulaire ou l’émetteur de la carte conteste un achat réalisé avec la carte parce que les documents de la transac-tion reçus après une demande de récupération ne comportent pas une signature valide et lisible du titulaire à l’emplacement requis pour la transaction.
LP Le titulaire ou l’émetteur de la carte conteste un achat réalisé avec la carte parce que l’acquéreur ou le marchand a soumis les données de la vente plus de trente jours après la requête d’autorisation et qu’il ne s’agissait pas d’une vente avec livraison différée.
SV Le titulaire ou l’émetteur de la carte conteste une transaction pour une carte prépayée parce que le marchand n’a pas obtenu d’autorisation pour le montant de la vente qui est source de litige.
TF Discover procède à une rétrofacturation d’une transaction avec une carte parce que l’acquéreur ou le marchand n’ont pas respecté les règles de fonctionnement applicables.
UA10 Demande de reçu pour une transaction par bande magnétique.
UA20 Demande de documents relatifs à une transaction saisie au clavier.
UA30 Demande de documents relatifs à une transaction effectuée en l’absence de carte.
UA31 Transaction effectuée en l’absence de carte – Preuve non valide recueillie par l’acquéreur ou le marchand.
UA38 Transaction effectuée en l’absence de carte – Les documents de la transaction sont illisibles.
UA02 Le titulaire ou l’émetteur de la carte conteste la validité d’un achat réalisé avec la carte parce que l’émetteur a refusé la transaction.
UA03 Le titulaire ou l’émetteur de la carte conteste la validité d’un achat réalisé avec la carte parce que le montant fac-turé au titulaire excède le montant autorisé par l’émetteur.
UA32 Le titulaire ou l’émetteur de la carte conteste la validité d’une transaction effectuée en l’absence de carte parce que l’acquéreur ou le marchand n’a pas effectué de vérification de l’adresse ou qu’il n’a pas obtenu et soumis le numéro d’identification de la carte (CID) avec la requête d’autorisation.
UA99 Le titulaire ou l’émetteur de la carte conteste la validité d’un achat réalisé avec la carte et l’acquéreur ou le march-and n’a pas respecté les règles de fonctionnement applicables aux achats réalisés avec la carte.
R2 Crédit non traité.
A Litige avec le titulaire de la carte : le titulaire de la carte demande une facture de vente.
Tableau 4-10 : Codes de motifs de rétrofacturation et de requête de récupération pour Discover (suite)
Code Description
Guide de référence de l’API pour les Services Web 1.0 4-19
Transactions du service de consultation des données mai 2019
4-20
APPENDIX A
Utilisation de la méthode HTTP Post
IntroductionEn plus d’un appel standard au service Web, vous pouvez utiliser la méthode HTTP Post pour envoyer les requêtes de transaction à Paysafe.
Veuillez noter que les URL dans les exemples ci-dessous portent sur l’environnement de production de Paysafe. Afin de tester votre intégration, veuillez communiquer avec le soutien technique pour obtenir les URL de test, puis testez les paramètres du compte de marchand.
• Courriel : [email protected]
• Téléphone : 1 888 709-8753
Requêtes relatives à un prélèvement automatique
facturation/créditPour en savoir davantage sur ces types de requêtes, consultez la rubrique Bâtir des requêtes de factur-ation ou de crédit à la page 2-4.
Pour envoyer une requête de facturation ou de crédit par HTTP Post :
1. Créez une requête de transaction semblable à l’exemple suivant :
<ddCheckRequestV1 xmlns="http://www.optimalpayments.com/directdebit/xmlschema/v1">
<merchantAccount><accountNum>12345678</accountNum><storeID>myStoreID</storeID><storePwd>myStorePWD</storePwd>
</merchantAccount><merchantRefNum>Ref-12345</merchantRefNum><amount>10.00</amount><check>
<accountType>PC</accountType><bankName>Chase</bankName><checkNum>12</checkNum><accountNum>987654321</accountNum><routingNum>123456789</routingNum>
</check><billingDetails>
<checkPayMethod>WEB</checkPayMethod><firstName>Jeanne</firstName>
Toutes les transactions envoyées par la méthode HTTP Post doivent être codées par URL à l’aide du format application/x-www-form-urlencoded. Autrement, il y a un risque d’échec puisque les caractères réservés (p. ex., barre oblique, perluète, etc.) seront retirés des requêtes qui ne sont pas correctement codées par URL.
Guide de référence de l’API pour les Services Web 1.0 A-1
Utilisation de la méthode HTTP Post mai 2019
<lastName>Tremblay</lastName><street>123 rue Principale</street><city>Alma</city><state>QC</state><country>CA</country><zip>G0W 1G0</zip><phone>555-555-5555</phone><email>[email protected]</email>
</billingDetails><sdk>
<version>1.0</version>platform>http</platform><provider>Merchant</provider>
</sdk></ddCheckRequestV1>
2. Insérez cette requête de transaction dans une requête HTTP Post (consultez la rubrique Exemple HTML – Facturation à la page A-2).
La requête HTTP Post doit comporter deux paramètres :
• txnMode – charge (facturation) ou credit (crédit).
• txnRequest – La requête de transaction ci-dessus.
3. Envoyez la requête HTTP Post à l’URL suivante :
https://webservices.optimalpayments.com/directdebitWS/DirectDebitServlet/v1
Exemple HTML – FacturationCet exemple présente une version de formulaire de requête de facturation/crédit contenant l’exemple ci-dessus que vous pourriez envoyer à Paysafe.
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html><title>Paysafe – Test de transaction par prélèvement automatique</title><body><form NAME="Direct Debit" METHOD="post"
ACTION="https://webservices.optimalpayments.com/directdebitWS/DirectDebitServlet/v1"><b>Mode de transaction : </b><br><select name="txnMode"><option value="charge">Facturation</option><option value="credit">Crédit</option></select><br><br><b>Corps du message XML :</b><TEXTAREA class="xmlbox" name="txnRequest" COLS=100 ROWS=10><ddCheckRequestV1 xmlns="http://www.optimalpayments.com/directdebit/xmlschema/v1">
<merchantAccount><accountNum>12345678</accountNum>
Pour obtenir la liste et la description des paramètres à inclure dans cette requête, consultez le Tableau 2-2 : Éléments de transaction ddCheckRequestV1 à la page 2-7.
A-2
mai 2019 facturation/crédit
<storeID>myStoreID</storeID><storePwd>myStorePWD</storePwd>
</merchantAccount><merchantRefNum>Ref-12345</merchantRefNum><amount>10.00</amount><check>
<accountType>PC</accountType><bankName>Chase</bankName><checkNum>12</checkNum><accountNum>987654321</accountNum><routingNum>123456789</routingNum>
</check><billingDetails>
<checkPayMethod>WEB</checkPayMethod><firstName>Jeanne</firstName><lastName>Tremblay</lastName><street>123 rue Principale</street><city>Alma</city><state>QC</state><country>CA</country><zip>G0W 1G0</zip><phone>555-555-5555</phone><email>[email protected]</email>
</billingDetails><sdk>
<version>1.0</version><platform>http</platform><provider>Marchand</provider>
</sdk></ddCheckRequestV1></TEXTAREA> <br><input TYPE=submit class=input VALUE="Envoyer la requête"></form></body></html>
Pour voir le résultat affiché dans un navigateur, consultez la rubrique HTTP Post – Exemples à la page A-31. Si vous cliquez sur le bouton Envoyer la requête, la transaction sera envoyée à Paysafe par HTTP Post.
La taille maximale de fichier prise en charge est de 100 Ko. Si votre requête HTTP Post dépasse les 100 Ko, elle échouera.
Guide de référence de l’API pour les Services Web 1.0 A-3
Utilisation de la méthode HTTP Post mai 2019
updateShippingInfoPour en savoir davantage sur ce type de requête, consultez la rubrique Création de requêtes update-ShippingInfo à la page 2-14.
Pour envoyer une requête updateShippingInfo par HTTP Post :
1. Créez une requête de transaction semblable à l’exemple suivant :
<ddShippingRequestV1 xmlns="http://www.optimalpayments.com/directdebit/xmlschema/v1">
<merchantAccount><accountNum>12345678</accountNum><storeID>myStoreID</storeID><storePwd>myStorePWD</storePwd>
</merchantAccount><carrier>FEX</carrier><trackingNumber>555666888999</trackingNumber><confirmationNumber>123456</confirmationNumber><shipMethod>T</shipMethod><firstName>Jeanne</firstName><lastName>Tremblay</lastName><street>123 rue principale</street><city>Alma</city><state>QC</state><country>CA</country><zip>G0W 1H0</zip><phone>555-555-5555</phone><email>[email protected]</email>
</ddShippingRequestV1>
2. Insérez cette requête de transaction dans une requête HTTP Post (consultez la rubrique Exemple HTML – updateShippingInfo à la page A-4).
La requête HTTP Post doit comporter deux paramètres :
• txnMode – updateShippingInfo
• txnRequest – La requête de transaction ci-dessus.
3. Envoyez la requête HTTP Post à l’URL suivante :
https://webservices.optimalpayments.com/directdebitWS/DirectDebitServlet/v1
Exemple HTML – updateShippingInfoCet exemple présente une version de formulaire de requête updateShippingInfo contenant l’exemple ci-dessus que vous pourriez envoyer à Paysafe.
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html><title> – Test de transaction par prélèvement automatique</title><body><form NAME="Direct Debit" METHOD="post"
ACTION="https://webservices.optimalpayments.com/directdebitWS/DirectDebitServlet/v1">
Pour obtenir la liste et la description des paramètres à inclure dans cette requête, consultez le Tableau 2-4 : Éléments de transaction ddShippingRequestV1 à la page 2-16.
A-4
mai 2019 ddLookupRequest
<input type=hidden name="txnMode" value="updateShippingInfo" >
<br><b>Corps du message XML :</b><TEXTAREA class="xmlbox" name="txnRequest" COLS=100 ROWS=10>
<ddShippingRequestV1 xmlns="http://www.optimalpayments.com/directdebit/xmlschema/v1">
<merchantAccount><accountNum>12345678</accountNum><storeID>myStoreID</storeID><storePwd>myStorePWD</storePwd>
</merchantAccount><carrier>FEX</carrier><trackingNumber>555666888999</trackingNumber><confirmationNumber>123456</confirmationNumber><shipMethod>T</shipMethod><firstName>Jeanne</firstName><lastName>Tremblay</lastName><street>123 rue principale</street><city>Alma</city><state>QC</state><country>CA</country><zip>G0W 1H0</zip><phone>555-555-5555</phone><email>[email protected]</email>
</ddShippingRequestV1></TEXTAREA> <br><input TYPE=submit class=input VALUE="Envoyer la requête"></form></body></html>
Pour voir le résultat affiché dans un navigateur, consultez la rubrique HTTP Post – Exemples à la page A-31. Si vous cliquez sur le bouton Envoyer la requête, la transaction sera envoyée à Paysafe par HTTP Post.
ddLookupRequestPour en savoir davantage sur ces types de requêtes, consultez la rubrique Création de lookupRequest (requêtes de consultation) à la page 2-18.
Pour envoyer une requête de consultation par HTTP Post :
1. Créez une requête de transaction semblable à l’exemple suivant :
<ddLookupRequestV1 xmlns="http://www.optimalpayments.com/directdebit/xmlschema/v1">
<merchantAccount><accountNum>12345678</accountNum><storeID>myStoreID</storeID><storePwd>myStorePWD</storePwd>
</merchantAccount><confirmationNumber>123456</confirmationNumber><merchantRefNum>Ref-12345</merchantRefNum>
La taille maximale de fichier prise en charge est de 100 Ko. Si votre requête HTTP Post dépasse les 100 Ko, elle échouera.
Guide de référence de l’API pour les Services Web 1.0 A-5
Utilisation de la méthode HTTP Post mai 2019
<startDate><year>2012</year><month>1</month><day>1</day><hour>12</hour><minute>1</minute><second>1</second>
</startDate><endDate>
<year>2012</year><month>1</month><day>1</day><hour>23</hour><minute>59</minute><second>59</second>
</endDate></<ddLookupRequestV1>
2. Insérez cette requête de transaction dans une requête HTTP Post (consultez la rubrique Exemple HTML – lookupRequest à la page A-6).
La requête HTTP Post doit comporter deux paramètres :
• txnMode – lookup
• txnRequest – La requête de transaction ci-dessus.
3. Envoyez la requête HTTP Post à l’URL suivante :
https://webservices.optimalpayments.com/directdebitWS/DirectDebitServlet/v1
Exemple HTML – lookupRequestCet exemple présente une version de formulaire de requête de consultation contenant l’exemple ci-dessus que vous pourriez envoyer à Paysafe.
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html><title> – Test de transaction par prélèvement automatique</title><body><form NAME="Direct Debit" METHOD="post"
ACTION="https://webservices.optimalpayments.com/directdebitWS/DirectDebitServlet/v1"><input type=hidden name="txnMode" value="lookup" >
<br><b>Corps du message XML :</b><TEXTAREA class="xmlbox" name="txnRequest" COLS=100 ROWS=10>
<ddLookupRequestV1 xmlns="http://www.optimalpayments.com/directdebit/xmlschema/v1">
<merchantAccount><accountNum>12345678</accountNum><storeID>myStoreID</storeID><storePwd>myStorePWD</storePwd>
Pour obtenir la liste et la description des paramètres à inclure dans cette requête, consultez le Tableau 2-5 : Éléments de transaction ddLookupRequestV1 à la page 2-20.
A-6
mai 2019 ddMandateRequest
</merchantAccount><confirmationNumber>123456</confirmationNumber><merchantRefNum>Ref-12345</merchantRefNum><startDate>
<year>2012</year><month>1</month><day>1</day><hour>12</hour><minute>1</minute><second>1</second>
</startDate><endDate>
<year>2012</year><month>1</month><day>1</day><hour>23</hour><minute>59</minute><second>59</second>
</endDate></<ddLookupRequestV1></TEXTAREA> <br><input TYPE=submit class=input VALUE="Envoyer la requête"></form></body></html>
Pour voir le résultat affiché dans un navigateur, consultez la rubrique HTTP Post – Exemples à la page A-31. Si vous cliquez sur le bouton Envoyer la requête, la transaction sera envoyée à Paysafe par HTTP Post.
ddMandateRequestPour en savoir davantage sur ces types de requêtes, consultez la rubrique Création de mandateRequest pour BACS (requêtes de mandat) à la page 2-22.
Pour envoyer une requête mandat par HTTP Post :
1. Créez une requête de transaction semblable à l’exemple suivant :
<ddMandateRequestV1 xmlns="http://www.optimalpayments.com/directdebit/xmlschema/v1">
<merchantAccount><accountNum>12345678</accountNum><storeID>myStoreID</storeID><storePwd>myStorePWD</storePwd>
</merchantAccount><merchantRefNum>Ref-12345</merchantRefNum><check>
<bankName>Chase</bankName><accountNum>987654321</accountNum><routingNum>123456</routingNum>
</check><billingDetails>
<checkPayMethod>WEB</checkPayMethod><firstName>Jeanne</firstName>
La taille maximale de fichier prise en charge est de 100 Ko. Si votre requête HTTP Post dépasse les 100 Ko, elle échouera.
Guide de référence de l’API pour les Services Web 1.0 A-7
Utilisation de la méthode HTTP Post mai 2019
<lastName>Tremblay</lastName><street>123 rue Principale</street><city>Alma</city><country>CA</country><zip>G0W 1G0</zip><phone>555-555-5555</phone><email>[email protected]</email>
</billingDetails><autosend>Y</autosend>
</ddMandateRequestV1>
2. Insérez cette requête de transaction dans une requête HTTP Post (consultez la rubrique Exemple HTML – lookupRequest à la page A-6).
La requête HTTP Post doit comporter deux paramètres :
• txnMode – mandate
• txnRequest – La requête de transaction ci-dessus.
3. Envoyez la requête HTTP Post à l’URL suivante :
https://webservices.optimalpayments.com/directdebitWS/DirectDebitServlet/v1
Exemple HTML – mandateRequestCet exemple présente une version de formulaire de requête de mandat contenant l’exemple ci-dessus que vous pourriez envoyer à Paysafe.
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html><title>Paysafe - Direct Debit Test</title><body><form NAME="Direct Debit" METHOD="post"
ACTION="https://webservices.optimalpayments.com/directdebitWS/DirectDebitServlet/v1"<input type=hidden name="txnMode" value="mandate" ><br><b>XML Message body:</b><TEXTAREA class="xmlbox" name="txnRequest" COLS=100 ROWS=10><ddMandateRequestV1 xmlns="http://www.optimalpayments.com/directdebit/xmlschema/v1">
<merchantAccount><accountNum>12345678</accountNum><storeID>myStoreID</storeID><storePwd>myStorePWD</storePwd>
</merchantAccount><merchantRefNum>Ref-12345</merchantRefNum><check>
<bankName>Chase</bankName><accountNum>987654321</accountNum><routingNum>123456</routingNum>
</check><billingDetails>
<checkPayMethod>WEB</checkPayMethod>
Pour obtenir la liste et la description des paramètres à inclure dans cette requête, consultez le Tableau 2-6 : Éléments de transaction ddMandateRequestV1 à la page 2-25.
A-8
mai 2019 changeStatusRequest
<firstName>Jeanne</firstName><lastName>Tremblay</lastName><street>123 rue Principale</street><city>Alma</city><country>CA</country><zip>G0W 1G0</zip><phone>555-555-5555</phone><email>[email protected]</email>
</billingDetails><autosend>Y</autosend>
</ddMandateRequestV1></TEXTAREA> <br><input TYPE=submit class=input VALUE="Envoyer la requête"></form></body></html>
Pour voir le résultat affiché dans un navigateur, consultez la rubrique HTTP Post – Exemples à la page A-31. Si vous cliquez sur le bouton Envoyer la requête, la transaction sera envoyée à Paysafe par HTTP Post.
changeStatusRequestPour en savoir davantage sur ces types de requêtes, consultez la rubrique Création de changeStatusRe-quest (requêtes de modification d’état) à la page 2-28.
Pour envoyer une requête de modification d’état par HTTP Post :
1. Créez une requête de transaction semblable à l’exemple suivant :
<ddChangeStatusRequestV1 xmlns="http://www.optimalpayments.com/directdebit/xmlschema/v1">
<merchantAccount><accountNum>12345678</accountNum><storeID>myStoreID</storeID><storePwd>myStorePWD</storePwd>
</merchantAccount><confirmationNumber>123456</confirmationNumber><status>C</status>
</ddChangeStatusRequestV1>
2. Insérez cette requête de transaction dans une requête HTTP Post (consultez la rubrique Exemple HTML – lookupRequest à la page A-6).
La requête HTTP Post doit comporter deux paramètres :
• txnMode – changeStatus
• txnRequest – La requête de transaction ci-dessus
La taille maximale de fichier prise en charge est de 100 Ko. Si votre requête HTTP Post dépasse les 100 Ko, elle échouera.
Pour obtenir la liste et la description des paramètres à inclure dans cette requête, consultez le Tableau 2-8 : Éléments de transaction ddChangeStatusRequestV1 à la page 2-30.
Guide de référence de l’API pour les Services Web 1.0 A-9
Utilisation de la méthode HTTP Post mai 2019
3. Envoyez la requête HTTP Post à l’URL suivante :
https://webservices.optimalpayments.com/directdebitWS/DirectDebitServlet/v1
Exemple HTML – changeStatusRequestCet exemple présente une version de formulaire de requête changeStatusRequest contenant l’exemple ci-dessus que vous pourriez envoyer à Paysafe.
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html><title>Paysafe - Direct Debit Transaction</title><body><form NAME="Direct Debit" METHOD="post"
ACTION="https://webservices.optimalpayments.com/directdebitWS/DirectDebitServlet/v1"<input type=hidden name="txnMode" value="changeStatus" ><br><b>XML Message body:</b><TEXTAREA class="xmlbox" name="txnRequest" COLS=100 ROWS=10><ddChangeStatusRequestV1 xmlns="http://www.optimalpayments.com/directdebit/xmlschema/v1">
<merchantAccount><accountNum>12345678</accountNum><storeID>myStoreID</storeID><storePwd>myStorePWD</storePwd>
</merchantAccount><confirmationNumber>123456</confirmationNumber><status>C</status>
</ddChangeStatusRequestV1></TEXTAREA> <br><input TYPE=submit class=input VALUE="Envoyer la requête"></form></body></html>
Pour voir le résultat affiché dans un navigateur, consultez la rubrique HTTP Post – Exemples à la page A-31. Si vous cliquez sur le bouton Envoyer la requête, la transaction sera envoyée à Paysafe par HTTP Post.
updateMandateRequestPour en savoir davantage sur ces types de requêtes, consultez la rubrique Création de updateMandate-Request (mise à jour du mandat) à la page 2-30.
Pour envoyer une requête de mise à jour du mandat par HTTP Post :
1. Créez une requête de transaction semblable à l’exemple suivant :
<ddUpdateMandateRequestV1 xmlns="http://www.optimalpayments.com/directdebit/xmlschema/v1">
<merchantAccount><accountNum>12345678</accountNum><storeID>myStoreID</storeID><storePwd>myStorePWD</storePwd>
La taille maximale de fichier prise en charge est de 100 Ko. Si votre requête HTTP Post dépasse les 100 Ko, elle échouera.
A-10
mai 2019 updateMandateRequest
</merchantAccount><confirmationNumber>123456</confirmationNumber><mandateReference>PDESTEST7A</mandateReference><accountNum>NL77ABNA0574908765</accountNum><routingNum>ABNANL2A</routingNum>
</ddUpdateMandateRequestV1>
2. Insérez cette requête de transaction dans une requête HTTP Post (consultez la rubrique Exemple HTML – updateMandateRequest à la page A-11).
La requête HTTP Post doit comporter deux paramètres :
• txnMode – updateMandate
• txnRequest – La requête de transaction ci-dessus
3. Envoyez la requête HTTP Post à l’URL suivante :
https://webservices.optimalpayments.com/directdebitWS/DirectDebitServlet/v1
Exemple HTML – updateMandateRequestCet exemple présente une version de formulaire de requête updateMandateRequest contenant l’exem-ple ci-dessus que vous pourriez envoyer à Paysafe.
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html><title>Paysafe - Direct Debit Transaction</title><body><form NAME="Direct Debit" METHOD="post"
ACTION="https://webservices.optimalpayments.com/directdebitWS/DirectDebitServlet/v1"<input type=hidden name="txnMode" value="updateMandate" ><br><b>XML Message body:</b><TEXTAREA class="xmlbox" name="txnRequest" COLS=100 ROWS=10><ddUpdateMandateRequestV1 xmlns="http://www.optimalpayments.com/directdebit/xmlschema/v1">
<merchantAccount><accountNum>12345678</accountNum><storeID>myStoreID</storeID><storePwd>myStorePWD</storePwd>
</merchantAccount><confirmationNumber>123456</confirmationNumber><mandateReference>PDESTEST7A</mandateReference><accountNum>NL77ABNA0574908765</accountNum><routingNum>ABNANL2A</routingNum>
</ddUpdateMandateRequestV1></TEXTAREA> <br><input TYPE=submit class=input VALUE="Send Request"></form></body></html>
Pour obtenir la liste et la description des paramètres à inclure dans cette requête, consultez le Table 2-9: Éléments de transaction ddUpdateMandateRequestV1 à la page 2-32.
Guide de référence de l’API pour les Services Web 1.0 A-11
Utilisation de la méthode HTTP Post mai 2019
Pour voir le résultat affiché dans un navigateur, consultez la rubrique HTTP Post – Exemples à la page A-31. Si vous cliquez sur le bouton Envoyer la requête, la transaction sera envoyée à Paysafe par HTTP Post.
Requêtes relatives à une carte de crédit
Achat, autorisation et vérificationPour en savoir davantage sur ces types de requêtes, consultez la rubrique Bâtir des requêtes d’achat, d’autorisation ou de vérification à la page 3-4.
Pour envoyer une requête de transaction d’achat, d’autorisation ou de vérification de carte de crédit par HTTP Post :
1. Créez une requête de transaction semblable à l’exemple suivant :
<ccAuthRequestV1 xmlns="http://www.optimalpayments.com/creditcard/xmlschema/v1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.optimalpayments.com/creditcard/xmlschema/v1">
<merchantAccount><accountNum>12345678</accountNum><storeID>myStoreID</storeID><storePwd>myStorePWD</storePwd>
</merchantAccount><merchantRefNum>Ref-12345</merchantRefNum><amount>10.00</amount><card>
<cardNum>4653111111111111</cardNum><cardExpiry>
<month>11</month><year>2008</year>
</cardExpiry><cardType>VI</cardType><cvdIndicator>1</cvdIndicator><cvd>111</cvd>
</card><authentication>
<indicator>05</indicator><cavv>AAABB4WZlQAAAAAAcJmVENiWiV+=</cavv><xid>Q2prWUI2RFNBc3FOTXNlem50eWY=</xid>
</authentication><billingDetails>
<cardPayMethod>WEB</cardPayMethod><firstName>Jeanne</firstName><lastName>Tremblay</lastName><street>123 rue Principale</street><city>Alma</city><state>QC</state><country>CA</country><zip>G0W 1G0</zip><phone>555-555-5555</phone>
La taille maximale de fichier prise en charge est de 100 Ko. Si votre requête HTTP Post dépasse les 100 Ko, elle échouera.
A-12
mai 2019 Achat, autorisation et vérification
<email>[email protected]</email></billingDetails><shippingDetails>
<carrier>FEX</carrier><shipMethod>T</shipMethod><firstName>Jeanne</firstName><lastName>Tremblay</lastName><street>44 rue Principale</street><city>Alma</city><state>QC</state><country>CA</country><zip>G0W 1G0</zip><phone>555-555-5555</phone><email>[email protected]</email>
</shippingDetails><recurring>
<recurringIndicator>I</recurringIndicator><originalConfirmationNumber>115147689</originalConfirmationNumber>
</recurring><customerIP>127.0.0.1</customerIP><productType>M</productType><addendumData>
<tag>CUST_ACCT_OPEN_DATE</tag><value>20041012</value>
</addendumData><addendumData>
<tag>MERCHANT_COUNTRY_CODE</tag><value>US</value>
</addendumData><addendumData>
<tag>SERVICE_REQUEST_CURRENCY</tag><value>on</value>
</addendumData></ccAuthRequestV1>
2. Insérez cette requête de transaction dans une requête HTTP Post (consultez la rubrique Exemple HTML – Autorisation à la page A-13).
La requête HTTP Post doit comporter deux paramètres :
• txnMode – ccAuthorize, ccPurchase ou ccVerification.
• txnRequest – La requête de transaction ci-dessus.
3. Envoyez la requête HTTP Post à l’URL suivante :
https://webservices.optimalpayments.com/creditcardWS/CreditCardServlet/v1
Exemple HTML – AutorisationCet exemple présente une version de formulaire de requête d’autorisation de carte de crédit, conten-ant l’exemple ci-dessus, que vous pourriez envoyer à Paysafe.
Pour obtenir la liste et la description des paramètres à inclure dans cette requête, consultez le Tableau 3-2 : Éléments de transaction ccAuthRequestV1 à la page 3-8.
Guide de référence de l’API pour les Services Web 1.0 A-13
Utilisation de la méthode HTTP Post mai 2019
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html><title>Credit Card Test</title><body><form NAME="Credit Card" METHOD="post"ACTION="https://webservices.optimalpayments.com/creditcardWS/CreditCardServlet/v1"><input type=hidden name="txnMode" value="ccAuthorize" ><b>XML Message body:</b><TEXTAREA class="xmlbox" name="txnRequest" COLS=100 ROWS=10 ><ccAuthRequestV1 xmlns="http://www.optimalpayments.com/creditcard/xmlschema/v1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.optimalpayments.com/creditcard/xmlschema/v1">
<merchantAccount><accountNum>12345678</accountNum><storeID>myStoreID</storeID><storePwd>myStorePWD</storePwd>
</merchantAccount><merchantRefNum>Ref-12345</merchantRefNum><amount>10.00</amount><card>
<cardNum>4653111111111111</cardNum><cardExpiry>
<month>11</month><year>2008</year>
</cardExpiry><cardType>VI</cardType><cvdIndicator>1</cvdIndicator><cvd>111</cvd>
</card><authentication>
<indicator>05</indicator><cavv>AAABB4WZlQAAAAAAcJmVENiWiV+=</cavv><xid>Q2prWUI2RFNBc3FOTXNlem50eWY=</xid>
</authentication><billingDetails>
<cardPayMethod>WEB</cardPayMethod><firstName>Jeanne</firstName><lastName>Tremblay</lastName><street>123 rue Principale</street><city>Alma</city><state>QC</state><country>CA</country><zip>G0W 1G0</zip><phone>555-555-5555</phone><email>[email protected]</email>
</billingDetails><shippingDetails>
<carrier>FEX</carrier><shipMethod>T</shipMethod><firstName>Jeanne</firstName><lastName>Tremblay</lastName><street>44 rue Principale</street>
Pour convertir cette requête en requête d’achat ou de vérification, il suffit de remplacer la valeur « ccAuthorize » de txnMode (soulignée ci-dessous) par « ccPurchase » ou par « ccVerification » respec-tivement.
A-14
mai 2019 Inversion d’autorisation
<city>Alma</city><state>QC</state><country>CA</country><zip>G0W 1G0</zip><phone>555-555-5555</phone><email>[email protected]</email>
</shippingDetails><recurring>
<recurringIndicator>I</recurringIndicator><originalConfirmationNumber>115147689</originalConfirmationNumber>
</recurring><customerIP>127.0.0.1</customerIP><productType>M</productType><addendumData>
<tag>CUST_ACCT_OPEN_DATE</tag><value>20041012</value>
</addendumData><addendumData>
<tag>MERCHANT_COUNTRY_CODE</tag><value>US</value>
</addendumData><addendumData>
<tag>SERVICE_REQUEST_CURRENCY</tag><value>on</value>
</addendumData></ccAuthRequestV1> </TEXTAREA><br><input TYPE=submit class=input VALUE="Envoyer la requête"></form></body></html>
Pour voir le résultat affiché dans un navigateur, consultez la rubrique HTTP Post – Exemples à la page A-31. Si vous cliquez sur le bouton Envoyer la requête, la transaction sera envoyée à Paysafe par HTTP Post.
Inversion d’autorisationPour en savoir davantage sur ces types de requêtes, consultez la rubrique Bâtir des requêtes d’inversion d’autorisation à la page 3-20.
Pour envoyer une requête de transaction d’inversion d’autorisation de carte de crédit par HTTP Post :
1. Créez une requête de transaction semblable à l’exemple suivant :
<ccAuthReversalRequestV1 xmlns="http://www.optimalpayments.com/creditcard/xmlschema/v1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.optimalpayments.com/creditcard/xmlschema/v1">
<merchantAccount><accountNum>12345678</accountNum><storeID>myStoreID</storeID>
La taille maximale de fichier prise en charge est de 100 Ko. Si votre requête HTTP Post dépasse les 100 Ko, elle échouera.
Guide de référence de l’API pour les Services Web 1.0 A-15
Utilisation de la méthode HTTP Post mai 2019
<storePwd>myStorePWD</storePwd></merchantAccount><confirmationNumber>115147689</confirmationNumber><merchantRefNum>AR2</merchantRefNum><reversalAmount>18.00</reversalAmount>
</ccAuthReversalRequestV1>
2. Insérez cette requête de transaction dans une requête HTTP Post (consultez la rubrique Exemple HTML – Inversion d’autorisation à la page A-16).
La requête HTTP Post doit comporter deux paramètres :
• txnMode – ccAuthorizeReversal
• txnRequest – La requête de transaction ci-dessus.
3. Envoyez la requête HTTP Post à l’URL suivante :
https://webservices.optimalpayments.com/creditcardWS/CreditCardServlet/v1
Exemple HTML – Inversion d’autorisationCet exemple présente une version de formulaire de requête d’inversion d’autorisation de carte de crédit, contenant l’exemple ci-dessus, que vous pourriez envoyer à Paysafe.
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html><title>Reverse Authorization Transaction</title><body><form NAME="Credit Card" METHOD="post"ACTION="https://webservices.optimalpayments.com/creditcardWS/CreditCardServlet/v1"><input type=hidden name="txnMode" value="ccAuthorizeReversal" ><b>XML Message body:</b><TEXTAREA class="xmlbox" name="txnRequest" COLS=100 ROWS=10 ><ccAuthReversalRequestV1 xmlns="http://www.optimalpayments.com/creditcard/xmlschema/v1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.optimalpayments.com/creditcard/xmlschema/v1">
<merchantAccount><accountNum>12345678</accountNum><storeID>myStoreID</storeID><storePwd>myStorePWD</storePwd>
</merchantAccount><confirmationNumber>115147689</confirmationNumber><merchantRefNum>AR2</merchantRefNum><reversalAmount>18.00</reversalAmount>
</ccAuthReversalRequestV1></TEXTAREA><br><input TYPE=submit class=input VALUE="Envoyer la requête"></form></body></html>
Pour obtenir la liste et la description des paramètres à inclure dans cette requête, consultez le Tableau 3-4 : Éléments de transaction ccAuthReversalRequestV1 à la page 3-22.
A-16
mai 2019 Règlement et crédit
Pour voir le résultat affiché dans un navigateur, consultez la rubrique HTTP Post – Exemples à la page A-31. Si vous cliquez sur le bouton Envoyer la requête, la transaction sera envoyée à Paysafe par HTTP Post.
Règlement et créditPour en savoir davantage sur ces types de requêtes, consultez la rubrique Bâtir des requêtes de règle-ment et de crédit à la page 3-23.
Pour envoyer une requête de transaction de règlement ou de crédit de carte de crédit par HTTP Post :
1. Créez une requête de transaction semblable à l’exemple suivant :
<ccPostAuthRequestV1 xmlns="http://www.optimalpayments.com/creditcard/xmlschema/v1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.optimalpayments.com/creditcard/xmlschema/v1">
<merchantAccount><accountNum>12345678</accountNum><storeID>myStoreID</storeID><storePwd>myStorePWD</storePwd>
</merchantAccount><confirmationNumber>123456</confirmationNumber><merchantRefNum>Ref-12345</merchantRefNum><amount>10.00</amount><addendumData>
<tag>MERCHANT_DATA</tag><value>MERCHANT_DATA</value>
</addendumData></ccPostAuthRequestV1>
2. Insérez cette requête de transaction dans une requête HTTP Post (consultez la rubrique Exemple HTML – Règlement à la page A-17).
La requête HTTP Post doit comporter deux paramètres :
• txnMode – ccSettlement ou ccCredit.
• txnRequest – La requête de transaction ci-dessus.
3. Envoyez la requête HTTP Post à l’URL suivante :
https://webservices.optimalpayments.com/creditcardWS/CreditCardServlet/v1
Exemple HTML – RèglementCet exemple présente une version de formulaire de requête de règlement de carte de crédit, contenant l’exemple ci-dessus, que vous pourriez envoyer à Paysafe.
La taille maximale de fichier prise en charge est de 100 Ko. Si votre requête HTTP Post dépasse les 100 Ko, elle échouera.
Pour obtenir la liste et la description des paramètres à inclure dans cette requête, consultez le Tableau 3-5 : Éléments de transaction ccPostAuthRequestV1 à la page 3-25.
Guide de référence de l’API pour les Services Web 1.0 A-17
Utilisation de la méthode HTTP Post mai 2019
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html><title>Credit Card Test</title><body><form NAME="Credit Card" METHOD="post"ACTION="https://webservices.optimalpayments.com/creditcardWS/CreditCardServlet/v1"><input type=hidden name="txnMode" value="ccSettlement" ><b>XML Message body:</b><TEXTAREA class="xmlbox" name="txnRequest" COLS=100 ROWS=10 ><ccPostAuthRequestV1 xmlns="http://www.optimalpayments.com/creditcard/xmlschema/v1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.optimalpayments.com/creditcard/xmlschema/v1">
<merchantAccount><accountNum>12345678</accountNum><storeID>myStoreID</storeID><storePwd>myStorePWD</storePwd>
</merchantAccount><confirmationNumber>123456</confirmationNumber><merchantRefNum>Ref-12345</merchantRefNum><amount>10.00</amount><addendumData>
<tag>MERCHANT_DATA</tag><value>MERCHANT_DATA</value>
</addendumData></ccPostAuthRequestV1></TEXTAREA><br><input TYPE=submit class=input VALUE="Envoyer la requête"></form></body></html>
Pour voir le résultat affiché dans un navigateur, consultez la rubrique HTTP Post – Exemples à la page A-31. Si vous cliquez sur le bouton Envoyer la requête, la transaction sera envoyée à Paysafe par HTTP Post.
Autorisation ou achat à partir de données mémoriséesPour en savoir davantage sur ces types de requêtes, consultez la rubrique Bâtir des requêtes de don-nées mémorisées à la page 3-27.
Pour envoyer par HTTP Post une requête de transaction d’autorisation ou d’achat à partir de données mémorisées :
1. Créez une requête de transaction semblable à l’exemple suivant :
<ccStoredDataRequestV1
Pour convertir cette requête en requête de crédit, il suffit de remplacer la valeur « ccSettlement » de txnMode (souligné ci-dessous) par « ccCredit ».
La taille maximale de fichier prise en charge est de 100 Ko. Si votre requête HTTP Post dépasse les 100 Ko, elle échouera.
A-18
mai 2019 Autorisation ou achat à partir de données mémorisées
xmlns="http://www.optimalpayments.com/creditcard/xmlschema/v1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.optimalpayments.com/creditcard/xmlschema/v1">
<merchantAccount><accountNum>12345678</accountNum><storeID>myStoreID</storeID><storePwd>myStorePWD</storePwd>
</merchantAccount><merchantRefNum>Ref-12345</merchantRefNum><confirmationNumber>123456</confirmationNumber><amount>18.00</amount><cvdIndicator>1</cvdIndicator><cvd>111</cvd>
</ccStoredDataRequestV1>
2. Insérez cette requête de transaction dans une requête HTTP Post (consultez la rubrique Exemple HTML – Autorisation à partir de données mémorisées à la page A-19).
La requête HTTP Post doit comporter deux paramètres :
• txnMode – ccStoredDataAuthorize ou ccStoredDataPurchase.
• txnRequest – La requête de transaction ci-dessus.
3. Envoyez la requête HTTP Post à l’URL suivante :
https://webservices.optimalpayments.com/creditcardWS/CreditCardServlet/v1
Exemple HTML – Autorisation à partir de données mémorisées Cet exemple présente une version de formulaire de requête d’autorisation à partir de données mémorisées de carte de crédit, contenant l’exemple ci-dessus, que vous pourriez envoyer à Paysafe.
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html><title>Credit Card Test</title><body><form NAME="Credit Card" METHOD="post"ACTION="https://webservices.optimalpayments.com/creditcardWS/CreditCardServlet/v1"><input type=hidden name="txnMode" value="ccStoredDataAuthorize" ><b>XML Message body:</b><TEXTAREA class="xmlbox" name="txnRequest" COLS=100 ROWS=10 ><ccStoredDataRequestV1 xmlns="http://www.optimalpayments.com/creditcard/xmlschema/v1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.optimalpayments.com/creditcard/xmlschema/v1">
<merchantAccount><accountNum>12345678</accountNum><storeID>myStoreID</storeID><storePwd>myStorePWD</storePwd>
Pour obtenir la liste et la description des paramètres à inclure dans cette requête, consultez le Tableau 3-6 : Éléments de transaction ccStoredDataRequestV1 à la page 3-29.
Pour convertir cette requête en requête d’achat à partir de données mémorisées, il suffit de remplacer la valeur « ccStoredDataAuthorize » de txnMode (souligné ci-dessous) par « ccStoredDataPurchase ».
Guide de référence de l’API pour les Services Web 1.0 A-19
Utilisation de la méthode HTTP Post mai 2019
</merchantAccount><merchantRefNum>Ref-12345</merchantRefNum><confirmationNumber>123456</confirmationNumber><amount>18.00</amount><cvdIndicator>1</cvdIndicator><cvd>111</cvd>
</ccStoredDataRequestV1></TEXTAREA><br><input TYPE=submit class=input VALUE="Envoyer la requête"></form></body></html>
Pour voir le résultat affiché dans un navigateur, consultez la rubrique HTTP Post – Exemples à la page A-31. Si vous cliquez sur le bouton Envoyer la requête, la transaction sera envoyée à Paysafe par HTTP Post.
Annuler un règlement, un crédit, un paiement, ou un crédit indépendantPour en savoir davantage sur ces types de requêtes, consultez la rubrique Bâtir des requêtes d’annula-tion à la page 3-31.
Pour annuler une requête de règlement, de crédit, de paiement, ou de crédit indépendant par HTTP Post :
1. Créez une requête de transaction semblable à l’exemple suivant :
<ccCancelRequestV1 xmlns="http://www.optimalpayments.com/creditcard/xmlschema/v1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.optimalpayments.com/creditcard/xmlschema/v1">
<merchantAccount><accountNum>12345678</accountNum><storeID>myStoreID</storeID><storePwd>myStorePWD</storePwd>
</merchantAccount><confirmationNumber>123456</confirmationNumber><addendumData>
<tag>MERCHANT_DATA</tag><value>MERCHANT_DATA</value>
</addendumData></ccCancelRequestV1>
2. Insérez cette requête de transaction dans une requête HTTP Post (consultez la rubrique Exemple HTML – Annuler à la page A-21).
La requête HTTP Post doit comporter deux paramètres :
• txnMode – ccCancelSettle, ccCancelCredit, ccCancelPayment, ou ccCancelIndependent-Credit.
La taille maximale de fichier prise en charge est de 100 Ko. Si votre requête HTTP Post dépasse les 100 Ko, elle échouera.
Pour obtenir la liste et la description des paramètres à inclure dans cette requête, consultez le Tableau 3-7 : Éléments de transaction ccCancelRequestV1 à la page 3-33.
A-20
mai 2019 Annuler un règlement, un crédit, un paiement, ou un crédit indépendant
• txnRequest – La requête de transaction ci-dessus.
3. Envoyez la requête HTTP Post à l’URL suivante :
https://webservices.optimalpayments.com/creditcardWS/CreditCardServlet/v1
Exemple HTML – Annuler Cet exemple présente une version de formulaire de requête d’annulation de règlement de carte de crédit, contenant l’exemple ci-dessus, que vous pourriez envoyer à Paysafe pour annuler une transac-tion de règlement.
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html><title>Credit Card Test</title><body><form NAME="Credit Card" METHOD="post"ACTION="https://webservices.optimalpayments.com/creditcardWS/CreditCardServlet/v1"><input type=hidden name="txnMode" value="ccCancelSettle" ><b>XML Message body:</b><TEXTAREA class="xmlbox" name="txnRequest" COLS=100 ROWS=10 ><ccCancelRequestV1 xmlns="http://www.optimalpayments.com/creditcard/xmlschema/v1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.optimalpayments.com/creditcard/xmlschema/v1">
<merchantAccount><accountNum>12345678</accountNum><storeID>myStoreID</storeID><storePwd>myStorePWD</storePwd>
</merchantAccount><confirmationNumber>123456</confirmationNumber><addendumData>
<tag>MERCHANT_DATA</tag><value>MERCHANT_DATA</value>
</addendumData></ccCancelRequestV1></TEXTAREA><br><input TYPE=submit class=input VALUE="Envoyer la requête"></form></body></html>
Pour voir le résultat affiché dans un navigateur, consultez la rubrique HTTP Post – Exemples à la page A-31. Si vous cliquez sur le bouton Envoyer la requête, la transaction sera envoyée à Paysafe par HTTP Post.
Pour convertir cette requête en requête d’annulation de crédit, de paiement, ou de crédit indépendant, il suffit de remplacer la valeur « ccCancelSettle » de txnMode (soulignée ci-dessous) par « ccCancelCredit », par « ccCancelPayment », ou par « ccCancelIndependentCredit » respectivement.
La taille maximale de fichier prise en charge est de 100 Ko. Si votre requête HTTP Post dépasse les 100 Ko, elle échouera.
Guide de référence de l’API pour les Services Web 1.0 A-21
Utilisation de la méthode HTTP Post mai 2019
Requête de paiementPour en savoir davantage sur ce type de requête, consultez la rubrique Bâtir des requêtes de paie-ment/crédit indépendant à la page 3-34.
Pour effectuer une requête de paiement par HTTP Post :
1. Créez une requête de transaction semblable à l’exemple suivant :
<ccPaymentRequestV1 xmlns="http://www.optimalpayments.com/creditcard/xmlschema/v1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.optimalpayments.com/creditcard/xmlschema/v1">
<merchantAccount><accountNum>12345678</accountNum><storeID>myStoreID</storeID><storePwd>myStorePWD</storePwd>
</merchantAccount><merchantRefNum>Ref-12345</merchantRefNum><amount>10.00</amount><card>
<cardNum>4653111111111111</cardNum><cardExpiry>
<month>11</month><year>2008</year>
</cardExpiry><cardType>VI</cardType><cvdIndicator>1</cvdIndicator><cvd>111</cvd>
</card><billingDetails>
<cardPayMethod>WEB</cardPayMethod><firstName>Jeanne</firstName><lastName>Tremblay</lastName><street>123 rue Principale</street><city>Alma</city><state>QC</state><country>CA</country><zip>G0W 1G0</zip><phone>555-555-5555</phone><email>[email protected]</email>
</billingDetails></ccPaymentRequestV1>
2. Insérez cette requête de transaction dans une requête HTTP Post (consultez la rubrique Exemple HTML – Paiement à la page A-23).
La requête HTTP Post doit comporter deux paramètres :
• txnMode – ccPayment ou ccIndependentCredit
• txnRequest – La requête de transaction ci-dessus.
3. Envoyez la requête HTTP Post à l’URL suivante :
https://webservices.optimalpayments.com/creditcardWS/CreditCardServlet/v1
Pour obtenir la liste et la description des paramètres à inclure dans cette requête, consultez le Tableau 3-8 : Éléments de transaction ccPaymentRequestV1 à la page 3-36.
A-22
mai 2019 Requête de paiement
Exemple HTML – Paiement
Cet exemple présente une version de formulaire de requête de paiement de carte de crédit, contenant l’exemple ci-dessus, que vous pourriez envoyer à Paysafe.
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html><head><title>CC Payment</title></head>
<body><h1> Credit Card Webservice Tester </h1><form NAME="creditcard" id="creditcard" METHOD="post"ACTION="https://webservices.optimalpayments/creditcardWS/CreditCardServlet/v1"><input type=hidden name="txnMode" value="ccPayment" ><b>XML Message body:</b><TEXTAREA class="xmlbox" name="txnRequest" COLS=100 ROWS=10 ><ccPaymentRequestV1 xmlns="http://www.optimalpayments.com/creditcard/xmlschema/v1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.optimalpayments.com/creditcard/xmlschema/v1">
<merchantAccount><accountNum>12345678</accountNum><storeID>myStoreID</storeID><storePwd>myStorePWD</storePwd>
</merchantAccount><merchantRefNum>Ref-12345</merchantRefNum><amount>10.00</amount><card>
<cardNum>4653111111111111</cardNum><cardExpiry>
<month>11</month><year>2008</year>
</cardExpiry><cardType>VI</cardType><cvdIndicator>1</cvdIndicator><cvd>111</cvd>
</card><billingDetails>
<cardPayMethod>WEB</cardPayMethod><firstName>Jeanne</firstName><lastName>Tremblay</lastName><street>123 rue Principale</street><city>Alma</city><state>QC</state><country>CA</country><zip>G0W 1G0</zip><phone>555-555-5555</phone><email>[email protected]</email>
</billingDetails></ccPaymentRequestV1></TEXTAREA><br>
Pour convertir cette requête en requête de crédit indépendant, il suffit de remplacer la valeur « ccPayment » de txnMode (soulignée ci-dessous) par « ccIndependentCredit ».
Guide de référence de l’API pour les Services Web 1.0 A-23
Utilisation de la méthode HTTP Post mai 2019
<input TYPE=submit class=input VALUE="Envoyer la requête"></form></body></html>
Pour voir le résultat affiché dans un navigateur, consultez la rubrique HTTP Post – Exemples à la page A-31. Si vous cliquez sur le bouton Envoyer la requête, la transaction sera envoyée à Paysafe par HTTP Post.
Consultation des donnéesPour en savoir davantage sur ce type de requête, consultez la rubrique Bâtir des requêtes de consulta-tion des données à la page 3-39.
Pour effectuer une requête de paiement par HTTP Post :
1. Créez une requête de transaction semblable à l’exemple suivant :
<ccTxnLookupRequestV1 xmlns="http://www.optimalpayments.com/creditcard/xmlschema/v1">
<merchantAccount><accountNum>12345678</accountNum><storeID>myStoreID</storeID><storePwd>myStorePWD</storePwd>
</merchantAccount><confirmationNumber>123456</confirmationNumber><merchantRefNum>Ref-12345</merchantRefNum><startDate>
<year>2012</year><month>1</month><day>1</day><hour>12</hour><minute>1</minute><second>1</second>
</startDate><endDate>
<year>2012</year><month>1</month><day>1</day><hour>23</hour><minute>59</minute><second>59</second>
</endDate></ccTxnLookupRequestV1>
2. Insérez cette requête de transaction dans une requête HTTP Post (consultez la rubrique Exemple HTML – Consultation des données à la page A-25).
La requête HTTP Post doit comporter deux paramètres :
• txnMode – ccTxnLookup
La taille maximale de fichier prise en charge est de 100 Ko. Si votre requête HTTP Post dépasse les 100 Ko, elle échouera.
Pour obtenir la liste et la description des paramètres à inclure dans cette requête, consultez le Table 3-9: Éléments de transaction ccTxnLookupRequestV1 à la page 3-41.
A-24
mai 2019 Consultation des données
• txnRequest – La requête de transaction ci-dessus.
3. Envoyez la requête HTTP Post à l’URL suivante :
https://webservices.optimalpayments.com/creditcardWS/CreditCardServlet/v1
Exemple HTML – Consultation des données<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html><title>Consultation des données</title>
<form NAME="Consultation des données" METHOD="post" ACTION="https://webservices.optimalpayments.com/creditcardWS/CreditCardServlet/v1">
<input type=hidden name="txnMode" value="ccTxnLookup" ><b>XML Message body:</b><TEXTAREA class="xmlbox" name="txnRequest" COLS=100 ROWS=25 >
<ccTxnLookupRequestV1 xmlns="http://www.optimalpayments.com/creditcard/xmlschema/v1">
<merchantAccount><accountNum>12345678</accountNum><storeID>myStoreID</storeID><storePwd>myStorePWD</storePwd>
</merchantAccount><confirmationNumber>123456</confirmationNumber><merchantRefNum>Ref-12345</merchantRefNum><startDate>
<year>2012</year><month>1</month><day>1</day><hour>12</hour><minute>1</minute><second>1</second>
</startDate><endDate>
<year>2012</year><month>1</month><day>1</day><hour>23</hour><minute>59</minute><second>59</second>
</endDate></ccTxnLookupRequestV1></TEXTAREA><br><input TYPE=submit class=input VALUE="Envoyer la requête"></form></body></html>
La taille maximale de fichier prise en charge est de 100 Ko. Si votre requête HTTP Post dépasse les 100 Ko, elle échouera.
Guide de référence de l’API pour les Services Web 1.0 A-25
Utilisation de la méthode HTTP Post mai 2019
Pour voir le résultat affiché dans un navigateur, consultez la rubrique HTTP Post – Exemples à la page A-31. Si vous cliquez sur le bouton Envoyer la requête, la transaction sera envoyée à Paysafe par HTTP Post.
Consultation d’inscriptionPour en savoir davantage sur ce type de requête, consultez la rubrique Bâtir des requêtes de consulta-tion d’inscription à la page 3-43.
Pour envoyer une requête de transaction de consultation d’inscription de carte de crédit par HTTP Post :
1. Créez une requête de transaction semblable à l’exemple suivant :
<ccEnrollmentLookupRequestV1 xmlns="http://www.optimalpayments.com/creditcard/xmlschema/v1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.optimalpayments.com/creditcard/xmlschema/v1"> <merchantAccount> <accountNum>12345678</accountNum> <storeID>MyStoreID</storeID> <storePwd>MyStorePWD</storePwd> </merchantAccount> <merchantRefNum>Ref-12345</merchantRefNum> <amount>21.00</amount> <card> <cardNum>4000000000000002</cardNum> <cardExpiry> <month>01</month> <year>2011</year> </cardExpiry> <cardType>VI</cardType> </card> </ccEnrollmentLookupRequestV1>
2. Insérez cette requête de transaction dans une requête HTTP Post (consultez la rubrique Exemple HTML – Consultation d’inscription à la page A-26).
La requête HTTP Post doit comporter deux paramètres :
• txnMode – ccTDSLookup
• txnRequest – La requête de transaction ci-dessus.
3. Envoyez la requête HTTP Post à l’URL suivante :
https://webservices.optimalpayments.com/creditcardWS/CreditCardServlet/v1
Exemple HTML – Consultation d’inscription<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html><title>Enrollment Lookup</title>
<form NAME="Enrollment Lookup" METHOD="post"
Pour obtenir la liste et la description des paramètres à inclure dans cette requête, consultez le Tableau 3-10 : Éléments de transaction ccEnrollmentLookupRequestV1 à la page 3-45.
A-26
mai 2019 Authentification
ACTION="https://webservices.optimalpayments.com/creditcardWS/CreditCardServlet/v1">
<input type=hidden name="txnMode" value="ccTDSLookup" ><b>XML Message body:</b><TEXTAREA class="xmlbox" name="txnRequest" COLS=100 ROWS=25 >
<ccEnrollmentLookupRequestV1 xmlns="http://www.optimalpayments.com/creditcard/xmlschema/v1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.optimalpayments.com/creditcard/xmlschema/v1">
<merchantAccount><accountNum>12345678</accountNum><storeID>MyStoreID</storeID><storePwd>MyStorePWD</storePwd>
</merchantAccount><merchantRefNum>Ref-12345</merchantRefNum><amount>21.00</amount><card>
<cardNum>4653111111111111</cardNum><cardExpiry>
<month>01</month><year>2011</year>
</cardExpiry><cardType>VI</cardType>
</card></ccEnrollmentLookupRequestV1></TEXTAREA><br><input TYPE=submit class=input VALUE="Envoyer la requête"></form></body></html>
Pour voir le résultat affiché dans un navigateur, consultez la rubrique HTTP Post – Exemples à la page A-31. Si vous cliquez sur le bouton Envoyer la requête, la transaction sera envoyée à Paysafe par HTTP Post.
AuthentificationPour en savoir davantage sur ce type de requête, consultez la rubrique Bâtir des requêtes d’authentifi-cation à la page 3-46.
Pour envoyer une requête de transaction d’authentification de carte de crédit par HTTP Post :
1. Créez une requête de transaction semblable à l’exemple suivant :
<ccAuthenticateRequestV1 xmlns="http://www.optimalpayments.com/creditcard/xmlschema/v1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.optimalpayments.com/creditcard/xmlschema/v1">
<merchantAccount><accountNum>12345678</accountNum>
La taille maximale de fichier prise en charge est de 100 Ko. Si votre requête HTTP Post dépasse les 100 Ko, elle échouera.
Guide de référence de l’API pour les Services Web 1.0 A-27
Utilisation de la méthode HTTP Post mai 2019
<storeID>myStoreID</storeID><storePwd>myStorePWD</storePwd>
</merchantAccount><confirmationNumber>123456</confirmationNumber><paymentResponse>myPaymentResponse</paymentResponse>
</ccAuthenticateRequestV1>
2. Insérez cette requête de transaction dans une requête HTTP Post (consultez la rubrique Exemple HTML – Authentification à la page A-28).
La requête HTTP Post doit comporter deux paramètres :
• txnMode – ccTDSAuthenticate
• txnRequest – La requête de transaction ci-dessus.
3. Envoyez la requête HTTP Post à l’URL suivante :
https://webservices.optimalpayments.com/creditcardWS/CreditCardServlet/v1
Exemple HTML – AuthentificationCet exemple présente une version de formulaire de requête d’authentification de carte de crédit, con-tenant l’exemple ci-dessus, que vous pourriez envoyer à Paysafe.
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html><title>Credit Card Test</title><body><form NAME="Credit Card" METHOD="post"ACTION="https://webservices.optimalpayments.com/creditcardWS/CreditCardServlet/v1"><input type=hidden name="txnMode" value="ccTDSAuthenticate" ><b>XML Message body:</b><TEXTAREA class="xmlbox" name="txnRequest" COLS=100 ROWS=10 ><ccAuthenticateRequestV1 xmlns="http://www.optimalpayments.com/creditcard/xmlschema/v1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.optimalpayments.com/creditcard/xmlschema/v1">
<merchantAccount><accountNum>12345678</accountNum><storeID>myStoreID</storeID><storePwd>myStorePWD</storePwd>
</merchantAccount><confirmationNumber>123456</confirmationNumber><paymentResponse>myPaymentResponse</paymentResponse>
</ccAuthenticateRequestV1></TEXTAREA><br><input TYPE=submit class=input VALUE="Envoyer la requête"></form></body></html>
Pour obtenir la liste et la description des paramètres à inclure dans cette requête, consultez le Tableau 3-11 : Éléments de transaction ccAuthenticateRequestV1 à la page 3-48.
A-28
mai 2019 Requêtes relatives au service de consultation des données
Pour voir le résultat affiché dans un navigateur, consultez la rubrique HTTP Post – Exemples à la page A-31. Si vous cliquez sur le bouton Envoyer la requête, la transaction sera envoyée à Paysafe par HTTP Post.
Requêtes relatives au service de consultation des donnéesPour en savoir davantage sur ce type de requête, consultez la rubrique Bâtir des requêtes ILS à la page 4-3.
Pour envoyer une requête ILS par HTTP Post :
1. Créez une requête de transaction semblable à l’exemple suivant :
<ilsLookupRequestV1 xmlns="http://www.optimalpayments.com/ils/xmlschema/v1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.optimalpayments.com/ils/xmlschema/v1">
<merchantAccount><accountNum>12345678</accountNum><storeID>myStoreID</storeID><storePwd>myStorePWD</storePwd>
</merchantAccount><startDate>
<year>2008</year><month>03</month><day>05</day><hour>00</hour><minute>00</minute><second>00</second>
</startDate><endDate>
<year>2008</year><month>03</month><day>05</day><hour>23</hour><minute>59</minute><second>59</second>
</endDate><type>authorizations</type><type>settlements</type><type>credits</type><type>chargebacks</type>
</ilsLookupRequestV1>
2. Insérez cette requête de transaction dans une requête HTTP Post (consultez la rubrique Exemple HTML – ILS à la page A-30).
3. Envoyez la requête HTTP Post à l’URL suivante :
https://webservices.optimalpayments.com/ilsWS/IlsServlet/v1
La taille maximale de fichier prise en charge est de 100 Ko. Si votre requête HTTP Post dépasse les 100 Ko, elle échouera.
Pour obtenir la liste et la description des paramètres à inclure dans cette requête, consultez le Tableau 4-1 : Éléments de transaction ilsLookupRequestV1 à la page 4-5.
Guide de référence de l’API pour les Services Web 1.0 A-29
Utilisation de la méthode HTTP Post mai 2019
Exemple HTML – ILS Cet exemple présente une version de formulaire de requête ILS, contenant l’exemple ci-dessus, que vous pourriez envoyer à Paysafe.
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html><title>Information Lookup Service</title><body><form NAME="ILS" METHOD="post"ACTION="https://webservices.optimalpayments.com/ilsWS/IlsServlet/v1"><b>XML Message body:</b><TEXTAREA class="xmlbox" name="txnRequest" COLS=100 ROWS=10 ><ilsLookupRequestV1 xmlns="http://www.optimalpayments.com/ils/xmlschema/v1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.optimalpayments.com/ils/xmlschema/v1">
<merchantAccount><accountNum>12345678</accountNum><storeID>myStoreID</storeID><storePwd>myStorePWD</storePwd>
</merchantAccount><startDate>
<year>2008</year><month>03</month><day>05</day><hour>00</hour><minute>00</minute><second>00</second>
</startDate><endDate>
<year>2008</year><month>03</month><day>05</day><hour>23</hour><minute>59</minute><second>59</second>
</endDate><type>authorizations</type><type>settlements</type><type>credits</type><type>chargebacks</type>
</ilsLookupRequestV1></TEXTAREA><br><input TYPE=submit class=input VALUE="Envoyer la requête"></form></body></html>
Pour voir le résultat affiché dans un navigateur, consultez la rubrique HTTP Post – Exemples à la page A-31. Si vous cliquez sur le bouton Envoyer la requête, la transaction sera envoyée à Paysafe par HTTP Post.
La taille maximale de fichier prise en charge est de 100 Ko. Si votre requête HTTP Post dépasse les 100 Ko, elle échouera.
A-30
mai 2019 HTTP Post – Exemples
HTTP Post – ExemplesVoici l’aspect qu’auraient les exemples de requêtes HTTP Post des types de transactions décrites dans le présent chapitre s’ils étaient affichés dans un navigateur :
Si vous cliquez sur le bouton Envoyer la requête, la transaction sera envoyée à Paysafe par HTTP Post.
HTTP Post – Réponses aux requêtesPaysafe retourne une réponse semblable à celle qui suit lorsqu’une requête de transaction réussit :
Paysafe retourne une réponse semblable à celle qui suit lorsqu’une requête de transaction échoue :
Guide de référence de l’API pour les Services Web 1.0 A-31
Utilisation de la méthode HTTP Post mai 2019
Vous trouverez une explication aux éléments de la réponse dans la rubrique Traitement de la réponse à la page 3-49. Pour obtenir une explication des codes d’erreur, consultez la rubrique Codes de réponse à la page B-1.
A-32
APPENDIX B
Codes de réponse
AperçuLes Services Web de Paysafe peuvent retourner divers types de codes lors de l’échec d’une tentative de transaction :
• Codes de réponse
• Codes d’action
• Codes de refus
Codes de réponse Le tableau suivant décrit les codes de réponse qui peuvent être retournés par les Services Web de Pay-safe.
Tableau B-1: Codes de réponse
Code de réponse
Action Description
1000 R Une erreur interne s’est produite. Ne réessayez pas la transaction. Communiquez avec le soutien technique pour obtenir plus de détails.
1001 R Une erreur s’est produite au niveau de la passerelle de traitement externe. Veuillez réessayer la transaction.
1002 R Une erreur interne s’est produite. Veuillez réessayer la transaction.
1003 D Une erreur s’est produite au niveau de la passerelle de traitement externe. Ne réessayez pas la transaction. Communiquez avec le soutien technique pour obtenir plus de détails.
1004 M Votre compte ne permet pas ce type de transaction. Veuillez vérifier vos paramètres et rées-sayer la transaction.
1006 D Une erreur s’est produite au niveau de la passerelle de traitement externe. Ne réessayez pas la transaction. Communiquez avec le soutien technique pour obtenir plus de détails.
1007 R Une erreur interne s’est produite. Veuillez réessayer la transaction.
1008 D Une erreur interne s’est produite. Ne réessayez pas la transaction. Communiquez avec le soutien technique pour obtenir plus de détails.
1018 D La passerelle de traitement externe a signalé que la transaction n’est pas autorisée. Ne rées-sayez pas la transaction. Communiquez avec le soutien technique pour obtenir plus de détails.
1028 M La passerelle de traitement externe a signalé des données non valides. Veuillez vérifier vos paramètres et réessayer la transaction.
1043 D La passerelle de traitement externe a signalé que le type de compte n’est pas valide. Ne rées-sayez pas la transaction. Communiquez avec le soutien technique pour obtenir plus de détails.
1060 D La passerelle de traitement externe a signalé qu’une limite a été atteinte. Ne réessayez pas la transaction.
Guide de référence de l’API pour les Services Web 1.0 B-1
Codes de réponse mai 2019
1078 R La passerelle de traitement externe a signalé une erreur système. Veuillez réessayer la trans-action.
1087 D La passerelle de traitement externe a rejeté la transaction. Ne réessayez pas la transaction. Communiquez avec le soutien technique pour obtenir plus de détails.
1101 M La combinaison carte / devise que vous avez soumise dans votre requête n’est pas prise en charge.
2000 D L’état du chèque électronique est introuvable.
2001 C Vous venez de soumettre une demande contenant le compte bancaire, le montant et le numéro de chèque utilisés conjointement dans une requête soumise au cours des dernières 24 heures.
2002 M La requête du chèque électronique est introuvable. Veuillez vérifier vos paramètres et rées-sayer.
2003 M Le type de paiement indiqué est incompatible avec le type de compte bancaire indiqué. Veuillez vérifier vos paramètres et réessayer la transaction.
2004 D La transaction de chèque électronique est introuvable.
2005 M Une erreur interne s’est produite. Veuillez vérifier vos paramètres et réessayer la transaction.
2006 C Vous avez répondu Refuser la transaction à une tentative de règlement.
2007 M Le type de paiement inclus dans votre requête ne peut être utilisé en mode de transaction de crédit. Veuillez vérifier vos paramètres et envoyer de nouveau la requête.
2008 C Vous avez indiqué un numéro d’acheminement non valide. Veuillez vérifier votre paramètre et réessayer la transaction.
2009 C Vous avez indiqué un numéro de compte bancaire non valide. Veuillez vérifier votre paramètre et réessayer la transaction.
2010 C Vous avez indiqué un numéro de chèque non valide. Veuillez vérifier votre paramètre et rées-sayer la transaction.
2011 M Vous avez indiqué une référence du mandat qui n’existe pas. Veuillez vérifier votre paramètre et réessayer la transaction.
2012 M Vous avez indiqué une référence du mandat qui n’est pas active en ce moment. Veuillez sou-mettre votre demande lorsque que le mandat sera actif ou soumettez votre demande à nou-veau en ajoutant une date txnDate après : <date>.
2013 M Vous avez indiqué une référence du mandat non valide. Veuillez vérifier votre paramètre et réessayer la transaction.
2016 M L’élément paymentToken ne peut pas être utilisé conjointement avec l’élément check ou l’élément billingDetails.
2017 M Le système bancaire du jeton de paiement ne correspond pas au système bancaire du compte marchand.
2014 M La référence du mandat est déjà utilisée pour les informations spécifiées du compte ban-caire. Veuillez spécifier une référence du mandat différente.
2100 D Vous avez tenté de rembourser une transaction de débit qui n’a pas été effectuée. Ne rées-sayez pas la transaction.
2101 R Le remboursement demandé est supérieur au montant débité restant. Veuillez vérifier vos paramètres et réessayer la transaction.
Tableau B-1: Codes de réponse (suite)
Code de réponse
Action Description
B-2
mai 2019 Codes de réponse
2102 R Le pays de l’institution financière indiqué dans votre requête n’est pas valide. Veuillez véri-fier votre paramètre et réessayer la transaction.
2500 D Aucun compte de marchand approprié n’a été trouvé pour cette requête. Ne réessayez pas la transaction. Communiquez avec le soutien technique pour obtenir plus de détails.
2501 D Une erreur interne s’est produite. Ne réessayez pas la transaction. Communiquez avec le soutien technique pour obtenir plus de détails.
2502 M Échec de l’authentification relative à votre requête de transaction. Les justificatifs d’identité n’ont pas été saisis correctement ou votre requête a été trafiquée. Veuillez vérifier votre requête et réessayer la transaction.
2503 M L’ID de magasin indiqué n’est pas valide. Il doit être représenté par une valeur numérique.
2504 M L’ID de magasin indiqué ne correspond à aucun magasin. Veuillez vérifier vos paramètres et réessayer la transaction.
2505 M Aucun compte de marchand n’a été trouvé pour la devise indiquée. Veuillez vérifier vos paramètres et réessayer la transaction.
2506 M Plus d’un compte de marchand a été trouvé pour la devise indiquée. Veuillez fournir un numéro de compte de marchand et envoyer de nouveau la requête.
2507 M Le compte de marchand indiqué ne correspond pas à l’ID de magasin indiqué. Veuillez véri-fier vos paramètres et réessayer la transaction.
2508 M Le paramètre encodedMessage est absent de votre requête. Veuillez vérifier vos paramètres et réessayer la transaction.
2509 M Le paramètre encodedMessage de votre requête n’est pas valide. Le paramètre encodedMes-sage n’a pu être décodé en base 64. Veuillez vérifier vos paramètres et envoyer de nouveau la requête.
2510 M Votre requête XML n’est pas valide. Veuillez vérifier votre requête et réessayer la transaction.
2511 R Une erreur interne s’est produite. Veuillez réessayer la transaction. Si l’erreur persiste, com-muniquez avec le soutien technique.
2512 M Le paramètre signature est absent de votre requête. Veuillez vérifier vos paramètres et rées-sayer la transaction.
2513 M Le paramètre ID de magasin est absent de votre requête. Veuillez vérifier vos paramètres et réessayer la transaction.
2514 D Une erreur interne s’est produite. Vos justificatifs d’identité de marchand sont introuvables. Ne réessayez pas la transaction. Communiquez avec le soutien technique pour obtenir plus de détails.
2515 R Une erreur interne s’est produite. Veuillez réessayer la transaction.
2516 D Une erreur interne s’est produite. Ne réessayez pas la transaction. Veuillez communiquer avec le soutien technique.
2517 D Une erreur interne s’est produite. Ne réessayez pas la transaction. Veuillez communiquer avec le soutien technique.
2518 R Une erreur interne s’est produite. Veuillez réessayer la transaction. Si l’erreur persiste, com-muniquez avec le soutien technique.
2519 D Le magasin indiqué dans votre requête est désactivé. Ne réessayez pas la transaction.
Tableau B-1: Codes de réponse (suite)
Code de réponse
Action Description
Guide de référence de l’API pour les Services Web 1.0 B-3
Codes de réponse mai 2019
2520 M La somme de cartItem et de feeItem ne correspond pas à totalAmount. Veuillez vérifier vos paramètres et réessayer la transaction.
2521 D Une erreur interne s’est produite. Votre magasin n’est pas correctement configuré. Ne rées-sayez pas la transaction. Communiquez avec le soutien technique pour obtenir plus de détails.
2523 R Une erreur interne s’est produite. Veuillez réessayer la transaction. Si l’erreur persiste, com-muniquez avec le soutien technique.
2524 D Une erreur interne s’est produite. Le profil client n’est pas correctement configuré. Ne rées-sayez pas la transaction. Communiquez avec le soutien technique pour obtenir plus de détails.
2525 M Le profil client associé au jeton fourni est introuvable. Veuillez vérifier vos paramètres et réessayer la transaction.
2526 R Une erreur interne de gestion de profil s’est produite et votre requête n’a pu être traitée. Veuillez réessayer la transaction. Si l’erreur persiste, communiquez avec le soutien tech-nique.
2527 M Le lieu indiqué dans votre requête n’est pas pris en charge. Veuillez vérifier vos paramètres et réessayer la transaction.
2528 M L’ID de client du marchand indiqué dans votre requête n’est pas associé au jeton de client fourni. Veuillez vérifier vos paramètres et réessayer la transaction.
2529 R Une erreur interne s’est produite. Veuillez réessayer la transaction.
2530 D Une erreur interne s’est produite. Ne réessayez pas la transaction. Communiquez avec le soutien technique pour obtenir plus de détails.
2531 M Un profil client associé au même ID de client du marchand existe déjà. Veuillez vérifier vos paramètres et réessayer la transaction.
2532 D Votre magasin n’est pas configuré pour le traitement de paiements. Ne réessayez pas la transaction. Communiquez avec le soutien technique pour obtenir plus de détails.
2533 D Votre magasin n’est pas configuré pour traiter le mode de paiement sélectionné. Ne rées-sayez pas la transaction. Communiquez avec le soutien technique pour obtenir plus de détails.
2534 M Le profil client associé au jeton fourni n’est pas actif. Veuillez vérifier vos paramètres et vous assurer que l’état du client est actif, puis réessayez la transaction.
2535 M Le profil client associé au jeton fourni comporte un compte bancaire non validé. Veuillez vérifier vos paramètres ou demander à votre client de valider le compte bancaire, puis rées-sayez la transaction.
2536 D La transaction a été refusée parce que le nombre maximum de tentatives a été atteint. Ne réessayez pas la transaction.
2537 D La validation du compte bancaire a échoué parce que le nombre maximum de tentatives a été atteint. Ne réessayez pas la transaction.
2538 D Le client a entré un montant de microdépôt non valide.
2539 R Une erreur interne s’est produite. Veuillez réessayer la transaction. Si l’erreur persiste, com-muniquez avec le soutien technique.
2540 M Le numéro de référence du marchand existe déjà. Veuillez vérifier vos paramètres et rées-sayer la transaction.
Tableau B-1: Codes de réponse (suite)
Code de réponse
Action Description
B-4
mai 2019 Codes de réponse
2541 R Une erreur interne s’est produite lors de l’envoi de la transaction de microdépôt. Veuillez réessayer la transaction. Si l’erreur persiste, communiquez avec le soutien technique.
2542 D Échec de la vérification AVS lors de la validation du profil client.
2543 M L’état du client ne peut être validé. Veuillez réinitialiser l’état du client avant de réessayer la transaction.
2544 D Le profil client ne comprend pas les renseignements sur la carte de crédit nécessaires à la validation.
2545 D Le client a tenté d’enregistrer un compte bancaire de TEF déjà utilisé par un autre client. Ne réessayez pas la transaction.
2546 D Le client a tenté d’enregistrer une carte de crédit déjà utilisée par un autre client. Ne rées-sayez pas la transaction.
2547 M Le profil client associé au jeton fourni ne comporte pas de carte de crédit. Veuillez vérifier vos paramètres et réessayer la transaction.
2548 M Le profil client utilisé pour cette transaction n’a pas été créé. Veuillez vérifier vos paramètres et réessayer la transaction.
2549 M Votre magasin n’est pas configuré en fonction de l’enregistrement d’un compte bancaire pour le pays indiqué. Veuillez vérifier vos paramètres et réessayer la transaction.
2550 M Le profil client associé au jeton fourni ne comporte pas de compte bancaire enregistré. Veuillez vérifier vos paramètres et réessayer la transaction.
2551 M Le mode de paiement dans votre requête n’est pas valide. Veuillez vérifier vos paramètres et réessayer la transaction.
2552 M L’ID de transaction de votre requête n'est pas valide. Veuillez vérifier vos paramètres et rées-sayer la transaction.
2553 D Notre système n’est pas en mesure de trouver la réponse confirmant l’inscription associée à votre requête d’ID de transaction. Ne réessayez pas la transaction. Communiquez avec le soutien technique pour obtenir plus de détails.
2554 M Le profil client associé au jeton fourni est désactivé. Veuillez vérifier vos paramètres et vous assurer que l’état du client est actif, puis réessayez la transaction.
2555 M Le jeton n’est pas associé au profil client fourni. Veuillez vérifier vos paramètres et réessayer la transaction.
2556 M La carte de crédit fournie pour cette transaction n’est pas activée pour le moment. Veuillez vérifier vos paramètres et réessayer la transaction.
2557 M Le numéro de confirmation indiqué dans la requête est introuvable. Veuillez vérifier ce paramètre et réessayer la transaction.
2558 M La transaction ne peut être annulée. Veuillez vérifier vos paramètres et assurez-vous d’annuler la bonne transaction. Si l’erreur persiste, communiquez avec le soutien technique.
2701 Aucune La validation par Equifax a été acceptée à la condition que la requête du client soit vérifiée.
2702 R Une erreur interne s’est produite lors du traitement d’une transaction Equifax. Réessayez la transaction. Si l’erreur persiste, communiquez avec le soutien technique.
2703 R Les bases de données d’Equifax sont totalement ou partiellement hors service. Réessayez la transaction. Si l’erreur persiste, communiquez avec le soutien technique.
2704 D La validation par Equifax a été rejetée. Ne réessayez pas la transaction.
Tableau B-1: Codes de réponse (suite)
Code de réponse
Action Description
Guide de référence de l’API pour les Services Web 1.0 B-5
Codes de réponse mai 2019
2705 R La validation par Equifax a été rejetée et doit être traitée manuellement. Par exemple, le marchand peut communiquer avec le client directement.
2706 R La validation par Equifax a été rejetée parce que les données entrées ne sont pas valides. Veuillez vérifier vos paramètres et réessayer la transaction.
2707 R La validation par Equifax a été rejetée parce que l’adresse n’est pas valide. Veuillez vérifier vos paramètres et réessayer la transaction.
2708 R Une erreur interne s’est produite. Les codes de réponse d’Equifax sont absents. Veuillez véri-fier vos paramètres et réessayer la transaction.
2709 D L’institution financière a rejeté la transaction. Elle n’a pas pu traiter la requête.
2710 D Le courriel de confirmation de la transaction n’a pu être envoyé car aucun modèle de courriel n’est configuré.
2711 M Rejet de la validation pour la mise à jour du profil. Ne réessayez pas la transaction.
3001 C Le type de carte indiqué dans votre requête n’est pas pris en charge. Veuillez vérifier ce paramètre et réessayer la transaction.
3002 C Le numéro de carte, la marque de carte ou la combinaison de numéro et de marque de votre requête n’est pas valide. Veuillez vérifier ces paramètres et réessayer la transaction.
3003 C La valeur donnée au paramètre cvdIndicator dans votre requête est incorrecte. Veuillez véri-fier ce paramètre et réessayer la transaction.
3004 C Vous avez demandé une vérification AVS. Assurez-vous que le code postal est indiqué.
3005 C La valeur donnée au paramètre cvd dans votre requête est incorrecte. Veuillez vérifier ce paramètre et réessayer la transaction.
3006 C Le numéro de carte de crédit indiqué dans votre requête est expiré. Veuillez vérifier ce paramètre et envoyer de nouveau la requête.
3007 D Échec de la vérification AVS. Veuillez noter que le montant peut avoir été retenu sur la carte du client et sera libéré dans les trois à cinq jours ouvrables. Veuillez vous assurer que l’adresse de facturation est exacte avant de réessayer la transaction.
3008 D Le compte de marchand n’est pas configuré en fonction du type de carte indiqué.
3009 D Votre requête a été refusée par l’institution financière émettrice.
3011 D Votre requête a été refusée par l’institution financière émettrice parce que la carte utilisée fait l’objet de restrictions. Communiquez avec la société émettrice de la carte de crédit du tit-ulaire pour obtenir de plus amples renseignements.
3012 D Votre requête a été refusée par l’institution financière émettrice parce que la date d’expira-tion de la carte de crédit indiquée n’est pas valide.
3013 D Votre requête a été refusée par l’institution financière émettrice en raison de problèmes rela-tifs au compte de carte de crédit.
3014 D Votre requête a été refusée. L’institution financière émettrice a donné une réponse incon-nue. Communiquez avec la société émettrice de la carte de crédit du titulaire pour obtenir de plus amples renseignements.
3015 D L’institution financière a demandé que vous traitiez la transaction manuellement en appe-lant la société émettrice de la carte de crédit du titulaire.
3016 D L’institution financière a demandé que vous récupériez la carte du titulaire; il s’agit peut-être d’une carte perdue ou volée.
Tableau B-1: Codes de réponse (suite)
Code de réponse
Action Description
B-6
mai 2019 Codes de réponse
3017 C Le numéro de carte de crédit indiqué dans votre requête n’est pas valide. Veuillez vérifier ce paramètre et réessayer la transaction.
3018 R L’institution financière a demandé que vous réessayiez la transaction.
3019 C Échec de la vérification CVD. Veuillez noter que le montant aurait pu quand même être blo-qué sur la carte du client. Si c’est le cas, le montant sera libéré dans les trois à cinq jours ouvrables. Veuillez vous assurer que la valeur CVD est exacte avant de réessayer la transac-tion.
3020 R L’institution financière a demandé que vous réessayiez la transaction.
3021 M Le numéro de confirmation indiqué dans la requête est introuvable. Veuillez vérifier ce paramètre et réessayer la transaction.
3022 D La carte a été refusée pour provision insuffisante.
3023 D Votre requête a été refusée par l’institution financière émettrice en raison des règles propres à l’institution en ce qui a trait à l’activité de ses cartes de crédit.
3024 D Votre requête a été refusée parce que l’institution financière émettrice ne permet pas d’effectuer cette transaction au moyen de cette carte.
3025 R La passerelle de traitement externe a signalé des données non valides. Veuillez vérifier vos paramètres et réessayer la transaction.
3026 D La passerelle de traitement externe a signalé que le type de compte n’est pas valide. Ne rées-sayez pas la transaction. Communiquez avec le soutien technique pour obtenir plus de détails.
3027 D La passerelle de traitement externe a signalé qu’une limite a été atteinte. Ne réessayez pas la transaction.
3028 R La passerelle de traitement externe a signalé une erreur système. Veuillez réessayer la trans-action.
3029 D La passerelle de traitement externe a rejeté la transaction. Ne réessayez pas la transaction. Communiquez avec le soutien technique pour obtenir plus de détails.
3030 D La passerelle de traitement externe a signalé que la transaction n’est pas autorisée. Ne rées-sayez pas la transaction. Communiquez avec le soutien technique pour obtenir plus de détails.
3031 M Le numéro de confirmation que vous avez soumis dans la requête est associé à une transac-tion qui n’est pas en attente.
3032 D Votre requête a été refusée par l’institution financière émettrice ou par la passerelle de trait-ement externe en raison du numéro de la carte qui figure dans l’une de leurs bases de don-nées négatives.
3035 D Votre requête a été refusée en raison d’un nombre excessif de tentatives de NIP.
3036 D Votre requête a été refusée en raison d’une institution financière émettrice invalide.
3037 D Votre requête a été refusée en raison d’être invalide.
3038 D Votre requête a été refusée en raison d’annulation par le client.
3039 D Votre requête a été refusée en raison d’une valeur d’authentification invalide.
3040 D Votre requête a été refusée parce que le type de requête n’est pas permise sur la carte de crédit.
Tableau B-1: Codes de réponse (suite)
Code de réponse
Action Description
Guide de référence de l’API pour les Services Web 1.0 B-7
Codes de réponse mai 2019
3041 D Votre requête a été refusée en raison d’un délai de connection dépassé.
3042 D Votre requête a été refusée en raison d’une erreur de cryptographie.
3044 D Vous avez envoyé un double de cette requête.
3045 D Le format de date indiquée dans votre requête n’est pas valide.
3046 D La transaction a été refusée parce que le montant a été reglé à zero.
3047 D La transaction a été refusée parce que le montant dépasse la limite.
3048 D La transaction a été refusée parce que le montant est inférieur à la limite.
3049 D L’institution financière a demandé que vous récupériez la carte du titulaire; la carte a expirée.
3050 D L’institution financière a demandé que vous récupériez la carte du titulaire; activité fraudu-leuse est suspectée.
3051 D L’institution financière a demandé que vous récupériez la carte du titulaire; contacter l’acquéreur de la carte pour obtenir de plus amples renseignements.
3052 D L’institution financière a demandé que vous récupériez la carte du titulaire; la carte de crédit est limitée.
3053 D L’institution financière a demandé que vous récupériez la carte du titulaire; veuillez commu-niquer avec l’acquéreur.
3054 D La transaction a été refuse; activité frauduleuse est suspectée.
3200 M Le format de l’ID d’autorisation du règlement n’est pas valide. Veuillez vérifier ce paramètre et réessayer la transaction.
3201 M L’ID d’autorisation indiqué dans la requête de règlement est introuvable. Veuillez vérifier ce paramètre et réessayer la transaction.
3202 D Vous avez atteint le nombre maximum de règlements autorisé. Communiquez avec le sout-ien technique pour obtenir plus de détails.
3203 M L’autorisation a été soit réglée en entier, soit annulée.
3204 M Le règlement demandé est supérieur au montant de l’autorisation restant.
3205 M L’autorisation que vous tentez de régler est périmée.
3206 D La passerelle de traitement externe a rejeté la transaction. Ne réessayez pas la transaction. Communiquez avec le soutien technique pour obtenir plus de détails.
3402 M Le montant du crédit demandé est supérieur au montant du règlement restant.
3403 M Vous avez déjà traité le nombre maximum de crédits autorisé pour ce règlement.
3404 M Ce règlement a déjà été crédité en entier.
3405 M Le règlement que vous tentez de créditer est périmé.
3406 M Le règlement que vous tentez de créditer n’a pas encore été mis en lot. Il n’existe pas de fonds de règlement disponibles à créditer.
3407 M Le règlement désigné par l’ID de réponse de transaction fourni est introuvable. Veuillez véri-fier ce paramètre et réessayer la transaction.
Tableau B-1: Codes de réponse (suite)
Code de réponse
Action Description
B-8
mai 2019 Codes de réponse
3408 M Le format de l’ID de réponse du règlement ou de l’achat initial n’est pas valide. Veuillez véri-fier ce paramètre et réessayer la transaction.
3409 M L’ID d’autorisation indiqué dans la requête de crédit est introuvable. Veuillez vérifier ce paramètre et réessayer la transaction.
3410 M Échec de la requête de remboursement.
3411 M Échec de l’annulation de la requête de remboursement.
3412 M La transaction de crédit que vous avez tenté d’effectuer n’a pas été autorisée parce que votre compte de marchand présente un découvert.
3413 M Le montant du crédit demandé dépasse le ratio de crédit permis par Visa. Veuillez vérifier ce paramètre et réessayer la transaction.
3414 M Le crédit désigné par l’ID de réponse de transaction fourni est introuvable. Veuillez vérifier ce paramètre et réessayer la transaction.
3415 D Vous ne pouvez pas annuler cette transaction. L’état de la transaction ne permet pas son annulation. Par exemple, elle peut avoir déjà été traitée et ne plus être en attente.
3416 M La passerelle de traitement externe pour laquelle votre compte de marchand est configuré ne prend pas en charge les règlements partiels. Assurez-vous que le montant du règlement est identique au montant de l’autorisation initiale et réessayez la transaction.
3417 M Il existe déjà une autre requête en cours de traitement sur la transaction référencée pour cette requête. SVP utilisez le numéro de confirmation utilisé pour cette requête afin de sortir un rapport ou rechercher pour déterminer les résultats.
3418 M La passerelle de traitement externe pour laquelle votre compte de marchand est configuré ne prend pas en charge les crédit partiels.
3500 M Le numéro de confirmation indiqué dans la requête est introuvable. Veuillez vérifier ce paramètre et réessayer la transaction.
3501 M Le montant de l’inversion d’autorisation demandé est supérieur au montant de l’autorisa-tion restant.
3502 D Cette autorisation a déjà été réglée. Vous ne pouvez pas effectuer une transaction d’inver-sion d’autorisation sur une autorisation réglée.
3503 M La transaction d’inversion d’autorisation n’est pas prise en charge pour le type de carte util-isée pour l’autorisation que vous tentez d’inverser.
3504 M La passerelle de traitement externe pour laquelle votre compte de marchand est configuré ne prend pas en charge les inversions d’autorisation partielles. Assurez-vous que le montant de l’inversion est identique au montant de l’autorisation initiale et réessayez la transaction.
3505 M Impossible d’effectuer l’inversion d’autorisation.
3506 M Le montant de l’inversion est supérieur au montant d’autorisation restant.
3601 D Échec de l’authentification 3D Secure du titulaire de carte par la société émettrice.
3602 M Le numéro de confirmation indiqué dans la requête d’authentification 3D Secure est introuv-able. Le numéro de confirmation doit être le numéro retourné en réponse à l’autorisation ou à l’achat initial par le processeur de paiement.
3603 M Vous avez envoyé une requête qu’il n’est pas possible d’exécuter pour l’authentification 3D Secure.
Tableau B-1: Codes de réponse (suite)
Code de réponse
Action Description
Guide de référence de l’API pour les Services Web 1.0 B-9
Codes de réponse mai 2019
3604 D La requête d’autorisation ou d’achat initiale est périmée. La requête d’authentification 3D Secure doit être effectuée dans les 60 minutes qui suivent l’autorisation ou l’achat initial.
3605 D Le service d’authentification 3D Secure n’était pas disponible pour la carte utilisée lors de cette transaction.
3701 M Le numéro de confirmation indiqué dans la requête est introuvable. Veuillez vérifier ce paramètre et réessayer la transaction.
3702 D Vous ne pouvez pas annuler cette transaction de paiement. L’état de la transaction ne per-met pas son annulation. Par exemple, elle peut avoir déjà été traitée et ne plus être en attente.
3703 C La passerelle de traitement externe a signalé que le montant indiqué dans votre requête n’est pas valide. Veuillez vérifier ce paramètre et réessayer la transaction.
3704 M La requête visée est introuvable.
3705 M La requête visée utilise un numéro de carte différente.
3706 M La requête visée n’est pas entièrement authentifiée.
3707 D La requête visée manque des réponses.
3708 M La requête visée n’a pas été réglée.
3800 D La transaction a été refusée par la passerelle d’authentification. Ne réessayez pas la transac-tion.
3801 D La transaction a été refusée par la passerelle de paiement. Ne réessayez pas la transaction.
3802 R La transaction n’a pas été effectuée. Veuillez réessayer la transaction.
3803 D Échec de la tentative de transaction. Ne réessayez pas la transaction. Veuillez communiquer avec le soutien technique pour obtenir plus de détails.
3804 M Vous avez tenté de rembourser une transaction de paiement qui n’a pas été effectuée.
3805 M Le montant du remboursement demandé est supérieur au montant disponible pour rem-boursement. Veuillez vérifier ce paramètre et réessayer la transaction.
3806 D Vous avez tenté d’effectuer un remboursement, mais aucun montant admissible au rem-boursement n’a été trouvé. Ne réessayez pas la transaction.
3807 D Vous avez tenté d’effectuer un remboursement, mais une tentative de remboursement simultanée a été détectée. Ne réessayez pas la transaction.
3808 D Vous avez tenté un remboursement, mais la transaction a été refusée par le fournisseur de solutions de paiement. Ne réessayez pas la transaction.
3809 D Le fournisseur de solutions de paiement pour la transaction que vous avez tenté d’effectuer ne vous a pas donné l’autorisation. Ne réessayez pas la transaction.
3810 D La transaction de paiement est en attente en raison des filtres contre la fraude du fournis-seur de solutions de paiement. Ne réessayez pas la transaction.
3811 D La requête a été annulée par le client.
3812 D La somme de cartItem ne correspond pas à totalAmount. Ne réessayez pas la transaction.
3850 D La carte prépayée associée au jeton de paiement n’est plus valide. Veuillez demander au cli-ent d’entrer les détails d’une autre carte.
Tableau B-1: Codes de réponse (suite)
Code de réponse
Action Description
B-10
mai 2019 Codes de réponse
4000 Refusé en raison des risques.
4001 D Le numéro de carte ou l’adresse de courriel correspondant à cette transaction figure dans notre base de données d’éléments négatifs.
4002 D La transaction a été refusée par notre service de gestion du risque.
5000 M Échec de l’authentification de votre compte de marchand. Soit votre ID de magasin ou votre mot de passe de magasin n’est pas valide, soit l’utilisation de l’adresse IP d’où provient la transaction n’a pas été autorisée. Veuillez vérifier ces paramètres et réessayer la transaction. Si l’erreur persiste, veuillez communiquer avec le soutien technique.
5001 M Le code de devise indiqué dans votre requête n’est pas valide. Veuillez vérifier ce paramètre et réessayer la transaction.
5002 M Le mode de paiement indiqué dans votre requête n’est pas valide. Veuillez vérifier ce paramètre et réessayer la transaction.
5003 C Le montant indiqué dans votre requête n’est pas valide. Veuillez vérifier ce paramètre et réessayer la transaction.
5004 M Le type de compte indiqué dans votre requête n’est pas valide. Veuillez vérifier ce paramètre et réessayer la transaction.
5005 M Le type d’opération indiqué dans votre requête n’est pas valide. Veuillez vérifier ce paramètre et réessayer la transaction.
5006 M Le type d’ID utilisateur indiqué dans votre requête n’est pas valide. Veuillez vérifier ce paramètre et réessayer la transaction.
5007 M Le type de produit indiqué dans votre requête n’est pas valide. Veuillez vérifier ce paramètre et réessayer la transaction.
5008 M Le transporteur indiqué dans votre requête n’est pas valide. Veuillez vérifier ce paramètre et réessayer la transaction.
5009 M Le mode d’expédition indiqué dans votre requête n’est pas valide. Veuillez vérifier ce paramètre et réessayer la transaction.
5010 M L’ID de pays indiqué dans votre requête n’est pas valide. Veuillez vérifier ce paramètre et réessayer la transaction.
5011 M La date et l’heure de la commande indiquées dans votre requête ne sont pas valides. Veuillez vérifier ce paramètre et réessayer la transaction.
5012 M Le paramètre de pays d’expédition indiqué dans votre requête n’est pas valide. Veuillez véri-fier ce paramètre et réessayer la transaction.
5013 M Le paramètre d’état d’expédition indiqué dans votre requête n’est pas valide. Veuillez vérifier ce paramètre et réessayer la transaction.
5014 M Le type de transaction indiqué dans votre requête n’est pas valide. Veuillez vérifier ce paramètre et réessayer la transaction.
5015 M Au moins un des paramètres de votre requête dépasse le nombre de caractères maximum autorisé. Veuillez vérifier vos paramètres et réessayer la transaction.
5016 M Le compte de marchand indiqué n’est pas valide ou est introuvable. Veuillez vérifier ce paramètre et réessayer la transaction. Si l’erreur persiste, veuillez communiquer avec le sou-tien technique.
5017 D Le compte de marchand indiqué dans votre requête n’est pas activé. Ne réessayez pas la transaction. Communiquez avec le soutien technique pour obtenir plus de détails.
Tableau B-1: Codes de réponse (suite)
Code de réponse
Action Description
Guide de référence de l’API pour les Services Web 1.0 B-11
Codes de réponse mai 2019
5018 M Vous avez soumis une requête manquant un paramètre ou contenant un paramètre non valide.
5019 D Aucun processeur n’est configuré pour le compte de marchand indiqué dans votre requête. Ne réessayez pas la transaction. Communiquez avec le soutien technique pour obtenir plus de détails.
5020 M Le type de devise indiqué dans votre requête ne correspond pas au type de devise de votre compte de marchand. Veuillez vérifier vos paramètres et envoyer de nouveau la requête.
5021 D Votre requête de transaction a été refusée. Veuillez vérifier les détails de la transaction avant de réessayer. Pour obtenir de plus amples renseignements, veuillez communiquer avec le soutien technique.
5022 M Les critères de recherche sont absents de la requête. Veuillez vérifier vos paramètres et rées-sayer la transaction.
5023 M Votre requête XML n’est pas valide. Veuillez vérifier votre requête et réessayer la transaction.
5024 M La date d’expiration de l’ID indiquée dans votre requête n’est pas valide. Veuillez vérifier ce paramètre et réessayer la transaction.
5025 M Les critères de recherche indiqués dans votre requête ne sont actuellement pas pris en charge. Veuillez vérifier vos critères de recherche et réessayer.
5026 M L’API des Services Web ne prend actuellement pas en charge les transactions par carte de crédit. Veuillez vérifier vos paramètres et réessayer la transaction.
5027 M Le nom de service du risque indiqué dans votre requête n’est pas valide. Veuillez vérifier vos paramètres et réessayer la transaction.
5028 M Vous avez envoyé un fichier séquentiel de nom, de taille et de nombre d’entrées identiques au cours des 24 dernières heures.
5029 M Vous avez envoyé un fichier séquentiel mal formaté.
5030 M Vous avez envoyé un fichier séquentiel dont le nombre de lignes est supérieur au maximum autorisé.
5031 M La transaction que vous avez envoyée a déjà été traitée.
5032 C La ville indiquée dans votre requête n’est pas valide. Veuillez vérifier ce paramètre et rées-sayer la transaction.
5033 C Le pays indiqué dans votre requête n’est pas valide. Veuillez vérifier ce paramètre et rées-sayer la transaction.
5034 C L’adresse de courriel indiquée dans votre requête n’est pas valide. Veuillez vérifier ce paramètre et réessayer la transaction.
5035 C Le nom indiqué dans votre requête n’est pas valide. Veuillez vérifier ce paramètre et rées-sayer la transaction.
5036 C Le numéro de téléphone indiqué dans votre requête n’est pas valide. Veuillez vérifier ce paramètre et réessayer la transaction.
5037 C Le code postal indiqué dans votre requête n’est pas valide. Veuillez vérifier ce paramètre et réessayer la transaction.
5038 C La province ou l’état indiqué dans votre requête n’est pas valide. Veuillez vérifier ce paramètre et réessayer la transaction.
Tableau B-1: Codes de réponse (suite)
Code de réponse
Action Description
B-12
mai 2019 Codes de réponse
5039 C Le nom de rue indiqué dans votre requête n’est pas valide. Veuillez vérifier ce paramètre et réessayer la transaction.
5040 D Votre compte de marchand n’est pas configuré en fonction de la transaction que vous avez tenté d’effectuer. Veuillez communiquer avec le soutien technique pour obtenir plus de détails.
5041 M Le paramètre merchantData indiqué dans votre requête n’est pas valide. Veuillez vérifier ce paramètre et réessayer la transaction.
5042 M Le numéro de référence du marchand est absent, n’est pas valide ou dépasse la longueur permise. Veuillez vérifier ce paramètre et réessayer la transaction.
5043 M La date d’ouverture de compte indiquée dans votre requête n’est pas valide. Veuillez vérifier ce paramètre et réessayer la transaction.
5044 M L’ID de client indiqué dans votre requête n’est pas valide. Veuillez vérifier ce paramètre et réessayer la transaction.
5045 M L’adresse IP du client indiquée dans votre requête n’est pas valide. Veuillez vérifier ce paramètre et réessayer la transaction.
5046 M Le code SIC du marchand indiqué dans votre requête n’est pas valide. Veuillez vérifier ce paramètre et réessayer la transaction.
5047 M La valeur donnée au paramètre d’ancien client dans votre requête n’est pas valide. Veuillez vérifier ce paramètre et réessayer la transaction.
5048 M Le code de produit indiqué dans votre requête n’est pas valide. Veuillez vérifier ce paramètre et réessayer la transaction.
5049 M La valeur indiquée pour les données utilisateur dans votre requête n’est pas valide. Veuillez vérifier ce paramètre et réessayer la transaction.
5050 D Une erreur s’est produite lors de la configuration de votre compte de marchand. Veuillez communiquer avec le soutien technique.
5051 C Le numéro de confirmation indiqué dans votre requête n’est pas valide. Veuillez vérifier le paramètre et réessayer.
5052 C Le code postal indiqué dans votre requête n’est pas valide. Veuillez vérifier votre paramètre et réessayer la transaction.
5053 C Les renseignements d’ID utilisateur indiqués dans votre requête ne sont pas valides. Veuillez vérifier vos paramètres et réessayer la transaction.
5054 M Vous ne pouvez pas envoyer des éléments de facturation récurrente avec ce type d’opéra-tion. Veuillez vous assurer que votre requête comprend le type d’opération approprié et réessayer la transaction.
5055 M La valeur ECI de votre requête n’est pas valide. Veuillez vérifier ce paramètre et réessayer la transaction.
5056 M Une valeur ECI doit être fournie pour l’authentification 3D Secure. Veuillez vérifier ce paramètre et réessayer la transaction.
5057 M La marque de carte de crédit indiquée dans votre requête ne prend pas en charge l’authentification 3D Secure. Veuillez vérifier ce paramètre et réessayer la transaction.
5058 M Une valeur CAVV doit être fournie pour l’authentification 3D Secure. Veuillez vérifier ce paramètre et réessayer la transaction.
5059 M La valeur indiquée pour le service de demande de devise n’est pas valide.
Tableau B-1: Codes de réponse (suite)
Code de réponse
Action Description
Guide de référence de l’API pour les Services Web 1.0 B-13
Codes de réponse mai 2019
5060 M Le paramètre recurringIndicator indiqué dans votre requête n’est pas valide. Veuillez vérifier ce paramètre et réessayer la transaction.
5061 M Échec d’une vérification de sécurité lors du traitement de cette transaction. Veuillez rées-sayer la transaction. Si l’erreur persiste, communiquez avec le soutien technique.
5062 M Votre requête comporte des caractères non valides. Veuillez vous assurer que tous les paramètres ne contiennent que des caractères dont le codage par URL est possible, puis réessayez la transaction.
5063 M Le KEYWORD indiqué dans votre requête n’est pas valide. Veuillez vérifier ce paramètre et réessayer la transaction.
5064 M Le NETBANX_REFERENCE indiqué dans votre requête n’est pas valide. Veuillez vérifier ce paramètre et réessayer la transaction.
5065 M Vous avez demandé une changement d’état non valide.
5066 M La passerelle de traitement externe pour laquelle votre compte de marchand est configuré ne prend pas en charge les Crédits indépendants.
5067 M La passerelle de traitement externe pour laquelle votre compte de marchand est configuré ne prend pas en charge les Paiements de cartes de crédit.
5068 M Vous avez omis de remplir un champ obligatoire dans votre requête ou la valeur d’un champ n’est pas saisie dans le bon format.
5071 M Votre requête comporte des critères de recherche non valides. Veuillez vérifier vos paramètres et réessayer la transaction.
5074 M Au moins un des paramètres de votre requête n’atteint pas le nombre de caractères mini-mum requis. Veuillez vérifier vos paramètres et réessayer la transaction.
5075 M Au moins un des paramètres de votre requête contient un espace au début ou à la fin. Veuillez vérifier vos paramètres et réessayer la transaction.
5269 Les ID(s) indiqués dans l’URL ne correspondent pas aux valeurs dans le système.
5270 La clé d’API fournie avec la requête n’est pas autorisée à accéder aux données demandées.
5271 Vous avez demandé une réponse dans un format qui n'est pas pris en charge.
5272 Vous avez soumis votre requête dans un format qui n’est pas pris en charge.
5273 L’URL est non valide ou le serveur n’est pas déployé correctement.
5274 La clé d’API indiquée pour cette requête ne peut pas être utilisée car elle est expirée ou dés-activée/verrouillée.
5275 La clé d’API indiquée pour cette requête ne peut pas être utilisée car elle est expirée ou dés-activée/verrouillée.
5276 La clé d’API indiquée pour cette requête ne peut pas être utilisée car elle est expirée ou dés-activée/verrouillée.
5277 La clé d’API indiquée pour cette requête ne peut pas être utilisée car elle est expirée ou dés-activée/verrouillée.
5278 La clé d’API a été refusée pour une raison inconnue.
5279 L’ID ou le mot de passe de la clé d’API est non valide.
Tableau B-1: Codes de réponse (suite)
Code de réponse
Action Description
B-14
mai 2019 Codes de réponse
5502 Soit le jeton de paiement est invalide ou le profil ou compte bancaire correspondant est dés-activé.
6001 Le service d’identification est désactivé.
6002 L’URL et le type de question ne correspondent pas.
6004 La question de suivi définie a déjà été soumise.
6005 Un problème est survenu lors de la configuration du compte.
6006 Une erreur de communication s’est produite.
6007 Une erreur s’est produite dans la passerelle de traitement externe.
6008 La réponse de la passerelle externe comporte une erreur.
6009 L’utilisateur a pris trop de temps à soumettre la réponse. La transaction a été interrompue.
7000 D L’adresse que vous tentez de créer existe déjà.
7001 M Création de l’adresse impossible. Essayez de nouveau ou communiquez avec le soutien technique.
7002 M Mise à jour de l’adresse impossible. Essayez de nouveau ou communiquez avec le soutien technique.
7003 M L’adresse indiquée est introuvable.
7004 M Chargement de l’adresse impossible. Essayez de nouveau ou communiquez avec le soutien technique.
7005 M Le type d’adresse indiqué n’est pas valide.
7006 M Les adresses du client sont introuvables.
7007 M Chargement des adresses impossible. Essayez de nouveau ou communiquez avec le soutien technique.
7010 D Le client que vous tentez de créer existe déjà.
7011 M Création du client impossible. Essayez de nouveau ou communiquez avec le soutien tech-nique.
7012 M Mise à jour du client impossible. Essayez de nouveau ou communiquez avec le soutien tech-nique.
7013 M Le client indiqué est introuvable.
7014 M Chargement du client impossible. Essayez de nouveau ou communiquez avec le soutien technique.
7015 M Le type de création de client indiqué dans votre requête n’est pas valide.
7016 M Le titre de client indiqué dans votre requête n’est pas valide.
7020 D Le mode de communication que vous tentez de créer existe déjà.
7021 M Création du mode de communication impossible. Essayez de nouveau ou communiquez avec le soutien technique.
Tableau B-1: Codes de réponse (suite)
Code de réponse
Action Description
Guide de référence de l’API pour les Services Web 1.0 B-15
Codes de réponse mai 2019
7022 M Mise à jour du mode de communication impossible. Essayez de nouveau ou communiquez avec le soutien technique.
7023 M Le mode de communication indiqué est introuvable.
7024 M Chargement du mode de communication impossible. Essayez de nouveau ou communiquez avec le soutien technique.
7025 M Le type de mode de communication indiqué n’est pas valide.
7026 M Les modes de communication du client sont introuvables.
7027 M Chargement des modes de communication impossible. Essayez de nouveau ou communi-quez avec le soutien technique.
7040 D Le mode de paiement que vous tentez de créer existe déjà.
7041 M Création du mode de paiement impossible. Essayez de nouveau ou communiquez avec le soutien technique.
7042 M Mise à jour du mode de paiement impossible. Essayez de nouveau ou communiquez avec le soutien technique.
7043 M Le mode de paiement indiqué est introuvable.
7044 M Chargement du mode de paiement impossible. Essayez de nouveau ou communiquez avec le soutien technique.
7045 M Le type de mode de paiement indiqué n’est pas valide.
7046 M Les modes de paiement du client sont introuvables.
7047 M Chargement des modes de paiement impossible. Essayez de nouveau ou communiquez avec le soutien technique.
7050 D Le calendrier de facturation que vous tentez de créer existe déjà.
7051 M Création du calendrier de facturation impossible. Essayez de nouveau ou communiquez avec le soutien technique.
7052 M Mise à jour du calendrier de facturation impossible. Essayez de nouveau ou communiquez avec le soutien technique.
7053 M Le calendrier de facturation indiqué est introuvable.
7054 M Chargement du calendrier de facturation impossible. Essayez de nouveau ou communiquez avec le soutien technique.
7055 M Le type d’intervalle de paiement indiqué n’est pas valide.
7056 M Les calendriers de facturation du client sont introuvables.
7057 M Chargement des calendriers de facturation impossible. Essayez de nouveau ou communi-quez avec le soutien technique.
7058 M Le montant facturé doit être supérieur à zéro.
7059 M Mise à jour de l’état du calendrier de facturation impossible. Essayez de nouveau ou commu-niquez avec le soutien technique.
7070 M Exécution de l’opération de recherche impossible. Essayez de nouveau ou communiquez avec le soutien technique.
Tableau B-1: Codes de réponse (suite)
Code de réponse
Action Description
B-16
mai 2019 Codes de réponse
7080 M Mise à jour des enregistrements impossible. Essayez de nouveau ou communiquez avec le soutien technique.
7090 D L’état de client que vous tentez de créer existe déjà.
7091 M Création de l’état de client impossible. Essayez de nouveau ou communiquez avec le soutien technique.
7092 M Mise à jour de l’état de client impossible. Essayez de nouveau ou communiquez avec le sou-tien technique.
7093 M L’état de client indiqué est introuvable.
7094 M Chargement de l’état de client impossible. Essayez de nouveau ou communiquez avec le soutien technique.
7095 M L’entité juridique du marchand est introuvable.
7096 M La récupération de l’entité juridique du marchand est impossible. Essayez de nouveau ou communiquez avec le soutien technique.
7097 D Une erreur interne s’est produite. Le détail de la réponse n’a pu être généré.
7098 M Le numéro de carte de crédit fourni n’est pas valide.
7100 M Le ddstatus que vous tentez de créer pour le paymentMethod existe déjà.
7101 M Création de ddstatus pour le paymentMethod impossible. Essayez de nouveau ou communi-quez avec le soutien technique.
7102 M Mise à jour de ddstatus pour le paymentMethod impossible. Essayez de nouveau ou commu-niquez avec le soutien technique.
7103 M Incapable de trouver le ddstatus spécifié pour le paymentMethod.
7104 M Chargement de ddstatus pour le paymentMethod impossible. Essayez de nouveau ou com-muniquez avec le soutien technique.
7107 M Le profil client a été créé mais nous n’avons pas pu charger le modèle de courriel.
7108 M Le ccstatus que vous tentez de créer pour le paymentMethod existe déjà.
7109 M Création de ccstatus pour le paymentMethod impossible. Essayez de nouveau ou communi-quez avec le soutien technique.
7110 M Mise à jour de ccstatus pour le paymentMethod impossible. Essayez de nouveau ou commu-niquez avec le soutien technique.
7111 M Chargement de ccstatus pour le paymentMethod impossible. Essayez de nouveau ou com-muniquez avec le soutien technique.
7500 Le profileId indiqué dans votre requête est introuvable.
7501 Vous n’avez pas spécifié d’entité juridique mère du marchand dans votre requête.
7502 Nous n’avons pas pu identifier l’entité juridique mère du marchand indiquée dans votre requête.
7503 Le numéro de carte que vous tentez d’ajouter au profil est déjà utilisé par ce profil.
7504 Le numéro de carte que vous tentez d’ajouter au profil est déjà utilisé par un autre profil.
Tableau B-1: Codes de réponse (suite)
Code de réponse
Action Description
Guide de référence de l’API pour les Services Web 1.0 B-17
Codes de réponse mai 2019
7505 Le merchantCustomerId indiqué pour ce profil a déjà été utilisé pour un autre profil.
7511 L’ID d’adresse indiqué dans votre requête est introuvable.
8000 M Exécution de l’opération impossible. Essayez de nouveau ou communiquez avec le soutien technique.
8001 M Votre requête n’est pas valide. Veuillez vérifier vos paramètres et réessayer.
8002 M L’élément consumerInfo est absent de votre requête.
8003 M La valeur de l’élément firstName est absente de votre requête.
8004 M La valeur de l’élément lastName est absente de votre requête.
8005 M L’élément billingAddress/shippingAddress est absent de votre requête.
8006 M Les renseignements billingAddress/shippingAddress sont absents de votre requête. La valeur de l’élément street est absente.
8007 M Les renseignements billingAddress/shippingAddress sont absents de votre requête. La valeur de l’élément city est absente.
8008 M Les renseignements billingAddress/shippingAddress sont absents de votre requête. La valeur de l’élément zip est absente.
8009 M Les renseignements billingAddress/shippingAddress sont absents de votre requête. La valeur de l’élément country est absente.
8010 M Les renseignements billingAddress/shippingAddress sont absents de votre requête. La valeur de l’élément state ou region est absente.
8011 M L’élément contactMethod est absent de votre requête.
8012 M L’élément type doit comprendre un numéro de téléphone résidentiel, un numéro de cellu-laire ou une adresse de courriel.
8013 M L’élément paymentMethod est absent de votre requête.
8014 M La valeur de l’élément enfant id de l’élément billingAddress est absente de votre requête.
8015 M La valeur de l’élément enfant card ou check de l’élément paymentMethod est absente de votre requête.
8016 M L’élément card est absent de votre requête.
8017 M La valeur de l’élément cardNum est absente de votre requête.
8018 M La valeur de l’élément cardType est absente de votre requête.
8019 M L’élément cardExpiry est absent de votre requête.
8020 M La valeur de l’élément month est absente de votre requête.
8021 M La valeur de l’élément year est absente de votre requête.
8022 M L’élément check est absent de votre requête.
8023 M La valeur de l’élément accountNum est absente de votre requête.
8024 M La valeur de l’élément accountType est absente de votre requête.
Tableau B-1: Codes de réponse (suite)
Code de réponse
Action Description
B-18
mai 2019 Codes de réponse
8025 M La valeur de l’élément routingNum est absente de votre requête.
8026 M La valeur de l’élément bankName est absente de votre requête.
8027 M La valeur de l’élément checkNum est absente de votre requête.
8028 M L’élément billingSchedule est absent de votre requête.
8029 M La valeur de l’élément intervalCode est absente de votre requête.
8030 M La valeur de l’élément nextBillingDate est absente de votre requête.
8031 M La valeur de l’élément startDate est absente de votre requête.
8032 M La valeur de l’élément amount est absente de votre requête.
8033 M L’élément merchantAccount est absent de votre requête.
8034 M La valeur de l’élément accountNum est absente de votre requête.
8035 M La valeur de l’élément storeID est absente de votre requête.
8036 M La valeur de l’élément storePwd est absente de votre requête.
8037 M Validation des justificatifs d’identité fournis avec le merchantAccount impossible.
8038 M Une erreur interne s’est produite. Veuillez envoyer de nouveau la requête.
8039 M La valeur de l’élément consumerId est absente de votre requête.
8040 M La valeur de l’élément title est absente de votre requête.
8041 M La valeur de l’élément enfant merchantRefNum de l’élément consumerInfo est absente de votre requête.
8042 M La valeur de l’élément street2 est absente de votre requête.
8043 M L’élément d’ID address de votre requête n’est pas valide. Il ne correspond pas à l’élément consumerId de votre requête.
8044 M L’élément d’ID contactMethod de votre requête n’est pas valide. Il ne correspond pas à l’élé-ment consumerId de votre requête.
8045 M La valeur de l’élément paymentMethodId est absente de votre requête.
8046 M La valeur de l’élément ccHolderName est absente de votre requête.
8047 M La valeur de l’élément enfant merchantRefNum de l’élément paymentMethod est absente de votre requête.
8048 M La valeur de l’élément enfant id de l’élément billingSchedule est absente de votre requête.
8049 M La valeur de l’élément serviceName est absente de votre requête.
8050 M La valeur de l’élément statusCode est absente de votre requête.
8051 M La valeur de l’élément lastDayOfTheMonth est absente de votre requête.
8052 M La valeur de l’élément enfant merchantRefNum de l’élément billingSchedule est absente de votre requête.
8053 M La requête contient deux éléments consumerId qui ne correspondent pas.
Tableau B-1: Codes de réponse (suite)
Code de réponse
Action Description
Guide de référence de l’API pour les Services Web 1.0 B-19
Codes de réponse mai 2019
8054 M Vous avez tenté d’effectuer une opération non prise en charge.
8055 M L’élément endDate de votre requête n’est pas valide.
8056 M L’élément issueNumber de votre requête n’est pas valide.
8057 M L’élément statusCode de votre requête n’est pas valide.
8058 M L’élément intervalCode de votre requête n’est pas valide.
8059 M L’élément title de votre requête n’est pas valide.
8060 M L’élément cardType de votre requête n’est pas valide.
8061 M L’élément accountType de votre requête n’est pas valide.
8062 M L’élément state de votre requête n’est pas valide.
8063 M L’élément country de votre requête n’est pas valide.
8064 M L’élément startDate de votre requête n’est pas valide.
8065 M L’élément endDate de votre requête n’est pas valide.
8066 M L’élément nextBillingDate de votre requête n’est pas valide.
8067 M La date de fin (endDate) ne peut pas être antérieure à la date de début (startDate).
8068 M La date de prochaine facturation (nextBillingDate) ne peut pas être postérieure à la date de fin (endDate).
8069 M La date de prochaine facturation (nextBillingDate) ne peut pas être antérieure à la date de début (startDate).
8070 M L’élément cardExpiry de votre requête n’est pas valide.
8071 M L’élément billingAddressId de paymentMethod n’est pas valide. Il ne correspond pas au con-sumerId indiqué dans la requête ou son type d’adresse est incorrect.
8072 M L’élément shippingAddressId de paymentMethod n’est pas valide. Il ne correspond pas au consumerId indiqué dans la requête ou son type d’adresse est incorrect.
8073 M L’élément type de contactMethod n’est pas valide.
8074 M L’élément id de paymentMethod n’est pas valide. Il ne correspond pas à l’élément consumerId de votre requête.
8075 M L’élément id de billingSchedule n’est pas valide. Il ne correspond pas à l’élément consumerId de votre requête.
8076 M L’élément consumerId de votre requête n’est pas valide. Le client indiqué n’est pas inscrit auprès de ce marchand.
8077 M L’élément paymentMethodId de billingSchedule n’est pas valide. Le mode de paiement indiqué ne fait pas partie de ceux du client.
8078 D Vous avez envoyé un double de cette requête au cours des 24 dernières heures.
8079 D Vous avez envoyé un fichier qui a déjà été traité au cours des 24 dernières heures.
8080 M Le type d’enregistrement de votre requête n’est pas valide. L’élément recurringBillingDetails est absent.
Tableau B-1: Codes de réponse (suite)
Code de réponse
Action Description
B-20
mai 2019 Codes de réponse
8081 D Vous avez envoyé un fichier vide.
8082 M Votre requête n’est pas valide.
8083 M La valeur de l’élément cvv est absente de votre requête.
8084 M L’élément cvv de votre requête n’est pas valide.
8085 M La valeur de l’élément ID de transaction du marchand est absente de votre requête.
8086 M La valeur de l’élément ID de transaction est absente de votre requête.
8087 M L’élément accountNum de votre requête n’est pas valide.
8088 M Le nombre de champs de l’enregistrement envoyé dans votre requête n’est pas valide.
8089 D La taille du fichier envoyé est supérieure à la limite permise.
8090 M L’élément Date de la transaction n’est pas valide.
8091 M L’élément Expiration de l’ID n’est pas valide.
8092 M Le type de transaction indiqué pour l’élément Code de transaction n’est pas pris en charge.
8093 M L’élément billingSchedule n’est pas valide. Votre requête doit comporter l’élément payment-MethodId ou un nouvel élément paymentMethod.
8094 M L’élément paymentMethod n’est pas valide. Votre requête doit comporter l’élément billingAd-dressId ou un nouvel élément billingAddress.
8095 M La taille du fichier envoyé est supérieure à la limite permise de 1000 enregistrements.
8096 M L’élément transactionMode n’est pas valide. Veuillez vérifier ce paramètre et réessayer la transaction.
8100 M La valeur de l’élément aggregateAccountNum est absente de votre requête.
8101 M L’élément aggregateAccountNum n’est pas valide.
8102 M L’élément Version n’est pas valide.
8103 M L’élément storeID n’est pas valide.
8104 M L’élément storePwd n’est pas valide.
8105 M L’élément accountNum n’est pas associé à l’élément aggregateAccountNum.
8106 M L’élément aggregateAccountNum n’est pas valide. Aucuns comptes groupés n’ont été trou-vés.
8107 M La valeur de l’élément intervalValue est absente de votre requête.
8108 M L’élément intervalValue n’est pas valide.
8109 M L’élément intervalValue ne peut être fourni avec l’élément intervalCode défini.
8110 M La valeur de l’élément intervalValue doit se situer entre 1 et 365.
8112 M L’élément merchantAccount n’est pas valide. Le numéro de compte de marchand fourni cor-respond à un compte qui n’est pas configuré en fonction de la facturation récurrente.
8119 M La valeur de l’élément userName est absente de votre requête.
Tableau B-1: Codes de réponse (suite)
Code de réponse
Action Description
Guide de référence de l’API pour les Services Web 1.0 B-21
Codes de réponse mai 2019
8120 M La valeur de l’élément password est absente de votre requête.
8121 M La valeur de l’élément customerIp est absente de votre requête.
8122 M La valeur de l’élément siteUrl est absente de votre requête.
8123 M La valeur de l’élément keyword est absente de votre requête.
8124 M La valeur de l’élément welcomeEmail est absente de votre requête.
8125 M Une erreur interne s’est produite. Le courriel de bienvenue n’a pu être généré.
8126 R Le pays de l’institution financière indiqué dans votre requête n’est pas valide. Veuillez véri-fier votre paramètre et réessayer la transaction.
8127 M La valeur de l’élément enfant ddMandateReference de l’élément billingSchedule est absente de votre requête.
8128 M Vous avez indiqué une référence du mandat non valide. Veuillez vérifier votre paramètre et réessayer la transaction.
8129 M L’élément financingType de votre requête n’est pas valide. Veuillez vérifier ce paramètre et réessayer la transaction.
8130 M L’élément plan de votre requête n’est pas valide. Veuillez vérifier ce paramètre et réessayer la transaction.
8131 M L’élément gracePeriod de votre requête n’est pas valide. Veuillez vérifier ce paramètre et réessayer la transaction.
8132 M L’élément term de votre requête n’est pas valide. Veuillez vérifier ce paramètre et réessayer la transaction.
8133 M L’élément processingType est absent de votre requête.
8134 M L’élément appliedDate est absent de votre requête.
8135 M L’élément echeckId est absent de votre requête.
8136 M La transaction qui correspond à l'enregistrement de facturation récurrente que vous essayez de créer n’a pas pu être localisé, probablement parce que plus d'un achat a été traité sur la carte.
8137 M Votre compte de marchand n’est pas configuré en fonction de la transaction que vous avez tenté d’effectuer.
8138 M L’adresse de courriel indiquée dans votre requête n’est pas valide.
8139 M Le numéro d’acheminement pour BACs (code de tri) doit être de 6 chiffres.
8140 M Le numéro d’acheminement pour ACH doit être de 9 chiffres.
8141 M Le numéro d’acheminement pour EFT (ID de l’institution/numéro de transit) doit être de 8 chiffres.
8142 M Le numéro d’acheminement pour NAB (succursale bancaire de l’État) doit être de 6 chiffres.
8143 M Le numéro d’acheminement pour SEPA (code identificateur de banque) ne devrait pas excéder 11 caractères.
8144 M Le numéro de compte pour BACS doit être de 8 chiffres.
Tableau B-1: Codes de réponse (suite)
Code de réponse
Action Description
B-22
mai 2019 Codes d’action
Codes d’actionLe processeur de transaction donne une action avec chaque code de réponse. Voici le sens des codes d'action :
• C = Erreur de paramètre du client. Les renseignements fournis par le client sont incorrects. Con-firmez les renseignements auprès du client.
• D = Ne pas réessayer.
• M = Erreur de paramètre du marchand. Les renseignements fournis par votre application sont incorrects. Vérifiez vos renseignements.
• R = Réessayer.
Codes de refusCes codes utilisés par le système de chambre de compensation automatisée (CCA) ou de transfert élec-tronique de fonds (TEF) correspondent aux différentes raisons pour lesquelles un chèque ou un paie-ment est refusé. Les codes sont générés par les institutions financières des clients (Receiving Depository Financial Institutions, ou RDFI) pour les effets refusés.
8145 M Le numéro de compte pour ACH ne devrait pas excéder 17 chiffres.
8146 M Le numéro de compte pour EFT ne devrait pas excéder 12 chiffres.
8147 M Le numéro de compte pour NAB (succursale bancaire de l’État) ne devrait pas excéder 9 chif-fres.
8148 M Le numéro de compte pour SEPA (numéro de compte bancaire international) ne devrait pas excéder 34 caractères.
9000 D Votre requête de transaction n’a pu être traitée parce que votre compte de marchand ne comporte aucun compte enfant disponible pour le partage de charge.
9001 D Votre requête de transaction n’a pu être traitée parce que votre compte de marchand ne comporte aucun compte enfant disponible pour l’acheminement par niveau.
9002 D Votre requête de transaction n’a pu être traitée parce que votre compte de marchand ne comporte aucun compte enfant disponible pour l’acheminement permanent.
9003 D Votre requête de transaction n’a pu être traitée parce que votre compte de marchand ne comporte aucun compte enfant disponible pour l’acheminement par le pays du NIB.
9004 D Votre requête de transaction n’a pu être traitée parce que votre compte de marchand ne comporte aucun compte enfant disponible pour l’acheminement par marque.
9005 D Votre requête de transaction n’a pu être traitée parce que votre compte de marchand ne comporte aucun compte enfant disponible pour l’acheminement par mot clé.
Tableau B-2: Codes de refus
Code Description Système bancaire
4 TYPE DE TRANSACTION non valide ou vide. Voir l’Annexe 3 pour une liste des types de transaction CPA.
EFT
5 MONTANT vide ou pas supérieur à zéro. EFT
Tableau B-1: Codes de réponse (suite)
Code de réponse
Action Description
Guide de référence de l’API pour les Services Web 1.0 B-23
Codes de réponse mai 2019
6 DATE D’EXIGIBILITÉ non valide ou vide. EFT
7 INSTITUTION (acheminement ou transit) dans un format erroné, inexistant ou vide. EFT
8 NUMÉRO DE COMPTE non valide pour l’INSTITUTION précisée. EFT
9 NUMÉRO DE SUIVI D’ÉLÉMENT non valide. EFT
10 TYPE DE TRANSACTION STOCKÉ non valide ou vide. EFT
11 NOM ABRÉGÉ DE L’AUTEUR vide. EFT
12 NOM DU PAYEUR/BÉNÉFICIAIRE vide. EFT
13 NOM LONG DE L’AUTEUR vide. EFT
14 Identifiant de l’adhérent direct d’origine non valide ou vide. EFT
15 RENVOI vide. EFT
16 INSTITUTION POUR LES RETOURS (acheminement ou transit) non valide ou vide. La caisse populaire doit être précisée.
EFT
19 Numéro de suivi d’élément d’origine non valide ou vide. EFT
21 IDENTIFIANT D’ÉLÉMENT DE DONNÉES non valide ou vide. EFT
900 Validation rejetée EFT
901 Compte fermé EFT
902 Ne peut pas tracer EFT
903 Paiement gelé/rappelé EFT
904 Post-daté, périmé EFT
905 Compte fermé EFT
906 Compte transféré EFT
907 Aucun privilège de compte de chèques EFT
908 Les fonds n’ont pas été validés EFT
909 Non-concordance de devise/compte EFT
910 Payeur/bénéficiaire décédé EFT
911 Compte gelé EFT
912 Numéro de compte invalide EFT
914 Nom du payeur/bénéficiaire incorrect EFT
915 Refusé par payeur/bénéficiaire EFT
916 Non conforme à l’entente - Personnel EFT
917 Entente révoquée - Personnel EFT
918 Aucune notification préalable - Personnel EFT
Tableau B-2: Codes de refus (suite)
Code Description Système bancaire
B-24
mai 2019 Codes de refus
919 Non conforme à l’entente - Commercial EFT
920 Entente révoquée - Commercial EFT
921 Aucune notification préalable - Commercial EFT
922 Crédit de retour initié par le client seulement EFT
990 Institution en défaut EFT
998 Aucune entente de renvoi EFT
E Accepté avec erreurs prises en note EFT
M Refusé, échec du code d’authentification de message (MAC) EFT
P Partiellement accepté, refus d’au moins une série de transactions EFT
R Refusé EFT
W Refusé, tests de validité de l’assurance échoués EFT
X Refusé, analyse de contenu après déchiffrage impossible EFT
TR Refusé par 824 EFT
YE Code de transaction non autorisé pour le compte d’origine BACS
0 Se reporter au payeur BACS
1 Instruction annulée par le payeur BACS
2 Payeur décédé BACS
3 Compte transféré BACS
4 Préavis contesté BACS
5 Aucun compte BACS
6 Aucune instruction BACS
7 Montant divergent BACS
8 Montant non échu BACS
9 Présentation en souffrance BACS
A Divergence de l’utilisateur du service BACS
B Compte fermé BACS
E Instruction modifiée BACS
AE Code de tri d’origine et/ou numéro de compte non valide(s) (émis par la banque) BACS
BE Code de tri d’origine et/ou numéro de compte non valide(s) (émis par le client) BACS
CE Code de tri de destination et code de tri d’origine et/ou numéro de compte non valide(s) (émis par la banque)
BACS
DE Code de tri de destination et code de tri d’origine et/ou numéro de compte non valide(s) (émis par le client)
BACS
Tableau B-2: Codes de refus (suite)
Code Description Système bancaire
Guide de référence de l’API pour les Services Web 1.0 B-25
Codes de réponse mai 2019
EE Code de tri de destination non valide BACS
FE Type de compte et code de tri d’origine et/ou numéro de compte non valide(s) (émis par la banque)
BACS
GE Type de compte et code de tri d’origine et/ou numéro de compte non valide(s) (émis par le client)
BACS
HE Code de tri de destination et type de compte et code de tri d’origine et/ou numéro de compte non valide (émis par la banque)
BACS
IE Code de tri de destination et type de compte et code de tri d’origine et/ou numéro de compte non valide(s) (émis par le client)
BACS
JE Code de tri de destination et type de compte non valides BACS
KE Type de compte non valide BACS
LE Numéro de compte de destination et nom de compte de destination et autres champs non valides
BACS
ME Numéro de compte de destination et nom de compte de destination non valides BACS
NE « Contra record » modifié BACS
OE Le numéro de référence n’était pas valide BACS
PE Le compte d’origine ne prend pas en charge la devise en fichier BACS
QE Contre-passation automatisée due à une erreur BACS
RE Contre-passation d’un autre élément (même jour) BACS
SE Rappel automatisé BACS
TE Le compte d’origine n’est pas valide et a été substitué avec les détails du compte principal par défaut, mais ce compte ne prend pas en charge la devise du fichier (émis par le client)
BACS
UE La référence du débit direct non payé était erronée (émis par la banque) BACS
XE Numéro de l’utilisateur du service de l’auteur non valide (émis par la banque) BACS
ZE La référence du débit direct non payé et d’autres champs étaient erronés (émis par la banque)
BACS
1I Le montant et/ou la date du débit direct diffère(nt) du préavis. BACS
2I Aucun préavis reçu par le payeur/ou montant cité contesté BACS
3I DDI annulé par la banque domiciliataire BACS
4I Le payeur a annulé le DDI direct avec l’utilisateur du service BACS
5I Utilisateurs du service AUDDIS seulement - Aucune instruction conservée. Contes-tation du payeur ayant le pouvoir
BACS
6I Utilisateurs du service AUDDIS seulement - Signature sur le DDI est frauduleuse ou ne correspond pas avec la/signatures autorisée(s) pour le compte
BACS
7I Réclamation soulevée à la demandes des utilisateurs du service une fois le débit direct appliqué au compte du payeur
BACS
Tableau B-2: Codes de refus (suite)
Code Description Système bancaire
B-26
mai 2019 Codes de refus
8I Nom de l’utilisateur du service contesté. Le payeur ne reconnaît pas l’utilisateur du service qui perçoit le débit direct
BACS
CC Demandé par l’auteur BACS
0C Détails non valides BACS
2C Bénéficiaire décédé BACS
3C Compte transféré BACS
5C Aucun compte BACS
BC Compte fermé BACS
C Compte transféré dans une autre succursale de la banque / organisme d’épargne et de crédit
BACS
D Préavis contesté BACS
F Type de compte non valide BACS
G La banque n’acceptera pas les débits directs sur le compte BACS
H Instruction échue BACS
I La référence du payeur n’est pas unique BACS
K Instruction annulée par la banque domiciliataire BACS
L Détails du compte du payeur erronés BACS
M Code de transaction / Statut de l’utilisateur incompatible BACS
N Transaction refusée à la succursale du payeur BACS
O Référence non valide BACS
P Nom du payeur non présent BACS
Q Nom de l’utilisateur du service vide BACS
R Instruction réintégrée (maximum de 2 mois à compte de la date d’annulation du DDI d’origine)
BACS
AC01 Identifiant de compte erroné SEPA
UPAY Paiement indu SEPA
AC06 Compte bloqué SEPA
AC13 Type de compte du débiteur non valide SEPA
AG01 Débit direct non autorisé SEPA
AG02 Code d’opération de banque non valide SEPA
AGNT Agent erroné SEPA
AM04 Fonds insuffisants SEPA
AM05 Duplication SEPA
Tableau B-2: Codes de refus (suite)
Code Description Système bancaire
Guide de référence de l’API pour les Services Web 1.0 B-27
Codes de réponse mai 2019
BE04 Adresse du créditeur manquante SEPA
BE05 Créditeur non reconnu SEPA
CURR Devise erronée SEPA
CUST Rappel par le client SEPA
CUTA Rappel en raison d’une demande d’enquête SEPA
DT01 Date non valide SEPA
DUPL Paiement en double SEPA
ED05 Règlement échoué SEPA
FF01 Format de fichier non valide SEPA
FF05 Type de débit direct incorrect SEPA
FRAD Fraude SEPA
MD01 Mandat non valide SEPA
MD02 Données du mandat manquantes ou erronées SEPA
MD06 Transaction autorisée contestée SEPA
MD07 Débiteur décédé SEPA
MS02 Refus du débiteur SEPA
MS03 Raison non précisée SEPA
PY01 Non acheminable SEPA
RC01 Identifiant de banque erroné SEPA
RR01 Compte ou identifiant du débiteur manquant SEPA
RR02 Nom ou adresse du débiteur manquant SEPA
RR03 Nom ou adresse du créditeur manquant SEPA
RR04 Disposition réglementaire SEPA
SL01 Service précis offert par l’agent du débiteur SEPA
TECH Erreur de paiement en raison d’un problème technique SEPA
TM01 Heure limite non valide SEPA
AC04 Compte fermé SEPA
RT non trouvé ACH
CONFIG Problème de configuration du client ACH
LIMIT Le montant maximum par chèque a été dépassé. ACH
INVACCT Type de compte non valide ACH
INVDIR Direction non valide ACH
Tableau B-2: Codes de refus (suite)
Code Description Système bancaire
B-28
mai 2019 Codes de refus
NOPOP Marchand non configuré ou non autorisé à exécuter des transactions POP - Conver-sion de chèque électronique.
ACH
PAPER Document papier impossible à envoyer. ACH
PARSE Problème de parsage ACH
THOMSON Refus en raison de la base de données Thomson ACH
UNKMER Marchand inconnu ACH
DEMO Démonstration de la transaction ou du marchand. ACH
R90 Chiffre MOD non valide ACH
R91 ABA non valide. Pas neuf (9) caractères ou numérique ACH
R92 ABA non actif ACH
R93 Combo Tran Code SEC non valide ACH
R94 Montant non valide de pré-note Tran Code ACH
R95 Montant à zéro (0) ACH
R96 Tran Code non valide ACH
R97 Code SEC non valide ACH
R98 Erreur de déchiffrage de compte ACH
R99 Correspondance OFAC possible ACH
R37 Document source présenté pour paiement ACH
R38 Arrêt de paiement au document source ACH
R39 Document source incorrect ACH
R53 Élément et saisie ACH présentés pour paiement ACH
R75 Retour d’origine non en double ACH
R76 Aucune erreur trouvée ACH
R83 Institution réceptrice étrangère DFI impossible à régler ACH
R84 Saisie non traitée par OGO ACH
R01 Fonds insuffisants ACH
R02 Compte fermé ACH
R03 Aucun compte/incapable de trouver ACH
R04 Numéro de compte invalide ACH
R05 Réservé ACH
R06 Retour demandé par ODFI ACH
R07 Autorisation révoquée note 2 ACH
Tableau B-2: Codes de refus (suite)
Code Description Système bancaire
Guide de référence de l’API pour les Services Web 1.0 B-29
Codes de réponse mai 2019
R08 Arrêter le paiement ACH
R09 Fonds non perçus ACH
R10 Pas autorisé note 2 ACH
R11 Vérifier le renvoi pour entrée tronquée ACH
R12 Succursale vendue à une autre DFI ACH
R13 La RDFI n’est pas admissible à la participation/ou itinéraire non valide ACH
R14 Bénéficiaire décédé ACH
R15 Bénéficiaire décédé ACH
R16 Compte gelé ACH
R17 Critères de modification du fichier ACH
R18 Date d’entrée en vigueur inadéquate ACH
R19 Erreur dans le champ du montant ACH
R20 Compte sans transaction ACH
R21 Identification invalide de la compagnie ACH
R22 Numéro d’identification personnelle invalide ACH
R23 Le crédit saisi est refusé par le récepteur ACH
R24 Entrée dédoublée ACH
R25 Erreur d’addenda ACH
R26 Erreur dans un champ obligatoire ACH
R27 Erreur avec le numéro de suivi ACH
R28 Erreur de chiffre dans le no. de vérif. de l’acheminement ACH
R29 Le conseiller aux clients n’est pas autorisé ACH
R30 Problème de RDFI, non-troncage ACH
R31 Renvoi permis ACH
R32 RDFI sans règlement ACH
R33 Renvoi de XCK ACH
R34 Participation limitée de la banque dépositaire DFI ACH
R35 Renvoi de l’entrée de débit inadéquat ACH
R36 Renvoi de l’entrée de crédit inadéquat ACH
R40 Retour de la saisie ENR par le gouv. fédéral. ACH
R41 Code de transaction non valide ACH
R42 Erreur de numéro d’acheminement/numéro de chèque ACH
Tableau B-2: Codes de refus (suite)
Code Description Système bancaire
B-30
mai 2019 Codes de refus
* Un effet compensé peut être retourné comme « Non autorisé », « Autorisé » ou « Autorisation révoquée » jusqu'à 60 jours suivant la date de présentation.
R43 Non valide Numéro de compte DFI ACH
R44 Non valide Numéro ED individuel ACH
R45 Nom de la personne / de l’entreprise non valide ACH
R46 Indicateur du représentant du bénéficiaire non valide ACH
R47 Enregistrement en double ACH
R50 Loi provinciale touchant l’acceptation RCK ACH
R51 L’élément est illisible (RCK) ACH
R52 Gelé paiement pour le l’élément (RCK) ACH
R61 Défaut d’acceptation ACH
R62 Défaut d’acceptation ACH
R63 Défaut d’acceptation ACH
R64 Défaut d’acceptation ACH
R65 Défaut d’acceptation ACH
R66 Défaut d’acceptation ACH
R67 Défaut d’acceptation ACH
R68 Défaut d’acceptation ACH
R69 Défaut d’acceptation ACH
R70 Défaut d’acceptation ACH
R71 Note contestée 4 ACH
R72 Note contestée 4 ACH
R73 Note contestée 4 ACH
R74 Note contestée 4 ACH
R80 Erreur de codage du paiement transfrontalier ACH
R81 Non participant au programme transfrontalier ACH
R82 Identifiant de RDFI étranger ACH
Tableau B-2: Codes de refus (suite)
Code Description Système bancaire
Guide de référence de l’API pour les Services Web 1.0 B-31
Codes de réponse mai 2019
B-32
APPENDIX C
Codes géographiques
Codes de province Tableau C-1: Codes de province
Province Code
Alberta AB
Colombie-Britannique BC
Île-du-Prince-Édouard PE
Manitoba MB
Nouveau-Brunswick NB
Nouvelle-Écosse NS
Nunavut NU
Ontario ON
Québec QC
Saskatchewan SK
Terre-Neuve-et-Labrador NL
Territoires du Nord-Ouest NT
Yukon YT
Guide de référence de l’API pour les Services Web 1.0 C-1
Codes géographiques février 2018
Codes d’étatTableau C-2: Codes d’état
État Code État Code
Alabama AL Alaska AK
Arizona AZ Arkansas AR
Californie CA Colorado CO
Caroline du Sud SC Dakota du Sud SD
Connecticut CT Delaware DE
Dakota du Nord ND Ohio OH
District fédéral de Columbia DC Floride FL
Forces armées – Europe AE Forces armées – Pacifique AP
Géorgie GA Hawaii HI
Guam GU Samoa américaine AS
Idaho ID Illinois IL
Îles Vierges américaines VI Mariannes du Nord MP
Indiana IN Iowa IA
International IT Puerto Rico PR
Kansas KS Kentucky KY
Louisiane LA Maine ME
Maryland MD Massachusetts MA
Michigan MI Minnesota MN
Mississippi MS Missouri MO
Montana MT Nebraska NE
Nevada NV New Hampshire NH
New Jersey NJ Nouveau-Mexique NM
New York NY Caroline du Nord NC
Oklahoma OK Oregon OR
Palau PW Forces armées – Amériques AA
Pennsylvanie PA Rhode Island RI
Tennessee TN Texas TX
Utah UT Vermont VT
Virginie VA Washington WA
Virginie-Occidentale WV Wisconsin WI
C-2
février 2018 Codes de pays
e
Codes de pays
Wyoming WY États-Unis US
Tableau C-3: Codes de pays
Pays Code Pays Cod
Afghanistan AF Brunei Darussalam BN
Afrique du Sud ZA Bulgarie BG
Albanie AL Burkina Faso BF
Algérie DZ Burundi BI
Allemagne DE Cambodge KH
Andorre AD Cameroun CM
Angola AO Canada CA
Anguilla AI Cap-Vert CV
Antarctique AQ Chili CL
Antigua-et-Barbuda AG Chine CN
Arabie saoudite SA Chypre CY
Argentine AR Colombie CO
Arménie AM Comores KM
Aruba AW Congo CG
Australie AU Congo, République démocratique du CD
Autriche AT Corée, République de KR
Azerbaïdjan AZ Corée, République populaire démocratique de KP
Bahamas BS Costa Rica CR
Bahreïn BH Côte d’Ivoire CI
Bangladesh BD Croatie HR
Barbade BB Cuba CU
Bélarus BY Curaçao CW
Belgique BE Danemark DK
Belize BZ Djibouti DJ
Bénin BJ Dominique DM
Bermudes BM Égypte EG
Tableau C-2: Codes d’état (suite)
État Code État Code
Guide de référence de l’API pour les Services Web 1.0 C-3
Codes géographiques février 2018
e
Bhoutan BT El Salvador SV
Bolivie BO Émirats arabes unis AE
Bonaire, Sint Eustatius et Saba BQ Équateur EC
Bosnie-Herzégovine BA Érythrée ER
Botswana BW Espagne ES
Brésil BR Estonie EE
État de la Cité du Vatican (Saint-Siège) VA Îles Caïmans KY
États-Unis US Îles Cocos (Keeling) CC
Éthiopie ET Îles Cook CK
Fédération de Russie RU Îles d'Åland AX
Fidji FJ Îles Féroé FO
Finlande FI Îles Heard et McDonald HM
France FR Îles Malouines FK
Gabon GA Îles Marshall MH
Gambie GM Îles Salomon SB
Géorgie GE Îles Turks et Caicos TC
Géorgie du Sud et les îles Sandwich du Sud GS Îles Vierges américaines VI
Ghana GH Îles Vierges britanniques VG
Gibraltar GI Îles Wallis-et-Futuna WF
Grèce GR Inde IN
Grenade GD Indonésie ID
Groenland GL Iran (République islamique d') IR
Guadeloupe GP Iraq IQ
Guam GU Irlande IE
Guatemala GT Islande IS
Guernesey GG Israël IL
Guinée GN Italie IT
Guinée équatoriale GQ Jamahiriya arabe libyenne LY
Guinée-Bissau GW Jamaïque JM
Guyana GY Japon JP
Guyane française GF Jersey JE
Haïti HT Jordanie JO
Tableau C-3: Codes de pays (suite)
Pays Code Pays Cod
C-4
février 2018 Codes de pays
e
Honduras HN Kazakhstan KZ
Hong Kong HK Kenya KE
Hongrie HU Kirghizistan KG
Île Bouvet BV Kiribati KI
Île Christmas CX Koweït KW
Île de Man IM Lesotho LS
Île Norfolk NF Lettonie LV
Lettonie LV Nigeria NG
Liban LB Niue NU
Libéria LR Norvège NO
Liechtenstein LI Nouvelle-Calédonie NC
Lituanie LT Nouvelle-Zélande NZ
Luxembourg LU Oman OM
Macao MO Ouganda UG
Macédoine MK Ouzbékistan UZ
Madagascar MG Pakistan PK
Malaisie MY Palau PW
Malawi MW Panama PA
Maldives MV Papouasie-Nouvelle-Guinée PG
Mali ML Paraguay PY
Malte MT Pays-Bas NL
Mariannes du Nord MP Pérou PE
Maroc MA Petites îles excentriques des États-Unis UM
Martinique MQ Philippines PH
Maurice MU Pitcairn PN
Mauritanie MR Pologne PL
Mayotte YT Polynésie française PF
Mexique MX Portugal PT
Micronésie, États fédérés de FM Puerto Rico PR
Moldova, République de MD Qatar QA
Monaco MC République arabe syrienne SY
Mongolie MN République centrafricaine CF
Tableau C-3: Codes de pays (suite)
Pays Code Pays Cod
Guide de référence de l’API pour les Services Web 1.0 C-5
Codes géographiques février 2018
e
Monténégro ME République démocratique populaire du Laos LA
Montserrat MS République dominicaine DO
Mozambique MZ République tchèque CZ
Myanmar MM République-Unie de Tanzanie TZ
Namibie NA Réunion RE
Nauru NR Roumanie RO
Népal NP Royaume-Uni GB
Nicaragua NI Rwanda RW
Niger NE Sahara-Occidental EH
Saint Martin MF Thaïlande TH
Saint-Barthélemy BL Timor-Leste TL
Saint-Kitts-et-Nevis KN Togo TG
Saint-Marin SM Tokelau TK
Saint-Pierre et Miquelon PM Tonga TO
Saint-Vincent-et-les-Grenadines VC Trinité-et-Tobago TT
Sainte-Hélène SH Tunisie TN
Sainte-Lucie LC Turkménistan TM
Samoa WS Turquie TR
Samoa américaine AS Tuvalu TV
Sao Tomé-et-Principe ST Ukraine UA
Sénégal SN Uruguay UY
Serbie RS Vanuatu VU
Seychelles SC Venezuela VE
Sierra Leone SL Vietnam VN
Singapour SG Yémen YE
Sint Maarten SX Zambie ZM
Slovaquie (République slovaque) SK Zimbabwe ZW
Slovénie SI
Somalie SO
Soudan SD
Soudan du Sud SS
Sri Lanka LK
Tableau C-3: Codes de pays (suite)
Pays Code Pays Cod
C-6
février 2018 Codes de pays
e
Suède SE
Suisse CH
Suriname SR
Svalbard et île de Jan Mayen SJ
Swaziland SZ
Tadjikistan TJ
Taïwan TW
Tchad TD
Terres australes françaises TF
Territoire britannique de l'océan Indien IO
Territoires palestiniens PS
Tableau C-3: Codes de pays (suite)
Pays Code Pays Cod
Guide de référence de l’API pour les Services Web 1.0 C-7
Codes géographiques février 2018
C-8