Partner Referrals API
Important: PayPal for Marketplaces is a limited-release solution at this time. It is available to select partners for approved use cases. For more information, reach out to your PayPal account manager.In the Connected Path, you host a button on your website that takes sellers to PayPal to create and configure a PayPal account. The Onboarding API enables you to collect seller data and pass it to the account creation and setup forms, reducing the burden on sellers during the signup and setup process. Call the create partner referral and show referral data methods for the Connected Path.
Partner referrals (resource group)
Enables you to create and get information about shared customer data.
Create partner referral
Request body
business_entity
Business entity of the account.
email
Email address of the customer used to create the account.
financial_instruments
Array of financial instruments attached to the customer's account.
individual_owners
array (contains the individual_owner object)
List of owners in the account. There should be only one primary account owner which is mentioned in their role_type.
legal_consents
array (contains the legal_consent object)
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.operations
array (contains the operation object)
An array of operations to perform for the customer while they share their data.
partner_config_override
The configuration property that the partner intends to override for this onboarding request.
payout_attributes
Payout specific attributes.
preferred_language_code
The preferred locale code to use in the onboarding flow for the customer.
products
array (contains the product_name object)
An array of PayPal products to which the partner wants to onboard the customer.
tracking_id
string
The partner's unique identifier for this customer in their system which can be used to track user in PayPal.
Sample Request
curl -v -X POST https://api-m.sandbox.paypal.com/v2/customer/partner-referrals \
-H "Content-Type: application/json" \
-H "Authorization: Bearer Access-Token" \
-d '{
"individual_owners": [
{
"names": [
{
"prefix": "Mr.",
"given_name": "John",
"surname": "Doe",
"middle_name": "Middle",
"suffix": "Jr.",
"full_name": "John Middle Doe Jr.",
"type": "LEGAL"
}
],
"citizenship": "US",
"addresses": [
{
"address_line_1": "One Washington Square",
"address_line_2": "Apt 123",
"admin_area_2": "San Jose",
"admin_area_1": "CA",
"postal_code": "95112",
"country_code": "US",
"type": "HOME"
}
],
"phones": [
{
"country_code": "1",
"national_number": "6692468839",
"extension_number": "1234",
"type": "MOBILE"
}
],
"birth_details": {
"date_of_birth": "1955-12-29"
},
"type": "PRIMARY"
}
],
"business_entity": {
"business_type": {
"type": "INDIVIDUAL",
"subtype": "ASSO_TYPE_INCORPORATED"
},
"business_industry": {
"category": "1004",
"mcc_code": "2025",
"subcategory": "8931"
},
"business_incorporation": {
"incorporation_country_code": "US",
"incorporation_date": "1986-12-29"
},
"names": [
{
"business_name": "Test Enterprise",
"type": "LEGAL_NAME"
}
],
"emails": [
{
"type": "CUSTOMER_SERVICE",
"email": "customerservice@example.com"
}
],
"website": "https://mystore.testenterprises.com",
"addresses": [
{
"address_line_1": "One Washington Square",
"address_line_2": "Apt 123",
"admin_area_2": "San Jose",
"admin_area_1": "CA",
"postal_code": "95112",
"country_code": "US",
"type": "WORK"
}
],
"phones": [
{
"country_code": "1",
"national_number": "6692478833",
"extension_number": "1234",
"type": "CUSTOMER_SERVICE"
}
],
"beneficial_owners": {
"individual_beneficial_owners": [
{
"names": [
{
"prefix": "Mr.",
"given_name": "John",
"surname": "Doe",
"middle_name": "Middle",
"suffix": "Jr.",
"full_name": "John Middle Doe Jr.",
"type": "LEGAL"
}
],
"citizenship": "US",
"addresses": [
{
"address_line_1": "One Washington Square",
"address_line_2": "Apt 123",
"admin_area_2": "San Jose",
"admin_area_1": "CA",
"postal_code": "95112",
"country_code": "US",
"type": "HOME"
}
],
"phones": [
{
"country_code": "1",
"national_number": "6692468839",
"extension_number": "1234",
"type": "MOBILE"
}
],
"birth_details": {
"date_of_birth": "1955-12-29"
},
"percentage_of_ownership": "50"
}
],
"business_beneficial_owners": [
{
"business_type": {
"type": "INDIVIDUAL",
"subtype": "ASSO_TYPE_INCORPORATED"
},
"business_industry": {
"category": "1004",
"mcc_code": "2025",
"subcategory": "8931"
},
"business_incorporation": {
"incorporation_country_code": "US",
"incorporation_date": "1986-12-29"
},
"names": [
{
"business_name": "Test Enterprise",
"type": "LEGAL_NAME"
}
],
"emails": [
{
"type": "CUSTOMER_SERVICE",
"email": "customerservice@example.com"
}
],
"website": "https://mystore.testenterprises.com",
"addresses": [
{
"address_line_1": "One Washington Square",
"address_line_2": "Apt 123",
"admin_area_2": "San Jose",
"admin_area_1": "CA",
"postal_code": "95112",
"country_code": "US",
"type": "WORK"
}
],
"phones": [
{
"country_code": "1",
"national_number": "6692478833",
"extension_number": "1234",
"type": "CUSTOMER_SERVICE"
}
],
"percentage_of_ownership": "50"
}
]
},
"office_bearers": [
{
"names": [
{
"prefix": "Mr.",
"given_name": "John",
"surname": "Doe",
"middle_name": "Middle",
"suffix": "Jr.",
"full_name": "John Middle Doe Jr.",
"type": "LEGAL"
}
],
"citizenship": "US",
"addresses": [
{
"address_line_1": "One Washington Square",
"address_line_2": "Apt 123",
"admin_area_2": "San Jose",
"admin_area_1": "CA",
"postal_code": "95112",
"country_code": "US",
"type": "HOME"
}
],
"phones": [
{
"country_code": "1",
"national_number": "6692468839",
"extension_number": "1234",
"type": "MOBILE"
}
],
"birth_details": {
"date_of_birth": "1955-12-29"
},
"role": "DIRECTOR"
}
],
"annual_sales_volume_range": {
"minimum_amount": {
"currency_code": "USD",
"value": "10000"
},
"maximum_amount": {
"currency_code": "USD",
"value": "50000"
}
},
"average_monthly_volume_range": {
"minimum_amount": {
"currency_code": "USD",
"value": "1000"
},
"maximum_amount": {
"currency_code": "USD",
"value": "50000"
}
},
"purpose_code": "P0104"
},
"email": "accountemail@example.com",
"preferred_language_code": "en-US",
"tracking_id": "testenterprices123122",
"partner_config_override": {
"partner_logo_url": "https://www.paypalobjects.com/webstatic/mktg/logo/pp_cc_mark_111x69.jpg",
"return_url": "https://testenterprises.com/merchantonboarded",
"return_url_description": "the url to return the merchant after the paypal onboarding process.",
"action_renewal_url": "https://testenterprises.com/renew-exprired-url",
"show_add_credit_card": true
},
"operations": [
{
"operation": "BANK_ADDITION"
}
],
"financial_instruments": {
"banks": [
{
"nick_name": "Bank of America",
"account_number": "123405668293",
"account_type": "CHECKING",
"currency_code": "USD",
"identifiers": [
{
"type": "ROUTING_NUMBER_1",
"value": "123456789"
}
]
}
]
},
"legal_consents": [
{
"type": "SHARE_DATA_CONSENT",
"granted": true
}
],
"products": [
"EXPRESS_CHECKOUT"
]
}'
Response
201 Created
status code and a JSON response body that contains a HATEOAS link to show the referral data and an action_url
to which you redirect the customer in a browser to complete the signup process. The partner_referral_id
token is appended to the URL.links
array (contains the link_description object)
An array of request-related HATEOAS links.
Sample Response
{
"links": [
{
"href": "https://uri.paypal.com/v2/customer/partner-referrals/ZjcyODU4ZWYtYTA1OC00ODIwLTk2M2EtOTZkZWQ4NmQwYzI3RU12cE5xa0xMRmk1NWxFSVJIT1JlTFdSbElCbFU1Q3lhdGhESzVQcU9iRT0=",
"rel": "self",
"method": "GET"
},
{
"href": "https://www.paypal.com/merchantsignup/partner/onboardingentry?token=ZjcyODU4ZWYtYTA1OC00ODIwLTk2M2EtOTZkZWQ4NmQwYzI3RU12cE5xa0xMRmk1NWxFSVJIT1JlTFdSbElCbFU1Q3lhdGhESzVQcU9iRT0=",
"rel": "action_url",
"method": "GET"
}
]
}
Show referral data
Path parameters
partner_referral_id
string
required
The ID of the partner-referrals data for which to show details.
Sample Request
curl -v -X GET https://api-m.sandbox.paypal.com/v2/customer/partner-referrals/ZjcyODU4ZWYtYTA1OC00ODIwLTk2M2EtOTZkZWQ4NmQwYzI3RU12cE5xa0xMRmk1NWxFSVJIT1JlTFdSbElCbFU1Q3lhdGhESzVQcU9iRT0= \
-H "Content-Type: application/json" \
-H "Authorization: Bearer Access-Token"
Response
200 OK
status code and a JSON response body that shows referral data.links
array (contains the link_description object)
An array of request-related HATEOAS links.
partner_referral_id
string
The ID to access the customer's data shared by the partner with PayPal.
referral_data
The customer's referral data that partners share with PayPal.
submitter_payer_id
string
The payer ID of the partner who shared the referral data.
Sample Response
{
"partner_referral_id": "ZjcyODU4ZWYtYTA1OC00ODIwLTk2M2EtOTZkZWQ4NmQwYzI3RU12cE5xa0xMRmk1NWxFSVJIT1JlTFdSbElCbFU1Q3lhdGhESzVQcU9iRT0=",
"submitter_payer_id": "RFYUH2QQDGUQU",
"referral_data": {
"individual_owners": [
{
"names": [
{
"prefix": "Mr.",
"given_name": "John",
"surname": "Doe",
"middle_name": "Middle",
"suffix": "Jr.",
"full_name": "John Middle Doe Jr.",
"type": "LEGAL"
}
],
"citizenship": "US",
"addresses": [
{
"address_line_1": "One Washington Square",
"address_line_2": "Apt 123",
"admin_area_2": "San Jose",
"admin_area_1": "CA",
"postal_code": "95112",
"country_code": "US",
"type": "HOME"
}
],
"phones": [
{
"country_code": "1",
"national_number": "6692468839",
"extension_number": "1234",
"type": "MOBILE"
}
],
"birth_details": {
"date_of_birth": "1955-12-29"
},
"type": "PRIMARY"
}
],
"business_entity": {
"business_type": {
"type": "INDIVIDUAL",
"subtype": "ASSO_TYPE_INCORPORATED"
},
"business_industry": {
"category": "1004",
"mcc_code": "2025",
"subcategory": "8931"
},
"business_incorporation": {
"incorporation_country_code": "US",
"incorporation_date": "1986-12-29"
},
"names": [
{
"business_name": "Test Enterprise",
"type": "LEGAL_NAME"
}
],
"emails": [
{
"type": "CUSTOMER_SERVICE",
"email": "customerservice@example.com"
}
],
"website": "https://mystore.testenterprises.com",
"addresses": [
{
"address_line_1": "One Washington Square",
"address_line_2": "Apt 123",
"admin_area_2": "San Jose",
"admin_area_1": "CA",
"postal_code": "95112",
"country_code": "US",
"type": "WORK"
}
],
"phones": [
{
"country_code": "1",
"national_number": "6692478833",
"extension_number": "1234",
"type": "CUSTOMER_SERVICE"
}
],
"beneficial_owners": {
"individual_beneficial_owners": [
{
"names": [
{
"prefix": "Mr.",
"given_name": "John",
"surname": "Doe",
"middle_name": "Middle",
"suffix": "Jr.",
"full_name": "John Middle Doe Jr.",
"type": "LEGAL"
}
],
"citizenship": "US",
"addresses": [
{
"address_line_1": "One Washington Square",
"address_line_2": "Apt 123",
"admin_area_2": "San Jose",
"admin_area_1": "CA",
"postal_code": "95112",
"country_code": "US",
"type": "HOME"
}
],
"phones": [
{
"country_code": "1",
"national_number": "6692468839",
"extension_number": "1234",
"type": "MOBILE"
}
],
"birth_details": {
"date_of_birth": "1955-12-29"
},
"percentage_of_ownership": "50"
}
],
"business_beneficial_owners": [
{
"business_type": {
"type": "INDIVIDUAL",
"subtype": "ASSO_TYPE_INCORPORATED"
},
"business_industry": {
"category": "1004",
"mcc_code": "2025",
"subcategory": "8931"
},
"business_incorporation": {
"incorporation_country_code": "US",
"incorporation_date": "1986-12-29"
},
"names": [
{
"business_name": "Test Enterprise",
"type": "LEGAL_NAME"
}
],
"emails": [
{
"type": "CUSTOMER_SERVICE",
"email": "customerservice@example.com"
}
],
"website": "https://mystore.testenterprises.com",
"addresses": [
{
"address_line_1": "One Washington Square",
"address_line_2": "Apt 123",
"admin_area_2": "San Jose",
"admin_area_1": "CA",
"postal_code": "95112",
"country_code": "US",
"type": "WORK"
}
],
"phones": [
{
"country_code": "1",
"national_number": "6692478833",
"extension_number": "1234",
"type": "CUSTOMER_SERVICE"
}
],
"percentage_of_ownership": "50"
}
]
},
"office_bearers": [
{
"names": [
{
"prefix": "Mr.",
"given_name": "John",
"surname": "Doe",
"middle_name": "Middle",
"suffix": "Jr.",
"full_name": "John Middle Doe Jr.",
"type": "LEGAL"
}
],
"citizenship": "US",
"addresses": [
{
"address_line_1": "One Washington Square",
"address_line_2": "Apt 123",
"admin_area_2": "San Jose",
"admin_area_1": "CA",
"postal_code": "95112",
"country_code": "US",
"type": "HOME"
}
],
"phones": [
{
"country_code": "1",
"national_number": "6692468839",
"extension_number": "1234",
"type": "MOBILE"
}
],
"birth_details": {
"date_of_birth": "1955-12-29"
},
"role": "DIRECTOR"
}
],
"annual_sales_volume_range": {
"minimum_amount": {
"currency_code": "USD",
"value": "10000"
},
"maximum_amount": {
"currency_code": "USD",
"value": "50000"
}
},
"average_monthly_volume_range": {
"minimum_amount": {
"currency_code": "USD",
"value": "1000"
},
"maximum_amount": {
"currency_code": "USD",
"value": "50000"
}
},
"purpose_code": "P0104"
},
"email": "accountemail@example.com",
"preferred_language_code": "en-US",
"tracking_id": "testenterprices123122",
"partner_config_override": {
"partner_logo_url": "https://www.paypalobjects.com/webstatic/mktg/logo/pp_cc_mark_111x69.jpg",
"return_url": "https://testenterprises.com/merchantonboarded",
"return_url_description": "the url to return the merchant after the paypal onboarding process.",
"action_renewal_url": "https://testenterprises.com/renew-exprired-url",
"show_add_credit_card": true
},
"operations": [
{
"operation": "API_INTEGRATION",
"api_integration_preference": {
"classic_api_integration": {
"integration_type": "THIRD_PARTY",
"third_party_details": {
"permissions": [
"EXPRESS_CHECKOUT",
"REFUND",
"DIRECT_PAYMENT",
"AUTH_CAPTURE",
"BUTTON_MANAGER",
"ACCOUNT_BALANCE",
"TRANSACTION_DETAILS"
]
},
"first_party_details": "CERTIFICATE"
},
"rest_api_integration": {
"integration_method": "PAYPAL",
"integration_type": "THIRD_PARTY",
"third_party_details": {
"features": [
"PAYMENT",
"REFUND",
"PARTNER_FEE"
]
}
}
},
"billing_agreement": {
"description": "Billing Agreement Description Field",
"billing_experience_preference": {
"experience_id": "string",
"billing_context_set": true
},
"merchant_custom_data": "PatnerMERCHANT23124",
"approval_url": "wttps://www.paypal.com/agreements/approve?ba_token=BA-67944913LE886121E",
"ec_token": "EC-1S970363DB536864M"
}
}
],
"products": [
"EXPRESS_CHECKOUT"
],
"legal_consents": [
{
"type": "SHARE_DATA_CONSENT",
"granted": true
}
],
"payout_attributes": {
"marketplace": true,
"kyc_required": true,
"country_transfer_method_currency_selection": [
{
"country": "US",
"transfer_methods": [
{
"transfer_method_type": "BANK_ACCOUNT",
"currencies": [
"USD, CAD"
]
},
{
"transfer_method_type": "PAYPAL"
}
]
},
{
"country": "CA",
"transfer_methods": [
{
"transfer_method_type": "WIRE",
"currencies": [
"USD, CAD"
]
},
{
"transfer_method_type": "VENMO"
}
]
}
]
}
},
"links": [
{
"href": "https://uri.paypal.com/v2/customer/partner-referrals/ZjcyODU4ZWYtYTA1OC00ODIwLTk2M2EtOTZkZWQ4NmQwYzI3RU12cE5xa0xMRmk1NWxFSVJIT1JlTFdSbElCbFU1Q3lhdGhESzVQcU9iRT0=",
"rel": "self",
"method": "GET"
},
{
"href": "https://www.paypal.com/merchantsignup/partner/onboardingentry?token=ZjcyODU4ZWYtYTA1OC00ODIwLTk2M2EtOTZkZWQ4NmQwYzI3RU12cE5xa0xMRmk1NWxFSVJIT1JlTFdSbElCbFU1Q3lhdGhESzVQcU9iRT0=",
"rel": "action_url",
"method": "GET"
}
]
}
Common object definitions
account
business_entity
Business entity of the account.
individual_owners
array (contains the individual_owner object)
List of owners in the account. There should be only one primary account owner which is mentioned in their role_type.
address_details
building_name
string
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
.delivery_service
string
The delivery service. Post office box, bag number, or post office name.
street_name
string
The street name. Just
Drury
inDrury Lane
.street_number
string
The street number.
street_type
string
The street type. For example, avenue, boulevard, road, or expressway.
sub_building
string
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.
address_portable
The two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is
GB
and notUK
as used in the top-level domain names for that country. Use theC2
country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.address_details
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 ofaddress_details.street_number
,street_name
, andstreet_type
.address_line_1
string
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.address_line_2
string
The second line of the address. For example, suite or apartment number.
address_line_3
string
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.admin_area_1
string
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 notCalifornia
. Value, by country, is:- UK. A county.
- US. A state.
- Canada. A province.
- Japan. A prefecture.
- Switzerland. A kanton.
admin_area_2
string
A city, town, or village. Smaller than
admin_area_level_1
.admin_area_3
string
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.
admin_area_4
string
The neighborhood, ward, or district. Smaller than
admin_area_level_3
orsub_locality
. Value is:- The postal sorting code for Guernsey and many French territories, such as French Guiana.
- The fine-grained administrative levels in China.
postal_code
string
The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.
address_portable
The two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is
GB
and notUK
as used in the top-level domain names for that country. Use theC2
country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.address_details
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 ofaddress_details.street_number
,street_name
, andstreet_type
.address_line_1
string
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.address_line_2
string
The second line of the address. For example, suite or apartment number.
address_line_3
string
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.admin_area_1
string
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 notCalifornia
. Value, by country, is:- UK. A county.
- US. A state.
- Canada. A province.
- Japan. A prefecture.
- Switzerland. A kanton.
admin_area_2
string
A city, town, or village. Smaller than
admin_area_level_1
.admin_area_3
string
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.
admin_area_4
string
The neighborhood, ward, or district. Smaller than
admin_area_level_3
orsub_locality
. Value is:- The postal sorting code for Guernsey and many French territories, such as French Guiana.
- The fine-grained administrative levels in China.
postal_code
string
The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.
address_portable_postal_code_validation
address_portable_postal_code_validation
address_portable_postal_code_validation
address_portable_postal_code_validation
beneficial_owners
business_beneficial_owners
array (contains the business_beneficial_owner object)
Business beneficial owners.
individual_beneficial_owners
array (contains the individual_beneficial_owner object)
Individual beneficial owners.
billing_agreement
approval_url
string
The URL to which to redirect seller to accept the billing agreement.
billing_experience_preference
The preference that customizes the billing experience of the customer.
description
string
The billing agreement description.
ec_token
string
The billing agreement token for the agreement.
merchant_custom_data
string
The custom data for the billing agreement.
billing_experience_preference
billing_context_set
boolean
Indicates whether the partner has already displayed the billing context to the seller.
experience_id
string
The ID of the payment web experience profile.
birth_details
date of birth, fomrat Internet date and time format.
business
addresses
array (contains the business_address_detail object)
List of addresses associated with the business entity.
business_incorporation
Information related to the business like the nature of business, started date etc.
business_industry
Information related to the business like the nature of business, started date etc.
business_type
Information related to the business like the nature of business, started date etc.
documents
array (contains the business_document object)
Business Party related Document data collected from the customer.. For example SSN, ITIN, Business registration number that were collected from the user.
emails
array (contains the email object)
Email addresses of the business.
names
array (contains the business_name_detail object)
Name of the business.
phones
array (contains the business_phone_detail object)
List of phone number associated with the business.
website
string
Website of the business.
business_address_detail
The two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is
GB
and notUK
as used in the top-level domain names for that country. Use theC2
country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.address_details
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 ofaddress_details.street_number
,street_name
, andstreet_type
.address_line_1
string
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.address_line_2
string
The second line of the address. For example, suite or apartment number.
address_line_3
string
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.admin_area_1
string
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 notCalifornia
. Value, by country, is:- UK. A county.
- US. A state.
- Canada. A province.
- Japan. A prefecture.
- Switzerland. A kanton.
admin_area_2
string
A city, town, or village. Smaller than
admin_area_level_1
.admin_area_3
string
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.
admin_area_4
string
The neighborhood, ward, or district. Smaller than
admin_area_level_3
orsub_locality
. Value is:- The postal sorting code for Guernsey and many French territories, such as French Guiana.
- The fine-grained administrative levels in China.
postal_code
string
The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.
inactive
boolean
Whether this address has been inactivated.
primary
boolean
Whether this is the primary address of the user. This cannot be directly set to
false
, but rather it is toggledfalse
in the datastore when another address is set to primary.type
The address type under which this is classified. For example, shipping or dropoff.
business_address_detail
The two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is
GB
and notUK
as used in the top-level domain names for that country. Use theC2
country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.address_line_1
string
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.address_line_2
string
The second line of the address. For example, suite or apartment number.
admin_area_1
string
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 notCalifornia
. Value, by country, is:- UK. A county.
- US. A state.
- Canada. A province.
- Japan. A prefecture.
- Switzerland. A kanton.
admin_area_2
string
A city, town, or village. Smaller than
admin_area_level_1
.postal_code
string
The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.
type
The address type under which this is classified. For example, shipping or dropoff.
business_address_type
business_address_type
enum
Address type under which the provided address is tagged
The possible values are:
WORK
. The address of the business.
business_beneficial_owner
addresses
array (contains the business_address_detail object)
List of addresses associated with the business entity.
business_incorporation
Information related to the business like the nature of business, started date etc.
business_industry
Information related to the business like the nature of business, started date etc.
business_type
Information related to the business like the nature of business, started date etc.
documents
array (contains the business_document object)
Business Party related Document data collected from the customer.. For example SSN, ITIN, Business registration number that were collected from the user.
emails
array (contains the email object)
Email addresses of the business.
names
array (contains the business_name_detail object)
Name of the business.
phones
array (contains the business_phone_detail object)
List of phone number associated with the business.
website
string
Website of the business.
percentage_of_ownership
The percentage of shares this person owns in the company.
business_beneficial_owner
addresses
array (contains the business_address_detail object)
List of addresses associated with the business entity.
business_incorporation
Information related to the business like the nature of business, started date etc.
business_industry
Information related to the business like the nature of business, started date etc.
business_type
Information related to the business like the nature of business, started date etc.
emails
array (contains the email object)
Email addresses of the business.
names
array (contains the business_name_detail object)
Name of the business.
phones
array (contains the business_phone_detail object)
List of phone number associated with the business.
website
string
Website of the business.
percentage_of_ownership
The percentage of shares this person owns in the company.
business_document
expiry_date
The expire data of the document.
files
array (contains the file_reference object)
The files contained in the document. For example, a document could be represented by a front page file and a back page file, etc.
id
string
The encrypted identifier for the document.
identification_number
string
The number for the document. It is the ID number if the document is
ID CARD
, the passport number if the document isPASSPORT
, etc.issue_date
The issue date of the document.
issuing_country_code
The country code of the document.
labels
array (contains the labels object)
The document labels. A document could be classfied to multiple categories. For example, a bill document can be classfified as
BILL DOCUMENT
andUTILITY DOCUMENT
.links
array (contains the link_description object)
The HATEOAS links.
name
string
The file name.
type
The actual type of the document.
business_document_type
business_document_type
enum
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.
business_entity
addresses
array (contains the business_address_detail object)
List of addresses associated with the business entity.
business_incorporation
Information related to the business like the nature of business, started date etc.
business_industry
Information related to the business like the nature of business, started date etc.
business_type
Information related to the business like the nature of business, started date etc.
documents
array (contains the business_document object)
Business Party related Document data collected from the customer.. For example SSN, ITIN, Business registration number that were collected from the user.
emails
array (contains the email object)
Email addresses of the business.
names
array (contains the business_name_detail object)
Name of the business.
phones
array (contains the business_phone_detail object)
List of phone number associated with the business.
website
string
Website of the business.
annual_sales_volume_range
The range for the total annual sales volume of the business.
average_monthly_volume_range
The range for the average monthly volume of the business.
beneficial_owners
List of beneficial owners part of the entity. They can be either a Person or a business entity.
business_description
string
The business goals description. For example, a mission statement.
office_bearers
array (contains the office_bearer object)
List of Directors present as part of the business entity.
purpose_code
(contains the purpose_code object)
The account's purpose code.
business_industry
category
string
required
The customer's business category code. PayPal uses industry standard seller category codes.
mcc_code
string
required
The customer's business seller category code. PayPal uses industry standard seller category codes.
subcategory
string
required
The customer's business subcategory code. PayPal uses industry standard seller subcategory codes.
business_name
business_name
string
Required. The business name of the party.
business_name_detail
business_name
string
Required. The business name of the party.
id
string
The encrypted ID for the business name.
type
The type of business name. For example, trading name.
business_name_detail
business_name
string
Required. The business name of the party.
type
The type of business name. For example, trading name.
business_name_type
business_name_type
enum
Business name type
The possible values are:
DOING_BUSINESS_AS
. The trading name of the business.LEGAL_NAME
. The legal name of the business.
business_name_validation
business_name_validation
business_phone_detail
country_code
string
required
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_number
string
required
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_number
string
The extension number.
contact_name
string
The name that the phone number is connected to.
inactive
boolean
Whether this phone number has been inactivated by the user.
primary
boolean
Whether this is the primary contact phone number of the user.
tags
array (contains the phone_number_tag object)
Array of tags for this phone number.
type
The type of phone number provided. For example, home, work, or mobile.
business_phone_detail
country_code
string
required
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_number
string
required
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_number
string
The extension number.
type
The type of phone number provided. For example, home, work, or mobile.
business_phone_type
business_phone_type
enum
The type of phone number provided. For example, home, work, or mobile.
The possible values are:
CUSTOMER_SERVICE
. The customer service phone number.
business_sub_type
business_sub_type
enum
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.
business_type
business_type
enum
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.
business_type_info
subtype
enum
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
enum
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.
country_code
country_code
string
The two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is
GB
and notUK
as used in the top-level domain names for that country. Use theC2
country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
country_code
country_code
string
The two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is
GB
and notUK
as used in the top-level domain names for that country. Use theC2
country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
create_referral_data_response
links
array (contains the link_description object)
An array of request-related HATEOAS links.
currency_code
currency_code
string
The three-character ISO-4217 currency code that identifies the currency.
currency_code
currency_code
string
The three-character ISO-4217 currency code that identifies the currency.
date_no_time
date_no_time
string
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.
date_time
date_time
string
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.
document
expiry_date
The expire data of the document.
files
array (contains the file_reference object)
The files contained in the document. For example, a document could be represented by a front page file and a back page file, etc.
id
string
The encrypted identifier for the document.
identification_number
string
The number for the document. It is the ID number if the document is
ID CARD
, the passport number if the document isPASSPORT
, etc.issue_date
The issue date of the document.
issuing_country_code
The country code of the document.
labels
array (contains the labels object)
The document labels. A document could be classfied to multiple categories. For example, a bill document can be classfified as
BILL DOCUMENT
andUTILITY DOCUMENT
.links
array (contains the link_description object)
The HATEOAS links.
name
string
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.type
enum
required
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.type
enum
required
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.
email_address
email_address
string
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.
email_address
email_address
string
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.
error
debug_id
string
required
The PayPal internal ID. Used for correlation purposes.
message
string
required
The message that describes the error.
name
string
required
The human-readable, unique name of the error.
details
array (contains the error_details object)
An array of additional details about the error.
information_link
string
The information link, or URI, that shows detailed information about this error for the developer.
links
array (contains the link_description object)
An array of request-related HATEOAS links.
error_details
issue
string
required
The unique, fine-grained application-level error code.
description
string
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.
field
string
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.
location
string
The location of the field that caused the error. Value is
body
,path
, orquery
.value
string
The value of the field that caused the error.
file_reference
content_type
string
create_time
The date and time when the file was created, in Internet date and time format.
id
string
The ID of the referenced file.
reference_url
string
The reference URL for the file.
size
string
The size of the file, in bytes.
first_party_details
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.
seller_nonce
string
required
S256 - The code verifier must be high-entropy cryptographic random string with a byte length of 43-128 range.
individual_beneficial_owner
addresses
array (contains the person_address_detail object)
The list of addresses associated with the person.
birth_details
The person's birth details.
citizenship
The citizenship country code of the person.
documents
array (contains the person_document object)
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.
id
string
The encrypted party ID.
names
array (contains the person_name object)
The name of the person.
phones
array (contains the person_phone_detail object)
The list of phone numbers associated with the person.
percentage_of_ownership
The percentage of shares this person owns in the company.
individual_beneficial_owner
addresses
array (contains the person_address_detail object)
The list of addresses associated with the person.
birth_details
The person's birth details.
citizenship
The citizenship country code of the person.
names
array (contains the person_name object)
The name of the person.
phones
array (contains the person_phone_detail object)
The list of phone numbers associated with the person.
percentage_of_ownership
The percentage of shares this person owns in the company.
individual_owner
addresses
array (contains the person_address_detail object)
The list of addresses associated with the person.
birth_details
The person's birth details.
citizenship
The citizenship country code of the person.
documents
array (contains the person_document object)
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.
id
string
The encrypted party ID.
names
array (contains the person_name object)
The name of the person.
phones
array (contains the person_phone_detail object)
The list of phone numbers associated with the person.
type
The actual role of this user on the account, PRIMARY/SECONDARY.
individual_owner
addresses
array (contains the person_address_detail object)
The list of addresses associated with the person.
birth_details
The person's birth details.
citizenship
The citizenship country code of the person.
documents
array (contains the person_document object)
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.
names
array (contains the person_name object)
The name of the person.
phones
array (contains the person_phone_detail object)
The list of phone numbers associated with the person.
type
The actual role of this user on the account, PRIMARY/SECONDARY.
individual_owner_type
individual_owner_type
enum
Role of the person party played in the account.
The possible values are:
PRIMARY
. Primary account holder.
labels
labels
string
A document label.
language
language
string
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.
legal_consent
granted
boolean
required
Indicates whether the customer agreed to share this type of data. To give consent, specify
true
. To withhold consent, specifyfalse
.type
enum
required
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.
link_description
href
string
required
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. Thehref
is the key HATEOAS component that links a completed call with a subsequent call.rel
string
required
The link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.
method
enum
The HTTP method required to make the related call.
link_description
href
string
required
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. Thehref
is the key HATEOAS component that links a completed call with a subsequent call.rel
string
required
The link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.
method
enum
The HTTP method required to make the related call.
link_description
href
string
required
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. Thehref
is the key HATEOAS component that links a completed call with a subsequent call.rel
string
required
The link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.
method
enum
The HTTP method required to make the related call.
link_description
href
string
required
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. Thehref
is the key HATEOAS component that links a completed call with a subsequent call.rel
string
required
The link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.
method
enum
The HTTP method required to make the related call.
link_description
href
string
required
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. Thehref
is the key HATEOAS component that links a completed call with a subsequent call.rel
string
required
The link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.
method
enum
The HTTP method required to make the related call.
money
The three-character ISO-4217 currency code that identifies the currency.
value
string
required
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.
- An integer for currencies like
name
full_name
string
When the party is a person, the party's full name.
given_name
string
When the party is a person, the party's given, or first, name.
middle_name
string
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.
prefix
string
The prefix, or title, to the party's name.
suffix
string
The suffix for the party's name.
surname
string
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.
name_validation
name_validation
office_bearer
addresses
array (contains the person_address_detail object)
The list of addresses associated with the person.
birth_details
The person's birth details.
citizenship
The citizenship country code of the person.
documents
array (contains the person_document object)
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.
id
string
The encrypted party ID.
names
array (contains the person_name object)
The name of the person.
phones
array (contains the person_phone_detail object)
The list of phone numbers associated with the person.
role
The role of the office bearer in the company.
office_bearer
addresses
array (contains the person_address_detail object)
The list of addresses associated with the person.
birth_details
The person's birth details.
citizenship
The citizenship country code of the person.
documents
array (contains the person_document object)
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.
names
array (contains the person_name object)
The name of the person.
phones
array (contains the person_phone_detail object)
The list of phone numbers associated with the person.
role
The role of the office bearer in the company.
office_bearer_role
office_bearer_role
enum
Role of the person party played in the business.
The possible values are:
CEO
. The ceo.CHAIRMAN
. The chairman.DIRECTOR
. Director of the businessSECRETARY
. The secretary.TREASURER
. The treasurer.TRUSTEE
. The trustee.
operation
api_integration_preference
The integration details for the partner and customer relationship. Required if
operation
isAPI_INTEGRATION
.billing_agreement
The details of the billing agreement between the partner and a seller.
operation
enum
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.
partner_configuration_override
action_renewal_url
string
If
renew_action_url
expires, redirect the customer to this URL.partner_logo_url
string
The partner logo URL to display in the customer's onboarding flow.
return_url
string
The URL to which to redirect the customer upon completion of the onboarding process.
return_url_description
string
The description of the return URL.
show_add_credit_card
boolean
Indicates whether to show an add credit card page.
percentage
percentage
string
The percentage, as a fixed-point, signed decimal number. For example, define a 19.99% interest rate as
19.99
.
person
addresses
array (contains the person_address_detail object)
The list of addresses associated with the person.
birth_details
The person's birth details.
citizenship
The citizenship country code of the person.
documents
array (contains the person_document object)
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.
id
string
The encrypted party ID.
names
array (contains the person_name object)
The name of the person.
phones
array (contains the person_phone_detail object)
The list of phone numbers associated with the person.
person_address_detail
The two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is
GB
and notUK
as used in the top-level domain names for that country. Use theC2
country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.address_details
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 ofaddress_details.street_number
,street_name
, andstreet_type
.address_line_1
string
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.address_line_2
string
The second line of the address. For example, suite or apartment number.
address_line_3
string
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.admin_area_1
string
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 notCalifornia
. Value, by country, is:- UK. A county.
- US. A state.
- Canada. A province.
- Japan. A prefecture.
- Switzerland. A kanton.
admin_area_2
string
A city, town, or village. Smaller than
admin_area_level_1
.admin_area_3
string
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.
admin_area_4
string
The neighborhood, ward, or district. Smaller than
admin_area_level_3
orsub_locality
. Value is:- The postal sorting code for Guernsey and many French territories, such as French Guiana.
- The fine-grained administrative levels in China.
postal_code
string
The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.
inactive
boolean
Whether this address has been inactivated.
primary
boolean
Whether this is the primary address of the user. This cannot be directly set to
false
, but rather it is toggledfalse
in the datastore when another address is set to primary.type
The address type under which this is classified.
person_address_detail
The two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is
GB
and notUK
as used in the top-level domain names for that country. Use theC2
country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.address_line_1
string
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.address_line_2
string
The second line of the address. For example, suite or apartment number.
admin_area_1
string
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 notCalifornia
. Value, by country, is:- UK. A county.
- US. A state.
- Canada. A province.
- Japan. A prefecture.
- Switzerland. A kanton.
admin_area_2
string
A city, town, or village. Smaller than
admin_area_level_1
.postal_code
string
The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.
type
The address type under which this is classified.
person_address_detail
The two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is
GB
and notUK
as used in the top-level domain names for that country. Use theC2
country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.address_line_1
string
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.address_line_2
string
The second line of the address. For example, suite or apartment number.
admin_area_1
string
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 notCalifornia
. Value, by country, is:- UK. A county.
- US. A state.
- Canada. A province.
- Japan. A prefecture.
- Switzerland. A kanton.
admin_area_2
string
A city, town, or village. Smaller than
admin_area_level_1
.postal_code
string
The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.
type
The address type under which this is classified.
person_address_type
person_address_type
enum
The address type under which the provided address is tagged.
The possible values are:
HOME
. The home address of the customer.
person_document
expiry_date
The expire data of the document.
files
array (contains the file_reference object)
The files contained in the document. For example, a document could be represented by a front page file and a back page file, etc.
id
string
The encrypted identifier for the document.
identification_number
string
The number for the document. It is the ID number if the document is
ID CARD
, the passport number if the document isPASSPORT
, etc.issue_date
The issue date of the document.
issuing_country_code
The country code of the document.
labels
array (contains the labels object)
The document labels. A document could be classfied to multiple categories. For example, a bill document can be classfified as
BILL DOCUMENT
andUTILITY DOCUMENT
.links
array (contains the link_description object)
The HATEOAS links.
name
string
The file name.
type
The actual type of the document. It could be
ID_CARD
,PASSPORT
, etc.
person_document
identification_number
string
The number for the document. It is the ID number if the document is
ID CARD
, the passport number if the document isPASSPORT
, etc.issuing_country_code
The country code of the document.
type
The actual type of the document. It could be
ID_CARD
,PASSPORT
, etc.
person_document
identification_number
string
The number for the document. It is the ID number if the document is
ID CARD
, the passport number if the document isPASSPORT
, etc.issuing_country_code
The country code of the document.
type
The actual type of the document. It could be
ID_CARD
,PASSPORT
, etc.
person_document_type
person_document_type
enum
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.
person_name
full_name
string
When the party is a person, the party's full name.
given_name
string
When the party is a person, the party's given, or first, name.
middle_name
string
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.
prefix
string
The prefix, or title, to the party's name.
suffix
string
The suffix for the party's name.
surname
string
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.
type
The type of name. Currently supported values are:
LEGAL
.
person_name
full_name
string
When the party is a person, the party's full name.
given_name
string
When the party is a person, the party's given, or first, name.
middle_name
string
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.
prefix
string
The prefix, or title, to the party's name.
suffix
string
The suffix for the party's name.
surname
string
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.
type
The type of name. Currently supported values are:
LEGAL
.
person_name
full_name
string
When the party is a person, the party's full name.
given_name
string
When the party is a person, the party's given, or first, name.
middle_name
string
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.
prefix
string
The prefix, or title, to the party's name.
suffix
string
The suffix for the party's name.
surname
string
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.
type
The type of name. Currently supported values are:
LEGAL
.
person_name_type
person_name_type
enum
The person's name type.
The possible values are:
LEGAL
. Indicates that this name is the legal name of the user.
person_phone_detail
country_code
string
required
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_number
string
required
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_number
string
The extension number.
contact_name
string
The name that the phone number is connected to.
inactive
boolean
Whether this phone number has been inactivated by the user.
primary
boolean
Whether this is the primary contact phone number of the user.
primary_mobile
boolean
Whether this is the primary mobile phone number of the user.
tags
array (contains the phone_number_tag object)
Array of tags for this phone number.
type
The type of phone number provided. For example, home, work, or mobile.
person_phone_detail
country_code
string
required
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_number
string
required
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_number
string
The extension number.
type
The type of phone number provided. For example, home, work, or mobile.
person_phone_detail
country_code
string
required
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_number
string
required
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_number
string
The extension number.
type
The type of phone number provided. For example, home, work, or mobile.
phone
country_code
string
required
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_number
string
required
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_number
string
The extension number.
phone_number_tag
phone_number_tag
enum
Tag associated with the phone number.
The possible values are:
MOBILE
. The mobile telephone number.LANDLINE
. The landline telephone number.
phone_type
phone_type
enum
The phone type.
The possible values are:
FAX
. A fax machine.HOME
. A home phone.MOBILE
. A mobile phone.OTHER
. Other.PAGER
. A pager.
product_name
product_name
enum
The PayPal product for which the customer is onboarded.
The possible values are:
EXPRESS_CHECKOUT
. Express checkout productPPPLUS
. PayPal PLUS product.WEBSITE_PAYMENT_PRO
. PayPal Professional productPPCP
. PayPal Complete Payments product
purpose_code
purpose_code
enum
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.
referral_data
business_entity
Business entity of the account.
individual_owners
array (contains the individual_owner object)
List of owners in the account. There should be only one primary account owner which is mentioned in their role_type.
email
Email address of the customer used to create the account.
financial_instruments
Array of financial instruments attached to the customer's account.
legal_consents
array (contains the legal_consent object)
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.operations
array (contains the operation object)
An array of operations to perform for the customer while they share their data.
partner_config_override
The configuration property that the partner intends to override for this onboarding request.
payout_attributes
Payout specific attributes.
preferred_language_code
The preferred locale code to use in the onboarding flow for the customer.
products
array (contains the product_name object)
An array of PayPal products to which the partner wants to onboard the customer.
tracking_id
string
The partner's unique identifier for this customer in their system which can be used to track user in PayPal.
referral_data-bank
account_number
string
required
The bank account number.
account_type
enum
required
The type of bank account.
The possible values are:
CHECKING
. Checking account.SAVINGS
. Savings account.
branch_location
The branch location, if applicable.
currency_code
The primary currency code of the bank account.
identifiers
array (contains the referral_data-identifier object)
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
Mandate for this bank account.
nick_name
string
The user-provided short name for the user's bank account.
referral_data-bank.address_portable
The two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is
GB
and notUK
as used in the top-level domain names for that country. Use theC2
country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.address_line_1
string
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.address_line_2
string
The second line of the address. For example, suite or apartment number.
admin_area_1
string
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 notCalifornia
. Value, by country, is:- UK. A county.
- US. A state.
- Canada. A province.
- Japan. A prefecture.
- Switzerland. A kanton.
admin_area_2
string
A city, town, or village. Smaller than
admin_area_level_1
.postal_code
string
The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.
referral_data-classic_api_integration
referral_data-country_transfer_method_currency_selection
country
string (contains the country_code object)
Country.
transfer_methods
array (contains the referral_data-transfer_method object)
Requested transfer method and currency for a country.
referral_data-financial_instruments
banks
array (contains the referral_data-bank object)
An array of banks attached to this managed account.
referral_data-identifier
type
enum
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.
value
string
The value of account identifier.
referral_data-mandate
accepted
boolean
required
Whether mandate was accepted or not.
referral_data-payout_attributes
country_transfer_method_currency_selection
array (contains the referral_data-country_transfer_method_currency_selection object)
Requested country, transfer method and currency.
kyc_required
boolean
If
true
, specifies that the Kyc is required for the merchant.marketplace
boolean
If
true
, specifies that the merchant or platform is offering goods or services on behalf of 3rd party sellers.
referral_data-rest_api_integration
first_party_details
The integration details for PayPal first party REST endpoints.
integration_method
enum
The REST-credential integration method.
The possible values are:
BRAINTREE
. Braintree integration method.PAYPAL
. PayPal integration method.
integration_type
enum
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.
third_party_details
The integration details for PayPal REST endpoints.
referral_data-transfer_method
currencies
array (contains the currency_code object)
Requested Currencies for a Transfer Method.
transfer_method_type
enum
Transfer Method type.
The possible values are:
BANK_ACCOUNT
. Transfer method type- Bank AccountPAYPAL
. Transfer method type- Bank AccountVENMO
. Transfer method type- Bank AccountWIRE_ACCOUNT
. Transfer method type- Bank Account
referral_data_response
links
array (contains the link_description object)
An array of request-related HATEOAS links.
partner_referral_id
string
The ID to access the customer's data shared by the partner with PayPal.
referral_data
The customer's referral data that partners share with PayPal.
submitter_payer_id
string
The payer ID of the partner who shared the referral data.
rest_endpoint_feature
rest_endpoint_feature
enum
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.
third_party_details
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.