On this page
No Headings
The referral data that partners share with PayPal.
objectcustomer_dataobjectThe customer's business and personal data that is required to create an account.
customer_typestring"CONSUMER", "MERCHANT"The type of PayPal account to create, which is consumer or seller.
person_detailsobjectThe customer's personal details.
email_addressstringppaas_common_email_address_v2^.+@[^"\-].+$The primary email address of the account.
nameobjectThe legal name of the customer.
prefixstringThe prefix, or title, to the party's name.
given_namestringWhen the party is a person, the party's given, or first, name.
surnamestringWhen the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. Use also to store multiple surnames including the matronymic, or mother's, surname.
middle_namestringWhen the party is a person, the party's middle name. Use also to store multiple middle names including the patronymic, or father's, middle name.
suffixstringThe suffix for the party's name.
alternate_full_namestringDEPRECATED. The party's alternate name. Can be a business name, nickname, or any other name that cannot be split into first, last name. Required when the party is a business.
full_namestringWhen the party is a person, the party's full name.
phone_contactsarrayAn array of contact phone numbers for the customer.
itemsobjectThe phone number and the phone type.
phone_number_detailsrequiredobjectThe phone number details.
country_coderequiredstring^[0-9]{1,3}?$The country calling code (CC), in its canonical international E.164 numbering plan format. The combined length of the CC and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).
national_numberrequiredstring^[0-9]{1,14}?$The national number, in its canonical international E.164 numbering plan format. The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).
extension_numberstring^[0-9]{1,15}?$The extension number.
phone_typerequiredstring"FAX", "HOME", "MOBILE", "OTHER", "PAGER"The phone type.
home_addressobjectThe home address of the account holder.
line1requiredstringThe first line of the address. For example, number or street.
line2stringThe second line of the address. For example, suite or apartment number.
cityrequiredstringThe city name.
statestringcountry_coderequiredstringppaas_common_country_code_v2^([A-Z]{2}|C2)$The two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain isGBand notUKas used in the top-level domain names for that country. Use theC2country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
postal_codestringThe postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.
nationality_country_codestringppaas_common_country_code_v2^([A-Z]{2}|C2)$The two-character ISO-3166-1 country code for the nationality of the account holder. Can include one of the PayPal-supported countries.
identity_documentsarrayAn array of documents that uniquely identify the user, such as a license number, social security number, and so on.
itemsobjectThe authority-issued identification document. Document types include a driver's license, social security number, employee ID number, and so on.
typerequiredstring"SOCIAL_SECURITY_NUMBER", "EMPLOYMENT_IDENTIFICATION_NUMBER", "TAX_IDENTIFICATION_NUMBER", "PASSPORT_NUMBER", "PENSION_FUND_ID", "MEDICAL_INSURANCE_ID", "CNPJ", "CPF", "PAN", "NATIONAL_ID_CARD", "BUSINESS_REGISTRATION"The identifier type in the onboarding domain. Indicates the most specific type or the closest matching value. For example, SOCIAL_SECURITY_NUMBER in preference to TAX_IDENTIFICATION_NUMBER.
valuerequiredstring^[A-Za-z0-9]+$The identifier value, such as license number, social security number, and so on.
partial_valuerequiredbooleanfalseIndicates whether the value is a partial value. Specify this value when the identifier type supports a partial value, such as four SSN digits instead of the full nine values. Depending on the context, this parameter can be ignored.
issuer_country_coderequiredstring^[A-Z]([A-Z]|\d)$The two-character ISO-3166-1 country code for the country that issued the document.
account_owner_relationshipsarrayAn array of familial relationships that are attached to a seller.
itemsobjectThe familial relationship of the seller account owner.
namerequiredobjectThe name of the familial relation.
prefixstringThe prefix, or title, to the party's name.
given_namestringWhen the party is a person, the party's given, or first, name.
surnamestringWhen the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. Use also to store multiple surnames including the matronymic, or mother's, surname.
middle_namestringWhen the party is a person, the party's middle name. Use also to store multiple middle names including the patronymic, or father's, middle name.
suffixstringThe suffix for the party's name.
alternate_full_namestringDEPRECATED. The party's alternate name. Can be a business name, nickname, or any other name that cannot be split into first, last name. Required when the party is a business.
full_namestringWhen the party is a person, the party's full name.
relationrequiredstring"MOTHER"The type of familial relationship.
country_code_of_nationalityrequiredstringppaas_common_country_code_v2^([A-Z]{2}|C2)$The nationality of the familial relation.
business_detailsobjectThe customer's business details.
phone_contactsarrayAn array of phone contacts for the business.
itemsobjectThe phone number and the phone type.
phone_number_detailsrequiredobjectThe phone number details.
country_coderequiredstring^[0-9]{1,3}?$The country calling code (CC), in its canonical international E.164 numbering plan format. The combined length of the CC and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).
national_numberrequiredstring^[0-9]{1,14}?$The national number, in its canonical international E.164 numbering plan format. The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).
extension_numberstring^[0-9]{1,15}?$The extension number.
phone_typerequiredstring"FAX", "HOME", "MOBILE", "OTHER", "PAGER"The phone type.
business_addressobjectThe address of the business.
line1requiredstringThe first line of the address. For example, number or street.
line2stringThe second line of the address. For example, suite or apartment number.
cityrequiredstringThe city name.
statestringcountry_coderequiredstringppaas_common_country_code_v2^([A-Z]{2}|C2)$The two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain isGBand notUKas used in the top-level domain names for that country. Use theC2country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
postal_codestringThe postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.
business_typestringThe type of business.
itemsstring"INDIVIDUAL", "PROPRIETORSHIP", "PARTNERSHIP", "CORPORATION", "NONPROFIT", "GOVERNMENT", "GENERAL_PARTNERSHIP", "LIMITED_PARTNERSHIP", "LIMITED_LIABILITY_PARTNERSHIP", "PRIVATE_CORPORATION", "PUBLIC_CORPORATION", "PROPRIETORSHIP_CRAFTSMAN", "PUBLIC_PARTNERSHIP", "LIMITED_LIABILITY_PROPRIETORS", "LIMITED_LIABILITY_PRIVATE_CORPORATION", "LIMITED_PARTNERSHIP_PRIVATE_CORPORATION", "PRIVATE_PARTNERSHIP", "PROPRIETARY_COMPANY", "PUBLIC_COMPANY", "ASSOCIATION", "REGISTERED_COOPERATIVE", "OTHER_CORPORATE_BODY", "ANY_OTHER_BUSINESS_ENTITY", "ONLY_BUY_OR_SEND_MONEY"The business type.
business_subtypestring"ASSO_TYPE_INCORPORATED", "ASSO_TYPE_NON_INCORPORATED", "GOVT_TYPE_ENTITY", "GOVT_TYPE_EMANATION", "GOVT_TYPE_ESTD_COMM", "GOVT_TYPE_ESTD_FC", "GOVT_TYPE_ESTD_ST_TR"^[0-9A-Z_]+$Sub classification of the business type.
categorystring^\d+$The customer's business category code. PayPal uses the industry standard seller category codes.
sub_categorystring^\d+$The customer's business subcategory code. PayPal uses the industry standard seller category codes.
merchant_category_codestring^\d+$The customer's business seller category code. PayPal uses the industry standard seller category codes.
purpose_codeThe account's purpose code.
itemsstring"P0104", "P0301", "P0801", "P0802", "P0803", "P0805", "P0806", "P0902", "P1004", "P1005", "P1006", "P1007", "P1008", "P1009"The purpose code. Required only for India. For more information, see the Reserve Bank Of India web site. Value is:
P0104. Cross border delivery of goods and services.P0301. Business related travel purchase.P0801. Hardware consulting.P0802. Software consulting.P0803. Data processing consulting.P0805. Freelance journalism.P0806. Other information services.P0902. Licensing revenues.P1004. Legal.P1005. Accounting and tax.P1006. Business and management consultancy.P1007. Advertising and market research.P1008. Research and development.P1009. Architectural services.namesarrayAn array of business names.
itemsobjectA name for the business. For example, the legal name or the stock-trading name.
typerequiredstring"LEGAL", "DOING_BUSINESS_AS", "STOCK_TRADING_NAME"The legal category of the business.
namerequiredstringThe business name.
business_descriptionstringThe business goals description. For example, a mission statement.
event_datesarrayAn array of event dates for the business.
itemsobjectThe date for an event type. Typically captured during onboarding.
event_typerequiredstring"BIRTH", "ESTABLISHED", "INCORPORATION", "OPERATION"The event type for an onboarding entity.
event_daterequiredstringdate-timeThe date portion of the date and time when the event occurred, in Internet date and time format. For accuracy, if you do not know the exact time zone, use the UTC time zone.
website_urlsarrayAn array of website URLs for the business.
itemsstringuriThe URL for the business website.
annual_sales_volume_rangeobjectThe range for the total annual sales volume of the business.
minimum_amountobjectThe minimum inclusive amount for the range.
valuerequiredstringThe amount, up to N digits after the decimal separator. For currencies that do not support decimals, see currency codes.
maximum_amountobjectThe maximum inclusive amount for the range.
valuerequiredstringThe amount, up to N digits after the decimal separator. For currencies that do not support decimals, see currency codes.
average_monthly_volume_rangeobjectThe range for the average monthly volume of the business.
minimum_amountobjectThe minimum inclusive amount for the range.
valuerequiredstringThe amount, up to N digits after the decimal separator. For currencies that do not support decimals, see currency codes.
maximum_amountobjectThe maximum inclusive amount for the range.
valuerequiredstringThe amount, up to N digits after the decimal separator. For currencies that do not support decimals, see currency codes.
identity_documentsarrayAn array of identity documents that uniquely identify the user. For example, a license number, social security number, and so on.
itemsobjectThe authority-issued identification document. Document types include a driver's license, social security number, employee ID number, and so on.
typerequiredstring"SOCIAL_SECURITY_NUMBER", "EMPLOYMENT_IDENTIFICATION_NUMBER", "TAX_IDENTIFICATION_NUMBER", "PASSPORT_NUMBER", "PENSION_FUND_ID", "MEDICAL_INSURANCE_ID", "CNPJ", "CPF", "PAN", "NATIONAL_ID_CARD", "BUSINESS_REGISTRATION"The identifier type in the onboarding domain. Indicates the most specific type or the closest matching value. For example, SOCIAL_SECURITY_NUMBER in preference to TAX_IDENTIFICATION_NUMBER.
valuerequiredstring^[A-Za-z0-9]+$The identifier value, such as license number, social security number, and so on.
partial_valuerequiredbooleanfalseIndicates whether the value is a partial value. Specify this value when the identifier type supports a partial value, such as four SSN digits instead of the full nine values. Depending on the context, this parameter can be ignored.
issuer_country_coderequiredstring^[A-Z]([A-Z]|\d)$The two-character ISO-3166-1 country code for the country that issued the document.
email_contactsarrayAn array of contact email addresses for the company.
itemsobjectThe email address. Includes the role of the email address.
email_addressrequiredstringppaas_common_email_address_v2^.+@[^"\-].+$The internationalized email address.
Note: Up to 64 characters are allowed before and 255 characters are allowed after the@sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted@sign exists.
rolerequiredstring"CUSTOMER_SERVICE"The role of the email address.
country_of_incorporationstringppaas_common_country_code_v2^([A-Z]{2}|C2)$The country code of the country where the business was incorporated.
beneficial_ownersobjectList of beneficial owners part of the entity. They can be either a Person or a business entity.
individual_beneficial_ownersarrayIndividual beneficial owners.
itemsobjectThe individual owner of the account.
nameobjectThe legal name of the customer.
prefixstringThe prefix, or title, to the party's name.
given_namestringWhen the party is a person, the party's given, or first, name.
surnamestringWhen the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. Use also to store multiple surnames including the matronymic, or mother's, surname.
middle_namestringWhen the party is a person, the party's middle name. Use also to store multiple middle names including the patronymic, or father's, middle name.
suffixstringThe suffix for the party's name.
alternate_full_namestringDEPRECATED. The party's alternate name. Can be a business name, nickname, or any other name that cannot be split into first, last name. Required when the party is a business.
full_namestringWhen the party is a person, the party's full name.
phone_contactsarrayAn array of contact phone numbers for the customer.
itemsobjectThe phone number and the phone type.
phone_number_detailsrequiredobjectThe phone number details.
country_coderequiredstring^[0-9]{1,3}?$The country calling code (CC), in its canonical international E.164 numbering plan format. The combined length of the CC and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).
national_numberrequiredstring^[0-9]{1,14}?$The national number, in its canonical international E.164 numbering plan format. The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).
extension_numberstring^[0-9]{1,15}?$The extension number.
phone_typerequiredstring"FAX", "HOME", "MOBILE", "OTHER", "PAGER"The phone type.
home_addressobjectThe home address of the account holder.
line1requiredstringThe first line of the address. For example, number or street.
line2stringThe second line of the address. For example, suite or apartment number.
cityrequiredstringThe city name.
statestringcountry_coderequiredstringppaas_common_country_code_v2^([A-Z]{2}|C2)$The two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain isGBand notUKas used in the top-level domain names for that country. Use theC2country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
postal_codestringThe postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.
nationality_country_codestringppaas_common_country_code_v2^([A-Z]{2}|C2)$The citizenship country code of the person
percentage_of_ownershipstringThe percentage of shares this person owns in the company.
business_beneficial_ownersarrayBusiness beneficial owners.
itemsobjectThe individual owner of the account.
namesarrayAn array of business names.
itemsobjectA name for the business. For example, the legal name or the stock-trading name.
typerequiredstring"LEGAL", "DOING_BUSINESS_AS", "STOCK_TRADING_NAME"The legal category of the business.
namerequiredstringThe business name.
phone_contactsarrayAn array of phone contacts for the business.
itemsobjectThe phone number and the phone type.
phone_number_detailsrequiredobjectThe phone number details.
country_coderequiredstring^[0-9]{1,3}?$The country calling code (CC), in its canonical international E.164 numbering plan format. The combined length of the CC and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).
national_numberrequiredstring^[0-9]{1,14}?$The national number, in its canonical international E.164 numbering plan format. The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).
extension_numberstring^[0-9]{1,15}?$The extension number.
phone_typerequiredstring"FAX", "HOME", "MOBILE", "OTHER", "PAGER"The phone type.
business_addressobjectThe address of the business.
line1requiredstringThe first line of the address. For example, number or street.
line2stringThe second line of the address. For example, suite or apartment number.
cityrequiredstringThe city name.
statestringcountry_coderequiredstringppaas_common_country_code_v2^([A-Z]{2}|C2)$The two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain isGBand notUKas used in the top-level domain names for that country. Use theC2country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
postal_codestringThe postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.
business_typestringThe type of business.
itemsstring"INDIVIDUAL", "PROPRIETORSHIP", "PARTNERSHIP", "CORPORATION", "NONPROFIT", "GOVERNMENT", "GENERAL_PARTNERSHIP", "LIMITED_PARTNERSHIP", "LIMITED_LIABILITY_PARTNERSHIP", "PRIVATE_CORPORATION", "PUBLIC_CORPORATION", "PROPRIETORSHIP_CRAFTSMAN", "PUBLIC_PARTNERSHIP", "LIMITED_LIABILITY_PROPRIETORS", "LIMITED_LIABILITY_PRIVATE_CORPORATION", "LIMITED_PARTNERSHIP_PRIVATE_CORPORATION", "PRIVATE_PARTNERSHIP", "PROPRIETARY_COMPANY", "PUBLIC_COMPANY", "ASSOCIATION", "REGISTERED_COOPERATIVE", "OTHER_CORPORATE_BODY", "ANY_OTHER_BUSINESS_ENTITY", "ONLY_BUY_OR_SEND_MONEY"The business type.
business_subtypestring"ASSO_TYPE_INCORPORATED", "ASSO_TYPE_NON_INCORPORATED", "GOVT_TYPE_ENTITY", "GOVT_TYPE_EMANATION", "GOVT_TYPE_ESTD_COMM", "GOVT_TYPE_ESTD_FC", "GOVT_TYPE_ESTD_ST_TR"^[0-9A-Z_]+$The sub classification of business type.
categorystring^\d+$The customer's business category code. PayPal uses the industry standard seller category codes.
sub_categorystring^\d+$The customer's business subcategory code. PayPal uses the industry standard seller category codes.
merchant_category_codestring^\d+$The customer's business seller category code. PayPal uses the industry standard seller category codes.
purpose_codeThe account's purpose code.
itemsstring"P0104", "P0301", "P0801", "P0802", "P0803", "P0805", "P0806", "P0902", "P1004", "P1005", "P1006", "P1007", "P1008", "P1009"The purpose code. Required only for India. For more information, see the Reserve Bank Of India web site. Value is:
P0104. Cross border delivery of goods and services.P0301. Business related travel purchase.P0801. Hardware consulting.P0802. Software consulting.P0803. Data processing consulting.P0805. Freelance journalism.P0806. Other information services.P0902. Licensing revenues.P1004. Legal.P1005. Accounting and tax.P1006. Business and management consultancy.P1007. Advertising and market research.P1008. Research and development.P1009. Architectural services.website_urlsarrayAn array of website URLs for the business.
itemsstringuriThe URL for the business website.
annual_sales_volume_rangeobjectThe range for the total annual sales volume of the business.
minimum_amountobjectThe minimum inclusive amount for the range.
valuerequiredstringThe amount, up to N digits after the decimal separator. For currencies that do not support decimals, see currency codes.
maximum_amountobjectThe maximum inclusive amount for the range.
valuerequiredstringThe amount, up to N digits after the decimal separator. For currencies that do not support decimals, see currency codes.
average_monthly_volume_rangeobjectThe range for the average monthly volume of the business.
minimum_amountobjectThe minimum inclusive amount for the range.
valuerequiredstringThe amount, up to N digits after the decimal separator. For currencies that do not support decimals, see currency codes.
maximum_amountobjectThe maximum inclusive amount for the range.
valuerequiredstringThe amount, up to N digits after the decimal separator. For currencies that do not support decimals, see currency codes.
percentage_of_ownershipstringThe percentage of shares this person owns in the company.
office_bearersarrayList of office bearers as part of the business entity.
itemsobjectDetails of the person party.
The office bearers of the account.
nameobjectThe legal name of the customer.
prefixstringThe prefix, or title, to the party's name.
given_namestringWhen the party is a person, the party's given, or first, name.
surnamestringWhen the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. Use also to store multiple surnames including the matronymic, or mother's, surname.
middle_namestringWhen the party is a person, the party's middle name. Use also to store multiple middle names including the patronymic, or father's, middle name.
suffixstringThe suffix for the party's name.
alternate_full_namestringDEPRECATED. The party's alternate name. Can be a business name, nickname, or any other name that cannot be split into first, last name. Required when the party is a business.
full_namestringWhen the party is a person, the party's full name.
phone_contactsarrayAn array of contact phone numbers for the customer.
itemsobjectThe phone number and the phone type.
phone_number_detailsrequiredobjectThe phone number details.
country_coderequiredstring^[0-9]{1,3}?$The country calling code (CC), in its canonical international E.164 numbering plan format. The combined length of the CC and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).
national_numberrequiredstring^[0-9]{1,14}?$The national number, in its canonical international E.164 numbering plan format. The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).
extension_numberstring^[0-9]{1,15}?$The extension number.
phone_typerequiredstring"FAX", "HOME", "MOBILE", "OTHER", "PAGER"The phone type.
home_addressobjectThe home address of the account holder.
line1requiredstringThe first line of the address. For example, number or street.
line2stringThe second line of the address. For example, suite or apartment number.
cityrequiredstringThe city name.
statestringcountry_coderequiredstringppaas_common_country_code_v2^([A-Z]{2}|C2)$The two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain isGBand notUKas used in the top-level domain names for that country. Use theC2country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
postal_codestringThe postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.
nationality_country_codestringppaas_common_country_code_v2^([A-Z]{2}|C2)$The citizenship country code of the person
rolestring"CEO", "CHAIRMAN", "DIRECTOR", "SECRETARY", "TREASURER", "TRUSTEE"^[0-9A-Z_]+$The role of the person in the company.
financial_instrument_dataobjectThe customer's financial instrument. Use it to add a financial instrument to the customer's PayPal account.
bank_detailsarrayAn array of bank account details for the ADD_BANK capability.
itemsobjectThe required information to add a card as a financial instrument to PayPal through onboarding.
nick_namestringThe user-provided short name for the user's bank account.
account_numberrequiredstring\d+The bank account number. These are numeric values only without any additional formatting.
account_typerequiredstring"CHECKING", "SAVINGS"The type of account, which is checking or savings.
currency_codestring^([A-Z]){3}$The primary three-character ISO-4217 currency code for the account.
identifiersarrayAn array of instrument institute attributes. Used with the account number to uniquely identify the instrument. Value is:
itemsobjectThe attributes for an instrument institute ID. Used with the account number to uniquely identify the instrument. Value is:
typestring"ROUTING_NUMBER_1", "ROUTING_NUMBER_2", "ROUTING_NUMBER_3", "BI_CODE", "BANK_CODE", "BRANCH_CODE", "INTERMEDIARY_SWIFT_CODE", "BBAN", "BBAN_ENCRYPTED", "BBAN_HMAC", "AGGREGATOR_YODLEE"The bank account ID type.
valuestringThe bank account ID value.
branch_locationobjectThe branch location, if applicable.
line1requiredstringThe first line of the address. For example, number or street.
line2stringThe second line of the address. For example, suite or apartment number.
cityrequiredstringThe city name.
statestringcountry_coderequiredstringppaas_common_country_code_v2^([A-Z]{2}|C2)$The two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain isGBand notUKas used in the top-level domain names for that country. Use theC2country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
postal_codestringThe postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.
mandate_agreedbooleanIndicates whether the user has agreed to the mandate for financial instrument (FI) authorization.
preferred_language_codestring^([a-z]){2}_([A-Z]){2}$The locale code of the user's preferred language.
primary_currency_codeThe primary three-character ISO-4217 currency code of the account.
referral_user_payer_idobjectThe PayPal account ID of the partner.
typerequiredstring"PAYER_ID"The type of ID for the account.
valuerequiredstringThe ID of the account.
partner_specific_identifiersarrayAn array of customer identifiers in the partner's system.
itemsobjectThe identifier for the customer in the partner's system.
typerequiredstring"TRACKING_ID", "ACCOUNT_LINKING_ID"The identifier type.
valuerequiredstringThe identifier value.
requested_capabilitiesarrayAn array of capabilities to enable for the customer while he or she shares the data.
itemsobjectThe required capability to share data.
capabilitystring"API_INTEGRATION", "BANK_ADDITION", "BILLING_AGREEMENT", "CONTEXTUAL_MARKETING_CONSENT"The capability to enable for the customer. To enable the collection of the API permissions that you require to integrate with the customer, specify API_INTEGRATION. BANK_ADDITION is supported only for the US.
api_integration_preferenceobjectThe integration details for the partner and customer relationship. Required if capability_type is API_INTEGRATION.
partner_idstringThe payer ID of the partner who integrates with the client. To find this ID, log in to the partner's PayPal business account. Navigate to Profile, click Profile and settings, and click My business info. The account number appears in the Merchant account ID section.
rest_api_integrationobjectThe integration details for PayPal REST endpoints.
integration_methodstring"BRAINTREE", "PAYPAL""PAYPAL"The REST-credential integration method.
integration_typestring"FIRST_PARTY", "THIRD_PARTY"The type of REST-endpoint integration. To integrate with Braintree v.zero for PayPal REST endpoints, specify REST_THIRD_PARTY_DETAILS.
integration_channelstring"DEFERRED_ONBOARDING"The rest api integration channel.
rest_third_party_detailsobjectThe integration details for PayPal REST endpoints.
partner_client_idstringThe client ID of the partner's API caller account.
feature_listarrayAn array of features that partner can access, or use, in PayPal on behalf of the seller. The seller grants permission for these features to the partner.
itemsstring"PAYMENT", "REFUND", "PARTNER_FEE", "DELAY_FUNDS_DISBURSEMENT", "READ_SELLER_DISPUTE", "UPDATE_SELLER_DISPUTE", "ACCESS_MERCHANT_INFORMATION", "INVOICE_READ_WRITE", "ADVANCED_TRANSACTIONS_SEARCH"The REST endpoint.
rest_first_party_detailsobjectThe integration details for PayPal First Party REST endpoints.
partner_client_idstringThe client ID of the partner.
feature_listarrayAn array of features that partner can access, or use, in PayPal on behalf of the seller. The seller grants permission for these features to the partner.
itemsstring"PAYMENT", "REFUND", "PARTNER_FEE", "DELAY_FUNDS_DISBURSEMENT", "READ_SELLER_DISPUTE", "UPDATE_SELLER_DISPUTE", "ACCESS_MERCHANT_INFORMATION", "INVOICE_READ_WRITE", "ADVANCED_TRANSACTIONS_SEARCH"The REST endpoint.
seller_noncestringS256 - The code verifier must be high-entropy cryptographic random string with a byte length of 43-128 range.
billing_agreementobjectThe details of the billing agreement between the partner and a seller.
descriptionstringThe billing agreement description.
billing_experience_preferenceobjectThe preference that customizes the billing experience of the customer.
experience_idstringThe ID of the payment web experience profile, which is returned from a create web experience profile call.
billing_context_setbooleanIndicates whether the partner has already displayed the billing context to the seller.
merchant_custom_datastringThe custom data for the billing agreement.
approval_urlstringuriThe URL to which to redirect seller to accept the billing agreement.
ec_tokenstringThe billing agreement token for the agreement.
web_experience_preferenceobjectThe preference to customize the web experience of the customer.
partner_logo_urlstringuriThe partner logo URL to display in the seller onboarding flow.
Note: While there is no restriction on the size of your image, PayPal forces the max width to 106px and max height to 29px. The best resolution you can provide is 106px x 29px.
return_urlstringuriThe URL to which to redirect the customer upon completion of the onboarding process.
return_url_descriptionstringThe description of the return URL.
action_renewal_urlstringuriIf renew_action_url expires, redirect the customer to this URL.
show_add_credit_cardbooleanIndicates whether to show an add credit card page.
show_mobile_confirmbooleanIndicates whether to ask the customer to initiate confirmation of their mobile phone (the phone that the partner designated as MOBILE in the customer data). Default isfalse.
use_mini_browserbooleanIndicates whether to provide a single page signup flow in a mini browser. Default is to provide a full-size, multi-page flow.
use_hua_email_confirmationbooleanIndicates whether to use the hosted_user_agreement_url to confirm the customer's email address. If true, PayPal appends the email confirmation code to hosted_user_agreement_url, and when a customer successfully accesses the hosted user agreement URL, confirms the customer's email address. If false, PayPal does not append the confirmation code to the URL and does not confirm the email address.
collected_consentsarrayAn array of all consents that the partner has received from this seller. If SHARE_DATA_CONSENT is not granted, PayPal does not store customer data.
itemsobjectThe customer-provided consent.
typerequiredstring"SHARE_DATA_CONSENT"The type of consent. SHARE_DATA_CONSENT gives consent to you to share your customer's data with PayPal.
grantedrequiredbooleanIndicates whether the customer agreed to share this type of data. To give consent, specify true. To withhold consent, specify false.
productsarrayAn array of PayPal products to which the partner wants to onboard the customer.
itemsstring"EXPRESS_CHECKOUT", "PPPLUS", "WP_PRO", "PPCP", "PAYMENT_METHODS", "ADVANCED_VAULTING"The PayPal product for which the customer is onboarded.