Last updated: September 11th 2023, @ 2:37:17 pm
We've made changes to this page and its layout to improve the developer experienceLet us know what you think of the updated documentation by selecting the feedback tab below.
Create an onboarding and payments solution for your marketplace or payments platform. Follow these steps for integrating PayPal Commerce Platform from onboarding your platform to going live.
1. Onboard your platform
Fill out this form to tell us about your platform and business, including what services and products your platform provides. We use this information to determine the most suitable integration for you. A PayPal representative will evaluate your business needs and contact you about your approval.
2. Configure your sandbox and live accounts
Log in to your sandbox API caller account to create a Platform REST app and get your API credentials. Then, set up your live account. For instructions, see Configure your sandbox account, live account, and API credentials.
3. Choose your payment solution
Determine how you want to accept payments and select a solution that works best for your use case. Things to consider include:
- How you want to onboard your sellers
- What payment methods you want your sellers to use
- How to manage disputes and refunds
- How to generate reports
4. Build and test your integration
Explore what you can do with the platform solution in the sandbox. Test the seller onboarding integration, display specific payment methods, and configure the backend management. For demos of our integrations, see PayPal Demo and the Interactive Buttons Demo.
Your sellers complete onboarding so they can accept PayPal payments on your platform.
There are 3 ways to onboard sellers:
- Onboard sellers before payment
- Onboard sellers after payment
- Build onboarding into software
We recommend onboarding your sellers before payment because it allows you to integrate both standard and advanced packaged solutions. It has few limitations and is the most common way to onboard your sellers.
For more information, see Onboard sellers overview.
There are two packaged solutions for checkout: standard and advanced.
The standard packaged solution includes PayPal checkout to your platform.
The advanced packaged solutions include everything in the standard packaged solution and customizable credit and debit card fields.
Manage back-end operations, dispute, and reporting
You can include the following in your back-end management:
- Issue a refund.
- Include your BN transaction code tracking in your API call headers.
- Configure Webhook notifications for all events, such as onboarding, transactions, and more.
- Sellers will handle their disputes through the PayPal Account Resolution Center. For more information, see Understanding disputes.
- Create an SFTP User account to access your reports. Use the Transaction Search API for custom reporting. For set-up instructions, see Generate reports.
5. Complete the integration checklist
Review and complete the integration checklist. The checklist provides best practice recommendations.
6. Go live
Make sure you have filled out this form to be an approved partner. Contact your PayPal representative to go live after you’ve tested your integration. Share the email addresses and client IDs for your sandbox and live accounts with your PayPal representative. When you have completed the integration checklist, a PayPal representative can copy your sandbox configuration to your live account.