Mode d'emploi | PayPal NVP API 2008 Manuel utilisateur

Guide de
développement et
référence de l'API
Paire Nom-Valeur
(NVP)
Dernière mise à jour : Janvier 2008
Guide de développement et référence de l’API NVP PayPal
Référence : 100018.fr_FR-200801
© 2008 PayPal, Inc. Tous droits réservés. PayPal est une marque déposée de PayPal, Inc. Le logo PayPal est une marque de PayPal, Inc. Les autres
marques et marques commerciales déposées appartiennent à leurs propriétaires respectifs.
Les informations contenues dans ce document sont la propriété de PayPal, Inc. et ne peuvent être utilisées, reproduites ni diffusées sans l'autorisation
écrite de PayPal, Inc.
PayPal Europe S.à.r.l. & Cie, S.C.A. est soumise par la Commission de Surveillance du Secteur Financier du Luxembourg à la réglementation des
établissements bancaires. Numéro d'enregistrement de PayPal au RCS : 118349
Avis de non responsabilité :
PayPal, Inc. fournit les informations de ce manuel en l'état. PayPal, Inc. ne fournit de quelque manière que ce soit (expresse, tacite ou légale) aucune
garantie résultant de ces informations. PayPal, Inc. n'assume aucune responsabilité en cas d'erreurs ou d'omissions pour tous dommages (directs ou
indirects), résultant de l'utilisation de ce manuel ou des informations qu'il contient ou résultant de l'application ou de l'utilisation du produit ou du
service décrit dans ce document. PayPal, Inc. se réserve le droit de modifier les informations de ce manuel sans préavis.
Table des matières
Préface
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
A propos de ce document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Public ciblé . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Historique des révisions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Chapitre 1
Présentation . . . . . . . . . . . . . . . . . . . . . . . . . 11
Présentation de l'API NVP PayPal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Intégrer votre application avec l'API PayPal . . . . . . . . . . . . . . . . . . . . . . . 11
Etapes de base . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Créer une application Web . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Obtenir des informations d'authentification API . . . . . . . . . . . . . . . . . . . . . 12
Créer et envoyer la requête . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Interpréter la réponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Transférer votre application dans l'environnement de production de PayPal . . . . . . . . 13
Créer un compte Business PayPal . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Créer des informations d'authentification API . . . . . . . . . . . . . . . . . . . . . . 14
Modifier votre code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Détails techniques . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Modèle de requête-réponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Format de la requête. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Format de la réponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Envois utilisant HTTPS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Chapitre 2
Accepter PayPal dans la fonction Paiement express . . . . 21
Procédure de paiement de base via PayPal . . . . . . . . . . . . . . . . . . . . . . . . . 21
1. Initialiser le paiement à l'aide de SetExpressCheckout . . . . . . . . . . . . . . . . 22
2. Rediriger le navigateur du client vers la page de connexion à PayPal . . . . . . . . 22
3. Récupérer les informations du client à l'aide de GetExpressCheckoutDetails . . . . 23
4. Effectuer une vente à l'aide de DoExpressCheckoutPayment . . . . . . . . . . . . 23
Vérifier l'adresse de livraison à l'aide de SetExpressCheckout . . . . . . . . . . . . . . . 24
Exiger une adresse confirmée . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Supprimer l'affichage de l'adresse de livraison sur PayPal . . . . . . . . . . . . . . . 24
Ignorer l'adresse de livraison enregistrée auprès de PayPal . . . . . . . . . . . . . . 25
Guide de développement et référence de l’API NVP
Janvier 2008
3
Table des matières
Changer la langue de la page de connexion à PayPal . . . . . . . . . . . . . . . . . . . 26
Modifier le Logo des pages PayPal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Choix d'un style de page de paiement personnalisé. . . . . . . . . . . . . . . . . . . 26
Personnaliser le logo et les couleurs individuellement . . . . . . . . . . . . . . . . . 27
Remplir le formulaire de votre page de vérification de paiement . . . . . . . . . . . . . . 27
Effectuer une vente à l'aide de DoExpressCheckoutPayment . . . . . . . . . . . . . . . . 28
Autoriser une collecte unique . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Autoriser les collectes multiples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Changer l'URL de la Notification instantanée de paiement (IPN) . . . . . . . . . . . . . . 30
Inclure le détail des objets à l'aide de DoExpressCheckoutPayment . . . . . . . . . . . . 30
Inclure les sous-totaux à l'aide de DoExpressCheckoutPayment . . . . . . . . . . . . . . 31
Mettre à jour les détails de la transaction avec DoExpressCheckoutPayment . . . . . . . 32
Mettre à jour l'adresse de livraison avec DoExpressCheckoutPayment . . . . . . . . . . . 33
Paiement express PayPal pour les enchères eBay . . . . . . . . . . . . . . . . . . . . . 33
Chapitre 3
API Paiements récurrents . . . . . . . . . . . . . . . . . . 35
Chapitre 4
Fonctions de gestion . . . . . . . . . . . . . . . . . . . . 37
Collecter, Autoriser, Annuler et Demander une nouvelle autorisation . . . . . . . . . . . . 37
Effectuer une collecte unique avec DoCapture . . . . . . . . . . . . . . . . . . . . . . . 37
Effectuer plusieurs collectes partielles avec DoCapture . . . . . . . . . . . . . . . . . . . 38
Insérer un numéro de facture et une remarque lors de la collecte à l'aide de DoCapture . . 39
Effectuer un remboursement à l'aide de RefundTransaction . . . . . . . . . . . . . . . . 39
Remboursement intégral. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Remboursements partiels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Insérer une remarque lors du remboursement . . . . . . . . . . . . . . . . . . . . . 40
Rechercher une transaction à l'aide de TransactionSearch . . . . . . . . . . . . . . . . . 40
Visualiser les détails d'une seule transaction à l'aide de GetTransactionDetails . . . . . . 41
Annexe A
Liste de référence des méthodes et des champs de l'API NVP 43
Caractéristiques générales des requêtes et des paramètres . . . . . . . . . . . . . . . . 43
Paramètres . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Champs multi-valeurs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Devises acceptées par PayPal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Paiement express PayPal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Requête SetExpressCheckout. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Réponse SetExpressCheckout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
4
Janvier 2008
Guide de développement et référence de l’API NVP
Table des matières
Requête GetExpressCheckoutDetails . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Réponse GetExpressCheckoutDetails. . . . . . . . . . . . . . . . . . . . . . . . . . 51
Requête DoExpressCheckoutPayment . . . . . . . . . . . . . . . . . . . . . . . . . 52
Réponse DoExpressCheckoutPayment . . . . . . . . . . . . . . . . . . . . . . . . . 57
Autorisation et collecte . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
DoAuthorization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
DoCapture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
DoReauthorization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
DoVoid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
RefundTransaction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
TransactionSearch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
GetTransactionDetails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Paiement groupé . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Requête MassPay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Réponse MassPay. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Paiements récurrents et transactions de référence . . . . . . . . . . . . . . . . . . . . . 79
CreateRecurringPaymentsProfile . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
GetRecurringPaymentsProfileDetails . . . . . . . . . . . . . . . . . . . . . . . . . . 87
ManageRecurringPaymentsProfileStatus . . . . . . . . . . . . . . . . . . . . . . . . 91
BillOutstandingAmount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
UpdateRecurringPaymentsProfile . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
SetCustomerBillingAgreement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
GetBillingAgreementCustomerDetails . . . . . . . . . . . . . . . . . . . . . . . . . .100
DoReferenceTransaction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .102
Annexe B
Liste de référence des messages d'erreur . . . . . . . . 113
Format des réponses d'erreur . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
Erreurs de validation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
Erreurs d'API générales . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Erreurs de l'API Paiement express PayPal . . . . . . . . . . . . . . . . . . . . . . . . . 118
Messages d'erreur de l'API Autorisation et collecte . . . . . . . . . . . . . . . . . . . . .135
Erreurs de l'API RefundTransaction . . . . . . . . . . . . . . . . . . . . . . . . . . . . .139
Erreurs de l'API TransactionSearch . . . . . . . . . . . . . . . . . . . . . . . . . . . . .143
Erreurs de l'API GetTransactionDetails . . . . . . . . . . . . . . . . . . . . . . . . . . .144
Erreurs de l'API MassPay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .145
Erreurs d'API des paiements récurrents et des transactions de référence . . . . . . . . .150
Erreurs de paiements récurrents . . . . . . . . . . . . . . . . . . . . . . . . . . . .150
Erreurs de SetCustomerBillingAgreement . . . . . . . . . . . . . . . . . . . . . . . .157
Guide de développement et référence de l’API NVP
Janvier 2008
5
Table des matières
Erreurs de GetBillingAgreementCustomerDetails . . . . . . . . . . . . . . . . . . . .159
Erreurs de DoReferenceTransaction . . . . . . . . . . . . . . . . . . . . . . . . . .159
Annexe C
Exemples Web de l'API NVP . . . . . . . . . . . . . . . . 167
Descriptions des exemples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .167
Accepter PayPal dans la fonction Paiement express . . . . . . . . . . . . . . . . . .167
Recueillir les détails de la transaction . . . . . . . . . . . . . . . . . . . . . . . . . .169
Fichiers communs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .170
Exemple d'utilisateur API avec signature API . . . . . . . . . . . . . . . . . . . . . . . .171
Exemples utilisant ASP classique . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .171
Logiciel requis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .171
Télécharger et décompresser les exemples . . . . . . . . . . . . . . . . . . . . . . .171
Installer les exemples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .171
Exécuter les exemples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .172
Exemples utilisant PHP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .172
Logiciel requis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .172
Télécharger et décompresser les exemples . . . . . . . . . . . . . . . . . . . . . . .172
Installer les exemples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .172
Exécuter les exemples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .172
Exemples utilisant ColdFusion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .173
Logiciel requis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .173
Télécharger et décompresser les exemples . . . . . . . . . . . . . . . . . . . . . . .173
Installer les exemples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .173
Exécuter les exemples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .173
Annexe D
Kit de développement PayPal Java . . . . . . . . . . . . 175
Installation du kit de développement PayPal Java . . . . . . . . . . . . . . . . . . . . . .175
Normes prises en charge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .175
Configuration matérielle recommandée . . . . . . . . . . . . . . . . . . . . . . . . .175
Télécharger et décompresser le kit de développement PayPal . . . . . . . . . . . . .176
Configuration post-installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .176
Documentation complète du kit de développement PayPal et des classes d'API . . . . . .177
Journaux du kit de développement PayPal . . . . . . . . . . . . . . . . . . . . . . .177
Préférences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .178
Aperçu des classes liées aux préférences. . . . . . . . . . . . . . . . . . . . . . . .179
Exemples d'applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .180
Exemple d'utilisateur API avec signature API . . . . . . . . . . . . . . . . . . . . . .181
Exemple d'utilisateur API avec certificat d'API. . . . . . . . . . . . . . . . . . . . . .181
6
Janvier 2008
Guide de développement et référence de l’API NVP
Table des matières
Annexe E
Kit de développement PayPal ASP.NET . . . . . . . . . . 183
Installation du kit de développement PayPal ASP.NET . . . . . . . . . . . . . . . . . . .183
Normes prises en charge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .183
Télécharger et installer le kit de développement PayPal . . . . . . . . . . . . . . . .184
Configuration post-installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .184
Configurations personnalisées facultatives de Web.config . . . . . . . . . . . . . . .185
Journaux du kit de développement PayPal . . . . . . . . . . . . . . . . . . . . . . .186
Activer la prise en charge des procurations . . . . . . . . . . . . . . . . . . . . . . .187
Désinstaller le kit de développement PayPal . . . . . . . . . . . . . . . . . . . . . .187
Documentation complète du kit de développement PayPal et des classes d'API . . . . . .187
Préférences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .188
Aperçu des classes liées aux préférences. . . . . . . . . . . . . . . . . . . . . . . .188
Exemples d'applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .190
Exemple d'utilisateur API avec signature API . . . . . . . . . . . . . . . . . . . . . . . .190
Exemple d'utilisateur API avec certificat d'API . . . . . . . . . . . . . . . . . . . . . . . .191
Installer les exemples sur Microsoft IIS . . . . . . . . . . . . . . . . . . . . . . . . . . .191
Exécuter les exemples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .192
Annexe F
Kit de développement PayPal Ruby on Rails . . . . . . . 193
Installation du kit de développement PayPal Ruby on Rails . . . . . . . . . . . . . . . . .193
Normes prises en charge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .193
Configuration matérielle recommandée . . . . . . . . . . . . . . . . . . . . . . . . .194
Installation du kit de développement PayPal . . . . . . . . . . . . . . . . . . . . . .194
Exemples d'applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .194
Prise en charge d'un serveur proxy . . . . . . . . . . . . . . . . . . . . . . . . . . . . .195
Annexe G
Codes pays . . . . . . . . . . . . . . . . . . . . . . . . 197
Guide de développement et référence de l’API NVP
Janvier 2008
7
Table des matières
8
Janvier 2008
Guide de développement et référence de l’API NVP
Préface
A propos de ce document
Le Guide de développement et référence de l’API NVP décrit l'API Paire Nom-Valeur de
PayPal.
Public ciblé
Le Guide de développement et référence de l’API NVP s'adresse aux développeurs de sites
mettant en œuvre des solutions utilisant l'API Paire Nom-Valeur.
Historique des révisions
Historique des révisions du Guide de développement et référence de l’API NVP.
TABLEAU P.1 Historique des révisions
Date
Janvier 2008
Description
z
z
z
z
Septembre 2007
z
z
Ajout de champs d'autorisation de facturation à SetExpressCheckout pour les
paiements récurrents;
Mise à jour de CreateRecurringPaymentsProfile avec de nouvelles fonctions
de paiements récurrents;
Ajout de nouvelles API pour les paiements récurrents;
Ajout de l'API DoNonReferencedCredit.
Mise à jour des enchères eBay dans la section Paiement express;
Ajout de champs destinés au mode de paiement giropay dans les API de
Paiement express.
Août 2007
Ajout de certains concepts liés aux paiements récurrents, modification de
SetExpressCheckout, de DoExpressCheckoutPayment et de
DoReferenceTransaction, et ajout de codes d'erreur pour
DoReferenceTransaction.
Avril 2007
Ajout d'API pour les paiements récurrents :
SetCustomerBillingAgreement,
GetBillingAgreementCustomerDetails et
CreateRecurringPaymentsProfile.
Guide de développement et référence de l’API NVP
Janvier 2008
9
Historique des révisions
TABLEAU P.1 Historique des révisions
10
Date
Description
Février 2007
Correction de problèmes comprenant la mise à jour des détails des objets pour
l’API de Paiement express, avec l'ajout de SHIPTOCOUNTRYCODE.
Décembre 2006
Mises à jour des corrections de problèmes.
Octobre 2006
Première version publique.
Janvier 2008
Guide de développement et référence de l’API NVP
1
Présentation
Ce chapitre présente l'API Paire Nom-Valeur (NVP) PayPal. Il se compose des sections
suivantes :
z
Présentation de l'API NVP PayPal
z
Etapes de base
z
Transférer votre application dans l'environnement de production de PayPal
z
Détails techniques
Présentation de l'API NVP PayPal
L'API NVP PayPal est une interface de programmation simple qui vous permet à vous, le
marchand, d'accéder aux fonctionnalités commerciales de PayPal permettant de :
z
Accepter PayPal comme option de paiement sur votre site par le biais de la fonction
Paiement express;
z
Collecter les paiements précédemment autorisés via Paiement express ou Paiements sur
site marchand;
z
Autoriser à nouveau ou annuler des autorisations antérieures;
z
Payer un ou plusieurs destinataires en utilisant le paiement groupé;
z
Effectuer des remboursements intégraux ou plusieurs remboursement partiels;
z
Rechercher des transactions en utilisant la date à laquelle elles ont débuté ou tout autre
critère;
z
Connaître les détails d'une transaction spécifique.
Il est facile d’intégrer PayPal à votre application Web grâce à L'API NVP PayPal. Il vous suffit
de construire une chaîne NVP et de l'envoyer au serveur PayPal en utilisant le protocole
HTTPS. PayPal vous envoie une réponse au format NVP.
Intégrer votre application avec l'API PayPal
Vous pouvez utiliser l'API NVP PayPal par l'une ou l'autre des deux approches suivantes :
Intégrer directement
L'intégration avec l'API NVP PayPal peut se faire directement par l'intermédiaire du langage
de programmation de votre choix. Cette approche est la plus directe et la plus flexible. Des
exemples téléchargeables vous montrent comment intégrer directement en utilisant ASP
classique, PHP et ColdFusion.
Guide de développement et référence de l’API NVP
Janvier 2008
11
Présentation
Etapes de base
Pour en savoir plus, consultez l’Annexe C, « Exemples Web de l'API NVP ».
Intégrer à l'aide d'un kit de développement PayPal (SDK)
L'intégration avec l'API NVP peut se faire en utilisant un kit de développement PayPal (SDK).
Les kits de développement sont fournis pour Java et ASP.NET. Ils décrivent des fonctions
simples qui facilitent l'intégration avec l'API NVP.
Pour obtenir plus de détails au sujet du kit de développement PayPal, consultez l'Annexe D,
« Kit de développement PayPal Java » ou l'Annexe E, « Kit de développement PayPal
ASP.NET ».
Exemples
Pour vous aider à utiliser l'API NVP PayPal, des exemples sont fournis à l'adresse
http:/www.paypal.fr/fr_FR/html/Espace-Integration-PayPal/ic_nvp.html. Grâce ces exemples, vous
pouvez envoyer des appels d’API à l'Environnement de test de PayPal.
Etapes de base
Cette section décrit les étapes de base de la programmation avec l'API NVP PayPal.
Lors du développement d'une application, cette dernière communique avec l'Environnement
de test de PayPal. Dans la section suivante, « Transférer votre application dans
l'environnement de production de PayPal » page 13, nous expliquons comment transférer
votre application de l'Environnement de test à l'environnement réel de PayPal.
R E M A R Q U E : La
meilleure façon de démarrer consiste à télécharger et à tester les exemples
d'applications comme indiqué au paragraphe « Intégrer votre application avec
l'API PayPal » page 11.
Créer une application Web
Votre intégration API NVP s'exécute habituellement dans une application Web. Vous pouvez soit
concevoir votre propre application, soit utiliser un des exemples comme point de départ.
Obtenir des informations d'authentification API
Pour accéder à l'API PayPal, il est nécessaire de détenir des informations d'authentification
API qui permettent de vous identifier, que ce soit une signature API ou un certificat d'API.
Utilisez l'exemple de signature et de mot de passe API ci-après dans vos échantillons de
programmes s'exécutant dans l'Environnement de test PayPal.
R E M A R Q U E : Si vous vous servez des exemples, cette signature est déjà présente dans le code.
12
Janvier 2008
Guide de développement et référence de l’API NVP
Présentation
Transférer votre application dans l'environnement de production de PayPal
TABLEAU 1.1 Détails de l'exemple de signature API
Identifiant API
sdk-three_api1.sdk.com
Mot de passe API
QFZCWN5HZM8VBG7Q
Signature API
A-IzJhZZjhg29XQ2qnhapuwxIDzyAZQ92FRP5dqBzVesOkzbdUONzmOU
Créer et envoyer la requête
Créez une chaîne de requête NVP et envoyez-la dans l'Environnement de test PayPal. Ajoutez
du code à votre application Web pour pouvoir effectuer les tâches suivantes :
1. Codez au format URL les paramètres noms et valeurs dans la requête pour que tous les
caractères soient transmis correctement. Cette action est décrite au paragraphe « Codage au
format URL » page 15
2. Construisez la chaîne de requête API NVP en vous aidant des conseils de la section
« Format de la requête » page 16. Le format NVP est décrit à « Format NVP » page 15.
3. Envoyez ensuite la requête NVP à l'Environnement de test PayPal comme indiqué à la
section « Envois utilisant HTTPS » page 19.
Interpréter la réponse
PayPal traite votre requête et vous envoie une réponse au format NVP. Ajoutez du code à votre
application Web pour pouvoir effectuer les tâches suivantes :
1. Recevoir la réponse HTTP et procéder à l'extraction de la chaîne NVP;
2. Décoder les valeurs des paramètres du format URL en vous aidant des conseils de la
section « Codage au format URL » page 15;
3. Prendre les mesures appropriées selon que les réponses contiennent un message de réussite
ou d'échec.
Transférer votre application dans l'environnement
de production de PayPal
Une fois le codage de votre application et les tests terminés, déployez votre application dans le
serveur de l'environnement de production de PayPal par le biais de votre compte Business
PayPal et grâce aux informations d'authentification de ce compte.
Guide de développement et référence de l’API NVP
Janvier 2008
13
Présentation
Détails techniques
Créer un compte Business PayPal
Lorsque vous êtes prêt à transférer votre application sur le serveur de production de PayPal,
ouvrez un compte Business PayPal sur www.paypal.fr.
Créer des informations d'authentification API
Pour utiliser les API, vous devez posséder un ensemble d'informations d'authentification pour
pouvoir vous identifier auprès de PayPal. Créer une signature API pour votre compte Business
Pour savoir comment obtenir des informations d'authentification API pour votre compte
Business, consultez la page https://www.paypal.com/IntegrationCenter/ic_certificate.html.
IMPO RTANT : Si
vous utilisez une signature API, vous devez en protéger les valeurs dans
votre intégration. Nous vous conseillons de sauvegarder ces valeurs dans un
endroit sûr autre que la racine des documents de votre serveur Web. Pensez
également à définir les droits d'accès à ce fichier, de sorte que seul
l'utilisateur système exécutant votre application de commerce électronique
puisse y accéder.
L'exemple de code ne sauvegarde pas ces valeurs de manière sûre. Il ne doit
en aucun cas être utilisé dans un environnement de production.
R E M A R Q U E : Nous
vous recommandons de vous procurer une signature API, mais vous
pouvez également utiliser un certificat d'API.
Modifier votre code
Dans votre application et pour les éléments suivants, substituez les valeurs de l'Environnement
de test à celles du serveur PayPal réel :
z
L'adresse du serveur dans l'URL (consultez la section « Envois utilisant HTTPS »
page 19).
z
Informations d'authentification API que vous avez créées à la section « Créer des
informations d'authentification API » page 14.
Détails techniques
Cette section présente des détails techniques sur les technologies utilisées par l'API NVP
PayPal.
Modèle de requête-réponse
Dans votre utilisation de l'API NVP PayPal, vous envoyez une requête NVP à PayPal et
PayPal vous envoie une réponse NVP.
14
Janvier 2008
Guide de développement et référence de l’API NVP
Présentation
Détails techniques
Format URL
La requête et la réponse sont encodées au format URL qui est définit par le Worldwide Web
Consortium (W3C). L'URL est une des spécifications de l'URI. Pour obtenir plus
d'informations sur l'URI, rendez-vous à l'adresse http://www.w3.org/Addressing/.
Format NVP
NVP est une façon de spécifier des noms et des valeurs dans une chaîne. NVP est le nom non
officiel de la demande dans la spécification URI. La chaîne NVP est ajoutée à l'URL.
Une chaîne NVP doit se conformer aux directives suivantes :
z
Le nom est séparé de la valeur par un signe égal (=). Exemple :
FIRSTNAME=Robert
z
Les paires nom-valeurs sont séparées par une esperluette (&). Exemple :
FIRSTNAME=Robert&MIDDLENAME=Herbert&LASTNAME=Morel
z
Dans une chaîne NVP, les valeurs de chaque champ sont codées au format URL.
Codage au format URL
La requête et la réponse sont codées au format URL. Ce format garantit la transmission des
caractères spéciaux, qui ne sont pas autorisés dans une URL, ainsi que ceux dotés d’une
signification particulière dans une URL tels que le signe égal et l'esperluette. Par exemple, la
chaîne NVP suivante :
NAME=Robert Morel&COMPANY=R. Morel & Cie
est codée au format URL de la manière suivante :
NAME=Robert+Morel&COMPANY=R%2E+Morel+%26+Cie
Utilisez les méthodes suivantes pour convertir au/du format URL vos chaînes NVP :
TABLEAU 1.2 Méthodes de codage au format URL
Langage
ASP.NET
ASP
classique
Java
PHP
Méthode
Codage
System.Web.HttpUtility.UrlEncode(buffer,
Encoding.Default)
Décodage
System.Web.HttpUtility.UrlDecode(buffer,
Encoding.Default)
Codage
Server.URLEncode
Décodage
Aucune fonction intégrée. Plusieurs exemples d'intégration sont
disponibles sur Internet.
Codage
java.net.URLEncoder.encode
Décodage
java.net.URLDecoder.decode
Codage
urlencode()
Guide de développement et référence de l’API NVP
Janvier 2008
15
Présentation
Détails techniques
TABLEAU 1.2 Méthodes de codage au format URL
Langage
ColdFusion
Méthode
Décodage
urldecode()
Codage
URLEncodedFormatstring [, charset ]
Décodage
URLDecodeurlEncodedString[, charset])
Format de la requête
Chaque requête NVP est composée de paramètres nécessaires et facultatifs et de leurs valeurs.
Les noms des paramètres ne différencient pas les majuscules/minuscules. Dans les exemples
contenus dans ce document, les noms des paramètres sont en MAJUSCULES et les paramètres
sont divisés en deux catégories : paramètres de sécurité et paramètres du corps de la requête.
TABLEAU 1.3 Format général d'une requête
Paramètres de
sécurité
obligatoires
USER=nomUtilisateurApi&PWD=motDePasseApi&SIGNATURE=signatureApi
&SUBJECT=adresseEmailTiersFacultative&VERSION=3.2
Les paramètres suivants sont toujours obligatoires :
USER
PWD
VERSION=3.2
R E M A R Q U E : Les paramètres de sécurité obligatoires apparaissent dans les
exemples sous la forme suivante :
[parametresDeSecuriteObligatoires]
Paramètres de
corps
&METHOD=nomMethode&autresParametresObligatoiresEtFacultatifs
Dans la pratique, il est nécessaire d'enchaîner tous les paramètres et toutes les valeurs dans une
chaîne unique, encodée au format URL. Après le paramètre METHOD, vous pouvez spécifier les
paramètres dans l'ordre de votre choix.
Paramètres de sécurité
Les paramètres de sécurité sont décrits ci-dessous. Ils correspondent à vos informations
d'authentification API PayPal.
TABLEAU 1.4 Paramètres de sécurité obligatoires : Informations d'authentification API
Paramètre
16
Valeur
USER
Obligatoire
Votre identifiant API PayPal.
PWD
Obligatoire
Votre mot de passe API PayPal.
Janvier 2008
Guide de développement et référence de l’API NVP
Présentation
Détails techniques
TABLEAU 1.4 Paramètres de sécurité obligatoires : Informations d'authentification API
Paramètre
Valeur
VERSION=
Obligatoire
Le numéro de version du service API NVP.
SIGNATURE
Facultatif
Votre chaîne de signature API PayPal.
Il n'est pas nécessaire d'inclure ce paramètre si vous utilisez un
certificat d'API.
SUBJECT
Facultatif
L'adresse email du compte PayPal qui vous a autorisé à faire cet
appel.
Définissez ce paramètre seulement si vous appelez une API pour le
compte d'un autre utilisateur.
<version en
cours>
IMPO RTANT :
Vous devez protéger les valeurs de USER, PWD et de SIGNATURE dans votre
intégration. Nous vous conseillons de sauvegarder ces valeurs dans un
endroit sûr autre que la racine des documents de votre serveur Web. Pensez
également à définir les droits d'accès à ce fichier, de sorte que seul
l'utilisateur système exécutant votre application de commerce électronique
puisse y accéder.
L'exemple de code ne sauvegarde pas ces valeurs de manière sûre. Il ne doit
en aucun cas être utilisé dans un environnement de production.
Des exemples de code se trouvent peut-être là où ces valeurs sont stockées,
sous un format HTML. L'exemple suivant montre ce que vous devez
EVITER de faire dans un Environnement de production :
<form method=post
action=https://api-3t.sandbox.paypal.com/nvp>
<!-- VALEURS NON PROTEGEES. NE PAS UTILISER EN PRODUCTION ! -->
<input type=hidden name=USER value=xxxxxx.paypal.com>
<input type=hidden name=PWD value=abcdefg>
<input type=hidden name=SIGNATURE value=xxxxxxxxxxxxxxx>
...
</form>
Paramètres API
Le corps de la requête doit contenir le nom de la méthode API dans le paramètre METHOD.
En outre, chaque méthode nécessite des paramètres obligatoires et facultatifs :
METHOD=nomDeLaMethode&parametresRequisEtFacultatifs
Toutes les méthodes d'API et leurs paramètres sont détaillés dans l'Annexe A, « Liste de
référence des méthodes et des champs de l'API NVP ». Des exemples d'utilisation sont
présentés aux Chapitre 2, « Accepter PayPal dans la fonction Paiement express » et
Chapitre 4, « Fonctions de gestion ». D’autres exemples d'utilisation figurent au Chapitre 2,
« Accepter PayPal dans la fonction Paiement express ».
Guide de développement et référence de l’API NVP
Janvier 2008
17
Présentation
Détails techniques
Format de la réponse
Une réponse en provenance des serveurs PayPal consiste en une chaîne de paires nom-valeur
encodée au format URL, à l'instar de la requête, si ce n'est qu'elle se présente sous le format
général suivant :
TABLEAU 1.5 Format général d'une réponse indiquant une réussite
Champs d'une
réponse
indiquant une
réussite
ACK=Success&TIMESTAMP=date/heureDeReponse
&CORRELATIONID=jetonDebogage&VERSION=3.200000
&BUILD=numeroBuild
L'en-tête de la réponse de
réussite apparaît dans les
exemples sous la forme
suivante :
[champsReponseReussie]
Champs de la
réponse API
&NOM1=valeur1&NOM2=valeur2&NOM3=valeur3&...
Chaque réponse comprend le champ ACK. Si la valeur du champ est Success ou
SuccessWithWarning, vous devez traiter les champs de la réponse API. Dans le cas d'une
réponse indiquant une réussite, vous pouvez ignorer tous les champs jusqu'au champ BUILD
compris. Les champs importants se trouvent après le champ BUILD.
Les champs susceptibles de se trouver dans une réponse de réussite sont détaillés pour chaque
méthode dans l'Annexe A, « Liste de référence des méthodes et des champs de l'API NVP ».
La façon d’utiliser les champs dépend du mode API spécifique que vous appelez, par exemple
remplir un formulaire FORM pour votre utilisateur, mettre à jour votre base de données, etc.
Réponses aux erreurs
Si la valeur du champ ACK est Error ou Warning, les champs de réponse API ne sont pas
renvoyés. Une réponse d'erreur se présente sous le format général suivant :
TABLEAU 1.6 Format d'une réponse d'erreur
Champs de la
réponse
d'erreur
ACK=Error&TIMESTAMP=date/heureDeLaReponse&
CORRELATIONID=jetonDebogage&VERSION=2.300000&
BUILD=numeroBuild&L_ERRORCODE0=codeErreur&
L_SHORTMESSAGE0=messageCourt&
L_LONGMESSAGE0=messageLong&
L_SEVERITYCODE0=codeGravite
Il est possible que des erreurs
multiples soient renvoyées.
Chaque groupe d'erreur est
caractérisé par un suffixe
numérique différent, en
commençant par 0 et incrémenté
d'une unité à chaque erreur.
Pour connaître les causes possibles des erreurs et savoir comment les corriger, reportez-vous à
l'explication du code spécifique de l'erreur, son message court et son message long dans
l'Annexe B, « Liste de référence des messages d'erreur ».
18
Janvier 2008
Guide de développement et référence de l’API NVP
Présentation
Détails techniques
Valeurs du paramètre ACK
Le tableau ci-dessous répertorie les valeurs du paramètre ACK.
TABLEAU 1.7 Valeurs du paramètre ACK
Type de réponse
Valeur
Réponse de réussite
Success
SuccessWithWarning
Réponse d'erreur
Failure
FailureWithWarning
Warning
Envois utilisant HTTPS
Votre application Web envoie la chaîne NVP encodée au format URL via une connexion
HTTPS à l'un des serveurs API de PayPal. PayPal fournit un serveur en environnement de
production et un autre en environnement de test permettant de tester les transactions.
Serveurs API pour la sécurité des signatures API
Si vous utilisez une signature API, envoyez la requête à l'un des serveurs suivants :
Environnement de test : https://api-3t.sandbox.paypal.com/nvp
Environnement de production : https://api-3t.paypal.com/nvp
Serveurs API garantissant la sécurité des certificats d'API
Si vous utilisez un certificat d'API, envoyez la requête à l'un des serveurs suivants :
Environnement de test : https://api.sandbox.paypal.com/nvp
Environnement de production : https://api.paypal.com/nvp
Guide de développement et référence de l’API NVP
Janvier 2008
19
Présentation
Détails techniques
20
Janvier 2008
Guide de développement et référence de l’API NVP
2
Accepter PayPal dans la fonction
Paiement express
S'il choisit l'option Paiement express PayPal, le client économisera du temps : plusieurs étapes
de la procédure de paiement seront ignorées car les informations de facturation et de livraison
déjà enregistrées auprès de PayPal seront utilisées.
Cette section vous explique comment utiliser la fonction Paiement express PayPal pour
accepter des paiements via PayPal. Elle se compose des rubriques suivantes :
z
« Procédure de paiement de base via PayPal » page 21
z
« Vérifier l'adresse de livraison à l'aide de SetExpressCheckout » page 24
z
« GetExpressCheckoutDetails renvoie l'adresse de livraison ignorée. » page 25
z
« Modifier le Logo des pages PayPal » page 26
z
« Remplir le formulaire de votre page de vérification de paiement » page 27
z
« Effectuer une vente à l'aide de DoExpressCheckoutPayment » page 28
z
« Autoriser une collecte unique » page 28
z
« Autoriser les collectes multiples » page 29
z
« Changer l'URL de la Notification instantanée de paiement (IPN) » page 30
z
« Inclure le détail des objets à l'aide de DoExpressCheckoutPayment » page 30
z
« Inclure les sous-totaux à l'aide de DoExpressCheckoutPayment » page 31
z
« Mettre à jour les détails de la transaction avec DoExpressCheckoutPayment » page 32
z
« Mettre à jour l'adresse de livraison avec DoExpressCheckoutPayment » page 33
z
« Paiement express PayPal pour les enchères eBay » page 33
Procédure de paiement de base via PayPal
Consultez le guide d'intégration de Paiement express pour obtenir des informations sur cette
fonction, en particulier le flux des pages au fil de la procédure, les points d'intégration, le
placement des boutons et la conception des pages.
La procédure de Paiement express via PayPal doit se dérouler selon les étapes suivantes :
1. Initialiser le paiement à l'aide de SetExpressCheckout
2. Rediriger le navigateur du client vers la page de connexion à PayPal
3. Récupérer les informations du client à l'aide de GetExpressCheckoutDetails
4. Effectuer une vente à l'aide de DoExpressCheckoutPayment
Guide de développement et référence de l’API NVP
Janvier 2008
21
Accepter PayPal dans la fonction Paiement express
Procédure de paiement de base via PayPal
La réponse SetExpressCheckout, vous fournit un jeton TOKEN qui identifie de manière
unique cette transaction en trois étapes. Vous devez transmettre ce jeton TOKEN dans les
requêtes GetExpressCheckoutDetails et DoExpressCheckoutPayment.
GetExpressCheckoutDetails et DoExpressCheckoutPayment renvoient toutes les
deux la valeur de TOKEN dans la réponse.
Cet exemple illustre un paiement de base utilisant un nombre minimum de paramètres.
1. Initialiser le paiement à l'aide de SetExpressCheckout
Le mode de requête SetExpressCheckout indique à PayPal que vous utilisez Paiement
express PayPal pour obtenir un paiement de votre client.
Vous devez toujours inclure les paramètres suivants dans la requête SetExpressCheckout :
z
AMT
z
RETURNURL
z
CANCELURL
TABLEAU 2.1 Initialiser le paiement
Requête
[parametresDeSecuriteObligatoires]&METHOD=SetExpressCheckout&AMT=10.00&
RETURNURL=https://www.masociete.com/traitementcommandes/affichcommande.html&
CANCELURL=https://www.unesociete.com/traitementcommande/infolivraison.html
Réponse
[champsReponseReussite]&TOKEN=EC-3DJ78083ES565113B
R E M A R Q U E : Du
fait que nous ne la spécifions pas, la valeur de l'élément
PAYMENTACTION sera sa valeur par défaut : Sale.
Sauvegardez le TOKEN en vue de son utilisation lors des appels Paiement express PayPal
restants.
2. Rediriger le navigateur du client vers la page de connexion à PayPal
Lorsque vous avez reçu une réponse de SetExpressCheckout, ajoutez la valeur de TOKEN
fournie dans la réponse SetExpressCheckout sous forme de paire nom-valeur à l'URL
suivante et redirigez le navigateur du client vers cette URL :
https://www.paypal.com/cgi-bin/webscr?cmd=_express-checkout&
token=valeur_retournee_par_SetExpressCheckoutResponse
PayPal vous recommande d'utiliser la réponse HTTPS 302 «Objet déplacé» avec l'URL cidessus comme valeur de l'en-tête Location dans la réponse HTTPS pour rediriger le navigateur
d'un client vers sa page de connexion. Si votre serveur utilise le protocole SSL, évitez que le
navigateur ne reçoive des avertissements à propos d'un mélange d'images sécurisées et non
sécurisées.
22
Janvier 2008
Guide de développement et référence de l’API NVP
Accepter PayPal dans la fonction Paiement express
Procédure de paiement de base via PayPal
3. Récupérer les informations du client à l'aide de GetExpressCheckoutDetails
Le mode GetExpressCheckoutDetails renvoie les informations du client, y compris son
nom et son adresse enregistrés par PayPal.
Vous devez toujours inclure les paramètres suivants dans GetExpressCheckoutDetails :
z
TOKEN : utilisez la valeur fournie par la réponse SetExpressCheckout
La réponse contient ce jeton TOKEN ainsi que les informations du client.
TABLEAU 2.2 Obtenir les informations du payeur
Requête
[parametresDeSecuriteObligatoires]&METHOD=GetExpressCheckoutDetails&
TOKEN=EC-3DJ78083ES565113B
Réponse
[champsReponseReussie]&TOKEN=EC-3DJ78083ES565113B&EMAIL=abcdef@unemail.com&
PAYERID=95HR9CM6D56Q2&PAYERSTATUS=verified&FIRSTNAME=Claude&
LASTNAME=Martin&COUNTRYCODE=FR&
SHIPTONAME=Claude+Martin&SHIPTOSTREET=144+Grande+rue&
SHIPTOCITY=Carpentras&SHIPTOSTATE=none&SHIPTOCOUNTRYCODE=FR&
SHIPTOZIP=84200&ADDRESSID=PayPal&
ADDRESSSTATUS=Confirmed
Assurez-vous que la valeur de TOKEN correspond à la valeur contenue dans la réponse
SetExpressCheckout.
Enregistrez PAYERID en vue de son utilisation lors du prochain appel.
4. Effectuer une vente à l'aide de DoExpressCheckoutPayment
Requête pour obtenir le paiement via la fonction Paiement express PayPal de PayPal à l'aide
de l'API DoExpressCheckoutPayment.
Par défaut, vous accomplissez la vente finale à l'aide de l'API DoExpressCheckoutPayment.
Vous pouvez également demander une autorisation pour collecte ultérieure du paiement. Pour
en savoir plus, reportez-vous à la section « Autoriser les collectes multiples » page 29.
Vous devez toujours inclure les paramètres suivants dans la requête SetExpressCheckout :
TOKEN: utilisez la valeur fournie par la réponse SetExpressCheckoutDetails.
PAYERID: utilisez la valeur fournie par la réponse SetExpressCheckoutDetails.
PAYMENTACTION: choisissez Sale. Il s'agit de la valeur par défaut de SetExpressCheckout.
AMT: utilisez la même valeur que pour la requête SetExpressCheckout
TABLEAU 2.3 Effectuer une vente
Requête
[parametresDeSecuriteObligatoires]&METHOD=DoExpressCheckoutPayment&
TOKEN=EC-0E881823PA052770A&AMT=10.00&
PAYERID=95HR9CM6D56Q2&PAYMENTACTION=Sale
Guide de développement et référence de l’API NVP
Janvier 2008
23
Accepter PayPal dans la fonction Paiement express
Vérifier l'adresse de livraison à l'aide de SetExpressCheckout
Réponse
[champsReponseReussie]&TOKEN=EC-0E881823PA052770A&
TRANSACTIONID=8SC56973LM923823H&TRANSACTIONTYPE=expresscheckout&
PAYMENTTYPE=instant&ORDERTIME=2006-08-22T20:16:05Z&AMT=10.00&
CURRENCYCODE=USD&FEEAMT=0.59&TAXAMT=0.00&
PAYMENTSTATUS=Completed&PENDINGREASON=None&REASONCODE=None
Vérifier l'adresse de livraison à l'aide de SetExpressCheckout
Vous pouvez modifier le comportement de l'adresse de livraison grâce aux paramètres
REQCONFIRMSHIPPING, NOSHIPPING et ADDROVERRIDE de la requête SetExpressCheckout.
L'adresse de livraison est spécifiée dans les paramètres SHIPTOxxx.
Exiger une adresse confirmée
Pour exiger que l'adresse de livraison soit une adresse PayPal confirmée, donnez à
REQCONFIRMSHIPPING la valeur 1 dans la requête SetExpressCheckout.
valeur de REQCONFIRMSHIPPING remplace le paramètre situé dans vos
Préférences de compte marchand.
R E M A R Q U E : La
TABLEAU 2.4 Exiger une adresse confirmée
Requête
[parametresDeSecuriteRequis]&METHOD=SetExpressCheckout&AMT=10.00&
RETURNURL=https://www.masociete.com/traitementcommandes/affichcommande.html&
CANCELURL=https://www.unesociete.com/traitementcommande/infoslivraison.html
&REQCONFIRMSHIPPING=1
Réponse
[champsReponseReussie]&TOKEN=EC-0E881823PA052770A
Supprimer l'affichage de l'adresse de livraison sur PayPal
Pour que l'adresse de livraison du client ne s'affiche pas sur les pages Web de PayPal, donnez à
NOSHIPPING la valeur 1 dans la requête SetExpressCheckout. Cette fonction peut être
utile dans les cas où le produit ou le service que vous vendez ne nécessite pas de livraison.
TABLEAU 2.5 Supprimer l'adresse de livraison
24
Requête
[parametresDeSecuriteObligatoires]&METHOD=SetExpressCheckout&AMT=10.00&
RETURNURL=https://www.masociete.com/traitementcommandes/affichcommande.html&
CANCELURL=https://www.unesociete.com/traitementcommande/infolivraison.html
&NOSHIPPING=1
Réponse
[champsReponseReussie]&TOKEN=EC-17C76533PL706494P
Janvier 2008
Guide de développement et référence de l’API NVP
Accepter PayPal dans la fonction Paiement express
Vérifier l'adresse de livraison à l'aide de SetExpressCheckout
GetExpressCheckoutDetails ne renvoie pas l'adresse de livraison.
TABLEAU 2.6 GetExpressCheckoutDetails
Requête
[parametresDeSecuriteObligatoires]&METHOD=GetExpressCheckoutDetails&
TOKEN=EC-17C76533PL706494P
Réponse
[champsReponseReussie]&TOKEN=EC17C76533PL706494P&EMAIL=abcdef@unesociete.com&PAYERID=95HR9CM6D56Q2&
PAYERSTATUS=verified&FIRSTNAME=Claude&LASTNAME=Martin&COUNTRYCODE=FR&
ADDRESSID=PayPal&ADDRESSSTATUS=None
Ignorer l'adresse de livraison enregistrée auprès de PayPal
Pour ne pas tenir compte de l'adresse de livraison enregistrée auprès de PayPal, appelez
SetExpressCheckout afin de pouvoir donner à l'élément ADDROVERRIDE la valeur 1 et
définissez les champs de l'adresse de livraison (consultez le Tableau A.3, « Adresse de
livraison (facultatif) »).
Si l'adresse est ignorée, le client ne peut pas la modifier.
TABLEAU 2.7 Ignorer l'adresse de livraison
Requête
[parametresDeSecuriteObligatoires]&METHOD=SetExpressCheckout&AMT=10.00&
RETURNURL=https://www.masociete.com/traitementcommandes/affichcommande.html&
CANCELURL=https://www.unesociete.com/traitementcommande/infoslivraison.html
&SHIPTONAME=Claude+Martin&SHIPTOSTREET=144+grande+rue&SHIPTOCITY=CARPENTRAS
&SHIPTOSTATE=none&SHIPTOCOUNTRYCODE=FR&SHIPTOZIP=84200&
ADDROVERRIDE=1
Réponse
[champsReponseReussie]&TOKEN=EC-17C76533PL706494P
GetExpressCheckoutDetails renvoie l'adresse de livraison ignorée.
TABLEAU 2.8 GetExpressCheckoutDetails
Requête
[parametresDeSecuriteObligatoires]&METHOD=GetExpressCheckoutDetails&TOKEN=EC17C76533PL706494P
Réponse
[champsReponseReussie]&TOKEN=EC-17C76533PL706494P&
PAYER=abcdef@unesociete.com&PAYERID=95HR9CM6D56Q2&PAYERSTATUS=verified&
FIRSTNAME=Claude&LASTNAME=Martin&
COUNTRYCODE=FR&SHIPTONAME=Claude+Martin&SHIPTOSTREET=144+grande+rue&
SHIPTOCITY=CARPENTRAS&SHIPTOSTATE=none&SHIPTOCOUNTRYCODE=FR&SHIPTOZIP=84200&
ADDRESSID=PayPal&ADDRESSSTATUS=Unconfirmed
Guide de développement et référence de l’API NVP
Janvier 2008
25
Accepter PayPal dans la fonction Paiement express
Changer la langue de la page de connexion à PayPal
Changer la langue de la page de connexion à PayPal
Pour changer la langue de la page de connexion à PayPal, donnez à LOCALECODE une des
valeurs autorisées dans SetExpressCheckout. Pour obtenir plus d'informations au sujet des
valeurs de LOCALECODE, consultez le Tableau A.1, « Devises acceptées par PayPal et codes de
devises pour les transactions ». Dans l'exemple suivant nous donnons à LOCALECODE la valeur
Français.
TABLEAU 2.9 Changer la langue de la page de connexion à PayPal pour la valeur Français
Requête
[parametresDeSecuriteObligatoires]&METHOD=SetExpressCheckout&AMT=10.00&
CURRENCYCODE=EUR&
RETURNURL=https://www.masociete.com/traitementcommandes/affichcommande.html&
CANCELURL=https://www.unesociete.com/traitementcommandes/infoslivraison.html
&LOCALECODE=fr_FR
Réponse
[champsReponseReussie]&TOKEN=EC-17C76533PL706494P
Modifier le Logo des pages PayPal
Il existe deux façons de modifier le logo et d'autres paramètres de couleur sur les pages
PayPal :
z
en sélectionnant un style de pages de paiement prédéfini;
z
en définissant les paramètres du logo et des couleurs individuellement.
Choix d'un style de page de paiement personnalisé
Pour spécifier un style de pages de paiement pour les pages PayPal, définissez le paramètre
PAGESTYLE dans SetExpressCheckout. Définissez PAGESTYLE en sélectionnant un nom
parmi les styles de page créés par vous dans vos pages de paiement personnalisées sur
https://www.paypal.fr.
L'exemple suivant définit la valeur de PAGESTYLE comme DesignerFotos-Yellow dans le
mode SetExpressCheckout
TABLEAU 2.10 Choix d'un style de page de paiement personnalisé
26
Requête
[parametresDeSecuriteObligatoires]&METHOD=SetExpressCheckout&AMT=10.00&
RETURNURL=https://www.masociete.com/traitementcommandes/affichcommande.html&
CANCELURL=https://www.masociete.com/traitementcommandes/infoslivraison.html&
PAGESTYLE=DesignerFotos-Yellow
Réponse
[champsReponseReussie]&TOKEN=EC-17C76533PL706494P
Janvier 2008
Guide de développement et référence de l’API NVP
Accepter PayPal dans la fonction Paiement express
Remplir le formulaire de votre page de vérification de paiement
Personnaliser le logo et les couleurs individuellement
Pour que les pages Web de PayPal ressemblent à vos propres pages Web, il vous suffit de
définir les paramètres suivants dans SetExpressCheckout :
z
HDRIMG : spécifie l'image devant s'afficher en haut à gauche de la page de paiement.
z
HDRBORDERCOLOR : définit la couleur de bordure encadrant l'en-tête de la page de paiement.
z
HDRBACKCOLOR : définit la couleur d'arrière-plan de l'en-tête de la page de paiement.
z
PAYFLOWCOLOR : définit la couleur d'arrière-plan de la page de paiement.
TABLEAU 2.11 Personnaliser le logo et les couleurs individuellement
Requête
[parametresDeSecuriteObligatoires]&METHOD=SetExpressCheckout&AMT=10.00&
RETURNURL=https://www.masociete.com/traitementcommandes/affichcommande.html&
CANCELURL=https://www.masociete.com/traitementcommandes/infoslivraison.html&
HDRIMG=https://www.masociete.com/images/ImageEnTete.gif&
HDRBORDERCOLOR=3366FF&HDRBACKCOLOR=D3EFF5&PAYFLOWCOLOR=F8F5F5
Réponse
[champsReponseReussie]&TOKEN=EC-17C76533PL706494P
Remplir le formulaire de votre page de vérification de paiement
Utilisez le nom et l'adresse de livraison du payeur fournis par la réponse
GetExpressCheckoutDetails pour renseigner les champs du formulaire sur la page de
vérification de paiement affichée une fois le client revenu de PayPal sur votre site.
TABLEAU 2.12 Remplir le formulaire de votre page de vérification de paiement
Requête
[parametresDeSecuriteObligatoires]&METHOD=GetExpressCheckoutDetails&
TOKEN=EC-3DJ78083ES565113B
Réponse
[champsReponseReussie]&TOKEN=EC-3DJ78083ES565113B&EMAIL=abcdef@unemail.com&
PAYERID=95HR9CM6D56Q2&PAYERSTATUS=verified&FIRSTNAME=Claude&LASTNAME=Martin&
COUNTRYCODE=FR&SHIPTONAME=Claude+Martin&SHIPTOSTREET=144+grande+rue&
SHIPTOCITY=CARPENTRAS&SHIPTOSTATE=none&SHIPTOCOUNTRYCODE=FR&SHIPTOZIP=84200&
ADDRESSID=PayPal&ADDRESSSTATUS=Confirmed
Obtenez le nom du payeur à partir des paramètres suivants de la réponse
GetExpressCheckoutDetails :
z
SALUTATION
z
FIRSTNAME
z
MIDDLENAME
z
LASTNAME
Guide de développement et référence de l’API NVP
Janvier 2008
27
Accepter PayPal dans la fonction Paiement express
Effectuer une vente à l'aide de DoExpressCheckoutPayment
z
SUFFIX
Obtenez l'adresse de livraison à partir des paramètres suivants de la réponse
GetExpressCheckoutDetails :
z
SHIPTONAME
z
SHIPTOSTREET
z
SHIPTOSTREET2
z
SHIPTOCITY
z
SHIPTOSTATE
z
SHIPTOCOUNTRYCODE
z
SHIPTOPHONENUM
z
SHIPTOZIP
Effectuer une vente à l'aide de DoExpressCheckoutPayment
Utilisez DoExpressCheckoutPayment pour effectuer une vente finale.
Pour en savoir plus, reportez-vous à la section « Procédure de paiement de base via PayPal »
page 21.
Autoriser une collecte unique
Vous pouvez autoriser le paiement d'une vente finale en attribuant la valeur Authorization
au champ PAYMENTACTION des API SetExpressCheckout et
DoExpressCheckoutPayment.
TABLEAU 2.13 Autoriser une collecte unique à l'aide de SetExpressCheckout
Requête
[parametresDeSecuriteObligatoires]&METHOD=SetExpressCheckout&AMT=10.00&
RETURNURL=https://www.masociete.com/traitement_commandes/affich_commande.html&
CANCELURL=https://www.masociete.com/traitement_commandes/infoslivraison.html&
PAYMENTACTION=Authorization
Réponse
[champsReponseReussie]&
TOKEN=EC-30P862430W113011F
TABLEAU 2.14 Autoriser une collecte unique à l'aide de DoExpressCheckoutPayment
Requête
28
[parametresDeSecuriteObligatoires]&METHOD=DoExpressCheckoutPayment&
TOKEN=EC-30P862430W113011F&PAYERID=95HR9CM6D56Q2&AMT=10.00
PAYMENTACTION=Authorization
Janvier 2008
Guide de développement et référence de l’API NVP
Accepter PayPal dans la fonction Paiement express
Autoriser les collectes multiples
Réponse
[champsReponseReussie]&TOKEN=EC-30P862430W113011F&
TRANSACTIONID=4D479374VP578364Y&TRANSACTIONTYPE=expresscheckout&
PAYMENTTYPE=instant&ORDERTIME=2006-08-22T22:02:42Z&AMT=10.00&
CURRENCYCODE=USD&TAXAMT=0.00&PAYMENTSTATUS=Pending&
PENDINGREASON=authorization&REASONCODE=None
Le réglage de PAYMENTACTION sur Order vérifie que le compte du client existe, mais ne
bloque pas les fonds. Pour autoriser les fonds, vous devez également appeler l'API
DoAuthorization en indiquant le montant à autoriser. Dans la plupart des cas, vous appelez
DoAuthorization directement après DoExpressCheckout dans votre flux de paiement
afin de réduire les risques de rejet de la collecte.
Utilisez la valeur de la variable TRANSACTIONID de la réponse
DoExpressCheckoutPayment comme valeur de TRANSACTIONID dans la requête
DoAuthorization. Utilisez ensuite celle de AUTHORIZATIONID contenue dans la réponse
DoAuthorization pour la requête DoCapture pour effectuer la collecte sur la commande.
Pour en savoir plus sur la fonction Autorisation et collecte, consultez « Effectuer une collecte
unique avec DoCapture » page 37.
Autoriser les collectes multiples
Vous pouvez autoriser le paiement de plusieurs collectes en attribuant la valeur Order au champ
PAYMENTACTION des API SetExpressCheckout et DoExpressCheckoutPayment.
TABLEAU 2.15 Autoriser des collectes multiples à l'aide de SetExpressCheckout
Requête
[parametresDeSecuriteObligatoires]&METHOD=SetExpressCheckout&AMT=10.00&
RETURNURL=https://www.masociete.com/traitement_commandes/affich_commande.html&
CANCELURL=https://www.masociete.com/traitement_commandes/infoslivraison.html&
PAYMENTACTION=Order
Réponse
[champsReponseReussie]&TOKEN=EC-8NB10343BA3562027
TABLEAU 2.16 Autoriser des collectes multiples à l'aide de DoExpressCheckoutPayment
Requête
[parametresDeSecuriteObligatoires]&METHOD=DoExpressCheckoutPayment&
TOKEN=EC-8NB10343BA3562027&PAYERID=95HR9CM6D56Q2&AMT=1.00&
PAYMENTACTION=Order
Réponse
[champsReponseReussie]&TOKEN=EC-8NB10343BA3562027&
TRANSACTIONID=O-2YX05090CA6454418&TRANSACTIONTYPE=expresscheckout&
PAYMENTTYPE=None&ORDERTIME=2006-08-22T22:22:03Z&AMT=1.00&
CURRENCYCODE=USD&TAXAMT=0.00&PAYMENTSTATUS=None&PENDINGREASON=order&
REASONCODE=None
Guide de développement et référence de l’API NVP
Janvier 2008
29
Accepter PayPal dans la fonction Paiement express
Changer l'URL de la Notification instantanée de paiement (IPN)
Avant d'effectuer une collecte sur la commande, vous devez commencer par appeler
DoAuthorization pour autoriser le montant de la transaction. Utilisez la valeur de
TRANSACTIONID de DoExpressCheckoutPayment comme valeur de TRANSACTIONID
dans la requête DoAuthorization. Dans la plupart des cas, vous devez appeler
DoAuthorization directement après DoExpressCheckout dans votre flux de paiement.
Utilisez la valeur de AUTHORIZATIONID contenue dans la réponse DoAuthorization dans
la requête DoCapture pour effectuer la collecte sur la commande. Pour en savoir plus sur la
fonction Autorisation et collecte, consultez « Effectuer plusieurs collectes partielles avec
DoCapture » page 38.
Pour en savoir plus sur DoCapture, reportez-vous à la section « Collecter, Autoriser, Annuler
et Demander une nouvelle autorisation » page 37.
Changer l'URL de la Notification instantanée de paiement (IPN)
Pour changer l'URL permettant de recevoir la Notification instantanée de paiement (IPN) pour
cette transaction, spécifiez le paramètre NOTIFYURL dans DoExpressCheckoutPayment.
Si vous ne spécifiez pas cette valeur dans la requête, c'est l'URL de notification de vos
Préférences du marchand qui est utilisée, s'il en existe une.
Pour plus d’informations concernant la fonction IPN, consultez le Guide d’intégration de la
gestion des commandes.
TABLEAU 2.17 Changer l'URL de la Notification instantanée de paiement (IPN)
Requête
[parametresDeSecuriteObligatoires]&METHOD=DoExpressCheckoutPayment&
TOKEN=EC-8AX1275942659774U&PAYERID=95HR9CM6D56Q2&AMT=10.00&
PAYMENTACTION=Sale&NOTIFYURL=https://www.anycompany.com/process-ipn/
Réponse
[champsReponseReussie]&TOKEN=EC-8AX1275942659774U&
TRANSACTIONID=1MA55216691247718&TRANSACTIONTYPE=expresscheckout&
PAYMENTTYPE=instant&ORDERTIME=2006-08-22T22:39:13Z&AMT=10.00&
CURRENCYCODE=USD&FEEAMT=0.59&TAXAMT=0.00&PAYMENTSTATUS=Completed&
PENDINGREASON=None&REASONCODE=None
Inclure le détail des objets à l'aide de DoExpressCheckoutPayment
Vous pouvez insérer des lignes de détails sur les objets en définissant les paramètres suivants
pour DoExpressCheckoutPayment :
30
z
L_NAMEn : le nom ou la description de l'objet
z
L_NUMBERn : le numéro de l'objet
z
L_QTYn : la quantité
Janvier 2008
Guide de développement et référence de l’API NVP
Accepter PayPal dans la fonction Paiement express
Inclure les sous-totaux à l'aide de DoExpressCheckoutPayment
z
L_TAXAMTn : le montant de la taxe pour l'objet
z
L_AMTn : le coût de l'objet
Vous pouvez détailler autant d'objets que vous le souhaitez. En commençant par 0, ajoutez un
numéro au nom de champ et incrémentez ce numéro d'une unité pour chaque champ.
L'exemple suivant définit les détails de deux objets. Ces détails sont enregistrés par PayPal.
TABLEAU 2.18 Ajouter le détail des objets
Requête
[parametresDeSecuriteObligatoires]&METHOD=DoExpressCheckoutPayment&
TOKEN=EC-4XH62109C8044521N&PAYERID=95HR9CM6D56Q2&PAYMENTACTION=Sale&AMT=6.24&
ITEMAMT=5.75&TAXAMT=0.49&L_NUMBER0=1&L_NAME0=A+Tale+of+Two+Cities&L_AMT0=2.50&
L_QTY0=1&L_TAXAMT0=0.21&L_NAME1=Oliver+Twist&L_NUMBER1=2&L_AMT1=3.25&L_QTY1=1&
L_TAXAMT1=0.28
Réponse
[champsReponseReussie]&TOKEN=EC-4XH62109C8044521N&
TRANSACTIONID=77U91743M2649930P&TRANSACTIONTYPE=expresscheckout&
PAYMENTTYPE=instant&ORDERTIME=2006-08-22T22:49:50Z&AMT=6.24&
CURRENCYCODE=USD&FEEAMT=0.48&TAXAMT=0.28&PAYMENTSTATUS=Completed&
PENDINGREASON=None&REASONCODE=None
Si vous spécifiez L_AMTn, vous devez préciser le paramètre ITEMAMT. La somme des valeurs
de L_AMTn et L_QTYn doit être égale au ITEMAMT.
Si vous spécifiez L_TAXAMTn, vous devez préciser le paramètre TAXAMT. La somme des
valeurs de L_TAXAMTn et L_QTYn doit être égale au TAXAMT.
Veuillez trouver ci-dessous des exemples de ITEMAMT and TAXAMT :
ITEMAMT = (L_AMT0 * L_QTY0) + (L_AMT1 * L_QTY1) + L_AMT2
TAXAMT = (L_TAXAMT0 * L_QTY0) + (L_TAXAMT1 * L_QTY1) + L_TAXAMT2
R E M A R Q U E : Si la somme du détail des objets ne correspond pas au ITEMAMT ou au TAXAMT,
les détails sont rejetés et la transaction est traitée en utilisant les valeurs de
ITEMAMT ou TAXAMT. La valeur ACK de la réponse est définie par
SuccessWithWarning.
Inclure les sous-totaux à l'aide de DoExpressCheckoutPayment
Si vous désirez que l'utilisateur PayPal puisse voir les sous-totaux correspondant au coût des
objets, aux frais de livraison, aux frais de dossier et aux taxes, incluez les paramètres suivants
pour DoExpressCheckoutPayment :
z
ITEMAMT
z
SHIPPINGAMT
z
HANDLINGAMT
z
TAXAMT
Guide de développement et référence de l’API NVP
Janvier 2008
31
Accepter PayPal dans la fonction Paiement express
Mettre à jour les détails de la transaction avec DoExpressCheckoutPayment
Si vous indiquez des valeurs pour des montants de ces sous-totaux, leur somme doit être égale
à la valeur du champ AMT indiqué dans la requête. Dans l'exemple ci-dessous, la somme de
ITEMAMT, SHIPPINGAMT, HANDLINGAMT et TAXAMT est ainsi égale à la valeur d'AMT.
Si un ou plusieurs des sous-totaux sont nuls, vous pouvez soit inclure le champ dans la requête
avec une valeur à zéro ou une chaîne vide, soit ne pas inclure le champ dans la requête.
Toutefois, la somme des champs des sous-totaux restants doit être égale à la valeur d'AMT.
TABLEAU 2.19 Inclure les sous-totaux
Requête
[parametresDeSecuriteObligatoires]&METHOD=DoExpressCheckoutPayment
TOKEN=EC-0EU150885J108392M&PAYERID=95HR9CM6D56Q2&PAYMENTACTION=Sale&
AMT=192.22&ITEMAMT=176.02&SHIPPINGAMT=14.34&HANDLINGAMT=1.10&TAXAMT=0.76
Réponse
[champsReponseReussie]&TOKEN=EC-0EU150885J108392M
&TRANSACTIONID=29W817045L6797418
&TRANSACTIONTYPE=expresscheckout&PAYMENTTYPE=instant
&ORDERTIME=2006-08-23T16:20:22Z&AMT=192.22&CURRENCYCODE=USD&FEEAMT=5.87
&TAXAMT=0.76&PAYMENTSTATUS=Completed&PENDINGREASON=None&REASONCODE=None
Mettre à jour les détails de la transaction avec
DoExpressCheckoutPayment
Il est possible que vous deviez mettre à jour le détail de la transaction sur le site PayPal si le
client la modifie lorsqu'il retourne à la page de vérification de la commande. Si une modification
implique de nouvelles valeurs pour l'un des paramètres suivants, vous devez mettre à jour le
détail de la transaction sur le site PayPal à l'aide de l'API DoExpressCheckoutPayment :
z
DESC: la description de l'objet
z
CUSTOM: un champ que vous pouvez utiliser librement
z
INVNUM: votre numéro de facture ou de suivi
Ces trois paramètres ont pu être définis pour l'API SetExpressCheckout.
TABLEAU 2.20 Mettre à jour les détails de la commande
32
Requête
[parametresDeSecuriteObligatoires]&METHOD=DoExpressCheckoutPayment&
TOKEN=EC-5JA9268562132991T&PAYERID=95HR9CM6D56Q2&PAYMENTACTION=Sale&AMT=10.00&
DESC=Commande+de+5+livres&CUSTOM=Merci+de+votre+confiance+!&INVNUM=ABC1234567
Réponse
[champsReponseReussie]&TOKEN=EC5JA9268562132991T&TRANSACTIONID=9JJ517146A732773R&TRANSACTIONTYPE=expresscheck
out&PAYMENTTYPE=instant&ORDERTIME=2006-0823T16:14:54Z&AMT=10.00&CURRENCYCODE=USD&FEEAMT=0.59&TAXAMT=0.00&PAYMENTSTATUS=
Completed&PENDINGREASON=None&REASONCODE=None
Janvier 2008
Guide de développement et référence de l’API NVP
Accepter PayPal dans la fonction Paiement express
Mettre à jour l'adresse de livraison avec DoExpressCheckoutPayment
Mettre à jour l'adresse de livraison avec DoExpressCheckoutPayment
Il est possible que vous ayez à mettre à jour l'adresse de livraison sur le site PayPal si le client
modifie l'adresse de livraison lorsqu'il retourne à la page de vérification de la commande. Le
cas échéant, vous devez mettre à jour l'adresse de livraison associée à cette transaction sur le
site PayPal.
Vous pouvez mettre à jour l'adresse de livraison en définissant les paramètres suivants pour
l'API DoExpressCheckoutPayment:
z
SHIPTONAME
z
SHIPTOSTREET
z
SHIPTOSTREET2
z
SHIPTOCITY
z
SHIPTOSTATE
z
SHIPTOCOUNTRYCODE
z
SHIPTOPHONENUM
z
SHIPTOZIP
TABLEAU 2.21 Mettre à jour l'adresse de livraison
Requête
[parametresDeSecuriteObligatoires]&METHOD=DoExpressCheckoutPayment&
TOKEN=EC-47C20533CU265432F&PAYERID=95HR9CM6D56Q2&PAYMENTACTION=Sale&AMT=10.00&
SHIPTONAME=Michel+Lebrun&SHIPTOSTREET=22+rue+Lavigne&SHIPTOCITY=Strasbourg&
SHIPTOCOUNTRYCODE=FR&SHIPTOSTATE=none&SHIPTOZIP=67000
Réponse
[champsReponseReussie]&TOKEN=EC-47C20533CU265432F&
TRANSACTIONID=8SC56973LM923823H&TRANSACTIONTYPE=expresscheckout&
PAYMENTTYPE=instant&ORDERTIME=2006-08-22T22:39:13Z&AMT=10.00&
CURRENCYCODE=USD&FEEAMT=0.59&TAXAMT=0.00&PAYMENTSTATUS=Completed&
PENDINGREASON=None&REASONCODE=None
Paiement express PayPal pour les enchères eBay
Vous pouvez également utiliser Paiement express pour payer les enchères eBay. Vous pouvez
mêler transactions eBay et hors eBay dans une même transaction.
Si le paiement de l'acheteur comporte des enchères eBay, vous devez définir des champs
supplémentaires pour commander le comportement de Paiement express.
Dans la requête SetExpressCheckout :
z
PAYMENTACTION doit avoir la valeur Sale
z
CHANNELTYPE doit avoir la valeur eBayItem
Guide de développement et référence de l’API NVP
Janvier 2008
33
Accepter PayPal dans la fonction Paiement express
Paiement express PayPal pour les enchères eBay
les enchères eBay, vous ne pouvez définir PAYMENTACTION à
Authorization ou Order. Vous devez définir PAYMENTACTION à Sale.
R E M A R Q U E : Pour
Dans la requête DoExpressCheckoutPayment, vous devez attribuer à PAYMENTACTION la
valeur Sale. Vous devez également fournir les détails de chaque objet pour chaque enchère
eBay pour que le paiement soit répercuté correctement dans Mon eBay.
R E M A R Q U E : Vous devez fournir les détails de chaque objet pour que l'acheteur puisse afficher
la transaction sur Mon eBay et avoir droit à la Protection des Achats PayPal.
Pour chaque objet, vous devez fournir les éléments suivants :
L_EBAYITEMNUMBERn et L_EBAYITEMAUCTIONTXNIDn
ou
L_EBAYITEMORDERIDn
Pour indiquer correctement les remises, vous pouvez également indiquer des éléments
négatifs, comme dans l'exemple suivant.
valeur que vous attribuez à AMT doit être égale au total des montants de
chaque objet indiqué.
R E M A R Q U E : La
TABLEAU 2.22 Éléments négatifs avec des enchères eBay
34
Requête
[parametresDeSecuriteObligatoires]&METHOD=DoExpressCheckoutPayment&
METHOD=DoExpressCheckoutPayment&TOKEN=EC-47C20533CU265432F&
PAYERID=95HR9CM6D56Q2&PAYMENTACTION=Sale&AMT=14.99&ITEMAMT=14.99&
LNAME0=Item0&LAMT0=19.99&L_EBAYITEMNUMBER0=230128323048&
L_EBAYITEMAUCTIONTXNID0=0&
Réponse
[champsReponseReussie]&TOKEN=EC-47C20533CU265432F&
TRANSACTIONID=8SC56973LM923823H&TRANSACTIONTYPE=expresscheckout&
PAYMENTTYPE=instant&ORDERTIME=2006-08-23T16:08:12Z&AMT=14.99&
CURRENCYCODE=USD&FEEAMT=0.00&TAXAMT=0.00&PAYMENTSTATUS=Completed&
PENDINGREASON=None&REASONCODE=None
Janvier 2008
Guide de développement et référence de l’API NVP
3
API Paiements récurrents
Les paiements récurrents vous permettent de facturer à un client un montant fixe à intervalle
fixe. L'acheteur s'abonne pour un paiement récurrent lors de la procédure de paiement sur
votre site. Voici deux exemples :
z
Un acheteur s'abonne à une revue ou à une lettre d'informations sur votre site et accepte de
payer un abonnement mensuel.
z
Un acheteur accepte de payer à un fournisseur d'accès à Internet un tarif forfaitaire en deux
échéances annuelles pour l'hébergement d'un site Web.
Ces exemples représentent des transactions de paiement qui se reproduisent périodiquement
pour un montant fixe.
Pour en savoir plus, consultez le Guide d'intégration de Paiement express PayPal.
Pour en savoir plus sur les API, consultez le paragraphe « Paiements récurrents et transactions
de référence » page 79.
Guide de développement et référence de l’API NVP
Janvier 2008
35
API Paiements récurrents
36
Janvier 2008
Guide de développement et référence de l’API NVP
4
Fonctions de gestion
Cette section présente des exemples des fonctions suivantes :
z
« Collecter, Autoriser, Annuler et Demander une nouvelle autorisation » page 37
z
« Effectuer un remboursement à l'aide de RefundTransaction » page 39
z
« Rechercher une transaction à l'aide de TransactionSearch » page 40
z
« Visualiser les détails d'une seule transaction à l'aide de GetTransactionDetails » page 41
Collecter, Autoriser, Annuler et Demander une nouvelle
autorisation
Quatre API se rapportent à la fonction Autorisation et collecte :
z
DoCapture
z
DoAuthorization
z
DoVoid
z
DoReauthorization
Effectuer une collecte unique avec DoCapture
Pour effectuer une collecte unique, vous devez définir le numéro d'identification de
l'autorisation et le montant sur DoCapture.
IMPO RTANT : Effectuer la
collecte une seule fois est la valeur par défaut. Par souci de
précision, vous pouvez également définir COMPLETETYPE=Complete.
COMPLETETYPE=Complete clôture toutes les autorisations en cours de la
commande. Vous ne pouvez plus effectuer de collecte.
TABLEAU 4.1 Collecter l'intégralité du montant d'une autorisation
Requête
[parametresDeSecuriteObligatoires]&METHOD=DoCapture&AUTHORIZATIONID=01987219673867
&AMT=99.12&COMPLETETYPE=Complete
Guide de développement et référence de l’API NVP
Janvier 2008
37
Fonctions de gestion
Effectuer plusieurs collectes partielles avec DoCapture
[champsReponseReussie]&AUTHORIZATIONID=01987219673867
&TRANSACTIONID=7JZ9679864YA2699519&PARENTTRANSACTIONID=01987219673867
&RECEIPTID=5151-0525-2028-5336&TRANSACTIONTYPE=express-checkout
&PAYMENTTYPE=instant&ORDERTIME=2006-08-15T17:31:38Z&AMT=99.12
&CURRENCYCODE=USD&FEEAMT=3.29&TAXAMT=0.00&PAYMENTSTATUS=Completed
&PENDINGREASON=None&REASONCODE=None
Réponse
Effectuer plusieurs collectes partielles avec DoCapture
Vous pouvez collecter une partie du montant d'une autorisation en définissant
COMPLETETYPE=NotComplete
Lors de la collecte finale, définissez COMPLETETYPE=Complete ou omettez COMPLETETYPE.
Cet exemple illustre trois collectes :
z
Les deux premières collectes sont partielles. La valeur deCOMPLETETYPE est NotComplete
z
Le dernière collecte est effectuée pour l'intégralité du montant restant. La valeur de
COMPLETETYPE est Complete.
TABLEAU 4.2 Collecter une partie du montant d'une autorisation
38
Première requête de
collecte partielle
[parametresDeSecuriteObligatoires]&METHOD=DoCapture
&AUTHORIZATIONID=4EL6476506322203&AMT=112.00&COMPLETETYPE=NotComplete
Réponse
[champsReponseReussie]&AUTHORIZATIONID=4EL6476506322203
&TRANSACTIONID=4Y117666R06578920&PARENTTRANSACTIONID=4EL6476506322203
&RECEIPTID=5151-0525-2028-5336&TRANSACTIONTYPE=webaccept
&PAYMENTTYPE=instant&ORDERTIME=2006-08-15T17:23:15Z&AMT=112.00
&CURRENCYCODE=USD&FEEAMT=3.55&TAXAMT=0.00&PAYMENTSTATUS=Completed
&PENDINGREASON=None&REASONCODE=None
Deuxième requête
de collecte partielle
[parametresDeSecuriteObligatoires]&METHOD=DoCapture
&AUTHORIZATIONID=4EL6476506322203&AMT=103.12&COMPLETETYPE=NotComplete
Réponse
[champsReponseReussie]&AUTHORIZATIONID=4EL6476506322203
&TRANSACTIONID=7JY48864YA2699519&PARENTTRANSACTIONID=4EL6476506322203
&RECEIPTID=5151-0525-2028-5336&TRANSACTIONTYPE=webaccept
&PAYMENTTYPE=instant&ORDERTIME=2006-08-15T17:31:38Z&AMT=103.12
&CURRENCYCODE=USD&FEEAMT=3.29&TAXAMT=0.00&PAYMENTSTATUS=Completed
&PENDINGREASON=None&REASONCODE=None
Requête de collecte
finale
[parametresDeSecuriteObligatoires]&METHOD=DoCapture
&AUTHORIZATIONID=4EL6476506322203
&AMT=103.12&COMPLETETYPE=Complete
Janvier 2008
Guide de développement et référence de l’API NVP
Fonctions de gestion
Insérer un numéro de facture et une remarque lors de la collecte à l'aide de DoCapture
Réponse
[champsReponseReussie]&AUTHORIZATIONID=4EL6476506322203
&TRANSACTIONID=7JZ89864YA2699519&PARENTTRANSACTIONID=4EL6476506322203
&RECEIPTID=5151-0525-2028-5336&TRANSACTIONTYPE=webaccept
&PAYMENTTYPE=instant&ORDERTIME=2006-08-15T17:31:38Z&AMT=90.80
&CURRENCYCODE=USD&FEEAMT=3.29&TAXAMT=0.00&PAYMENTSTATUS=Completed
&PENDINGREASON=None&REASONCODE=None
Insérer un numéro de facture et une remarque lors de la collecte
à l'aide de DoCapture
Que la collecte soit effectuée pour un montant intégral ou partiel, vous avez la possibilité
d'insérer une remarque sur la collecte ainsi que votre propre numéro de facture ou tout autre
numéro d'identification.
TABLEAU 4.3 Inclure un numéro de facture et une remarque lors de la collecte
Requête
[parametresDeSecuriteObligatoires]&METHOD=DoCapture
&AUTHORIZATIONID=4EL6476506322203
&COMPLETETYPE=Complete&AMT=304.92&INVNUM=H091234&NOTE=UPS+trk#+b86283978
Réponse
[champsReponseReussie]&AUTHORIZATIONID=4EL6476506322203
&TRANSACTIONID=7JZ89864YA2694419&PARENTTRANSACTIONID=4EL6476506322203
&RECEIPTID=5151-0525-2028-5336&TRANSACTIONTYPE=webaccept
&PAYMENTTYPE=instant&ORDERTIME=2006-08-15T17:31:38Z&AMT=304.92
&CURRENCYCODE=USD&FEEAMT=3.29&TAXAMT=0.00&PAYMENTSTATUS=Completed
&PENDINGREASON=None&REASONCODE=None
Effectuer un remboursement à l'aide de RefundTransaction
Grâce à RefundTransaction, vous pouvez effectuer un remboursement du montant intégral
ou d'un montant partiel d'une transaction. Spécifiez le numéro de la transaction initiale et le
type de remboursement : Intégral ou Partiel.
R E M A R Q U E : Si
vous ne disposez pas du numéro de la transaction pour le remboursement,
vous pouvez créditer le compte du client sans ce numéro en utilisant l'API
DoNonReferencedCredit. Vous devez obtenir l'accord de PayPal pour
utiliser l'API DoNonReferencedCredit. Pour plus d'informations, contactez
votre gestionnaire de compte PayPal.
Guide de développement et référence de l’API NVP
Janvier 2008
39
Fonctions de gestion
Rechercher une transaction à l'aide de TransactionSearch
Remboursement intégral
IMPO RTANT : Si vous désirez rembourser le montant dans son intégralité, n'assignez pas de
valeur au champ AMT.
TABLEAU 4.4 Rembourser le montant intégral de la transaction
Requête
[parametresDeSecuriteObligatoires]&METHOD=RefundTransaction&
TRANSACTIONID=019454569673867&REFUNDTYPE=Full
Réponse
[champsReponseReussie]&REFUNDTRANSACTIONID=4RP55200GJ177180N
&FEEREFUNDAMT=4.01&GROSSREFUNDAMT=127.87&NETREFUNDAMT=123.86
Remboursements partiels
Pour effectuer un remboursement partiel, assignez à REFUNDTYPE la valeur Partiel et
définissez AMT.
TABLEAU 4.5 Rembourser une partie du montant
Requête
[parametresDeSecuriteObligatoires]&METHOD=RefundTransaction
&TRANSACTIONID=9CX07910UV614511L&REFUNDTYPE=Partial&AMT=12.95
Réponse
[champsReponseReussie]&REFUNDTRANSACTIONID=1H0011898K637700R
&FEEREFUNDAMT=0.38&GROSSREFUNDAMT=12.95&NETREFUNDAMT=12.57
Insérer une remarque lors du remboursement
Que le remboursement soit intégral ou partiel, vous avez également la possibilité d'insérer une
remarque à son sujet.
TABLEAU 4.6 Insérer une remarque lors du remboursement
Requête
[parametresDeSecuriteObligatoires]&METHOD=RefundTransaction&
TRANSACTIONID=019454569673867&REFUNDTYPE=Partial&AMT=12.95&
NOTE=Customer+changed+mind.
Réponse
[champsReponseReussie]&REFUNDTRANSACTIONID=1H0011898K637700R
&FEEREFUNDAMT=0.38&GROSSREFUNDAMT=12.95&NETREFUNDAMT=12.57
Rechercher une transaction à l'aide de TransactionSearch
Pour trouver toutes les transactions effectuées à une date particulière, utilisez
TransactionSearch et saisissez la date de votre choix dans le champ STARTDATE. La date
doit obligatoirement être au format UTC/GMT.
40
Janvier 2008
Guide de développement et référence de l’API NVP
Fonctions de gestion
Visualiser les détails d'une seule transaction à l'aide de GetTransactionDetails
.
TABLEAU 4.7 Rechercher des transactions par STARTDATE
Requête
[parametresDeSecuriteObligatoires]&METHOD=TransactionSearch
&STARTDATE=2006-08-15T17:00:00Z
Réponse
[champsReponseReussie]&L_TIMESTAMP0=2006-08-18T05:58:41Z&
L_TIMEZONE0=GMT&L_TYPE0=Authorization&L_NAME0=Jean+Dupont&
L_TRANSACTIONID0=3XK029742B016373C&L_STATUS0=Pending&L_AMT0=1.00&
L_TIMESTAMP1=2006-08-18T05:56:20Z&L_TIMEZONE1=GMT&L_TYPE1=Payment&
L_NAME1=Jean+Dupont&L_TRANSACTIONID1=4BV19600WF261673U&L_STATUS1=Completed
&L_AMT1=1.00&L_FEEAMT1=-0.33&L_NETAMT1=0.67&
L_TIMESTAMP2=2006-08-18T05:53:22Z&L_TIMEZONE2=GMT&L_TYPE2=Payment
&L_NAME2=Jean+Dupont&L_TRANSACTIONID2=6XB50622KC566325C&L_STATUS2=Completed
&L_AMT2=1.00&L_FEEAMT2=-0.33&L_NETAMT2=0.67&
L_TIMESTAMP3=2006-08-18T05:38:04Z&L_TIMEZONE3=GMT
&L_TYPE3=Payment&L_NAME3=Jean+Dupont&L_TRANSACTIONID3=80774637LP956560E&
L_STATUS3=Completed&L_AMT3=1.00&L_FEEAMT3-0.33&L_NETAMT3=0.67&
L_TIMESTAMP4=2006-08-17T03:02:44Z&L_TIMEZONE4=GMT&L_TYPE4=Payment&
L_NAME4=Anne+Bailly-Marchand&L_TRANSACTIONID4=8G40321568512733L&
L_STATUS4=Completed&L_AMT4=104.00&L_FEEAMT4=-3.32&L_NETAMT4=100.68
TransactionSearch renvoie un tableau multi-valeurs de toutes les transactions correspondant
aux critères de recherche. Chaque transaction débute par sa date : L_TIMESTAMPn, où n
commence par 0 et augmente d'une unité pour chaque transaction.
Visualiser les détails d'une seule transaction à l'aide de
GetTransactionDetails
Pour visualiser tous les détails d'une seule transaction, utiliser GetTransactionDetails.
TABLEAU 4.8 Visualiser les détails d'une transaction
Requête
[parametresDeSecuriteObligatoires]&METHOD=GetTransactionDetails
&TRANSACTIONID=3B288546P5019992D
Réponse
[champsReponseReussie]&RECEIVERBUSINESS=Jims+Hardware
&RECEIVEREMAIL=jim@hardwareplace.com&RECEIVERID=WNSJNN89XVWFA
&PAYERID=B3KS3VFYNG9SN&PAYERSTATUS=unverified&FIRSTNAME=Pierre&
LASTNAME=Durand&COUNTRYCODE=FR&SHIPTOSTATE=&ADDRESSID=PayPal&ADDRESSSTATUS=Non
e
&TRANSACTIONID=3B288546P5019992D&RECEIPTID=3596-6202-14612615
&TRANSACTIONTYPE=webaccept&PAYMENTTYPE=instant&
ORDERTIME=2006-08-15T17:00:00Z&AMT=127.87&CURRENCYCODE=USD&FEEAMT=4.01
&TAXAMT=0.00&PENDINGREASON=None&REASONCODE=None&SALESTAX=0.00&L_QTY0=1
Guide de développement et référence de l’API NVP
Janvier 2008
41
Fonctions de gestion
Visualiser les détails d'une seule transaction à l'aide de GetTransactionDetails
42
Janvier 2008
Guide de développement et référence de l’API NVP
A
Liste de référence des méthodes
et des champs de l'API NVP
Caractéristiques générales des requêtes et des paramètres
Paramètres
La chaîne des paramètres d'une requête obéit à la syntaxe des composants d'une demande
définie dans l'Uniform Resource Identifier (URI) : syntaxe générique. Les noms et les valeurs des
paramètres peuvent être soit en lettres majuscules, soit en lettres minuscules. Par souci de clarté,
nous utiliserons ici des majuscules. Toutes les valeurs doivent être codées au format URL.
Champs multi-valeurs
Les champs acceptant des valeurs multiples ont des noms tels que :
L_NOMDUCHAMPn
où L_ est littéral, NOMDUCHAMP est le nom du paramètre et n est l’indice, qui commence à 0
et s’incrémente d'une unité pour chaque valeur du champ. Les indices doivent être séquentiels.
Par exemple, dans le cas d'une commande d'objets multiples, il vous est possible d'ajouter un
coût d'objet pour chaque objet à l'aide du paramètre L_AMTn :
L_AMT0=4.95&L_AMT1=6.72&L_AMT2=7.95
Devises acceptées par PayPal
Les devises suivantes sont acceptées par PayPal.
TABLEAU A.1 Devises acceptées par PayPal et codes de devises pour les transactions
Code ISO4217
Devise
AUD
Dollar australien
CAD
Dollar canadien
CHF
Franc suisse
CZK
Couronne tchèque
DKK
Couronne danoise
EUR
Euro
GBP
Livre sterling
Guide de développement et référence de l’API NVP
Janvier 2008
43
Liste de référence des méthodes et des champs de l'API NVP
Paiement express PayPal
TABLEAU A.1 Devises acceptées par PayPal et codes de devises pour les transactions
Code ISO4217
Devise
HKD
Dollar de Hong-Kong
HUF
Forint hongrois
JPY
Yen japonais
NOK
Couronne norvégienne
NZD
Dollar néo-zélandais
PLN
Zloty polonais
SEK
Couronne suédoise
SGD
Dollar de Singapour
USD
Dollar américain
Paiement express PayPal
Requête SetExpressCheckout
TABLEAU A.2
Paramètres de la requête SetExpressCheckout
Paramètre
Description
Requis
METHOD
Nom de l'API : SetExpressCheckout
Oui
RETURNURL
URL vers laquelle le navigateur du client est renvoyé après avoir choisi de
payer avec PayPal.
Oui
R E M A R Q U E : PayPal recommande que la valeur corresponde à la page
de vérification finale sur laquelle le client confirme la
commande et le paiement ou l'autorisation de facturation.
Longueur maximale : pas de limite.
CANCELURL
URL vers laquelle le client est renvoyé s'il n'approuve pas l'utilisation de
PayPal pour vous payer.
Oui
R E M A R Q U E : PayPal recommande que la valeur corresponde à la page
initiale sur laquelle le client a choisi de payer avec PayPal
ou d'établir une autorisation de facturation.
Longueur maximale : pas de limite.
44
Janvier 2008
Guide de développement et référence de l’API NVP
Liste de référence des méthodes et des champs de l'API NVP
Paiement express PayPal
TABLEAU A.2
Paramètres de la requête SetExpressCheckout (suite)
Paramètre
Description
Requis
AMT
Coût total de la transaction pour le client. Si vous connaissez les frais
d'expédition, de livraison et de TVA, incluez-les dans cette valeur; sinon,
cette valeur doit correspondre au sous-total actuel de la commande.
Si la transaction inclut un ou plusieurs achats ponctuels, ce champ doit
être égal à la somme des achats. Si la transaction ne comporte aucun achat
ponctuel, ce champ peut être défini à 0.
Limites : Ne doit pas excéder $10 000 USD dans aucune devise. Pas de
symbole de devise. Doit comporter deux positions décimales, le
séparateur décimal doit être une virgule (,) et le séparateur des milliers
facultatif doit être un point (.).
Oui
CURRENCYCODE
Code de devise à trois caractères correspondant à l'une des devises
répertoriées dans Devises de transaction acceptées par PayPal. Par défaut :
USD.
Non
MAXAMT
Montant total maximum prévu de la commande complète, y compris frais
d'expédition, de livraison et de TVA.
Si la transaction ne comporte aucun achat ponctuel, ce champ est ignoré.
Limites : Ne doit pas excéder $10 000 USD dans aucune devise. Pas de
symbole de devise. Doit comporter deux positions décimales, le
séparateur décimal doit être une virgule (,) et le séparateur des milliers
facultatif doit être un point (.).
Non
PAYMENTACTION
Mode d'obtention du paiement :
z Sale indique qu'il s'agit d'une vente finale pour laquelle vous
demandez un paiement.
z Authorization indique que ce paiement est une autorisation de
base qui sera traitée par Autorisation et collecte.
z Order indique que ce paiement est une autorisation de commande qui
sera traitée par la fonction Autorisation et collectede PayPal.
Si la transaction ne comporte aucun achat ponctuel, ce champ est ignoré.
Non
R E M A R Q U E : Vous ne pouvez pas définir cette valeur sur Sale dans la
requête SetExpressCheckout, puis la définir sur
Authorization ou Order dans la requête
DoExpressCheckoutPayment de l'API finale. Mais si
la variable est définie à Authorization ou Order dans
SetExpressCheckout, elle peut l'être à Sale ou à la
même valeur (Authorization ou Order) dans
DoExpressCheckoutPayment.
Nombre de caractères limite : jusqu'à 13 caractères alphabétiques d'un octet.
Valeur par défaut : Sale
EMAIL
Adresse email de l'acheteur saisie lors du paiement. PayPal utilise cette
valeur pour pré-remplir la partie réservée à l'inscription pour l'adhésion à
PayPal de la page de connexion PayPal.
Nombre de caractères limite : 127 caractères alphanumériques d'un octet.
Guide de développement et référence de l’API NVP
Janvier 2008
Non
45
Liste de référence des méthodes et des champs de l'API NVP
Paiement express PayPal
TABLEAU A.2
Paramètres de la requête SetExpressCheckout (suite)
Paramètre
Description
Requis
DESC
Description des objets achetés par le client.
Longueur maximale : 127 caractères alphanumériques d'un octet.
Non
CUSTOM
Champ à structure non imposée que vous utilisez librement, par exemple
un numéro de suivi ou toute autre valeur que vous souhaitez que PayPal
renvoie dans la réponse GetExpressCheckoutDetails et la réponse
DoExpressCheckoutPayment.
Longueur maximale : 256 caractères alphanumériques d'un octet.
Non
INVNUM
Votre numéro de facture ou de suivi personnel. PayPal vous renvoie cette
valeur dans la réponse DoExpressCheckoutPayment.
Si la transaction ne comporte aucun achat ponctuel, ce champ est ignoré.
Longueur maximale : 127 caractères alphanumériques d'un octet.
Non
REQCONFIRMSHIPPING
La valeur 1 indique que vous demandez que l'adresse de livraison du
client enregistrée chez PayPal soit une adresse confirmée.
Non
R E M A R Q U E : Si vous définissez ce champ, le paramètre que vous avez
indiqué dans vos Préférences de compte marchand est
remplacé.
Longueur maximale : un caractère numérique d'un octet.
Valeurs autorisées : 0, 1
Par défaut : 0
46
NOSHIPPING
La valeur 1 indique qu'aucun champ d'adresse de livraison ne doit
apparaître sur les pages de PayPal.
Longueur maximale : un caractère numérique d'un octet.
Valeurs autorisées : 0, 1
Par défaut : 0
Non
ADDROVERRIDE
La valeur 1 indique que les pages de PayPal doivent afficher l'adresse de
livraison que vous avez définie dans la requête SetExpressCheckout,
et non celle enregistrée chez PayPal pour ce client.
Le fait d'afficher l'adresse postale enregistrée chez PayPal ne permet pas
au client de modifier cette adresse.
Longueur maximale : un caractère numérique d'un octet.
Valeurs autorisées : 0, 1
Par défaut : 0
Non
Janvier 2008
Guide de développement et référence de l’API NVP
Liste de référence des méthodes et des champs de l'API NVP
Paiement express PayPal
TABLEAU A.2
Paramètres de la requête SetExpressCheckout (suite)
Paramètre
Description
Requis
TOKEN
Jeton horodaté par lequel vous indiquez à PayPal que vous traitez ce
paiement avec la fonction Paiement express PayPal.
Non
R E M A R Q U E : Le jeton expire au bout de trois heures.
Si vous avez défini le jeton dans la requête SetExpressCheckout, sa
valeur dans la réponse est identique à celle de la requête.
Longueur maximale : 20 caractères d'un octet.
Valeurs autorisées : Consultez la description de JETON au Tableau A.4,
« Champs de la réponse SetExpressCheckout ».
LOCALECODE
Paramètre régional des pages affichées par PayPal pendant la procédure
de Paiement express PayPal.
Longueur maximale : N'importe quel code pays de deux caractères.
Les codes pays de deux caractères suivants sont pris en charge par
PayPal :
z AU
z DE
z FR
z IT
z GB
z ES
z US
Toute autre valeur sera remplacée par défaut par US.
Non
R E M A R Q U E : Pour consulter la liste des codes pays, reportez-vous à
l’Annexe G, « Codes pays ».
PAGESTYLE
Détermine le style personnalisé des pages de paiement associées à ce
bouton/lien. Cette valeur correspond à la variable HTML page_style qui
permet de personnaliser ces pages. La valeur est identique au nom du style
choisi lors de l'ajout ou de la modification du style de page du sous-onglet
Préférences de l'onglet Mon compte sur le site PayPal.
Longueur maximale : 30 caractères alphabétiques d'un octet.
Non
HDRIMG
URL de l'image que vous souhaitez voir apparaître dans la partie
supérieure gauche de la page de paiement. La taille maximale de l'image
est de 750 pixels en largeur et de 90 pixels en hauteur. PayPal vous
recommande de fournir une image stockée sur un serveur sécurisé (https).
Si vous ne spécifiez aucune image, c'est le nom de l'entreprise qui est
affiché.
Nombre de caractères limite : 127 caractères alphanumériques d'un octet.
Non
HDRBORDERCOLOR
Définit la couleur de bordure de l'en-tête de la page de paiement. La
bordure est un périmètre de 2 pixels autour de l'espace d'en-tête, qui
dispose d'une taille de 750 pixels de large sur 90 pixels de haut. Par
défaut, elle est noire.
Longueur maximale : code couleur hexadécimal HTML de six caractères
en ASCII.
Non
Guide de développement et référence de l’API NVP
Janvier 2008
47
Liste de référence des méthodes et des champs de l'API NVP
Paiement express PayPal
TABLEAU A.2
Paramètres de la requête SetExpressCheckout (suite)
Paramètre
Description
Requis
HDRBACKCOLOR
Définit la couleur d'arrière-plan de l'en-tête de la page de paiement. Par
défaut, elle est blanche.
Nombre de caractères limite : code couleur hexadécimal HTML de six
caractères en ASCII.
Non
PAYFLOWCOLOR
Définit la couleur d'arrière-plan de la page de paiement. Par défaut, elle
est blanche.
Nombre de caractères limite : code couleur hexadécimal HTML de six
caractères en ASCII.
Non
CHANNELTYPE
Type de canal :
z Merchant : vendeur non enchères
z eBayItem : enchère eBay
Si la transaction ne comporte aucun achat ponctuel, ce champ est ignoré.
Non
SOLUTIONTYPE
Type de procédure de paiement :
z Sole : Paiement express PayPal pour les enchères
z Mark : Paiement express PayPal normal
Si la transaction ne comporte aucun achat ponctuel, ce champ est ignoré.
Non
GIROPAYSUCCESS
URL
L'URL du site du marchand vers laquelle le client doit être redirigé après
un paiement giropay réussi.
N'utilisez ce champ que si vous utilisez giropay ou un paiement par
virement bancaire en Allemagne.
Non
GIROPAYCANCELURL
URL du site marchand vers laquelle le client doit être redirigé après
l'annulation ou l'échec d'un paiement par giropay ou par virement
bancaire.
N'utilisez ce champ que si vous utilisez giropay ou un paiement par
virement bancaire en Allemagne.
Non
BANKTXNPENDING
URL
L'URL du site du marchand vers laquelle le client doit être redirigé après
un paiement par virement bancaire.
N'utilisez ce champ que si vous utilisez giropay ou un paiement par
virement bancaire en Allemagne.
Non
L_BILLINGTYPEn
Type d'autorisation de facturation.
Pour les paiements récurrents, ce champ est requis et doit être défini à
RecurringPayments.
Voir la
description
L_BILLING
AGREEMENT
DESCRIPTIONn
Description des biens ou des services associés à l'autorisation de
facturation.
PayPal recommande d'indiquer un résumé succinct des conditions
générales de l'autorisation de facturation.
Non
L_CUSTOMn
Champ d'annotation personnalisé que vous utilisez librement.
Non
R E M A R Q U E : Ce champ est ignoré pour les paiements récurrents.
48
Janvier 2008
Guide de développement et référence de l’API NVP
Liste de référence des méthodes et des champs de l'API NVP
Paiement express PayPal
TABLEAU A.2
Paramètres de la requête SetExpressCheckout (suite)
Paramètre
Description
Requis
L_PAYMENTTYPEn
Spécifie le type de paiement PayPal que vous exigez pour l'autorisation de
facturation, parmi les valeurs suivantes :
z Any
z InstantOnly
Non
R E M A R Q U E : Ce champ est ignoré pour les paiements récurrents.
Reportez-vous au
Tableau A.3 page 49.
Adresse de livraison facultative. Les paramètres de l'adresse de livraison
facultative sont décrits dans Tableau A.3, « Adresse de livraison
(facultatif) »».
Non
I M P O R T A N T : L'adresse de livraison est facultative mais si vous
l'incluez, certains champs doivent être saisis.
TABLEAU A.3
Adresse de livraison (facultatif)
Paramètre
Description
Requis
SHIPTONAME
Nom de la personne associée à cette adresse de livraison.
Longueur maximale : 32 caractères d'un octet.
Oui
SHIPTOSTREET
Première adresse postale.
Longueur maximale : 100 caractères d'un octet.
Oui
SHIPTOCITY
Nom de la ville.
Longueur maximale : 40 caractères d'un octet.
Oui
SHIPTOSTATE
Etat ou province.
Longueur maximale : 40 caractères d'un octet.
Requis pour les adresses américaines (USA) seulement.
Non
SHIPTOCOUNTRYCODE
Code pays.
Nombre de caractères : deux caractères d'un octet.
Pour consulter la liste des codes pays, reportez-vous à l’Annexe G,
« Codes pays ».
Oui
SHIPTOZIP
Code postal américain ou code postal spécifique aux autres pays.
Longueur maximale : 20 caractères d'un octet.
Oui
SHIPTOSTREET2
Seconde adresse postale.
Longueur maximale : 100 caractères d'un octet.
Non
PHONENUM
Numéro de téléphone.
Nombre de caractères limite : 20 caractères d'un octet.
Non
Guide de développement et référence de l’API NVP
Janvier 2008
49
Liste de référence des méthodes et des champs de l'API NVP
Paiement express PayPal
Réponse SetExpressCheckout
TABLEAU A.4
Champs de la réponse SetExpressCheckout
Paramètre
Description
TOKEN
Jeton horodaté par lequel vous indiquez à PayPal que vous traitez ce paiement avec la
fonction Paiement express PayPal.
R E M A R Q U E : Le jeton expire au bout de trois heures.
Si vous avez défini le jeton dans la requête SetExpressCheckout, sa valeur dans la
réponse est identique à celle de la requête.
Longueur maximale : 20 caractères d'un octet.
Rediriger le navigateur du client vers la page de connexion PayPal
Lorsque vous avez reçu une réponse de SetExpressCheckout, ajoutez la valeur de l'élément
TOKEN de SetExpressCheckout sous forme de paire nom-valeur à l'URL suivante et
redirigez-y le navigateur de votre client :
https://www.paypal.com/cgi-bin/webscr?cmd=_express-checkout&
token=value_from_SetExpressCheckoutResponse
PayPal vous recommande d'utiliser la réponse HTTPS 302 « Objet déplacé » avec l'URL cidessus comme valeur de l'en-tête Location dans la réponse HTTPS pour rediriger le navigateur
d'un client vers sa page de connexion. Si votre serveur utilise le protocole SSL, évitez que le
navigateur ne reçoive des avertissements à propos d'un mélange d'images sécurisées et non
sécurisées.
Requête GetExpressCheckoutDetails
TABLEAU A.5
50
Paramètres de GetExpressCheckoutDetails
Paramètre
Description
Requis ?
METHOD
Nom de l'API : GetExpressCheckoutDetails
Oui
TOKEN
Jeton horodaté dont la valeur a été renvoyée par la réponse
SetExpressCheckout.
Longueur maximale : 20 caractères d'un octet.
Valeurs autorisées : Jeton non expiré
Oui
Janvier 2008
Guide de développement et référence de l’API NVP
Liste de référence des méthodes et des champs de l'API NVP
Paiement express PayPal
Réponse GetExpressCheckoutDetails
TABLEAU A.6
Champs de la réponse GetExpressCheckoutDetails
Champ
Description
TOKEN
Valeur du jeton horodaté qui a été renvoyée par la réponse SetExpressCheckout et
transmise dans la requête GetExpressCheckoutDetails.
Longueur maximale : 20 caractères d'un octet.
Valeurs possibles : Consultez la description de JETON dans Tableau A.4, « Champs
de la réponse SetExpressCheckout ».
EMAIL
Adresse email du payeur.
Longueur maximale : 127 caractères d'un octet.
PAYERID
Numéro de compte unique du client PayPal.
Nombre de caractères limite:13 caractères alphanumériques d'un octet.
PAYERSTATUS
Etat du payeur. Les valeurs possibles sont les suivantes :
z verified
z unverified
Nombre de caractères limite : 10 caractères alphabétiques d'un octet.
Valeurs possibles : verified, unverified
SALUTATION
Formule d'appel du payeur.
Longueur maximale : 20 caractères d'un octet.
FIRSTNAME
Prénom du payeur.
Longueur maximale : 25 caractères d'un octet.
MIDDLENAME
Deuxième prénom du payeur.
Longueur maximale : 25 caractères d'un octet.
LASTNAME
Nom du payeur.
Longueur maximale : 25 caractères d'un octet.
SUFFIX
Suffixe du payeur.
Longueur maximale : 12 caractères d'un octet.
COUNTRYCODE
Pays de résidence du payeur sous forme de code pays ISO 3166 à deux caractères.
Longueur maximale : deux caractères d'un octet.
Pour consulter la liste des codes pays, reportez-vous à l’Annexe G, « Codes pays ».
BUSINESS
Raison sociale du payeur.
Longueur maximale : 127 caractères d'un octet.
SHIPTONAME
Nom de la personne associée à cette adresse.
Longueur maximale : 32 caractères d'un octet.
SHIPTOSTREET
Première adresse postale.
Longueur maximale : 100 caractères d'un octet.
Guide de développement et référence de l’API NVP
Janvier 2008
51
Liste de référence des méthodes et des champs de l'API NVP
Paiement express PayPal
TABLEAU A.6
Champs de la réponse GetExpressCheckoutDetails(suite)
Champ
Description
SHIPTOSTREET2
Seconde adresse postale.
Longueur maximale : 100 caractères d'un octet.
SHIPTOCITY
Nom de la ville.
Longueur maximale : 40 caractères d'un octet.
SHIPTOSTATE
Etat ou province.
Longueur maximale : 40 caractères d'un octet.
SHIPTOCOUNTRYCODE
Code pays.
Nombre de caractères : deux caractères d'un octet.
Pour consulter la liste des codes pays, reportez-vous à l’Annexe G, « Codes pays ».
SHIPTOZIP
Code postal américain ou code postal spécifique aux autres pays.
Longueur maximale : 20 caractères d'un octet.
ADDRESSSTATUS
Etat de l'adresse postale enregistrée chez PayPal
CUSTOM
Champ à structure non imposée que vous utilisez librement et défini par vos soins dans
l'élément Custom de la requête SetExpressCheckout.
Longueur maximale : 256 caractères alphanumériques d'un octet.
INVNUM
Votre numéro de facture ou de suivi personnel, défini par vos soins dans l'élément du
même nom dans la requête SetExpressCheckout.
Longueur maximale : 127 caractères alphanumériques d'un octet.
PHONENUM
Numéro de téléphone à contacter du payeur.
R E M A R Q U E : PayPal renvoie ce type de numéro uniquement si les paramètres de vos
Préférences de compte marchand nécessitent que l'acheteur en saisisse un.
Longueur maximale : le masque du champ est XXX-XXX-XXXX (pour les numéros
aux Etats-Unis) ou +XXX XXXXXXXX (pour les autres numéros)
REDIRECTREQUIRED
Drapeau indiquant si vous devez rediriger le client vers PayPal lorsque la transaction est
terminée.
R E M A R Q U E : N'utilisez ce champ que si vous utilisez giropay ou un paiement par
virement bancaire en Allemagne.
Requête DoExpressCheckoutPayment
Requête pour obtenir le paiement via la fonction Paiement express PayPal.
IMPO RTANT : PayPal
exige qu'un vendeur utilisant Paiement express PayPal affiche pour
le client un montant identique à celui qu'il envoie à PayPal dans le paramètre
AMT avec la requête API DoExpressCheckoutPayment.
52
Janvier 2008
Guide de développement et référence de l’API NVP
Liste de référence des méthodes et des champs de l'API NVP
Paiement express PayPal
TABLEAU A.7
Paramètres DoExpressCheckoutPayment
Paramètre
Description
Requis ?
METHOD
Nom de l'API : DoExpressCheckoutPayment
Oui
TOKEN
Valeur du jeton horodaté qui a été renvoyée par la réponse
SetExpressCheckout et transmise dans la requête
GetExpressCheckoutDetails.
Longueur maximale : 20 caractères d'un octet.
Oui
PAYMENTACTION
Mode d'obtention du paiement :
Oui
z Sale indique qu'il s'agit d'une vente finale pour laquelle vous
demandez un paiement.
z Authorization indique que ce paiement est une autorisation de
base qui sera traitée par Autorisation et collecte.
z Order indique que ce paiement est une autorisation de commande
qui sera traitée par la fonction Autorisation et collecte de PayPal.
Si la transaction ne comporte aucun achat ponctuel, ce champ est ignoré.
R E M A R Q U E : Vous ne pouvez pas définir cette valeur sur Sale dans
la requête SetExpressCheckout, puis la définir sur
Authorization ou Order dans la requête
DoExpressCheckoutPayment de l'API finale. Si la
variable est définie à Authorization ou Order dans
SetExpressCheckout, elle peut l'être à Sale ou à la
même valeur (Authorization ou Order) dans
DoExpressCheckoutPayment.
Nombre de caractères : jusqu'à 13 caractères alphabétiques d'un octet.
Valeur par défaut : Sale
Valeurs autorisées :
z Autorisation
z Order
z Sale
Par défaut : La transaction résultant de la requête
DoExpressCheckoutPayment est une vente finale.
PAYERID
Numéro d'identification unique du compte client PayPal renvoyé par
la réponse GetExpressCheckoutDetails.
Longueur maximale : 13 caractères alphanumériques d'un octet.
Oui
AMT
Total de la commande, incluant les frais d'expédition et de livraison, de
dossier et le montant de la TVA.
Oui
R E M A R Q U E : Limites
: Ne doit pas excéder $10 000 USD dans
aucune devise. Pas de symbole de devise. Doit
comporter deux positions décimales, le séparateur
décimal doit être une virgule (,) et le séparateur
des milliers facultatif doit être un point (.).
Guide de développement et référence de l’API NVP
Janvier 2008
53
Liste de référence des méthodes et des champs de l'API NVP
Paiement express PayPal
TABLEAU A.7
Paramètres DoExpressCheckoutPayment (suite)
Paramètre
Description
Requis ?
DESC
Description des objets achetés par le client.
Longueur maximale : 127 caractères alphanumériques d'un octet.
Non
CUSTOM
Champ à structure non imposée que vous utilisez librement.
Longueur maximale : 256 caractères alphanumériques d'un octet.
Non
INVNUM
Votre numéro de facture ou de suivi personnel.
Longueur maximale : 127 caractères alphanumériques d'un octet.
Non
BUTTONSOURCE
Code d'identification permettant aux applications tierces d'identifier
les transactions.
Longueur maximale : 32 caractères alphanumériques d'un octet.
Non
NOTIFYURL
Votre URL pour la réception de la Notification instantanée de
paiement (IPN) concernant cette transaction.
Non
R E M A R Q U E : Si vous ne spécifiez pas cette valeur dans la requête,
c'est l'URL de notification de vos Préférences du
marchand qui est utilisée, s'il en existe une.
Longueur maximale : 2 048 caractères alphanumériques d'un octet.
ITEMAMT
Somme des frais de tous les objets de cette commande.
Limites : Ne doit pas excéder $10 000 USD dans aucune devise. Pas
de symbole de devise. Doit comporter deux positions décimales, le
séparateur décimal doit être une virgule (,) et le séparateur des milliers
facultatif doit être un point (.).
Non
R E M A R Q U E : ITEMAMT est nécessaire si vous spécifiez une valeur
pour L_AMTn.
SHIPPINGAMT
Total des frais d'expédition et de livraison de cette commande.
Non
R E M A R Q U E : Longueur maximale : Ne doit pas excéder $10 000
USD dans aucune devise. Pas de symbole de devise.
Quelle que soit la devise, le séparateur décimal doit
être une virgule (,) et le séparateur des milliers
facultatif un point (.). Equivalent à neuf caractères
maximum pour les USD.
HANDLINGAMT
Total des frais de dossier de cette commande.
Non
R E M A R Q U E : Longueur maximale : Ne doit pas excéder $10 000
USD dans aucune devise. Pas de symbole de devise.
Quelle que soit la devise, le séparateur décimal doit
être une virgule (,) et le séparateur des milliers
facultatif un point (.). Equivalent à neuf caractères
maximum pour les USD.
54
Janvier 2008
Guide de développement et référence de l’API NVP
Liste de référence des méthodes et des champs de l'API NVP
Paiement express PayPal
TABLEAU A.7
Paramètres DoExpressCheckoutPayment (suite)
Paramètre
Description
Requis ?
TAXAMT
Somme des frais de TVA de tous les objets de cette commande.
Non
R E M A R Q U E : Longueur maximale : Ne doit pas excéder $10 000
USD dans aucune devise. Pas de symbole de devise.
Quelle que soit la devise, le séparateur décimal doit
être une virgule (,) et le séparateur des milliers
facultatif un point (.). Equivalent à neuf caractères
maximum pour les USD.
R E M A R Q U E : TAXAMT est nécessaire si vous spécifiez une valeur
pour L_TAXAMTn.
CURRENCYCODE
Un code de devise à trois caractères pour une des devises répertoriées
dans Devises de transaction acceptées par PayPal. Par défaut : USD.
Non
L_NAMEn
Nom de l'objet
Longueur maximale : 127 caractères d'un octet.
Ces paramètres doivent être ordonnés de façon séquentielle en
commençant par 0 (par exemple L_NAME0, L_NAME1).
Non
L_NUMBERn
Numéro de l'objet.
Longueur maximale : 127 caractères d'un octet.
Ces paramètres doivent être ordonnés de façon séquentielle en
commençant par 0 (par exemple L_NUMBER0, L_NUMBER1).
Non
L_QTYn
Quantité d'objets.
Longueur maximale : n'importe quel chiffre entier positif.
Ces paramètres doivent être ordonnés de façon séquentielle en
commençant par 0 (par exemple L_QTY0, L_QTY1.
Non
L_TAXAMTn
TVA concernant l'objet.
Limites : Ne doit pas excéder $10 000 USD dans aucune devise. Pas
de symbole de devise. Doit comporter deux positions décimales, le
séparateur décimal doit être une virgule (,) et le séparateur des milliers
facultatif doit être un point (.).
Ces paramètres doivent être ordonnés de façon séquentielle en
commençant par 0 (par exemple L_TAXAMT0, L_TAXAMT1).
Non
L_AMTn
Coût de l'objet.
Limites : La valeur peut être positive, négative ou égale à zéro et ne
doit pas excéder $10.000 USD dans n'importe quelle devise. Pas de
symbole de devise. Doit comporter deux positions décimales, le
séparateur décimal doit être une virgule (,) et le séparateur des milliers
facultatif doit être un point (.).
Ces paramètres doivent être ordonnés de façon séquentielle en
commençant par 0 (par exemple L_AMT0, L_AMT1).
Non
R E M A R Q U E : Si vous spécifiez une valeur pourL_AMn, vous devez
également en spécifier une pour ITEMAMT.
Guide de développement et référence de l’API NVP
Janvier 2008
55
Liste de référence des méthodes et des champs de l'API NVP
Paiement express PayPal
TABLEAU A.7
Paramètre
Description
Requis ?
L_EBAYITEMNUMBERn
Numéro de l'enchère/de l'objet
Nombre de caractères : 765 caractères d'un octet.
Non
L_EBAYITEMAUCTION
TXNIDn
Numéro de transaction de la vente aux enchères.
Nombre de caractères : 255 caractères d'un octet.
Non
L_EBAYITEMORDERIDn
Numéro de commande de la vente aux enchères
Nombre de caractères : 64 caractères d'un octet.
Non
TABLEAU A.8
56
Paramètres DoExpressCheckoutPayment (suite)
Facultatif Adresse de livraison
Paramètre
Description
Requis ?
SHIPTONAME
Nom de la personne associée à cette adresse.
Longueur maximale : 32 caractères d'un octet.
Oui
SHIPTOSTREET
Première adresse postale.
Longueur maximale : 100 caractères d'un octet.
Oui
SHIPTOCITY
Nom de la ville.
Longueur maximale : 40 caractères d'un octet.
Oui
SHIPTOSTATE
Etat ou province.
Longueur maximale : 40 caractères d'un octet.
Requis pour les adresses américaines (USA) seulement.
Non
SHIPTOCOUNTRYCODE
Code pays.
Nombre de caractères : deux caractères d'un octet.
Pour consulter la liste des codes pays, reportez-vous à l’Annexe G,
« Codes pays ».
Oui
SHIPTOZIP
Code postal américain ou code postal spécifique aux autres pays.
Longueur maximale : 20 caractères d'un octet.
Oui
SHIPTOSTREET2
Seconde adresse postale.
Longueur maximale : 100 caractères d'un octet.
Non
SHIPTOPHONENUM
Numéro de téléphone.
Nombre de caractères limite : 20 caractères d'un octet.
Non
Janvier 2008
Guide de développement et référence de l’API NVP
Liste de référence des méthodes et des champs de l'API NVP
Paiement express PayPal
Réponse DoExpressCheckoutPayment
TABLEAU A.9
Champs de paiement de la réponse DoExpressCheckout
Champ
Description
TOKEN
Valeur du jeton horodaté qui a été renvoyée par la réponse SetExpressCheckout et
transmise dans la requête GetExpressCheckoutDetails.
Nombre de caractères limite : 20 caractères d'un octet.
Valeurs autorisées : Consultez la description de JETON dans Tableau A.4, « Champs de
la réponse SetExpressCheckout ».
TRANSACTIONID
Numéro de transaction unique du paiement.
R E M A R Q U E : Si l'élément PaymentAction de la requête est défini sur
Authorization ou sur Order, cette valeur correspond à votre
AuthorizationID à utiliser avec les API Autorisation et collecte.
Nombre de caractères limite : 19 caractères d'un octet.
Valeurs possibles : Spécifique à la transaction
TRANSACTIONTYPE
Type de transaction
Nombre de caractères limite : 15 caractères d'un octet.
Valeurs possibles :
z cart
z express-checkout
PAYMENTTYPE
Indique si le paiement est immédiat ou différé.
Longueur maximale : 7 caractères d'un octet.
Valeurs possibles :
z none
z echeck
z instant
ORDERTIME
Horodatage du paiement
Valeurs possibles : Spécifique à la transaction
AMT
Montant final facturé, incluant les frais d'expédition, de livraison et de TVA de vos
Préférences du marchand.
Longueur maximale : Ne peut excéder $10 000 USD dans aucune devise. Pas de symbole
de devise. Quelle que soit la devise, le séparateur décimal doit être une virgule (,) et le
séparateur des milliers facultatif un point (.). Equivalent à neuf caractères maximum pour
les USD.
Valeurs possibles : Spécifique à la transaction
CURRENCYCODE
Un code de devise à trois caractères pour une des devises répertoriées dans Devises de
transaction acceptées par PayPal. Par défaut : USD.
Guide de développement et référence de l’API NVP
Janvier 2008
57
Liste de référence des méthodes et des champs de l'API NVP
Paiement express PayPal
TABLEAU A.9
58
Champs de paiement de la réponse DoExpressCheckout
Champ
Description
FEEAMT
Montant de la commission de PayPal facturée pour la transaction
Longueur maximale : Ne peut excéder $10 000 USD dans aucune devise. Pas de symbole
de devise. Quelle que soit la devise, le séparateur décimal doit être une virgule (,) et le
séparateur des milliers facultatif un point (.). Equivalent à neuf caractères maximum pour
les USD.
Valeurs possibles : Spécifique à la transaction
SETTLEAMT
Montant déposé sur votre compte PayPal après conversion de devise.
Valeurs possibles : Spécifique à la transaction
TAXAMT
TVA facturée pour la transaction.
Longueur maximale : Ne peut excéder $10 000 USD dans aucune devise. Pas de symbole
de devise. Quelle que soit la devise, le séparateur décimal doit être une virgule (,) et le
séparateur des milliers facultatif un point (.). Equivalent à neuf caractères maximum pour
les USD.
Valeurs possibles : Spécifique à la transaction
EXCHANGERATE
Taux de change utilisé en cas de conversion de devise. S'applique uniquement si vous
facturez dans une devise secondaire. Si l'utilisateur choisit de payer dans une devise autre
que la devise secondaire, la conversion a lieu sur son compte.
Longueur maximale : une décimale qui ne dépasse pas 17 caractères, y compris la virgule
décimale.
Valeurs possibles : Spécifique à la transaction
PAYMENTSTATUS
Etat du paiement :
Completed : le paiement est terminé et les fonds ont été portés au solde de votre compte.
Pending : le paiement est en attente. Pour plus de détails, reportez-vous à l'élément
PendingReason.
Janvier 2008
Guide de développement et référence de l’API NVP
Liste de référence des méthodes et des champs de l'API NVP
Paiement express PayPal
TABLEAU A.9
Champs de paiement de la réponse DoExpressCheckout
Champ
Description
PENDINGREASON
Motif pour lequel le paiement est en attente :
z none: aucun motif de mise en attente.
z address : le paiement est en attente parce que l'utilisateur n'a pas indiqué d'adresse de
livraison confirmée et que vos préférences de réception de paiements sont configurées
pour que vous puissiez accepter ou refuser manuellement chacun de ces paiements.
Pour modifier ce paramètre, accédez à la section Préférences de vos
Préférences.
z echeck : le paiement est en attente parce qu'il a été effectué par un chèque
électronique qui n'a pas encore été compensé.
z intl : le paiement est en attente parce que vous détenez un compte hors des EtatsUnis et que vous ne disposez pas de système de virement. Vous devez accepter ou
refuser manuellement ce paiement à partir de votre Aperçu du compte.
z multi-currency : vous ne disposez pas de solde dans la devise qui vous a été
envoyée et vos Préférences de réception de paiements ne sont pas
configurées pour convertir automatiquement ce paiement et l'accepter. Vous devez
accepter ou refuser manuellement ce paiement.
z verify : le paiement est en attente parce que vous n'avez pas encore le statut Vérifié.
Vous devez faire vérifier votre compte avant de pouvoir accepter ce paiement.
z other : le paiement est en attente pour une autre raison que celles indiquées ci-dessus.
Pour en savoir plus, contactez le Service clientèle de PayPal.
REASONCODE
Motif d'une annulation si TransactionType a la valeur reversal :
z none: aucun code de motif.
z chargeback : cette transaction a été annulée en raison d'une opposition à un paiement
de la part de votre client.
z guarantee : cette transaction a été annulée car votre client a demandé à faire jouer la
garantie de remboursement.
z buyer-complaint : cette transaction a été annulée car votre client a déposé une
réclamation concernant cette transaction.
z refund : cette transaction a été annulée car vous avez remboursé le client.
z other : cette transaction a été annulée pour un motif autre que celles indiquées cidessus.
REDIRECTREQUIRED
Drapeau indiquant si vous devez rediriger le client vers PayPal lorsque la transaction est
terminée.
R E M A R Q U E : N'utilisez ce champ que si vous utilisez giropay ou un paiement par
virement bancaire en Allemagne.
Guide de développement et référence de l’API NVP
Janvier 2008
59
Liste de référence des méthodes et des champs de l'API NVP
Autorisation et collecte
Autorisation et collecte
DoAuthorization
TABLEAU A.10 Paramètres DoAuthorization
Paramètre
Description
Requis ?
METHOD
Nom de l'API : DoAuthorization
Oui
TRANSACTIONID
Valeur du numéro de transaction de la commande renvoyée par PayPal.
Longueur maximale : 19 caractères d'un octet.
Oui
AMT
Montant à autoriser.
Limites : La valeur est un nombre positif qui ne doit excéder
$10 000 USD dans aucune devise. Pas de symbole de devise. Doit
comporter deux positions décimales, le séparateur décimal doit être une
virgule (,) et le séparateur des milliers facultatif doit être un point (.).
TRANSACTIONENTITY
Type de transaction à autoriser. La seule valeur acceptable est Order, qui
signifie que la transaction représente une commande d'un client qui peut
être honorée au-delà de 29 jours.
Non
CURRENCYCODE
Un code de devise à trois caractères pour une des devises répertoriées
dans Devises de transaction acceptées par PayPal. Par défaut : USD.
Non
TABLEAU A.11 Champs de la réponse DoAuthorization
Champ
Description
TRANSACTIONID
Numéro d'identification d'autorisation.
Nombre de caractères limite : 19 caractères d'un octet.
AMT
Montant spécifié dans la requête.
DoCapture
TABLEAU A.12 Paramètres DoCapture
60
Paramètre
Description
Requis ?
METHOD
Nom de l'API : DoCapture
Oui
AUTHORIZATIONID
Numéro d'autorisation du paiement à collecter. Il s'agit du numéro de
transaction renvoyé par DoExpressCheckoutPayment.
Longueur maximale : 19 caractères d'un octet au maximum.
Oui
Janvier 2008
Guide de développement et référence de l’API NVP
Liste de référence des méthodes et des champs de l'API NVP
Autorisation et collecte
TABLEAU A.12 Paramètres DoCapture
Paramètre
Description
Requis ?
AMT
Montant à collecter.
Limites : La valeur est un nombre positif qui ne doit excéder $10 000 USD
dans aucune devise. Pas de symbole de devise. Doit comporter deux
positions décimales, le séparateur décimal doit être une virgule (,) et le
séparateur des milliers facultatif doit être un point (.).
Oui
CURRENCYCODE
Un code de devise à trois caractères pour une des devises répertoriées dans
Devises de transaction acceptées par PayPal. Par défaut : USD.
Non
COMPLETETYPE
La valeur Complete indique s'il s'agit de la dernière collecte que vous
avez l'intention d'exécuter.
La valeur NotComplete indique que vous avez l'intention d'exécuter des
collectes supplémentaires.
Oui
R E M A R Q U E : Si vous conservez la valeur Complete, tout montant
restant de la transaction initiale autorisée est
automatiquement annulé et toutes les autorisations ouvertes
restantes sont annulées.
Longueur maximale : 12 caractères alphanumériques d'un octet.
INVNUM
Votre numéro de facture ou un autre numéro d'identification affiché pour le
marchand ou le client dans son historique des transactions.
Non
R E M A R Q U E : Cette valeur de DoCapture remplace la valeur
précédemment définie pour DoAuthorization.
R E M A R Q U E : La valeur n'est enregistrée que si l'autorisation que vous
collectez est une autorisation de commande et pas une
autorisation de base.
Longueur maximale : 127 caractères alphanumériques d'un octet.
NOTE
Note d'information sur le règlement concerné, envoyée par email à
l'émetteur du paiement et qui apparaît dans l'historique de ses transactions.
Non
Longueur maximale : 255 caractères d'un octet.
Guide de développement et référence de l’API NVP
Janvier 2008
61
Liste de référence des méthodes et des champs de l'API NVP
Autorisation et collecte
TABLEAU A.12 Paramètres DoCapture
Paramètre
Description
Requis ?
SOFTDESCRIPTOR
Il s'agit d'une description par transaction du paiement, qui apparaîtra sur le
relevé de la carte bancaire du client.
Si une valeur est attribuée au champ softdescriptor, le descripteur complet
tel qu'il apparaît sur le relevé du client se présente sous le format suivant :
Non
<PP * | PAYPAL *><descripteur du marchand tel que défini
dans les Préférences de réception de paiements><1
espace><descripteur softdescriptor>
Le descripteur softdescriptor ne peut contenir que les caractères suivants :
z Caractères alphanumériques
z - (tiret)
z * (astérisque)
z . (point)
z
{espace}
Si vous utilisez un autre caractère (comme “,”), un code d'erreur est
retourné.
Softdescriptor n'inclut pas le numéro de téléphone, qui peut être basculé
entre le numéro du service clientèle du marchand et celui du Service
clientèle PayPal.
La longueur maximale du descripteur softdescriptor est de 22 caractères.
Parmi ceux-ci, 4 ou 8 caractères sont utilisés par le préfixe PayPal
apparaissant dans le format des données. La longueur maximale de ce
descripteur passé dans la requête d'API est donc :
22 - len(<PP * | PAYPAL *>) - len(<descripteur défini dans
les Préférences de réception de paiements> + 1)
Supposons, par exemple, les conditions suivantes :
z Le préfixe PayPal est défini à PAYPAL * dans les outils
d'administration de PayPal
z Le descripteur du marchand défini dans les Préférences de réception de
paiements est défini à EBAY.
z La valeur de SOFTDESCRIPTOR passée est Fleurs et Cie
La chaîne du descripteur qui apparaît sur le relevé de la carte sera :
PAYPAL *EBAY Fleurs et
TABLEAU A.13 Champs de la réponse DoCapture
62
Champ
Description
AUTHORIZATIONID
Numéro d'autorisation spécifié dans la requête.
Longueur maximale : 19 caractères d'un octet.
TRANSACTIONID
Numéro de transaction unique du paiement.
Nombre de caractères limite : 17 caractères d'un octet.
Janvier 2008
Guide de développement et référence de l’API NVP
Liste de référence des méthodes et des champs de l'API NVP
Autorisation et collecte
TABLEAU A.13 Champs de la réponse DoCapture
Champ
Description
PARENTTRANSACTIONID
Numéro de transaction parent ou liée. Ce champ est rempli pour les types de
transaction suivants :
z Annulation. Collecte d'une transaction autorisée.
z Annulation. Nouvelle autorisation d'une transaction.
z Collecte d'une commande. La valeur de ParentTransactionID correspond au
OrderID initial.
z Autorisation d'une commande. La valeur de ParentTransactionID
correspond au OrderID initial.
z Collecte d'une autorisation de commande.
z Annulation d'une commande. La valeur de ParentTransactionID correspond
au OrderID initial.
Longueur maximale : 16 chiffres au format xxxx-xxxx-xxxx-xxxx
RECEIPTID
Numéro d'avis de réception
Longueur maximale : 16 chiffres au format xxxx-xxxx-xxxx-xxxx
TRANSACTIONTYPE
Type de transaction
z cart
z express-checkout
Nombre de caractères limite : 15 caractères d'un octet.
PAYMENTTYPE
Indique si le paiement est immédiat ou différé.
Nombre de caractères limite : sept caractères d'un octet.
ORDERTIME
Horodatage du paiement. Exemple : 2006-08-15T17:23:15Z.
AMT
Montant final facturé, incluant les frais d'expédition, de livraison et de TVA de
vos Préférences du marchand.
FEEAMT
Montant de la commission de PayPal facturée pour la transaction
SETTLEAMT
Montant déposé sur votre compte PayPal en cas de conversion de devise.
TAXAMT
TVA appliquée à la transaction, le cas échéant
EXCHANGERATE
Taux de change utilisé en cas de conversion de devise. S'applique uniquement
si vous facturez dans la devise secondaire de l'utilisateur. Si l'utilisateur choisit
de payer dans une devise autre que la devise secondaire, la conversion a lieu
sur son compte.
Nombre de caractères limite : multiplicateur décimal.
Guide de développement et référence de l’API NVP
Janvier 2008
63
Liste de référence des méthodes et des champs de l'API NVP
Autorisation et collecte
TABLEAU A.13 Champs de la réponse DoCapture
Champ
Description
PAYMENTSTATUS
Etat du paiement.
Etat du paiement :
z None : aucun état
z Canceled-Reversal : indique qu'une contre-opération a été annulée. Par
exemple, un litige avec le client a été réglé en votre faveur et les fonds de la
transaction annulée vous ont été remboursés.
z Completed : le paiement est terminé et les fonds ont été portés au solde de
votre compte.
z Denied : vous avez refusé le paiement. Ne se produit que si le paiement
était précédemment en attente pour l'une des raisons décrites dans l'élément
PendingReason.
z Expired : la durée d'autorisation pour ce paiement a expiré.
z Failed : le paiement a échoué. Ne se produit que si le paiement a été
effectué à partir du compte bancaire de votre client.
z Pending : le paiement est en attente. Pour en savoir plus, reportez-vous au
champ PendingReason.
z Refunded : vous avez remboursé le paiement.
z Reversed : un paiement a été annulé en raison d'un rejet de débit ou d'un
autre type de contre-opération. Les fonds ont été retirés du solde de votre
compte et rendus à l'acheteur. La raison de l'annulation est spécifiée dans
l'élément ReasonCode.
z Processed : un paiement a été accepté.
z Voided : une autorisation accordée pour cette transaction a été annulée.
DoReauthorization
TABLEAU A.14 Paramètres de la requête DoReauthorization
64
Paramètre
Description
Requis ?
METHOD
Nom de l'API : DoReauthorization
Oui
AUTHORIZATIONID
Valeur du numéro d'une transaction préalablement autorisée, renvoyée par
PayPal.
Longueur maximale : 19 caractères d'un octet.
Oui
AMT
Montant de l'autorisation renouvelée.
Limites : La valeur est un nombre positif qui ne doit excéder $10 000 USD
dans aucune devise. Pas de symbole de devise. Doit comporter deux
positions décimales, le séparateur décimal doit être une virgule (,) et le
séparateur des milliers facultatif doit être un point (.).
Oui
Janvier 2008
Guide de développement et référence de l’API NVP
Liste de référence des méthodes et des champs de l'API NVP
Autorisation et collecte
TABLEAU A.14 Paramètres de la requête DoReauthorization
Paramètre
Description
Requis ?
CURRENCYCODE
Un code de devise à trois caractères pour une des devises répertoriées dans
Devises de transaction acceptées par PayPal. Par défaut : USD.
Non
TABLEAU A.15 Champs de la réponse DoReauthorization
Champ
Description
AUTHORIZATIONID
Numéro d'identification d'une autorisation renouvelée.
Nombre de caractères limite :19 caractères d'un octet.
DoVoid
TABLEAU A.16 Paramètres de la requête DoVoid
Paramètre
Description
Requis ?
METHOD
Nom de l'API : DoVoid
Oui
AUTHORIZATIONID
Valeur du numéro d'autorisation initial renvoyée par un produit PayPal.
Oui
I M P O R T A N T : Si vous annulez une transaction qui a fait l'objet d'une
nouvelle autorisation, utilisez le numéro de l'autorisation
initiale, pas celui de la nouvelle autorisation.
Longueur maximale : 19 caractères d'un octet.
NOTE
Note d'information sur cette annulation, envoyée par email à l'émetteur du
paiement et qui apparaît dans l'historique de ses transactions.
Longueur maximale : 255 caractères d'un octet.
Non
TABLEAU A.17 Champs de la réponse DoVoid
Champ
Description
AUTHORIZATIONID
Numéro d'autorisation spécifié dans la requête.
Longueur maximale : 19 caractères d'un octet.
Guide de développement et référence de l’API NVP
Janvier 2008
65
Liste de référence des méthodes et des champs de l'API NVP
RefundTransaction
RefundTransaction
TABLEAU A.18 Paramètres de la requête RefundTransaction
Paramètre
Description
Requis ?
METHOD
Nom de l'appel d’API : RefundTransaction
Oui
TRANSACTIONID
Identifiant unique d'une transaction.
Longueur maximale : 17 caractères alphanumériques d'un octet.
Oui
REFUNDTYPE
Type de remboursement effectué.
z Other
z Full
z Partial
Oui
AMT
Montant du remboursement.
Amount doit être défini si RefundType a la valeur Partial.
Non
R E M A R Q U E : Si RefundType a la valeur Full, il n'est pas nécessaire de
définir Amount.
NOTE
Mémo personnalisé concernant le remboursement.
Longueur maximale : 255 caractères alphanumériques d'un octet.
Non
TABLEAU A.19 Champs de la réponse DoRefund
66
Champ
Description
REFUNDTRANSACTIONID
Numéro de transaction unique du remboursement.
Nombre de caractères limite : 17 caractères d'un octet.
NETREFUNDAMT
Montant soustrait du solde PayPal du destinataire initial du paiement pour
effectuer ce remboursement
FEEREFUNDAMT
Commission sur transaction remboursée au destinataire initial du paiement.
GROSSREFUNDAMT
Somme d'argent remboursée au payeur initial.
Janvier 2008
Guide de développement et référence de l’API NVP
Liste de référence des méthodes et des champs de l'API NVP
TransactionSearch
TransactionSearch
Avec TransactionSearch vous devez toujours définir le champ StartDate. De plus :
z
Lorsqu'elle est définie, la valeur de TransactionID remplace celles de tous les autres
champs (y compris le champ StartDate obligatoire).
z
La définition d'autres éléments s'ajoute à l'existant ou peut modifier les critères de recherche.
TransactionSearch renvoie jusqu'à 100 correspondances. Les correspondances partielles
avec le système de vérification d'adresse s'affichent. Par exemple, l'attribution de la valeur
« Jess » à l'élément FirstName de TransactionSearchRequest renvoie des résultats tels
que « Jessica » et « Jesse ».
L'élément renvoyé le plus important est TransactionID que vous pouvez transmettre à
GetTransactionDetails afin de récupérer toutes les informations disponibles sur une
transaction spécifique.
TABLEAU A.20 Paramètres de la requête TransactionSearch
Paramètre
Description
Requis
METHOD
Nom de l'appel d’API : TransactionSearch
Oui
STARTDATE
Date de transaction la plus ancienne à partir de laquelle lancer la recherche.
Aucun caractère générique n'est autorisé. La valeur doit être au format
UTC/GMT.
Oui
ENDDATE
Date de transaction la plus récente à inclure dans la recherche.
Non
EMAIL
Recherche par adresse email de l'acheteur.
Longueur maximale : 127 caractères alphanumériques d'un octet.
Non
RECEIVER
Recherche par adresse email du bénéficiaire. Si le compte marchand possède
un seul email, celui-ci sera l'email principal. Peut également être un email
autre que l'email principal.
Non
RECEIPTID
Recherche par numéro d'avis de réception du compte PayPal facultatif.
Non
TRANSACTIONID
Recherche par numéro de transaction. Les résultats renvoyés proviennent des
registres des transactions du marchand.
Longueur maximale : 19 caractères d'un octet.
Non
INVNUM
Recherche par clé de demande de paiement, que vous avez définie pour la
transaction initiale. Ce champ recherche les objets vendus par le marchand
dans les registres, et non les objets achetés.
Non
R E M A R Q U E : Aucun caractère générique n'est autorisé.
Longueur maximale : 127 caractères d'un octet.
Guide de développement et référence de l’API NVP
Janvier 2008
67
Liste de référence des méthodes et des champs de l'API NVP
TransactionSearch
TABLEAU A.20 Paramètres de la requête TransactionSearch
Paramètre
Description
Requis
ACCT
Recherche par numéro de carte bancaire, que vous avez défini pour la
transaction initiale. Ce champ recherche les objets vendus par le marchand
dans les registres, et non les objets achetés.
Non
R E M A R Q U E : Aucun caractère générique n'est autorisé.
Longueur maximale : entre 11 et 25 caractères numériques d'un octet. Les
signes de ponctuation spéciaux tels que les tirets ou espaces sont ignorés.
68
SALUTATION
Formule d'appel de l'acheteur.
Longueur maximale : 20 caractères d'un octet.
Non
FIRSTNAME
Prénom de l'acheteur.
Longueur maximale : 25 caractères d'un octet.
Non
MIDDLENAME
Deuxième prénom de l'acheteur.
Longueur maximale : 25 caractères d'un octet.
Non
LASTNAME
Nom de l'acheteur.
Longueur maximale : 25 caractères d'un octet.
Non
SUFFIX
Suffixe du payeur.
Longueur maximale : 12 caractères d'un octet.
Non
AUCTIONITEMNUMBER
Recherche par numéro d'enchère des biens achetés.
Non
Janvier 2008
Guide de développement et référence de l’API NVP
Liste de référence des méthodes et des champs de l'API NVP
TransactionSearch
TABLEAU A.20 Paramètres de la requête TransactionSearch
Paramètre
Description
Requis
TRANSACTIONCLASS
Recherche par classification de la transaction.
Non
R E M A R Q U E : Certains types de classes de transactions possibles ne peuvent
pas être recherchés avec ce champ. Par exemple, vous ne
pouvez pas rechercher les virements bancaires.
z
z
z
z
z
z
z
z
z
z
z
z
z
z
z
z
z
z
z
All : toutes les classifications de transactions
Sent : uniquement les paiements envoyés
Received : uniquement les paiements reçus
MassPay : uniquement les paiements groupés
MoneyRequest : uniquement les demandes de paiement
FundsAdded : uniquement les fonds crédités au solde
FundsWithdrawn : uniquement les fonds débités du solde
Referral : uniquement les transactions impliquant des parrainages
Fee : uniquement les transactions impliquant des commissions
Subscription : uniquement les transactions impliquant des abonnements
Dividend : uniquement les transactions impliquant des dividendes
Billpay : uniquement les transactions BillPay
Refund : uniquement les transactions impliquant des fonds
CurrencyConversions : uniquement les transactions impliquant des
conversions de devises
BalanceTransfer : uniquement les transactions impliquant des
transferts de solde
Reversal : uniquement les transactions impliquant des annulations
BillPay
Shipping : uniquement les transactions impliquant des frais d'envoi UPS
BalanceAffecting : uniquement les transactions affectant le solde du
compte
ECheck : uniquement les transactions impliquant des virements différés
AMT
Recherche par montant de transaction.
Non
STATUS
Recherche par état de transaction :
z Pending : le paiement est en attente. Le motif spécifique de mise en
attente du paiement est renvoyé par le champ PendingReason de l'API
GetTransactionDetails.
z Processing : le paiement est en cours de traitement.
z Success : le paiement est effectué et les fonds ont été ajoutés au solde
de votre compte.
z Denied : vous avez refusé le paiement. Cela se produit uniquement si le
paiement a été précédemment mis en attente.
z Reversed : un paiement a été annulé en raison d'un rejet de débit ou d'un
autre type de contre-opération. Les fonds ont été retirés du solde de votre
compte et rendus à l'acheteur.
Non
Guide de développement et référence de l’API NVP
Janvier 2008
69
Liste de référence des méthodes et des champs de l'API NVP
TransactionSearch
TABLEAU A.21 Champs de la réponse TransactionSearch
70
Champ
Description
L_TIMESTAMPn
Date et heure (au format UTC/GMT) de la transaction
Ces paramètres doivent être ordonnés de façon séquentielle en commençant par 0 (par
exemple L_TIMESTAMP0, L_TIMESTAMP1).
L_TIMEZONEn
Fuseau horaire de la transaction
Ces paramètres doivent être ordonnés de façon séquentielle en commençant par 0 (par
exemple L_TIMEZONE0, L_TIMEZONE1).
L_TYPEn
Type de la transaction
Ces paramètres doivent être ordonnés de façon séquentielle en commençant par 0 (par
exemple L_TYPE0, L_TYPE1).
L_EMAILn
Adresse email du payeur ou du destinataire du paiement (le « bénéficiaire du paiement »).
Si le montant du paiement est positif, ce champ indique le destinataire des fonds. S'il est
négatif, ce champ indique le client qui paie.
Ces paramètres doivent être ordonnés de façon séquentielle en commençant par 0 (par
exemple L_EMAIL0, L_EMAIL1).
L_NAMEn
Affiche le nom du payeur
Ces paramètres doivent être ordonnés de façon séquentielle en commençant par 0 (par
exemple L_NAME0, L_NAME1).
L_TRANSACTIONIDn
Numéro de transaction du vendeur
Ces paramètres doivent être ordonnés de façon séquentielle en commençant par 0 (par
exemple L_TRANSACTIONID0, L_TRANSACTIONID1.
L_STATUSn
Etat de la transaction.
Ces paramètres doivent être ordonnés de façon séquentielle en commençant par 0 (par
exemple L_STATUS0, L_STATUS1).
L_AMTn
Montant total hors taxe débité, y compris les frais d'expédition et de livraison et les taxes
Ces paramètres doivent être ordonnés de façon séquentielle en commençant par 0 (par
exemple L_AMT0, L_AMT1).
L_FEEAMTn
Frais débités par PayPal pour la transaction
Ces paramètres doivent être ordonnés de façon séquentielle en commençant par 0 (par
exemple L_FEEAMT0, L_FEEAMT1).
L_NETAMTn
Montant net de la transaction.
Ces paramètres doivent être ordonnés de façon séquentielle en commençant par 0 (par
exemple L_NETAMT0, L_NETAMT1).
Janvier 2008
Guide de développement et référence de l’API NVP
Liste de référence des méthodes et des champs de l'API NVP
GetTransactionDetails
GetTransactionDetails
TABLEAU A.22 Paramètres de la requête GetTransactionDetails
Paramètre
Description
Requis ?
METHOD
Nom de l'API : GetTransactionDetails
Oui
TRANSACTIONID
Identifiant unique d'une transaction.
Oui
R E M A R Q U E : Les détails de certains types de transactions ne peuvent pas
être extraits avec GetTransactionDetails. Par
exemple, vous ne pouvez pas obtenir les détails des
virements bancaires.
Longueur maximale : 17 caractères alphanumériques d'un octet.
TABLEAU A.23 Champs de la réponse GetTransactionDetails
Paramètre
Description
RECEIVERBUSINESS
Adresse email ou numéro de compte du destinataire du paiement (le vendeur).
Equivalent à Receiver si le paiement est envoyé au compte principal.
Longueur maximale : 127 caractères alphanumériques d'un octet.
RECEIVEREMAIL
Adresse email principale du destinataire du paiement (le vendeur).
Si vous êtes le destinataire du paiement et que celui-ci est envoyé à une adresse email
autre que l'adresse principale, la valeur de Receiver reste votre adresse email
principale.
Longueur maximale : 127 caractères alphanumériques d'un octet.
RECEIVERID
Numéro de compte unique du destinataire du paiement (le vendeur). Cette valeur est
identique à celle du code parrainage du destinataire.
EMAIL
Adresse email du payeur.
Longueur maximale : 127 caractères d'un octet.
PAYERID
Numéro client unique.
Longueur maximale : 13 caractères alphanumériques d'un octet.
PAYERSTATUS
Etat de l'adresse email du payeur :
Vérifié
Non-Vérifié
FIRSTNAME
Prénom du payeur.
Longueur maximale : 25 caractères d'un octet.
LASTNAME
Nom du payeur.
Longueur maximale : 25 caractères d'un octet.
Guide de développement et référence de l’API NVP
Janvier 2008
71
Liste de référence des méthodes et des champs de l'API NVP
GetTransactionDetails
TABLEAU A.23 Champs de la réponse GetTransactionDetails
72
Paramètre
Description
MIDDLENAME
Deuxième prénom du payeur.
Longueur maximale : 25 caractères d'un octet.
PAYERBUSINESS
Raison sociale du payeur.
Longueur maximale : 127 caractères d'un octet.
SHIPTOCOUNTRYCODE
Pays de résidence de l'expéditeur du paiement, indiqué par un code pays ISO 3166 à
deux caractères.
Longueur maximale : deux caractères d'un octet.
Pour consulter la liste des codes pays, reportez-vous à l’Annexe G, « Codes pays ».
SALUTATION
Formule d'appel du payeur.
Longueur maximale : 20 caractères d'un octet.
SUFFIX
Suffixe du payeur.
Longueur maximale : 12 caractères d'un octet.
ADDRESSOWNER
Société eBay qui gère cette adresse.
ADDRESSSTATUS
Etat de l'adresse enregistrée chez PayPal :
None
Confirmed
Unconfirmed
SHIPTOCITY
Nom de la ville.
Longueur maximale : 120 caractères alphanumériques d'un octet.
SHIPTONAME
Nom de la personne associée à cette adresse.
Longueur maximale : 32 caractères alphanumériques d'un octet.
SHIPTOPHONENUM
Numéro de téléphone associé à cette adresse.
SHIPTOZIP
Code postal
SHIPTOSTATE
Etat ou province.
Longueur maximale : 120 caractères alphanumériques d'un octet.
Requis pour les adresses américaines (USA) seulement.
SHIPTOSTREET
Première adresse postale.
Longueur maximale : 300 caractères alphanumériques d'un octet.
SHIPTOSTREET2
Seconde adresse postale.
Longueur maximale : 300 caractères alphanumériques d'un octet.
Janvier 2008
Guide de développement et référence de l’API NVP
Liste de référence des méthodes et des champs de l'API NVP
GetTransactionDetails
TABLEAU A.23 Champs de la réponse GetTransactionDetails
Paramètre
Description
PARENTTRANSACTIONID
Transaction initiale à laquelle cette transaction est associée. Ce champ est rempli pour
les types de transaction suivants :
z Annulation
z Collecte d'une transaction autorisée.
z Nouvelle autorisation d'une transaction.
z Collecte d'une commande. La valeur de ParentTransactionID correspond au
OrderID initial.
z Autorisation d'une commande. La valeur de ParentTransactionID correspond
au OrderID initial.
z Collecte d'une autorisation de commande.
z Annulation d'une commande. La valeur de ParentTransactionID correspond
au OrderID initial.
Longueur maximale : 19 caractères d'un octet.
TRANSACTIONID
Numéro de transaction de PayPal.
Longueur maximale : 19 caractères d'un octet.
RECEIPTID
Numéro d'avis de réception
Longueur maximale : 16 chiffres au format xxxx-xxxx-xxxx-xxxx.
TRANSACTIONTYPE
Type de transaction
cart : transaction créée par le client via la fonction Panier de PayPal.
send-money : transaction créée par le client à partir de l'onglet Paiement du site
PayPal.
web-accept : transaction créée par le client via les logos malins Acheter, Dons ou
Enchères.
subscr-*: transaction créée par le client via la fonction Abonnements et Paiements
récurrents. eot signifie « fin de la durée d'abonnement ».
merch-pmt : paiement pré-approuvé.
mass-pay : transaction créée via la fonction Paiements groupés.
PAYMENTTYPE
Indique si le paiement est immédiat ou différé.
Longueur maximale : 7 caractères d'un octet.
ORDERTIME
Date et heure du paiement.
AMT
Montant total du paiement du client, avant soustraction des commissions sur les
transactions.
CURRENCYCODE
La monnaie de la transaction.
FEEAMT
Commissions sur transaction associées au paiement.
SETTLEAMT
Montant déposé sur le solde principal du compte après conversion automatique de la
devise (par le biais de vos Préférences de réception de paiements) ou
conversion manuelle (en acceptant manuellement un paiement). Ce montant est
calculé après évaluation des frais et des taxes.
TAXAMT
Montant des taxes pour la transaction.
Guide de développement et référence de l’API NVP
Janvier 2008
73
Liste de référence des méthodes et des champs de l'API NVP
GetTransactionDetails
TABLEAU A.23 Champs de la réponse GetTransactionDetails
74
Paramètre
Description
EXCHANGERATE
Taux de change pour la transaction.
PAYMENTSTATUS
Etat du paiement.
Etat du paiement :
z None : aucun état
z Canceled-Reversal : indique qu'une contre-opération a été annulée. Par
exemple, un litige avec le client a été réglé en votre faveur et les fonds de la
transaction annulée vous ont été remboursés.
z Completed : le paiement est terminé et les fonds ont été portés au solde de votre
compte.
z Denied : vous avez refusé le paiement. Ne se produit que si le paiement était
précédemment en attente pour l'une des raisons décrites dans l'élément
PendingReason.
z Expired : la durée d'autorisation pour ce paiement a expiré.
z Failed : le paiement a échoué. Ne se produit que si le paiement a été effectué à
partir du compte bancaire de votre client.
z Pending : le paiement est en attente. Pour en savoir plus, reportez-vous au champ
PendingReason.
z Refunded : vous avez remboursé le paiement.
z Reversed : un paiement a été annulé en raison d'un rejet de débit ou d'un autre
type de contre-opération. Les fonds ont été retirés du solde de votre compte et
rendus à l'acheteur. La raison de l'annulation est spécifiée dans l'élément
ReasonCode.
z Processed : un paiement a été accepté.
z Voided : une autorisation accordée pour cette transaction a été annulée.
Janvier 2008
Guide de développement et référence de l’API NVP
Liste de référence des méthodes et des champs de l'API NVP
GetTransactionDetails
TABLEAU A.23 Champs de la réponse GetTransactionDetails
Paramètre
Description
PENDINGREASON
R E M A R Q U E : PendingReason est renvoyé dans la réponse uniquement si
PaymentStatus a la valeur Pending.
Motif pour lequel le paiement est en attente :
z none: aucun motif de mise en attente.
z address : le paiement est en attente parce que l'utilisateur n'a pas indiqué
d'adresse de livraison confirmée et que vos préférences de réception de paiements
sont configurées pour que vous puissiez accepter ou refuser manuellement chacun
de ces paiements. Pour modifier ce paramètre, accédez à la section Préférences
de vos Préférences.
z echeck : le paiement est en attente parce qu'il a été effectué par un chèque
électronique qui n'a pas encore été compensé.
z intl : le paiement est en attente parce que vous détenez un compte hors des
Etats-Unis et que vous ne disposez pas de système de virement. Vous devez
accepter ou refuser manuellement ce paiement à partir de votre Aperçu du
compte.
z multi-currency : vous ne disposez pas de solde dans la devise qui vous a été
envoyée et vos Préférences de réception de paiements ne sont pas
configurées pour convertir automatiquement ce paiement et l'accepter. Vous devez
accepter ou refuser manuellement ce paiement.
z verify : le paiement est en attente parce que vous n'avez pas encore le statut
Vérifié. Vous devez faire vérifier votre compte avant de pouvoir accepter ce
paiement.
z other : le paiement est en attente pour une autre raison que celles indiquées cidessus. Pour en savoir plus, contactez le Service clientèle de PayPal.
REASONCODE
Motif d'une annulation si TransactionType a la valeur reversal :
z none: aucun code de motif.
z chargeback : cette transaction a été annulée en raison d'une opposition à un
paiement de la part de votre client.
z guarantee : cette transaction a été annulée car votre client a demandé à faire
jouer la garantie de remboursement.
z buyer-complaint : cette transaction a été annulée car votre client a déposé une
réclamation concernant cette transaction.
z refund : cette transaction a été annulée car vous avez remboursé le client.
z other : cette transaction a été annulée pour un motif autre que celles indiquées cidessus.
INVNUM
Numéro de facture défini dans la transaction initiale.
Longueur maximale : 127 caractères alphanumériques d'un octet.
CUSTOM
Champ personnalisé défini dans la transaction initiale.
Longueur maximale : 127 caractères alphanumériques d'un octet.
NOTE
Mémo saisi par votre client dans le champ note des paiements sur site marchand de
PayPal.
Longueur maximale : 255 caractères alphanumériques d'un octet.
Guide de développement et référence de l’API NVP
Janvier 2008
75
Liste de référence des méthodes et des champs de l'API NVP
GetTransactionDetails
TABLEAU A.23 Champs de la réponse GetTransactionDetails
76
Paramètre
Description
SALESTAX
Montant des taxes débitées pour le paiement.
L_DESCn
Nom de l'objet défini par vous ou saisi par le client. S'il s'agit d'une transaction
effectuée via le Panier, PayPal ajoute le numéro de l'objet à la variable HTML
item_name. Par exemple, item_name1, item_name2, etc.
Longueur maximale : 127 caractères alphanumériques d'un octet.
Ces paramètres doivent être ordonnés de façon séquentielle en commençant par 0 (par
exemple L_DESC0, L_DESC1).
L_NUMBERn
Numéro de l'objet que vous avez défini. S'il s'agit d'une transaction effectuée via le
Panier, PayPal ajoute le numéro de l'objet à la variable HTML item_number. Par
exemple, item_number1, item_number2, etc.
Longueur maximale : 127 caractères alphanumériques d'un octet.
Ces paramètres doivent être ordonnés de façon séquentielle en commençant par 0 (par
exemple L_NUMBER0, L_NUMBER1).
L_QTYn
Quantité définie par vous ou saisie par le client.
Longueur maximale : pas de limite.
Ces paramètres doivent être ordonnés de façon séquentielle en commençant par 0 (par
exemple L_QTY0, L_QTY1).
L_AMTn
Coût de l'objet.
Ces paramètres doivent être ordonnés de façon séquentielle en commençant par 0 (par
exemple L_AMT0, L_AMT1).
L_OPTIONSNAMEn
Noms d'options PayPal pour un objet dans le panier; chaque nom correspond à une
valeur d'option. Plusieurs noms d'options peuvent exister par objet.
Ces paramètres doivent être ordonnés de façon séquentielle en commençant par 0 (par
exemple L_OPTIONSNAMES0, L_OPTIONSNAME1).
L_OPTIONSVALUEn
Valeurs d'options PayPal correspondant aux noms d'options d'un objet dans le panier.
Ces paramètres doivent être ordonnés de façon séquentielle en commençant par 0 (par
exemple L_OPTIONSVALUE0, L_OPTIONSVALUE1).
SUBSCRIPTIONID
Numéro généré par PayPal pour l'abonné.
Longueur maximale : pas de limite.
SUBSCRIPTIONDATE
Date de début de l'abonnement.
EFFECTIVEDATE
Date d'entrée en vigueur de la modification de l'abonnement.
RETRYTIME
Date à laquelle PayPal va à nouveau essayer le paiement d'abonnement qui a échoué.
USERNAME
Identifiant généré par PayPal et donné à l'abonné pour accéder à l'abonnement.
Longueur maximale : 64 caractères alphanumériques d'un octet.
PASSWORD
Mot de passe généré par PayPal et donné à l'abonné pour accéder à l'abonnement.
Pour des raisons de sécurité, la valeur du mot de passe est hachée.
Longueur maximale : 128 caractères alphanumériques d'un octet.
Janvier 2008
Guide de développement et référence de l’API NVP
Liste de référence des méthodes et des champs de l'API NVP
GetTransactionDetails
TABLEAU A.23 Champs de la réponse GetTransactionDetails
Paramètre
Description
RECURRENCES
Le nombre de versements qui auront lieu au tarif standard.
Longueur maximale : pas de limite.
REATTEMPT
Indique si de nouvelles tentatives doivent être effectuées en cas d'échec de paiement.
RECURRING
Indique s'il y a une base récurrente de facturation.
1 = Oui
PERIOD
Durée sur laquelle l'abonné sera débité.
Longueur maximale : pas de limite.
BUYERID
Identification d'enchère du client.
CLOSINGDATE
Date de clôture des enchères.
MULTIITEM
Compteur utilisé pour les paiements pour enchères de plusieurs objets.
Guide de développement et référence de l’API NVP
Janvier 2008
77
Liste de référence des méthodes et des champs de l'API NVP
Paiement groupé
Paiement groupé
Requête MassPay
TABLEAU A.24 Paramètres MassPay
Paramètre
Description
Requis ?
METHOD
Nom de l'API : MassPay
Oui
RECEIVERTYPE
Indique comment identifier les destinataires des paiements pour tous les éléments
d'un paiement groupé :
z EmailAddress (L_EMAILn pour l'objet individuel)
z UserID (L_RECEIVERID_n pour l'objet individuel).
Oui
L_AMTn
Montant du paiement.
Oui
CURRENCYCODE
Un code de devise à trois caractères pour une des devises répertoriées dans
Devises de transaction acceptées par PayPal. Par défaut : USD.
Oui
L_EMAILn
Adresse email du destinataire. Ce champ est nécessaire si RECEIVERTYPE est
EmailAddress.
Voir la
description
R E M A R Q U E : Vous devez spécifier soit L_EMAILn, soit L_RECEIVERIDn,
mais vous ne pouvez pas les associer. Utilisez uniquement l'un ou
l'autre, mais pas les deux, dans la même requête.
Longueur maximale : 127 caractères d'un octet au maximum.
Ces paramètres doivent être ordonnés de façon séquentielle en commençant par 0
(par exemple L_EMAIL0, L_EMAIL1).
L_RECEIVERIDn
Numéro de compte unique du client PayPal. Cette valeur correspond à la valeur de
PAYERID renvoyée par GetTransactionDetails. Ce champ est nécessaire si
RECEIVERTYPE est UserID.
Ces paramètres doivent être ordonnés de façon séquentielle en commençant par 0
(par exemple L_RECEIVERID0, L_RECEIVER1).
Voir la
description
L_UNIQUEIDn
Numéro de transaction spécifique permettant d'assurer le suivi dans un système
comptable.
Longueur maximale : 30 caractères d'un octet Aucun espace n'est autorisé.
Ces paramètres doivent être ordonnés de façon séquentielle en commençant par 0
(par exemple L_UNIQUEID0, L_UNIQUEID1).
Non
L_NOTEn
Remarque personnalisée pour chaque destinataire.
Longueur maximale : 4 000 caractères alphanumériques d'un octet.
Ces paramètres doivent être ordonnés de façon séquentielle en commençant par 0
(par exemple L_NOTE0, L_NOTE1).
Non
EMAILSUBJECT
Ligne Objet de l'email envoyé par PayPal une fois la transaction terminée. Cette
ligne est la même pour tous les destinataires.
Longueur maximale : 255 caractères alphanumériques d'un octet.
Non
Réponse MassPay
Les champs de la réponse correspondent aux champs d'en-tête de réponse standard. Reportezvous à « Format de la réponse » page 18.
78
Janvier 2008
Guide de développement et référence de l’API NVP
Liste de référence des méthodes et des champs de l'API NVP
Paiements récurrents et transactions de référence
Paiements récurrents et transactions de référence
CreateRecurringPaymentsProfile
Requête CreateRecurringPaymentsProfile
Le message CreateRecurringPaymentsProfileRequest se compose des champs
identifiés dans le Tableau A.1.
TABLEAU A.25Requête CreateRecurringPaymentsProfile
Name
Description et type de données
Requis
METHOD
Nom de l'API : CreateRecurringPaymentsProfile
Oui
TOKEN
Jeton horodaté dont la valeur a été retournée dans la réponse au premier
appel de SetExpressCheckout. Vous pouvez également utiliser le
jeton retourné dans la réponse SetCustomerBillingAgreement.
z Un seul profil de paiement récurrent est autorisé par requête
CreateRecurringPaymentsProfile.
z Le même jeton peut être utilisé par plusieurs appels
CreateRecurringPaymentsProfile pour définir plusieurs
profils de paiement récurrent. Le nombre de profils de paiements
récurrents ne doit pas excéder celui des détails d'autorisation de
facturation passés dans la requête SetExpressCheckout.
Ce champ est nécessaire si vous utilisez des paiements récurrents avec
Paiement express.
Voir la
description
R E M A R Q U E : La requête CreateRecurringPaymentsProfile
doit comporter le champ TOKEN.
R E M A R Q U E : Le jeton expire au bout d'environ trois heures.
SUBSCRIBERNAME
Nom complet de la personne recevant le produit ou service payé par le
paiement récurrent.
Sinon, le nom spécifié dans le compte PayPal de l'abonné est utilisé.
Longueur maximale : 32 caractères d'un octet.
Non
Adresse de livraison
(reportez vous au
Adresse de livraison de l'abonné associée à ce profil, le cas échéant. Si
celle-ci n'est pas spécifiée, l'adresse de livraison apparaissant dans le
compte PayPal de l'acheteur est utilisée.
Reportez-vous au Tableau A.1, « Devises acceptées par PayPal et
codes de devises pour les transactions », page 43 pour obtenir des
informations sur les coordonnées.
Non
Tableau A.1, « Devises
acceptées par PayPal et
codes de devises pour
les transactions »,
page 43)
R E M A R Q U E : L'adresse de livraison est facultative mais si vous
l'incluez, certains champs doivent être saisis.
Guide de développement et référence de l’API NVP
Janvier 2008
79
Liste de référence des méthodes et des champs de l'API NVP
Paiements récurrents et transactions de référence
TABLEAU A.25Requête CreateRecurringPaymentsProfile
Name
Description et type de données
Requis
PROFILESTARTDATE
La date de début de facturation pour ce profil.
Doit être une date correcte, au format UTC/GMT.
Oui
R E M A R Q U E : L'activation des préférences peut prendre jusqu'à 24
heures.
PROFILEREFERENCE
La référence unique ou le numéro de facture du marchand.
Longueur maximale : 127 caractères alphanumériques d'un octet.
Non
DESC
Description du paiement récurrent.
Non
R E M A R Q U E : Ce champ doit correspondre à la description
d'autorisation de facturation incluse dans la requête
SetExpressCheckout.
Longueur maximale : 127 caractères alphanumériques d'un octet.
TRIALBILLINGPERIOD
Unité de facturation pour cette période d'essai.
Une des valeurs suivantes :
z Day
z Week
z SemiMonth
z Month
z Year
Si vous créez une période d'essai, TRIALBILLINGPERIOD est requis.
Sinon, la valeur est facultative.
Vous ne pouvez créer qu'une période d'essai par profil.
Voir la
description
R E M A R Q U E : La combinaison de TRIALBILLINGPERIOD et de
TRIALBILLINGFREQUENCY ne peut excéder un an.
TRIALBILLING
FREQUENCY
Le nombre de périodes de facturation constituant un cycle de
facturation.
Voir la
description
R E M A R Q U E : La combinaison de la période de facturation et de la
fréquence de facturation ne doit pas excéder un an.
R E M A R Q U E : Si la période de facturation est SemiMonth, la
fréquence de facturation doit être 1.
TRIALTOTALBILLING
CYCLES
80
Nombre total d'échéances de facturation dans cette période d'essai, qui
doit être supérieur à 0. La période d'essai commence à la date
BILLINGSTARTDATE et continue à la fréquence
TRIALBILLINGFREQUENCY pendant TRIALTOTALBILLINGCYCLES
échéances.
Si vous créez une période d'essai, TRIALTOTALBILLINGCYCLES est
requis. Sinon, la valeur est facultative.
Janvier 2008
Voir la
description
Guide de développement et référence de l’API NVP
Liste de référence des méthodes et des champs de l'API NVP
Paiements récurrents et transactions de référence
TABLEAU A.25Requête CreateRecurringPaymentsProfile
Name
Description et type de données
Requis
TRIALAMT
Montant de la facturation pour chaque échéance pendant la période
d'essai, hors frais de livraison et TVA.
Si vous créez une période d'essai, TRIALAMT est requis. Sinon, la valeur
est facultative.
Longueur maximale : Ne peut excéder $10 000 USD dans aucune
devise. Pas de symbole de devise. Quelle que soit la devise, le
séparateur décimal doit être une virgule (,) et le séparateur des milliers
facultatif un point (.). Equivalent à neuf caractères maximum pour les
USD.
Voir la
description
TRIALSHIPPINGAMT
Montant des frais d'expédition pour chaque échéance de facturation
pendant la période d'essai.
Longueur maximale : Ne peut excéder $10 000 USD dans aucune
devise. Pas de symbole de devise. Quelle que soit la devise, le
séparateur décimal doit être une virgule (,) et le séparateur des milliers
facultatif un point (.). Equivalent à neuf caractères maximum pour les
USD.
Non
TRIALTAXAMT
Montant de la TVA pour chaque échéance de facturation pendant la
période d'essai.
Longueur maximale : Ne peut excéder $10 000 USD dans aucune
devise. Pas de symbole de devise. Quelle que soit la devise, le
séparateur décimal doit être une virgule (,) et le séparateur des milliers
facultatif un point (.). Equivalent à neuf caractères maximum pour les
USD.
Non
BILLINGPERIOD
Unité de mesure des échéances de facturation. Doit être choisie parmi
les valeurs suivantes :
z Day
z Week
z SemiMonth
z Month
z Year
Pour SemiMonth, la facturation s'effectue le premier et le 15 de chaque
mois.
Oui
BILLINGFREQUENCY
Le nombre de périodes de facturation constituant un cycle de
facturation.
La combinaison de la fréquence de facturation et de la période de
facturation doit être inférieure ou égale à un an. Si, par exemple,
l'échéance de facturation est Month (mois), la valeur maximale de la
fréquence de facturation est 12. De même, si cette échéance est Week
(semaine), la valeur maximale de la fréquence de facturation est 52.
Oui
R E M A R Q U E : Si la période de facturation est SemiMonth, la
fréquence de facturation doit être 1.
Guide de développement et référence de l’API NVP
Janvier 2008
81
Liste de référence des méthodes et des champs de l'API NVP
Paiements récurrents et transactions de référence
TABLEAU A.25Requête CreateRecurringPaymentsProfile
Name
Description et type de données
Requis
TOTALBILLINGCYCLES
Nombre d'échéances de facturation pendant la période des paiements
normaux.
z Si aucune valeur n'est spécifiée ou si la valeur est 0, la période de
paiements normaux se poursuit jusqu'à annulation ou désactivation
des préférences.
z Si la valeur est supérieure à 0, la période des paiements normaux
commence à la fin de la période d'essai et se poursuit à la fréquence
de facturation pendant le nombre d'échéances spécifié.
Non
AMT
Montant de la facturation pour chaque échéance pendant la période des
paiements normaux, hors frais de livraison et TVA.
Oui
R E M A R Q U E : Tous les montants de la requête
CreateRecurringPaymentsProfile doivent être
exprimés dans la même devise.
Longueur maximale : Ne peut excéder $10 000 USD dans aucune
devise. Pas de symbole de devise. Quelle que soit la devise, le
séparateur décimal doit être une virgule (,) et le séparateur des milliers
facultatif un point (.). Equivalent à neuf caractères maximum pour les
USD.
SHIPPINGAMT
Montant des frais d'expédition pour chaque échéance de facturation
pendant la période des paiements normaux.
Non
R E M A R Q U E : Tous les montants de la requête doivent être exprimés
dans la même devise.
Longueur maximale : Ne peut excéder $10 000 USD dans aucune
devise. Pas de symbole de devise. Quelle que soit la devise, le
séparateur décimal doit être une virgule (,) et le séparateur des milliers
facultatif un point (.). Equivalent à neuf caractères maximum pour les
USD.
TAXAMT
Montant de la TVA pour chaque échéance de facturation pendant la
période des paiements normaux.
Non
R E M A R Q U E : Tous les montants de la requête doivent être exprimés
dans la même devise.
Longueur maximale : Ne peut excéder $10 000 USD dans aucune
devise. Pas de symbole de devise. Quelle que soit la devise, le
séparateur décimal doit être une virgule (,) et le séparateur des milliers
facultatif un point (.). Equivalent à neuf caractères maximum pour les
USD.
MAXFAILEDPAYMENTS
82
Nombre de paiements programmés qui peuvent échouer avant que le
profil soit annulé automatiquement.
Longueur maximale : Chaîne de nombre représentant un entier
Janvier 2008
Non
Guide de développement et référence de l’API NVP
Liste de référence des méthodes et des champs de l'API NVP
Paiements récurrents et transactions de référence
TABLEAU A.25Requête CreateRecurringPaymentsProfile
Name
Description et type de données
Requis
AUTOBILLOUTAMT
Ce champ indique si vous souhaitez que PayPal facture
automatiquement le solde débiteur dans l'échéance de facturation
suivante. Le solde débiteur est le montant total de tous les défauts de
paiement précédents.
Valeurs possibles : NoAutoBill ou AddToNextBilling
Non
INITAMT
Montant de paiement non récurrent initial dû immédiatement à la
création du profil. Utilisez ce montant initial pour les frais d'inscription
ou de configuration.
Non
R E M A R Q U E : Tous les montants de la requête
CreateRecurringPaymentsProfile doivent être
exprimés dans la même devise.
Longueur maximale : Ne peut excéder $10 000 USD dans aucune
devise. Pas de symbole de devise. Quelle que soit la devise, le
séparateur décimal doit être une virgule (,) et le séparateur des milliers
facultatif un point (.). Equivalent à neuf caractères maximum pour les
USD.
FAILEDINITAMTACTION
Par défaut, PayPal suspendra le profil en attente au cas où le paiement
initial échouerait. Vous pouvez remplacer ce comportement par défaut
en réglant ce champ sur ContinueOnFailure, indiquant que si le
paiement initial échoue, PayPal doit l'ajouter au solde débiteur dans ce
profil de paiement récurrent.
Lorsque cet indicateur est défini à ContinueOnFailure, un code
indiquant le succès de l’opération est retourné au marchand dans la
réponse CreateRecurringPaymentsProfile et le profil de
paiements récurrents est activé immédiatement pour la facturation
planifiée. Vous devez surveiller l'évolution de l'état des paiements dans
vos messages IPN ou sur votre compte PayPal.
Si ce champ n'est pas défini ou s'il est défini sur CancelOnFailure,
PayPal créera le profil de paiement récurrent, mais le placera en attente
jusqu'à ce que le paiement initial ait été effectué. Si le paiement initial
est réglé, PayPal vous notifie par IPN que le profil en attente a été
activé. Si le paiement initial échoue, PayPal vous notifie par IPN que le
profil en attente a été annulé.
Longueur maximale et limitations : ContinueOnFailure ou
CancelOnFailure
Guide de développement et référence de l’API NVP
Janvier 2008
Non
83
Liste de référence des méthodes et des champs de l'API NVP
Paiements récurrents et transactions de référence
Réponse CreateRecurringPaymentsProfile
TABLEAU A.26Réponse CreateRecurringPaymentsProfile
Champ
Description
PROFILEID
Un identifiant unique pour toute référence ultérieure aux détails de ce paiement
récurrent.
Longueur maximale et limitations : Jusqu'à 20 caractères alphanumériques codés sur
un octet.
STATUS
Etat du profil de paiement récurrent.
z ActiveProfile - Le profil de paiement récurrent a été créé et activé
correctement pour les paiements planifiés selon les instructions de facturation de
ce profil.
z PendingProfile - Le système est en train de créer le profil de paiement
récurrent. Veuillez surveiller la modification de cet état dans vos messages IPN.
Pour en savoir plus sur l'état et les montants initiaux, voir le champ
FailedInitialAmountAction page 83.
Abréviations des Etats et provinces
Le tableau suivant répertorie les abréviations des provinces canadiennes et des Etats
américains. Entrez ces valeurs dans le paramètre STATE ou SHIPTOSTATE.
TABLEAU A.27 Abréviations pour les provinces canadiennes et les Etats américains
84
Province canadienne ou
Etat américain
Abréviation
Alberta
AB
Colombie-Britannique
BC
Manitoba
MB
Nouveau Brunswick
NB
Terre-Neuve et Labrador
NL
Territoires du Nord-Ouest
NT
Nouvelle-Ecosse
NS
Nunavut
NU
Ontario
ON
Ile du Prince-Edouard
PE
Québec
QC
Janvier 2008
Guide de développement et référence de l’API NVP
Liste de référence des méthodes et des champs de l'API NVP
Paiements récurrents et transactions de référence
TABLEAU A.27 Abréviations pour les provinces canadiennes et les Etats américains
Province canadienne ou
Etat américain
Abréviation
Saskatchewan
SK
Yukon
YT
Alabama
AL
Alaska
AK
Samoa Américaines
AS
Arizona
AZ
Arkansas
AR
Californie
CA
Colorado
CO
Connecticut
CT
Delaware
DE
District de Columbia
DC
Etats fédérés de Micronésie
FM
Floride
FL
Géorgie
GA
Guam
GU
Hawaii
HI
Idaho
ID
Illinois
IL
Indiana
IN
Iowa
IA
Kansas
KS
Kentucky
KY
Louisiane
LA
Maine
ME
Iles Marshall
MH
Maryland
MD
Massachusetts
MA
Guide de développement et référence de l’API NVP
Janvier 2008
85
Liste de référence des méthodes et des champs de l'API NVP
Paiements récurrents et transactions de référence
TABLEAU A.27 Abréviations pour les provinces canadiennes et les Etats américains
86
Province canadienne ou
Etat américain
Abréviation
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
Dakota du Nord
ND
Iles Mariannes du Nord
MP
Ohio
OH
Oklahoma
OK
Oregon
OU
Palaos
PW
Pennsylvanie
PA
Porto Rico
PR
Rhode Island
RI
Caroline du Sud
SC
Dakota du Sud
SD
Tennessee
TN
Texas
TX
Utah
UT
Vermont
VT
Iles Vierges
VI
Janvier 2008
Guide de développement et référence de l’API NVP
Liste de référence des méthodes et des champs de l'API NVP
Paiements récurrents et transactions de référence
TABLEAU A.27 Abréviations pour les provinces canadiennes et les Etats américains
Province canadienne ou
Etat américain
Abréviation
Virginie
VA
Washington
WA
Virginie-Occidentale
WV
Wisconsin
WI
Wyoming
WY
Forces armées Amériques
AA
Forces armées Europe
AE
Forces armées Pacifique
AP
GetRecurringPaymentsProfileDetails
Requête GetRecurringPaymentsProfileDetails
TABLEAU A.28Requête GetRecurringPaymentsProfileDetails
Champ
Description
Requis ?
PROFILEID
Numéro du profil de paiement récurrent retourné dans la réponse
CreateRecurringPaymentsProfile.
Oui
Réponse GetRecurringPaymentsProfileDetails
TABLEAU A.29Réponse GetRecurringPaymentsProfileDetails
Champ
Description
PROFILEID
Numéro du profil de paiement récurrent retourné dans la réponse
CreateRecurringPaymentsProfile.
STATUS
Etat du profil de paiement récurrent.
z ActiveProfile
z PendingProfile
z CancelledProfile
z SuspendedProfile
z ExpiredProfile
DESC
Description du paiement récurrent.
Longueur maximale et limitations : 127 caractères alphanumériques d'un octet.
Guide de développement et référence de l’API NVP
Janvier 2008
87
Liste de référence des méthodes et des champs de l'API NVP
Paiements récurrents et transactions de référence
TABLEAU A.29Réponse GetRecurringPaymentsProfileDetails
Champ
Description
AUTOBILLOUTAMT
Ce champ indique si vous souhaitez que PayPal facture automatiquement le
solde débiteur dans l'échéance de facturation suivante.
Valeurs possibles : NoAutoBill ou AddToNextBilling
MAXFAILEDPAYMENTS
Nombre de paiements programmés qui peuvent échouer avant que le profil soit
annulé automatiquement.
Longueur maximale et limitations : Chaîne de nombre représentant un entier
SUBSCRIBERNAME
Nom complet de la personne recevant le produit ou service payé par le paiement
récurrent.
Sinon, le nom spécifié dans le compte PayPal de l'abonné est utilisé.
Longueur maximale et limitations : 32 caractères d'un octet..
Adresse de livraison (reportez
vous au Tableau A.1,
Adresse de livraison de l'acheteur.
Reportez-vous au Tableau A.1, « Devises acceptées par PayPal et codes de
devises pour les transactions », page 43 pour obtenir des informations sur les
coordonnées.
« Devises acceptées par
PayPal et codes de devises
pour les transactions »,
page 43)
PROFILESTARTDATE
Date de la première facturation pour ce profil, au format AAAA-MM-JJ.
PROFILEREFERENCE
La référence unique ou le numéro de facture du marchand.
Nombre de caractères limite : 127 caractères alphanumériques d'un octet.
BILLINGPERIOD
Unité de mesure des échéances de facturation. Doit être choisie parmi les valeurs
suivantes :
z Day
z Week
z SemiMonth
z Month
z Year
R E M A R Q U E : Ce champ n'est pas retourné si le profil est annulé ou a expiré.
BILLINGFREQUENCY
Le nombre de périodes de facturation constituant un cycle de facturation.
R E M A R Q U E : Ce champ n'est pas retourné si le profil est annulé ou a expiré.
TOTALBILLINGCYCLES
Nombre d'échéances de facturation pendant la période des paiements normaux.
R E M A R Q U E : Ce champ n'est pas retourné si le profil est annulé ou a expiré.
88
Janvier 2008
Guide de développement et référence de l’API NVP
Liste de référence des méthodes et des champs de l'API NVP
Paiements récurrents et transactions de référence
TABLEAU A.29Réponse GetRecurringPaymentsProfileDetails
Champ
Description
AMT
Montant de la facturation pour chaque échéance pendant la période des
paiements normaux, hors frais de livraison et TVA.
R E M A R Q U E : Tous les montants de la requête
CreateRecurringPaymentsProfile doivent être exprimés
dans la même devise.
Longueur maximale et limitations : Ne peut excéder $10 000 USD dans aucune
devise. Pas de symbole de devise. Quelle que soit la devise, le séparateur
décimal doit être une virgule (,) et le séparateur des milliers facultatif un point
(.). Equivalent à neuf caractères maximum pour les USD.
R E M A R Q U E : Ce champ n'est pas retourné si le profil est annulé ou a expiré.
SHIPPINGAMT
Montant des frais d'expédition pour chaque échéance de facturation pendant la
période des paiements normaux.
R E M A R Q U E : Tous les montants de la requête doivent être exprimés dans la
même devise.
Longueur maximale et limitations : Ne peut excéder $10 000 USD dans aucune
devise. Pas de symbole de devise. Quelle que soit la devise, le séparateur
décimal doit être une virgule (,) et le séparateur des milliers facultatif un point
(.). Equivalent à neuf caractères maximum pour les USD.
R E M A R Q U E : Ce champ n'est pas retourné si le profil est annulé ou a expiré.
TAXAMT
Montant de la TVA pour chaque échéance de facturation pendant la période des
paiements normaux.
R E M A R Q U E : Tous les montants de la requête doivent être exprimés dans la
même devise.
Longueur maximale et limitations : Ne peut excéder $10 000 USD dans aucune
devise. Pas de symbole de devise. Quelle que soit la devise, le séparateur
décimal doit être une virgule (,) et le séparateur des milliers facultatif un point
(.). Equivalent à neuf caractères maximum pour les USD.
R E M A R Q U E : Ce champ n'est pas retourné si le profil est annulé ou a expiré.
NEXTBILLINGDATE
Date de facturation planifiée suivante, au format AAAA-MM-JJ.
NUMCYCLESCOMPLETED
Nombre d'échéances de facturation terminées dans la période d'abonnement en
cours. Une échéance de facturation est considérée comme terminée lorsque le
paiement est collecté ou après que de nouvelles tentatives de collecte du
paiement ont échoué pour l'échéance de facturation en cours.
NUMCYCLESREMAINING
Nombre d'échéances de facturation restantes dans la période d'abonnement en
cours.
OUTSTANDINGBALANCE
Montant des arriérés ou solde débiteur pour ce profil.
Longueur maximale et limitations : Ne peut excéder $10 000 USD dans aucune
devise. Pas de symbole de devise. Quelle que soit la devise, le séparateur
décimal doit être une virgule (,) et le séparateur des milliers facultatif un point
(.). Equivalent à neuf caractères maximum pour les USD.
Guide de développement et référence de l’API NVP
Janvier 2008
89
Liste de référence des méthodes et des champs de l'API NVP
Paiements récurrents et transactions de référence
TABLEAU A.29Réponse GetRecurringPaymentsProfileDetails
Champ
Description
FAILEDPAYMENTCOUNT
Nombre total d'échéances de facturation ayant échoué pour ce profil.
LASTPAYMENTDATE
Date du dernier paiement effectué pour ce profil, au format AAAA-MM-JJ.
LASTPAYMENTAMT
Montant du dernier paiement reçu pour ce profil.
Longueur maximale et limitations : Ne peut excéder $10 000 USD dans aucune
devise. Pas de symbole de devise. Quelle que soit la devise, le séparateur
décimal doit être une virgule (,) et le séparateur des milliers facultatif un point
(.). Equivalent à neuf caractères maximum pour les USD.
TABLEAU A.30Détails de la carte bancaire pour GetRecurringPaymentsProfileDetails
90
Champ
Description
CREDITCARDTYPE
Type de carte bancaire.
Longueur maximale et limitations : jusqu'à 13 caractères alphabétiques d'un
octet.
Valeurs autorisées :
z Visa
z MasterCard
ACCT
Les quatre derniers chiffres du numéro de la carte.
Longueur maximale et limitations : caractères numériques uniquement. Aucun
espace ou ponctuation.
EXPDATE
Date d'expiration de la carte bancaire.
Format: MMAAAA
Longueur maximale et limitations : six caractères d'un octet, y compris les zéros
non significatifs.
FIRSTNAME
Prénom du payeur.
Longueur maximale et limitations : 25 caractères d'un octet.
LASTNAME
Nom du payeur.
Longueur maximale et limitations : 25 caractères d'un octet.
STREET1
Première adresse postale.
Longueur maximale et limitations : 100 caractères d'un octet.
STREET2
Seconde adresse postale.
Longueur maximale et limitations : 100 caractères d'un octet.
CITY
Nom de la ville.
Longueur maximale et limitations : 40 caractères d'un octet.
STATE
Etat ou province.
Longueur maximale et limitations : 40 caractères d'un octet.
Pour les abréviations des états ou provinces, voir « Abréviations des Etats et
provinces » page 84.
Janvier 2008
Guide de développement et référence de l’API NVP
Liste de référence des méthodes et des champs de l'API NVP
Paiements récurrents et transactions de référence
TABLEAU A.30Détails de la carte bancaire pour GetRecurringPaymentsProfileDetails
Champ
Description
COUNTRY
Code pays.
Longueur maximale et limitations : deux caractères d'un octet.
Pour consulter la liste des codes pays, reportez-vous à l’Annexe G, « Codes
pays ».
ZIP
Code postal américain ou code postal spécifique aux autres pays.
Longueur maximale et limitations : 20 caractères d'un octet.
ManageRecurringPaymentsProfileStatus
Requête ManageRecurringPaymentsProfileStatus
TABLEAU A.31Requête ManageRecurringPaymentsProfileStatus
Champ
Description
Requis ?
PROFILEID
Numéro du profil de paiement récurrent retourné dans la réponse
CreateRecurringPaymentsProfile.
Oui
ACTION
Action à effectuer sur le profil de paiement récurrent. Doit avoir
l'une des valeurs suivantes :
z Cancel (Annuler) - Seuls les profils à l'état Active ou
Suspended peuvent être annulés.
z Suspend - Seuls les profils à l'état Active peuvent être
suspendus.
z Reactivate - Seuls les profils à l'état Suspended peuvent être
réactivés.
Oui
NOTE
Raison du changement d'état. Pour les profils créés avec Paiement
express, ce message sera inclus dans la notification par email
envoyée à l'acheteur lorsque l'état du profil est modifié avec succès,
et peut être également lu par vous et par l'acheteur sur la page
Historique du statut du compte PayPal.
Oui
Guide de développement et référence de l’API NVP
Janvier 2008
91
Liste de référence des méthodes et des champs de l'API NVP
Paiements récurrents et transactions de référence
Réponse ManageRecurringPaymentsProfileStatus
TABLEAU A.32Réponse ManageRecurringPaymentsProfileStatus
Champ
Description
PROFILEID
Numéro du profil de paiement récurrent retourné dans la réponse
CreateRecurringPaymentsProfile.
Pour chaque action, une erreur est retournée si l'état du profil de paiement récurrent
n'est pas compatible avec l'action. Des erreurs sont retournées dans les cas suivants :
z Cancel - L'état du profil n'est ni Active ni Suspended
z Suspend - L'état du profil n'est pas Active
z Reactivate - L'état du profil n'est pas Suspended
BillOutstandingAmount
vous appelez BillOutstandingAmount dans les 24 heures qui suivent un
paiement régulièrement planifié, une erreur est retournée.
R E M A R Q U E : Si
Requête BillOutstandingAmount
TABLEAU A.33Requête BillOutstandingAmount
Champ
Description
Requis ?
PROFILEID
Numéro du profil de paiement récurrent retourné dans la réponse
CreateRecurringPaymentsProfile.
Oui
R E M A R Q U E : L'état du profil doit être Active ou Suspended.
92
AMT
Montant de la facture. Ce montant doit être inférieur ou égal au solde
débiteur en cours du profil. Si aucune valeur n'est spécifiée, PayPal
tente de facturer la totalité du solde débiteur.
Longueur maximale et limitations : Ne peut excéder $10 000 USD
dans aucune devise. Pas de symbole de devise. Quelle que soit la
devise, le séparateur décimal doit être une virgule (,) et le séparateur
des milliers facultatif un point (.). Equivalent à neuf caractères
maximum pour les USD.
Non
NOTE
Motif du paiement non planifié. Pour les profils créés avec Paiement
express, ce message sera inclus dans la notification par email envoyée
à l'acheteur pour la transaction du paiement non planifié, et peut être
également lu par vous et par l'acheteur sur la page Historique du statut
du compte PayPal.
Oui
Janvier 2008
Guide de développement et référence de l’API NVP
Liste de référence des méthodes et des champs de l'API NVP
Paiements récurrents et transactions de référence
Réponse BillOutstandingAmount
TABLEAU A.34Réponse BillOutstandingAmount
Champ
Description
PROFILEID
Numéro du profil de paiement récurrent retourné dans la réponse
CreateRecurringPaymentsProfile.
Une erreur est retournée si le profil spécifié dans la requête BillOutstandingAmount
est à l'état annulé ou expiré.
UpdateRecurringPaymentsProfile
R E M A R Q U E : Pour
les profils de paiement récurrent créés avec Paiement express, une erreur
peut être retournée si vous appelez UpdateRecurringPaymentsProfile
dans les 72 heures qui suivent un paiement régulièrement planifié.
Requête UpdateRecurringPaymentsProfile
TABLEAU A.35Requête UpdateRecurringPaymentsProfile
Champ
Description
Requis ?
PROFILEID
Numéro du profil de paiement récurrent retourné dans la réponse
CreateRecurringPaymentsProfile.
Oui
NOTE
Motif de la mise à jour du profil de paiement récurrent. Ce message
sera inclus dans la notification envoyée à l'acheteur pour la mise à
jour du profil de paiement récurrent. Vous pouvez lire cette remarque
sur la page Historique du statut du compte PayPal. Pour les profils de
paiement récurrent, l’acheteur peut également lire la remarque sur son
compte PayPal.
Oui
DESC
Description du paiement récurrent.
Longueur maximale et limitations : 127 caractères alphanumériques
d'un octet.
Non
SUBSCRIBERNAME
Nom complet de la personne recevant le produit ou service payé par
le paiement récurrent.
Sinon, le nom spécifié dans le compte PayPal de l'abonné est utilisé.
Longueur maximale et limitations : 32 caractères d'un octet.
Non
Guide de développement et référence de l’API NVP
Janvier 2008
93
Liste de référence des méthodes et des champs de l'API NVP
Paiements récurrents et transactions de référence
TABLEAU A.35Requête UpdateRecurringPaymentsProfile
Champ
Description
Requis ?
Adresse de livraison
(reportez vous au
Adresse de livraison de l'abonné associée à ce profil, le cas échéant.
Si celle-ci n'est pas spécifiée, l'adresse de livraison apparaissant dans
le compte PayPal de l'acheteur est utilisée.
Reportez-vous au Tableau A.1, « Devises acceptées par PayPal et
codes de devises pour les transactions », page 43 pour obtenir
des informations sur les coordonnées.
Non
Tableau A.1, « Devises
acceptées par PayPal et
codes de devises pour
les transactions »,
page 43)
I M P O R T A N T : L'adresse de livraison est facultative, mais si vous
modifiez l'un des champs d'adresse, vous devez tous
les saisir. Si, par exemple, vous souhaitez mettre à
jour l'adresse postale de l'abonné, vous devez
spécifier non seulement le champ de l'adresse
postale, mais tous les champs répertoriés au
Tableau A.1, « Devises acceptées par PayPal et
codes de devises pour les transactions »,
page 43.
PROFILEREFERENCE
La référence unique ou le numéro de facture du marchand.
Longueur maximale et limitations : 127 caractères alphanumériques
d'un octet.
Non
ADDITIONALBILLING
CYCLES
Nombre d'échéances de facturation supplémentaires à ajouter à ce
profil.
Non
AMT
Montant de la facturation pour chaque échéance de la période
d'abonnement, hors frais de livraison et TVA.
Non
R E M A R Q U E : Pour les paiements récurrents avec Paiement express,
le montant du paiement ne peut être augmenté de plus
de 20 % par période de 180 jours (à partir de la date
de création du profil).
Longueur maximale et limitations : Ne peut excéder $10 000 USD
dans aucune devise. Pas de symbole de devise. Quelle que soit la
devise, le séparateur décimal doit être une virgule (,) et le séparateur
des milliers facultatif un point (.). Equivalent à neuf caractères
maximum pour les USD.
SHIPPINGAMT
Montant des frais d'expédition pour chaque échéance de facturation
pendant la période des paiements normaux.
Non
R E M A R Q U E : Tous les montants de la requête doivent être exprimés
dans la même devise.
Longueur maximale et limitations : Ne peut excéder $10 000 USD
dans aucune devise. Pas de symbole de devise. Quelle que soit la
devise, le séparateur décimal doit être une virgule (,) et le séparateur
des milliers facultatif un point (.). Equivalent à neuf caractères
maximum pour les USD.
94
Janvier 2008
Guide de développement et référence de l’API NVP
Liste de référence des méthodes et des champs de l'API NVP
Paiements récurrents et transactions de référence
TABLEAU A.35Requête UpdateRecurringPaymentsProfile
Champ
Description
Requis ?
TAXAMT
Montant de la TVA pour chaque échéance de facturation pendant la
période des paiements normaux.
Non
R E M A R Q U E : Tous les montants de la requête doivent être exprimés
dans la même devise.
Longueur maximale et limitations : Ne peut excéder $10 000 USD
dans aucune devise. Pas de symbole de devise. Quelle que soit la
devise, le séparateur décimal doit être une virgule (,) et le séparateur
des milliers facultatif un point (.). Equivalent à neuf caractères
maximum pour les USD.
OUTSTANDINGAMT
Montant des arriérés ou solde débiteur pour ce profil. Vous pouvez
uniquement réduire le solde débiteur — vous ne pouvez l'augmenter.
Longueur maximale et limitations : Ne peut excéder $10 000 USD
dans aucune devise. Pas de symbole de devise. Quelle que soit la
devise, le séparateur décimal doit être une virgule (,) et le séparateur
des milliers facultatif un point (.). Equivalent à neuf caractères
maximum pour les USD.
Non
AUTOBILLOUTAMT
Ce champ indique si vous souhaitez que PayPal facture
automatiquement le solde débiteur dans l'échéance de facturation
suivante.
Valeurs possibles : NoAutoBill ou AddToNextBilling
Non
MAXFAILEDPAYMENTS
Le nombre d'échecs de paiement autorisés avant que le profil ne soit
automatiquement suspendu. La valeur spécifiée ne peut être inférieure
au nombre des échecs de paiement existants pour ce profil.
Nombre de caractères limite : numéro de chaîne représentant un
chiffre entier
Non
Détails de la carte bancaire
(voir Tableau A.36,
Détails de la carte bancaire à mettre à jour.
Voir la
description
« Détails de la carte
bancaire pour la requête
UpdateRecurringPayme
ntsProfile »)
R E M A R Q U E : Vous ne pouvez pas mettre à jour le numéro de la carte
bancaire.
I M P O R T A N T : L'adresse de facturation de la carte bancaire est
facultative, mais si vous modifiez l'un des champs
d'adresse, vous devez tous les saisir. Si, par exemple,
vous souhaitez mettre à jour l'adresse postale, vous
devez spécifier non seulement le champ de l'adresse
postale, mais tous les champs répertoriés au
Tableau A.1, « Devises acceptées par PayPal et
codes de devises pour les transactions »,
page 43.
Reportez-vous à Tableau A.36, « Détails de la carte bancaire
pour la requête UpdateRecurringPaymentsProfile ».
Guide de développement et référence de l’API NVP
Janvier 2008
95
Liste de référence des méthodes et des champs de l'API NVP
Paiements récurrents et transactions de référence
TABLEAU A.36Détails de la carte bancaire pour la requête
UpdateRecurringPaymentsProfile
Champ
Description
Requis ?
CREDITCARDTYPE
Type de carte bancaire.
Longueur maximale et limitations : jusqu'à 13 caractères
alphabétiques d'un octet.
Si vous mettez à jour les informations relatives à la carte bancaire, ce
champ est requis.
Valeurs autorisées :
z Visa
z MasterCard
Voir la
description
EXPDATE
Date d'expiration de la carte bancaire.
Si vous mettez à jour les informations relatives à la carte bancaire, ce
champ est requis.
Format: MMAAAA
Longueur maximale et limitations : six caractères d'un octet, y
compris les zéros non significatifs.
Voir la
description
CARDVERIFICATION
VALUE
Valeur de vérification de carte, version 2.
Voir la
description
R E M A R Q U E : Vos paramètres de compte marchand déterminent si
ce champ est obligatoire ou non.
Nombre de caractères pour les cartes Visa et MasterCard : trois
chiffres exactement.
Nombre de caractères pour les cartes American Express : quatre
chiffres exactement.
I M P O R T A N T : Afin de respecter les réglementations relatives au
traitement des cartes bancaires, vous ne devez pas
conserver la valeur de CVV2 une fois la transaction
effectuée.
FIRSTNAME
Prénom du payeur.
Si vous mettez à jour les informations relatives à la carte bancaire, ce
champ est requis.
Longueur maximale et limitations : 25 caractères d'un octet.
Voir la
description
LASTNAME
Si vous mettez à jour les informations relatives à la carte bancaire, ce
champ est requis.
Nom du payeur.
Longueur maximale et limitations : 25 caractères d'un octet.
Voir la
description
STREET1
Première adresse postale.
Longueur maximale et limitations : 100 caractères d'un octet.
Voir la
description
I M P O R T A N T : L'adresse de facturation de la carte bancaire est
facultative, mais si vous modifiez l'un des champs
d'adresse, vous devez tous les saisir.
96
Janvier 2008
Guide de développement et référence de l’API NVP
Liste de référence des méthodes et des champs de l'API NVP
Paiements récurrents et transactions de référence
TABLEAU A.36Détails de la carte bancaire pour la requête
UpdateRecurringPaymentsProfile
Champ
Description
Requis ?
STREET2
Seconde adresse postale.
Longueur maximale et limitations : 100 caractères d'un octet.
Voir la
description
I M P O R T A N T : L'adresse de facturation de la carte bancaire est
facultative, mais si vous modifiez l'un des champs
d'adresse, vous devez tous les saisir.
CITY
Nom de la ville.
Longueur maximale et limitations : 40 caractères d'un octet.
Voir la
description
I M P O R T A N T : L'adresse de facturation de la carte bancaire est
facultative, mais si vous modifiez l'un des champs
d'adresse, vous devez tous les saisir.
STATE
Etat ou province.
Longueur maximale et limitations : 40 caractères d'un octet.
Pour les abréviations des états ou provinces, voir « Abréviations
des Etats et provinces » page 84.
Voir la
description
I M P O R T A N T : L'adresse de facturation de la carte bancaire est
facultative, mais si vous modifiez l'un des champs
d'adresse, vous devez tous les saisir.
COUNTRY
Code pays.
Longueur maximale et limitations : deux caractères d'un octet.
Pour consulter la liste des codes pays, reportez-vous à l’Annexe G,
« Codes pays ».
Voir la
description
I M P O R T A N T : L'adresse de facturation de la carte bancaire est
facultative, mais si vous modifiez l'un des champs
d'adresse, vous devez tous les saisir.
ZIP
Code postal américain ou code postal spécifique aux autres pays.
Longueur maximale et limitations : 20 caractères d'un octet.
Voir la
description
I M P O R T A N T : L'adresse de facturation de la carte bancaire est
facultative, mais si vous modifiez l'un des champs
d'adresse, vous devez tous les saisir.
Guide de développement et référence de l’API NVP
Janvier 2008
97
Liste de référence des méthodes et des champs de l'API NVP
Paiements récurrents et transactions de référence
Réponse UpdateRecurringPaymentsProfile
TABLEAU A.37Réponse UpdateRecurringPaymentsProfile
Champ
Description
PROFILEID
Numéro du profil de paiement récurrent retourné dans la réponse
CreateRecurringPaymentsProfile.
Une erreur est retournée si le profil spécifié dans la requête BillOutstandingAmount
est à l'état annulé ou expiré.
SetCustomerBillingAgreement
SetCustomerBillingAgreementRequest
Le message SetCustomerBillingAgreementRequest se compose des champs identifiés
dans le Tableau A.1.
TABLEAU A.38Champs de SetCustomerBillingAgreementRequest
Name
Description et type de données
Requis
METHOD
Nom de l'API : SetCustomerBillingAgreement
Oui
BILLINGTYPE
Type d'autorisation de facturation. Pour les transactions de référence, ce
champ doit être MerchantInitiatedBilling. Il demande à PayPal
d'inviter l'acheteur à définir une autorisation de facturation pour les
paiements récurrents. Dans le cas de paiements récurrents, la valeur doit
être RecurringPayments
Oui
R E M A R Q U E : Les autres valeurs définies ne sont pas correctes.
BILLINGAGREEMENT
DESCRIPTION
Description des biens ou des services associés à l'autorisation de
facturation.
Non
BILLINGAGREEMENT
CUSTOM
Champ d'annotation personnalisé que vous utilisez librement.
Non
PAYMENTTYPE
Indique le type de paiement PayPal dont vous avez besoin pour
l'autorisation de facturation.
Non
RETURNURL
URL vers laquelle le navigateur du client est renvoyé après avoir choisi
de payer avec PayPal.
Oui
R E M A R Q U E : PayPal recommande que la valeur corresponde à la page
de vérification finale sur laquelle le client confirme
l'autorisation de facturation.
Longueur maximale et limitations : pas de limite.
98
Janvier 2008
Guide de développement et référence de l’API NVP
Liste de référence des méthodes et des champs de l'API NVP
Paiements récurrents et transactions de référence
TABLEAU A.38Champs de SetCustomerBillingAgreementRequest (suite)
Name
Description et type de données
Requis
CANCELURL
URL vers laquelle le client est renvoyé s'il n'approuve pas l'utilisation
de PayPal pour vous payer.
Oui
R E M A R Q U E : PayPal recommande que la valeur corresponde à la page
initiale sur laquelle le client a choisi de payer avec PayPal ou
d'établir une autorisation de facturation.
Longueur maximale et limitations : pas de limite.
LOCALECODE
Paramètre régional des pages affichées par PayPal pendant la procédure
de paiement.
Longueur maximale et limitations : N'importe quel code pays de deux
caractères.
Les codes pays de deux caractères suivants sont pris en charge par
PayPal :
z AU
z DE
z FR
z IT
z GB
z ES
z US
Toute autre valeur sera remplacée par défaut par US.
Non
R E M A R Q U E : Dans le cas de paiements récurrents, le paramètre
régional doit être US.
Pour consulter la liste des codes pays, reportez-vous à
l’Annexe G, « Codes pays ».
PAGESTYLE
Détermine le style personnalisé des pages de paiement associées à ce
bouton/lien. Cette valeur correspond à la variable HTML page_style
qui permet de personnaliser ces pages. La valeur est identique au nom
du style choisi lors de l'ajout ou de la modification du style de page du
sous-onglet Préférences de l'onglet Mon compte sur le site PayPal.
Longueur maximale et limitations : 30 caractères alphabétiques d'un
octet.
Non
HDRIMG
URL de l'image que vous souhaitez voir apparaître dans la partie
supérieure gauche de la page de paiement. La taille maximale de l'image
est de 750 pixels en largeur et de 90 pixels en hauteur. PayPal vous
recommande de fournir une image stockée sur un serveur sécurisé
(https).
Longueur maximale et limitations : 127 caractères alphanumériques
d'un octet.
Non
Guide de développement et référence de l’API NVP
Janvier 2008
99
Liste de référence des méthodes et des champs de l'API NVP
Paiements récurrents et transactions de référence
TABLEAU A.38Champs de SetCustomerBillingAgreementRequest (suite)
Name
Description et type de données
Requis
HDRBORDERCOLOR
Définit la couleur de bordure de l'en-tête de la page de paiement. La
bordure est un périmètre de 2 pixels autour de l'espace d'en-tête, qui
dispose d'une taille de 750 pixels de large sur 90 pixels de haut.
Longueur maximale et limitations : code couleur hexadécimal HTML
de six caractères en ASCII.
Non
HDRBACKCOLOR
Définit la couleur d'arrière-plan de l'en-tête de la page de paiement. Par
défaut, elle est blanche.
Nombre de caractères limite : code couleur hexadécimal HTML de six
caractères en ASCII.
Non
PAYFLOWCOLOR
Définit la couleur d'arrière-plan de la page de paiement.
Nombre de caractères limite : code couleur hexadécimal HTML de six
caractères en ASCII.
Non
EMAIL
Adresse email de l'acheteur saisie lors du paiement. PayPal utilise cette
valeur pour pré-remplir la partie réservée à l'inscription pour l'adhésion
à PayPal de la page de connexion PayPal.
Nombre de caractères limite : 127 caractères alphanumériques d'un
octet.
Non
SetCustomerBillingAgreementResponse
Le message SetCustomerBillingAgreementRequest se compose des champs identifiés
dans le Tableau A.1.
TABLEAU A.39Champs de SetCustomerBillingAgreementResponse
Elément
Description et type de données
TOKEN
Un jeton horodaté qui identifie cette transaction de manière unique en vue d'appels
d’API ultérieurs.
R E M A R Q U E : Le jeton expire au bout de trois heures.
Longueur maximale et limitations : 20 caractères d'un octet.
GetBillingAgreementCustomerDetails
Requête GetBillingAgreementCustomerDetails
Le message GetBillingAgreementCustomerDetailsRequest se compose des champs
identifiés dans le Tableau A.1.
TABLEAU A.40Champs de GetBillingAgreementCustomerDetailsRequest
100
Elément
Description et type de données
Requis
METHOD
Nom de l'API : GetBillingAgreementCustomerDetails
Oui
Janvier 2008
Guide de développement et référence de l’API NVP
Liste de référence des méthodes et des champs de l'API NVP
Paiements récurrents et transactions de référence
TABLEAU A.40Champs de GetBillingAgreementCustomerDetailsRequest
Elément
Description et type de données
Requis
TOKEN
Le jeton horodaté renvoyé dans la réponse
SetCustomerBillingAgreement.
Oui
R E M A R Q U E : Le jeton expire au bout de trois heures.
Longueur maximale et limitations : 20 caractères d'un octet.
Réponse GetBillingAgreementCustomerDetails
Le message GetBillingAgreementCustomerDetailsResponse se compose des champs
identifiés dans le Tableau A.1.
TABLEAU A.41Champs de GetBillingAgreementCustomerDetailsResponse
Elément
Description et type de données
EMAIL
Adresse email du payeur.
Longueur maximale et limitations : 127 caractères d'un octet.
PAYERID
Numéro client unique.
Longueur maximale et limitations : 13 caractères alphanumériques d'un octet.
PAYERSTATUS
Etat de l'adresse email du payeur :
Vérifié
Non-Vérifié
SALUTATION
Formule d'appel du payeur.
Longueur maximale et limitations : 20 caractères d'un octet.
FIRSTNAME
Prénom du payeur.
Longueur maximale et limitations : 25 caractères d'un octet.
MIDDLENAME
Deuxième prénom du payeur.
Longueur maximale et limitations : 25 caractères d'un octet.
LASTNAME
Nom du payeur.
Longueur maximale et limitations : 25 caractères d'un octet.
SUFFIX
Suffixe du payeur.
Longueur maximale et limitations : 12 caractères d'un octet.
SHIPTOCOUNTRYCODE
Pays de résidence de l'expéditeur du paiement, indiqué par un code pays ISO 3166 à
deux caractères.
Longueur maximale et limitations : deux caractères d'un octet.
Pour consulter la liste des codes pays, reportez-vous à l’Annexe G, « Codes pays ».
PAYERBUSINESS
Raison sociale du payeur.
Longueur maximale et limitations : 127 caractères d'un octet.
Adresse de livraison
Reportez-vous au Tableau A.1, « Devises acceptées par PayPal et codes de
devises pour les transactions », page 43.
Guide de développement et référence de l’API NVP
Janvier 2008
101
Liste de référence des méthodes et des champs de l'API NVP
Paiements récurrents et transactions de référence
DoReferenceTransaction
Requête DoReferenceTransaction
TABLEAU A.42Champs de DoReferenceTransactionRequest
NVP Name
Type de données et description
Requis
METHOD
Nom de l'API : DoReferenceTransaction
Oui
REFERENCEID
Création d'une nouvelle transaction basée sur :
z Numéro d'autorisation de facturation
z Numéro de transaction
z Numéro de paiements pré-approuvés
z Numéro de référence
Oui
PAYMENTACTION
Mode d'obtention du paiement :
z Authorization indique que ce paiement est une autorisation de
base qui sera traitée par Autorisation et collecte.
z Sale indique qu'il s'agit d'une vente finale pour laquelle vous
demandez un paiement.
Oui
AMT
Total de la commande, incluant les frais d'expédition et de livraison, de
dossier et le montant de la TVA.
Oui
R E M A R Q U E : Limites : Ne doit pas excéder $10 000 USD dans aucune
devise. Pas de symbole de devise. Doit comporter deux
positions décimales, le séparateur décimal doit être une
virgule (,) et le séparateur des milliers facultatif doit être
un point (.).
Vous devez définir l'attribut currencyID sur l'un des codes des devises à
trois caractères pour toutes les devises acceptées par PayPal.
ITEMAMT
Somme des frais de tous les objets de cette commande.
Limites : Ne doit pas excéder $10 000 USD dans aucune devise. Pas de
symbole de devise. Doit comporter deux positions décimales, le
séparateur décimal doit être une virgule (,) et le séparateur des milliers
facultatif doit être un point (.).
Non
SHIPPINGAMT
Total des frais d'expédition et de livraison de cette commande.
Non
R E M A R Q U E : Longueur maximale et limitations : Ne doit pas excéder
$10 000 USD dans aucune devise. Pas de symbole de
devise. Quelle que soit la devise, le séparateur décimal
doit être une virgule (,) et le séparateur des milliers
facultatif un point (.). Equivalent à neuf caractères
maximum pour les USD.
Vous devez définir l'attribut currencyID sur l'un des codes des devises à
trois caractères pour toutes les devises acceptées par PayPal.
102
Janvier 2008
Guide de développement et référence de l’API NVP
Liste de référence des méthodes et des champs de l'API NVP
Paiements récurrents et transactions de référence
TABLEAU A.42Champs de DoReferenceTransactionRequest (suite)
NVP Name
Type de données et description
Requis
HANDLINGAMT
Total des frais de dossier de cette commande.
Non
R E M A R Q U E : Longueur maximale et limitations : Ne doit pas excéder
$10 000 USD dans aucune devise. Pas de symbole de
devise. Quelle que soit la devise, le séparateur décimal
doit être une virgule (,) et le séparateur des milliers
facultatif un point (.). Equivalent à neuf caractères
maximum pour les USD.
Vous devez définir l'attribut currencyID sur l'un des codes des devises à
trois caractères pour toutes les devises acceptées par PayPal.
TAXAMT
Somme des frais de TVA de tous les objets de cette commande.
Non
R E M A R Q U E : Longueur maximale et limitations : Ne doit pas excéder
$10 000 USD dans aucune devise. Pas de symbole de
devise. Quelle que soit la devise, le séparateur décimal
doit être une virgule (,) et le séparateur des milliers
facultatif un point (.). Equivalent à neuf caractères
maximum pour les USD.
Vous devez définir l'attribut currencyID sur l'un des codes des devises à
trois caractères pour toutes les devises acceptées par PayPal.
Le code de devise doit être le même que celui défini pour AMT.
DESC
Description des objets achetés par le client.
Longueur maximale et limitations : 127 caractères alphanumériques d'un
octet.
Non
CUSTOM
Champ à structure non imposée que vous utilisez librement.
Longueur maximale et limitations : 256 caractères alphanumériques d'un
octet.
Non
INVNUM
Votre numéro de facture ou de suivi personnel.
Longueur maximale et limitations : 127 caractères alphanumériques d'un
octet.
Non
BUTTON
SOURCE
Code d'identification permettant aux applications tierces d'identifier les
transactions.
Longueur maximale et limitations : 32 caractères alphanumériques d'un
octet.
Non
NOTIFYURL
Votre URL pour la réception de la Notification instantanée de paiement
(IPN) concernant cette transaction.
Non
R E M A R Q U E : Si vous ne spécifiez pas cette valeur dans la requête, c'est
l'URL de notification de vos Préférences du marchand
qui est utilisée, s'il en existe une.
Longueur maximale et limitations : 2 048 caractères alphanumériques
d'un octet.
Guide de développement et référence de l’API NVP
Janvier 2008
103
Liste de référence des méthodes et des champs de l'API NVP
Paiements récurrents et transactions de référence
TABLEAU A.42Champs de DoReferenceTransactionRequest (suite)
NVP Name
Type de données et description
Requis
SHIPTONAME
Nom de la personne associée à cette adresse.
Longueur maximale et limitations : 32 caractères d'un octet.
Oui
SHIPTOSTREET
Première adresse postale.
Longueur maximale et limitations : 100 caractères d'un octet.
Oui
SHIPTOCITY
Nom de la ville.
Longueur maximale et limitations : 40 caractères d'un octet.
Oui
SHIPTOSTATE
Etat ou province.
Longueur maximale et limitations : 40 caractères d'un octet.
Pour les abréviations des états ou provinces, voir « Abréviations des
Etats et provinces » page 84.
Requis pour les adresses américaines (USA) seulement.
Non
SHIPTOZIP
Code postal américain ou code postal spécifique aux autres pays.
Longueur maximale et limitations : 20 caractères d'un octet.
Oui
SHIPTOCOUNTRYCODE
Code pays.
Nombre de caractères : deux caractères d'un octet.
Pour consulter la liste des codes pays, reportez-vous à l’Annexe G,
« Codes pays ».
Oui
SHIPTOSTREET2
Seconde adresse postale.
Longueur maximale et limitations : 100 caractères d'un octet.
Non
SHIPTOPHONENUM
Numéro de téléphone.
Nombre de caractères limite : 20 caractères d'un octet.
Non
L_DESCn
Nom de l'objet
Longueur maximale et limitations : 127 caractères d'un octet.
Non
L_AMTn
Coût de l'objet.
Non
R E M A R Q U E : Longueur maximale et limitations : Ne doit pas excéder
$10 000 USD dans aucune devise. Pas de symbole de
devise. Quelle que soit la devise, le séparateur décimal
doit être une virgule (,) et le séparateur des milliers
facultatif un point (.). Equivalent à neuf caractères
maximum pour les USD.
R E M A R Q U E : Vous devez définir l'attribut currencyID sur l'un des codes
des devises à trois caractères pour toutes les devises
acceptées par PayPal.
104
L_NUMBERn
Numéro de l'objet.
Longueur maximale et limitations : 127 caractères d'un octet.
Non
L_QTYn
Quantité d'objets.
Longueur maximale et limitations : n'importe quel chiffre entier positif.
Non
Janvier 2008
Guide de développement et référence de l’API NVP
Liste de référence des méthodes et des champs de l'API NVP
Paiements récurrents et transactions de référence
TABLEAU A.42Champs de DoReferenceTransactionRequest (suite)
NVP Name
Type de données et description
Requis
L_TAXAMTn
TVA concernant l'objet.
Limites : Ne doit pas excéder $10 000 USD dans aucune devise. Pas de
symbole de devise. Doit comporter deux positions décimales, le
séparateur décimal doit être une virgule (,) et le séparateur des milliers
facultatif doit être un point (.).
Le code de devise doit être le même que celui défini pour OrderTotal.
Non
SOFTDESCRIPTOR
Il s'agit d'une description par transaction du paiement, qui apparaîtra sur
le relevé de la carte bancaire du client.
Si une valeur est attribuée au champ softdescriptor, le descripteur
complet tel qu'il apparaît sur le relevé du client se présente sous le format
suivant :
Non
<PP * | PAYPAL *><descripteur du marchand tel que défini
dans les Préférences de réception de paiements><1
espace><descripteur softdescriptor>
Ce descripteur ne peut contenir que les caractères suivants :
z Caractères alphanumériques
z - (tiret)
z * (astérisque)
z . (point)
z
{espace}
Si vous utilisez un autre caractère (comme “,”), un code d'erreur est
retourné.
Softdescriptor n'inclut pas le numéro de téléphone, qui peut être basculé
entre le numéro du service clientèle du marchand et celui du Service
clientèle PayPal.
La longueur maximale de ce descripteur est de 22 caractères. Parmi ceuxci, 4 ou 8 caractères sont utilisés par le préfixe PayPal apparaissant dans
le format des données. La longueur maximale de ce descripteur passé
dans la requête d'API est donc :
22 - len(<PP * | PAYPAL *>) - len(<descripteur défini dans
les Préférences de réception de paiements> + 1)
Supposons, par exemple, les conditions suivantes :
z Le préfixe PayPal est défini à PAYPAL * dans les outils
d'administration de PayPal
z Le descripteur du marchand défini dans les Préférences de réception
de paiements est défini à EBAY.
z La valeur de SOFTDESCRIPTOR passée est Fleurs et Cie SARL
La chaîne du descripteur qui apparaît sur le relevé de la carte sera :
PAYPAL *EBAY Fleurs et
Guide de développement et référence de l’API NVP
Janvier 2008
105
Liste de référence des méthodes et des champs de l'API NVP
Paiements récurrents et transactions de référence
Les champs suivants ne conviennent que pour les transactions de référence directes par carte
bancaire.
TABLEAU A.43Champs supplémentaires pour les transactions de référence directes
par carte bancaire
NVP Name
Type de données et description
Requis
IPADDRESS
Adresse IP du navigateur du payeur.
Non
I M P O R T A N T : PayPal enregistre cette adresse IP afin de détecter des
fraudes éventuelles.
Longueur maximale et limitations : 15 caractères d'un octet, y compris les
points, par exemple : 255.255.255.255.
CREDITCARDTYPE
Type de carte bancaire.
Longueur maximale et limitations : jusqu'à 13 caractères alphabétiques d'un
octet.
La carte bancaire peut être l'une des valeurs suivantes :
z Visa
z MasterCard
Oui
ACCT
Numéro de carte bancaire.
Longueur maximale et limitations : caractères numériques uniquement.
Aucun espace ou ponctuation. Doit respecter le modulo et la longueur requis
par chaque type de carte bancaire.
Oui
EXPDATE
Date d'expiration de la carte bancaire.
Format : MMAAAA
Longueur maximale et limitations : six caractères d'un octet, y compris les
zéros non significatifs.
Oui
CVV2
Valeur du cryptogramme visuel, version 2.
Voir la
description
R E M A R Q U E : Vos paramètres de compte marchand déterminent si ce champ
est obligatoire ou non.
Nombre de caractères pour les cartes Visa et MasterCard : trois chiffres
exactement.
I M P O R T A N T : Afin de respecter les réglementations relatives au traitement
des cartes bancaires, vous ne devez pas conserver la valeur
de CVV2 une fois la transaction effectuée.
106
EMAIL
Adresse email du payeur.
Longueur maximale et limitations : 127 caractères d'un octet.
Non
PAYERID
Numéro de compte unique du client PayPal.
Nombre de caractères limite:13 caractères alphanumériques d'un octet.
Non
FIRSTNAME
Prénom du payeur.
Longueur maximale et limitations : 25 caractères d'un octet.
Oui
Janvier 2008
Guide de développement et référence de l’API NVP
Liste de référence des méthodes et des champs de l'API NVP
Paiements récurrents et transactions de référence
TABLEAU A.43Champs supplémentaires pour les transactions de référence directes
par carte bancaire
NVP Name
Type de données et description
Requis
LASTNAME
Nom du payeur.
Longueur maximale et limitations : 25 caractères d'un octet.
Oui
STREET
Première adresse postale.
Longueur maximale et limitations : 100 caractères d'un octet.
Non
CITY
Nom de la ville.
Longueur maximale et limitations : 40 caractères d'un octet.
Non
STATE
Etat ou province.
Longueur maximale et limitations : 40 caractères d'un octet.
Pour les abréviations des états ou provinces, voir « Abréviations des Etats
et provinces » page 84.
Non
COUNTRYCODE
Code pays.
Longueur maximale et limitations : deux caractères d'un octet.
Pour consulter la liste des codes pays, reportez-vous à l’Annexe G, « Codes
pays ».
Non
ZIP
Code postal américain ou code postal spécifique aux autres pays.
Longueur maximale et limitations : 20 caractères d'un octet.
Non
DoReferenceTransactionResponse
TABLEAU A.44Champs de DoReferenceTransactionResponse
NVP Name
Type de données et description
TRANSACTIONID
Numéro de transaction unique du paiement.
R E M A R Q U E : Si l'élément PaymentAction de la requête est défini sur
Authorization, la valeur de TransactionID correspond à votre
AuthorizationID à utiliser avec les API Autorisation et collecte.
Longueur maximale et limitations : 19 caractères d'un octet.
AMT
Montant final facturé, incluant les frais d'expédition, de livraison et de TVA de vos
Préférences du marchand.
Longueur maximale et limitations : Ne peut excéder $10 000 USD dans aucune devise. Pas
de symbole de devise. Quelle que soit la devise, le séparateur décimal doit être une virgule
(,) et le séparateur des milliers facultatif un point (.). Equivalent à neuf caractères
maximum pour les USD.
Guide de développement et référence de l’API NVP
Janvier 2008
107
Liste de référence des méthodes et des champs de l'API NVP
Paiements récurrents et transactions de référence
TABLEAU A.44Champs de DoReferenceTransactionResponse (suite)
NVP Name
Type de données et description
FEEAMT
Longueur maximale et limitations : Ne peut excéder $10 000 USD dans aucune devise. Pas
de symbole de devise. Quelle que soit la devise, le séparateur décimal doit être une virgule
(,) et le séparateur des milliers facultatif un point (.). Equivalent à neuf caractères
maximum pour les USD.
Montant de la commission de PayPal facturée pour la transaction
Longueur maximale et limitations : Ne peut excéder $10 000 USD dans aucune devise. Pas
de symbole de devise. Quelle que soit la devise, le séparateur décimal doit être une virgule
(,) et le séparateur des milliers facultatif un point (.). Equivalent à neuf caractères
maximum pour les USD.
SETTLEAMT
Montant déposé sur votre compte PayPal après conversion de devise.
TAXAMT
Longueur maximale et limitations : Ne peut excéder $10 000 USD dans aucune devise. Pas
de symbole de devise. Quelle que soit la devise, le séparateur décimal doit être une virgule
(,) et le séparateur des milliers facultatif un point (.). Equivalent à neuf caractères
maximum pour les USD.
TVA facturée pour la transaction.
Longueur maximale et limitations : Ne peut excéder $10 000 USD dans aucune devise. Pas
de symbole de devise. Quelle que soit la devise, le séparateur décimal doit être une virgule
(,) et le séparateur des milliers facultatif un point (.). Equivalent à neuf caractères
maximum pour les USD.
EXCHANGERATE
Taux de change utilisé en cas de conversion de devise. S'applique uniquement si vous
facturez dans une devise secondaire. Si l'utilisateur choisit de payer dans une devise autre
que la devise secondaire, la conversion a lieu sur son compte.
Nombre de caractères limite : une décimale qui ne dépasse pas 17 caractères, y
compris la virgule décimale.
PAYMENTSTATUS
108
Etat du paiement :
Completed : le paiement est terminé et les fonds ont été portés au solde de votre compte.
Pending : le paiement est en attente. Pour plus de détails, reportez-vous à l'élément
PendingReason.
Janvier 2008
Guide de développement et référence de l’API NVP
Liste de référence des méthodes et des champs de l'API NVP
Paiements récurrents et transactions de référence
TABLEAU A.44Champs de DoReferenceTransactionResponse (suite)
NVP Name
Type de données et description
PENDINGREASON
Motif pour lequel le paiement est en attente :
z none: aucun motif de mise en attente.
z address : le paiement est en attente parce que l'utilisateur n'a pas indiqué d'adresse de
livraison confirmée et que vos préférences de réception de paiements sont configurées
pour que vous puissiez accepter ou refuser manuellement chacun de ces paiements. Pour
modifier ce paramètre, accédez à la section Préférences de vos Préférences.
z echeck : le paiement est en attente parce qu'il a été effectué par un chèque
électronique qui n'a pas encore été compensé.
z intl : le paiement est en attente parce que vous détenez un compte hors des EtatsUnis et que vous ne disposez pas de système de virement. Vous devez accepter ou
refuser manuellement ce paiement à partir de votre Aperçu du compte.
z multi-currency : vous ne disposez pas de solde dans la devise qui vous a été
envoyée et vos Préférences de réception de paiements ne sont pas
configurées pour convertir automatiquement ce paiement et l'accepter. Vous devez
accepter ou refuser manuellement ce paiement.
z verify : le paiement est en attente parce que vous n'avez pas encore le statut Vérifié.
Vous devez faire vérifier votre compte avant de pouvoir accepter ce paiement.
z other : le paiement est en attente pour une autre raison que celles indiquées ci-dessus.
Pour en savoir plus, contactez le Service clientèle de PayPal.
REASONCODE
Motif d'une annulation si TransactionType a la valeur reversal :
z none : aucun code de motif.
z chargeback : cette transaction a été annulée en raison d'une opposition à un paiement
de la part de votre client.
z guarantee : cette transaction a été annulée car votre client a demandé à faire jouer la
garantie de remboursement.
z buyer-complaint : cette transaction a été annulée car votre client a déposé une
réclamation concernant cette transaction.
z refund : cette transaction a été annulée car vous avez remboursé le client.
z other : cette transaction a été annulée pour un motif autre que celles indiquées ci-dessus.
BILLING
AGREEMENTID
Autorisation de facturation associée à cette transaction. Ce champ est retourné uniquement
pour les transactions de référence par Paiement express.
TABLEAU A.45Champs de réponse supplémentaires pour les transactions de
référence directes par carte bancaire
NVP Name
Type de données et description
AVSCODE
Code de réponse pour le système de vérification d'adresse.
Nombre de caractères : un seul caractère alphanumérique d'un octet.
Reportez-vous à « Codes de réponse AVS pour Visa, MasterCard et American
Express. » page 110.
CVV2MATCH
Résultat de la vérification CVV2 par PayPal.
Reportez-vous à « Codes de réponse CVV2 (cryptogramme visuel) pour Visa,
MasterCard et American Express » page 111.
Guide de développement et référence de l’API NVP
Janvier 2008
109
Liste de référence des méthodes et des champs de l'API NVP
Paiements récurrents et transactions de référence
Codes de réponse AVS pour Visa, MasterCard et American Express.
Le Tableau A.46 répertorie les codes de réponse du système de vérification d'adresse.
TABLEAU A.46 Codes de réponse AVS pour Visa, MasterCard et American Express
Code
AVS
Signification
Détails concordants
A
Address
Adresse uniquement (pas de code postal)
B
« A » international
Adresse uniquement (pas de code postal)
C
« N » international
None
R E M A R Q U E : La transaction est refusée.
D
« X » international
Adresse et code postal
E
Non autorisé pour les transactions MOTO
(Internet/Téléphone)
Non applicable
R E M A R Q U E : La transaction est refusée.
F
« X » spécifique au Royaume-Uni
Adresse et code postal
G
Mondial non disponible
Non applicable
I
International non disponible
Non applicable
N
Non
None
R E M A R Q U E : La transaction est refusée.
110
P
Postal (« Z » international)
Code postal uniquement (pas d'adresse)
R
Réessayer
Non applicable
S
Service non pris en charge
Non applicable
U
Non disponible
Non applicable
W
Code postal entier
Code postal à neuf chiffres (pas d'adresse)
X
Correspondance parfaite
Adresse et code postal à neuf chiffres
Y
Oui
Adresse et code postal à cinq chiffres
Z
Code postal
Code postal à cinq chiffres (pas d'adresse)
Tous les
autres
Erreur
Non applicable
Janvier 2008
Guide de développement et référence de l’API NVP
Liste de référence des méthodes et des champs de l'API NVP
Paiements récurrents et transactions de référence
Codes de réponse CVV2 (cryptogramme visuel) pour Visa, MasterCard et
American Express
Le Tableau A.47 répertorie les codes de réponse du cryptogramme visuel.
TABLEAU A.47 Codes de réponse CVV2 (cryptogramme visuel) pour Visa, MasterCard
et American Express
Code
CVV2
Signification
Détails concordants
M
Correspondance
Cryptogramme visuel
N
Aucune correspondance avec le système
de vérification d'adresse
Aucun
P
Non traité
Non applicable
S
Service non pris en charge
Non applicable
U
Service non disponible
Non applicable
X
Pas de réponse
Non applicable
Guide de développement et référence de l’API NVP
Janvier 2008
111
Liste de référence des méthodes et des champs de l'API NVP
Paiements récurrents et transactions de référence
112
Janvier 2008
Guide de développement et référence de l’API NVP
B
Liste de référence des messages
d'erreur
Ce chapitre inventorie les messages d'erreur de l'API.
Format des réponses d'erreur
Si la valeur de ACK est Error ou Warning, des champs de réponse spécifiques de l'API ne
sont pas renvoyés. Une réponse d'erreur se présente sous le format général suivant :
TABLEAU B.1Format d'une réponse d'erreur
Champs de
la réponse
sur l'erreur
ACK=Error&TIMESTAMP=date/heureDeReponse
&CORRELATIONID=jetonDebogage&VERSION=3.200000
&BUILD=numBuild&L_ERRORCODE0=codeErreur&
L_SHORTMESSAGE0=messageCourt
&L_LONGMESSAGE0=messageLong
&L_SEVERITYCODE0=codeGravite
Il est possible que des erreurs
multiples soient renvoyées.
Chaque groupe d'erreur est
caractérisé par un suffixe
numérique différent, en
commençant par 0 et incrémenté
d'une unité à chaque erreur.
Erreurs de validation
TABLEAU B.1 Erreurs de validation
Code
d'erreur
Message court
Message long
81000
Missing Parameter
Le paramètre requis est manquant : impossible d'identifier le
paramètre
81001
Invalid Parameter
Un paramètre est incorrect : impossible d'identifier le paramètre
81002
Unspecified Method
Méthode spécifiée non prise en charge
81003
Unspecified Method
Aucune méthode spécifiée
81004
Unspecified Method
Aucune requête reçue
81100
Missing Parameter
OrderTotal (Amt) : Le paramètre requis est manquant
81101
Missing Parameter
MaxAmt : Le paramètre requis est manquant
Guide de développement et référence de l’API NVP
Janvier 2008
113
Liste de référence des messages d'erreur
Erreurs de validation
TABLEAU B.1 Erreurs de validation
114
Code
d'erreur
Message court
Message long
81102
Missing Parameter
ReturnURL: Le paramètre requis est manquant
81103
Missing Parameter
NotifyURL : Le paramètre requis est manquant
81104
Missing Parameter
CancelURL : Le paramètre requis est manquant
81105
Missing Parameter
ShipToStreet : Le paramètre requis est manquant
81106
Missing Parameter
ShipToStreet2 : Le paramètre requis est manquant
81107
Missing Parameter
ShipToCity : Le paramètre requis est manquant
81108
Missing Parameter
ShipToState : Le paramètre requis est manquant
81109
Missing Parameter
ShipToZip : Le paramètre requis est manquant
81110
Missing Parameter
Country : Le paramètre requis est manquant
81111
Missing Parameter
ReqConfirmShipping : Le paramètre requis est manquant
81112
Missing Parameter
NoShipping : Le paramètre requis est manquant
81113
Missing Parameter
AddrOverride : Le paramètre requis est manquant
81114
Missing Parameter
LocaleCode : Le paramètre requis est manquant
81115
Missing Parameter
PaymentAction : Le paramètre requis est manquant
81116
Missing Parameter
Email : Le paramètre requis est manquant
81117
Missing Parameter
Token : Le paramètre requis est manquant
81118
Missing Parameter
PayerID : Le paramètre requis est manquant
81119
Missing Parameter
ItemAmt : Le paramètre requis est manquant
81120
Missing Parameter
ShippingAmt : Le paramètre requis est manquant
81121
Missing Parameter
HandlingTotal Amt : Le paramètre requis est manquant
81122
Missing Parameter
TaxAmt : Le paramètre requis est manquant
81123
Missing Parameter
IPAddress : Le paramètre requis est manquant
81124
Missing Parameter
ShipToName : Le paramètre requis est manquant
81125
Missing Parameter
L_Amt : Le paramètre requis est manquant
81126
Missing Parameter
Amt : Le paramètre requis est manquant
81127
Missing Parameter
L_TaxAmt : Le paramètre requis est manquant
81128
Missing Parameter
AuthorizationID : Le paramètre requis est manquant
81129
Missing Parameter
CompleteType : Le paramètre requis est manquant
81130
Missing Parameter
CurrencyCode : Le paramètre requis est manquant
Janvier 2008
Guide de développement et référence de l’API NVP
Liste de référence des messages d'erreur
Erreurs de validation
TABLEAU B.1 Erreurs de validation
Code
d'erreur
Message court
Message long
81131
Missing Parameter
TransactionID : Le paramètre requis est manquant
81132
Missing Parameter
TransactionEntity : Le paramètre requis est manquant
81133
Missing Parameter
Acct : Le paramètre requis est manquant
81134
Missing Parameter
ExpDate : Le paramètre requis est manquant
81135
Missing Parameter
FirstName : Le paramètre requis est manquant
81136
Missing Parameter
LastName : Le paramètre requis est manquant
81137
Missing Parameter
Street : Le paramètre requis est manquant
81138
Missing Parameter
Street2 : Le paramètre requis est manquant
81139
Missing Parameter
City : Le paramètre requis est manquant
81140
Missing Parameter
State : Le paramètre requis est manquant
81141
Missing Parameter
Zip : Le paramètre requis est manquant
81142
Missing Parameter
CountryCode : Le paramètre requis est manquant
81143
Missing Parameter
RefundType : Le paramètre requis est manquant
81144
Missing Parameter
StartDate : Le paramètre requis est manquant
81145
Missing Parameter
EndDate : Le paramètre requis est manquant
81146
Missing Parameter
MPID : Le paramètre requis est manquant
81147
Missing Parameter
CreditCardType : Le paramètre requis est manquant
81148
Missing Parameter
User : Le paramètre requis est manquant
81149
Missing Parameter
Pwd : Le paramètre requis est manquant
81150
Missing Parameter
Version : Le paramètre requis est manquant
81200
Invalid Parameter
Amt : paramètre incorrect
81201
Invalid Parameter
MaxAmt : paramètre incorrect
81203
Invalid Parameter
NotifyURL : paramètre incorrect
81205
Invalid Parameter
ShipToStreet : paramètre incorrect
81206
Invalid Parameter
ShipToStreet2 : paramètre incorrect
81207
Invalid Parameter
ShipToCity : paramètre incorrect
81208
Invalid Parameter
ShipToState : paramètre incorrect
81209
Invalid Parameter
ShipToZip : paramètre incorrect
81210
Invalid Parameter
Country : paramètre incorrect
Guide de développement et référence de l’API NVP
Janvier 2008
115
Liste de référence des messages d'erreur
Erreurs de validation
TABLEAU B.1 Erreurs de validation
116
Code
d'erreur
Message court
Message long
81211
Invalid Parameter
ReqConfirmShipping : paramètre incorrect
81212
Invalid Parameter
Noshipping : paramètre incorrect
81213
Invalid Parameter
AddrOverride : paramètre incorrect
81214
Invalid Parameter
LocaleCode : paramètre incorrect
81215
Invalid Parameter
PaymentAction : paramètre incorrect
81219
Invalid Parameter
ItemAmt : paramètre incorrect
81220
Invalid Parameter
ShippingAmt : paramètre incorrect
81221
Invalid Parameter
HandlingTotal Amt : paramètre incorrect
81222
Invalid Parameter
TaxAmt : paramètre incorrect
81223
Invalid Parameter
IPAddress : paramètre incorrect
81224
Invalid Parameter
ShipToName : paramètre incorrect
81225
Invalid Parameter
L_Amt : paramètre incorrect
81226
Invalid Parameter
Amt : paramètre incorrect
81227
Invalid Parameter
L_TaxAmt : paramètre incorrect
81229
Invalid Parameter
CompleteType : paramètre incorrect
81230
Invalid Parameter
CurrencyCode : paramètre incorrect
81232
Invalid Parameter
TransactionEntity : paramètre incorrect
81234
Invalid Parameter
ExpDate : paramètre incorrect
81235
Invalid Parameter
FirstName : paramètre incorrect
81236
Invalid Parameter
LastName : paramètre incorrect
81237
Invalid Parameter
Street : paramètre incorrect
81238
Invalid Parameter
Street2 : paramètre incorrect
81239
Invalid Parameter
City : paramètre incorrect
81243
Invalid Parameter
RefundType : paramètre incorrect
81244
Invalid Parameter
StartDate : paramètre incorrect
81245
Invalid Parameter
EndDate : paramètre incorrect
81247
Invalid Parameter
CreditCardType : paramètre incorrect
81248
Invalid Parameter
Username : paramètre incorrect
81249
Invalid Parameter
Password : paramètre incorrect
Janvier 2008
Guide de développement et référence de l’API NVP
Liste de référence des messages d'erreur
Erreurs d'API générales
TABLEAU B.1 Erreurs de validation
Code
d'erreur
Message court
Message long
81250
Invalid Parameter
Version : paramètre incorrect
81251
Internal Error
Erreur de service interne
Erreurs d'API générales
TABLEAU B.2 Erreurs d'API générales
Code
d'erreur
Message court
Message long
10002
Authentication/
Authorization Failed
L'identifiant ou le mot de passe est incorrect
10002
Authentication/
Authorization Failed
Vous ne disposez pas des permissions requises
pour effectuer cet appel d’API
10002
Authentication/
Authorization Failed
Le compte est verrouillé ou inactif
10002
Internal Error
Erreur interne
10002
Authentication/
Authorization Failed
Erreur interne
10002
Authentication/
Authorization Failed
Le compte n'est pas vérifié
10002
Authentication/
Authorization Failed
Cet appel n'est pas défini dans la base de
données.
10002
Authentication/
Authorization Failed
Le jeton n'est pas valable
10002
Restricted account
Le compte a un accès restreint
Guide de développement et référence de l’API NVP
Janvier 2008
Traitement de cette
erreur
Cette erreur peut être due à
un identifiant API, un mot de
passe API ou une signature
API incorrect. Vérifiez que
ces trois valeurs sont
correctes. Pour votre
sécurité, PayPal ne précise
pas laquelle de ces trois
valeurs est incorrecte.
Votre compte marchand
PayPal a été restreint.
Contactez votre chargé de
compte PayPal pour
résoudre ce problème.
117
Liste de référence des messages d'erreur
Erreurs de l'API Paiement express PayPal
TABLEAU B.2 Erreurs d'API générales
Code
d'erreur
Traitement de cette
erreur
Message court
Message long
10002
Authentication/
Authorization Failed
Le jeton n'est pas valable
10002
Authentication/
Authorization Failed
L'accès à l'API est désactivé pour ce compte
10002
Authentication/
Authorization Failed
Le certificat du client est désactivé
10002
Restricted account
Le compte a un accès restreint
Erreurs de l'API Paiement express PayPal
TABLEAU B.3 Erreurs de l'API SetExpressCheckout
Code
d'erreur
118
Traitement de cette
erreur…
Message court
Message long
10001
ButtonSource value
truncated.
Impossible de charger la transaction
10001
Internal Error
Erreur interne
10004
Transaction refused
because of an
invalid argument.
See additional error
messages for
details.
Transaction refusée en raison d’un argument
incorrect. Pour en savoir plus, reportez-vous
aux messages d'erreur supplémentaires.
10004
Transaction refused
because of an
invalid argument.
See additional error
messages for
details.
Le numéro de transaction est incorrect
10004
Transaction refused
because of an
invalid argument.
See additional error
messages for
details.
Valeur incorrecte du paramètre de demande
d'adresse de facturation.
Janvier 2008
Guide de développement et référence de l’API NVP
Liste de référence des messages d'erreur
Erreurs de l'API Paiement express PayPal
TABLEAU B.3 Erreurs de l'API SetExpressCheckout
Code
d'erreur
Message court
Message long
10007
Permission denied
Vous ne disposez pas des permissions requises
pour effectuer cet appel d’API
10102
PaymentAction of
Order Temporarily
Unavailable
L'élément PaymentAction défini sur Order est
temporairement indisponible. Veuillez essayer
ultérieurement ou utiliser une autre valeur
PaymentAction.
10103
Please use another
Solution Type.
Votre type de solution est momentanément
indisponible. Si possible, veuillez utiliser un
autre type de solution.
10402
Authorization only
is not allowed for
merchant.
Ce compte marchand n'a pas le droit de définir
PaymentAction sur Authorization. Veuillez
contacter le Service clientèle.
10404
Transaction refused
because of an
invalid argument.
See additional error
messages for
details.
ReturnURL manquant.
10405
Transaction refused
because of an
invalid argument.
See additional error
messages for
details.
CancelURL manquant.
10407
Transaction refused
because of an
invalid argument.
See additional error
messages for
details.
Adresse email de l'acheteur (BuyerEmail)
incorrecte.
10409
You're not
authorized to
access this info.
Le jeton de Paiement express PayPal a été émis
pour un compte marchand autre que le vôtre.
10410
Invalid token
Jeton incorrect.
Guide de développement et référence de l’API NVP
Janvier 2008
Traitement de cette
erreur…
119
Liste de référence des messages d'erreur
Erreurs de l'API Paiement express PayPal
TABLEAU B.3 Erreurs de l'API SetExpressCheckout
Code
d'erreur
10411
120
Traitement de cette
erreur…
Message court
Message long
This Express
Checkout session
has expired.
Cette session de Paiement express PayPal a
expiré. La valeur du jeton n'est plus valable.
Janvier 2008
Le jeton renvoyé par
SetExpressCheckoutRes
ponse expire au bout de
trois heures. Si vous essayez
d'envoyer
DoExpressCheckoutPaym
ent après ce délai, vous
recevez un code d'erreur
10411 dans
DoExpressCheckoutPaym
entResponse.
Si vous recevez cette erreur,
vous devez renvoyer votre
client vers PayPal pour qu'il
en réapprouve l'utilisation.
Affichez un message
d'erreur informant le client
que la transaction a expiré et
fournissez un bouton
permettant de retourner à
PayPal. Dans ce cas, vous
redémarrez en fait la totalité
de la procédure de paiement.
(Ne réutilisez pas la valeur
du jeton ayant expiré dans
SetExpressCheckoutReq
uest.) Toutefois, comme
vous connaissez déjà la
valeur finale de
OrderTotal, n'oubliez pas
d'en actualiser la valeur, le
cas échéant. Vous devrez
peut-être aussi actualiser la
valeur de ReturnURL et de
CancelURL, si nécessaire.
Guide de développement et référence de l’API NVP
Liste de référence des messages d'erreur
Erreurs de l'API Paiement express PayPal
TABLEAU B.3 Erreurs de l'API SetExpressCheckout
Code
d'erreur
Message court
Message long
10412
Duplicate invoice
Un paiement a déjà été effectué pour cet
élément InvoiceID.
PayPal s'assure que les
valeurs de InvoiceID sont
uniques pour chaque
marchand. Si vous envoyez
une valeur de InvoiceID
déjà associée à une autre
transaction dans le système
PayPal, PayPal renvoie le
code d'erreur 10412.
Vous ne pourrez peut-être
pas corriger cette erreur
pendant une procédure de
paiement. Si vous recevez
cette erreur, recherchez-en la
cause et modifiez votre
intégration de Paiement
express PayPal de façon à
générer des numéros de
demande de paiement
uniques.
10415
Transaction refused
because of an
invalid argument.
See additional error
messages for
details.
Une transaction a déjà été réalisée pour ce
jeton.
PayPal autorise un jeton une
seule fois par transaction.
Traitement de cette erreur
Si vos clients ont tendance à
cliquer deux fois sur le
bouton « Passer
commande », PayPal vous
recommande de le désactiver
après avoir cliqué dessus.
10425
Express Checkout
has been disabled
for this merchant.
La fonction Paiement express PayPal a été
désactivée pour ce marchand. Veuillez
contacter le Service clientèle.
10432
Transaction refused
because of an
invalid argument.
See additional error
messages for
details.
La valeur de InvoiceID dépasse la longueur
maximale autorisée.
Guide de développement et référence de l’API NVP
Janvier 2008
Traitement de cette
erreur…
121
Liste de référence des messages d'erreur
Erreurs de l'API Paiement express PayPal
TABLEAU B.3 Erreurs de l'API SetExpressCheckout
Code
d'erreur
122
Traitement de cette
erreur…
Message court
Message long
10433
Transaction refused
because of an
invalid argument.
See additional error
messages for
details.
La valeur de l'élément OrderDescription est
tronquée.
10434
Transaction refused
because of an
invalid argument.
See additional error
messages for
details.
La valeur de l'élément Custom est tronquée.
10436
Transaction refused
because of an
invalid argument.
See additional error
messages for
details.
La valeur de PageStyle dépasse la longueur
maximale autorisée.
10437
Transaction refused
because of an
invalid argument.
See additional error
messages for
details.
La valeur de cpp-header-image dépasse la
longueur maximale autorisée.
10438
Transaction refused
because of an
invalid argument.
See additional error
messages for
details.
La valeur de cpp-header-image dépasse la
longueur maximale autorisée.
10439
Transaction refused
because of an
invalid argument.
See additional error
messages for
details.
La valeur de cpp-header-image dépasse la
longueur maximale autorisée.
10440
Transaction refused
because of an
invalid argument.
See additional error
messages for
details.
La valeur de cpp-header-image dépasse la
longueur maximale autorisée.
Janvier 2008
Guide de développement et référence de l’API NVP
Liste de référence des messages d'erreur
Erreurs de l'API Paiement express PayPal
TABLEAU B.3 Erreurs de l'API SetExpressCheckout
Code
d'erreur
Message court
Message long
10471
Transaction refused
because of an
invalid argument.
See additional error
messages for
details.
ReturnURL : paramètre incorrect
10472
Transaction refused
because of an
invalid argument.
See additional error
messages for
details.
CancelURL incorrect.
10476
Invalid Data
Dépassement du nombre maximal
d'autorisations de facturation.
10477
Invalid Data
Plusieurs autorisations de facturation
spécifiées pour la transaction de référence.
10478
Invalid Data
Une description du profil de paiement
récurrent doit être fournie si le type
d'autorisation de facturation est Paiements
récurrents.
10479
Invalid Data
Plusieurs types d'autorisation de facturation ne
peuvent pas être mêlés dans le même projet.
10480
Invalid Data
Type d'autorisation de facturation incorrect.
10537
Risk Control
Country Filter
Failure
La transaction a été refusée car le pays est
interdit dans vos paramètres de contrôle des
risques pour les pays sous surveillance.
10538
Risk Control Max
Amount Failure
La transaction a été refusée car le montant
maximum a été dépassé dans vos paramètres
de contrôle des risques pour le montant
maximum.
10539
Payment declined
by your Risk
Controls settings:
PayPal Risk
Model.
Paiement rejeté par vos paramètres de contrôle
des risques : modèle PayPal de gestion des
risques.
10725
Shipping Address
Country Error
Une erreur s'est produite dans le champ
indiquant le pays livraison
10727
Shipping Address1
Empty
Le champ Adresse de livraison1 doit être
rempli.
Guide de développement et référence de l’API NVP
Janvier 2008
Traitement de cette
erreur…
123
Liste de référence des messages d'erreur
Erreurs de l'API Paiement express PayPal
TABLEAU B.3 Erreurs de l'API SetExpressCheckout
Code
d'erreur
Traitement de cette
erreur…
Message court
Message long
10728
Shipping Address
City Empty
Le champ Ville de livraison doit être rempli.
10729
Shipping Address
State Empty
Le champ Etat de livraison doit être rempli.
10730
Shipping Address
Postal Code Empty
Le champ Code postal de livraison doit être
rempli.
10731
Shipping Address
Country Empty
Le champ Pays de livraison doit être rempli.
10736
Shipping Address
Invalid City State
Postal Code
Incompatibilité entre la ville, l'état et le code
postale de l'adresse de livraison.
11547
Recurring
payments
temporarily
unavailable; try
again later
Paiements récurrents momentanément non
disponibles.
11601
Request for billing
address failed
La demande d'autorisation de facturation n'est
pas activée pour le marchand
11602
Request for billing
address failed
Fonction encore non disponible
TABLEAU B.4 Erreurs de l'API GetExpressCheckoutDetails
124
Code
d'erreur
Message
court
Message long
10001
Internal Error
Erreur interne
10001
Internal Error
La transaction a échoué en raison
d'une erreur interne
10001
ButtonSource
value
truncated.
Impossible de charger la
transaction
10001
ButtonSource
value
truncated.
Impossible de charger la
transaction
Traitement de cette erreur…
Janvier 2008
Guide de développement et référence de l’API NVP
Liste de référence des messages d'erreur
Erreurs de l'API Paiement express PayPal
TABLEAU B.4 Erreurs de l'API GetExpressCheckoutDetails
Code
d'erreur
Message
court
10004
Transaction
refused
because of an
invalid
argument. See
additional error
messages for
details.
Transaction refusée en raison
d’un argument incorrect. Pour en
savoir plus, reportez-vous aux
messages d'erreur
supplémentaires.
10004
Transaction
refused
because of an
invalid
argument. See
additional error
messages for
details.
Le numéro de transaction est
incorrect
10004
Invalid
transaction
type
Vous ne pouvez pas accéder aux
détails de ce type de transaction
10004
Transaction
refused
because of an
invalid
argument. See
additional error
messages for
details.
Impossible de charger la
transaction
10004
Transaction
refused
because of an
invalid
argument. See
additional error
messages for
details.
Le numéro de transaction est
incorrect
10007
Permission
denied
Vous ne disposez pas des
permissions requises pour
effectuer cet appel d’API
10007
Permission
denied
Vous ne disposez pas des
permissions requises pour
accéder aux détails de cette
transaction
Message long
Guide de développement et référence de l’API NVP
Traitement de cette erreur…
Janvier 2008
125
Liste de référence des messages d'erreur
Erreurs de l'API Paiement express PayPal
TABLEAU B.4 Erreurs de l'API GetExpressCheckoutDetails
Code
d'erreur
Message
court
10007
Permission
denied
Vous ne disposez pas des
permissions requises pour
effectuer cet appel d’API
10408
Express
Checkout
token is
missing.
Le jeton de Paiement express
PayPal est manquant.
10409
You're not
authorized to
access this
info.
Le jeton de Paiement express
PayPal a été émis pour un compte
marchand autre que le vôtre.
10410
Invalid token
Jeton incorrect.
10411
This Express
Checkout
session has
expired.
Cette session de Paiement
express PayPal a expiré. La
valeur du jeton n'est plus valable.
Message long
Traitement de cette erreur…
TABLEAU B.5 Erreurs de l'API DoExpressCheckoutPayment
Code
Message
d'erreur court
126
Message long
Traitement de cette erreur…
10001
Internal Error
La transaction a échoué en raison
d'une erreur interne
10001
Internal Error
Indique qu'une erreur interne
s'est produite. Il est possible que
le numéro de transaction soit
incorrect
10001
ButtonSource
value
truncated.
Impossible de charger la
transaction
10001
Internal Error
Erreur interne
10004
Transaction
refused
because of an
invalid
argument. See
additional error
messages for
details.
Transaction refusée en raison
d’un argument incorrect. Pour en
savoir plus, reportez-vous aux
messages d'erreur
supplémentaires.
Janvier 2008
Guide de développement et référence de l’API NVP
Liste de référence des messages d'erreur
Erreurs de l'API Paiement express PayPal
TABLEAU B.5 Erreurs de l'API DoExpressCheckoutPayment
Code
Message
d'erreur court
Message long
Traitement de cette erreur…
10004
Transaction
refused
because of an
invalid
argument. See
additional error
messages for
details.
Le numéro de transaction est
incorrect
10007
Permission
denied
Vous ne disposez pas des
permissions requises pour
effectuer cet appel d’API
10406
Transaction
refused
because of an
invalid
argument. See
additional error
messages for
details.
La valeur de PayerID est
incorrecte.
10408
Express
Checkout
token is
missing.
Le jeton de Paiement express
PayPal est manquant.
10409
You're not
authorized to
access this
info.
Le jeton de Paiement express
PayPal a été émis pour un compte
marchand autre que le vôtre.
10410
Invalid token
Jeton incorrect.
10411
This Express
Checkout
session has
expired.
Cette session de Paiement
express PayPal a expiré. La
valeur du jeton n'est plus valable.
10412
Duplicate
invoice
Un paiement a déjà été effectué
pour cet élément InvoiceID.
Guide de développement et référence de l’API NVP
Janvier 2008
127
Liste de référence des messages d'erreur
Erreurs de l'API Paiement express PayPal
TABLEAU B.5 Erreurs de l'API DoExpressCheckoutPayment
Code
Message
d'erreur court
128
Message long
Traitement de cette erreur…
Si vous incluez la valeur des éléments suivants
avec DoExpressCheckoutPayment, la somme
de leurs valeurs doit être égale à la valeur de
OrderTotal.
z ItemTotal
z ShippingTotal
z HandlingTotal
z TaxTotal
Si vous recevez cette erreur, recherchez-en la
cause et modifiez votre intégration de Paiement
express PayPal de façon à obtenir la somme
correcte de ces valeurs.
10413
Transaction
refused
because of an
invalid
argument. See
additional error
messages for
details.
Les montants totaux des objets
du panier ne correspondent pas
aux montants de la commande.
10414
Transaction
refused
because of an
invalid
argument. See
additional error
messages for
details.
Le montant dépasse le montant
maximum autorisé pour une
seule transaction.
10415
Transaction
refused
because of an
invalid
argument. See
additional error
messages for
details.
Une transaction a déjà été
réalisée pour ce jeton.
10416
Transaction
refused
because of an
invalid
argument. See
additional error
messages for
details.
Vous avez dépassé le nombre
maximum de tentatives de
paiement pour ce jeton.
Janvier 2008
Vous pouvez envoyer 10 appels d’API
DoExpressCheckoutPayment au maximum
pour une valeur de jeton unique, après quoi il
n'est plus valable.
Guide de développement et référence de l’API NVP
Liste de référence des messages d'erreur
Erreurs de l'API Paiement express PayPal
TABLEAU B.5 Erreurs de l'API DoExpressCheckoutPayment
Code
Message
d'erreur court
Message long
Traitement de cette erreur…
Il est possible que le mode de paiement choisi par
le client sur PayPal ne soit pas accepté lorsque
vous envoyez DoExpressCheckoutPayment.
Dans la plupart des cas, la banque a refusé
d'autoriser la carte bancaire du client. Il se peut
aussi, mais plus rarement, que la valeur finale de
OrderTotal soit nettement supérieure à la
valeur estimée de OrderTotal que vous avez
envoyée avec SetExpressCheckout au point
d'intégration 1 et que la valeur finale de
OrderTotal soit refusée par l'analyse du
modèle PayPal de gestion des risques.
Si aucune autre source d'approvisionnement
PayPal du client n'est acceptable, la réponse
DoExpressCheckoutPayment renvoie le code
d'erreur 10417.
Informez le client que PayPal ne peut pas traiter
le paiement et réaffichez les autres modes de
paiement avec lesquels il peut payer.
10417
Transaction
cannot
complete.
La transaction ne peut pas
s'effectuer. Demandez au client
d'utiliser un autre mode de
paiement.
10418
Transaction
refused
because of an
invalid
argument. See
additional error
messages for
details.
Les devises des montants du
panier doivent être identiques.
10419
Express
Checkout
PayerID is
missing.
L'élément PayerID de Paiement
express PayPal est manquant.
10420
Transaction
refused
because of an
invalid
argument. See
additional error
messages for
details.
L'élément PaymentAction de
Paiement express PayPal est
manquant.
Guide de développement et référence de l’API NVP
Janvier 2008
129
Liste de référence des messages d'erreur
Erreurs de l'API Paiement express PayPal
TABLEAU B.5 Erreurs de l'API DoExpressCheckoutPayment
Code
Message
d'erreur court
130
Message long
Traitement de cette erreur…
10421
This Express
Checkout
session
belongs to a
different
customer.
Cette session de Paiement
express PayPal appartient à un
autre client. Non-concordance de
la valeur de Token.
Lorsque votre client se connecte à PayPal, la
valeur de PayerID de PayPal est associée au
jeton de Paiement express PayPal. Cette erreur
est due au mélange de jetons pour deux PayerID
différents. Les valeurs de Token et de PayerID
renvoyées pour un client par la réponse
GetExpressCheckoutDetails doivent être
identiques à celles que vous avez envoyées avec
DoExpressCheckoutPayment.
Vérifiez que vos programmes associent
correctement les éléments Token et PayerID.
10422
Customer must
choose new
funding
sources.
Le client doit revenir à PayPal
pour sélectionner de nouvelles
sources d'approvisionnement.
Il est possible que le mode de paiement choisi par
le client sur PayPal ne soit pas accepté lorsque
vous envoyez DoExpressCheckoutPayment.
Si le client dispose d'une source
d'approvisionnement susceptible d'être acceptée,
la réponse DoExpressCheckoutPayment
renvoie le code d'erreur 10422 pour que vous le
redirigiez vers PayPal.
10423
Transaction
refused
because of an
invalid
argument. See
additional error
messages for
details.
Cette transaction ne peut pas
s'effectuer avec PaymentAction
défini sur Authorization.
Cette erreur se produit si au point d'intégration 1,
vous avez défini PaymentAction sur Sale
avec la requête SetExpressCheckout mais
qu'au point d'intégration 3, vous avez défini
PaymentAction sur Authorization avec
DoExpressCheckoutPayment.
PayPal n'autorise pas ce passage de Sale à
Authorization dans une même session de
paiement.
Néanmoins, PayPal autorise l'inverse. Vous
pouvez définir PaymentAction sur
Authorization avec SetExpressCheckout
au point d'intégration 1 et faire passer
PaymentAction sur Sale avec
DoExpressCheckoutPayment au point
d'intégration 3.
Janvier 2008
Guide de développement et référence de l’API NVP
Liste de référence des messages d'erreur
Erreurs de l'API Paiement express PayPal
TABLEAU B.5 Erreurs de l'API DoExpressCheckoutPayment
Code
Message
d'erreur court
Message long
Traitement de cette erreur…
Si vous recevez ce message d'erreur, PayPal vous
recommande de renvoyer votre client vers PayPal
pour qu'il consulte et approuve de nouvelles
sources d'approvisionnement correctes. Bien que
cette erreur se produise rarement, pensez à la
récupérer afin d'afficher un message auprès du
client décrivant ce qu'il s'est passé, avec un
bouton ou un lien permettant de revenir vers
PayPal. Pour connaître les règles de ce calcul,
consultez le chapitre concernant les pratiques
recommandées dans le Guide d'intégration de
Paiement express PayPal.
10424
Transaction
refused
because of an
invalid
argument. See
additional error
messages for
details.
L'adresse de livraison est
incorrecte.
10426
Transaction
refused
because of an
invalid
argument. See
additional error
messages for
details.
Le total des objets est incorrect.
10427
Transaction
refused
because of an
invalid
argument. See
additional error
messages for
details.
Le total de la livraison est
incorrect.
10428
Transaction
refused
because of an
invalid
argument. See
additional error
messages for
details.
Le total des frais de dossier est
incorrect.
10429
Transaction
refused
because of an
invalid
argument. See
additional error
messages for
details.
Le total de la TVA est incorrect.
Guide de développement et référence de l’API NVP
Janvier 2008
131
Liste de référence des messages d'erreur
Erreurs de l'API Paiement express PayPal
TABLEAU B.5 Erreurs de l'API DoExpressCheckoutPayment
Code
Message
d'erreur court
132
Message long
Traitement de cette erreur…
10431
Le montant des
objets est
incorrect.
Le montant des objets est
incorrect.
10432
Transaction
refused
because of an
invalid
argument. See
additional error
messages for
details.
La valeur de InvoiceID dépasse
la longueur maximale autorisée.
10433
Transaction
refused
because of an
invalid
argument. See
additional error
messages for
details.
La valeur de l'élément
OrderDescription est tronquée.
10434
Transaction
refused
because of an
invalid
argument. See
additional error
messages for
details.
La valeur de l'élément Custom
est tronquée.
10435
Transaction
refused
because of an
invalid
argument. See
additional error
messages for
details.
Le client n'a pas encore confirmé
de paiement pour cette session de
Paiement express PayPal.
10441
Transaction
refused
because of an
invalid
argument. See
additional error
messages for
details.
La valeur de NotifyURL dépasse
la longueur maximale autorisée.
Janvier 2008
Guide de développement et référence de l’API NVP
Liste de référence des messages d'erreur
Erreurs de l'API Paiement express PayPal
TABLEAU B.5 Erreurs de l'API DoExpressCheckoutPayment
Code
Message
d'erreur court
Message long
Traitement de cette erreur…
10442
ButtonSource
value
truncated.
La valeur de l'élément
ButtonSource dépasse la
longueur maximale autorisée.
10443
Transaction
refused
because of an
invalid
argument. See
additional error
messages for
details.
Cette transaction ne peut pas
s'effectuer avec PaymentAction
défini sur Order.
10444
Transaction
refused
because of an
invalid
argument. See
additional error
messages for
details.
La devise spécifiée pour la
transaction doit être identique à
celle définie précédemment.
10445
This
transaction
cannot be
processed at
this time.
Please try
again later.
Impossible de traiter maintenant
cette transaction. Veuillez
réessayer ultérieurement.
10446
Unconfirmed
email
Un email confirmé est nécessaire
pour effectuer cet appel d’API.
10474
Invalid Data
Impossible de traiter cette
transaction. Le code pays de
l'adresse d'expédition doit
correspondre au pays de
résidence de l'acheteur.
10537
Risk Control
Country Filter
Failure
La transaction a été refusée car le
pays est interdit dans vos
paramètres de contrôle des
risques pour les pays sous
surveillance.
Guide de développement et référence de l’API NVP
Janvier 2008
L'acheteur sélectionne le pays de résidence
lorsqu'il ouvre son compte PayPal. Le pays de
résidence s'affiche après le tiret dans le titre de la
page Aperçu du compte.
133
Liste de référence des messages d'erreur
Erreurs de l'API Paiement express PayPal
TABLEAU B.5 Erreurs de l'API DoExpressCheckoutPayment
Code
Message
d'erreur court
134
Message long
Traitement de cette erreur…
10538
Risk Control
Max Amount
Failure
La transaction a été refusée car le
montant maximum a été dépassé
dans vos paramètres de contrôle
des risques pour le montant
maximum.
10539
Payment
declined by
your Risk
Controls
settings:
PayPal Risk
Model.
Paiement rejeté par vos
paramètres de contrôle des
risques : modèle PayPal de
gestion des risques.
10725
Shipping
Address
Country Error
Une erreur s'est produite dans le
champ indiquant le pays livraison
10727
Shipping
Address1
Empty
Le champ Adresse de livraison1
doit être rempli.
10728
Shipping
Address City
Empty
Le champ Ville de livraison doit
être rempli.
10729
Shipping
Address State
Empty
Le champ Etat de livraison doit
être rempli.
10730
Shipping
Address Postal
Code Empty
Le champ Code postal de
livraison doit être rempli.
10731
Shipping
Address
Country Empty
Le champ Pays de livraison doit
être rempli.
10736
Shipping
Address
Invalid City
State Postal
Code
Incompatibilité entre la ville,
l'Etat et le code postal de
l'adresse de livraison.
Janvier 2008
Guide de développement et référence de l’API NVP
Liste de référence des messages d'erreur
Messages d'erreur de l'API Autorisation et collecte
Messages d'erreur de l'API Autorisation et collecte
TABLEAU B.6 Messages d'erreur de l'API Autorisation et collecte
Code
Message
d'erreur court
Message
long
10001
Internal Error
Erreur interne
10001
Internal Error
La transaction a échoué en
raison d'une erreur interne
10004
Internal Error
Argument incorrect
10007
Permission
denied
Vous ne disposez pas des
permissions requises pour
effectuer cet appel d’API
10009
Transaction
refused
Le compte est verrouillé ou
inactif
10010
Transaction
refused because
of an invalid
argument. See
additional error
messages for
details.
Argument incorrect
10202
Exceed max
La transaction dépasserait le
montant maximal mensuel
de l'utilisateur
DoAuthorization
DoCapture
10600
Authorization
voided.
L'autorisation est annulée.
DoAuthorization
DoCapture
DoReauthorization
DoVoid
Fermez la commande ou
l'autorisation.
10601
Authorization
expired.
L'autorisation a expiré.
DoAuthorization
DoCapture
DoReauthorization
DoVoid
Fermez la commande ou
l'autorisation.
10602
Authorization
completed.
L'autorisation est déjà
terminée.
DoAuthorization
DoCapture
DoReauthorization
DoVoid
Fermez la commande ou
l'autorisation.
Guide de développement et référence de l’API NVP
Renvoyé par l'appel
d’API...
Traitement de cette
erreur…
Relancez la requête
ultérieurement ou fermez
la commande.
Janvier 2008
135
Liste de référence des messages d'erreur
Messages d'erreur de l'API Autorisation et collecte
TABLEAU B.6 Messages d'erreur de l'API Autorisation et collecte
136
Code
Message
d'erreur court
Message
long
Renvoyé par l'appel
d’API...
Traitement de cette
erreur…
10603
The buyer is
restricted.
Le compte de l'acheteur a un
accès restreint.
DoAuthorization
DoCapture
DoReauthorization
DoVoid
Contactez l'acheteur.
10604
Authorization
must include
both buyer and
seller.
La transaction d'autorisation
ne peut pas être unilatérale.
Elle doit inclure l'acheteur et
le vendeur.
DoAuthorization
Vérifiez dans la
commande que le client et
le vendeur sont tous deux
membres de PayPal.
10605
Unsupported
currency.
Nous n'acceptons pas cette
devise.
DoAuthorization
DoCapture
Réessayez la requête avec
une devise acceptée par
PayPal.
10606
Buyer cannot
pay.
Transaction rejetée,
contactez l'acheteur.
DoAuthorization
DoCapture
DoReauthorization
Contactez l'acheteur.
10607
Auth&Capture
unavailable.
La fonction Autorisation et
collecte est indisponible.
DoAuthorization
DoCapture
DoReauthorization
DoVoid
Contactez le Service
clientèle de PayPal.
10608
Funding source
missing.
La source
d'approvisionnement est
manquante.
DoAuthorization
DoCapture
DoReauthorization
Contactez l'acheteur.
10609
Invalid
transactionID.
Le numéro de transaction est
incorrect.
DoAuthorization
DoCapture
DoReauthorization
DoVoid
Vérifiez la validité du
numéro d'autorisation et
réessayez la requête.
10610
Amount limit
exceeded.
Le montant spécifié est
supérieur à la limite
autorisée.
DoAuthorization
DoCapture
DoReauthorization
Réessayez la requête en
indiquant un montant
inférieur.
10611
Not enabled.
La fonction Autorisation et
collecte n’est pas activée
pour le marchand. Contactez
le Service clientèle.
DoAuthorization
DoCapture
DoReauthorization
Contactez le Service
clientèle de PayPal.
10612
No more
settlement.
Le nombre maximum de
règlements autorisés a été
atteint. Plus aucun règlement
n'est possible pour
l'autorisation.
DoCapture
Fermez la commande.
Janvier 2008
Guide de développement et référence de l’API NVP
Liste de référence des messages d'erreur
Messages d'erreur de l'API Autorisation et collecte
TABLEAU B.6 Messages d'erreur de l'API Autorisation et collecte
Code
Message
d'erreur court
Message
long
Renvoyé par l'appel
d’API...
Traitement de cette
erreur…
10613
Currency
mismatch.
La devise de collecte doit
être identique à la devise
d'autorisation.
DoCapture
Vérifiez que les devises
sont identiques et
réessayez la requête.
10614
Cannot void
reauth.
Vous ne pouvez annuler que
l'autorisation initiale, mais
pas une nouvelle
autorisation.
DoVoid
Annulez l'autorisation.
10615
Cannot reauth
reauth.
Vous ne pouvez renouveler
que l'autorisation initiale,
mais pas une nouvelle
autorisation.
DoReauthorization
Collectez la nouvelle
autorisation.
10616
Maximum
number of
reauthorization
allowed for the
auth is reached.
Le nombre maximum de
nouvelles autorisations
permises pour l'autorisation
est atteint.
DoReauthorization
Collectez ou fermez
l'autorisation
10617
Reauthorization
not allowed.
La nouvelle autorisation
n'est pas permise dans la
période de validité.
DoReauthorization
Collectez l'autorisation ou
la nouvelle autorisation en
dehors de la période de
validité.
10618
Transaction
already voided
or expired.
La transaction est déjà
annulée ou a expiré.
DoAuthorization
DoCapture
DoReauthorization
DoVoid
Fermez la commande ou
l'autorisation.
10619
Invoice ID value
exceeds
maximum
allowable
length.
La valeur de InvoiceID
dépasse la longueur
maximale autorisée.
DoCapture
Vérifiez la longueur du
numéro de demande de
paiement et réessayez la
requête.
10620
Order has
already been
voided, expired
or completed.
La commande est déjà
annulée, a expiré ou est
terminée.
DoAuthorization
DoCapture
DoVoid
Fermez cette commande.
10621
Order has
expired.
La commande a expiré.
DoAuthorization
DoCapture
DoVoid
Fermez cette commande.
10622
Order is voided.
La commande est annulée.
DoAuthorization
DoCapture
DoVoid
Fermez cette commande.
Guide de développement et référence de l’API NVP
Janvier 2008
137
Liste de référence des messages d'erreur
Messages d'erreur de l'API Autorisation et collecte
TABLEAU B.6 Messages d'erreur de l'API Autorisation et collecte
138
Code
Message
d'erreur court
Message
long
Renvoyé par l'appel
d’API...
Traitement de cette
erreur…
10623
Maximum
number of
authorization
allowed for the
order is reached.
Le nombre maximum
d'autorisations permises
pour la commande est
atteint.
DoAuthorization
DoCapture
DoReauthorization
DoVoid
Collectez cette
commande.
10624
Duplicate
invoice
Un paiement a déjà été
effectué pour cet élément
InvoiceID.
DoAuthorization
Vérifiez le numéro de
demande de paiement et
réessayez la requête.
10625
Transaction
refused because
of an invalid
argument. See
additional error
messages for
details.
Le montant dépasse le
montant maximum autorisé
pour une seule transaction.
DoAuthorization
DoCapture
DoReauthorization
Réessayez la requête en
indiquant un montant
inférieur.
10626
Risk
Transaction refusée en
raison du modèle de gestion
des risques
DoAuthorization
DoCapture
DoReauthorization
Contactez l'acheteur.
10627
Transaction
refused because
of an invalid
argument. See
additional error
messages for
details.
Le champ InvoiceID n'est
pas accepté pour les
autorisations de base
DoAuthorization
DoReauthorization
DoVoid
Le champ InvoiceID ne
peut être utilisé qu'avec
DoCapture.
10628
This transaction
cannot be
processed at this
time. Please try
again later.
Impossible de traiter
maintenant cette transaction.
Veuillez réessayer
ultérieurement.
DoAuthorization
DoCapture
DoReauthorization
DoVoid
Réessayez la requête
ultérieurement.
10629
Reauthorization
not allowed.
La nouvelle autorisation
n'est pas permise pour ce
type d'autorisation.
DoReauthorization
Utilisez DoAuthorization
pour autoriser la
commande.
10630
Item amount is
invalid.
Le montant des objets est
incorrect.
DoAuthorization
DoCapture
Vérifiez que le montant
des objets n'a pas la valeur
zéro ou une valeur
négative.
Janvier 2008
Guide de développement et référence de l’API NVP
Liste de référence des messages d'erreur
Erreurs de l'API RefundTransaction
TABLEAU B.6 Messages d'erreur de l'API Autorisation et collecte
Code
Message
d'erreur court
Message
long
11094
Cette autorisation ne peut
être gérée que dans
l'environnement de création.
Il est impossible de l'annuler,
de l'autoriser à nouveau ou
de la collecter.
This
authorization
cannot be
voided,
reauthorized, or
captured
against.
Renvoyé par l'appel
d’API...
Traitement de cette
erreur…
Erreurs de l'API RefundTransaction
TABLEAU B.7 Erreurs de l'API RefundTransaction
Code
d'erreur
Message
court
Message long
10001
Internal Error
Erreur interne
10001
Internal Error
Indique qu'une erreur interne s'est produite. Il
est possible que le numéro de transaction soit
incorrect
10001
ButtonSource
value
truncated.
Impossible de charger la transaction
10001
Internal Error
Erreur interne
10004
Transaction
refused
because of an
invalid
argument. See
additional error
messages for
details.
Le montant du remboursement partiel doit être
une valeur positive
10004
Transaction
refused
because of an
invalid
argument. See
additional error
messages for
details.
Vous ne pouvez pas spécifier un montant
partiel avec un remboursement intégral
Guide de développement et référence de l’API NVP
Traitement de cette erreur…
Janvier 2008
139
Liste de référence des messages d'erreur
Erreurs de l'API RefundTransaction
TABLEAU B.7 Erreurs de l'API RefundTransaction
140
Code
d'erreur
Message
court
10004
Transaction
refused
because of an
invalid
argument. See
additional error
messages for
details.
Un numéro de transaction est obligatoire
10004
Transaction
refused
because of an
invalid
argument. See
additional error
messages for
details.
Le montant du remboursement partiel doit être
une valeur positive
10004
Transaction
refused
because of an
invalid
argument. See
additional error
messages for
details.
Vous ne pouvez pas spécifier un montant
partiel avec un remboursement intégral
10004
Transaction
refused
because of an
invalid
argument. See
additional error
messages for
details.
Un numéro de transaction est obligatoire
10004
Transaction
refused
because of an
invalid
argument. See
additional error
messages for
details.
La catégorie de la transaction n'est pas
acceptée
Message long
Traitement de cette erreur…
Janvier 2008
Guide de développement et référence de l’API NVP
Liste de référence des messages d'erreur
Erreurs de l'API RefundTransaction
TABLEAU B.7 Erreurs de l'API RefundTransaction
Code
d'erreur
Message
court
10004
Transaction
refused
because of an
invalid
argument. See
additional error
messages for
details.
Le numéro de transaction est incorrect
10007
Permission
denied
Vous ne disposez pas des permissions requises
pour rembourser cette transaction
10007
Permission
denied
Vous ne disposez pas des permissions requises
pour effectuer cet appel d’API
10009
Transaction
refused
Vous ne disposez pas d'un SIT vérifié
10009
Transaction
refused
Le montant du remboursement partiel doit être
inférieur ou égal au montant de la transaction
initiale
10009
Transaction
refused
Le montant du remboursement partiel doit être
inférieur ou égal au montant restant
10009
Transaction
refused
Le montant du remboursement partiel est
incorrect
10009
Transaction
refused
Etant donné qu'un dossier de réclamation a été
déposé pour cette transaction, seul le
remboursement du montant intégral ou du
montant intégral restant de la transaction peut
être effectué.
10009
Transaction
refused
Vous avez dépassé le délai pour effectuer un
remboursement sur cette transaction
Message long
Guide de développement et référence de l’API NVP
Traitement de cette erreur…
Janvier 2008
Cette erreur peut être due à une
provision insuffisante dans votre
solde PayPal pour couvrir le
montant du remboursement, et au
fait que vous n'avez pas encore
vérifié le compte bancaire associé à
votre compte PayPal ou que vous
ne disposez pas d'un compte
bancaire associé à votre compte
PayPal.
Assurez-vous que vous disposez
d'une provision suffisante dans
votre solde PayPal et pensez à
vérifier le compte bancaire associé.
141
Liste de référence des messages d'erreur
Erreurs de l'API RefundTransaction
TABLEAU B.7 Erreurs de l'API RefundTransaction
142
Code
d'erreur
Message
court
Message long
10009
Transaction
refused
Impossible d'effectuer un remboursement
intégral après un remboursement partiel
10009
Transaction
refused
Le compte est verrouillé ou inactif
10009
Transaction
refused
Le remboursement partiel doit être dans la
même devise que la transaction initiale
10009
Transaction
refused
Cette transaction a déjà été remboursée en
intégralité
10009
Transaction
refused
Le compte a un accès restreint
10009
Transaction
refused
Vous ne pouvez pas rembourser ce type de
transaction
10009
Transaction
refused
Vous ne pouvez pas effectuer un
remboursement partiel sur cette transaction
10009
Transaction
refused
Le compte de l'autre partie est verrouillé ou
inactif
10009
Transaction
refused
Vous ne pouvez pas rembourser ce type de
transaction
10011
Invalid
transaction id
value
La transaction a été refusée à cause d'une
valeur de numéro de transaction incorrecte
11001
Transaction
refused
because of an
invalid
argument. See
additional error
messages for
details.
La catégorie de la transaction n'est pas
acceptée
Traitement de cette erreur…
Janvier 2008
Guide de développement et référence de l’API NVP
Liste de référence des messages d'erreur
Erreurs de l'API TransactionSearch
Erreurs de l'API TransactionSearch
TABLEAU B.8Erreurs de l'API TransactionSearch
Code
d'erreur
Message court
Message long
10001
Internal Error
Erreur interne
10001
ButtonSource value truncated.
Impossible de charger la transaction
10003
Transaction refused because
of an invalid argument. See
additional error messages for
details.
La date d'ouverture est un paramètre obligatoire
10004
Transaction refused because
of an invalid argument. See
additional error messages for
details.
La date d'ouverture est incorrecte
10004
Transaction refused because
of an invalid argument. See
additional error messages for
details.
La date de clôture est incorrecte
10004
Transaction refused because
of an invalid argument. See
additional error messages for
details.
Nous n'acceptons pas cette devise.
10004
Transaction refused because
of an invalid argument. See
additional error messages for
details.
La catégorie de la transaction n'est pas acceptée
10004
Transaction refused because
of an invalid argument. See
additional error messages for
details.
Le numéro d'avis de réception est incorrect
10004
Transaction refused because
of an invalid argument. See
additional error messages for
details.
L'email du payeur est incorrect
10004
Transaction refused because
of an invalid argument. See
additional error messages for
details.
L'identification des objets d'enchères est incorrecte
Guide de développement et référence de l’API NVP
Janvier 2008
143
Liste de référence des messages d'erreur
Erreurs de l'API GetTransactionDetails
TABLEAU B.8Erreurs de l'API TransactionSearch
Code
d'erreur
Message court
Message long
10004
Transaction refused because
of an invalid argument. See
additional error messages for
details.
L'email du bénéficiaire est incorrect
10004
Transaction refused because
of an invalid argument. See
additional error messages for
details.
Vous ne pouvez pas rechercher un numéro de transaction et un
numéro d'avis de réception
10004
Transaction refused because
of an invalid argument. See
additional error messages for
details.
Le bénéficiaire ne peut être spécifié que pour les paiements reçus
10004
Transaction refused because
of an invalid argument. See
additional error messages for
details.
Le numéro de transaction est incorrect
10007
Permission denied
Vous ne disposez pas des permissions requises pour rechercher cette
transaction
10007
Permission denied
Vous ne disposez pas des permissions requises pour effectuer cet
appel d’API
11002
Search warning
Le nombre de résultats est tronqué. Veuillez modifier vos paramètres
de recherche si vous souhaitez afficher tous vos résultats.
Erreurs de l'API GetTransactionDetails
TABLEAU B.9 Erreurs de l'API GetTransactionDetails
144
Code
d'erreur
Message
court
Message long
10001
Internal Error
Erreur interne
Janvier 2008
Guide de développement et référence de l’API NVP
Liste de référence des messages d'erreur
Erreurs de l'API MassPay
Erreurs de l'API MassPay
TABLEAU B.10 Erreurs de l'API MassPay
Code
d'erreur
Message
court
Message long
10001
Invalid account
number.
La transaction a échoué en raison d'un numéro de carte bancaire
incorrect. Vérifiez le numéro ou essayez une autre carte.
10001
Internal Error
Erreur interne
10001
Internal Error
Impossible de charger la transaction
10001
ButtonSource
value
truncated.
Impossible de charger la transaction
10001
Transaction
refused
because of an
invalid
argument. See
additional error
messages for
details.
L'élément receiver_type de Paiements groupés n'est pas un type
reconnaissable
10002
Account
locked
Le compte de l'utilisateur est verrouillé
10004
Transaction
refused
because of an
invalid
argument. See
additional error
messages for
details.
Le nombre d'enregistrements d'entrée est supérieur à la valeur
maximale autorisée
10004
Transaction
refused
because of an
invalid
argument. See
additional error
messages for
details.
Le nombre d'enregistrements d'entrée est inférieur ou égal à zéro
Guide de développement et référence de l’API NVP
Janvier 2008
145
Liste de référence des messages d'erreur
Erreurs de l'API MassPay
TABLEAU B.10 Erreurs de l'API MassPay
146
Code
d'erreur
Message
court
10004
Transaction
refused
because of an
invalid
argument. See
additional error
messages for
details.
La longueur de la chaîne de remarque dépasse la limite maximale
de 4000 caractères
10004
Transaction
refused
because of an
invalid
argument. See
additional error
messages for
details.
Le montant est manquant
10004
Transaction
refused
because of an
invalid
argument. See
additional error
messages for
details.
La devise est manquante
10004
Transaction
refused
because of an
invalid
argument. See
additional error
messages for
details.
Nous n'acceptons pas cette devise.
10004
Transaction
refused
because of an
invalid
argument. See
additional error
messages for
details.
Le montant n'est pas un nombre correct
Message long
Janvier 2008
Guide de développement et référence de l’API NVP
Liste de référence des messages d'erreur
Erreurs de l'API MassPay
TABLEAU B.10 Erreurs de l'API MassPay
Code
d'erreur
Message
court
10004
Transaction
refused
because of an
invalid
argument. See
additional error
messages for
details.
Le montant dépasse la limite maximale pour un objet de
paiements groupés unique
10004
Transaction
refused
because of an
invalid
argument. See
additional error
messages for
details.
Le montant est inférieur ou égal à zéro
10004
Transaction
refused
because of an
invalid
argument. See
additional error
messages for
details.
La longueur de la chaîne d'identification unique dépasse la limite
maximale de 30 caractères
10004
Transaction
refused
because of an
invalid
argument. See
additional error
messages for
details.
La chaîne d'identification unique contient un espace comme
caractère
10004
Transaction
refused
because of an
invalid
argument. See
additional error
messages for
details.
Le numéro de transaction est incorrect
10007
Permission
denied
Vous ne disposez pas des permissions requises pour effectuer cet
appel d’API
Guide de développement et référence de l’API NVP
Message long
Janvier 2008
147
Liste de référence des messages d'erreur
Erreurs de l'API MassPay
TABLEAU B.10 Erreurs de l'API MassPay
148
Code
d'erreur
Message
court
Message long
10301
User not
allowed
L'utilisateur n'est pas autorisé à effectuer un paiement via la
fonction Paiements groupés
10303
Restricted
account
Le compte a un accès restreint
10304
Unconfirmed
email
Le compte de l'utilisateur a un email non confirmé
10305
Limit
Exceeded
La limite de paiement du compte de l'utilisateur doit être
supprimée pour pouvoir effectuer un paiement groupé.
10306
Limit
Exceeded
La limite de paiement du compte hors des Etats-Unis de
l'utilisateur doit être supprimée pour pouvoir effectuer un
paiement groupé
10307
Receive only
account
Le compte de l'utilisateur est un compte de dépôts uniquement;
par conséquent, aucun paiement ne peut être effectué
10308
Masspay
server
configuration
error
Une erreur de configuration s'est produite.
10309
Masspay
server
unavailable
Le serveur de paiements groupés est indisponible
10310
Unable to
create payment
Impossible de créer des paiements pour les paiements groupés
10311
Unable to
submit
payment
Impossible de soumettre des paiements pour les paiements
groupés
10312
Masspay
server error
Le serveur de paiements groupés a signalé des erreurs.
10313
Masspay
Invalid Data
Le fichier d'entrée des paiements groupés contient des données
incorrectes
10314
Masspay input
parse error
Le fichier d'entrée du serveur de paiements groupés est incorrect.
Vérifiez que vous utilisez un fichier d'entrée correctement
formaté.
10317
Masspay
Invalid Email
Le fichier d'entrée des paiements groupés contient un email
incorrect
10320
Internal Error
Erreur interne
Janvier 2008
Guide de développement et référence de l’API NVP
Liste de référence des messages d'erreur
Erreurs de l'API MassPay
TABLEAU B.10 Erreurs de l'API MassPay
Code
d'erreur
Message
court
Message long
10321
Insufficient
funds
Le compte ne dispose pas d'une provision suffisante pour
effectuer ces paiements groupés
10327
Masspay
Invalid UserID
Le fichier d'entrée des paiements groupés contient un UserID
incorrect
Guide de développement et référence de l’API NVP
Janvier 2008
149
Liste de référence des messages d'erreur
Erreurs d'API des paiements récurrents et des transactions de référence
Erreurs d'API des paiements récurrents
et des transactions de référence
Erreurs de paiements récurrents
Le tableau ci-dessous répertorie les erreurs d'API suivantes relatives aux profils de paiement
récurrent :
z
CreateRecurringPaymentsProfile
z
GetRecurringPaymentsProfileDetails
z
ManageRecurringPaymentsProfileStatus
z
UpdateRecurringPaymentsProfile
z
BillOutstandingAmount
TABLEAU B.11 Erreurs de paiements récurrents
Code
d'erreur
150
Informations
supplémentaires
Message court
Message long
10001
Invalid account
number.
La transaction a échoué en raison
d'un numéro de carte bancaire
incorrect. Vérifiez le numéro ou
essayez une autre carte bancaire.
10478
Invalid Data
Une description du profil de
paiement récurrent doit être
fournie si le type d'autorisation de
facturation est Paiements
récurrents.
10501
Invalid Configuration
Cette transaction ne peut pas être
traitée en raison d'une
configuration incorrecte du
marchand.
Se produit lorsque l'autorisation
de facturation est désactivée ou
inactive.
10502
Invalid Data
Impossible de traiter cette
transaction. Veuillez utiliser une
carte bancaire en cours de validité.
La carte bancaire utilisée a
expiré.
10504
Invalid Data
Impossible de traiter cette
transaction. Veuillez entrer un
cryptogramme visuel correct.
Le CVV (cryptogramme visuel)
fourni est incorrect. Le CVV doit
contenir entre 3 et 4 chiffres.
10505
Gateway Decline
Impossible de traiter cette
transaction.
Cette transaction a été refusée
car la réponse du système de
vérification d'adresse a renvoyé
la valeur N, et le compte
marchand ne peut pas accepter
ces transactions.
Janvier 2008
Guide de développement et référence de l’API NVP
Liste de référence des messages d'erreur
Erreurs d'API des paiements récurrents et des transactions de référence
TABLEAU B.11 Erreurs de paiements récurrents
Code
d'erreur
Message court
Message long
Informations
supplémentaires
10507
Invalid Configuration
Impossible de traiter cette
transaction. Veuillez contacter le
Service clientèle de PayPal.
Votre compte PayPal a un accès
restreint. Pour en savoir plus,
contactez PayPal.
10508
Invalid Data
Impossible de traiter cette
transaction. Veuillez entrer la date
d'expiration figurant sur la carte
bancaire.
La date d'expiration doit
comporter deux chiffres pour le
mois et quatre chiffres pour
l'année.
10509
Invalid Data
Impossible de traiter cette
transaction.
Vous devez soumettre l'adresse
IP de l'acheteur avec chaque
appel d’API.
10510
Invalid Data
Le type de carte bancaire n'est pas
accepté. Essayez un autre type de
carte.
Le type de carte bancaire saisi
n'est pas accepté actuellement
par PayPal.
10511
Invalid Data
Impossible de traiter cette
transaction.
Le marchand a sélectionné une
valeur pour le champ
PaymentAction qui n'est pas
acceptée
10512
Invalid Data
Impossible de traiter cette
transaction. Veuillez entrer un
prénom.
Le prénom de l'acheteur est
obligatoire pour ce marchand
10513
Invalid Data
Impossible de traiter cette
transaction. Veuillez entrer un
nom.
Le nom de l'acheteur est
obligatoire pour ce marchand
10535
Gateway Decline
Impossible de traiter cette
transaction. Veuillez entrer un
numéro correct et un type de carte
bancaire pris en charge.
10548
Invalid Configuration
Impossible de traiter cette
transaction. Le compte du
marchand ne peut pas traiter les
transactions.
10561
Invalid Data
Une erreur s'est produite dans cette
transaction. Veuillez entrer une
adresse de facturation complète.
10565
Merchant country
unsupported
Le pays du marchand n'est pas pris
en charge.
10709
Invalid Data
Une erreur s'est produite dans cette
transaction. Veuillez saisir une
valeur address1 dans l'adresse de
facturation.
Guide de développement et référence de l’API NVP
Janvier 2008
Le compte marchand qui tente la
transaction n'est pas un compte
Business chez PayPal. Vérifiez
les paramètres de votre compte.
Une erreur s'est produite dans un
champ de l'adresse. Le long
message d'erreur vous indiquera
le champ incorrect.
151
Liste de référence des messages d'erreur
Erreurs d'API des paiements récurrents et des transactions de référence
TABLEAU B.11 Erreurs de paiements récurrents
152
Code
d'erreur
Message court
Message long
10710
Invalid Data
Une erreur s'est produite dans cette
transaction. Veuillez saisir une
ville dans l'adresse de facturation.
Une erreur s'est produite dans un
champ de l'adresse. Le long
message d'erreur vous indiquera
le champ incorrect.
10711
Invalid Data
Une erreur s'est produite dans cette
transaction. Veuillez saisir votre
état dans l'adresse de facturation.
Une erreur s'est produite dans un
champ de l'adresse. Le long
message d'erreur vous indiquera
le champ incorrect.
10712
Invalid Data
Une erreur s'est produite dans cette
transaction. Veuillez entrer votre
code postal à cinq chiffres dans
l'adresse de facturation.
Une erreur s'est produite dans un
champ de l'adresse. Le long
message d'erreur vous indiquera
le champ incorrect.
10713
Invalid Data
Une erreur s'est produite dans cette
transaction. Veuillez saisir un pays
dans l'adresse de facturation.
Une erreur s'est produite dans un
champ de l'adresse. Le long
message d'erreur vous indiquera
le champ incorrect.
10744
Invalid Data
Impossible de traiter cette
transaction. Veuillez saisir un code
pays valable dans l'adresse de
facturation.
Une erreur s'est produite dans un
champ de l'adresse. Le long
message d'erreur vous indiquera
le champ incorrect.
10748
Invalid Data
Impossible de traiter cette
transaction sans un cryptogramme
visuel.
La configuration du marchand
nécessite la saisie d'un CVV
(cryptogramme visuel), mais
aucun cryptogramme visuel n'a
été fourni avec cette transaction.
Contactez PayPal si vous
souhaitez modifier ce paramètre.
10751
Invalid Data
Une erreur s'est produite dans cette
transaction. Veuillez saisir un état
qui convient dans l'adresse de
facturation.
Le marchand a fourni une
adresse aux Etats-Unis ou au
Canada, mais l'état indiqué
n'existe dans aucun des deux
pays.
10752
Gateway Decline
Impossible de traiter cette
transaction.
La transaction a été refusée par
la banque émettrice, et non par
PayPal. Le marchand doit
essayer une autre carte.
11089
Transaction refused
Le compte est verrouillé ou inactif.
11501
Invalid merchant
country
Le pays du marchand n'est pas pris
en charge actuellement
Janvier 2008
Informations
supplémentaires
Guide de développement et référence de l’API NVP
Liste de référence des messages d'erreur
Erreurs d'API des paiements récurrents et des transactions de référence
TABLEAU B.11 Erreurs de paiements récurrents
Code
d'erreur
Message court
Message long
Informations
supplémentaires
11502
The token is missing
or is invalid
Le jeton est manquant ou incorrect
Jeton manquant
11503
Missing subscription
details
Détails de l'abonnement
manquants
Un ou plusieurs des champs des
détails de l'abonnement sont
absents de la requête.
11504
Missing schedule
details
Détails de la grille tarifaire
manquants
Un ou plusieurs des champs des
détails du calendrier sont absents
de la requête.
11505
Start date should be
greater than current
date
La date de début de l'abonnement
doit être postérieure à la date du
jour
11506
Invalid max failed
payments
Nombre d'échecs de paiement
maximum, si fourni, doit être >= 0
11507
Invalid trial amount
Le montant d'essai doit être >= 0
11508
Invalid trial total
billing cycles
Le total des échéances de
facturation de la période d'essai
doit être > 0
11509
Invalid trial billing
period
La période de la facturation d'essai
doit correspondre à l'une des
valeurs suivantes : Day, Week,
Month, SemiMonth ou Year
11510
Invalid trial amount
Le montant d'essai doit être >= 0
11511
Invalid currency for
trial amount
Cette devise n'est actuellement pas
prise en charge pour le montant
prélevé pendant la période d'essai.
La devise doit être USD.
11512
Invalid trial shipping
amount
Le montant de livraison d'essai doit
être >= 0
Si des frais d'expédition sont
indiqués pour la période d'essai,
ils doivent être >= 0.
11513
Invalid currency for
trial shipping amount
Cette devise n'est actuellement pas
prise en charge pour les frais
d'expédition pendant la période
d'essai.
La devise doit être USD.
11514
Invalid profile status
L'état du profil est incorrect.
11515
Invalid currency for
trial tax amount
Cette devise n'est actuellement pas
prise en charge pour la TVA
facturée pendant la période d'essai.
Guide de développement et référence de l’API NVP
Janvier 2008
La devise doit être USD.
153
Liste de référence des messages d'erreur
Erreurs d'API des paiements récurrents et des transactions de référence
TABLEAU B.11 Erreurs de paiements récurrents
Code
d'erreur
154
Informations
supplémentaires
Message court
Message long
11516
Invalid billing
frequency
La fréquence de facturation doit
être > 0 et inférieure ou égale à un
an
11517
Invalid total billing
cycles
Le total des cycles de facturation
doit être >= 0 (0 signifie continu)
11518
Invalid billing period
La période de facturation doit
correspondre à l'une des valeurs
suivantes : Day, Week, Month,
SemiMonth ou Year
11519
Invalid amount
Le montant de la facture doit être
supérieur à 0
11520
Invalid currency for
amount
Cette devise n'est actuellement pas
prise en charge pour le montant
11521
Invalid shipping
amount
Le montant de livraison doit être
>= 0
11522
Invalid currency for
shipping amount
Cette devise n'est actuellement pas
prise en charge pour les frais
d'expédition
11523
Invalid tax amount
Le montant de la TVA
doit être >= 0
11524
Invalid currency for
tax amount
Cette devise n'est actuellement pas
prise en charge pour le montant de
la TVA
11531
Invalid profile status
L'état du profil doit être actif (A),
annulé (C) ou expiré (X)
11543
Invalid payer country
Le pays du payeur n'est pas pris en
charge actuellement
11544
Invalid period status
L'état de la période d'essai doit être
actif (A) ou annulé (C)
11545
Denied
Le compte du payeur est refusé
11546
Denied
Le compte marchand est refusé
11547
This feature is not
available at this time
La fonction Paiements récurrents
n'est pas disponible pour l'instant.
Réessayez plus tard.
Janvier 2008
La combinaison de la fréquence
de facturation et de la période de
facturation ne doit pas excéder
un an.
La devise doit être USD.
La devise doit être USD.
La devise doit être USD.
Guide de développement et référence de l’API NVP
Liste de référence des messages d'erreur
Erreurs d'API des paiements récurrents et des transactions de référence
TABLEAU B.11 Erreurs de paiements récurrents
Code
d'erreur
Message court
Message long
11548
Invalid currency code
Code de devise incorrect. Tous les
codes de devise doivent
correspondre
11549
Start date is required
La date d'entrée en vigueur de
l'abonnement est requise
11550
Start Date should be
valid
La date de début de l'abonnement
doit être correcte
11551
Profile ID is missing
from the request
L’identifiant du profil est absent de
la requête
11552
Invalid profile ID
L'identifiant du profil est incorrect
11553
Invalid action value
provided
La valeur de l’action fournie est
incorrecte
11554
Note is missing from
the request
La remarque ne figure pas dans la
requête
11556
Invalid profile status
for cancel action;
profile should be
active or suspended
Etat du profil incorrect pour
l'action de suspension. Le profil
devrait être actif ou suspendu
11557
Invalid profile status
for suspend action;
profile should be
active
Etat du profil incorrect pour
l'action de suspension. Le profil
devrait être actif
11558
Invalid profile status
for reactivate action;
profile should be
suspended
Etat du profil incorrect pour
l'action de réactivation. Le profil
devrait être suspendu
11560
Invalid activation type
Le type d'activation est incorrect
11561
Invalid initial amount
Le montant initial est incorrect
11562
Invalid auto bill type
Le type de facturation automatique
est incorrect
11564
The number of failed
payments should be
greater than the current
number of failed
payments
Le nombre d'échecs de paiement
doit être supérieur au nombre
actuel de ces échecs
Informations
supplémentaires
11555
Guide de développement et référence de l’API NVP
Janvier 2008
155
Liste de référence des messages d'erreur
Erreurs d'API des paiements récurrents et des transactions de référence
TABLEAU B.11 Erreurs de paiements récurrents
Code
d'erreur
156
Informations
supplémentaires
Message court
Message long
11567
The time of the update
is too close to the
billing date
Le moment de la mise à jour est
trop proche de la date de
facturation
11568
Invalid currency for
delinquent amount
Devise incorrecte pour le montant
impayé
11569
Cannot increase
delinquent amount
Augmentation du montant impayé
impossible
11570
The maximum number
of failed payments
should be greater than
the current number of
failed payments
Le nombre maximal des échecs de
paiement doit être supérieur au
nombre actuel des échecs de
paiement
11571
The total amount
cannot exceed 120%
increment per 180
days
Le montant total ne peut
augmenter de plus de 120% par
période de 180 jours
11576
Bill amount is greater
than outstanding
balance
Montant facturé supérieur au solde
débiteur
11577
Another outstanding
payment is scheduled
Un autre paiement en attente est
planifié
11578
Bill outstanding
amount not processed
because of scheduled
payment
Un paiement récurrent est planifié
dans les prochaines 24 heures, c'est
pourquoi nous ne traitons pas le
montant de la facture en attente
11579
Payment is failing
Echec du paiement
11582
No payment in queue
Aucun paiement planifié n'a été
trouvé.
11584
Inactive profile
Le profil n'est pas actif
11585
Missing Token or
buyer credit card
Jeton ou source de paiement
manquants
11587
Billing Address is
Partial
L'adresse de facturation est
incomplète
11590
Profile update is not
required
Selon votre requête d'entrée, le
profil est déjà à jour.
15004
Gateway Decline
Impossible de traiter cette
transaction. Veuillez entrer un
cryptogramme visuel correct.
Janvier 2008
Guide de développement et référence de l’API NVP
Liste de référence des messages d'erreur
Erreurs d'API des paiements récurrents et des transactions de référence
Erreurs de SetCustomerBillingAgreement
TABLEAU B.12 Erreurs de SetCustomerBillingAgreement
Code
d'erreur
Informations
supplémentaires
Message court
Message long
10004
Transaction refused
because of an invalid
argument. See
additional error
messages for details.
Argument incorrect; aucune
information dans le champ de
saisie BillingType
10404
Transaction refused
because of an invalid
argument. See
additional error
messages for details.
ReturnURL manquant.
10004
Transaction refused
because of an invalid
argument. See
additional error
messages for details.
Valeur incorrecte du paramètre de
demande d'adresse de facturation.
10405
Transaction refused
because of an invalid
argument. See
additional error
messages for details.
CancelURL manquant.
La balise CancelURL est vide
10407
Transaction refused
because of an invalid
argument. See
additional error
messages for details.
Adresse email de l'acheteur
(BuyerEmail) incorrecte.
L'adresse email de l'acheteur
(BuyerEmail) est incorrecte
(incorrectement formatée ou en
violation du protocole SMTP du
format de l'adresse email) ou est
transmise comme s'il s'agissait
d'une balise vide.
10436
Transaction refused
because of an invalid
argument. See
additional error
messages for details.
La valeur de PageStyle dépasse la
longueur maximale autorisée.
La balise PageStyle est trop
longue
10437
Transaction refused
because of an invalid
argument. See
additional error
messages for details.
La valeur de cpp-header-image
dépasse la longueur maximale
autorisée.
La balise cpp_header_image est
trop longue; la longueur
maximale est de 127
Guide de développement et référence de l’API NVP
Janvier 2008
La balise ReturnURL est vide
157
Liste de référence des messages d'erreur
Erreurs d'API des paiements récurrents et des transactions de référence
TABLEAU B.12 Erreurs de SetCustomerBillingAgreement
Code
d'erreur
158
Informations
supplémentaires
Message court
Message long
10438
Transaction refused
because of an invalid
argument. See
additional error
messages for details.
La valeur de cpp-header-bordercolor dépasse la longueur
maximale autorisée.
La balise
cpp_header_border_color est
trop longue; la longueur
maximale est de 6
10439
Transaction refused
because of an invalid
argument. See
additional error
messages for details.
La valeur de cpp-header-backcolor dépasse la longueur
maximale autorisée.
La balise
cpp_header_back_color est trop
longue; la longueur maximale
est de 6
10440
Transaction refused
because of an invalid
argument. See
additional error
messages for details.
La valeur de cpp-payflow-color
dépasse la longueur maximale
autorisée.
La balise cpp_payflow_color est
trop longue; la longueur
maximale est de 6
10471
Transaction refused
because of an invalid
argument. See
additional error
messages for details.
ReturnURL manquant.
La balise ReturnURL contient
une URL incorrecte
10472
Transaction refused
because of an invalid
argument. See
additional error
messages for details.
CancelURL incorrect.
La balise CancelURL contient
une URL incorrecte
10476
Transaction refused
because of an invalid
argument. See
additional error
messages for details.
10477
Transaction refused
because of an invalid
argument. See
additional error
messages for details.
11452
Merchant not enabled
for reference
transactions
Marchand non activé pour les
transactions de référence
Ce marchand n'est pas activé
pour les transactions de
référence. Avertissement
uniquement
Janvier 2008
Guide de développement et référence de l’API NVP
Liste de référence des messages d'erreur
Erreurs d'API des paiements récurrents et des transactions de référence
TABLEAU B.12 Erreurs de SetCustomerBillingAgreement
Code
d'erreur
Message court
Message long
Informations
supplémentaires
11453
Reference transactions
temporarily
unavailable.
La fonction Transaction de
référence n'est actuellement pas
disponible; veuillez essayer
ultérieurement
La fonction n'est pas activée
parce que le système fonctionne
en mode autonome.
Avertissement uniquement
11601
Request for billing
address failed
La demande d'autorisation de
facturation n'est pas activée pour le
marchand
11602
Request for billing
address failed
Fonction encore non disponible
Erreurs de GetBillingAgreementCustomerDetails
TABLEAU B.13 Erreurs de GetBillingAgreementCustomerDetails
Code
d'erreur
Message court
Message long
Informations
supplémentaires
10408
Express Checkout token is
missing.
Le jeton est manquant
Le jeton est manquant
10409
You're not authorized to
access this info.
Le jeton de Paiement express
PayPal a été émis pour un
compte marchand autre que le
vôtre.
Le jeton appartient à un autre
marchand
10410
Invalid token
Jeton incorrect.
Jeton incorrect
10411
This Express Checkout
session has expired.
Cette session de Paiement
express PayPal a expiré. La
valeur du jeton n'est plus
valable.
Jeton périmé
Erreurs de DoReferenceTransaction
TABLEAU B.14 Erreurs d'API relatives à toutes les transactions de référence
Code
d'erreur Message court
Message long
10001
Erreur interne
Internal Error
Guide de développement et référence de l’API NVP
Janvier 2008
Informations
supplémentaires
159
Liste de référence des messages d'erreur
Erreurs d'API des paiements récurrents et des transactions de référence
TABLEAU B.14 Erreurs d'API relatives à toutes les transactions de référence (suite)
Code
d'erreur Message court
160
Informations
supplémentaires
Message long
10002
Authentication/
Authorization Failed
10004
Transaction refused
because of an invalid
argument. See additional
error messages for details.
Argument de type de paiement
incorrect
10009
Transaction refused
Le compte de l'autre partie est
verrouillé ou inactif
Le compte marchand est
verrouillé, fermé ou restreint
10010
Invalid Invoice
Les numéros de facture contenant des
caractères autres que ASCII ne sont
pas pris en charge
Le champ InvoiceID contient
des caractères autres que ASCII
10201
Agreement canceled
L'autorisation de facturation a été
annulée
L'autorisation de facturation
n'est pas active
10202
Exceed max
La transaction dépasserait le montant
maximal mensuel de l'utilisateur
La transaction dépasserait le
montant maximal mensuel
10203
Action required
Transaction rejetée en raison d'une
action requise de la part de l'utilisateur
10204
User's account is closed or
restricted
Le compte de l'utilisateur est clos ou
restreint
10205
Risk
Transaction refusée en raison du
modèle de gestion des risques
10206
Duplicate
La transaction a déjà été traitée
10207
Retry
La transaction a échoué mais
l'utilisateur dispose d'une autre source
d'approvisionnement
Retentez la transaction avec
une autre source
d'approvisionnement.
10209
Disabled
Fonction Paiements pré-approuvés
non activée.
La fonction Paiements préapprouvés (PAP) n'est pas
activée pour ce marchand;
s'applique seulement aux
autorisations de facturation
PAP existantes
10210
No Funding
La transaction a échoué en l'absence
de source d'approvisionnement
Le bénéficiaire ne dispose
d'aucune source
d'approvisionnement.
10211
Invalid MP ID
MP ID incorrect
10212
Profile preference setting
Une préférence de profil rejette
automatiquement certaines
transactions
Janvier 2008
Une préférence de profil rejette
automatiquement ce type de
transaction
Guide de développement et référence de l’API NVP
Liste de référence des messages d'erreur
Erreurs d'API des paiements récurrents et des transactions de référence
TABLEAU B.14 Erreurs d'API relatives à toutes les transactions de référence (suite)
Code
d'erreur Message court
10213
Invalid Soft Descriptor
Message long
La valeur de SOFTDESCRIPTOR
fournie contient des caractères
incorrects
10214
10215
Informations
supplémentaires
Erreur de format de
Softdescriptor.
Soft Descriptor truncated
Softdescriptor a été tronqué
10216
Transaction refusée parce
qu'une adresse confirmée n'est
disponible
10400
Transaction refused
because of an invalid
argument. See additional
error messages for details.
La commande n'a pas de total.
Le montant TotalOrder est
manquant
10401
Transaction refused
because of an invalid
argument. See additional
error messages for details.
Le total de la commande est incorrect.
Le montant TotalOrder est
incorrect.
10402
Authorization only is not
allowed for merchant.
Ce compte marchand n'a pas le droit
de définir PaymentAction sur
Authorization. Veuillez contacter le
Service clientèle.
Marchand non admissible pour
une autorisation de règlement
10406
Transaction refused
because of an invalid
argument. See additional
error messages for details.
La valeur de PayerID est incorrecte.
Le numéro de compte
marchand est incorrect
10412
Duplicate invoice
Un paiement a déjà été effectué pour
cet élément InvoiceID.
Paiement déjà effectué pour
cette facture
10413
Transaction refused
because of an invalid
argument. See additional
error messages for details.
Les montants totaux des objets du
panier ne correspondent pas aux
montants de la commande.
Le montant total des objets du
panier de correspond pas au
montant total de la commande
10414
Transaction refused
because of an invalid
argument. See additional
error messages for details.
Le montant dépasse le montant
maximum autorisé pour une seule
transaction.
Le montant dépasse le montant
maximum autorisé pour une
seule transaction
10417
Transaction cannot
complete.
La transaction ne peut pas s'effectuer.
Demandez au client d'utiliser un autre
mode de paiement.
Compte non associé à une
source d'approvisionnement
valable
Guide de développement et référence de l’API NVP
Janvier 2008
161
Liste de référence des messages d'erreur
Erreurs d'API des paiements récurrents et des transactions de référence
TABLEAU B.14 Erreurs d'API relatives à toutes les transactions de référence (suite)
Code
d'erreur Message court
162
Informations
supplémentaires
Message long
10417
Transaction cannot
complete.
La transaction ne peut pas s'effectuer.
Demandez au client d'utiliser un autre
mode de paiement.
Une carte bancaire ou une
autorisation de facturation sont
nécessaires pour effectuer le
paiement.
10418
Transaction refused
because of an invalid
argument. See additional
error messages for details.
Les devises des montants du panier
doivent être identiques.
Les devises du panier doivent
être identiques
10420
Transaction refused
because of an invalid
argument. See additional
error messages for details.
La balise PaymentAction est
manquante.
La balise PaymentAction est
manquante.
10426
Transaction refused
because of an invalid
argument. See additional
error messages for details.
Le total des objets est incorrect.
Le montant ItemTotal est
incorrect.
10427
Transaction refused
because of an invalid
argument. See additional
error messages for details.
Le total de la livraison est incorrect.
Le montant ShippingTotal est
incorrect.
10428
Transaction refused
because of an invalid
argument. See additional
error messages for details.
Le total des frais de dossier est
incorrect.
Le montant HandlingTotal est
incorrect.
10429
Transaction refused
because of an invalid
argument. See additional
error messages for details.
Le total de la TVA est incorrect.
Le montant TaxTotal est
incorrect.
10429
Transaction refused
because of an invalid
argument. See additional
error messages for details.
La TVA concernant l'objet est
incorrecte.
PaymentDetailsItem.Le champ
de la TVA est incorrect.
Avertissement seulement; l'API
s’exécute
10430
Transaction refused
because of an invalid
argument. See additional
error messages for details.
Le montant des objets est manquant.
PaymentDetailsItem. Le champ
Montant est manquant.
Avertissement seulement; l'API
s’exécute
10431
Transaction refused
because of an invalid
argument. See additional
error messages for details.
Le montant des objets est incorrect.
PaymentDetailsItem. Le champ
montant est incorrect.
Avertissement seulement; l'API
s’exécute
Janvier 2008
Guide de développement et référence de l’API NVP
Liste de référence des messages d'erreur
Erreurs d'API des paiements récurrents et des transactions de référence
TABLEAU B.14 Erreurs d'API relatives à toutes les transactions de référence (suite)
Code
d'erreur Message court
Message long
Informations
supplémentaires
10432
Transaction refused
because of an invalid
argument. See additional
error messages for details.
La valeur de InvoiceID dépasse la
longueur maximale autorisée.
Le champ InvoiceID est trop
long; la longueur maximale est
de 256
10433
Transaction refused
because of an invalid
argument. See additional
error messages for details.
La valeur de l'élément
OrderDescription est tronquée.
OrderDescription est trop long;
la longueur maximale est de
127. Avertissement seulement;
l'API s’exécute
10434
Transaction refused
because of an invalid
argument. See additional
error messages for details.
La valeur de l'élément Custom est
tronquée.
Le champ Custom est trop
long; la longueur maximale est
de 256. Avertissement
seulement; l'API s’exécute
10441
Transaction refused
because of an invalid
argument. See additional
error messages for details.
La valeur de NotifyURL dépasse la
longueur maximale autorisée.
Le champ NotifyURL est trop
long; sa longueur maximale est
de 2048
10442
ButtonSource value
truncated.
La valeur de l'élément ButtonSource
dépasse la longueur maximale
autorisée.
OrderDescription est trop long;
sa longueur maximale est de 32.
Avertissement seulement; l'API
s’exécute
10504
The cvv2 is invalid.
Impossible de traiter cette transaction.
Veuillez entrer un cryptogramme
visuel correct.
Le champ CVV2
(cryptogramme visuel) est
incorrect.
10527
Invalid Data
Impossible de traiter cette transaction.
Veuillez entrer un numéro correct et un
type de carte bancaire pris en charge.
Le numéro
(CreditCardNumber) et/ou le
type de carte bancaire
(CreditCardType) sont
incorrects
10537
Risk Control Country Filter
Failure
La transaction a été refusée car le pays
est interdit dans vos paramètres de
contrôle des risques pour les pays sous
surveillance.
Transaction refusée en raison
des paramètres de contrôle des
risques pour les pays sous
surveillance
10538
Risk Control Max Amount
Failure
La transaction a été refusée car le
montant maximum a été dépassé dans
vos paramètres de contrôle des risques
pour le montant maximum.
Transaction refusée en raison
des paramètres de contrôle des
risques pour le montant
maximum
10539
Payment declined by your
Risk Controls settings:
PayPal Risk Model.
Paiement rejeté par vos paramètres de
contrôle des risques : modèle PayPal
de gestion des risques.
Transaction refusée par les
paramètres de contrôle des
risques : modèle PayPal de
gestion des risques.
Guide de développement et référence de l’API NVP
Janvier 2008
163
Liste de référence des messages d'erreur
Erreurs d'API des paiements récurrents et des transactions de référence
TABLEAU B.14 Erreurs d'API relatives à toutes les transactions de référence (suite)
164
Code
d'erreur Message court
Message long
Informations
supplémentaires
10546
Gateway Decline
Impossible de traiter cette transaction.
Echec des modèles de fraude IP.
10560
Invalid Data
Le numéro d'émission de la carte
bancaire est incorrect.
Le numéro d'émission
(IssueNumber) est incorrect.
10600
Authorization voided.
L’autorisation est annulée.
10601
Authorization expired.
L'autorisation a expiré.
10621
Order has expired.
La commande a expiré.
10622
Order is voided.
La commande est annulée.
10623
Maximum number of
authorization allowed for
the order is reached.
Le nombre maximum d'autorisations
permises pour la commande est atteint.
10725
Shipping Address Country
Error
Une erreur s'est produite dans le
champ indiquant le pays livraison
Erreur dans le champ Pays de
livraison
10727
Shipping Address1 Empty
Le champ Adresse de livraison1 doit
être rempli.
Erreur dans le champ Adresse
de livraison1
10728
Shipping Address City
Empty
Le champ Ville de livraison doit être
rempli.
Erreur dans le champ Ville de
livraison
10729
Shipping Address State
Empty
Le champ Etat de livraison doit être
rempli.
Erreur dans le champ Etat de
livraison
10730
Shipping Address Postal
Code Empty
Le champ Code postal de livraison
doit être rempli.
Erreur dans le champ Code
postal de livraison
10731
Shipping Address Country
Empty
Le champ Pays de livraison doit être
rempli.
Le code pays de l'adresse de
livraison n'a pas été saisi
10736
Shipping Address Invalid
City State Postal Code
Incompatibilité entre la ville, l'état et le
code postale de l'adresse de livraison.
Incompatibilité entre la ville,
l'état et le code postale de
l'adresse de livraison.
10747
Invalid Data
Cette transaction ne peut pas être
traitée sans une adresse IP correct.
Le champ IPAddress est
incorrect.
10748
Invalid Data
Impossible de traiter cette transaction
sans un cryptogramme visuel.
Le champ CVV2
(cryptogramme visuel) est
manquant.
10755
Unsupported Currency.
Cette transaction ne peut pas être
traitée en raison d'une devise non
acceptée.
11302
Cannot pay self
La transaction a été refusée car vous
ne pouvez vous payer vous-même.
Janvier 2008
Impossible de se payer soimême. Le marchand référence
sa propre transaction.
Guide de développement et référence de l’API NVP
Liste de référence des messages d'erreur
Erreurs d'API des paiements récurrents et des transactions de référence
TABLEAU B.14 Erreurs d'API relatives à toutes les transactions de référence (suite)
Code
d'erreur Message court
Message long
Informations
supplémentaires
11451
Billing Agreement Id or
transaction Id is not valid
Le numéro d'autorisation de
facturation ou le numéro de
transaction n'est pas correct
Numéro de référence incorrect
11451
Billing Agreement Id or
transaction Id is not valid
Le numéro d'autorisation de
facturation ou le numéro de
transaction n'est pas correct
La transaction de référence
n'est pas associée à une
autorisation de facturation.
11451
Billing Agreement Id or
transaction Id is not valid
Le numéro d'autorisation de
facturation ou le numéro de
transaction n'est pas correct
Le numéro de référence n'a pas
été trouvé ou n'a pas pu être
décrypté
11451
Billing Agreement Id or
transaction Id is not valid
Le numéro d'autorisation de
facturation ou le numéro de
transaction n'est pas correct
Le numéro de référence n'a pas
été trouvé ou n'a pas pu être
décrypté
11452
Merchant not enabled for
reference transactions
Marchand non activé pour les
transactions de référence
Ce marchand n'est pas activé
pour les transactions de
référence
11453
Reference transactions
temporarily unavailable.
La fonction Transaction de référence
n'est actuellement pas disponible;
veuillez essayer ultérieurement
Fonction désactivée
11453
Reference transactions
temporarily unavailable.
La fonction Transaction de référence
n'est actuellement pas disponible;
veuillez essayer ultérieurement
Fonction non assurée en mode
autonome
11454
Warning: Could not send
email to the buyer
Avertissement : impossibilité
d'envoyer l'email à l'acheteur
Echec de l'envoi de l'email à
l'acheteur. Cette erreur n'est pas
fatale et génère un
avertissement.
11459
Invalid Data
L'adresse de livraison doit
correspondre à celle de l'utilisateur
dans le compte PayPal.
L'adresse de livraison dans le
fichier ne correspond pas à
l'adresse de livraison
demandée.
18014
Gateway Decline
Impossible de traiter cette transaction.
Impossible de traiter cette
transaction sans un
cryptogramme visuel.
Guide de développement et référence de l’API NVP
Janvier 2008
165
Liste de référence des messages d'erreur
Erreurs d'API des paiements récurrents et des transactions de référence
166
Janvier 2008
Guide de développement et référence de l’API NVP
C
Exemples Web de l'API NVP
Ce chapitre traite des exemples Web de l'API PNV capables d'accéder à cette API directement.
Cette section comprend les rubriques suivantes :
z
« Descriptions des exemples » page 167
z
« Exemples utilisant ASP classique » page 171
z
« Exemples utilisant PHP » page 172
z
« Exemples utilisant ColdFusion » page 173
Descriptions des exemples
Les exemples Web comprennent les éléments suivants :
z
« Accepter PayPal dans la fonction Paiement express » page 167
z
« Recueillir les détails de la transaction » page 169
z
« Fichiers communs » page 170
La page principale des exemples, index.htlm ou Default.htm, contient des liens vers chaque
exemple.
R E M A R Q U E : Dans
cette section sont présentés des exemples de code pour tous les langages
de programmation. Les noms de fichiers spécifiques à un langage sont indiqués
sous la forme nom_fichier.ext.
Accepter PayPal dans la fonction Paiement express
Cet exemple explique comment utiliser la fonction Paiement express pour accepter des
paiements par le biais de PayPal. Accédez à cet exemple à partir de l'une des options suivantes
contenues dans la page index.html ou dans la page Default.htm :
ExpressCheckout - Sale
Effectuer un paiement par le biais de PayPal.
Dans la requête SetExpressCheckout, le paramètre
PAYMENTACTION est défini par Sale.
ExpressCheckout Authorization
Autoriser une collecte unique.
Dans la requête SetExpressCheckout, le paramètre
PAYMENTACTION est défini par Authorization.
ExpressCheckout - Order
Autoriser les collectes multiples.
Dans la requête SetExpressCheckout, le paramètre
PAYMENTACTION est défini par Order.
Guide de développement et référence de l’API NVP
Janvier 2008
167
Exemples Web de l'API NVP
Descriptions des exemples
Les principaux fichiers concernant cet exemple sont :
TABLEAU C.1 Les fichiers Paiement express
Fichier
Description
SetExpressCheckout.ext
Cette page est la page Web principale de l'exemple Paiement
express. Elle permet à l'utilisateur de saisir un montant et un
type de devise. Il est également possible d'y saisir la variable
paymentType qui devient la valeur du paramètre
PAYMENTACTION.
Lorsque l'utilisateur clique sur le bouton Soumettre,
ReviewOrder.ext est appelé.
Appelé par index.html ou par Default.htm.
Appelle ReviewOrder.ext.
ReviewOrder.ext
Ce fichier est appelé dès que l'utilisateur clique sur un bouton,
durant la procédure de paiement, pour utiliser la fonction
Paiement express de PayPal. L'utilisateur se connecte à son
compte PayPal.
Ce fichier est appelé deux fois.
Lors du premier passage, le code exécute l'instruction if :
if (! isset ($token))
Le code collecte les paramètres de la transaction dans le
formulaire affiché par SetExpressCheckout.ext, puis construit
et envoie une chaîne de requête SetExpressCheckout au
serveur PayPal. La variable paymentType devient le
paramètre PAYMENTACTION de la chaîne de requête. Le
paramètre RETURNURL renvoie à ce fichier et ReviewOrder.ext
est donc appelé deux fois.
Lors du deuxième passage, le code exécute l'instruction else.
Lors de la première transmission, l'acheteur a rempli
l'autorisation dans son compte PayPal; le code obtient
maintenant les détails du payeur en envoyant une requête
GetExpressCheckoutDetails au serveur PayPal. Le code
appelle ensuite GetExpressCheckoutDetails.ext.
R E M A R Q U E : Assurez-vous de bien vérifier la valeur de
PAYPAL_URL. L'acheteur est dirigé vers cette
URL afin d'autoriser le paiement depuis son
compte PayPal. Lors de tests, cette URL doit
être celle de l'environnement test de PayPal.
Appelé par SetExpressCheckout.ext.
Appelle GetExpressCheckoutDetails.ext, CallerService.ext, et
Display.ext.
168
Janvier 2008 Guide de développement et référence de l’API NVP
Exemples Web de l'API NVP
Descriptions des exemples
TABLEAU C.1 Les fichiers Paiement express
Fichier
Description
GetExpressCheckoutDetails.ext
Cette fonctionnalité est appelée lorsque l'acheteur revient de
PayPal et a autorisé le paiement.
Affiche les détails du payeur renvoyés par la réponse
GetExpressCheckoutDetails et appelle
DoExpressCheckoutPayment.ext pour compléter l'autorisation
de paiement.
Appelé par ReviewOrder.ext.
Appelle DoExpressCheckoutPayment.ext et CallerService.ext.
DoExpressCheckoutPayment.ext
Cette fonctionnalité est appelée pour compléter le paiement et
affiche le résultat de la transaction sur l'écran de l'acheteur.
Le code construit et envoie la chaîne de requête
DoExpressCheckoutPayment au serveur PayPal.
Appelé par GetExpressCheckoutDetails.ext et
CallerService.ext.
Recueillir les détails de la transaction
Cet exemple montre comment utiliser la requête GetTransactionDetails. Vous pouvez accéder
à cet exemple à partir des options suivantes contenues dans la page index.html ou dans la page
Default.htm :
GetTransactionDetails
Recueille les détails de la transaction pour un numéro de
transaction spécifique.
La page principale affiche une zone de texte dans laquelle
l'utilisateur saisit un numéro de transaction. Lorsque l'utilisateur
clique sur le bouton Soumettre, le code construit une requête API
NVP avec GetTransactionDetails et l'envoie au serveur
PayPal.
Les principaux fichiers concernant cet exemple sont :
TABLEAU C.2 Les fichiers Recueillir les détails de la transaction
Fichier
Description
GetTransactionDetails.ext
Cette page est la page Web principale de l'exemple
GetTransactionDetails. Cette page affiche une zone de texte où
l'utilisateur peut saisir un numéro de transaction et un bouton
Soumettre qui appelle TransactionDetails.ext.
Appelle TransactionDetails.ext.
Guide de développement et référence de l’API NVP
Janvier 2008
169
Exemples Web de l'API NVP
Descriptions des exemples
TABLEAU C.2 Les fichiers Recueillir les détails de la transaction
Fichier
Description
TransactionDetails.ext
Envoie une requête API NVP GetTransactionDetails à
PayPal.
Le code récupère le numéro de transaction et construit la chaîne de
requête API NVP qui sera envoyée au serveur PayPal. La requête
envoyée à PayPal utilise une signature API.
Une fois la réponse du serveur PayPal reçue, le code affiche la
requête et la réponse dans le navigateur. Si l'opération a réussi, les
paramètres de la réponse sont affichés. Si l'opération a échoué, les
messages d'erreur reçus sont affichés.
Appelé par GetTransactionDetails.html.
Fichiers communs
Les fichiers suivants sont communs à tous les exemples.
TABLEAU C.3 Fichiers communs
170
Fichier
Description
index.html
Default.htm
La page web principale contenant des liens vers chacun des exemples.
Appelle SetExpressCheckout.ext et GetTransactionDetails.html.
sdk.css
Feuille de style CSS utilisée par la page index.html ou par la page
Default.htm.
CallerService.ext
Page de configuration des exemples. Elle contient les paramètres
nécessaires pour effectuer un appel d’API.
Les exemples sont associés à une signature API qui leur permet de
faire des appels d’API pour l'Environnement de test PayPal. La
signature API est décrite dans la section « Exemple d'utilisateur API
avec signature API » page 171.
Appelé par TransactionDetails.ext, ReviewOrder.ext et Display.ext.
Display.ext
Affiche les paramètres de la requête et de la réponse. S'il y a une erreur,
affiche les paramètres de la requête et de l'erreur.
Appelé par TransactionDetails.ext et
DoExpressCheckoutPayment.ext.
Janvier 2008 Guide de développement et référence de l’API NVP
Exemples Web de l'API NVP
Exemple d'utilisateur API avec signature API
Exemple d'utilisateur API avec signature API
Les exemples sont fournis avec une signature API à utiliser avec les exemples et
l'Environnement de test PayPal. Cette signature API appartient à l'utilisateur suivant :
TABLEAU C.4Détails de l'exemple de signature API
Identifiant API
sdk-three_api1.sdk.com
Mot de passe API
QFZCWN5HZM8VBG7Q
Signature API
A-IzJhZZjhg29XQ2qnhapuwxIDzyAZQ92FRP5dqBzVesOkzbdUONzmOU
IMPO RTANT :
Vous devez protéger les valeurs de la signature API dans votre intégration.
Nous vous conseillons de sauvegarder ces valeurs dans un endroit sûr autre
que la racine des documents de votre serveur Web. Pensez également à
définir les droits d'accès à ce fichier, de sorte que seul l'utilisateur système
exécutant votre application d’e-commerce puisse y accéder.
L'exemple de code ne sauvegarde pas ces valeurs de manière sûre. Il ne doit
en aucun cas être utilisé dans un environnement de production.
Exemples utilisant ASP classique
Cette section contient des informations sur la configuration et l'exécution des exemples Web
de l'API NVP utilisant ASP classique.
Logiciel requis
Aucun logiciel complémentaire n'est requis.
Télécharger et décompresser les exemples
La dernière version des exemples Web est disponible à l'adresse
http://www.paypal.fr/fr_FR/html/Espace-Integration-PayPal/ic_nvp.html.
1. Téléchargez le fichier distribué au format zip.
2. Décompressez le fichier zip dans le répertoire de votre choix.
Installer les exemples
Les exemples doivent être installés dans Microsoft IIS (version 5.1 ou supérieure).
Créez un répertoire virtuel dans Microsoft IIS appelé PayPalClassicAspNvpSamples qui
pointe vers Samples_Root.
Guide de développement et référence de l’API NVP
Janvier 2008
171
Exemples Web de l'API NVP
Exemples utilisant PHP
Exécuter les exemples
Assurez-vous tout d'abord d'avoir installé le logiciel et les exemples requis.
Les exemples peuvent être exécutés en saisissant l'adresse suivante dans un navigateur Web :
http://name_of_Server:port/PayPalClassicAspNvpSamples/Default.htm
Exemples utilisant PHP
Cette section contient des informations sur la configuration et l'exécution des exemples Web
de l'API NVP utilisant PHP.
Logiciel requis
Les logiciels suivants sont nécessaires :
TABLEAU C.5 Logiciel requis
Logiciel
Version
PHP avec extension CURL activée
4.4.2 ou supérieure
Serveur HTTP Apache
1.3.17 ou supérieure
Adresse de téléchargement
http://httpd.apache.org/
Vous devez installer et configurer PHP avec le serveur HTTP Apache.
Télécharger et décompresser les exemples
La dernière version des exemples Web est disponible à l'adresse suivante :
https://www.paypal.com/IntegrationCenter/ic_nvp.html.
1. Téléchargez le fichier distribué au format zip.
2. Décompressez le fichier zip dans le répertoire de votre choix.
Installer les exemples
Copiez le dossier php_nvp_samples contenant les exemples dans la racine des documents
du serveur HTTP Apache. Par défaut, docroot se trouve dans datadir/htdocs.
Exécuter les exemples
Assurez-vous tout d'abord d'avoir installé les logiciels et les exemples requis.
Les exemples peuvent être exécutés en saisissant l'adresse suivante dans un navigateur Web :
http://name_of_Apache_HTTP_Server:port/php_nvp_samples/index.html
172
Janvier 2008 Guide de développement et référence de l’API NVP
Exemples Web de l'API NVP
Exemples utilisant ColdFusion
Exemples utilisant ColdFusion
Cette section contient des informations sur la configuration et l'exécution des exemples Web
de l'API NVP utilisant Coldfusion.
Logiciel requis
Le logiciel suivant est requis :
TABLEAU C.6 Normes prises en charge
Norme
Version
Adresse de téléchargement
ColdFusion
7.x MX
http://www.adobe.com/products/coldfusion/
Télécharger et décompresser les exemples
La dernière version des exemples Web est disponible à l'adresse
https://www.paypal.com/IntegrationCenter/ic_nvp.html.
1. Téléchargez le fichier distribué au format zip.
2. Décompressez le fichier zip dans le répertoire de votre choix.
Installer les exemples
R E M A R Q U E : Les
exemples supposent que Coldfusion s'exécute sous Microsoft Windows.
Copiez le dossier ColdFusionMX7_root_directory\wwwroot contenant les
exemples dans la racine des documents du serveur Web de l'application
ColdFusion.
Exécuter les exemples
Assurez-vous tout d'abord d'avoir installé le logiciel et les exemples requis.
Les exemples peuvent être exécutés en saisissant l'adresse suivante dans un navigateur Web :
http://name_of_Server:port/cf_nvp_samples/index.html
Guide de développement et référence de l’API NVP
Janvier 2008
173
Exemples Web de l'API NVP
Exemples utilisant ColdFusion
174
Janvier 2008 Guide de développement et référence de l’API NVP
D
Kit de développement PayPal Java
Cette section explique comment utiliser le kit de développement PayPal Java et comprend les
rubriques suivantes :
z
« Installation du kit de développement PayPal Java » page 175
z
« Préférences » page 178
z
« Exemples d'applications » page 180
Installation du kit de développement PayPal Java
Cette section présente les logiciels et le matériel pris en charge par le kit de développement
PayPal, et requis pour l'installation et les tâches post-installation.
Normes prises en charge
Le kit de développement PayPal a été testé et fonctionne avec les normes suivantes :
TABLEAU D.1 Normes prises en charge
Norme
Version
Environnement d'exécution Java
1.4.2 ou supérieur
Langues prises en charge
Le kit de développement PayPal est disponible en anglais américain.
Numéro de version du kit de développement PayPal
Ce guide décrit le kit de développement PayPal Java version 5.1.1.
Configuration matérielle recommandée
La configuration matérielle minimum recommandée pour utiliser le kit de développement
PayPal dans le développement et les tests est indiquée ci-dessous. Les systèmes de production
peuvent nécessiter une capacité supérieure, qui varie selon la charge prévue.
TABLEAU D.2 Configuration matérielle recommandée
Composant
Capacité minimale
RAM
256 Mo
Guide de développement et référence de l’API NVP
Janvier 2008
175
Kit de développement PayPal Java
Installation du kit de développement PayPal Java
TABLEAU D.2 Configuration matérielle recommandée
Composant
Capacité minimale
Processeur
Pentium 1 GHz
Espace disque
50 Mo
Télécharger et décompresser le kit de développement PayPal
La dernière version du kit de développement PayPal est disponible à l'adresse
https://www.paypal.com/IntegrationCenter/ic_nvp.html.
1. Téléchargez le fichier distribué au format zip.
2. Décompressez le fichier zip dans le répertoire de votre choix.
R E M A R Q U E : Dans
ce manuel, le répertoire dans lequel vous choisissez d'extraire le kit de
développement PayPal est appelé : SDK_root.
Configuration post-installation
Cette section décrit en détail les étapes préalables à l'utilisation du kit de développement
PayPal.
Ajouter des fichiers JAR du kit de développement PayPal dans CLASSPATH
Avant de développer des applications avec le kit de développement Java PayPal, ajoutez les
fichiers JAR qui se trouvent dans SDK_root/lib à votre variable d'environnement CLASSPATH.
Répertoires et configurations facultatives du kit de développement PayPal
Les composants du kit de développement PayPal sont organisés en différents sous-répertoires,
présentés dans le Tableau D.3, “Kit de développement PayPal Java : répertoires et contenu ».
TABLEAU D.3 Kit de développement PayPal Java : répertoires et contenu
176
Répertoire
Description
cert
Certificats publics PayPal pour PayPal en direct et
l'Environnement de test de PayPal
docs
Documentation API du kit de développement PayPal
lib
Bibliothèques du kit de développement PayPal
licenses
Fichiers de licence
samples
Exemples de code qui utilisent le kit de développement.
src
Code source du kit de développement PayPal
tools
Applications tierces
Janvier 2008
Guide de développement et référence de l’API NVP
Kit de développement PayPal Java
Documentation complète du kit de développement PayPal et des classes d'API
Documentation complète du kit de développement PayPal
et des classes d'API
Une documentation Javadoc complète relative à l'ensemble des interfaces, classes, méthodes,
structures et types de données du kit de développement PayPal est fournie avec la version du
kit. Pour l'afficher, ouvrez le fichier suivant dans votre navigateur :
SDK_root/docs/index.html
Journaux du kit de développement PayPal
Le kit de développement PayPal utilise le logiciel de journalisation log4j. Pour plus
d'informations, consultez la documentation à l'adresse http://logging.apache.org/log4j/docs/
Configurer les niveaux de journalisation
Définissez la valeur de l'élément dans SDK_root/lib/log4j.properties.
TABLEAU D.4 Niveaux de journalisation du kit de développement PayPal
Niveau
Description
ALL
Identique à DEBUG
ERROR
Consigne uniquement les erreurs graves
INFO
Date/heure de l'opération API, nom de l'opération, temps écoulé, indication de réussite
ou d'échec
DEBUG
Texte complet des requêtes et réponses et des autres messages de débogage. Evitez
d'utiliser la journalisation DEBUG au quotidien, car elle risque de réduire les
performances du kit de développement.
R E M A R Q U E : Les requêtes et réponses étant asynchrones, leur enregistrement dans le
fichier journal peut paraître désordonné.
Sauvegarde du fichier journal
La taille par défaut du fichier journal du kit de développement PayPal est 10 Mo. Vous pouvez
augmenter ou diminuer cette taille en modifiant la valeur de param name=”MaxFileSize”
dans log4j.properties. Lorsque le fichier journal atteint sa taille maximum, un fichier de
sauvegarde est créé et le système commence un nouveau fichier journal.
Guide de développement et référence de l’API NVP
Janvier 2008
177
Kit de développement PayPal Java
Préférences
Préférences
Avant toute utilisation, le kit de développement PayPal doit identifier les préférences de
l'utilisateur qui accède à ses services. Ces préférences sont un ensemble d'informations
relatives à un marchand ou à un développeur utilisant le kit de développement. Des
préférences API sont associées aux services API, notamment :
z
Identifiant et mot de passe API PayPal;
z
Si vous utilisez des certificats API, chemin du certificat API au format P12 et mot de passe
de la clé privée pour accéder à ce certificat;
z
Si vous utilisez des signatures API, chaîne de la signature;
z
Nom facultatif d'un tiers qui autorise l'appelant à invoquer les API PayPal en son nom. Ce
tiers porte le nom d'appelé;
z
Environnement PayPal pour traiter les appels API : site réel ou environnement de test.
Des préférences pour les Paiements sur site marchand cryptés sont associées aux
services EWP, notamment :
z
Chemin d'accès de la copie locale du certificat public utilisée par le marchand;
z
Mot de passe pour la clé privée du certificat public;
z
Chemin d'accès du fichier de la clé privée d'un marchand pour la signature numérique des
données;
z
URL vers laquelle le formulaire du bouton renvoie (POST);
z
URL facultative d'une image de bouton de paiement. Par défaut, il s'agit du bouton PayPal
standard Acheter.
Pour en savoir plus sur le fonctionnement de Paiements sur site marchand cryptés, reportezvous au Guide d'intégration de Paiements sur site marchand disponible à l'adresse
https://www.paypal.com/fr_FR/pdf/PP_WebsitePaymentsStandard_IntegrationGuide.pdf.
178
Janvier 2008
Guide de développement et référence de l’API NVP
Kit de développement PayPal Java
Préférences
Aperçu des classes liées aux préférences
Les principales interfaces et classes des préférences du kit de développement PayPal sont
présentées dans le tableau Tableau D.1, « Normes prises en charge », page 175
TABLEAU D.5 Interface et classes des références du kit de développement PayPal
Interface/Classe
Descriptions
Interface IAPIProfile
Cette interface définit les informations de base requises par PayPal au
sujet d'un utilisateur des API PayPal. Les développeurs doivent créer
une instance de l'interface IAPIProfile pour chaque compte qui
accède aux API. Pour les développeurs d'un marchand unique, une
seule instance de IAPIProfile est nécessaire. PayPal propose deux
classes d'intégration, adaptées aux besoins de la plupart des
développeurs utilisant le kit de développement PayPal :
CertificateAPIProfile et SignatureAPIProfile. Toutefois, vous pouvez
écrire une intégration personnalisée, si vous avez besoin d'une
fonctionnalité supplémentaire, qui n'existe pas dans la classe par
défaut.
Interface EWPProfile
Cette interface définit les informations de base requises par PayPal au
sujet d'un utilisateur de son service Paiements sur site marchand
cryptés (EWP, Encrypted Website Payments). Les développeurs
doivent créer une instance de l'interface EWPProfile pour chaque
compte qui crée le code du bouton crypté (pour les utilisateurs d'un
marchand unique, il y aura une seule instance). PayPal propose une
classe d'intégration de base appelée DefaultEWPProfile, adaptée aux
besoins de la plupart des développeurs utilisant le kit de
développement PayPal. Toutefois, vous pouvez écrire une intégration
personnalisée, si vous avez besoin d'une fonctionnalité qui n'existe
pas dans la classe par défaut.
Classe ProfileFactory
Cette classe crée à la fois les objets APIProfile et les objets
EWPProfile. Elle contient des méthodes statiques qui gèrent
l'instanciation et la construction des objets de préférences.
Classe Profiles
Cette classe de données représente tous les profils connus du kit de
développement PayPal. Elle contient deux collections, l'une pour
APIProfiles et l'autre pour EWPProfiles. Cette classe est proposée à
ProfileHandler pour enregistrer les données des préférences et
renvoyée par ProfileHandler pour les extraire.
Guide de développement et référence de l’API NVP
Janvier 2008
179
Kit de développement PayPal Java
Exemples d'applications
Exemples d'applications
Le kit PayPal pour développeur contient des exemples d'applications, placés dans le répertoire
SDK_root/samples Chaque sous-répertoire est fourni avec un fichier LISEZMOI qui
explique comment configurer l'application.
TABLEAU D.6 Kit de développement PayPal Java Exemples de code dans
SDK_root/samples
180
Sous-répertoire
Description
Cert
Certificats d'API utilisés par les exemples d'applications
JSP
Intégration JavaScript pour Apache Tomcat des API PayPal
suivantes :
z Paiement express PayPal pour la vente finale,
autorisation et commande
z TransactionSearch
z GetTransactionDetails
z RefundTransaction
z DoCapture
z DoVoid
z MassPay
z DoReauthorization
Janvier 2008
Guide de développement et référence de l’API NVP
Kit de développement PayPal Java
Exemples d'applications
Exemple d'utilisateur API avec signature API
Les exemples sont fournis avec une signature API à utiliser avec les exemples et
l'Environnement de test PayPal. Cette signature API appartient à l'utilisateur suivant :
TABLEAU D.7Détails de l'exemple de signature API
Identifiant API
sdk-three_api1.sdk.com
Mot de passe API
QFZCWN5HZM8VBG7Q
Signature API
A-IzJhZZjhg29XQ2qnhapuwxIDzyAZQ92FRP5dqBzVesOkzbdUONzmOU
IMPO RTANT :
Vous devez protéger les valeurs de la signature API dans votre intégration.
Nous vous conseillons de sauvegarder ces valeurs dans un endroit sûr autre
que la racine des documents de votre serveur Web. Pensez également à
définir les droits d'accès à ce fichier, de sorte que seul l'utilisateur système
exécutant votre application de commerce électronique puisse y accéder.
L'exemple de code ne sauvegarde pas ces valeurs de manière sûre. Il ne doit
en aucun cas être utilisé dans un environnement de production.
Exemple d'utilisateur API avec certificat d'API
Les exemples sont fournis avec un certificat d'API numérique à utiliser avec le kit de
développement et l'Environnement de test PayPal. Ce certificat appartient à l'utilisateur suivant :
TABLEAU D.8 Détails de l'exemple de certificat d'API du kit de développement PayPal
Emplacement du
certificat
SDK_root\samples\Certs\sdk-seller.p12
Identifiant API
sdk-seller_api1.sdk.com
Mot de passe API
12345678
Mot de passe PKCS12
password
IMPO RTANT :
Vous devez protéger les valeurs du certificat API lors l'intégration. Nous
vous conseillons de sauvegarder ces valeurs dans un endroit sûr autre que la
racine des documents de votre serveur Web. Pensez également à définir les
droits d'accès à ce fichier, de sorte que seul l'utilisateur système exécutant
votre application de commerce électronique puisse y accéder.
L'exemple de code ne sauvegarde pas ces valeurs de manière sûre. Il ne doit
en aucun cas être utilisé dans un environnement de production.
Guide de développement et référence de l’API NVP
Janvier 2008
181
Kit de développement PayPal Java
Exemples d'applications
182
Janvier 2008
Guide de développement et référence de l’API NVP
E
Kit de développement PayPal
ASP.NET
Cette section explique comment utiliser le kit de développement PayPal ASP.NET et
comprend les rubriques suivantes :
z
« Installation du kit de développement PayPal ASP.NET » page 183
z
« Préférences » page 188
z
« Exemples d'applications » page 190
Installation du kit de développement PayPal ASP.NET
Cette section présente les logiciels et le matériel pris en charge par le kit de développement
PayPal, et requis pour l'installation et les tâches post-installation.
Normes prises en charge
Le kit de développement PayPal a été testé : son fonctionnement est compatible avec les
normes ci-dessous.
TABLEAU E.1 Normes prises en charge
Norme
Version
Microsoft .NET Framework
1.1, Service Pack 1
Langues acceptées
Le kit de développement PayPal est disponible en anglais américain.
Numéro de version du kit de développement PayPal
Ce guide décrit le kit de développement PayPal ASP.NET, version 5.1.1.
Guide de développement et référence de l’API NVP
Janvier 2008
183
Kit de développement PayPal ASP.NET
Installation du kit de développement PayPal ASP.NET
Configuration matérielle requise
Le tableau ci-dessous indique la configuration matérielle minimum requise pour utiliser le kit
de développement PayPal et effectuer des tests. Les systèmes de production peuvent nécessiter
une capacité supérieure, qui varie selon la charge prévue.
TABLEAU E.2 Configuration matérielle requise
Composant
Capacité minimale
RAM
256 Mo
Processeur
Pentium 1 GHz
Espace disque
50 Mo
Obligatoire : Microsoft .NET Framework 1.1, Service Pack 1
IMPO RTANT :
Le kit de développement PayPal requiert l'installation du Service Pack 1 de
Microsoft .NET Framework 1.1. Vous pouvez télécharger ce Service
Pack 1 à partir du site Microsoft.
Télécharger et installer le kit de développement PayPal
La dernière version du kit de développement PayPal est disponible à l'adresse
http://www.paypal.fr/fr_FR/html/Espace-Integration-PayPal/ic_nvp.html. Vous pouvez
télécharger un programme d'installation à extraction automatique ou un fichier distribué au
format zip.
L'installation est simple et ne nécessite aucune instruction particulière. Si vous le souhaitez,
vous pouvez installer la source du kit de développement PayPal.
Configuration post-installation
Cette section décrit en détail les étapes préalables à l'utilisation du kit de développement
PayPal.
Référencer les DLL du kit de développement PayPal
Avant de développer des applications à l'aide du kit de développement PayPal, ajoutez les
références de vos projets ASP.NET dans les DLL du kit de développement PayPal présentes
sous SDK_root\bin.
Installer les exemples
Le kit de développement PayPal contient des exemples d'applications que vous pouvez étudier
et utiliser. Vous pouvez les installer dans Microsoft Internet Information Server (IIS). Pour en
savoir plus sur les exemples, consultez « Exemples d'applications » page 190. Pour en savoir
plus sur l'installation dans l'IIS, consultez « Installer les exemples sur Microsoft IIS »
page 191.
184
Janvier 2008
Guide de développement et référence de l’API NVP
Kit de développement PayPal ASP.NET
Installation du kit de développement PayPal ASP.NET
Répertoires et configurations facultatives du kit de développement PayPal
Les composants du kit de développement PayPal sont organisés en différents sous-répertoires,
présentés dans le Tableau E.3, « Répertoires et contenu du kit de développement PayPal ».
TABLEAU E.3 Répertoires et contenu du kit de développement PayPal
Répertoire
Description
bin
DLL compilées du kit de développement PayPal
docs
Documentation de classe Ndoc
Documentation et Guide du kit de développement PayPal
samples\ASPNET
Exemples de codes utilisant le kit de développement PayPal
dans les sous-répertoires
samples\cert
sdk-seller.p12 Certificat d'API pour l'utilisateur de
l'API sdk-seller_api1.sdk.com
src
Fichiers de projet Visual Studio et fichiers source du kit de
développement PayPal. Ce dossier n'existe que si vous avez
installé le source du kit de développement PayPal.
Configurations personnalisées facultatives de Web.config
Vous pouvez ajouter des paramètres personnalisés facultatifs dans le fichier Web.config.
Ajout des paramètres PayPal
Pour commencer, ajoutez une balise <section name=”paypal”>, comme indiqué cidessous. La section doit être placée dans <configSections> qui suit immédiatement la
balise <configuration> supérieure.
<configuration>
<configSections>
<section name=”paypal”
type=”com.paypal.sdk.core.ConfigSectionHandler, paypal_base”/>
<configSections>
Les paramètres personnalisés facultatifs sont contenus dans un bloc <paypal> qui se trouve
plus bas dans le fichier :
<paypal>
... paramètres personnalisés...
</paypal>
Guide de développement et référence de l’API NVP
Janvier 2008
185
Kit de développement PayPal ASP.NET
Installation du kit de développement PayPal ASP.NET
Journaux du kit de développement PayPal
Le kit de développement PayPal utilise le logiciel de journalisation public log4net. Pour en
savoir plus sur log4net, consultez sa documentation, à la page
http://logging.apache.org/log4net/release/manual/introduction.html.
Cette section décrit les niveaux de journalisation du kit de développement PayPal, les fichiers
de configuration dans lesquels le niveau souhaité est défini ainsi que la journalisation des
requêtes.
Niveaux de journalisation
La quantité de détails enregistrée par le kit de développement PayPal varie en fonction de
quatre niveaux de journalisation.
TABLEAU E.4 Niveaux de journalisation du kit de développement PayPal
Niveau
Description
ALL
Identique à DEBUG
ERROR
Consigne uniquement les erreurs graves
INFO
Date/heure de l'opération API, nom de l'opération, temps écoulé, indication de réussite
ou d'échec
DEBUG
Texte complet des requêtes et réponses et des autres messages de débogage. Le niveau
de journalisation DEBUG peut réduire les performances du kit de développement
PayPal. Evitez de l'utiliser au quotidien.
R E M A R Q U E : Les requêtes et réponses étant asynchrones, leur enregistrement dans le
fichier journal peut paraître désordonné.
Définir les niveaux de journalisation du kit de développement PayPal
Afin d'activer la journalisation pour les applications Web utilisant le kit de développement
PayPal, ajoutez les lignes ci-après dans le bloc <configuration> du fichier Web.config.
Vous pouvez copier ces lignes dans le fichier SDK_root\samples\ASPNET\Web.config.
z
Vous pouvez modifier la valeur de l'élément file afin d'enregistrer le contenu du journal
dans un emplacement de votre choix.
z
Définissez la valeur de l'élément level en choisissant un niveau de détail décrit dans
le Tableau E.4, « Niveaux de journalisation du kit de développement PayPal ».
<configSections>
<section name="log4net"
type="log4net.Config.Log4NetConfigurationSectionHandler,log4net"/>
</configSections>
<log4net>
<appender name="PAYPALLOGFILE"
type="log4net.Appender.RollingFileAppender">
<file value="logs/paypal.sdk.log" />
<appendToFile value="true" />
<encoding value="UTF-8" />
186
Janvier 2008
Guide de développement et référence de l’API NVP
Kit de développement PayPal ASP.NET
Documentation complète du kit de développement PayPal et des classes d'API
<rollingStyle value="5" />
<maxSizeRollBackups value="10" />
<maximumFileSize value="10MB" />
<staticLogFileName value="true" />
<layout type="log4net.Layout.PatternLayout">
<conversionPattern
value="%d{dd MMM yyyy HH:mm:ss} %-5p [%C{1}] %m%n" />
</layout>
</appender>
<logger name="com.paypal.sdk">
<level value="ALL" />
<appender-ref ref="PAYPALLOGFILE" />
</logger>
</log4net>
Activer la prise en charge des procurations
Si votre application se trouve derrière un serveur de procurations, vous devez activer la prise
en charge des procurations dans le fichier Web.config. Pour savoir comment utiliser
l'élément system.net dans le fichier Web.config, reportez-vous à la section Configuration
des applications Internet de MSDN Library.
Désinstaller le kit de développement PayPal
Pour désinstaller le kit de développement PayPal, utilisez la fonction Ajout/Suppression de
programmes du Panneau de configuration de Microsoft Windows.
Documentation complète du kit de développement PayPal et des
classes d'API
Une documentation Microsoft .NET Ndoc complète relative à l'ensemble des interfaces,
classes, méthodes, structures et types de données du kit de développement PayPal est fournie
avec la version du kit. Pour l'afficher, ouvrez le fichier suivant dans votre navigateur :
SDK_root/docs/PayPalBaseAPI.chm
Guide de développement et référence de l’API NVP
Janvier 2008
187
Kit de développement PayPal ASP.NET
Préférences
Préférences
Avant toute utilisation, le kit de développement PayPal doit identifier les préférences de
l'utilisateur qui accède à ses services. Ces préférences sont un ensemble d'informations
relatives à un marchand ou à un développeur qui utilise le kit de développement PayPal. Des
préférences API sont associées aux services API, notamment :
z
Identifiant et mot de passe API PayPal;
z
Si vous utilisez des certificats API, chemin du certificat API au format P12 et mot de passe
de la clé privée pour accéder à ce certificat;
z
Si vous utilisez des signatures API, chaîne de la signature;
z
Nom facultatif d'un tiers qui autorise l'appelant à invoquer les API PayPal en son nom. Ce
tiers porte le nom d'appelé;
z
Environnement PayPal pour traiter les appels API : site réel ou environnement de test.
Des préférences pour les Paiements sur site marchand cryptés sont associées aux
services EWP, notamment :
z
Chemin d'accès de la copie locale du certificat public utilisée par le marchand;
z
Mot de passe pour la clé privée du certificat public;
z
Chemin d'accès du fichier de la clé privée d'un marchand pour la signature numérique des
données;
z
URL vers laquelle le formulaire du bouton renvoie (POST);
z
URL facultative d'une image de bouton de paiement. Par défaut, il s'agit du bouton PayPal
standard Acheter.
Pour en savoir plus sur le fonctionnement de Paiements sur site marchand cryptés, reportezvous au Guide d'intégration de Paiements sur site marchand disponible à l'adresse
https://www.paypal.com/fr_FR/pdf/PP_WebsitePaymentsStandard_IntegrationGuide.pdf.
Aperçu des classes liées aux préférences
Les principales interfaces et classes des préférences du kit de développement PayPal sont
présentées dans le Tableau E.5, « Récapitulatif des interfaces et classes liées aux préférences
du kit de développement PayPal ASP.NET ».
188
Janvier 2008
Guide de développement et référence de l’API NVP
Kit de développement PayPal ASP.NET
Préférences
TABLEAU E.5 Récapitulatif des interfaces et classes liées aux préférences du kit de
développement PayPal ASP.NET
Interface/Classe
Description
Interface IAPIProfile
Cette interface définit les informations de base requises par PayPal au
sujet d'un utilisateur des API PayPal. Les développeurs doivent créer
une instance de l'interface IAPIProfile pour chaque compte qui
accède aux API. Pour les développeurs d'un marchand unique, une
seule instance de IAPIProfile est nécessaire. PayPal propose une
classe d'intégration par défaut appelée DefaultAPIProfile, adaptée
aux besoins de la plupart des développeurs utilisant le kit de
développement PayPal. Toutefois, vous pouvez écrire une intégration
personnalisée, si vous avez besoin d'une fonctionnalité
supplémentaire, qui n'existe pas dans la classe par défaut.
Classe ProfileFactory
Cette classe crée l'objet IAPIProfile. Elle contient des méthodes
statiques qui gèrent l'instanciation et la construction des objets de
préférences.
Interface EWPProfile
Cette interface définit les informations de base requises par PayPal au
sujet d'un utilisateur de son service Paiements sur site marchand
cryptés (EWP, Encrypted Website Payments). Les développeurs
doivent créer une instance de l'interface EWPProfile pour chaque
compte qui crée le code du bouton crypté (pour les utilisateurs d'un
marchand unique, il y aura une seule instance). PayPal propose une
classe d'intégration de base appelée DefaultEWPProfile, adaptée aux
besoins de la plupart des développeurs utilisant le kit de
développement PayPal. Toutefois, vous pouvez écrire une intégration
personnalisée, si vous avez besoin d'une fonctionnalité qui n'existe
pas dans la classe par défaut.
Guide de développement et référence de l’API NVP
Janvier 2008
189
Kit de développement PayPal ASP.NET
Exemples d'applications
Exemples d'applications
Le kit de développement PayPal contient des exemples d'applications, dans le dossier SDK_root\
samples\ASPNET. Le dossier samples\ASPNET est divisé en sous-dossiers par produit.
TABLEAU E.6 Exemples par produit
Sous-dossier de SDK_Root\samples\ASPNET
Produits
admin
DoCapture
DoVoid
GetTransactionDetails
MassPay
RefundTransaction
TransactionSearch
DoReauthorization
wppro
Paiement express PayPal
z Final Sale
z Autorisation
z Order
Exemple d'utilisateur API avec signature API
Les exemples sont fournis avec une signature API à utiliser avec les exemples et
l'Environnement de test PayPal. Cette signature API appartient à l'utilisateur suivant :
TABLEAU E.7Détails de l'exemple de signature API
Identifiant API
sdk-three_api1.sdk.com
Mot de passe API
QFZCWN5HZM8VBG7Q
Signature API
A-IzJhZZjhg29XQ2qnhapuwxIDzyAZQ92FRP5dqBzVesOkzbdUONzmOU
IMPO RTANT :
Vous devez protéger les valeurs de la signature API dans votre intégration.
Nous vous conseillons de sauvegarder ces valeurs dans un endroit sûr autre
que la racine des documents de votre serveur Web. Pensez également à définir
les droits d'accès à ce fichier, de sorte que seul l'utilisateur système exécutant
votre application de commerce électronique puisse y accéder.
L'exemple de code ne sauvegarde pas ces valeurs de manière sûre. Il ne doit
en aucun cas être utilisé dans un environnement de production.
190
Janvier 2008
Guide de développement et référence de l’API NVP
Kit de développement PayPal ASP.NET
Exemple d'utilisateur API avec certificat d'API
Exemple d'utilisateur API avec certificat d'API
Les exemples sont fournis avec un certificat d'API numérique à utiliser avec le kit de
développement et l'Environnement de test PayPal. Ce certificat appartient à l'utilisateur suivant :
TABLEAU E.8 Détails de l'exemple de certificat d'API du kit de développement PayPal
Emplacement du
certificat
SDK_root\samples\Certs\sdk-seller.p12
Identifiant API
sdk-seller_api1.sdk.com
Mot de passe API
12345678
Mot de passe PKCS12
password
IMPO RTANT :
Vous devez protéger les valeurs du certificat API lors l'intégration. Nous
vous conseillons de sauvegarder ces valeurs dans un endroit sûr autre que la
racine des documents de votre serveur Web. Pensez également à définir les
droits d'accès à ce fichier, de sorte que seul l'utilisateur système exécutant
votre application de commerce électronique puisse y accéder.
L'exemple de code ne sauvegarde pas ces valeurs de manière sûre. Il ne doit
en aucun cas être utilisé dans un environnement de production.
Installer les exemples sur Microsoft IIS
R E M A R Q U E : Vérifiez que vous avez ouvert une session administrateur, que Microsoft IIS est
en cours d'exécution et que WinHttpCertCfg.exe figure dans votre variable
PATH.
Pour installer les exemples dans Microsoft IIS :
1. Exécuter SDK_root\samples\ASPNET\InstallSample.bat.
2. Pour autoriser l'ouverture de session, remplacez les permissions du dossier
localComputerName\ASPNET par Contrôle total.
InstallSample.bat exécute les opérations suivantes :
– Crée dans Microsoft IIS un répertoire virtuel appelé PaypalASPNETSample qui pointe
sur SDK_root\samples\ASPNET.
– Charge l'exemple de certificat d'API SDK_root\samples\Certs\sdk-seller.p12
dans le magasin système de Microsoft Windows.
– Utilise la commande WinHttpCertCfg.exe pour octroyer à ce certificat un accès
illimité au compte Everyone.
Guide de développement et référence de l’API NVP
Janvier 2008
191
Kit de développement PayPal ASP.NET
Exécuter les exemples
Exécuter les exemples
Pour exécuter les exemples, ouvrez l'URL suivante dans Internet Explorer :
http://localhost/PaypalASPNETSamples.
192
Janvier 2008
Guide de développement et référence de l’API NVP
F
Kit de développement PayPal
Ruby on Rails
Le kit de développement PayPal Ruby on Rails facilite la procédure d'intégration des services
financiers de PayPal dans votre application en fournissant trois fichiers peu encombrants :
caller.rb, profile.rb et utils.rb. Le package est fourni avec des exemples de pages Web écrits
pour Ruby on Rails qui illustrent comment utiliser les API NVP des services Web PayPal,
notamment des exemples pour les fonctions Paiement express, Recherche de transactions,
Remboursement, Annuler et Collecter.
Cette section, qui explique comment utiliser le kit de développement PayPal Ruby on Rails
pour l'API NVP, comprend les rubriques suivantes :
z
« Installation du kit de développement PayPal Ruby on Rails » page 193
z
« Exemples d'applications » page 194
z
« Prise en charge d'un serveur proxy » page 195
Installation du kit de développement PayPal Ruby on Rails
Cette section présente les logiciels et le matériel pris en charge par le kit de développement
PayPal Ruby on Rails, et requis pour l'installation, ainsi que les tâches d'installation.
Normes prises en charge
Le kit de développement PayPal Ruby on Rails a été testé : son fonctionnement est compatible
avec les normes ci-dessous.
R E M A R Q U E : Le
code du kit de développement a été développé et testé sur les versions
répertoriées ci-dessous. Toutefois, le SDK peut également fonctionner sur des
versions antérieures.
TABLEAU F.1 Normes prises en charge
Norme
Version
Ruby on Rails
1.8.6 ou supérieur
Ruby on Rails
1.2.3
Langues acceptées
Le kit de développement PayPal Ruby on Rails est disponible en anglais américain.
Numéro de version du kit de développement PayPal
Ce guide décrit le kit de développement PayPal Ruby on Rails version 1.0.
Guide de développement et référence de l’API NVP
Janvier 2008
193
Kit de développement PayPal Ruby on Rails
Exemples d'applications
Configuration matérielle recommandée
La configuration matérielle minimum recommandée pour utiliser le kit de développement
PayPal dans le développement et les tests est indiquée ci-dessous. Les systèmes de production
peuvent nécessiter une capacité supérieure, qui varie selon la charge prévue.
TABLEAU F.2 Configuration matérielle recommandée
Composant
Capacité minimale
RAM
256 Mo
Processeur
Pentium 1 GHz
Espace disque
50 Mo
Installation du kit de développement PayPal
1. Téléchargez le fichier distribué au format zip.
2. Décompressez le fichier zip dans le répertoire de votre choix. Dans ce manuel, le répertoire
dans lequel vous choisissez d'extraire le kit de développement PayPal est appelé :
SDK_root.
3. Sur la ligne de commande, accédez au répertoire (cd) racine_SDK.
4. Saisissez ruby script/server. La ligne suivante s'affiche au démarrage du serveur :
** WEBRick available at 0.0.0.0:3000
5. Ouvrez un navigateur et saisissez http://<Adresse-IP>:3000 dans la barre d'adresse,
où <Adresse-IP> est l'adresse IP de votre machine. Appuyez sur Entrée.
Exemples d'applications
Les tests unitaires de l'API GetTransactionDetails API se trouvent dans le fichier suivant :
Racine_SDK/test/unit/dcc_unit.rb
Les tests unitaires fournissent également des exemples montrant comment effectuer des appels
d'API PayPal. Par exemple, les lignes de code suivantes montrent comment appeler
GetTransactionDetails :
req = { :method => 'gettransactionDetails',
:transactionid => '20P46879S1049380U'
}
@contents, @data = @caller.call(req)
@response = CGI::parse(@data)
194
Janvier 2008
Guide de développement et référence de l’API NVP
Kit de développement PayPal Ruby on Rails
Prise en charge d'un serveur proxy
Prise en charge d'un serveur proxy
La prise en charge des serveurs proxy a été ajoutée pour les environnements situés derrière un
proxy HTTP. Si des appels doivent être effectués par un serveur proxy, définissez les valeurs
suivantes dans la table de hashage @proxy_info de la classe profile :
TABLEAU F.3 Paramètres proxy
Variable
Valeur
USE_PROXY
True
ADDRESS
L'adresse IP du serveur proxy
PORT
Le numéro de port du serveur proxy
Guide de développement et référence de l’API NVP
Janvier 2008
195
Kit de développement PayPal Ruby on Rails
Prise en charge d'un serveur proxy
196
Janvier 2008
Guide de développement et référence de l’API NVP
G
Codes pays
R E M A R Q U E : Ce
tableau répertorie les codes pays définis par la norme ISO 3166-1.
TABLEAU G.1Codes pays
Pays
Code
AFGHANISTAN
AF
AFRIQUE DU SUD
ZA
ÅLAND, ILES
AX
ALBANIE
AL
ALGERIE
DZ
ALLEMAGNE
DE
ANDORRE
AD
ANGOLA
AO
ANGUILLA
AI
ANTARCTIQUE
AQ
ANTIGUA-ET-BARBUDA
AG
ANTILLES NEERLANDAISES
AN
ARABIE SAOUDITE
SA
ARGENTINE
AR
ARMENIE
AM
ARUBA
AW
AUSTRALIE
AU
AUTRICHE
AT
AZERBAIDJAN
AZ
BAHAMAS
BS
BAHREIN
BH
BANGLADESH
BD
BARBADE
BB
Guide de développement et référence de l’API NVP
Janvier 2008
197
198
Pays
Code
Pays
Code
BELGIQUE
BE
CD
BELIZE
BZ
CONGO, REPUBLIQUE
DEMOCRATIQUE DU
BENIN
BJ
COOK, ILES
CK
BERMUDES
BM
COREE, REPUBLIQUE DE
KR
BHOUTAN
BT
KP
BIELORUSSIE
BY
COREE, REPUBLIQUE
POPULAIRE
DEMOCRATIQUE DE
BOLIVIE
BO
COSTA RICA
CR
BOSNIE-HERZEGOVINE
BA
COTE D'IVOIRE
CI
BOTSWANA
BW
CROATIE
HR
BOUVET, ILE
BV
CUBA
CU
BRESIL
BR
DANEMARK
DK
BRUNEI DARUSSALAM
BN
DJIBOUTI
DJ
BULGARIE
BG
DOMINICAINE,
REPUBLIQUE
DO
BURKINA FASO
BF
DOMINIQUE
DM
BURUNDI
BI
EGYPTE
EG
CAIMANES, ILES
KY
EL SALVADOR
SV
CAMBODGE
KH
EMIRATS ARABES UNIS
AE
CAMEROUN
CM
EQUATEUR
EC
CANADA
CA
ERYTHREE
ER
CAP-VERT
CV
ESPAGNE
ES
CENTRAFRICAINE,
REPUBLIQUE
CF
ESTONIE
EE
CHILI
CL
ETATS-UNIS
US
CHINE
CN
ETHIOPIE
ET
CHRISTMAS, ILE
CX
FALKLAND (MALVINAS),
ILES
FK
CHYPRE
CY
FEROE, ILES
FO
COCOS (KEELING), ILES
CC
FIDJI
FJ
COLOMBIE
CO
FINLANDE
FI
COMORES
KM
FRANCE
FR
CONGO
CG
Janvier 2008
Guide de développement et référence de l’API NVP
Pays
Code
Pays
Code
GABON
GA
IRAK
IQ
GAMBIE
GM
IR
GEORGIE
GE
IRAN, REPUBLIQUE
ISLAMIQUE D'
GEORGIE DU SUD ET LES
ILES SANDWICH DU SUD
GS
IRLANDE
IE
ISLANDE
IS
GHANA
GH
ISRAEL
IL
GIBRALTAR
GI
ITALIE
IT
GRECE
GR
LY
GRENADE
GD
JAMAHIRIYA ARABE
LIBYENNE
GROENLAND
GL
JAMAIQUE
JM
GUADELOUPE
GP
JAPON
JP
GUAM
GU
JERSEY
JE
GUATEMALA
GT
JORDANIE
JO
GUERNESEY
GG
KAZAKHSTAN
KZ
GUINEE
GN
KENYA
KE
GUINEE EQUATORIALE
GQ
KIRGHIZISTAN
KG
GUINEE-BISSAU
GW
KIRIBATI
KI
GUYANA
GY
KOWEIT
KW
GUYANE FRANCAISE
GF
LA
HAITI
HT
LAOS, REPUBLIQUE
DEMOCRATIQUE
POPULAIRE
HEARD, ILE ET MCDONALD,
ILES
HM
LESOTHO
LS
LETTONIE
LV
HONDURAS
HN
LIBAN
LB
HONG-KONG
HK
LIBERIA
LR
HONGRIE
HU
LIECHTENSTEIN
LI
ILES MINEURES ELOIGNEES
DES ETATS-UNIS
UM
LITUANIE
LT
ILES VIERGES
BRITANNIQUES
VG
LUXEMBOURG
LU
MACAO
MO
ILES VIERGES DES ETATSUNIS
VI
MK
INDE
IN
MACEDOINE, EXREPUBLIQUE YOUGOSLAVE
DE
INDONESIE
ID
MADAGASCAR
MG
Guide de développement et référence de l’API NVP Janvier 2008
199
200
Pays
Code
Pays
Code
MALAISIE
MY
NORVEGE
NO
MALAWI
MW
NOUVELLE-CALEDONIE
NC
MALDIVES
MV
NOUVELLE-ZELANDE
NZ
MALI
ML
IO
MALTE
MT
OCEAN INDIEN, TERRITOIRE
BRITANNIQUE DE L'
MAN, ILE DE
IM
OMAN
OM
MARIANNES DU NORD, ILES
MP
OUGANDA
UG
MAROC
MA
OUZBEKISTAN
UZ
MARSHALL, ILES
MH
PAKISTAN
PK
MARTINIQUE
MQ
PALAOS
PW
MAURICE
MU
PANAMA
PA
MAURITANIE
MR
PAPOUASIE-NOUVELLEGUINEE
PG
MAYOTTE
YT
PARAGUAY
PY
MEXIQUE
MX
PAYS-BAS
NL
MICRONESIE, ETATS
FEDERES DE
FM
PEROU
PE
MOLDOVA, REPUBLIQUE DE
MD
PHILIPPINES
PH
MONACO
MC
PITCAIRN
PN
MONGOLIE
MN
POLOGNE
PL
MONTSERRAT
MS
POLYNESIE FRANCAISE
PF
MOZAMBIQUE
MZ
PORTO RICO
PR
MYANMAR
MM
PORTUGAL
PT
NAMIBIE
NA
QATAR
QA
NAURU
NR
REPUBLIQUE ARABE
SYRIENNE
SY
NEPAL
NP
REUNION
RE
NICARAGUA
NI
ROUMANIE
RO
NIGER
NE
ROYAUME-UNI
GB
NIGERIA
NG
RUSSIE, FEDERATION DE
RU
NIUE
NU
RWANDA
RW
NORFOLK, ILE
NF
Janvier 2008
Guide de développement et référence de l’API NVP
Pays
Code
Pays
Code
SAHARA OCCIDENTAL
EH
TW
SAINT SIEGE (ETAT DE LA
CITE DU VATICAN)
VA
TAIWAN, PROVINCE DE
CHINE
TZ
SAINTE-HELENE
SH
TANZANIE, REPUBLIQUE
UNIE DE
SAINTE-LUCIE
LC
TCHAD
TD
SAINT-KITTS-ET-NEVIS
KN
TCHEQUE, REPUBLIQUE
CZ
SAINT-MARIN
SM
TERRES AUSTRALES
FRANÇAISES
TF
SAINT-PIERRE-ETMIQUELON
PM
TERRITOIRE PALESTINIEN
OCCUPÉ
PS
SAINT-VINCENT-ET-LES
GRENADINES
VC
THAILANDE
TH
SALOMON, ILES
SB
TIMOR-LESTE
TL
SAMOA
WS
TOGO
TG
SAMOA AMERICAINES
AS
TOKELAU
TK
SAO TOME ET PRINCIPE
ST
TONGA
TO
SENEGAL
SN
TRINITE-ET-TOBAGO
TT
SERBIE-ET-MONTENEGRO
CS
TUNISIE
TN
SEYCHELLES
SC
TURKMENISTAN
TM
SIERRA LEONE
SL
TURKS ET CAIQUES, ILES
TC
SINGAPOUR
SG
TURQUIE
TR
SLOVAQUIE
SK
TUVALU
TV
SLOVENIE
SI
UKRAINE
UA
SOMALIE
SO
URUGUAY
UY
SOUDAN
SD
VANUATU
VU
SRI LANKA
LK
VENEZUELA
VE
SUEDE
SE
VIET NAM
VN
SUISSE
CH
WALLIS ET FUTUNA
WF
SURINAM
SR
YEMEN
YE
SVALBARD ET ILE JAN
MAYEN
SJ
ZAMBIE
ZM
ZIMBABWE
ZW
SWAZILAND
SZ
TADJIKISTAN
TJ
Guide de développement et référence de l’API NVP Janvier 2008
201
202
Janvier 2008
Guide de développement et référence de l’API NVP
Index
A
ACCT 68, 90
ACK 18, 113
ADDRESSOWNER 72
ADDRESSSTATUS 52, 72
ADDROVERRIDE 46
Ajout/Suppression de programmes 187
AMT 40
DoCapture 61
DoExpressCheckoutPayment 53
DoReauthorization 64
RefundTransaction 66
rembourser 40
réponse DoAuthorization 60
réponse DoCapture 63
réponse DoExpressCheckoutPayment 57
réponse GetTransactionDetails 73
requête DoAuthorization 60
TransactionSearch 69
Aperçu 35
API PayPal
certificat d’API 19
signature API 19
api.sandbox.paypal.com 19
api-3t.paypal.com 19
api-3t.sandbox.paypal.com 19
AUCTIONITEMNUMBER 68
AUD 43
AUTHORIZATIONID 57, 60, 62, 107
DoVoid 65
réponse DoReauthorization 65
réponse DoVoid 65
requête DoReauthorization 64
B
Balise paypal dans Web.Config 185
BUILD 18, 113
BUSINESS 51
Business, compte
créer 14
Guide de développement et référence de l’API NVP
BUTTONSOURCE 54
BUYERID 77
C
CAD 43
Canceled-Reversal 64, 74
Certificat
d’API 12, 19
exemple 181, 191
CertificateAPIProfile
classe 179
Chaîne codée au format URL 16
CHANNELTYPE 48
CHF 43
chm, documentation 187
CITY 90, 97, 107
CLASSPATH 176
CLOSINGDATE 77
Codage au format URL 15, 18, 19, 43
ASP classique 15
ASP.NET 15
ColdFusion 16
Java 15
PHP 15
Code postal 91, 97, 107
Codes des devises 43
ColdFusion 173
Collecter l'intégralité du montant d'une autorisation 37
Collecter une partie du montant d'une autorisation 38
Completed 64, 74
COMPLETETYPE 37, 38, 61
Compte Business PayPal
créer 14
CORRELATIONID 18, 113
COUNTRYCODE 51, 91, 97, 107
Couronne 43, 44
CREDITCARDTYPE 90, 96
Cryptogramme visuel. Voir CVV2.
CURRENCYCODE 45, 55, 57, 60, 61, 65, 78
currencyID 102, 103, 104
Janvier 2008
203
Index
CUSTOM 46, 52, 54, 75
CZK 43
D
Danoise, couronne 43
DefaultAPIProfile
classe 189
Denied 64, 74
état de la transaction 69
DESC 46, 54
Détails de la transaction 190
Devises acceptées par PayPal 43
DKK 43
DoAuthorization 37
DoCapture 37, 180, 190
Documentation 185
Javadoc pour le kit de développement PayPal 177
Dollar
américain 44
australien 43
canadien 43
Hong-Kong 44
néo-zélandais 44
Singapour 44
US 44
DoReauthorization 37, 190
DoReferenceTransactionRequest
champs 102
DoReferenceTransactionResponse
champs 107
DoVoid 37, 180, 190
E
EFFECTIVEDATE 76
EMAIL 45, 51, 71, 101, 106
TransactionSearch 67
EMAILSUBJECT 78
ENDDATE 67
Environnement de test 19
Etat de la transaction
denied 69
pending 69
processing 69
reversed 69
success 69
204
EUR 43
Euro 43
EWPProfile, interface 179
EXCHANGERATE 58, 63, 74
Exemple d'application 190
Exemple d'informations d'authentification API 171,
181, 190, 191
Exemple d’informations d’authentification API 13
Exemple de certificat d'API 181, 191
Exemple de signature API 13, 171, 181, 190
EXPDATE 90, 96
Expired 64, 74
F
FEEAMT 58, 63, 73
FEEREFUNDAMT 66
Fichiers source 185
FIRSTNAME 51, 68, 71, 101, 106
Forint 44
Format URL 15
Franc suisse 43
G
GBP 43
GetTransactionDetails 41, 180, 190
GROSSREFUNDAMT 66
Guide d'intégration de Paiements sur site
marchand 178, 188
H
HANDLINGAMT 31, 54
HDRBACKCOLOR 48
HDRBORDERCOLOR 47
HDRIMG 47
HKD 44
Hongrois, forint 44
HUF 44
I
IAPIProfile, interface 179
IIS 191
Informations d’authentification API 16
créer 14
Janvier 2008
Guide de développement et référence de l’API NVP
Index
LASTNAME 51, 68, 71, 90, 96, 101, 107
Livre sterling 43
LOCALECODE 47
log4j.properties 177
log4net 186
exemple 13
obtenir 12
Insérer une remarque lors du remboursement 40
InstallSample.bat 191
Interface EWPProfile 179
Interface EWPProfile,EWPProfile, interface 189
Interface IAPIProfile 179
Interface IAPIProfile,IAPIProfile, interface 189
INVNUM 46, 52, 54, 61, 67, 75
ITEMAMT 31, 54
M
J
Japonais, yen 44
Javadoc, documentation pour le kit de développement
PayPal 177
Jeton 22, 50
JPY 44
JSP 180
K
Kit de développement Java 1.4 175, 193
L
L_AMTn 31, 55, 70, 76, 78
L_DESCn 76
L_EBAYITEMAUCTIONTXNIDn 56
L_EBAYITEMNUMBERn 56
L_EBAYITEMORDERIDn 56
L_EMAILn 70, 78
L_FEEAMTn 70
L_NAMEn 30, 55, 70
L_NETAMTn 70
L_NOTEn 78
L_NUMBERn 30, 55, 76
L_OPTIONSNAMEn 76
L_QTYn 30, 55, 76
L_RECEIVERIDn 78
L_STATUSn 70
L_TAXAMTn 31, 55
L_TIMESTAMPn 70
L_TIMEZONEn 70
L_TRANSACTIONIDn 70
L_TYPEn 70
L_UNIQUEIDn 78
Guide de développement et référence de l’API NVP
Magasin système 191
MassPay 190
MAXAMT 45
METHOD 17
DoAuthorization 60
DoCapture 60
DoExpressCheckoutPayment 53
DoReauthorization 64
DoVoid 65
GetExpressCheckoutDetails 50
GetTransactionDetails 71
MassPay 78
RefundTransaction 66
TransactionSearch 67
Microsoft .NET 1.1 183
Microsoft .NET Framework SP1 184
MIDDLENAME 51, 68, 72, 101
Mot de passe API 13, 171, 181, 190
MULTIITEM 77
N
NETREFUNDAMT 66
Niveaux de journalisation 186
NOK 44
Norvégienne, couronne 44
NOSHIPPING 46
NotComplete 38
NOTE
DoCapture 61
RefundTransaction 66
réponse GetTransactionDetails 75
requête DoVoid 65
NOTIFYURL 54
NVP
envoyer 19
format 15
format de la réponse 18
erreur 18
Janvier 2008
205
Index
valeurs de ACK 19
format de la requête 16
modèle de requête-réponse 14
requête
créer et envoyer 13
interpréter 13
NZD 44
O
ORDERTIME 57, 63, 73
P
PAGESTYLE 47
Paiement express PayPal 180, 190
Paramètres d’API 17
PARENTTRANSACTIONID 63, 73
PASSWORD 76
PAYERBUSINESS 72, 101
PAYERID 51, 53, 71, 101, 106
PAYERSTATUS 51, 71, 101
PAYFLOWCOLOR 48
PAYMENTACTION 45, 53, 57
PAYMENTSTATUS 58, 64, 74
PAYMENTTYPE 57, 63, 73
Pending 64, 74
état de la transaction 69
PENDINGREASON 59, 64, 74, 75
PERIOD 77
PHONENUM 49, 52
PLN 44
Polonais, zloty 44
Préférences pour les Paiements sur site marchand
cryptés
définition 178, 188
Processed 64, 74
Processing
état de la transaction 69
ProfileFactory
classe 179, 189
Profiles
classe 179
PWD 16
206
R
REASONCODE 59, 64, 74, 75
REATTEMPT 77
RECEIPTID 63, 67, 73
RECEIVER 67
RECEIVERBUSINESS 71
RECEIVEREMAIL 71
RECEIVERID 71
RECEIVERTYPE 78
RECURRENCES 77
RECURRING 77
Refunded 64, 74
RefundTransaction 39, 180, 190
REFUNDTRANSACTIONID 66
REFUNDTYPE 40, 66
Rembourser le montant intégral de la transaction 40
Rembourser une partie du montant 40
REQCONFIRMSHIPPING 46
RETRYTIME 76
Reversed 64, 74
état de la transaction 69
S
SALESTAX 76
SALUTATION 51, 68, 72, 101
sdk-seller.p12 181, 185, 191
sdk-seller_api1.sdk.com 13, 171, 181, 190, 191
sdk-three_api1.sdk.com 13, 171, 181, 190
SEK 44
Serveurs d’API PayPal
certificat d’API 19
signature API 19
Service Pack 1 de Microsoft .NET Framework 1.1 184
SETTLEAMT 58, 63, 73
SGD 44
SHIPPINGAMT 31, 54
SHIPTOCITY 49, 52, 56, 72, 104
SHIPTOCOUNTRYCODE 49, 52, 56, 72, 101, 104
SHIPTONAME 49, 51, 56, 72, 104
SHIPTOPHONENUM 56, 72, 104
SHIPTOSTATE 49, 52, 56, 72, 104
SHIPTOSTREET 49, 51, 56, 72, 104
SHIPTOSTREET2 49, 52, 56, 72, 104
SHIPTOZIP 49, 52, 56, 72, 104
SIGNATURE 17
Janvier 2008
Guide de développement et référence de l’API NVP
Index
Signature API 12, 19
exemple 13
SignatureAPIProfile
classe 179
SOFTDESCRIPTOR 62, 105
SOLUTIONTYPE 48
src 185
STARTDATE 40, 67
STATE 90, 97, 107
STATUS 69
STREET 90, 96, 107
SUBJECT 17
SUBSCRIPTIONDATE 76
SUBSCRIPTIONID 76
Success
état de la transaction 69
successResponseFields, defini 18
Suédoise,couronne 44
SUFFIX 51, 68, 72, 101
Suisse, franc 43
T
TAXAMT 31, 55, 58, 63, 73
Tchèque, couronne 43
TOKEN 50, 57
DoExpressCheckoutPayment 53
GetExpressCheckoutDetails 50
réponse GetExpressCheckoutDetails 51
réponse SetExpressCheckout 50
SetExpressCheckout 47
Token 22
TRANSACTIONCLASS 69
TRANSACTIONENTITY 60
TRANSACTIONID 107
DoAuthorization 60
GetTransactionDetails 71
RefundTransaction 66
réponse DoAuthorization 60
réponse DoCapture 62
réponse DoExpressCheckoutPayment 57
réponse GetTransactionDetails 73
TransactionSearch 67
TransactionSearch 40, 180, 190
TRANSACTIONTYPE 57, 59, 63, 73
TransactionType 75, 109
Guide de développement et référence de l’API NVP
U
URL
codage 15
format 15
UrlDecode 15
urldecode() 16
URLDecoder 15
URLDecodeurlEncodedString 16
URLEncode 15
UrlEncode 15
urlencode() 15
URLEncodedFormatstring 16
URLEncoder.encode 15
USD 44
USER 16
USERNAME 76
UTC/GMT 70
V
Valeur de vérification de carte. Voir CVV2.
VERSION 17, 18, 113
Voided 64, 74
W
Web.config 185, 186
balise paypal 185
WinHttpCertCfg.exe 191
WinHttpPCertCfg.exe 191
Y
Yen 44
Z
Zloty 44
Janvier 2008
207