openapi: 3.0.3 info: title: Paypal Partner Referrals description: 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.

Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.

format: ppaas_common_country_code_v2 maxLength: 2 minLength: 2 pattern: "^([A-Z]{2}|C2)$" address_portable: type: object title: Portable Postal Address (Medium-Grained) description: 'The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-controls-the-autocomplete-attribute).' properties: address_line_1: type: string description: The first line of the address. For example, number or street. For example, `173 Drury Lane`. Required for data entry and compliance and risk checks. Must contain the full address. maxLength: 300 address_line_2: type: string description: The second line of the address. For example, suite or apartment number. maxLength: 300 address_line_3: type: string description: The third line of the address, if needed. For example, a street complement for Brazil, direction text, such as `next to Walmart`, or a landmark in an Indian address. maxLength: 100 admin_area_4: type: string description: The neighborhood, ward, or district. Smaller than `admin_area_level_3` or `sub_locality`. Value is:

The postal sorting code for Guernsey and many French territories, such as French Guiana.
The fine-grained administrative levels in China.

maxLength: 100 admin_area_3: type: string description: A sub-locality, suburb, neighborhood, or district. Smaller than `admin_area_level_2`. Value is:

Brazil. Suburb, bairro, or neighborhood.
India. Sub-locality or district. Street name information is not always available but a sub-locality or district can be a very small area.

maxLength: 100 admin_area_2: type: string description: A city, town, or village. Smaller than `admin_area_level_1`. maxLength: 120 admin_area_1: type: string description: The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. Format for postal delivery. For example, `CA` and not `California`. Value, by country, is:

UK. A county.
US. A state.
Canada. A province.
Japan. A prefecture.
Switzerland. A kanton.

maxLength: 300 postal_code: type: string description: The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See [postal code](https://en.wikipedia.org/wiki/Postal_code). maxLength: 60 country_code: "$ref": "#/components/schemas/country_code" address_details: type: object title: Address Details description: The non-portable additional address details that are sometimes needed for compliance, risk, or other scenarios where fine-grain address information might be needed. Not portable with common third party and open source. Redundant with core fields.
For example, `address_portable.address_line_1` is usually a combination of `address_details.street_number`, `street_name`, and `street_type`. properties: street_number: type: string description: The street number. maxLength: 100 street_name: type: string description: The street name. Just `Drury` in `Drury Lane`. maxLength: 100 street_type: type: string description: The street type. For example, avenue, boulevard, road, or expressway. maxLength: 100 delivery_service: type: string description: The delivery service. Post office box, bag number, or post office name. maxLength: 100 building_name: type: string description: A named locations that represents the premise. Usually a building name or number or collection of buildings with a common name or number. For example, Craven House. maxLength: 100 sub_building: type: string description: The first-order entity below a named building or location that represents the sub-premise. Usually a single building within a collection of buildings with a common name. Can be a flat, story, floor, room, or apartment. maxLength: 100 required: - country_code person_address_type: description: The address type under which the provided address is tagged. title: Person address type type: string pattern: "^[0-9A-Z_]+$" minLength: 1 maxLength: 255 enum: - HOME person_address_detail: type: object title: Person address detail description: A simple postal address with coarse-grained fields. allOf: - "$ref": "#/components/schemas/address_portable" - properties: type: description: The address type under which this is classified. "$ref": "#/components/schemas/person_address_type" primary: type: boolean description: Whether this is the primary address of the user. This cannot be directly set to `false`, but rather it is toggled `false` in the datastore when another address is set to primary. inactive: type: boolean description: Whether this address has been inactivated. readOnly: true required: - type phone: type: object title: Phone description: The phone number in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). properties: country_code: type: string description: The country calling code (CC), in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). 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). minLength: 1 maxLength: 3 pattern: "^[0-9]{1,3}?$" national_number: type: string description: The national number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). 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). minLength: 1 maxLength: 14 pattern: "^[0-9]{1,14}?$" extension_number: type: string description: The extension number. minLength: 1 maxLength: 15 pattern: "^[0-9]{1,15}?$" required: - country_code - national_number phone_type: type: string title: Phone Type description: The phone type. enum: - FAX - HOME - MOBILE - OTHER - PAGER phone_number_tag: description: Tag associated with the phone number. title: Phone number tag type: string pattern: "^[0-9A-Z_]+$" minLength: 1 maxLength: 255 enum: - MOBILE - LANDLINE person_phone_detail: type: object title: Phone details description: The phone number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). allOf: - "$ref": "#/components/schemas/phone" - properties: contact_name: type: string description: The name that the phone number is connected to. minLength: 1 maxLength: 900 inactive: type: boolean description: Whether this phone number has been inactivated by the user. readOnly: true primary: type: boolean description: Whether this is the primary contact phone number of the user. primary_mobile: type: boolean description: Whether this is the primary mobile phone number of the user. type: "$ref": "#/components/schemas/phone_type" description: The type of phone number provided. For example, home, work, or mobile. tags: type: array description: Array of tags for this phone number. items: "$ref": "#/components/schemas/phone_number_tag" minItems: 0 maxItems: 20 required: - type date_no_time: type: string description: The stand-alone date, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). To represent special legal values, such as a date of birth, you should use dates with no associated time or time-zone data. Whenever possible, use the standard `date_time` type. This regular expression does not validate all dates. For example, February 31 is valid and nothing is known about leap years. format: ppaas_date_notime_v2 minLength: 10 maxLength: 10 pattern: "^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$" birth_details: title: Birth details type: object description: Date of birth data provided by the user properties: date_of_birth: description: date of birth, fomrat [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). "$ref": "#/components/schemas/date_no_time" required: - date_of_birth date_time: type: string description: The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional.

Note: The regular expression provides guidance but does not reject all invalid dates.

Note: This field is not applicable for POST [/v2/customer/partner-referrals](/docs/api/partner-referrals/v2/#partner-referrals_create) API calls.

type: array items: "$ref": "#/components/schemas/person_document" minItems: 0 maxItems: 20 individual_owner_type: description: Role of the person party played in the account. title: Individual owner role type type: string pattern: "^[0-9A-Z_]+$" minLength: 1 maxLength: 255 enum: - PRIMARY individual_owner: title: Individual_owner description: The individual owner of the account. allOf: - "$ref": "#/components/schemas/person" - properties: type: description: The actual role of this user on the account, PRIMARY/SECONDARY. "$ref": "#/components/schemas/individual_owner_type" business_type: description: The business types classified title: Business type type: string pattern: "^[0-9A-Z_]+$" minLength: 1 maxLength: 255 enum: - ANY_OTHER_BUSINESS_ENTITY - ASSOCIATION - CORPORATION - GENERAL_PARTNERSHIP - GOVERNMENT - INDIVIDUAL - LIMITED_LIABILITY_PARTNERSHIP - LIMITED_LIABILITY_PROPRIETORS - LIMITED_LIABILITY_PRIVATE_CORPORATION - LIMITED_PARTNERSHIP - LIMITED_PARTNERSHIP_PRIVATE_CORPORATION - NONPROFIT - ONLY_BUY_OR_SEND_MONEY - OTHER_CORPORATE_BODY - PARTNERSHIP - PRIVATE_PARTNERSHIP - PROPRIETORSHIP - PROPRIETORSHIP_CRAFTSMAN - PROPRIETORY_COMPANY - PRIVATE_CORPORATION - PUBLIC_COMPANY - PUBLIC_CORPORATION - PUBLIC_PARTNERSHIP - REGISTERED_COOPERATIVE business_sub_type: description: Sub classification of the business type title: The business sub type. type: string pattern: "^[0-9A-Z_]+$" minLength: 1 maxLength: 255 enum: - 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 business_type_info: title: Business type information type: object description: The type and subtype of the business. properties: type: description: Type of business entity like corporation, sole prop, governmental. "$ref": "#/components/schemas/business_type" subtype: description: The sub classification of the business type. "$ref": "#/components/schemas/business_sub_type" business_industry: title: Business industry type: object description: The category, subcategory and MCC code of the business. properties: category: type: string description: The customer's business category code. PayPal uses industry standard seller category codes. pattern: "^\\d+$" minLength: 1 maxLength: 20 mcc_code: type: string description: The customer's business seller category code. PayPal uses industry standard seller category codes. pattern: "^\\d+$" minLength: 1 maxLength: 20 subcategory: type: string description: The customer's business subcategory code. PayPal uses industry standard seller subcategory codes. pattern: "^\\d+$" minLength: 1 maxLength: 20 required: - category - mcc_code - subcategory business_incorporation: title: Business_incorporation type: object description: Business incorporation information. properties: incorporation_country_code: description: The incorporation country code. "$ref": "#/components/schemas/country_code" incorporation_date: description: date of incorporation "$ref": "#/components/schemas/date_no_time" incorporation_province_code: description: The province of incorporation. type: string minLength: 1 maxLength: 50 pattern: "^[A-Z]{2}-([A-Z]{2,3}|[0-9]{2,3})$" business_name: type: object title: Business Name description: The business name of the party. properties: business_name: type: string description: Required. The business name of the party. maxLength: 300 business_name_type: description: Business name type title: The business name type. type: string pattern: "^[0-9A-Z_]+$" minLength: 1 maxLength: 255 enum: - DOING_BUSINESS_AS - LEGAL_NAME business_name_detail: type: object title: Business name description: Name of the business provided. allOf: - "$ref": "#/components/schemas/business_name" - properties: id: description: The encrypted ID for the business name. type: string readOnly: true minLength: 1 maxLength: 20 type: description: The type of business name. For example, trading name. "$ref": "#/components/schemas/business_name_type" required: - type email_address: type: string description: 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.

An integer for currencies like `JPY` that are not typically fractional.
A decimal fraction for currencies like `TND` that are subdivided into thousandths.

For the required number of decimal places for a currency code, see [Currency Codes](/docs/integration/direct/rest/currency-codes/). maxLength: 32 pattern: "^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$" required: - currency_code - value currency_range: type: object title: Currency Range description: The currency range, from the minimum inclusive amount to the maximum inclusive amount. additionalProperties: false properties: minimum_amount: description: The minimum inclusive amount for the range. "$ref": "#/components/schemas/money" maximum_amount: description: The maximum inclusive amount for the range. "$ref": "#/components/schemas/money" purpose_code_enum: type: string title: Purpose Code description: 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.

Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.

format: ppaas_common_country_code_v2 maxLength: 2 minLength: 2 pattern: "^([A-Z]{2}|C2)$" address_portable-2: type: object title: Portable Postal Address (Medium-Grained) description: 'The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-controls-the-autocomplete-attribute).' properties: address_line_1: type: string description: The first line of the address. For example, number or street. For example, `173 Drury Lane`. Required for data entry and compliance and risk checks. Must contain the full address. maxLength: 300 address_line_2: type: string description: The second line of the address. For example, suite or apartment number. maxLength: 300 address_line_3: type: string description: The third line of the address, if needed. For example, a street complement for Brazil, direction text, such as `next to Walmart`, or a landmark in an Indian address. maxLength: 100 admin_area_4: type: string description: The neighborhood, ward, or district. Smaller than `admin_area_level_3` or `sub_locality`. Value is:

The postal sorting code for Guernsey and many French territories, such as French Guiana.
The fine-grained administrative levels in China.

maxLength: 100 admin_area_3: type: string description: A sub-locality, suburb, neighborhood, or district. Smaller than `admin_area_level_2`. Value is:

Brazil. Suburb, bairro, or neighborhood.
India. Sub-locality or district. Street name information is not always available but a sub-locality or district can be a very small area.

UK. A county.
US. A state.
Canada. A province.
Japan. A prefecture.
Switzerland. A kanton.

For banks with IBAN information, the IBAN number.
For banks with BBAN information, the BBAN number.
For banks with both IBAN and BBAN information, the IBAN number.