canonical: https://jentic.com/apis/paypal.com/partner-referrals # Paypal 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 available to approved partners only. Fill out this form to get approved and a PayPal representative will reach out to you shortly.
For more . The API exposes 2 endpoints secured with oauth2 authentication. ## For AI agents Programmatically create partner referral, show referral data. Covers 2 operations with oauth2 authentication. ## Scope Does not handle communications, crm, or developer tools - use for payments only. ## Capabilities - Create partner referral - Show referral data - Access Partner Referrals resources via REST API ## Use cases ### Payments Operations Use the Partner Referrals to perform payments operations programmatically. The API provides 2 endpoints covering core functionality including create partner referral, show referral data. Example prompt: Call POST /v2/customer/partner-referrals to create partner referral ### Data Retrieval and Monitoring Query Partner Referrals endpoints to retrieve structured data for monitoring, reporting, or downstream processing. The API returns JSON responses that agents can parse directly, enabling automated data collection workflows without manual intervention. Example prompt: Query the Partner Referrals API to retrieve current data and verify the response contains expected fields ### AI Agent Integration via Jentic AI agents discover and call Partner Referrals endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle oauth2 tokens manually. Example prompt: Search Jentic for 'create partner referral', load the operation schema, and execute with Jentic-managed credentials ## Key endpoints | Method | Path | Description | | --- | --- | --- | | POST | /v2/customer/partner-referrals | Create partner referral | | GET | /v2/customer/partner-referrals/{partner_referral_id} | Show referral data | ## Key resources - **partner-referrals** — Enables you to create and get information about shared customer data. ## Why Jentic - **Setup:** Wiring PayPal Partner Referrals by hand means running its OAuth 2.0 flow, refreshing Bearer tokens, and choosing the right sandbox or live host before you can create or read a referral. Through Jentic you install once, import Partner Referrals from the API Directory, store the client credentials once, and your agent calls it. - **Permission scoping:** Partner Referrals puts the referral id in the URL path (/v2/customer/partner-referrals/{partner_referral_id}), so a rule can pin your agent to reading one referral. You choose the operations it may call, so creating new partner referrals is not included unless you add it. - **Credential handling:** Your PayPal OAuth client id and secret are stored once, encrypted, by your own Jentic One instance and injected at execution time, with token refresh handled for you. They never enter the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'create a partner referral' or 'read a referral status', and Jentic returns the matching Partner Referrals operation with its input schema so the agent calls the right endpoint without browsing the reference docs. ## Related APIs - **Stripe** — Alternative payments API - **Adyen** — Alternative payments API - **Square** — Complementary payments API ## FAQ ### What authentication does the Partner Referrals use? The Partner Referrals uses OAuth 2.0 for authorization. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context. ### Can I create partner referral with the Partner Referrals? Yes. Use the POST /v2/customer/partner-referrals endpoint. The API returns structured JSON responses that agents can parse and act on directly. ### What are the rate limits for the Partner Referrals? Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer. ### How do I create partner referral through Jentic? Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'create partner referral'. Jentic returns the matching Partner Referrals operation with its input schema. Load the schema and execute the call - credentials are injected automatically. ### How many endpoints does the Partner Referrals have? The Partner Referrals exposes 2 endpoints covering partner-referrals operations. ### Can I limit what my agent is allowed to do with the Partner Referrals API? Yes. Because you run Jentic One yourself, your own rules decide which Partner Referrals operations the agent may call and which credentials it may use. This API has just two operations, creating a referral via POST /v2/customer/partner-referrals and reading one via GET /v2/customer/partner-referrals/{partner_referral_id}, so you can allow only the read operation and keep the agent from creating new referrals. Since the referral id sits in the URL path, a rule can also pin the agent to a single referral.