Visualisation d'une page Webjax
Présentation et généralités sur l'API Paypal
Cette page est propulsée par
Cette page vous présente l'API Paypal d'un point de vue global. L'API Paypal est un ensemble d'outils à utiliser pour inclure , sur vos sites webs e-commerce, sites communautaires acceptant les donations (par exemple), la possibilité d'effectuer des paiements rapides et sécurisés en ligne.
L'API permet diverses fonctionnalités dont celles de pouvoir enregistrer des paiements par carte de crédit via Paypal, de créer des procédures de paiements automatiques, dites "de masse", de créer des rotations de prélèvements pour la gestion d'abonnements par exemple.
Nous vous proposons donc sur Webjax.eu, une traduction francisée de la documentation de l'API Paypal, traduction qui a pour objectif de vous aider à prendre en main l'API et à la déployer avec le plus de précision et d'efficacité sur vos sites webs.
00 :: Présentation de l'API
L'API Paypal rend plus performante les fonctionnalités Paypal disponible en exposant certaines de ces fonctionnalités à des développeurs externes à Paypal. Afin de pouvoir utiliser Paypal, vous devez disposer d'un compte de type « Premier » ou « Business ». Vous devez aussi disposer des identifiants regroupés au sein d'une entité nommée « API Credentials » qui permettent d'authentifier vos appels à l'API Paypal. L'API Paypal vous permet d'envoyer de l'argent, de procéder aux remboursements de transactions, d'effectuer des recherches dans votre historique de transactions et plus encore.
01 :: Opérations permises par l'API
Vous pouvez réaliser l'ensemble des opérations suivantes à l'aide de l'API Paypal :
Groupe
API's
Description
Recherche de transactions
et
Détails de transactions
-
TransactionSearch
-
GetTransactionDetails
Permet de retrouver le détails de transactions présentes dans un historique de transactions Paypal.
Procéder à des remboursements
-
RefundTransaction
Permet d'effectuer un remboursement pour une transaction payée par Paypal.
Paiements de masse
-
MassPay
Permet de payer simultanément un ou plusieurs destinataires.
Paiements directs
-
DoDirectPayment
Permet de procéder à la validation d'un paiement par Carte Bancaire.
Autorisations et Captures
-
DoAuthorization
-
DoReauthorization
-
DoCapture
-
DoVoid
Commande Express
-
SelfExpressCheckout
-
GetExpressCheckoutDetails
-
DoExpressCheckoutPayment
Permet d'autoriser vos utilisateurs/clients à utiliser des informations de facturation et de livraison sauvegardées de façon sécurisée dans Paypal. Cela permet d'accéder la procédure de « Checkout ».
Paiements récurrents
-
SetCustomerBillingAgreement
-
GetBillingAgreementCustomerDetails
-
CreateRecurringPaymentsProfile
Permet d'autoriser la facturation de clients pour des montants fixés à des dates fixées.
Liens de ce niveau de titre :
https://www.paypal.com/IntegrationCenter/ic_transaction-search-and-details.html
https://www.paypal.com/IntegrationCenter/ic_refund-transaction.html
https://www.paypal.com/IntegrationCenter/ic_masspay.html
https://www.paypal.com/IntegrationCenter/ic_direct-payment.html
https://www.paypal.com/IntegrationCenter/ic_authcapture.html
https://www.paypal.com/IntegrationCenter/ic_expresscheckout.html
https://www.paypal.com/IntegrationCenter/ic_recurringpayments.html
02 :: Utilisation de l'API
Une fois que vous avez obtenu le groupe d'identifiants nommé « API Credentials », vous êtes prêts à effectuer des appels à l'API Paypal. Il existe deux interfaces permettant de communiquer avec l'API Paypal. Vous pouvez utiliser celle qui convient le mieux à votre style de développement ainsi qu'à votre environnement :
-
Name-Value Pair (NVP) : Les requêtes comme les réponses sont formatées dans un format HTTP simple. Cette interface rassemblera les développeurs recherchant un format léger et des développements « scripts-based ».
-
SOAP Interface : Les requêtes comme les réponses sont transmises via SOAP. Cette interface conviendra mieux aux développeurs en environnement orienté objet.
Liens de ce niveau de titre :
https://www.paypal.com/IntegrationCenter/ic_certificate.html
https://www.paypal.com/IntegrationCenter/ic_nvp.html
https://www.paypal.com/IntegrationCenter/ic_sdk-resource.html
03 :: Codes d'erreur de l'API
Vous pouvez consulter la liste des codes d'erreurs que peut renvoyer l'API Paypal en consultant l'url ci après : https://www.paypal.com/IntegrationCenter/ic_api-errors.html
04 :: Points d'accès / end-points de l'API
Les poins d'accès à l'API, soient les urls de base que vous devez utiliser pour construire vos appels HTTP/SOAP, dépendent du système d'authentification que vous utiliser ainsi que du mécanisme d'authentification que vous utiliser. Le tableau ci après formalise ces différentes urls « points d'accès » :
Environnement
Authentification
Calling
Endpoint
Live
API Certificate
Name-Value Pair
https://api.paypal.com/nvp
Live
API Signature
Name-Value Pair
https://api-3t.paypal.com/nvp
Live
API Certificate
SOAP
https://api.paypal.com/2.0/
Live
API Signature
SOAP
https://api-3t.paypal.com/2.0/
Sandbox
API Certificate
Name-Value Pair
https://api.sandbox.paypal.com/nvp
Sandbox
API Signature
Name-Value Pair
https://api-3t.sandbox.paypal.com/nvp
Sandbox
API Certificate
SOAP
https://api.sandbox.paypal.com/2.0/
Sandbox
API Signature
SOAP
https://api-3t.sandbox.paypal.com/2.0/
04 :: #05 :: Historique/Changelog de l'API
Le fichier WSDL Paypal identifie les différentes changements effectués sur l'API Paypal depuis sa version 2.4 :
Version
Changements, nouveautés, suppressions
Version 2.4
Les fonctionnalités suivantes ont été ajouté pour « mobile checkout API's » :
SetMobileCheckout
DoMobileCheckout
Les messages suivants ont été ajoutés pour « mobile checkout API's » :
SetMobileCheckoutRequest
SetMobileCheckoutResponse
DoMobileCheckoutPaymentRequest
DoMobileCheckoutPaymentResponse
Version 3.0
Changement du type de donnée de l'élément « RefundType » dans le message « RefundTransactionRequest ».
Changement de la signature pour « BAUpdate API »
Ajout de « DoReferenceTransaction API »
Ajout des confirmations de facturation via API :
SetCustomerBillingAgreement
GetBillingAgreementCustomerDetails
CreateBillingAgreement
Ajout des messages de confirmation de facturation dans les API :
SetCustomerBillingAgreementRequest
SetCustomerBillingAgreementResponse
GetBillingAgreementCustomerDetailsRequest
GetBillingAgreementCustomerDetailsResponse
Ajout des API UATP (airlines) :
DoUATPExpressCheckoutPayment
DoUATPAuthorization
Ajour des messages dans les API UATP :
DoUATPExpressCheckoutPaymentRequest
DoUATPExpressCheckoutPaymentResponse
DoUATPAuthorizationRequest
DoUATPAuthorizationResponse
Version 3.1
Changement du type de données de l'élément « CreditCard » dans le message « DoReferenceTransactionRequest ».
Ajout de l'API « mobile checkout » :
GetBalance
Ajout des messages suivants pour l'API « mobile checkout » :
GetBalanceRequest
GetBalanceResponse
Ajout de l'API de paiements récurrents (prélèvements automatiques)
CreateRecurringPaymentsProfile
Ajout des messages suivants dans l'API de paiements récurrents :
CreateRecurringPaymentsProfileRequest
CreateRecurringPaymentsProfileResponse
Version 3.2
Ajout de l'élément « ReqBillingAddress » dans le message « GetExpressCheckoutDetailsRequest »
Ajout de l'élément « BillingAddress » dans le message « GetExpressCheckoutDetails Response »
Ajout de l'élément « ReqBillingAddress » dans le message « GetBillingAgreementCustomerDetailsRequest »
Ajout de l'élément « BillingAddress » dans le message « GetBillingAgreementCustomerDetailsResponse »
Ajout de l'élément « ShippingMethod » pour le type de données « PaymentInfoType »
Changement des types de données « Amount », « ShippingAmount », « TaxAmount » dans « BillingPeriodDetailsType ».
Suppression du « MessageID » dans « AbstractRequestType ».
Version 3.2 (release 48)
Ajout du « SoftDescriptor » dans « DoReferenceTransactionRequest ».
Cette page vous présente l'API Paypal d'un point de vue global. L'API Paypal est un ensemble d'outils à utiliser pour inclure , sur vos sites webs e-commerce, sites communautaires acceptant les donations (par exemple), la possibilité d'effectuer des paiements rapides et sécurisés en ligne.
L'API permet diverses fonctionnalités dont celles de pouvoir enregistrer des paiements par carte de crédit via Paypal, de créer des procédures de paiements automatiques, dites "de masse", de créer des rotations de prélèvements pour la gestion d'abonnements par exemple.
Nous vous proposons donc sur Webjax.eu, une traduction francisée de la documentation de l'API Paypal, traduction qui a pour objectif de vous aider à prendre en main l'API et à la déployer avec le plus de précision et d'efficacité sur vos sites webs.
00 :: Présentation de l'API
L'API Paypal rend plus performante les fonctionnalités Paypal disponible en exposant certaines de ces fonctionnalités à des développeurs externes à Paypal. Afin de pouvoir utiliser Paypal, vous devez disposer d'un compte de type « Premier » ou « Business ». Vous devez aussi disposer des identifiants regroupés au sein d'une entité nommée « API Credentials » qui permettent d'authentifier vos appels à l'API Paypal. L'API Paypal vous permet d'envoyer de l'argent, de procéder aux remboursements de transactions, d'effectuer des recherches dans votre historique de transactions et plus encore.
01 :: Opérations permises par l'API
Vous pouvez réaliser l'ensemble des opérations suivantes à l'aide de l'API Paypal :
|
Groupe |
API's |
Description |
|---|---|---|
|
Recherche de transactions et Détails de transactions |
|
Permet de retrouver le détails de transactions présentes dans un historique de transactions Paypal. |
|
Procéder à des remboursements |
|
Permet d'effectuer un remboursement pour une transaction payée par Paypal. |
|
Paiements de masse |
|
Permet de payer simultanément un ou plusieurs destinataires. |
|
Paiements directs |
|
Permet de procéder à la validation d'un paiement par Carte Bancaire. |
|
Autorisations et Captures |
|
|
|
Commande Express |
|
Permet d'autoriser vos utilisateurs/clients à utiliser des informations de facturation et de livraison sauvegardées de façon sécurisée dans Paypal. Cela permet d'accéder la procédure de « Checkout ». |
|
Paiements récurrents |
|
Permet d'autoriser la facturation de clients pour des montants fixés à des dates fixées. |
Liens de ce niveau de titre :
https://www.paypal.com/IntegrationCenter/ic_transaction-search-and-details.html
https://www.paypal.com/IntegrationCenter/ic_refund-transaction.html
https://www.paypal.com/IntegrationCenter/ic_masspay.html
https://www.paypal.com/IntegrationCenter/ic_direct-payment.html
https://www.paypal.com/IntegrationCenter/ic_authcapture.html
https://www.paypal.com/IntegrationCenter/ic_expresscheckout.html
https://www.paypal.com/IntegrationCenter/ic_recurringpayments.html
02 :: Utilisation de l'API
Une fois que vous avez obtenu le groupe d'identifiants nommé « API Credentials », vous êtes prêts à effectuer des appels à l'API Paypal. Il existe deux interfaces permettant de communiquer avec l'API Paypal. Vous pouvez utiliser celle qui convient le mieux à votre style de développement ainsi qu'à votre environnement :
-
Name-Value Pair (NVP) : Les requêtes comme les réponses sont formatées dans un format HTTP simple. Cette interface rassemblera les développeurs recherchant un format léger et des développements « scripts-based ».
-
SOAP Interface : Les requêtes comme les réponses sont transmises via SOAP. Cette interface conviendra mieux aux développeurs en environnement orienté objet.
Liens de ce niveau de titre :
https://www.paypal.com/IntegrationCenter/ic_certificate.html
https://www.paypal.com/IntegrationCenter/ic_nvp.html
https://www.paypal.com/IntegrationCenter/ic_sdk-resource.html
03 :: Codes d'erreur de l'API
Vous pouvez consulter la liste des codes d'erreurs que peut renvoyer l'API Paypal en consultant l'url ci après : https://www.paypal.com/IntegrationCenter/ic_api-errors.html
04 :: Points d'accès / end-points de l'API
Les poins d'accès à l'API, soient les urls de base que vous devez utiliser pour construire vos appels HTTP/SOAP, dépendent du système d'authentification que vous utiliser ainsi que du mécanisme d'authentification que vous utiliser. Le tableau ci après formalise ces différentes urls « points d'accès » :
|
Environnement |
Authentification |
Calling |
Endpoint |
|---|---|---|---|
|
Live |
API Certificate |
Name-Value Pair |
https://api.paypal.com/nvp |
|
Live |
API Signature |
Name-Value Pair |
https://api-3t.paypal.com/nvp |
|
Live |
API Certificate |
SOAP |
https://api.paypal.com/2.0/ |
|
Live |
API Signature |
SOAP |
https://api-3t.paypal.com/2.0/ |
|
Sandbox |
API Certificate |
Name-Value Pair |
https://api.sandbox.paypal.com/nvp |
|
Sandbox |
API Signature |
Name-Value Pair |
https://api-3t.sandbox.paypal.com/nvp |
|
Sandbox |
API Certificate |
SOAP |
https://api.sandbox.paypal.com/2.0/ |
|
Sandbox |
API Signature |
SOAP |
https://api-3t.sandbox.paypal.com/2.0/ |
04 :: #05 :: Historique/Changelog de l'API
Le fichier WSDL Paypal identifie les différentes changements effectués sur l'API Paypal depuis sa version 2.4 :
|
Version |
Changements, nouveautés, suppressions |
|---|---|
|
Version 2.4 |
Les fonctionnalités suivantes ont été ajouté pour « mobile checkout API's » : SetMobileCheckout Les messages suivants ont été ajoutés pour « mobile checkout API's » : SetMobileCheckoutRequest |
|
Version 3.0 |
Changement du type de donnée de l'élément « RefundType » dans le message « RefundTransactionRequest ».
Changement de la signature pour « BAUpdate API »
Ajout de « DoReferenceTransaction API »
Ajout des confirmations de facturation via API : SetCustomerBillingAgreement
Ajout des messages de confirmation de facturation dans les API : SetCustomerBillingAgreementRequest
Ajout des API UATP (airlines) : DoUATPExpressCheckoutPayment
Ajour des messages dans les API UATP : DoUATPExpressCheckoutPaymentRequest
|
|
Version 3.1 |
Changement du type de données de l'élément « CreditCard » dans le message « DoReferenceTransactionRequest ».
Ajout de l'API « mobile checkout » : GetBalance
Ajout des messages suivants pour l'API « mobile checkout » : GetBalanceRequest
Ajout de l'API de paiements récurrents (prélèvements automatiques) CreateRecurringPaymentsProfile
Ajout des messages suivants dans l'API de paiements récurrents : CreateRecurringPaymentsProfileRequest
|
|
Version 3.2 |
Ajout de l'élément « ReqBillingAddress » dans le message « GetExpressCheckoutDetailsRequest »
Ajout de l'élément « BillingAddress » dans le message « GetExpressCheckoutDetails Response »
Ajout de l'élément « ReqBillingAddress » dans le message « GetBillingAgreementCustomerDetailsRequest »
Ajout de l'élément « BillingAddress » dans le message « GetBillingAgreementCustomerDetailsResponse »
Ajout de l'élément « ShippingMethod » pour le type de données « PaymentInfoType »
Changement des types de données « Amount », « ShippingAmount », « TaxAmount » dans « BillingPeriodDetailsType ».
Suppression du « MessageID » dans « AbstractRequestType ».
|
|
Version 3.2 (release 48) |
Ajout du « SoftDescriptor » dans « DoReferenceTransactionRequest ». |

:

