Partner Referrals
Use the Partner Referrals API to add PayPal seller accounts to PayPal Complete Payments Platform for Marketplaces and Platforms. Important: This endpoint is…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Use the Partner Referrals API to add PayPal seller accounts to PayPal Complete Payments Platform for Marketplaces and Platforms. Important: This endpoint is available to approved partners only. Fill out this form to get approved and a PayPal representative will reach out to you shortly. For more information about partner integrations and onboarding sellers, see PayPal Complete Payments Platform for Marketplaces and Platforms.
Endpoints 2
partner-referrals
- POSTCreate partner referral
/v2/customer/partner-referralsCreates a partner referral that is shared by the partner or API caller. The partner referral is used to onboard the seller, and contains the seller's… - GETShow referral data
/v2/customer/partner-referrals/:partner_referral_idShows details by ID for referral data that was shared by the partner or API caller.
API details
- Base URL
https://api-m.sandbox.paypal.comhttps://api-m.paypal.com- Authentication
- OAuth 2.0 (client credentials flow) with 3 scopes
- Operations
- 2 operations on 2 pathsGET 1POST 1
- Main resources
- partner-referrals 2
- Response formats
application/json- Description format
- OpenAPI 3.0.3, API version
2.5 - Links
- Documentation · OpenAPI document
- Listed from
- PayPal's published OpenAPI description (paypal/paypal-rest-api-specifications) (Apache-2.0)
How to test the Partner Referrals in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Partner Referrals collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (client credentials flow) with 3 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Create partner referral” (POST /v2/customer/partner-referrals), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Partner Referrals?
Use the Partner Referrals API to add PayPal seller accounts to PayPal Complete Payments Platform for Marketplaces and Platforms. Important: This endpoint is… It is listed under Payments and has 2 endpoints.
Who publishes the Partner Referrals?
It is listed from PayPal's public API description (an OpenAPI document), not published by PayPal on Swastik Codes. Anyone who controls paypal.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Partner Referrals?
Its description lists 2 base URLs: https://api-m.sandbox.paypal.com, https://api-m.paypal.com. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the Partner Referrals?
With OAuth 2.0 (client credentials flow) with 3 scopes.
How many endpoints does the Partner Referrals have?
2 operations on 2 paths (1 GET, 1 POST). The largest groups are partner-referrals.
Is forking the Partner Referrals free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.