Partner Referrals API

Business entity of the account.

List of owners in the account. There should be only one primary account owner which is mentioned in their role_type.

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.

The delivery service. Post office box, bag number, or post office name.

The street name. Just Drury in Drury Lane.

The street number.

The street type. For example, avenue, boulevard, road, or expressway.

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.

The two-character ISO 3166-1 code that identifies the country or region.

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.

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.

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.

The second line of the address. For example, suite or apartment number.

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.

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.

A city, town, or village. Smaller than admin_area_level_1.

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.

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.

The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.

The two-character ISO 3166-1 code that identifies the country or region.

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.

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.

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.

The second line of the address. For example, suite or apartment number.

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.

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.

A city, town, or village. Smaller than admin_area_level_1.

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.

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.

The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.

Business beneficial owners.

Individual beneficial owners.

The URL to which to redirect seller to accept the billing agreement.

The preference that customizes the billing experience of the customer.

The billing agreement description.

The billing agreement token for the agreement.

The custom data for the billing agreement.

Indicates whether the partner has already displayed the billing context to the seller.

The ID of the payment web experience profile.

date of birth, fomrat Internet date and time format.

List of addresses associated with the business entity.

Information related to the business like the nature of business, started date etc.

Information related to the business like the nature of business, started date etc.

Information related to the business like the nature of business, started date etc.

Business Party related Document data collected from the customer.. For example SSN, ITIN, Business registration number that were collected from the user.

Email addresses of the business.

Name of the business.

List of phone number associated with the business.

Website of the business.

The two-character ISO 3166-1 code that identifies the country or region.

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.

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.

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.

The second line of the address. For example, suite or apartment number.

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.

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.

A city, town, or village. Smaller than admin_area_level_1.

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.

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.

The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.

Whether this address has been inactivated.

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.

The address type under which this is classified. For example, shipping or dropoff.

The two-character ISO 3166-1 code that identifies the country or region.

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.

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.

The second line of the address. For example, suite or apartment number.

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.

A city, town, or village. Smaller than admin_area_level_1.

The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.

The address type under which this is classified. For example, shipping or dropoff.

Address type under which the provided address is tagged

The possible values are:

• WORK. The address of the business.

List of addresses associated with the business entity.

Information related to the business like the nature of business, started date etc.

Information related to the business like the nature of business, started date etc.

Information related to the business like the nature of business, started date etc.

Business Party related Document data collected from the customer.. For example SSN, ITIN, Business registration number that were collected from the user.

Email addresses of the business.

Name of the business.

List of phone number associated with the business.

Website of the business.

The percentage of shares this person owns in the company.

List of addresses associated with the business entity.

Information related to the business like the nature of business, started date etc.

Information related to the business like the nature of business, started date etc.

Information related to the business like the nature of business, started date etc.

Email addresses of the business.

Name of the business.

List of phone number associated with the business.

Website of the business.

The percentage of shares this person owns in the company.

The expire data of the document.

The files contained in the document. For example, a document could be represented by a front page file and a back page file, etc.

The encrypted identifier for the document.

The number for the document. It is the ID number if the document is ID CARD, the passport number if the document is PASSPORT, etc.

The issue date of the document.

The country code of the document.

The document labels. A document could be classfied to multiple categories. For example, a bill document can be classfified as BILL DOCUMENT and UTILITY DOCUMENT.

The HATEOAS links.

The file name.

The actual type of the document.

The number for the document. It is the ID number if the document is ID CARD, the passport number if the document is PASSPORT, etc.

The country code of the document.

The actual type of the document.

The type of documents.

The possible values are:

• SOCIAL_SECURITY_NUMBER. A social security number.
• EMPLOYMENT_IDENTIFICATION_NUMBER. The employee identification number.
• TAX_IDENTIFICATION_NUMBER. The tax identification number.
• PASSPORT_NUMBER. A passport number.
• PENSION_FUND_ID. A pension fund ID.
• MEDICAL_INSURANCE_ID. A medical insurance ID.
• CNPJ. The identification number issued to Brazilian companies by the Department of Federal Revenue of Brazil.
• CPF. A Brazilian individual's taxpayer registry identification number.
• PAN. The Permanent account number issued by the Indian Income Tax Department.

List of addresses associated with the business entity.

Information related to the business like the nature of business, started date etc.

Information related to the business like the nature of business, started date etc.

Information related to the business like the nature of business, started date etc.

Business Party related Document data collected from the customer.. For example SSN, ITIN, Business registration number that were collected from the user.

Email addresses of the business.

Name of the business.

List of phone number associated with the business.

Website of the business.

The range for the total annual sales volume of the business.

The range for the average monthly volume of the business.

List of beneficial owners part of the entity. They can be either a Person or a business entity.

The business goals description. For example, a mission statement.

List of Directors present as part of the business entity.

The account's purpose code.

The incorporation country code.

date of incorporation

The province of incorporation.

The incorporation country code.

date of incorporation

The customer's business category code. PayPal uses industry standard seller category codes.

The customer's business seller category code. PayPal uses industry standard seller category codes.

The customer's business subcategory code. PayPal uses industry standard seller subcategory codes.

Required. The business name of the party.

Required. The business name of the party.

The encrypted ID for the business name.

The type of business name. For example, trading name.

Required. The business name of the party.

The type of business name. For example, trading name.

Business name type

The possible values are:

• DOING_BUSINESS_AS. The trading name of the business.
• LEGAL_NAME. The legal name of the business.

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).

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).

The extension number.

The name that the phone number is connected to.

Whether this phone number has been inactivated by the user.

Whether this is the primary contact phone number of the user.

Array of tags for this phone number.

The type of phone number provided. For example, home, work, or mobile.

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).

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).

The extension number.

The type of phone number provided. For example, home, work, or mobile.

The type of phone number provided. For example, home, work, or mobile.

The possible values are:

• CUSTOMER_SERVICE. The customer service phone number.

Sub classification of the business type

The possible values are:

• ASSO_TYPE_INCORPORATED. The asso type incorporated.
• ASSO_TYPE_NON_INCORPORATED. The asso type non incorporated.
• GOVT_TYPE_ENTITY. The govt type entity.
• GOVT_TYPE_EMANATION. The govt type emanation.
• GOVT_TYPE_ESTD_COMM. The govt type estd comm.
• GOVT_TYPE_ESTD_FC. The govt type estd fc.
• GOVT_TYPE_ESTD_ST_TR. The govt type estd st tr.

The business types classified

The possible values are:

• ANY_OTHER_BUSINESS_ENTITY. The any other business entity.
• ASSOCIATION. The association.
• CORPORATION. The corporation.
• GENERAL_PARTNERSHIP. The general partnership.
• GOVERNMENT. The government.
• INDIVIDUAL. The individual.
• LIMITED_LIABILITY_PARTNERSHIP. The limited liability partnership.
• LIMITED_LIABILITY_PROPRIETORS. The limited liability proprietors.
• LIMITED_LIABILITY_PRIVATE_CORPORATION. The limited liability private corporation.
• LIMITED_PARTNERSHIP. The limited partnership.
• LIMITED_PARTNERSHIP_PRIVATE_CORPORATION. The limited partnership private corporation.
• NONPROFIT. The nonprofit.
• ONLY_BUY_OR_SEND_MONEY. The only buy and send money.
• OTHER_CORPORATE_BODY. The other corporate body.
• PARTNERSHIP. The partnership.
• PRIVATE_PARTNERSHIP. The private partnership.
• PROPRIETORSHIP. The proprietorship.
• PROPRIETORSHIP_CRAFTSMAN. The proprietorship craftsman.
• PROPRIETORY_COMPANY. The proprietory company.
• PRIVATE_CORPORATION. The private corporation.
• PUBLIC_COMPANY. The public company.
• PUBLIC_CORPORATION. The public corporation.
• PUBLIC_PARTNERSHIP. The public partnership.
• REGISTERED_COOPERATIVE. Registered Co-operative.

The sub classification of the business type.

The possible values are:

• ASSO_TYPE_INCORPORATED. The asso type incorporated.
• ASSO_TYPE_NON_INCORPORATED. The asso type non incorporated.
• GOVT_TYPE_ENTITY. The govt type entity.
• GOVT_TYPE_EMANATION. The govt type emanation.
• GOVT_TYPE_ESTD_COMM. The govt type estd comm.
• GOVT_TYPE_ESTD_FC. The govt type estd fc.
• GOVT_TYPE_ESTD_ST_TR. The govt type estd st tr.

Type of business entity like corporation, sole prop, governmental.

The possible values are:

• ANY_OTHER_BUSINESS_ENTITY. The any other business entity.
• ASSOCIATION. The association.
• CORPORATION. The corporation.
• GENERAL_PARTNERSHIP. The general partnership.
• GOVERNMENT. The government.
• INDIVIDUAL. The individual.
• LIMITED_LIABILITY_PARTNERSHIP. The limited liability partnership.
• LIMITED_LIABILITY_PROPRIETORS. The limited liability proprietors.
• LIMITED_LIABILITY_PRIVATE_CORPORATION. The limited liability private corporation.
• LIMITED_PARTNERSHIP. The limited partnership.
• LIMITED_PARTNERSHIP_PRIVATE_CORPORATION. The limited partnership private corporation.
• NONPROFIT. The nonprofit.
• ONLY_BUY_OR_SEND_MONEY. The only buy and send money.
• OTHER_CORPORATE_BODY. The other corporate body.
• PARTNERSHIP. The partnership.
• PRIVATE_PARTNERSHIP. The private partnership.
• PROPRIETORSHIP. The proprietorship.
• PROPRIETORSHIP_CRAFTSMAN. The proprietorship craftsman.
• PROPRIETORY_COMPANY. The proprietory company.
• PRIVATE_CORPORATION. The private corporation.
• PUBLIC_COMPANY. The public company.
• PUBLIC_CORPORATION. The public corporation.
• PUBLIC_PARTNERSHIP. The public partnership.
• REGISTERED_COOPERATIVE. Registered Co-operative.

The two-character ISO 3166-1 code that identifies the country or region.

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.

The two-character ISO 3166-1 code that identifies the country or region.

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.

An array of request-related HATEOAS links.

The three-character ISO-4217 currency code that identifies the currency.

The three-character ISO-4217 currency code that identifies the currency.

The maximum inclusive amount for the range.

The minimum inclusive amount for the range.

The stand-alone date, in Internet date and time format. 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.

The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional.

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

The expire data of the document.

The files contained in the document. For example, a document could be represented by a front page file and a back page file, etc.

The encrypted identifier for the document.

The number for the document. It is the ID number if the document is ID CARD, the passport number if the document is PASSPORT, etc.

The issue date of the document.

The country code of the document.

The document labels. A document could be classfied to multiple categories. For example, a bill document can be classfified as BILL DOCUMENT and UTILITY DOCUMENT.

The HATEOAS links.

The file name.

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.

The role of the email address.

The possible values are:

• CUSTOMER_SERVICE. The email ID to be used to contact the customer service of the business.

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.

The role of the email address.

The possible values are:

• CUSTOMER_SERVICE. The email ID to be used to contact the customer service of the business.

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.

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.

The PayPal internal ID. Used for correlation purposes.

The message that describes the error.

The human-readable, unique name of the error.

An array of additional details about the error.

The information link, or URI, that shows detailed information about this error for the developer.

An array of request-related HATEOAS links.

The unique, fine-grained application-level error code.

The human-readable description for an issue. The description can change over the lifetime of an API, so clients must not depend on this value.

The field that caused the error. If this field is in the body, set this value to the field's JSON pointer value. Required for client-side errors.

The location of the field that caused the error. Value is body, path, or query.

The value of the field that caused the error.

The Internet Assigned Numbers Authority (IANA) media type of the file.

The date and time when the file was created, in Internet date and time format.

The ID of the referenced file.

The reference URL for the file.

The size of the file, in bytes.

An 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.

S256 - The code verifier must be high-entropy cryptographic random string with a byte length of 43-128 range.

The list of addresses associated with the person.

The person's birth details.

The citizenship country code of the person.

A person's or party's related document data collected from the customer. For example SSN, ITIN, or business registration number collected from the user.

Note: This field is not applicable for POST /v2/customer/partner-referrals API calls.

The encrypted party ID.

The name of the person.

The list of phone numbers associated with the person.

The percentage of shares this person owns in the company.

The list of addresses associated with the person.

The person's birth details.

The citizenship country code of the person.

The name of the person.

The list of phone numbers associated with the person.

The percentage of shares this person owns in the company.

The list of addresses associated with the person.

The person's birth details.

The citizenship country code of the person.

A person's or party's related document data collected from the customer. For example SSN, ITIN, or business registration number collected from the user.

Note: This field is not applicable for POST /v2/customer/partner-referrals API calls.

The encrypted party ID.

The name of the person.

The list of phone numbers associated with the person.

The actual role of this user on the account, PRIMARY/SECONDARY.

The list of addresses associated with the person.

The person's birth details.

The citizenship country code of the person.

A person's or party's related document data collected from the customer. For example SSN, ITIN, or business registration number collected from the user.

Note: This field is not applicable for POST /v2/customer/partner-referrals API calls.

The name of the person.

The list of phone numbers associated with the person.

The actual role of this user on the account, PRIMARY/SECONDARY.

Role of the person party played in the account.

The possible values are:

• PRIMARY. Primary account holder.

The integration details for PayPal CLASSIC endpoints.

The integration details for PayPal REST endpoints.

A document label.

The language tag for the language in which to localize the error-related strings, such as messages, issues, and suggested actions. The tag is made up of the ISO 639-2 language code, the optional ISO-15924 script tag, and the ISO-3166 alpha-2 country code.

Indicates whether the customer agreed to share this type of data. To give consent, specify true. To withhold consent, specify false.

The type of consent. SHARE_DATA_CONSENT gives consent to you to share your customer's data with PayPal.

The possible values are:

• SHARE_DATA_CONSENT. The consent given by the customer to share their data with paypal.

The complete target URL. To make the related call, combine the method with this URI Template-formatted link. For pre-processing, include the $, (, and ) characters. The href is the key HATEOAS component that links a completed call with a subsequent call.

The link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.

The HTTP method required to make the related call.

The complete target URL. To make the related call, combine the method with this URI Template-formatted link. For pre-processing, include the $, (, and ) characters. The href is the key HATEOAS component that links a completed call with a subsequent call.

The link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.

The HTTP method required to make the related call.

The complete target URL. To make the related call, combine the method with this URI Template-formatted link. For pre-processing, include the $, (, and ) characters. The href is the key HATEOAS component that links a completed call with a subsequent call.

The link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.

The HTTP method required to make the related call.

The complete target URL. To make the related call, combine the method with this URI Template-formatted link. For pre-processing, include the $, (, and ) characters. The href is the key HATEOAS component that links a completed call with a subsequent call.

The link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.

The HTTP method required to make the related call.

The complete target URL. To make the related call, combine the method with this URI Template-formatted link. For pre-processing, include the $, (, and ) characters. The href is the key HATEOAS component that links a completed call with a subsequent call.

The link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.

The HTTP method required to make the related call.

The three-character ISO-4217 currency code that identifies the currency.

The value, which might be:

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

When the party is a person, the party's full name.

When the party is a person, the party's given, or first, name.

When 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.

The prefix, or title, to the party's name.

The suffix for the party's name.

When 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.

The list of addresses associated with the person.

The person's birth details.

The citizenship country code of the person.

A person's or party's related document data collected from the customer. For example SSN, ITIN, or business registration number collected from the user.

Note: This field is not applicable for POST /v2/customer/partner-referrals API calls.

The encrypted party ID.

The name of the person.

The list of phone numbers associated with the person.

The role of the office bearer in the company.

The list of addresses associated with the person.

The person's birth details.

The citizenship country code of the person.

A person's or party's related document data collected from the customer. For example SSN, ITIN, or business registration number collected from the user.

Note: This field is not applicable for POST /v2/customer/partner-referrals API calls.

The name of the person.

The list of phone numbers associated with the person.

The role of the office bearer in the company.

Role of the person party played in the business.

The possible values are:

• CEO. The ceo.
• CHAIRMAN. The chairman.
• DIRECTOR. Director of the business
• SECRETARY. The secretary.
• TREASURER. The treasurer.
• TRUSTEE. The trustee.

The integration details for the partner and customer relationship. Required if operation is API_INTEGRATION.

The details of the billing agreement between the partner and a seller.

The operation 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.

The possible values are:

• API_INTEGRATION. The operation used by partner request permission for customers api access.
• BANK_ADDITION. Captured state of an order.
• BILLING_AGREEMENT. The operation to create a billing agreement.
• CONTEXTUAL_MARKETING_CONSENT. The operation to create a contextual marketing consent.

If renew_action_url expires, redirect the customer to this URL.

The partner logo URL to display in the customer's onboarding flow.

The URL to which to redirect the customer upon completion of the onboarding process.

The description of the return URL.

Indicates whether to show an add credit card page.

The percentage, as a fixed-point, signed decimal number. For example, define a 19.99% interest rate as 19.99.

The list of addresses associated with the person.

The person's birth details.

The citizenship country code of the person.

A person's or party's related document data collected from the customer. For example SSN, ITIN, or business registration number collected from the user.

Note: This field is not applicable for POST /v2/customer/partner-referrals API calls.

The encrypted party ID.

The name of the person.

The list of phone numbers associated with the person.

The two-character ISO 3166-1 code that identifies the country or region.

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.

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.

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.

The second line of the address. For example, suite or apartment number.

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.

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.

A city, town, or village. Smaller than admin_area_level_1.

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.

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.

The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.

Whether this address has been inactivated.

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.

The address type under which this is classified.

The two-character ISO 3166-1 code that identifies the country or region.

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.

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.

The second line of the address. For example, suite or apartment number.

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.

A city, town, or village. Smaller than admin_area_level_1.

The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.

The address type under which this is classified.

The two-character ISO 3166-1 code that identifies the country or region.

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.

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.

The second line of the address. For example, suite or apartment number.

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.

A city, town, or village. Smaller than admin_area_level_1.

The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.

The address type under which this is classified.

The address type under which the provided address is tagged.

The possible values are:

• HOME. The home address of the customer.

The expire data of the document.

The files contained in the document. For example, a document could be represented by a front page file and a back page file, etc.

The encrypted identifier for the document.

The number for the document. It is the ID number if the document is ID CARD, the passport number if the document is PASSPORT, etc.

The issue date of the document.

The country code of the document.

The document labels. A document could be classfied to multiple categories. For example, a bill document can be classfified as BILL DOCUMENT and UTILITY DOCUMENT.

The HATEOAS links.

The file name.

The actual type of the document. It could be ID_CARD, PASSPORT, etc.

The number for the document. It is the ID number if the document is ID CARD, the passport number if the document is PASSPORT, etc.

The country code of the document.

The actual type of the document. It could be ID_CARD, PASSPORT, etc.

The number for the document. It is the ID number if the document is ID CARD, the passport number if the document is PASSPORT, etc.

The country code of the document.

The actual type of the document. It could be ID_CARD, PASSPORT, etc.

The type of documents.

The possible values are:

• SOCIAL_SECURITY_NUMBER. A social security number.
• EMPLOYMENT_IDENTIFICATION_NUMBER. The employee identification number.
• TAX_IDENTIFICATION_NUMBER. A tax identification number.
• PASSPORT_NUMBER. The passport number.
• PENSION_FUND_ID. A pension fund ID.
• MEDICAL_INSURANCE_ID. The medical insurance ID.
• CNPJ. The identification number issued to Brazilian companies by the Department of Federal Revenue of Brazil.
• CPF. A Brazilian individual's taxpayer registry identification number.
• PAN. The permanent account number issued by the Indian Income Tax Department.

When the party is a person, the party's full name.

When the party is a person, the party's given, or first, name.

When 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.

The prefix, or title, to the party's name.

The suffix for the party's name.

When 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.

The type of name. Currently supported values are: LEGAL.

When the party is a person, the party's full name.

When the party is a person, the party's given, or first, name.

When 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.

The prefix, or title, to the party's name.

The suffix for the party's name.

When 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.

The type of name. Currently supported values are: LEGAL.

When the party is a person, the party's full name.

When the party is a person, the party's given, or first, name.

When 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.

The prefix, or title, to the party's name.

The suffix for the party's name.

When 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.

The type of name. Currently supported values are: LEGAL.

The person's name type.

The possible values are:

• LEGAL. Indicates that this name is the legal name of the user.

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).

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).

The extension number.

The name that the phone number is connected to.

Whether this phone number has been inactivated by the user.

Whether this is the primary contact phone number of the user.

Whether this is the primary mobile phone number of the user.

Array of tags for this phone number.

The type of phone number provided. For example, home, work, or mobile.

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).

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).

The extension number.

The type of phone number provided. For example, home, work, or mobile.

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).

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).

The extension number.

The type of phone number provided. For example, home, work, or mobile.

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).

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).

The extension number.

Tag associated with the phone number.

The possible values are:

• MOBILE. The mobile telephone number.
• LANDLINE. The landline telephone number.

The phone type.

The possible values are:

• FAX. A fax machine.
• HOME. A home phone.
• MOBILE. A mobile phone.
• OTHER. Other.
• PAGER. A pager.

The PayPal product for which the customer is onboarded.

The possible values are:

• EXPRESS_CHECKOUT. Express checkout product
• PPPLUS. PayPal PLUS product.
• WEBSITE_PAYMENT_PRO. PayPal Professional product
• PPCP. PayPal Complete Payments product

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.

The possible values are:

• 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.

Business entity of the account.

List of owners in the account. There should be only one primary account owner which is mentioned in their role_type.

Email address of the customer used to create the account.

Array of financial instruments attached to the customer's account.

An 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.

An array of operations to perform for the customer while they share their data.

The configuration property that the partner intends to override for this onboarding request.

Payout specific attributes.

The preferred locale code to use in the onboarding flow for the customer.

An array of PayPal products to which the partner wants to onboard the customer.

The partner's unique identifier for this customer in their system which can be used to track user in PayPal.

The bank account number.

The type of bank account.

The possible values are:

• CHECKING. Checking account.
• SAVINGS. Savings account.

The branch location, if applicable.

The primary currency code of the bank account.

An array of instrument institute attributes. Used with the account number to uniquely identify the instrument. Value is:

• 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.

Mandate for this bank account.

The user-provided short name for the user's bank account.

The two-character ISO 3166-1 code that identifies the country or region.

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.

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.

The second line of the address. For example, suite or apartment number.

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.

A city, town, or village. Smaller than admin_area_level_1.

The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.

Country.

Requested transfer method and currency for a country.

An array of banks attached to this managed account.

The bank account ID type.

The possible values are:

• BANK_CODE. The bank code.
• BI_CODE. The BI code.
• BRANCH_CODE. The bank branch code.
• ROUTING_NUMBER_1. The bank routing number.
• ROUTING_NUMBER_2. The bank routing number.
• ROUTING_NUMBER_3. The bank routing number.
• SWIFT_CODE. The bank swift code.
• BRANCH_CODE. Branch code.
• INTERMEDIARY_SWIFT_CODE. Swift code.
• BBAN. BBAN.
• BBAN_ENCRYPTED. BBAN enrypted.
• BBAN_HMAC. BBAN HMAC.
• AGGREGATOR_YODLEE. Aggregator Yodlee.

The value of account identifier.

Whether mandate was accepted or not.

Requested country, transfer method and currency.

If true, specifies that the Kyc is required for the merchant.

If true, specifies that the merchant or platform is offering goods or services on behalf of 3rd party sellers.

The integration details for PayPal first party REST endpoints.

The REST-credential integration method.

The possible values are:

• BRAINTREE. Braintree integration method.
• PAYPAL. PayPal integration method.

The type of REST-endpoint integration. To integrate with Braintree v.zero for PayPal REST endpoints, specify third_party_details.

The possible values are:

• FIRST_PARTY. A first-party integration.
• THIRD_PARTY. A third-party integration.

The integration details for PayPal REST endpoints.

Requested Currencies for a Transfer Method.

Transfer Method type.

The possible values are:

• BANK_ACCOUNT. Transfer method type- Bank Account
• PAYPAL. Transfer method type- Bank Account
• VENMO. Transfer method type- Bank Account
• WIRE_ACCOUNT. Transfer method type- Bank Account

An array of request-related HATEOAS links.

The ID to access the customer's data shared by the partner with PayPal.

The customer's referral data that partners share with PayPal.

The payer ID of the partner who shared the referral data.

The REST endpoint.

The possible values are:

• PAYOUTS. Payout feature.
• PAYMENT. Payment feature.
• REFUND. Refund feature.
• FUTURE_PAYMENT. Future Payment feature.
• DIRECT_PAYMENT. Direct Payment feature.
• PARTNER_FEE. Partner fee feature.
• DELAY_FUNDS_DISBURSEMENT. Delay funds disbursement feature.
• READ_SELLER_DISPUTE. Read seller dispute feature.
• UPDATE_SELLER_DISPUTE. update seller dispute feature.
• ADVANCED_TRANSACTIONS_SEARCH. Advanced transaction search feature.
• SWEEP_FUNDS_EXTERNAL_SINK. Sweep funds external sink feature.
• ACCESS_MERCHANT_INFORMATION. Access merchant information feature.
• TRACKING_SHIPMENT_READWRITE. Tracking Shipment readwrite feature.
• INVOICE_READ_WRITE. Invoice readwrite feature.
• DISPUTE_READ_BUYER. Read the buyer disputes.
• UPDATE_CUSTOMER_DISPUTES. Update the buyer disputes.

An 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.