Paypal Customer Partner Referrals V2
PayPal Customer Partner Referrals is a PayPal API that lets platform partners refer and onboard sellers or customers to PayPal services.
- Base URL:
https://api-m.sandbox.paypal.com - Auth: OAuth 2.0 client-credentials — the tool fetches a token from
/v1/oauth2/tokenusing yourclientId/clientSecret, then calls the API.
Operations
partner_referrals_read— GET /v2/customer/partner-referrals/{partner_referral_id} — Show referral datapartner_referrals_create— POST /v2/customer/partner-referrals — Create partner referral
Inputs
clientId/clientSecret— your paypal-customer-partner-referrals-v2 OAuth app credentialsscope— OAuth scopes (optional; defaults from the spec)operation— one of the operations above- path parameters when an operation's path contains
{...} query— optional JSON object of query paramsbody— JSON object for create/update ops
Example
operation: partner_referrals_read
clientId: <your client id>
clientSecret: <your client secret>
Publishes
The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.
erroroperationresultstatus
Input Properties
Every property this tool accepts, from its own tool.iml.
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
clientId |
string | yes | — | OAuth client ID for paypal-customer-partner-referrals-v2. |
clientSecret |
string | yes | — | OAuth client secret for paypal-customer-partner-referrals-v2. |
operation |
string | yes | — | One of: partner_referrals_read, partner_referrals_create |
scope |
string | no | https://uri.paypal.com/services/customer/partner https://uri.paypal.com/services/customer/partner-referrals/readwrite https://uri.paypal.com/services/customer/partner-referrals |
OAuth scopes (space-separated); default from the spec. |
partner_referral_id |
string | no | — | Path parameter partner_referral_id (required by some operations). |
body |
string | no | — | Request body as a JSON object string (for create/update operations). |
query |
string | no | — | Query-string parameters as a JSON object string, e.g. {"limit": 50}. Parsed and url-encoded onto the request. |