PartnerReferrals
Returns referral data shared by the partner or API caller, including business entity, financial instrument, and payout attribute details.
View-Specific Information
SELECT
Note: The PartnerReferrals API does not provide a way to list all PartnerReferralIds, so you must specify one. The only filter supported by the PayPal API is Id, which is required. The driver processes all other filters client-side.
For example, the driver processes the following queries server-side to retrieve details for a specific partner referral.
SELECT * FROM PartnerReferrals WHERE Id = 'ZjcyODU4ZWYtYTA1OC00ODIwLTk2M2EtOTZkZWQ4NmQwYzI3RU12cE5xa0xMRmk1NWxFSVJIT1JlTFdSbElCbFU1Q3lhdGhESzVQcU9iRT0='
Columns
| Name | Type | References | Description |
| Id [KEY] | String | The Id used to access the referral data shared by the partner with PayPal. | |
| SubmitterPayerId | String | The payer Id of the partner who shared the referral data. | |
| SubmitterClientId | String | The client Id of the partner who shared the referral data. | |
| IndividualOwners | String | The list of individual owners in the account. | |
| BusinessNames | String | The names associated with the business. | |
| BusinessEmails | String | The email addresses of the business. | |
| BusinessWebsite | String | The website of the business. | |
| BusinessAddresses | String | The list of addresses associated with the business entity. | |
| BusinessPhones | String | The list of phone numbers associated with the business. | |
| BusinessDocuments | String | The document data related to the business party collected from the customer. | |
| BusinessType | String | The type of business entity, such as corporation, sole proprietorship, or governmental. | |
| BusinessSubtype | String | The subclassification of the business type. | |
| BusinessIndustryCategory | String | The customer's business category code. | |
| BusinessIndustryMccCode | String | The customer's business seller category code. | |
| BusinessIndustrySubcategory | String | The customer's business subcategory code. | |
| BusinessIncorporationCountryCode | String | The incorporation country code. | |
| BusinessIncorporationDate | Date | The date of business incorporation. | |
| BusinessOfficeBearers | String | The list of directors that are part of the business entity. | |
| BusinessPurposeCode | String | The purpose code for the business account. | |
| BusinessDescription | String | The business goals description. For example, a mission statement. | |
| IndividualBeneficialOwners | String | The list of individual beneficial owners that are part of the entity. | |
| BusinessBeneficialOwners | String | The list of business beneficial owners that are part of the entity. | |
| AnnualSalesVolumeRangeMinAmountCurrencyCode | String | The minimum inclusive amount currency code of the range for the total annual sales volume of the business. | |
| AnnualSalesVolumeRangeMinAmountValue | Decimal | The minimum inclusive amount value of the range for the total annual sales volume of the business. | |
| AnnualSalesVolumeRangeMaxAmountCurrencyCode | String | The maximum inclusive amount currency code of the range for the total annual sales volume of the business. | |
| AnnualSalesVolumeRangeMaxAmountValue | Decimal | The maximum inclusive amount value of the range for the total annual sales volume of the business. | |
| AvgMonthlyVolumeRangeMinAmountCurrencyCode | String | The minimum inclusive amount currency code of the range for the average monthly volume of the business. | |
| AvgMonthlyVolumeRangeMinAmountValue | Decimal | The minimum inclusive amount value of the range for the average monthly volume of the business. | |
| AvgMonthlyVolumeRangeMaxAmountCurrencyCode | String | The maximum inclusive amount currency code of the range for the average monthly volume of the business. | |
| AvgMonthlyVolumeRangeMaxAmountValue | Decimal | The maximum inclusive amount value of the range for the average monthly volume of the business. | |
| TrackingId | String | The unique identifier assigned by the partner to track the customer in PayPal. | |
| Operations | String | An array of operations to perform for the customer while they share their data. | |
| Products | String | An array of PayPal products to which the partner wants to onboard the customer. | |
| Capabilities | String | An array of capabilities which the partner wants to enable for the selected products. | |
| OutsideProcessDependencies | String | An array of dependent processes. | |
| LegalConsents | String | An array of all consents that the partner has received from this seller. | |
| String | The email address of the customer used to create the account. | ||
| PreferredLanguageCode | String | The preferred locale code to use in the onboarding flow for the customer. | |
| PartnerConfigReturnUrl | String | The URL to which to redirect the customer upon completion of the onboarding process. | |
| PartnerConfigReturnUrlDescription | String | The description of the return URL. | |
| PartnerConfigShowAddCreditCard | Boolean | Indicates whether to show an add credit card page. | |
| FinancialInstrumentBanks | String | An array of banks attached to this managed account. | |
| PayoutAttributesMarketplace | Boolean | Indicates whether the merchant or platform offers goods or services on behalf of third-party sellers. | |
| PayoutAttributesKycRequired | Boolean | Indicates whether Know Your Customer (KYC) verification is required for the merchant. | |
| PayoutAttributesCountryTransferMethodCurrency | String | The requested country, transfer method, and currency selection. | |
| LegalCountryCode | String | The legal country code. |