Table des matières
À propos de Paypal
Informations générales sur PayPal
PayPal est l'un des plus grands portefeuilles électroniques au monde pour l'e-commerce et le m-commerce. Environs 179 millions de membres actifs dans plus de 200 pays payent leurs achats en ligne avec PayPal. Les acheteurs peuvent payer via prélèvement automatique ou par carte (American Express, Diners Club, Discover, MasterCard, Visa). Outre ces modes de paiement, PayPal PLUS propose les formules d'achat à crédit et d'achat à tempérament. Lors du passage à la validation du paiement, les membres se connectent à leur compte PayPal avec leur adresse e-mail et leur mot de passe, ils sélectionnent également leur mode de paiement préféré (prélèvement automatique, crédit PayPal, carte et, si applicable, achat à crédit ou à tempérament). Le montant à payer est alors immédiatement crédité sur leur propre compte PayPal. Les durées de transfert usuelles pour les prélèvements automatiques ou les retards dus à la distribution des services de collecte ne s'appliquent pas. Ceci permet un traitement de paiement en temps réel sur Internet.
PayPal Express Checkout
La plateforme de paiement propose l'option PayPal Express Checkout afin de raccourcir le processus de commande : Vos clients ne doivent pas entrer de données d'adresse, ils cliquent simplement sur le bouton Checkout de PayPal de la rubrique panier, ils se connectent et sélectionnent les adresses de facturation et de livraison conservées par PayPal. la plateforme de paiement renvoie alors l'adresse de livraison à votre boutique, sous forme de paramètre de réponse.
Protection des acheteurs et des vendeurs inclue
Les acheteurs et les vendeurs sont également protégés. PayPal offre une protection acheteur / vendeur étendue aux acheteurs et aux commerçants. Les acheteurs peuvent ainsi réclamer un remboursement à PayPal en cas de non-exécution d'un contrat de vente. Avec sa vérification d'adresse et sa protection du vendeur, PayPal décharge le commerçant du risque de défaut de paiement dans le cas de paiements par prélèvement automatique, de paiements par carte de crédit allemande ou encore de réclamations injustifiées de la part des acheteurs. La protection du vendeur est toujours sujette aux règlements et conditions de PayPal. La gestion des risques PayPal avec protection des acheteurs et vérification d'adresse vous est proposée via la plateforme de paiement.
Payer en ligne dans le monde entier
PayPal s'avère particulièrement avantageux pour l'acquisition de clients internationaux. La plateforme de paiement prend en charge toutes les devises et tous les marchés proposés par PayPal. Dans de nombreux pays, PayPal propose aux clients des modes de paiement spécifiques à leur pays. Les clients à l'étranger peuvent souvent utiliser des modes de paiement typiques comme par ex. les cartes prépayées en Italie ou les cartes de débit au Royaume-Uni. L'intégration de PayPal au sein de votre boutique vous permet donc de proposer à vos clients plusieurs modes de paiement à la fois.
AXEPTA traite également les paiements PayPal, ce qui vous offre une protection commerçant sur le plan mondial, avec un potentiel de 220 millions d'acheteurs internationaux dans plus de 200 pays. PayPal est un des modes de paiement en ligne les plus populaires, ce système peut être utilisé pour l'e-commerce et le m-commerce. |
Vous trouverez de plus amples informations sur la page web de PayPal (http://www.paypal.com).
Schémas de déroulement du processus
Déroulement de processus PayPal du point de vue du commerçant :
Déroulement de processus PayPal Shortcut du point de vue du commerçant :
Informations importantes
Veuillez noter qu'à l'inverse de notre tableau des devises, les devises HUF (forint hongrois) et TWD (République de Chine - dollar taïwanais) doivent être introduites sans décimales.
Exemple : pour transférer 100,00 HUF, entrez le montant=100
Ces exceptions ne s'appliquent que pour le mode de paiement PayPal.
Configuration pour PayPal
Le commerçant qui souhaite traiter des transactions PayPal via la plateforme de paiement doit disposer d'un compte professionnel PayPal. Il doit également activer l'interface PayPal pour une utilisation via la plateforme de paiement et procéder aux paramétrages requis pour la réception des paiements.
Création et configuration du compte professionnel PayPal
- Veuillez utiliser l'URL PayPal de votre pays, par ex. http://www.paypal.co.uk.
- Cliquez sur le bouton « Inscription » pour ouvrir un nouveau compte professionnel
- La page suivante vous montre les types de comptes professionnels qui peuvent être créés.
- Veuillez sélectionner « Compte professionnel » puis cliquer sur « Continuer ».
- Vous accédez alors à la page « Ouvrir compte professionnel ». Veuillez saisir votre adresse e-mail - celle-ci sera utilisée pour votre compte PayPal - puis cliquer sur « Continuer ».
- Entrez ici les informations relatives à votre commerce. Acceptez les Conditions d'utilisation en cliquant sur le bouton « Accepter et continuer ».
- Veuillez compléter dans les pages suivantes les informations demandées au sujet de votre entreprise.
- Vous recevez ensuite un e-mail pour la confirmation de votre adresse e-mail. Veuillez confirmer votre adresse e-mail.
- Veuillez compléter les informations supplémentaires demandées au sujet de votre entreprise.
Paramétrage de l'autorisation API
Pour pouvoir traiter des transactions PayPal via la plateforme de paiement, vous devez paramétrer une autorisation API. Veuillez par conséquent compléter les six étapes expliquées ci-dessous.
- Accédez au menu -> Profils -> Profils et paramétrages
- Accédez à « Mes préférences de vente » à gauche …
… puis sélectionner « Accès API » : compléter avec le lien « Actualiser ». - Au sein de la rubrique Accès API, veuillez sélectionner « Accorder autorisation API »
- Veuillez entrer le nom d'utilisateur tiers API ci-dessous puis cliquer sur bouton « Consulter » : frank.arnoldt_api1.computop.de
- Cochez les cases ci-dessous pour le niveau d'accès API, ne pas cocher les autres cases. Cliquez sur « Ajouter » pour confirmer et clôturer le paramétrage d'autorisation API
- Utilisation de PayPal Express Checkout pour traiter vos paiements
- Émission d'un remboursement pour une transaction définie
- Autorisation et capture de vos transactions PayPal
- Appel d'informations sur une transaction définie
- Recherche au sein de vos transactions pour des articles correspondant à certains critères et affichage des résultats - Vous recevez une confirmation selon laquelle le fournisseur tiers « frank.arnoldt_api1.computop.de » a été ajouté.
Configuration des permissions de PayPal-API pour la Sandbox
Pour utiliser la Sandbox PayPal, vous aurez besoin de configurer les permissions en suivant les étapes ci-après:
- Sur le site https://developer.paypal.com en dessous de "Accounts" --> (Accountname) --> "Manage accounts" --> "View/ edit account", vous trouverez les données d'accès du compte du commerçant adéquat.
- En utilisant ces données d'accès, veuillez vous connecter sur : https://sandbox.paypal.com.
- Cliquez sur le nom en haut à droite et aller dans "Account settings".
- Cliquez sur "API access" --> "Set up API permission" --> et saisissez "test_paypal_api_api1.computop.com".
- Cochez les cases pour les permissions suivantes :
-Utiliser PayPal Express pour procéder aux paiements
-Emettre un remboursement pour une transaction spécifique
-Autoriser et capturer vos transactions PayPal
-Obtenir des informations sur une seule transaction
-Rechercher dans vos transactions des items qui répondent à des critères spécifiques et afficher les résultats.
Paramétrage des préférences pour la réception des paiements
- Accédez aux « Profils » puis cliquez sur « Profils et paramétrages ».
- Sélectionnez sous « Mes préférences de vente » l'option « Bloquer paiements » avec le lien « Actualiser ».
- Veuillez procéder aux étapes suivantes.
- Bloquer les paiements transmis avec une devise non prise en charge
- Bloquer les paiements accidentels avec double ID de facture
- Refuser les paiements suivants : bloquer les paiements avec statut « en attente » (recommandé). Cette option n'a aucun effet sur les paiements eBay.
- Bloquer les paiements provenant de mineurs titulaires d'un compte Étudiants
- Afficher le champ de saisie de texte « Ajouter instructions pour le vendeur »
Veuillez confirmer les options choisies en cliquant sur le bouton « Enregistrer ».
Paramètres de l'interface
Formats des données : a alphabétique as alphabétique avec caractères spéciaux n numérique an alphanumérique ans alphanumérique avec caractères spéciaux ns numérique avec caractères spéciaux bool expression booléenne (true ou false) 3 longueur fixe avec 3 chiffres/caractères ..3 longueur variable avec maximum 3 chiffres/caractères enum énumération de valeurs admissibles dttm Date et heure ISO (AAAA-MM-JJThh:mm:ss) Abréviations : CND condition M obligatoire (mandatory en anglais) O optionnel C conditionnel Remarque : Veuillez noter que les noms des paramètres peuvent être en majuscules ou en minuscules.
Appel de l'interface
Utilisez l'URL et les paramètres ci-dessous pour initier un paiement PayPal au sein du formulaire de la plateforme de paiement :
Avec cette URL, la plateforme de paiement prend en charge deux méthodes PayPal différentes : vous pouvez d'une part proposer en toute simplicité PayPal comme mode de paiement supplémentaire pour la clôture d'une vente. D'autre part, vous pouvez utiliser le shortcut PayPal Express Checkout qui relie les clients du panier directement à PayPal, page dans laquelle ils sélectionnent ensuite leurs adresses de livraison et de facturation. le client épargne d'avoir à ressaisir ses coordonnées et le commerçant bénéficie de la protection des vendeurs de PayPal.
La plateforme de paiement prend également en charge la séparation de l'autorisation et de la capture pour PayPal Express Checkout. La plateforme de paiement vous permet de définir des paramètres pour déterminer si le montant doit être bloqué sur le compte PayPal du client ou immédiatement capturé.
Remarque : veuillez noter qu'une connexion PayPal au sein de la boutique via une fenêtre iFrame est impossible en raison des conditions PayPal. Express Checkout connecte toujours le client directement à PayPal.
Remarque : L'une des conditions ci-dessous doit être remplie pour que vous puissiez bénéficier de la protection du vendeur de PayPal. Soit le client utilise la fonction PayPal Express Checkout et choisit une adresse de livraison qu'il a préalablement définie avec PayPal, adresse que la plateforme de paiement transmet à votre boutique. Soit votre boutique transmet l'adresse de livraison déjà connue à PayPal. La protection du vendeur ne s'applique que si les marchandises ont été livrées à cette adresse spécifiée. Il ne peut y avoir plus de 3 jours entre l'autorisation du montant sur le compte PayPal du client et la saisie si vous souhaitez bénéficier de la protection du vendeur. C'est pourquoi la plateforme de paiement prend en charge plusieurs alternatives pour le traitement des paiements PayPal : nous restons volontiers à votre disposition pour vous conseiller sur l'implémentation de PayPal.
Remarque : Pour des raisons de sécurité, la plateforme de paiement rejette toutes les demandes de paiement contenant des erreurs de format. Veuillez par conséquent utiliser le type de données correct pour chaque paramètre.
Le tableau ci-dessous présente les paramètres de demande de paiement chiffrés :
Paramètre | Format | CND | Description |
---|---|---|---|
MerchantID | ans..30 | M | ID du commerçant. Ce paramètre doit également être transféré non chiffré. |
TransID | ans..64 | M | ID de la transaction qui doit être unique pour chaque paiement |
RefNr | an12 | M | Numéro de référence unique |
Amount | n..10 | M | Montant indiqué dans la plus petite unité de la devise (par ex. les centimes pour l'euro) Veuillez contacter notre service d'assistance si vous souhaitez capturer des montants < 100 (plus petite unité de la devise). Si le paramètre OrderDesc(n) est utilisé, l'option suivante doit être valide : |
Currency | a3 | M | Code pour la devise, trois caractères DIN / ISO 4217 |
Capture | a..6 | O | Auto ou Manual : détermine si le montant demandé doit être débité immédiatement ou plus tard. Remarque importante : veuillez contacter le Support pour l'option Manual afin de discuter des différentes utilisations possibles. |
TxType | ans..5 | C | Obligatoire pour Capture=Manual : type de transaction avec les valeurs possibles Order ou Auth et BAID (BillingAgreementID) |
PayPalMethod | enum | O | La fonction « shortcut » permet de sélectionner la procédure de transaction définie : le client est redirigé vers la boutique pour confirmation du paiement et par ex. en cas d'achat à tempérament, les données s'y rapportant sont affichées pour confirmation par le client. Vous devez alors appeler l'interface paypalcomplete.aspx pour clôturer la vente. |
RTF | ans1 | O | Pour paiements réguliers (abonnements) :
Dans ce cas, seul RTF=I est autorisé ; les autres paiements d'abonnement sont exécutés via l'interface séparée paypalAbo.aspx. |
OrderDesc | ans..127 | M | Description des produits achetées, des prix unitaires etc. |
OrderDesc(n) | ans..2048 | O | Panier du client sous la forme suivante : OrderDesc(n)=Name,Amount,Number,Quantity,Description,Tax OrderDesc2 à max. OrderDesc99 sont autorisés Afin de garantir l'exécution correcte de la fonction d'affichage, tous les montants OrderDesc(n) doivent coïncider avec le paramètre Amount de la plateforme de paiement. |
TaxTotal | n..12 | C | Obligatoire si +Tax est indiqué sous OrderDesc(n) : montant total des taxes des différents articles dans la plus petite unité de la devise (par ex. les centimes pour l'euro) = somme (Tax*Number) |
ItemTotal | n..12 | C | Obligatoire si +Tax est indiqué sous OrderDesc(n) : montant brut des différents articles dans la plus petite unité de la devise (par ex. les centimes pour l'euro) = somme (Amount*Number) |
ShAmount | n..12 | O | Frais d'expédition dans la plus petite unité de la devise (par ex. les centimes pour l'euro). Utilisé uniquement en lien avec les paramètres ItemTotal et TaxTotal. |
MAC | an64 | M | Code d'authentification de message haché (HMAC) avec algorithme SHA-256 |
URLSuccess | ans..256 | M | Adresse URL complète qui appelle la plateforme de paiement en cas de réussite du paiement. L'URL ne peut être appelée que par le port 443. Cette URL ne peut contenir aucun paramètre : pour échanger des valeurs de paramètre entre la plateforme de paiement et la boutique, veuillez utiliser le paramètre UserData. |
URLFailure | ans..256 | M | Adresse URL complète qui appelle la plateforme de paiement en cas d'échec du paiement. L'URL ne peut être appelée que par le port 443. Cette URL ne peut contenir aucun paramètre : pour échanger des valeurs de paramètre entre la plateforme de paiement et la boutique, veuillez utiliser le paramètre UserData. |
Response | a7 | O | Statut de la réponse envoyée par la plateforme de paiement à URLSuccess et URLFailure, doit être chiffré. À cette fin, transmettez le paramètre Response=encrypt. |
URLNotify | ans..256 | M | Adresse URL complète appelée par la plateforme de paiement pour notifier le résultat de paiement à la boutique. L'URL ne peut être appelée que par le port 443. Elle ne peut contenir aucun paramètre : utilisez le paramètre UserData pour ce faire. |
UserData | ans..1024 | O | Si indiqué lors de la requête, la plateforme de paiement transmet le paramètre à la boutique avec le résultat du paiement |
ReqID | ans..32 | O | Pour éviter les paiements en double, saisissez une valeur alphanumérique qui identifie votre transaction et ne peut être attribuée qu’une seule fois. Si la transaction est à nouveau soumise avec le paramètre ReqID identique, la plateforme de paiement n’exécute pas le paiement et se contente de retourner le statut de la transaction d’origine. Attention : Plateforme de paiement doit afficher un statut de transaction finalisée pour la première action initiale. Les introductions avec un ReqID identique pour un statut ouvert sont traitées à intervalles réguliers. |
Account | ans..128 | O | Compte commerçant pour la gestion de plusieurs comptes PayPal : ID ou adresse e-mail pour lesquelles la demande doit être adressée à PayPal |
BrandName | ans..127 | O | Marque affichée sur la page de connexion |
HeaderLogo | ans..127 | O | URL pour une image de logo au sein de la rubrique de connexion. Formats graphiques GIF, JPG ou PNG avec maximum 190 x 60 pixels. Les logos plus larges sont tronqués par PayPal. PayPal affiche le logo en haut sur le panier. |
LandingPage | ans | O | Commande l'affichage de la page PayPal. Les valeurs possibles sont « Login » ou « Billing » |
FundingSource | a..7 | O | Pour l'achat à tempérament PayPal : « FINANCE » La formule d'achat à tempérament PayPal est actuellement proposée aux clients disposant d'une adresse de facturation allemande, en euros, avec un panier minimum de 99 euros. Les données relatives à l'achat à tempérament doivent être affichées pour le client avant la confirmation de la commande. Il faut par conséquent utiliser la méthode « shortcut » de PayPal. Les LineItem doivent également être transférés au sein des paramètres OrderDesc, y compris taxtotal, itemtotal et shamount. |
Language | an2 | O | AU, DE, FR, IT, GB, ES, US ; valeur par défaut DE |
FirstName | as..30 | OC | (obligatoire pour les USA et le Canada) : soit uniquement le nom, soit le nom et le prénom si le nom d'une société est utilisé comme adresse de livraison. |
LastName | as..30 | OC | (obligatoire pour les USA et le Canada) : nom ou nom de la société au sein de l'adresse de livraison |
AddrStreet | ans..100 | OC | (obligatoire pour les USA et le Canada) : rue au sein de l'adresse de livraison |
AddrStreet2 | ans..100 | O | rue au sein de l'adresse de livraison |
AddrCity | ans..40 | OC | (obligatoire pour les USA et le Canada) : localité de l'adresse de livraison |
AddrState | ans..40 | OC | (obligatoire pour les USA et le Canada) : État fédéral de l'adresse de livraison La localité indiquée sous AddrCity doit être située dans un état fédéré sans quoi PayPal refuse ce paiement. Consulter la documentation de référence PayPal API pour les valeurs possibles. |
AddrZip | ans..20 | OC | (obligatoire pour les USA et le Canada) : code postal de l'adresse de livraison |
AddrCountryCode | an2 | O | code de pays de livraison |
Phone | n..20 | O | Numéro de téléphone |
NoShipping | n1 | O | Le transfert de NoShipping=1 bloque l'affichage de l'adresse de livraison enregistrée chez Paypal |
AllowNote | ans..2 | O | La valeur « no » bloque l'option d'envoi d'un message au commerçant. Par défaut, un message éventuel est renvoyé au sein du paramètre Infotext. |
BuyerEMail | ans..127 | OC | Pré-réglage d'adresse e-mail sur la page de connexion PayPal |
NoteToBuyer | ans..165 | O | Texte d'info pour le client |
Le tableau suivant présente les paramètres de réponse que la plateforme de paiement transmet à URLSuccess ou URLFailure et URLNotify. Si vous avez spécifié le paramètre Response=encrypt, les paramètres suivants sont transmis à votre système avec chiffrement Blowfish :
Paramètre | Format | CND | Description | |
---|---|---|---|---|
MID | ans..30 | M | ID du commerçant, attribué par AXEPTA | |
PayID | an32 | M | ID attribuée au paiement par la plateforme de paiement, par ex. pour le référencement des fichiers batch. | |
XID | an32 | M | ID attribuée par La plateforme de paiement pour toutes les différentes transactions (commande, vente, autorisation, capture, remboursement) pour un paiement. | |
TransID | ans..64 | M | Numéro de transaction du commerçant | |
Status | a..30 | M | OK, AUTHORIZE_REQUEST ou Timeout (uniquement si Capture=Manual) sur la page URLSuccess page, ou FAILED sur la page URLFailure. AUTHORIZE_REQUEST – Est retourné activement uniquement pour le paramètre de demande "TxType = auth" ou "PayPalMethod = shortcut". Lors de l'utilisation de TxType = auth ou sans TxType, l'état final est renvoyé directement. | |
Description | ans..1024 | M | Détails supplémentaires en cas d'échec du paiement. Veuillez ne pas utiliser le paramètre Description mais bien le paramètre Code pour une analyse de l'état de la transaction ! | |
Code | n8 | M | Code d'erreur conformément au fichier Excel des codes de réponse de la plateforme de paiement | |
MAC | an64 | M | Code d'authentification de message haché (HMAC) avec algorithme SHA-256 | |
RefNr | an12 | M | Numéro de référence unique du commerçant | |
UserData | ans..1024 | O | Si indiqué lors de la requête,, la plateforme de paiement transmet le paramètre à la boutique avec le résultat du paiement | |
CodeExt | n..10 | O | Code d'erreur de PayPal, si convenu avec le Support | |
Nom | ans..32 | M | Prénom et nom collés | |
FirstName | as..30 | M | Prénom du client (PayerInfo, peut être différent du nom du compte) | |
LastName | as..30 | M | Nom du client (PayerInfo, peut être différent du nom du compte) | |
ans..100 | M | Adresse e-mail du client. | ||
AddrStreet | ans..100 | O | rue de l'adresse de livraison | |
AddrStreet2 | ans..100 | O | 2. Nom de rue de l'adresse de livraison, si convenu avec AXEPTA | |
AddrCity | ans..40 | O | localité de l'adresse de livraison | |
AddrState | ans..40 | O | État fédéral de l'adresse de livraison | |
AddrZIP | ans..20 | O | code postal de l'adresse de livraison | |
AddrCountryCode | an2 | O | code de pays de livraison | |
Phone | n..20 | O | Numéro de téléphone | |
BillingAgreementID | an19 | M | Numéro d'identification du règlement des factures. Dès que le client confirme ce règlement des factures, ce dernier entre en vigueur et reste valide jusqu'à sa révocation par le client. | |
BillingName | ans..32 | O | Prénom et nom collés | |
BillingAddrStreet | ans..100 | O | Nom de rue de l'adresse de facturation enregistrée chez PayPal | |
BillingAddrStreet2 | ans..100 | O | 2. Nom de rue de l'adresse de facturation enregistrée chez PayPal, si convenu avec AXEPTA | |
BillingAddrCity | ans..40 | O | Localité de l'adresse de facturation enregistrée chez PayPal | |
BillingAddrState | ans..40 | O | État fédéral de l'adresse de facturation enregistrée chez PayPal | |
BillingAddrZIP | ans..20 | O | Code postal de l'adresse de facturation enregistrée chez PayPal | |
BillingAddrCountryCode | an2 | O | code de pays de livraison | |
TransactionID | an..19 | O | Numéro de transaction unique de PayPal pour une transaction (PayPal Order) | |
TID | an..19 | O | Numéro de transaction unique de PayPal pour une autorisation (PayPal Auth): Uniquement pour la configuration automatique de PayPal ou si TxType = Auth | |
payerStatus | an..10 | O | Statut de l'acheteur avec les valeurs possibles "verified" ou "unverified" | |
InfoText | ans..255 | M | Message à l'attention du commerçant | |
PayerID | ans..13 | O | (Si la réponse est activée) : numéro d'identification unique du compte client chez PayPal | |
IsFinancing | ans..5 | C | Uniquement en cas d'achat à tempérament : indique s'il s'agit ou non d'un achat à tempérament : valeur « TRUE » ou « FALSE » | |
FinancingFeeAmount | ans..9 | C | Uniquement en cas d'achat à tempérament : frais liés à l'achat à tempérament. (transfert par PayPal ; il n'y a jusqu'à présent pas de conversion dans la plus petite unité de la devise) | |
FinancingMonthlyPayment | ans..9 | C | Uniquement en cas d'achat à tempérament : montant estimé avec frais, que le client doit payer chaque mois. (transfert par PayPal ; il n'y a jusqu'à présent pas de conversion dans la plus petite unité de la devise) | |
FinancingTerm | an..2 | C | Uniquement en cas d'achat à tempérament : nombre de mensualités (valeurs possibles 6, 12, 18 et 24) | |
FinancingTotalCost | ans..9 | C | Uniquement en cas d'achat à tempérament : montant estimé avec frais, que le client doit payer au total. (transfert par PayPal ; il n'y a jusqu'à présent pas de conversion dans la plus petite unité de la devise) | |
GrossAmount | an..9 | O | Montant définitif imputé, avec frais d'expédition et taxes issus de votre profil de commerçant | |
FeeAmount | an..9 | O | Montant des frais PayPal imputés pour la transaction | |
SettleAmount | an..9 | O | Montant déposé sur votre compte PayPal suite à une conversion de devises | |
TaxAmount | an..9 | O | Taxes imputées pour la transaction | |
ExchangeRate | an..17 | O | Taux de change en cas de conversion de devises. Applicable uniquement si la facture n'est pas établie dans la devise principale. Si le client choisit de payer dans une devise autre que la devise principale, la conversion s'effectue au sein du compte du client | |
mc_fee | an..9 | C | Uniquement en cas de notification séparée de la part de PayPal : frais de transaction associés au paiement. mc_gross moins mc_fee correspond au montant déposé sur le compte receiver_email. Correspond au paramètre payment_fee pour les paiements en USD. Un montant négatif signale un remboursement ou une annulation : ces deux statuts de paiement peuvent concerner le montant total ou partiel des frais de transaction originaux | |
mc_gross | an..9 | C | Uniquement en cas de notification séparée de la part de PayPal : montant total du paiement de l'acheteur avant déduction des frais de transaction. Correspond au paramètre payment_gross pour les paiements en USD. Un montant négatif signale un remboursement ou une annulation : ces deux statuts de paiement peuvent concerner le montant total ou partiel de la transaction originale. |
Remarque : Les paramètres d'adresse sont toujours transmis à la boutique mais restent vides en l'absence d'échange de données d'adresse.
Appel de l'interface pour la méthode « shortcut »
La méthode « shortcut » de PayPal permet une procédure de transaction modifiée : le client est redirigé vers la boutique pour confirmation du paiement et par ex. en cas d'achat à tempérament, les données s'y rapportant sont affichées pour confirmation par le client. Utilisez l'URL et les paramètres ci-dessous pour clôturer ce paiement PayPal dans l'étape suivante :
Le tableau ci-dessous présente les paramètres de demande de paiement chiffrés :
Paramètre | Format | CND | Description |
---|---|---|---|
MerchantID | ans..30 | M | ID du commerçant, attribué par AXEPTA. Ce paramètre doit également être transféré non chiffré. |
PayID | an32 | M | ID attribuée par La plateforme de paiement pour le paiement. Transmettez ici le PayID reprise sur la réponse de paypal.aspx reçue précédemment lors de cette procédure de transaction. |
TransID | ans..64 | M | ID de la transaction qui doit être unique pour chaque paiement |
RefNr | an12 | M | Numéro de référence unique |
Amount | n..10 | M | Montant indiqué dans la plus petite unité de la devise (par ex. les centimes pour l'euro) Veuillez contacter notre service d'assistance si vous souhaitez capturer des montants < 100 (plus petite unité de la devise). Si le paramètre OrderDesc(n) est utilisé, l'option suivante doit être valide : Remarque : en cas de modification du paramètre OrderDesc(n), Amount doit également être adapté. |
Currency | a3 | M | Code pour la devise, trois caractères DIN / ISO 4217 |
OrderDesc(n) | ans..2048 | O | Panier du client sous la forme suivante : OrderDesc(n)=Name,Amount,Number,Quantity,Description,Tax OrderDesc2 à max. OrderDesc99 sont autorisés Afin de garantir l'exécution correcte de la fonction d'affichage, tous les montants OrderDesc(n) doivent coïncider avec le paramètre Amount de la plateforme de paiement. |
Informations relatives à l'adresse. En transférant ces valeurs, il est également possible de modifier une adresse. | |||
FirstName | as..30 | C | Obligatoire afin de transférer des informations d'adresse : soit uniquement le prénom, soit le prénom et le nom si le nom d'une société est utilisé comme adresse de livraison. |
LastName | as..30 | C | Obligatoire en cas de transmission de FirstName : nom ou nom de la société de l'adresse de livraison |
AddrStreet | ans..100 | C | Obligatoire en cas de transmission de FirstName : rue de l'adresse de livraison |
AddrStreet2 | ans..100 | C | Obligatoire en cas de transmission de FirstName : rue de l'adresse de livraison |
AddrCity | ans..40 | C | Obligatoire en cas de transmission de FirstName : localité de l'adresse de livraison |
AddrState | ans..40 | C | Obligatoire en cas de transmission de FirstName : État fédéral de l'adresse de livraison La localité indiquée sous AddrCity doit être située dans un état fédéré sans quoi PayPal refuse ce paiement. Consulter la documentation de référence PayPal API pour les valeurs possibles. |
AddrZip | ans..20 | C | Obligatoire en cas de transmission de FirstName : code postal de l'adresse de livraison |
AddrCountryCode | an2 | C | Obligatoire en cas de transmission de FirstName : code de pays de livraison |
Phone | n..20 | C | Obligatoire en cas de transmission de FirstName : Numéro de téléphone |
Le tableau ci-dessous présente les paramètres de réponse de la plateforme de paiement :
Paramètre | Format | CND | Description |
---|---|---|---|
MID | ans..30 | M | ID du commerçant, attribué par AXEPTA |
PayID | an32 | M | ID attribuée au paiement par la plateforme de paiement, par ex. pour le référencement des fichiers batch. |
XID | an32 | M | ID attribuée par La plateforme de paiement pour toutes les différentes transactions (commande, vente, autorisation, capture, remboursement) pour un paiement. |
TransID | ans..64 | M | Numéro de transaction du commerçant |
Status | a..30 | M | OK ou FAILED |
Description | ans..1024 | M | Détails supplémentaires en cas d'échec du paiement. Veuillez ne pas utiliser le paramètre Description mais bien le paramètre Code pour une analyse de l'état de la transaction ! |
Code | n8 | M | Code d'erreur conformément au fichier Excel des codes de réponse de la plateforme de paiement |
MAC | an64 | M | Code d'authentification de message haché (HMAC) avec algorithme SHA-256 |
RefNr | an12 | M | Numéro de référence unique du commerçant |
CodeExt | n..10 | O | Code d'erreur de PayPal, si convenu avec le Support |
Appel de l'interface pour une autorisation séparée
Pour un paiement PayPal, ORDER peut être séparé de l'autorisation subséquente et des étapes suivantes. Une autorisation séparée n'est possible qu'après clôture de la commande (TxType=Order).
Appelez l'URL ci-dessous pour une autorisation séparée avec PayPal :
Le tableau ci-dessous présente les paramètres de demande de paiement chiffrés :
Paramètre | Format | CND | Description |
---|---|---|---|
MerchantID | ans..30 | M | ID du commerçant, attribué par AXEPTA. Ce paramètre doit également être transféré non chiffré. |
PayID | an32 | M | ID attribuée par la plateforme de paiement pour le paiement. |
TransID | ans..64 | M | ID de la transaction qui doit être unique pour chaque paiement |
TxType | ans..5 | M | Type de transaction Auth |
Amount | n..10 | M | Montant indiqué dans la plus petite unité de la devise (par ex. les centimes pour l'euro) Veuillez contacter notre service d'assistance si vous souhaitez capturer des montants < 100 (plus petite unité de la devise). |
Currency | a3 | M | Code pour la devise, trois caractères DIN / ISO 4217 |
FirstName | as..30 | O | soit uniquement le nom, soit le nom et le prénom si le nom d'une société est utilisé comme adresse de livraison. |
LastName | as..30 | O | nom ou nom de la société de l'adresse de livraison |
AddrStreet | ans..100 | O | rue de l'adresse de livraison |
AddrStreet2 | ans..100 | O | 2. Nom de rue de l'adresse de livraison, si convenu avec AXEPTA |
AddrCity | ans..40 | O | localité de l'adresse de livraison |
AddrState | ans..40 | O | État fédéral de l'adresse de livraison La localité indiquée sous AddrCity doit être située dans un état fédéré sans quoi PayPal refuse ce paiement. Consulter la documentation de référence PayPal API pour les valeurs possibles. |
AddrZip | ans..20 | O | code postal de l'adresse de livraison |
AddrCountryCode | an2 | O | code de pays de livraison |
Phone | n..20 | O | Numéro de téléphone |
Le tableau ci-dessous présente les paramètres de réponse de la plateforme de paiement :
Paramètre | Format | CND | Description |
---|---|---|---|
MID | ans..30 | M | ID du commerçant, attribué par AXEPTA |
PayID | an32 | M | ID attribuée au paiement par la plateforme de paiement, par ex. pour le référencement des fichiers batch. |
XID | an32 | M | ID attribuée par La plateforme de paiement pour toutes les différentes transactions (commande, vente, autorisation, capture, remoursement pour un paiement. |
TransID | ans..64 | M | Numéro de transaction du commerçant |
Status | a..30 | M | OK ou FAILED |
Description | ans..1024 | M | Détails supplémentaires en cas d'échec du paiement. Veuillez ne pas utiliser le paramètre Description mais bien le paramètre Code pour une analyse de le statut de la transaction ! |
Code | n8 | M | Code d'erreur conformément au fichier Excel des codes de réponse de la plateforme de paiement |
CodeExt | n..10 | O | Code d'erreur de PayPal, si convenu avec le Support |
Appel de l'interface pour une capture
Pour exécuter une capture pour PayPal via une connexion de serveur à serveur, veuillez utiliser l'URL suivante :
Remarque : Pour des raisons de sécurité, la plateforme de paiement rejette toutes les demandes de paiement contenant des erreurs de format. Veuillez par conséquent utiliser le type de données correct pour chaque paramètre.
Le tableau ci-dessous présente les paramètres de demande de paiement chiffrés :
Paramètre | Format | CND | Description |
---|---|---|---|
MerchantID | ans..30 | M | ID du commerçant, attribué par AXEPTA. Ce paramètre doit également être transféré non chiffré. |
PayID | an32 | M | ID attribuée par la plateforme de paiement pour le paiement à capturé |
TransID | ans..64 | M | ID de la transaction qui doit être unique pour chaque paiement |
MAC | an64 | M | Code d'authentification de message haché (HMAC) avec algorithme SHA-256 |
Amount | n..10 | M | Montant indiqué dans la plus petite unité de la devise (par ex. les centimes pour l'euro) Veuillez contacter notre service d'assistance si vous souhaitez capturer des montants < 100 (plus petite unité de la devise). |
Currency | a..3 | M | Code pour la devise, trois caractères DIN / ISO 4217 |
RefNr | an12 | M | Numéro de référence du commerçant : il est possible de transmettre ici un numéro de référence séparé, par ex. un numéro de facture |
ReqID | ans..32 | O | Pour éviter les paiements en double, saisissez une valeur alphanumérique qui identifie votre transaction et ne peut être attribuée qu’une seule fois. Si la transaction est à nouveau soumise avec le paramètre ReqID identique, la plateforme de paiement n’exécute pas le paiement et se contente de retourner le statut de la transaction d’origine. Attention : Plateforme de paiement doit afficher un statut de transaction finalisée pour la première action initiale. Les introductions avec un ReqID identique pour un statut ouvert sont traitées à intervalles réguliers. |
TID | ans..17 | O | Numéro de transaction PayPal unique. Requis pour des captures partielles relatives à des autorisations précédentes. |
CompleteType | ans..3 | O | Si <YES> est transféré, la commande éventuellement ouverte est clôturée par PayPal à la capture. (motif : une capture à 115% est possible côté PayPal. Si une capture atteint 100%, la plateforme de paiement envoie automatiquement une requêter pour fermer le paiement) |
Le tableau ci-dessous présente les paramètres de réponse de la plateforme de paiement :
Paramètre | Format | CND | Description | |
---|---|---|---|---|
MID | ans..30 | M | ID du commerçant, attribué par AXEPTA | |
PayID | an32 | M | ID attribuée au paiement par la plateforme de paiement, par ex. pour le référencement des fichiers batch. | |
XID | an32 | M | ID attribuée par La plateforme de paiement pour toutes les différentes transactions (commande, vente, autorisation, capture, remboursement) pour un paiement. | |
TransID | ans..64 | M | Numéro de transaction du commerçant | |
Status | a..30 | M | OK ou FAILED | |
Description | ans..1024 | M | Détails supplémentaires en cas d'échec du paiement. Veuillez ne pas utiliser le paramètre Description mais bien le paramètre Code pour une analyse de l'état de la transaction ! | |
Code | n8 | M | Code d'erreur conformément au fichier Excel des codes de réponse de la plateforme de paiement | |
TID | ans..17 | O | Numéro de transaction PayPal unique. Requis pour des captures partielles relatives à des autorisations précédentes. | |
CodeExt | n..10 | O | Code d'erreur de PayPal, si convenu avec le Support |
Appel de l'interface pour un remboursement avec référence
Pour exécuter un remboursement avec une transaction de référence pour PayPal, veuillez utiliser l'adresse URL suivante :
Remarque : Pour des raisons de sécurité, la plateforme de paiement rejette toutes les demandes de paiement contenant des erreurs de format. Veuillez par conséquent utiliser le type de données correct pour chaque paramètre.
Le tableau ci-dessous présente les paramètres de demande de paiement chiffrés :
Paramètre | Format | CND | Description |
---|---|---|---|
MerchantID | ans..30 | M | ID du commerçant, attribué par AXEPTA. Ce paramètre doit également être transféré non chiffré. |
PayID | an32 | M | ID attribuée par la plateforme de paiement pour le paiement à créditer |
TransID | ans..64 | M | ID de la transaction qui doit être unique pour chaque paiement |
MAC | an64 | M | Code d'authentification de message haché (HMAC) avec algorithme SHA-256 |
Amount | n..10 | M | Montant indiqué dans la plus petite unité de la devise (par ex. les centimes pour l'euro) Veuillez contacter notre service d'assistance si vous souhaitez capturer des montants < 100 (plus petite unité de la devise). |
Currency | a..3 | M | Code pour la devise, trois caractères DIN / ISO 4217 |
RefNr | an12 | M | Numéro de référence du commerçant : il est possible de transmettre ici un numéro de référence séparé, par ex. un numéro de facture |
ReqID | ans..32 | O | Pour éviter les paiements en double, saisissez une valeur alphanumérique qui identifie votre transaction et ne peut être attribuée qu’une seule fois. Si la transaction est à nouveau soumise avec le paramètre ReqID identique, la plateforme de paiement n’exécute pas le paiement et se contente de retourner le statut de la transaction d’origine. Attention : Plateforme de paiement doit afficher un statut de transaction finalisée pour la première action initiale. Les introductions avec un ReqID identique pour un statut ouvert sont traitées à intervalles réguliers. |
Account | ans..128 | O | Compte commerçant pour la gestion de plusieurs comptes PayPal : ID ou adresse e-mail pour lesquelles la demande doit être adressée à PayPal |
TID | ans..17 | O | Numéro de transaction PayPal univoque. Requis pour remboursements partiels pour des captures partielles précédentes. |
Note | ans..768 | C | Texte d'explication à l'attention du destinataire |
Subject | ans..255 | C | MassPay : objet d'e-mail pour le destinataire |
Le tableau ci-dessous présente les paramètres de réponse de la plateforme de paiement :
Paramètre | Format | CND | Description |
---|---|---|---|
MID | ans..30 | M | ID du commerçant, attribué par AXEPTA. |
PayID | an32 | M | ID attribuée au paiement par la plateforme de paiement, par ex. pour le référencement des fichiers batch. |
XID | an32 | M | ID attribuée par La plateforme de paiement pour toutes les différentes transactions (commande, vente, autorisation, capture, remboursement) pour un paiement. |
TransID | ans..64 | M | Numéro de transaction du commerçant |
Status | a..30 | M | OK ou FAILED |
Description | ans..1024 | M | Détails supplémentaires en cas d'échec du paiement. Veuillez ne pas utiliser le paramètre Description mais bien le paramètre Code pour une analyse du statut de la transaction ! |
Code | n8 | M | Code d'erreur conformément au fichier Excel des codes de réponse de la plateforme de paiement |
TID | ans..17 | O | Numéro de transaction univoque PayPal. Requis pour remboursement partiels pour des captures partielles précédentes. |
CodeExt | n..10 | O | Code d'erreur de PayPal, si convenu avec le Support |
FeeRefundAmount | n..10 | O | Montant remboursé pour les frais de transaction PayPal. Requis pour les remboursements partiels pour des captures partielles précédentes. |
GrossRefundAmount | n..10 | O | Montant brut remboursé à l'acheteur. Requis pour remboursement partiels pour des captures partielles précédentes. |
NetRefundAmount | n..10 | O | Montant déduit de votre compte PayPal pour effectuer ce remboursement. Requis pour remboursement partiels pour des captures partielles précédentes. |
Appel de l'interface pour un remboursement sans référence
Appelez l'URL et les paramètres ci-dessous pour initier un remboursement sans transaction de référence pour un paiement PayPal au sein du formulaire La plateforme de paiement :
Le tableau ci-dessous présente les paramètres de demande de paiement chiffrés :
Paramètre | Format | CND | Description |
---|---|---|---|
MerchantID | ans..30 | M | ID du commerçant, attribué par AXEPTA. Ce paramètre doit également être transféré non chiffré. |
TransID | ans..64 | M | ID de la transaction qui doit être unique pour chaque paiement |
RefNr | an12 | M | Numéro de référence unique du commerçant |
Amount | n..10 | M | Montant indiqué dans la plus petite unité de la devise (par ex. les centimes pour l'euro) Veuillez contacter notre service d'assistance si vous souhaitez capturer des montants < 100 (plus petite unité de la devise). |
Currency | a..3 | M | Code pour la devise, trois caractères DIN / ISO 4217 |
PayerID | ans..13 | O | numéro d'identification unique du compte client chez PayPal |
Note | ans..768 | C | MassPay : Texte d'explication à l'attention du destinataire |
Subject | ans..255 | C | MassPay : objet d'e-mail pour le destinataire |
Payer | ans..100 | O | MassPay : Adresse e-mail du client. |
Le tableau ci-dessous présente les paramètres de réponse de la plateforme de paiement :
Paramètre | Format | CND | Description |
---|---|---|---|
MID | ans..30 | M | ID du commerçant, attribué par AXEPTA |
PayID | an32 | M | ID attribuée au paiement par la plateforme de paiement, par ex. pour le référencement des fichiers batch. |
XID | an32 | M | ID attribuée par La plateforme de paiement pour toutes les différentes transactions (commande, vente, autorisation, capture, remboursement) pour un paiement. |
TransID | ans..64 | M | Numéro de transaction du commerçant |
Status | a..30 | M | OK ou FAILED |
Description | ans..1024 | M | Détails supplémentaires en cas d'échec du paiement. Veuillez ne pas utiliser le paramètre Description mais bien le paramètre Code pour une analyse de l'état de la transaction ! |
Code | n8 | M | Code d'erreur conformément au fichier Excel des codes de réponse de la plateforme de paiement |
CodeExt | n..10 | O | Code d'erreur de PayPal, si convenu avec le Support |
FeeRefundAmount | n..10 | O | Montant remboursé pour les frais de transaction PayPal. Requis pour notes de crédit partielles pour des captures partielles précédentes. |
GrossRefundAmount | n..10 | O | Montant remboursé au client pour cette transaction de remboursement. Requis pour notes de crédit partielles pour des captures partielles précédentes. |
NetRefundAmount | n..10 | O | Montant déduit de votre compte PayPal pour effectuer ce remboursement. Requis pour notes de crédit partielles pour des captures partielles précédentes. |
Appel de l'interface la plateforme de paiement pour les annulations
Appelez l'URL ci-dessous pour annuler une transaction avec PayPal :
Le tableau ci-dessous présente les paramètres de demande de paiement chiffrés :
Paramètre | Format | CND | Description |
---|---|---|---|
MerchantID | ans..30 | M | ID du commerçant, attribué par AXEPTA. Ce paramètre doit également être transféré non chiffré. |
PayID | an32 | M | ID la plateforme de paiement pour l'identification d'un paiement |
TransID | ans..64 | M | ID de la transaction qui doit être unique pour chaque paiement |
Amount | n..10 | M | Montant indiqué dans la plus petite unité de la devise (par ex. les centimes pour l'euro) Veuillez contacter notre service d'assistance si vous souhaitez capturer des montants < 100 (plus petite unité de la devise). |
Currency | a..3 | M | Code pour la devise, trois caractères DIN / ISO 4217 |
MAC | an64 | M | Code d'authentification de message haché (HMAC) avec algorithme SHA-256 |
ReqID | ans..32 | O | Pour éviter les paiements en double, saisissez une valeur alphanumérique qui identifie votre transaction et ne peut être attribuée qu’une seule fois. Si la transaction est à nouveau soumise avec le paramètre ReqID identique, la plateforme de paiement n’exécute pas le paiement et se contente de retourner le statut de la transaction d’origine. Attention : Plateforme de paiement doit afficher un statut de transaction finalisée pour la première action initiale. Les introductions avec un ReqID identique pour un statut ouvert sont traitées à intervalles réguliers. |
TID | ans..17 | O | Numéro de transaction PayPal univoque. Requis pour des annulations partielles relatives à des autorisations partielles précédentes. |
Le tableau ci-dessous présente les paramètres de réponse de la plateforme de paiement :
Paramètre | Format | CND | Description |
---|---|---|---|
MID | ans..30 | M | ID du commerçant, attribué par AXEPTA |
PayID | an32 | M | ID attribuée au paiement par la plateforme de paiement, par ex. pour le référencement des fichiers batch. |
XID | an32 | M | ID attribuée par La plateforme de paiement pour toutes les différentes transactions (commande, vente, autorisation, capture, remboursement) pour un paiement. |
TransID | ans..64 | M | Numéro de transaction du commerçant |
Status | a..30 | M | OK ou FAILED |
Description | ans..1024 | M | Détails supplémentaires en cas d'échec du paiement. Veuillez ne pas utiliser le paramètre Description mais bien le paramètre Code pour une analyse de l'état de la transaction ! |
Code | n8 | M | Code d'erreur conformément au fichier Excel des codes de réponse de la plateforme de paiement |
TID | ans..17 | O | Numéro de transaction PayPal univoque. Requis pour des annulations partielles relatives à des autorisations partielles précédentes. |
CodeExt | n..10 | O | Code d'erreur de PayPal, si convenu avec le Support |
Appel de l'interface la plateforme de paiement pour les abonnements
Le traitement des paiements PayPal par abonnement suppose qu'une première transaction ait été effectuée via l'interface normale. En outre, la possibilité de recourir à des abonnements doit avoir été préalablement activée auprès de PayPal et de BNP. Pour cela, l'option « Reference transaction » doit être configurée chez BNP et chez PayPal. De plus, les 3 options pour le niveau d'accès API doivent être cochées de la section « Autorisations disponibles » lors de la configuration (voir section Paramétrage de l'autorisation API ci-dessus) :
- Imputation de comptes existants sur base de transactions précédentes
- Configuration et gestion des paiements par abonnement
- Demande d'autorisation et initialisation des paiements PayPal via encaissement du commerçant
Utilisez l'URL et les paramètres ci-dessous pour initier un paiement d'abonnement PayPal au sein du formulaire la plateforme de paiement :
Le tableau ci-dessous présente les paramètres de demande de paiement chiffrés :
Paramètre | Format | CND | Description |
---|---|---|---|
MerchantID | ans..30 | M | ID du commerçant, attribué par AXEPTA. Ce paramètre doit également être transféré non chiffré. |
TransID | ans..64 | M | ID de la transaction qui doit être unique pour chaque paiement |
RefNr | an12 | M | Numéro de référence unique du commerçant qui doit être unique pour chaque paiement |
Amount | n..10 | M | Montant indiqué dans la plus petite unité de la devise (par ex. les centimes pour l'euro) Veuillez contacter notre service d'assistance si vous souhaitez capturer des montants < 100 (plus petite unité de la devise). |
Currency | a..3 | M | Code pour la devise, trois caractères DIN / ISO 4217 |
OrderDesc | ans..30 | Description des produits achetées, des prix unitaires etc. | |
Capture | a..6 | M | Auto ou Manual : détermine si le montant demandé doit être débité immédiatement ou plus tard. Remarque importante : veuillez contacter le Support pour l'option Manual afin de discuter des différentes utilisations possibles. |
TxType | ans..5 | M | Obligatoire pour Capture=Manual : Type de transaction avec les valeurs possibles Order et Auth |
BillingAgreementID | an19 | M | Numéro d'identification du règlement des factures. Dès que le client confirme ce règlement des factures, ce dernier entre en vigueur et reste valide jusqu'à sa révocation par le client. |
RTF | ans1 | O | Pour paiements réguliers (abonnements) :
|
FirstName | as..30 | OC | (obligatoire pour les USA et le Canada) : soit uniquement le nom, soit le nom et le prénom si le nom d'une société est utilisé comme adresse de livraison. |
LastName | as..30 | OC | (obligatoire pour les USA et le Canada) : nom ou nom de la société de l'adresse de livraison |
AddrStreet | ans..100 | OC | (obligatoire pour les USA et le Canada) : rue de l'adresse de livraison |
AddrCity | ans..40 | OC | (obligatoire pour les USA et le Canada) : localité de l'adresse de livraison |
AddrState | ans..40 | OC | (obligatoire pour les USA et le Canada) : État fédéral de l'adresse de livraison La localité indiquée sous AddrCity doit être située dans un état fédéré sans quoi PayPal refuse ce paiement. Consulter la documentation de référence PayPal API pour les valeurs possibles. |
AddrZip | ans..20 | OC | (obligatoire pour les USA et le Canada) : code postal de l'adresse de livraison |
AddrCountryCode | an2 | O | code de pays de livraison |
Phone | n..20 | O | Numéro de téléphone |
Le tableau ci-dessous présente les paramètres de réponse de la plateforme de paiement :
Paramètre | Format | CND | Description |
---|---|---|---|
MID | ans..30 | M | ID du commerçant, attribué par AXEPTA |
PayID | an32 | M | ID attribuée au paiement par la plateforme de paiement, par ex. pour le référencement des fichiers batch. |
XID | an32 | M | ID attribuée par La plateforme de paiement pour toutes les différentes transactions (commande, vente, autorisation, capture, remboursements) pour un paiement. |
TransID | ans..64 | M | Numéro de transaction du commerçant |
Status | a..30 | M | OK ou FAILED |
Description | ans..1024 | M | Détails supplémentaires en cas d'échec du paiement. Veuillez ne pas utiliser le paramètre Description mais bien le paramètre Code pour une analyse du statut de la transaction ! |
Code | n8 | M | Code d'erreur conformément au fichier Excel des codes de réponse de la plateforme de paiement |
BillingAgreementID | an19 | M | Numéro d'identification du règlement des factures. Dès que le client confirme ce règlement des factures, ce dernier entre en vigueur et reste valide jusqu'à sa révocation par le client. |
CodeExt | n..10 | O | Code d'erreur de PayPal, si convenu avec le Support |
Traitement Batch via l'interface
Pour de plus amples informations sur l'utilisation des fichiers Batch et sur leur structure, voir le manuel Batch Manager.
Cette section décrit les paramètres qui doivent être transmis au sein de l'enregistrement (Record) pour l'exécution d'un paiement PayPal, ainsi que les informations pouvant être contenues dans le fichier de réponse sur le statut du paiement.
Pour les appels Batch, il convient de distinguer les versions batch utilisées qui définissent les paramètres optionnels. Toutes les désignations de version commençant par « 2. » se rapportent aux appels pour un groupe d'entreprises. Ceci signifie qu'au sein d'un fichier batch avec un MerchantID spécifique, il est également possible de transférer des transactions d'autres commerçants avec sous-MID séparé.
Le tableau ci-dessous donne une vue d'ensemble de toutes les versions batch possibles pour une action spécifique et de leurs particularités :
Action | Version | Description |
---|---|---|
Authorize | 1.0 / 2.0 | Version standard sans retour de paramètre Code |
| 1.4 / 2.4 | avec TID |
Capture | 1.0 / 2.0 | Version standard sans retour de paramètre Code |
| 1.x / 2.x | Avec RefNr (valide pour toutes les versions autres que 1.0) |
| 1.4 / 2.4 | avec TID |
Remboursements | 1.0 / 2.0 | Version standard sans retour de paramètre Code |
| 1.x / 2.x | Avec RefNr (valide pour toutes les versions autres que 1.0) |
| 1.4 / 2.4 | avec TID |
CreditEx | 1.0 / 2.0 | Version standard sans retour de paramètre Code |
| 1.x / 2.x | Avec RefNr (valide pour toutes les versions autres que 1.0) |
Reverse | 1.0 / 2.0 | Version standard sans retour de paramètre Code |
| 1.4 / 2.4 | avec TID |
Abo | 1.0 / 2.0 | Version standard sans retour de paramètre Code |
| 1.x / 2.x | Avec RefNr (valide pour toutes les versions autres que 1.0) |
La structure devant être introduite pour un paiement PayPal au sein d'un fichier Batch est comme suit :
HEAD,<MerchantID>,<Date>,<Version> PAYPAL,Authorize,<Amount>,<Currency>,<TransID>,<PayID> PAYPAL,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>(,<TID>) PAYPAL,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>(,<TID>) PAYPAL,CreditEx,<TransID>,(<RefNr>,)<Amount>,<Currency>,<payer>,<note> PAYPAL,Reverse,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>(,<TID>) PAYPAL,ABO,<Amount>,<Currency>,<TransID>,(<RefNr>),(<OrderDesc>),(<Capture>),(<TxType>,)<BillingAgreementId> |
Exemple de Master MID Funktion:
HEAD,[Master]MerchantID,Date,2.x Type,Action,[Slave]MID,Amount,Currency,TransID,Data (depends on Action) FOOT,CountRecords,SumAmount |
Remarque : avec la version 1.4, il est également possible de transférer le CompleteType avec une action Capture :
PAYPAL,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>(,<CompleteType>,<TID>)
Le tableau ci-dessous présente les différents champs et valeurs utilisés dans l'enregistrement (record) au sein du fichier batch :
Paramètre | Format | CND | Description |
---|---|---|---|
Type | a..11 | M | HEAD pour l'en-tête, FOOT pour le pied de page, PAYPAL pour PayPal |
Action | a..20 | M | Le paramètre Action définit le type de transaction : Authorize Reverse (annulation) |
Amount | n..10 | M | Montant indiqué dans la plus petite unité de la devise (par ex. les centimes pour l'euro) Veuillez contacter notre service d'assistance si vous souhaitez capturer des montants < 100 (plus petite unité de la devise). |
Currency | a3 | M | Code pour la devise, trois caractères DIN / ISO 4217 |
TransID | ans..64 | M | ID de la transaction qui doit être unique pour chaque paiement |
RefNr | an12 | M | Numéro de référence unique |
payer | ans..100 | O | MassPay : Adresse e-mail du client. Dans ce cas, vous transférez le paramètre d'email reçu à partir de la Réponse |
note | ans..758 | O | Texte d'explication à l'attention du destinataire |
PayID | an32 | M | ID pour cette transaction attribuée par la plateforme de paiement |
TID | ans..17 | O | Numéro de transaction univoque PayPal. Requis pour plusieurs autorisations ou captures partielles, des remboursements partiels ou des annulations partielles. |
OrderDesc | ans..127 | O | Description des produits achetés, des prix unitaires etc. |
Capture | a..6 | O | Auto ou Manual : détermine si le montant demandé doit être débité immédiatement ou plus tard. |
TxType | ans..5 | OC | Obligatoire pour Capture=Manual : Type de transaction avec les valeurs possibles Order et Auth |
BillingAgreementID | an19 | M | Numéro d'identification du règlement des factures. Dès que le client confirme ce règlement des factures, ce dernier entre en vigueur et reste valide jusqu'à sa révocation par le client. |
La zone Record dans le fichier de réponse pour les transactions Batch se présente comme suit :
HEAD,<MerchantID>,<Date>,<Version> PAYPAL,Authorize,<Amount>,<Currency>,<TransID>,<PayID>,<Status>,<Code>,<CodeExt> PAYPAL,Capture,<Betrag>,<Währung>,<TransID>,(<RefNr>,)<PayID>,(TID,)<Status>,<Code>,<CodeExt> PAYPAL,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,(TID,)<Status>,<Code>,<CodeExt> PAYPAL,CreditEx,<TransID>,(<RefNr>,)<Amount>,<Currency>,<payer>,<note>,<Status>,<Code>,<CodeExt> PAYPAL,Reverse,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code>,<CodeExt> PAYPAL,ABO,<Amount>,<Currency>,<TransID>,(<RefNr>),(<OrderDesc>),(<Capture>),(<TxType>,)<BillingAgreementId>,<CodeExt>,<PayID>,<Status>,<Code> FOOT,<CountRecords>,<SumAmount> |
Le tableau ci-dessous décrit les paramètres de réponse que le Batch Manager sauvegarde dans la zone Record pour chaque transaction (les paramètres par défaut non détaillés ici tels que <TransID> ou <RefNR>, ainsi que les paramètres de demande sont renvoyés inchangés et correspondent à l'appel tel que spécifié) :
Paramètre | Format | CND | Description |
---|---|---|---|
Action | a..20 | M | Le paramètre Action définit le type de transaction comme pour Capture ou Remboursement. |
PayID | an32 | M | ID pour cette transaction attribuée par la plateforme de paiement |
Status | a..50 | M | OK ou FAILED |
Code | n8 | M | Code d'erreur conformément au fichier Excel des codes de réponse de la plateforme de paiement |
CodeExt | n..10 | O | Code d'erreur de PayPal |
REPORTING : Intégration des données PayPal dans le fichier de réconciliation Axepta (Settlement file)
Pour que nous puissions récupérer les fichiers de règlement de PayPal, nous avons besoin des données de votre compte SFTP PayPal.
Pour cela vous devez :
- Contacter votre « Account Manager » PayPal (si vous en avez un) ou le support client standard de PayPal, pour qu’ils activent cette fonction SFTP dans votre compte client PayPal et que vous puissiez y accéder directement.
- Vous devrez ensuite, depuis votre compte PayPal, créer un compte SFTP sécurisé dans la section « information sur le compte - Creating a secure FTP server user ».
- Après avoir créé le serveur SFTP avec succès, veuillez nous envoyer les données d'accès SFTP : nom d'utilisateur et mot de passe.
Veuillez trouver la documentation PayPal pour vous aider : https://developer.paypal.com/docs/reports/sftp-reports/settlement-report/#know-before-you-begin
A noter :
- Nous ne demanderons jamais le mot de passe de votre compte PayPal (ces données sont strictement confidentielles), nous avons besoin uniquement des accès à votre compte SFTP de PayPal.
- Ne pas confondre l’activation du moyen de paiement PayPal dans Axepta (activation réalisée lors de votre inscription avec la solution Axepta) et l’intégration des fichiers de reporting PayPal dans Axepta (procédure décrite ci-dessus).