PAYPAL NVP API - 2007, NVP API - 2012 User Manual [fr]

Guide de développement et référence de l’API Paire Nom-Valeur (NVP) Référence : 100018.en_US-20070524

© 2007 PayPal, Inc. Tous droits réservés. PayPal et le logo P ayPal sont des marques déposées de PayPal, Inc. Les autres marques et marques commerciales mentionné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 Limited est autorisée et réglementée par la Financial Services Authority (FSA) du Royaume-Uni en tant qu'institution émettrice de monnaie électronique. Numéro de registre FSA de PayPal : 226056.

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. PayPal, Inc. ne garantit pas que les fonctionnalités décrites dans ce manuel seront annoncées ou mises à disposition de tous à l'avenir.

Mai 2007 3

4 Mai 2007

Sommaire

Sommaire . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

A propos de ce document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Public ciblé. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Problèmes relatifs à la documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Historique des révisions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Chapitre 1 Présentation . . . . . . . . . . . . . . . . . . . . . . . . .13

Présentation de l'API NVP PayPal. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Intégrer avec l'API PayPal. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Etapes de base . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Créer une application Web . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Obtenir des informations d'authentification API . . . . . . . . . . . . . . . . . . . . . 14

Créer et envoyer la requête . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Interpréter la réponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Transférer votre application dans l'e nvironnement de production de PayPal . . . . . . . . 15

Créer un compte Business PayPal . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Créer des informations d'authentification API . . . . . . . . . . . . . . . . . . . . . . 16

Modifier votre code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Détails techniques . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Modèle de requête-réponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Format de la requête. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Format de la réponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Envois utilisant HTTPS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Chapitre 2 Accepter PayPal dans la fonction Paiement express . . . . 23

Procédure de paiement de base via PayPal . . . . . . . . . . . . . . . . . . . . . . . . . 23

1. Initialiser le paiement à l'aide de SetExpressCheckout . . . . . . . . . . . . . . . . 24

2. Rediriger le navigateur du client vers la page de connexion à PayPal . . . . . . . . 24

3. Récupérer les informations du client à l'aide de GetExpressCheckoutDetails . . . . 25

4. Effectuer une vente à l'aide de DoExpressCheckoutPayment . . . . . . . . . . . . 25

Vérifier l'adresse de livraison à l'aide de SetExpressCheckout . . . . . . . . . . . . . . . 26

Exiger une adresse confirmée. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Supprimer l'affichage de l'adresse de livraison sur PayPal . . . . . . . . . . . . . . . 27

Guide de développement et référence de l’API Paire Nom-Valeur (NVP) Mai 2007 5

Sommaire

Ignorer l'adresse de livraison enregistrée auprès de PayPal . . . . . . . . . . . . . . 27

Changer la langue de la page de connexion à PayPal à l'aide de SetExpressCheckout . . 28

Modifier le Logo des pages PayPal à l'aide de SetExpressCheckout . . . . . . . . . . . . 28

Sélectionner un style de pages de paiement prédéfini . . . . . . . . . . . . . . . . . 29

Spécifier les paramètres du Logo et des couleurs individuellement. . . . . . . . . . . 29

Remplir le formulaire de votre page de vérification de paiement à l'aide de

GetExpressCheckoutDetails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

Effectuer une vente à l'aide de DoExpressCheckoutPayment. . . . . . . . . . . . . . . . 31

Autoriser une collecte unique à l'aide de SetExpressCheckout et de

DoExpressCheckoutPayment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Autoriser des collectes multiples à l'aide de SetExpressCheckout et de

DoExpressCheckoutPayment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Changer l'URL de la Notification instantanée de paiement (IPN) à l'aide de

DoExpressCheckoutPayment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Inclure le détail des objets à l'aide de DoExpressCheckoutPayment . . . . . . . . . . . . 33

Inclure les sous-totaux à l'aide de DoExpressCheckoutPayment . . . . . . . . . . . . . . 34

Mettre à jour les détails de la commande à l'aide de DoExpressCheckoutPayment . . . . 35

Mettre à jour l'adresse de livraison à l'aide de DoExpressCheckoutPayment . . . . . . . . 35

Chapitre 3 Comment utiliser l'API Paiements récurrents . . . . . . . . 37

Présentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Limites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Créer un paiement récurrent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

Procédure de création des paiements récurrents . . . . . . . . . . . . . . . . . . . . . . 40

Lancer la procédure à l'aide de SetCustomerBillingAgreement . . . . . . . . . . . . . . . 40

Spécifier un style de page de paiement personnalisé . . . . . . . . . . . . . . . . . . . . 41

Personnaliser le logo et les couleurs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Rediriger le navigateur du client vers PayPal . . . . . . . . . . . . . . . . . . . . . . . . 42

Obtenir les informations du payeur à l'aide de GetBillingAgreementCustomerDetails. . . . 43

Effectuer la transaction à l'aide de CreateRecurringPaymentsProfile . . . . . . . . . . . . 43

Effectuer la transaction à l'aide de CreateRecurringPaymentsProfile . . . . . . . . . . . . 45

Récapitulatif des Préférences de paiements récurrents . . . . . . . . . . . . . . . . . . . 46

Chapitre 4 Fonctions de gestion . . . . . . . . . . . . . . . . . . . .49

Collecter, Autoriser, Annuler et Demander une nouvelle autorisation . . . . . . . . . . . . 49

Effectuer une collecte unique dans une commande à l'aide de DoCapture . . . . . . . . . 49

Effectuer plusieurs collectes partielles dans une commande à l'aide de DoCapture . . . . 50

6 Mai 2007Guide de développement et référence de l’API Paire Nom-Valeur (NVP)

Insérer un numéro de facture et une remarque lors de la collecte à l'aide de DoCapture. . 51

Effectuer un remboursement à l'aide de RefundTransaction . . . . . . . . . . . . . . . . 51

Remboursement intégral. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Remboursements partiels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Insérer une remarque lors du remboursement . . . . . . . . . . . . . . . . . . . . . 52

Rechercher une transaction à l'aide de TransactionSearch . . . . . . . . . . . . . . . . . 52

Visualiser les détails d'une seule transaction à l'aide de GetTransactionDetails . . . . . . 53

Annexe A Liste de référence des méthodes et des champs

de l'API NVP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Caractéristiques générales des requêtes et des paramètres . . . . . . . . . . . . . . . . 55

Paramètres . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Champs multi-valeurs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Devises acceptées par PayPal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Paiement express PayPal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

Requête SetExpressCheckout. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

Réponse SetExpressCheckout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

Requête GetExpressCheckoutDetails . . . . . . . . . . . . . . . . . . . . . . . . . . 65

Réponse GetExpressCheckoutDetails. . . . . . . . . . . . . . . . . . . . . . . . . . 66

Requête DoExpressCheckoutPayment . . . . . . . . . . . . . . . . . . . . . . . . . 67

Réponse DoExpressCheckoutPayment . . . . . . . . . . . . . . . . . . . . . . . . . 71

Autorisation et collecte . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

DoAuthorization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

DoCapture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

DoReauthorization. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

DoVoid. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

Sommaire

RefundTransaction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

TransactionSearch. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

GetTransactionDetails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

Paiement groupé. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90

Paiements récurrents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

SetCustomerBillingAgreement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

GetBillingAgreementCustomerDetails . . . . . . . . . . . . . . . . . . . . . . . . . . 94

CreateRecurringPaymentsProfile . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96

Transactions de référence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .100

DoReferenceTransaction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .100

Guide de développement et référence de l’API Paire Nom-Valeur (NVP) Mai 2007 7

Sommaire

Annexe B Liste de référence des messages d'erreur . . . . . . . . 105

Format des réponses d'erreur . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .105

Erreurs de validation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .105

Erreurs d'API générales . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .109

Erreurs de l'API Paiement express PayPal . . . . . . . . . . . . . . . . . . . . . . . . .110

Erreurs de l'API Autorisation et collecte . . . . . . . . . . . . . . . . . . . . . . . . . . .128

Erreurs de l'API RefundTransaction . . . . . . . . . . . . . . . . . . . . . . . . . . . . .132

Erreurs de l'API TransactionSearch . . . . . . . . . . . . . . . . . . . . . . . . . . . . .135

Erreurs de l'API GetTransactionDetails . . . . . . . . . . . . . . . . . . . . . . . . . . .137

Erreurs de l'API MassPay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .137

Erreurs de l'API Paiements récurrents. . . . . . . . . . . . . . . . . . . . . . . . . . . .142

Erreurs SetCustomerBillingAgreement . . . . . . . . . . . . . . . . . . . . . . . . .142

Erreurs de GetBillingAgreementCustomerDetails . . . . . . . . . . . . . . . . . . . .143

Erreurs de CreateRecurringPaymentsProfile . . . . . . . . . . . . . . . . . . . . . .144

Transactions de référence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .146

Annexe C Exemples Web de l'API NVP. . . . . . . . . . . . . . . . 151

Descriptions des exemples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .151

Accepter PayPal avec Paiement express . . . . . . . . . . . . . . . . . . . . . . . .151

Recueillir les détails de la transaction . . . . . . . . . . . . . . . . . . . . . . . . . .154

Fichiers communs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .155

Exemple d'utilisateur API avec signature API . . . . . . . . . . . . . . . . . . . . . . . .155

Exemples utilisant ASP classique . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .156

Logiciel requis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .156

Télécharger et décompresser les exemples. . . . . . . . . . . . . . . . . . . . . . .156

Installer les exemples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .156

Exécuter les exemples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .156

Exemples utilisant PHP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .156

Logiciel requis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .157

Télécharger et décompresser les exemples. . . . . . . . . . . . . . . . . . . . . . .157

Installer les exemples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .157

Exécuter les exemples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .157

Exemples utilisant ColdFusion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .157

Logiciel requis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .158

Télécharger et décompresser les exemples. . . . . . . . . . . . . . . . . . . . . . .158

Installer les exemples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .158

Exécuter les exemples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .158

8 Mai 2007Guide de développement et référence de l’API Paire Nom-Valeur (NVP)

Sommaire

Annexe D Le kit de développement PayPal Java. . . . . . . . . . . 159

Installation du kit de développement PayPal Java. . . . . . . . . . . . . . . . . . . . . .159

Normes prises en charge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .159

Configuration matérielle recommandée . . . . . . . . . . . . . . . . . . . . . . . . .159

Télécharger et décompresser le kit de développement PayPal . . . . . . . . . . . . .160

Configuration post-installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .160

Documentation complète du kit de développement PayPal et des classes d'API . . . . . .161

Journaux du kit de développement PayPal . . . . . . . . . . . . . . . . . . . . . . .161

Préférences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .162

Aperçu des classes liées aux préférences. . . . . . . . . . . . . . . . . . . . . . . .163

Exemples d'applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .164

Exemple d'utilisateur API avec signature API . . . . . . . . . . . . . . . . . . . . . .164

Exemple d'utilisateur API avec certificat d'API. . . . . . . . . . . . . . . . . . . . . .165

Annexe E Le kit de d éveloppement PayPal ASP.NET . . . . . . . . 167

Installation du kit de développement PayPal ASP.NET . . . . . . . . . . . . . . . . . . .167

Normes prises en charge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .167

Configuration post-installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .168

Configurations personnalisées facultatives de Web.config . . . . . . . . . . . . . . .169

Journaux du kit de développement PayPal . . . . . . . . . . . . . . . . . . . . . . .169

Activer la prise en charge des procurations . . . . . . . . . . . . . . . . . . . . . . .171

Désinstaller le kit de développement PayPal . . . . . . . . . . . . . . . . . . . . . .171

Documentation complète du kit de développement PayPal et des classes d'API . . . . . .171

Préférences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .171

Aperçu des classes liées aux préférences. . . . . . . . . . . . . . . . . . . . . . . .172

Exemples d'applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .173

Exemple d'utilisateur API avec signature API . . . . . . . . . . . . . . . . . . . . . . . .173

Exemple d'utilisateur API avec certificat d'API. . . . . . . . . . . . . . . . . . . . . . . .174

Installer les exemples sur Microsoft IIS . . . . . . . . . . . . . . . . . . . . . . . . . . .175

Exécuter les exemples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .175

Annexe F Codes pays . . . . . . . . . . . . . . . . . . . . . . . . 177

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183

Guide de développement et référence de l’API Paire Nom-Valeur (NVP) Mai 2007 9

Sommaire

10 Mai 2007Guide de développement et référence de l’API Paire Nom-Valeur (NVP)

Préface

A propos de ce document

Le Guide de développement et référence de l'API Pair e Nom-Valeur (NVP) décrit l'API Paires Nom-Valeur de PayPal.

Public ciblé

Le Guide de développement et référence de l'API Paire Nom-Valeur (NVP) s'adresse aux développeurs de sites mettant en oeuvre des solutions utilisant l'API Paire Nom-Valeur.

Problèmes relatifs à la documentation

Si vous relevez des erreurs ou si vous rencontrez des problèmes liés à cette documentation, envoyez-nous un email en suivant les instructions ci-dessous. Décrivez l'erreur ou le problème aussi précisément que possible et communiquez-nous le titre du document et le(s) numéro(s) de page(s).

Pour contacter le service d'assistance des développeurs au sujet des problèmes liés à la documentation :

Connectez-vous à votre compte à l'adresse email et votre mot de passe dans la zone Log In.

Cliquez sur Help Center en haut à droite de la page. Cliquez sur Email PayPal Technical Support. Complétez le formulaire.

https://developer.paypal.com/ en entrant votre adresse

Guide de développement et référence de l'API Paire Nom-Valeur (NVP) Mai 2007 11

Historique des révisions

Historique des révisions du Guide de développement et référence de l'API Paire Nom-Valeur (NVP) .

TABLEAU P.1 Historique des révisions

Date Description

Avril 20 07 Ajout d'API pour les paiements récurrents :

SetCustomerBillingAgreement, GetBillingAgreementCustomerDeta ils et CreateRecurringPaymentsProfile.

Février 2007 La correction de problèmes comprenant la mise à jour des détails des objets pour

le paiement direct et les API Paiement express, la définition de quelques paramètres sur facultatif dans DoDirectPayment, l'ajout de SHIPTOCOUNTRYCODE, ainsi que celui de codes Switch/Solo codes pour AVS et

CVV2. Décembre 2006 Mises à jour des corrections de problèmes. Octobre 2006 Première version publique.

12 Mai 2007Guide de développement et référence de l'API Paire Nom-Valeur (NVP)

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 à la fonctionalité commerciale de PayPal afin 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, Paiement direct 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 Connaitre les détails d'une transaction spécifique

Ajouter PayPal à votre application Web est aisé, 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 avec l'API PayPal

Vous pouvez développer avec l'API NVP PayPal en utilisant l'une ou l'autre des deux approches suivantes :

Intégration directe

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

Guide de développement et référence de l'API Paire Nom-Valeur (NVP) Mai 2007 13

Présentation

Etapes de base

exemples Web sont téléchargeables, qui vous montrent comment intégrer directement en utilisant ASP classique, PHP et ColdFusion.

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,

«Le kit de développement PayPal Java» ou l'Annexe E, «Le kit de développement PayPal ASP.NET».

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 15, nous expliquons comment transférer

votre application de l'Environnement de test à l'environnement réel de PayPal.

REMARQUE : la meilleure façon de démarrer est de télécharger et de tester les exemples

d'applications de la façon décrite dans la section « Intégrer avec l'API PayPal »

page 13.

Créer une application Web

Votre intégration de l'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 suivant dans vos échantillons de programmes s'exécutant dans l'Environnement de test PayPal.

REMARQUE : si vous vous servez des exemples, cette signature est déjà présente dans le

code.

TABLEAU 1.1 Détails de l'exemple de signature API

Identifiant API sdk-three_api1.sdk.com

14 Mai 2007 Guide de développement et référence de l'API Paire Nom-Valeur (NVP)

Présentation

Transférer votre application dans l'environnement de production de PayPal

ABLEAU 1.1 Détails de l'exemple de signature API (suite)

Mot de passe API QFZCWN5HZM8VBG7Q Signature API A-IzJhZZjhg29XQ2qnhapuwxIDzyAZQ 92FRP5dqBzVesOkzbd UONzmOU

Créer et envoyer la requête

Créez une chaîne de requête NVP et l'envoyer à l'Environnement de test PayPal. Ajoutez un code à votre application Web pour pouvoir effectuer les tâches suivantes :

1. Encodez au format URL les paramètres nom et valeur dans la requête pour faire en sorte

que tous les caractères soient transmis correctement. Cette action est décrite dans la section

« Encodage dans l'URL » page 17.

2. Construisez la chaîne de requête API NVP en vous aidant des conseils de la section

« Format de la requête » page 18. Le format NVP est décrit dans la section «Format NVP » page 16.

3. Envoyez ensuite la requête NVP à l'Environnement de test PayPal ainsi qu'expliqué dans la

section « Envois utilisant HTTPS » page 20.

Interpréter la réponse

PayPal traite votre requête et vous envoie une réponse au format NVP. Ajoutez un code à votre application Web pour pouvoir effectuer les tâches suivantes :

1. Recevez la réponse HTTP et procédez à l'extraction de la chaîne NVP.

2. Décodez les valeurs des paramètres du format URL en vous aidant des conseils de la

section « Encodage dans l'URL » page 17.

3. Prenez les mesures adaptées en fonction des réponses.

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.

Créer un compte Business PayPal

Lorsque vous êtes prêt à transférer votre application sur le serveur réel de PayPal, ouvrez un compte Business PayPal sur

www.paypal.fr.

Guide de développement et référence de l'API Paire Nom-Valeur (NVP) Mai 2007 15

Présentation

Détails techniques

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ée r une signature API pour votre compte Business

IMPORTANT : 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

devrait en aucun cas être utilisé dans un environnement de production.

REMARQUE : 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 20).

z Informations d'authentification API que vous avez créées à la section « Créer des

informations d'authentification API » page 16.

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.

Format URL

La requête et la réponse sont encodées au format URL qui est défini 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.

16 Mai 2007 Guide de développement et référence de l'API Paire Nom-Valeur (NVP)

Présentation

Détails techniques

Une chaîne NVP doit se conformer aux directives suivantes :

z Le nom est séparé de la valeur par un signe égal (=). Par exemple :

FIRSTNAME=Robert

z Les paires nom-valeurs sont séparées par une esperluette (&). Par exemple :

FIRSTNAME=Robert&MIDDLENAME=He rbert&LASTNAME=Moo re

z La chaîne NVP est encodée dans l'URL.

Encodage dans l'URL

La requête et la réponse sont encodées dans l'URL. L'encodage URL garantie la transmission des caractères spéciaux, caractères qui ne sont pas autorisés dans une URL et des caractères ayant une signification particulière dans une URL tels que le signe égal et l'esperluette. Par exemple, la chaîne NVP suivante :

NAME=Robert Moore&COMPANY=R. H . Moore & Associat es

est encodée dans une URL de la manière suivante :

NAME=Robert+Moore&COMPANY=R%2E +H%2E+Moore+%26+As sociates

Utilisez les méthodes suivantes pour l'encodage dans une URL ou le décodage depuis une URL de votre chaîne NVP :

TABLEAU 1.2 Méthodes d'encodage dans une URL

Langage Méthode

ASP.NET Encode System.Web.HttpUtility.UrlEncode (buffer,

Encoding.Default)

Décodage System.Web.HttpUtility.UrlDecode (buffer,

Encoding.Default)

ASP classique

Java Encode java.net.UR LEncoder.encode

PHP Encode urlencode()

ColdFusion Encode URLEncodedF ormatstring [, charset ]

Encode Server.U RLEncode

Décodage Aucune fonction intégrée. Plusieurs exemples d'intégration sont disponibles

sur Internet.

Décodage java.net.URLDecoder.decode

Décodage urldecode()

Décodage URLDecodeurlEncodedString[, char set])

Guide de développement et référence de l'API Paire Nom-Valeur (NVP) Mai 2007 17

Présentation

Détails techniques

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

Paramètres de corps

USER=apiUsername&PWD=apiPassword&SIGNATURE=apiSignature &SUBJECT=optionalThirdPartyEmailAddress&VERSION=2.3

Les paramètres suivants sont toujours obligatoires :

USER PWD VERSION=2.3

EMARQUE : les paramètres de sécurité obligatoires apparaissent dans les

exemples sous la forme suivante :

[paramètresDeSécuritéRequis]

&METHOD=methodName&otherRequiredAndOptionalParameters

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 METHODE, vous pouvez spécifier les paramètres dans l'ordre de votre choix.

Paramètres de sécurité obligatoires

Les paramètres de sécurité obligatoires 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 Valeur

USER Obligatoire Votre identifiant API PayPal. PWD Obligatoire Votre mot de passe API PayPal. VERSION=2.3 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.

18 Mai 2007 Guide de développement et référence de l'API Paire Nom-Valeur (NVP)

Présentation

Détails techniques

IMPORTANT : vous devez protéger les valeurs de USER, PWD et de SIGNATURE dans

L'exemple de code ne sauvegarde pas ces valeurs de manière sûre. Il ne devrait 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 devriez EVITER de faire dans un Environnement de production :

Paramètres API

Le corps de la requête doit contenir le nom de la méthode API dans le paramètre METHODE. En outre, chaque méthode nécessite des paramètres obligatoires et facultatifs :

METHOD=methodName&requiredAndO ptionalParameters

Toutes les méthodes d'API et leurs paramètres sont detaillé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, « Débiter une carte bancaire en utilisant DoDirectPayment»,

Chapitre 2, « Accepter PayPal dans la fonction Paiement express», et Chapitre 4, « Fonctions de gestion».

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 genéral d'une réponse indiquant un e réuss ite

Champs d'une réponse indiquant une réussite

ACK=Success&TIMESTAMP=date/timeOfResponse &CORRELATIONID=debuggingToken&VERSION=2.300000 &BUILD=buildNumber

L'en-tête de la réponse de réussite apparaît dans les exemples sous la forme suivante :

[champsDeRéponseRéussie]

Champs de la réponse API

Guide de développement et référence de l'API Paire Nom-Valeur (NVP) Mai 2007 19

&NAME1=value1&NAME2=value2&NAME3=value3&...

Présentation

Détails techniques

Chaque réponse comprend le champ ACK. Si la valeur du champ est Success ou SuccessWithWarning, il vous faut alors 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 et y compris le champ BUILD. Les champs d'importance se trouve 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». Les actions que vous prenez en ce qui concerne les champs dépendent 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 d'erreur

Si la valeur ACK est Erreur ou Avertissement, 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 sur l'erreur

ACK=Error&TIMESTAMP=date/timeOfResponse& CORRELATIONID=debuggingToken&VERSION=2.300000& BUILD=buildNumber&L_ERRORCODE0=errorCode& L_SHORTMESSAGE0=shortMessage L_LONGMESSAGE0=longMessage &L_SEVERITYCODE0=severityCode

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 connaitre 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ére nce des messages d'erreur».

Valeurs du paramètre ACK

Le tableau ci-dessous répertorie les valeurs du paramètre ACK.

ABLEAU 1.7 Valeurs du paramètre ACK

Type de réponse Valeur

Réponse de réussite Success

SuccessWithWarning

Réponse d'erreur Error

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 réel ainsi qu'un serveur

20 Mai 2007 Guide de développement et référence de l'API Paire Nom-Valeur (NVP)

Présentation

Détails techniques

en Environnement de test qui vous permet de traiter les transations dans un Environnement de test.

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/nv p Réel: 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 Réel : https://api.paypal.com/nvp

Guide de développement et référence de l'API Paire Nom-Valeur (NVP) Mai 2007 21

Présentation

Détails techniques

22 Mai 2007 Guide de développement et référence de l'API Paire Nom-Valeur (NVP)

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 23 z « Vérifier l'adresse de livraison à l'aide de SetExpressCheckout » page 26 z « GetExpressCheckoutDetails renvoie l'adresse de livraison ignorée » page 28 z « Modifier le Logo des pages PayPal à l'aide de SetExpressCheckout » page 28 z « Remplir le formulaire de votre page de vérification de paiement à l'aide de

GetExpressCheckoutDetails » page 30

z « Effectuer une vente à l'aide de DoExpressCheckoutPayment » page 31 z « Autoriser une collecte unique à l'aide de SetExpressCheckout et de

DoExpressCheckoutPayment » page 31

z « Autoriser des collectes multiples à l'aide de SetExpressCheckout et de

DoExpressCheckoutPayment » page 32

z « Changer l'URL de la Notification instantanée de paiement (IPN) à l'aide de

DoExpressCheckoutPayment » page 32

z « Inclure le détail des objets à l'aide de D oExpressCheckoutPayment » page 33 z « Inclure les sous-totaux à l'aide de DoExpressCheckoutPayment » page 34 z « Mettre à jour les détails de la commande à l'aide de DoExpressCheckoutPayment »

page 35

z « Mettre à jour l'adresse de livraison à l'aide de DoExpressCheckoutPayment » page 35

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.

Guide de développement et référence de l’API Paire Nom-Valeur (NVP) Mai 2007 23

Accepter PayPal dans la fonction Paiement express

Procédure de paiement de base via PayPal

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

La réponse SetExpressCheckout, vous fournit un TO KEN qui identifie de manière unique cette transaction en trois étapes. Vous devez transmettre ce TOKEN dans les requêtes

GetExpressCheckoutDetails et DoExpressChec koutPayment. GetExpressCheckoutDetails et DoExpressChec koutPayment 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

ABLEAU 2.1 Initialiser le paiement

Requête

Réponse

[paramètresDeSécuritéRequis]&METHOD=SetExpressCheckout&AMT=10.00&

RETURNURL=https://www.masociété.com/traitement_commandes/affich_commande.html& CANCELURL=https://www.masociété.com/traitement_commandes/infoslivraison.html&

[champsDeRéponseRéussie]&TOKEN=EC-3DJ78083ES565113B

REMARQUE : du fait que nous ne la spécifions pas, la valeur de l'élément P AYMENTACTION

sera sa valeur par défaut : Vente.

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/fr/cgi- bin/webscr?cmd=_ex press-checkout& token=value_from_SetExpressChe ckoutResponse

24 Mai 2007 Guide de développement et référence de l’API Paire Nom-Valeur (NVP)

Accepter PayPal dans la fonction Paiement express

Procédure de paiement de base via PayPal

Pour rediriger le navigateur d'un client vers la page de connexion à PayPal, PayPal vous recommande d'utiliser la réponse HTTPS 302 « Objet déplacé » avec l'URL ci-dessus comme valeur de l'en-tête Location dans la réponse HTTPS. Si votre serveur utilise le protocole SSL, vous évitez que le navigateur ne reçoive des avertissements à propos d'un mélange d'images sécurisées et non sécurisées.

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 TOKEN ainsi que les informations du client.

TABLEAU 2.2 Obtenir les informations du client

Requête

Réponse

[paramètresDeSécuritéRequis]&METHOD=GetExpressCheckoutDetails&

TOKEN=EC-3DJ78083ES565113B

[champsDeRéponseRéussie]&TOKEN=EC-3DJ78083ES565113B&EMAIL=abcdef@anyemail.com& PAYERID=95HR9CM6D56Q2&PAYERSTATUS=vérifié&FIRSTNAME=Pierre& LASTNAME=Dupont&COUNTRYCODE=FR& SHIPTONAME=Pierre Dupont&SHIPTOSTREET=by 10 rue de la République& SHIPTOCITY=Paris&SHIPTOSTATE=CA&SHIPTOCOUNTRYCODE=FR& SHIPTOZIP=75015&ADDRESSID=PayPal& ADDRESSSTATUS=Confirmé

Assurez-vous que la valeur de TOKEN corresponde à la valeur contenue dans la réponse SetExpressCheckout.

Sauvegarder 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 <:v "Express Checkout" 1> de PayPal à l'aid 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 des collectes multiples à l'aide de

SetExpressCheckout et de DoExpressCheckoutPayment » page 32.

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

Guide de développement et référence de l’API Paire Nom-Valeur (NVP) Mai 2007 25

Accepter PayPal dans la fonction Paiement express

Vérifier l'adresse de livraison à l'aide de SetExpressCheckout

PAYMENTACTION : choisissez Vente. Il s'agit de la valeur par défaut de SetExpressCheckout.

AMT : utilisez la même valeur que pour la requêtet

TABLEAU 2.3 Effectuer une vente

Requête

Réponse

[paramètresDeSécuritéRequis]&METHOD=DoExpressCheckoutPayment&

TOKEN=EC-0E881823PA052770A&AMT=10.00& PAYERID=95HR9CM6D56Q2&PAYMENTACTION=Sale

[champsDeRéponseRéussie]&TOKEN=EC-0E881823PA052770A&

TRANSACTIONID=8SC56973LM923823H&TRANSACTIONTYPE=expresscheck out& PAYMENTTYPE=instant&ORDERTIME=2006-08-22T20:16:05Z&AMT=10.00& CURRENCYCODE=EUR&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 ADDROVER RIDE dans la requête SetExpressCheckout.

L'adresse de livraison est spécifiée dans les paramètres SHIPTO

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 SetExpres sCheckout.

xxx.

REMARQUE : la valeur de REQCONFIRMSHIPPING remplace le paramètre situé dans vos

Préférences de compte marchand.

ABLEAU 2.4 Exiger une adresse confirmée

Requête

Réponse

26 Mai 2007 Guide de développement et référence de l’API Paire Nom-Valeur (NVP)

[paramètresDeSécuritéRequis]&METHOD=SetExpressCheckout&AMT=10.00&

RETURNURL=https://www.masociété.com/traitement_commandes/affich_commande.html& CANCELURL=https://www.masociété.com/traitement_commandes/infoslivraison.html& &REQCONFIRMSHIPPING=1

[champsDeRéponseRéussie]&TOKEN=EC-0E881823PA052770A

Accepter PayPal dans la fonction Paiement express

Vérifier l'adresse de livraison à l'aide de SetExpressCheckout

Supprimer l'affichage de l'adresse de livraison sur PayPal

Pour faire en sorte 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

Requête

Réponse

[champsDeRéponseRéussie]&TOKEN=EC-17C76533PL706494P

GetExpressCheckoutDetails ne renvoie pas l'adresse de livraison.

TABLEAU 2.6 GetExpressCheckoutDetails

Requête

Réponse

[paramètresDeSécuritéRequis]&METHOD=GetExpressCheckoutDetails& TOKEN=EC-17C76533PL706494P

[champsDeRéponseRéussie]&TOKEN=EC17C76533PL706494P&EMAIL=abcdef@masociété.com&PAYERID=95HR9CM6D56Q2& PAYERSTATUS=vérifié&FIRSTNAME=Pierre&LASTNAME=Dupont&COUNTRYCODE=FR& ADDRESSID=PayPal&ADDRESSSTATUS=Aucun

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émentADDROVERRIDE la valeur 1 et définissez les champs de l'adresse de livraison (consultez le Tableau A.5, « 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

Guide de développement et référence de l’API Paire Nom-Valeur (NVP) Mai 2007 27

[paramètresDeSécuritéRequis]&METHOD=SetExpressCheckout&AMT=10.00& RETURNURL=https://www.masociété.com/traitement_commandes/affich_commande.html& CANCELURL=https://www.masociété.com/traitement_commandes/infoslivraison.html& &SHIPTONAME=Peter+Dupont&SHIPTOSTREET=by 10 rue de la République&SHIPTOCITY=Paris &SHIPTOSTATE=CA&SHIPTOCOUNTRYCODE=FR&SHIPTOZIP=99911&

ADDROVERRIDE=1

Accepter PayPal dans la fonction Paiement express

Changer la langue de la page de connexion à PayPal à l'aide de SetExpressCheckout

Réponse

[champsDeRéponseRéussie]&TOKEN=EC-17C76533PL706494P

GetExpressCheckoutDetails renvoie l'adresse de livraison ignorée

TABLEAU 2.8 GetExpressCheckoutDetails

Requête

Réponse

[paramètresDeSécuritéRequis]&METHOD=GetExpressCheckoutDetails&TOKEN=EC- 17C76533PL706494P

[champsDeRéponseRéussie]&TOKEN=EC-17C76533PL706494P& PAYER=abcdef@masociété.com&PAYERID=95HR9CM6D56Q2&PAYERSTATUS=vérifié& FIRSTNAME=Pierre&LASTNAME=Dupont& COUNTRYCODE=FR&SHIPTONAME=Peter+Dupont&SHIPTOSTREET=by 10 rue de la

République& SHIPTOCITY=Paris&SHIPTOSTATE=CA&SHIPTOCOUNTRYCODE=FR&SHIPTOZIP=75015& ADDRESSID=PayPal&ADDRESSSTATUS=non confirmé

Changer la langue de la page de connexion à PayPal à l'aide de

SetExpressCheckout

Pour changer la langue de la page de connexion à PayPal, donner à LO CALECODE une des valeurs autorisées dans SetExpressCheckout. Pour obtenir plus d'informations au sujet des valeurs de LOCALECODE, consultez le Tableau A.4, « Paramètres de la requête

SetExpressCheckout ». Dans l'exemple su ivant 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

Réponse

[paramètresDeSécuritéRequis]&METHOD=SetExpressCheckout&AMT=10.00& CURRENCYCODE=EUR& RETURNURL=https://www.masociété.com/traitement_commandes/affich_commande.html& CANCELURL=https://www.masociété.com/traitement_commandes/infoslivraison.html& &LOCALECODE=fr_FR

[champsDeRéponseRéussie]&TOKEN=EC-17C76533PL706494P

Modifier le Logo des pages PayPal à l'aide de

SetExpressCheckout

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

28 Mai 2007 Guide de développement et référence de l’API Paire Nom-Valeur (NVP)

Accepter PayPal dans la fonction Paiement express

Modifier le Logo des pages PayPal à l'aide de SetExpressCheckout

Sélectionner un style de pages de paiement prédéfini

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 Sélectionner un style de pages de paiement prédéfini

Requête

Réponse

PAGESTYLE=DesignerFotos-Yellow

[champsDeRéponseRéussie]&TOKEN=EC-17C76533PL706494P

Spécifier les paramètres du Logo et des couleurs individuellement

Pour faire en sorte que les pages W eb 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 que vous désirez afficher en haut à gauche de la page de

paiement

z HDRBORDERCOLOR : définit la couleur de bordure de 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 Spécifier les paramètres du Logo et des couleurs individuellemen t

Requête

HDRIMG=https://www.masociété.com/images/HeaderImage.gif& HDRBORDERCOLOR=3366FF&HDRBACKCOLOR=D3EFF5&PAYFLOWCOLOR=F8F5F5

Réponse

Guide de développement et référence de l’API Paire Nom-Valeur (NVP) Mai 2007 29

[champsDeRéponseRéussie]&TOKEN=EC-17C76533PL706494P

Accepter PayPal dans la fonction Paiement express

Remplir le formulaire de votre page de vérification de paiement à l'aide de GetExpressCheckoutDetails

Remplir le formulaire de votre page de vérification de paiement

à l'aide de GetExpressCheckoutDetails

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

Réponse

[paramètresDeSécuritéRequis]&METHOD=GetExpressCheckoutDetails& TOKEN=EC-3DJ78083ES565113B

[champsDeRéponseRéussie]&TOKEN=EC-3DJ78083ES565113B&EMAIL=abcdef@anyemail.com& PAYERID=95HR9CM6D56Q2&PAYERSTATUS=vérifié&FIRSTNAME=Pierre&LASTNAME=Dupont& COUNTRYCODE=FR&SHIPTONAME=Pierre Dupont&SHIPTOSTREET=by 10 rue de la République& SHIPTOCITY=Paris&SHIPTOSTATE=CA&SHIPTOCOUNTRYCODE=FR&SHIPTOZIP=75015& ADDRESSID=PayPal&ADDRESSSTATUS=Confirmé

Obtenez le nom du payeur à partir des paramètres suivants de la réponse GetExpressCheckoutDetails :

z SALUTATION z FIRSTNAME z MIDDLENAME z LASTNAME 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

30 Mai 2007 Guide de développement et référence de l’API Paire Nom-Valeur (NVP)

+ 157 hidden pages