Actions55
- Webhooks Actions
- Payments Actions
- Products Actions
- Plans Actions
- Partner Referrals Actions
- Reporting Actions
- Orders Actions
- Subscriptions Actions
- Invoicing Actions
- Disputes Actions
Partner Referrals → Create Partner Referral
AI-generatedOverview
The Create Partner Referral operation in the "Partner Referrals" resource of this node allows users to create a partner referral through PayPal's API. This is useful for businesses or partners who want to register referrals with PayPal, typically as part of a partner or affiliate program.
Common scenarios where this node is beneficial include:
- Automating the onboarding process of new partners by creating referrals programmatically.
- Integrating PayPal partner referral creation into larger workflows such as CRM or marketing automation.
- Managing partner relationships and tracking referrals without manual intervention.
Example use case: A company running a partner program can automatically create partner referrals when a new partner signs up on their platform, ensuring seamless integration with PayPal’s partner system.
Properties
| Name | Meaning |
|---|---|
| Request Body | JSON object containing the details of the partner referral to be created. |
| Additional Options | Collection of optional parameters: - Environment: Choose between "Sandbox" or "Live" PayPal environment. - Page Size: Number of items per page for list operations (not relevant here). - Start Time: Start date filter (ISO 8601 format, not relevant here). - End Time: End date filter (ISO 8601 format, not relevant here). |
Output
The output JSON contains the following fields:
resource: The resource used, here always"partnerReferrals".operation: The operation performed, here"createPartnerReferral".success: Boolean indicating if the operation was successful.- All fields returned by the PayPal API response for the created partner referral, which typically includes referral details such as referral ID, status, and partner information.
creditsUsed: Number of API credits consumed by the request (usually 1).creditsRemaining: Remaining API credits after the request.timestamp: ISO timestamp of when the operation was executed.
If the operation fails and "Continue On Fail" is enabled, the output will contain an error message and success will be false.
No binary data output is produced by this operation.
Dependencies
- Requires valid credentials for:
- An API key credential for the external "N8N Tools API" service that validates operations.
- A PayPal OAuth2 API credential providing an access token and environment configuration.
- The node makes HTTP requests to both the N8N Tools API and PayPal API endpoints.
- Proper configuration of these credentials in n8n is necessary for the node to function.
Troubleshooting
- Invalid JSON in Request Body: If the JSON provided in the "Request Body" property is malformed, the node throws an error indicating invalid JSON. Ensure the JSON syntax is correct.
- API Validation Failure: If the external validation API rejects the resource-operation combination or credentials, the node will throw a validation failure error. Verify API keys and permissions.
- Unknown Operation or Resource: Errors occur if unsupported operations or resources are specified. Confirm that "Partner Referrals" resource and "Create Partner Referral" operation are selected.
- Authorization Errors: If the PayPal OAuth2 token is invalid or expired, the API call will fail. Refresh or reconfigure the PayPal credentials.
- Network or API Errors: General HTTP errors from PayPal or the validation API will cause the node to fail unless "Continue On Fail" is enabled.