PartnerReferrals
Shows details by ID for referral data that was shared by the partner or API caller.
Table Specific Information
Select
Note: PartnerReferrals API does not give us a way to list all PartnerReferralId-s, so you must specify it.
The only filter supported by the PayPal API is Id, which is required.
The component processes other filters client side within the component.
For example, the following queries are processed server side and retrieve details for a specific Partner Referral.
SELECT * FROM PartnerReferrals where id= 'ZjcyODU4ZWYtYTA1OC00ODIwLTk2M2EtOTZkZWQ4NmQwYzI3RU12cE5xa0xMRmk1NWxFSVJIT1JlTFdSbElCbFU1Q3lhdGhESzVQcU9iRT0='
Columns
| Name | Type | References | Description |
| Id [KEY] | String | The ID to access the customer's 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 | List of owners in the account. | |
| BusinessNames | String | Name of the business. | |
| BusinessEmails | String | Email addresses of the business. | |
| BusinessWebsite | String | Website of the business. | |
| BusinessAddresses | String | List of addresses associated with the business entity. | |
| BusinessPhones | String | List of phone number associated with the business. | |
| BusinessDocuments | String | Business Party related Document data collected from the customer. | |
| BusinessType | String | Type of business entity like corporation, sole prop, governmental. | |
| BusinessSubtype | String | The sub classification 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 | Date of business incorporation. | |
| BusinessOfficeBearers | String | List of Directors present as part of the business entity. | |
| BusinessPurposeCode | String | The account's purpose code. | |
| BusinessDescription | String | The business goals description. For example, a mission statement. | |
| IndividualBeneficialOwners | String | List of Individual beneficial owners part of the entity. | |
| BusinessBeneficialOwners | String | List of Business beneficial owners 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 partner's unique identifier for this customer in their system which can be used to track user 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 | 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 | If true, specifies that the merchant or platform is offering goods or services on behalf of 3rd party sellers. | |
| PayoutAttributesKycRequired | Boolean | If true, specifies that the Kyc is required for the merchant. | |
| PayoutAttributesCountryTransferMethodCurrency | String | Requested country, transfer method and currency. | |
| LegalCountryCode | String | Legal Country Code. |