Access to Accounts
Last updated: Sept 23rd, 5:28pm
Overview
This page provides technical documentation for PayPal's XS2A (Access to Accounts) offerings for Third-Party Providers or TPPs under the PSD2 regulation. Where available, documentation will be referred to detailed specifications online at PayPal's Developer Documentation pages.
PayPal will improve and develop this page on an ongoing basis, based on feedback provided by TPPs and further development of PayPal’s product. We will send new versions of this page to all TPPs that have been onboarded with PayPal.
This page is not intended for a general audience – some content of this Document may be confidential and may have been provided based on the specific legal status of TPPs. Refer to PayPal if you plan to share or publish any contained information.
Version History
| Version | Release Date | Changes |
|---|---|---|
| 3.0 | March 2024 | Updated Section 4 – Account information. Added Sections from 4.4 – 4.9, 5.3 and 5.4 |
| 2.0 | January 2024 | Updated the Connect URL to append the name-value parameter as response_type=code.Updated the user authentication access from 90-days to 180-days |
| 1.2.3 | February 2021 | Updated to new api-m host names. Enabled section numbers. |
| 1.2.2 | September 2020 | Removed sentence about pending availability of PayPal’s XS2A interface in Production environment. |
| 1.2.1 | August 2020 | Added information how to reset a user’s 180-day authorization expiration period. |
| 1.2.0 | June 2020 | Added information about retrieving the user’s account type. Added sample response for User Information API. |
| 1.1.0 | (unreleased) May 2020 | Added information about retrieving the user’s name. Added Token Introspection API documentation. Added section how to receive revocation notifications. Updated authentication flow URL and documentation links. Updated online documentation references for Checkout APIs. Typos fixed. |
| 1.0.1 | 5 June 2019 | Added missing client_id parameter to specification of authentication flow URL. |
| 1.0 | 14 March 2019 | Initial Release |
TPP Onboarding
Go to PayPal’s TPP Sandbox registration flow to onboard for testing PayPal’s XS2A offerings.
PayPal REST APIs
PayPal’s XS2A offerings are part of PayPal’s proven and powerful REST API stack, using a RESTful endpoint structure and HTTP methods to structure available operations. The API authorization framework is OAuth 2.0. Requests are to be formatted in JSON, responses will be JSON-formatted as well. See PayPal's Getting Started documentation section to learn how to access and work with PayPal's REST APIs in general.
Live and Testing Environments
PayPal’s REST APIs are available in two environments: use the Sandbox environment for testing purposes and then move to the Live environment for production processing.
The Sandbox environment is a mirror of the PayPal Live system’s functionality. Any part of the PayPal integration can be tested in this environment without real funds being moved.
Note that separate API credentials will be needed for making calls against the PayPal Sandbox versus the Live environment. When testing in the Sandbox environment, use your Sandbox API credentials to make calls to the Sandbox URIs. When you’re set to go live, use the Live API credentials assigned to you.
The API Endpoints
The endpoints for PayPal’s REST API environments are:
-
Sandbox (for testing): https://api-m.sandbox.paypal.com
-
Live (production): https://api-m.paypal.com
PayPal’s web applications are also available in both environments:
-
Sandbox (for testing): https://www.sandbox.paypal.com
-
Live (production): https://www.paypal.com
TPP API Credentials
PayPal will provide TPPs with API credentials specifically configured to access XS2A functionalities. Only PayPal REST APIs referenced on this page will be available through TPP credentials. PayPal’s public developer documentation pages may refer to functionalities that are only available to PayPal merchants and partners. If you are interested in accessing and offering additional PayPal functionalities, reach out to PayPal for a full partnership.
PayPal will improve and develop this page on an ongoing basis, based on feedback provided by TPPs and further development of PayPal’s product. New versions of the page will be sent to all TPPs who have been onboarded with PayPal.
This page is not intended for a general audience – some content of this Document may be confidential and may have been provided based on the specific legal status of TPPs. Refer to PayPal if you plan to share or publish any contained information.
For detailed information, refer to the PDF.
Contact Us
Contact PayPal’s Developer Support by email at dl-pp-tpp@paypal.com with any questions, suggestions, or other issues related to specific TPP and XS2A functionalities: we are happy to receive all of your feedback.