Partner Referrals (1)

API Version v1

Deprecation notice: This integration method is deprecated. PayPal continues to support existing merchants using this method, but be advised that new features and enhancements will not be applied to these integrations. For details, see Onboard Sellers.

Partners can use the Partner Referrals API to add PayPal seller accounts using the before payment onboarding model. With this API, you collect seller data and pass it to the account creation and setup forms, reducing the burden on sellers during the signup and setup process.

Create partner referral

post/v1/customer/partner-referrals

Creates a partner referral that is shared by the API caller. The referrals contains the client's personal, business, and financial data.

SecurityOauth2

Request

Request Body schema:
application/json
required

	Array of objects (capability) An array of capabilities to enable for the customer while he or she shares the data.
	Array of objects (legal_consent) 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.
products	Array of strings (product_name) An array of PayPal products to which the partner wants to onboard the customer. Items Enum: "EXPRESS_CHECKOUT" "PPPLUS" "WP_PRO" "PPCP" "PAYMENT_METHODS" "ADVANCED_VAULTING"
	object (user) The customer's business and personal data that is required to create an account.
	object (web_experience_preference) The preference to customize the web experience of the customer.

Responses

201

A successful request returns the HTTP 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.

Request samples

Payload
cURL
Node.js
Java
Python

{"customer_data": {"customer_type": "MERCHANT",
"person_details": {"email_address": "[email protected]",
"name": {"prefix": "Mr.",
"given_name": "Shashank",
"surname": "Wankhede",
"middle_name": "Govind"
},
"phone_contacts": [{"phone_number_details": {"country_code": "91",
"national_number": "9740216087"
},
"phone_type": "HOME"
}
],
"home_address": {"line1": "11, outer ring road",
"state": "Karnataka",
"city": "Bangalore",
"country_code": "IN",
"postal_code": "560103"
},
"date_of_birth": {"event_type": "BIRTH",
"event_date": "1987-12-29T23:59:59.999Z"
},
"nationality_country_code": "IN",
"identity_documents": [{"type": "SOCIAL_SECURITY_NUMBER",
"value": "ABCDEF34646",
"partial_value": false,
"issuer_country_code": "US"
}
]
},
"business_details": {"phone_contacts": [{"phone_number_details": {"country_code": "91",
"national_number": "9740216087"
},
"phone_type": "FAX"
}
],
"business_address": {"line1": "11, outer ring road",
"state": "Karnataka",
"city": "Bangalore",
"country_code": "IN",
"postal_code": "560103"
},
"business_type": "PROPRIETORSHIP",
"category": "1004",
"sub_category": "2025",
"merchant_category_code": "8931",
"names": [{"type": "LEGAL",
"name": "SHASHANK STORE"
}
],
"business_description": "Arts and handicrafts",
"event_dates": [{"event_type": "ESTABLISHED",
"event_date": "2009-01-31T13:59:45Z"
}
],
"website_urls": ["https://example.com/mystore/"
],
"annual_sales_volume_range": {"minimum_amount": {"currency": "USD",
"value": "2000"
},
"maximum_amount": {"currency": "USD",
"value": "3000"
}
},
"average_monthly_volume_range": { },
"identity_documents": [{"type": "TAX_IDENTIFICATION_NUMBER",
"value": "ABCDEF34646",
"partial_value": false,
"issuer_country_code": "US"
}
],
"email_contacts": [{"email_address": "[email protected]",
"role": "CUSTOMER_SERVICE"
}
]
},
"financial_instrument_data": { },
"preferred_language_code": "en_US",
"primary_currency_code": "USD",
"referral_user_payer_id": {"type": "PAYER_ID",
"value": "RFYUH2QQDGUQU"
},
"partner_specific_identifiers": [{"type": "TRACKING_ID",
"value": "ABJSDFO343SD"
}
]
},
"requested_capabilities": [{"capability": "API_INTEGRATION",
"api_integration_preference": {"partner_id": "RFYUH2QQDGUQU",
"classic_api_integration_type": "THIRD_PARTY",
"classic_third_party_details": {"permission_list": ["EXPRESS_CHECKOUT",
"DIRECT_PAYMENT",
"AUTH_CAPTURE",
"BUTTON_MANAGER"
]
}
}
},
{"capability": "BANK_ADDITION"
}
],
"web_experience_preference": {"partner_logo_url": "https://example.com/logo/",
"return_url": "https://example.com/",
"action_renewal_url": "https://example.com/renew/"
},
"collected_consents": [{"type": "SHARE_DATA_CONSENT",
"granted": true
}
],
"products": ["EXPRESS_CHECKOUT"
]
}

Response samples

application/json

{"links": [{"href": "https://uri.paypal.com/v1/customer/partner-referrals/ZjcyODU4ZWYtYTA1OC00ODIwLTk2M2EtOTZkZWQ4NmQwYzI3RU12cE5xa0xMRmk1NWxFSVJIT1JlTFdSbElCbFU1Q3lhdGhESzVQcU9iRT0=",
"rel": "self",
"method": "GET",
"description": "The read referral data shared by the partner."
},
{"href": "https://www.paypal.com/merchantsignup/partner/onboardingentry?token=ZjcyODU4ZWYtYTA1OC00ODIwLTk2M2EtOTZkZWQ4NmQwYzI3RU12cE5xa0xMRmk1NWxFSVJIT1JlTFdSbElCbFU1Q3lhdGhESzVQcU9iRT0=",
"rel": "action_url",
"method": "GET",
"description": "The target web redirect URL for the next action."
}
]
}

Show referral data

get/v1/customer/partner-referrals/{partner_referral_id}

Shows details for referral data, by ID, that was shared by the API caller.

SecurityOauth2

Request

path Parameters

partner_referral_id

required

string

The ID of the partner-referrals data for which to show details.

Responses

200

A successful request returns the HTTP 200 OK status code and a JSON response body that shows referral data.

Request samples

cURL
Node.js
Java
Python

Response samples

application/json

{"partner_referral_id": "YWU0MGFiYTctZTNiNC00MmMzLWJiMzUtZTI2MDMzZDViM2Y0dmdkb0twTmt2NC9GSllvL2NLT3BBVTV6bk90MlBXdzRwQVpsek5mcG5QVT12Mg==",
"links": [{"href": "https://te-tscp-fb-dev.qa.paypal.com:15293/v1/customer/partner-referrals/YWU0MGFiYTctZTNiNC00MmMzLWJiMzUtZTI2MDMzZDViM2Y0dmdkb0twTmt2NC9GSllvL2NLT3BBVTV6bk90MlBXdzRwQVpsek5mcG5QVT12Mg==",
"rel": "self",
"method": "GET"
}
],
"submitter_payer_id": "LRB56X79RX58Y",
"referral_data": {"customer_data": {"business_details": {"business_type": "PARTNERSHIP",
"merchant_category_code": "1750",
"event_dates": [{"event_type": "ESTABLISHED",
"event_date": "2019-01-01"
}
],
"country_of_incorporation": "C2",
"names": [{"name": "测试LEGAL name",
"type": "LEGAL"
},
{"name": "测试DBA name",
"type": "DOING_BUSINESS_AS"
}
],
"email_contacts": [{"role": "CUSTOMER_SERVICE",
"email_address": "[email protected]"
}
],
"identity_documents": [{"type": "BUSINESS_REGISTRATION",
"value": "123456789012345678",
"partial_value": false,
"issuer_country_code": "C2"
}
],
"business_address": {"country_code": "C2",
"state": "BEIJING",
"city": "Haidian",
"line1": "xituchenglu",
"line2": "xituchenglu NO. 10"
},
"average_monthly_volume_range": {"minimum_amount": {"currency": "USD",
"value": "1000"
},
"maximum_amount": {"currency": "USD",
"value": "2000"
}
}
},
"person_details": {"name": {"given_name": "五",
"surname": "王",
"full_name": "王五"
},
"home_address": {"country_code": "C2",
"state": "BEIJING",
"city": "chaoyang",
"line1": "dawanglu",
"line2": "zhengdazhongxin"
},
"identity_documents": [{"value": "1234568909837811233",
"issuer_country_code": "C2",
"partial_value": false,
"type": "NATIONAL_ID_CARD"
}
],
"date_of_birth": {"event_type": "BIRTH",
"event_date": "1990-12-29"
},
"nationality_country_code": "C2",
"email_address": "[email protected]"
},
"partner_specific_identifiers": [{"type": "TRACKING_ID",
"value": "thisisatestid1719544350"
}
],
"customer_type": "MERCHANT",
"referral_user_payer_id": {"type": "PAYER_ID",
"value": "LRB56X79RX58Y"
}
},
"requested_capabilities": [{"capability": "API_INTEGRATION",
"api_integration_preference": {"partner_id": "LRB56X79RX58Y"
}
}
],
"collected_consents": [{"type": "SHARE_DATA_CONSENT",
"granted": true
}
],
"products": ["PPCP"
],
"legal_agreements": [{"type": "USER_AGREEMENT",
"minor_version": 2,
"major_version": 3,
"accepted_time": "2024-07-05T07:18:28.264Z"
},
{"type": "PRIVACY_AGREEMENT",
"minor_version": 2,
"major_version": 3,
"accepted_time": "2024-07-05T07:18:28.264Z"
},
{"type": "PAYPAL_COMPLETE_PYMTS_CUSTOM_FIELDS_AGREEMENT",
"minor_version": 1,
"major_version": 3,
"accepted_time": "2024-07-05T07:18:28.264Z"
}
],
"primary_currency_code": "USD"
}
}

List seller tracking information

get/v1/customer/partners/{partner_id}/merchant-integrations

Lists sellers that a partner onboarded, by partner ID.

SecurityOauth2

Request

path Parameters

partner_id

required

string

The ID of the partner for which to list onboarded sellers. This ID is the partner's PayPal account number. To find it, log in to the partner's PayPal business account. Navigate to Profile (top right), click Profile and settings, and click My business info. The account number appears in the Merchant account ID section.

query Parameters

tracking_id

required

string

Filters the sellers in the response by this partner-provided seller ID (merchant_id).

Responses

201

A successful request returns the HTTP 201 Created status code and a JSON response body that lists sellers. For each seller, the response shows the seller ID (merchant_id), the tracking ID, and HATEOAS links to show the seller-partner information.

Request samples

cURL
Node.js
Java
Python

Response samples

application/json

{"merchant_id": "8LQLM2ML4ZTYU",
"tracking_id": "merchantref1",
"links": [{"href": "v1/customer/partners/6LKMD2ML4NJYU",
"rel": "read",
"method": "GET",
"description": "Main partner resource."
}
]
}

Show seller status

get/v1/customer/partners/{partner_id}/merchant-integrations/{merchant_id}

Shows status information for sellers that the partner on-boards, by partner ID.

SecurityOauth2

Request

path Parameters

partner_id required	string The ID of the partner for which to show onboarded seller status information., which is the partner's PayPal account number. To find this ID, log in to the partner's PayPal business account. Navigate to Profile, click Profile and settings, and click My business info. The account number appears in the Merchant account ID section.
merchant_id required	string The ID of the seller for which to show status information.

query Parameters

fields

string

Filters the fields in the response to this comma-separated list of fields.

Responses

200

A successful request returns the HTTP 200 OK status code and a JSON response body that shows status details.

Request samples

cURL
Node.js
Java
Python

Response samples

application/json

{"merchant_id": "8LQLM2ML4ZTYU",
"products": [{"name": "EXPRESS_CHECKOUT",
"status": "ACTIVE"
},
{"name": "PPCP_STANDARD",
"vetting_status": "SUBSCRIBED",
"capabilities": ["INSTALLMENTS",
"SUBSCRIPTIONS",
"ACCEPT_DONATIONS",
"PAYPAL_CHECKOUT",
"GUEST_CHECKOUT",
"PAYPAL_CHECKOUT_ALTERNATIVE_PAYMENT_METHODS",
"SEND_INVOICE",
"QR_CODE",
"WITHDRAW_FUNDS_TO_DOMESTIC_BANK",
"PAYPAL_CHECKOUT_PAY_WITH_PAYPAL_CREDIT"
]
},
{"name": "PPCP_CUSTOM",
"vetting_status": "IN_REVIEW",
"capabilities": ["CARD_PROCESSING_VIRTUAL_TERMINAL",
"COMMERCIAL_ENTITY",
"DEBIT_CARD_SWITCH",
"VENMO_PAY_PROCESSING",
"FRAUD_TOOL_ACCESS",
"AMEX_OPTBLUE",
"APPLE_PAY",
"CUSTOM_BANK_PROCESSING",
"PAYPAL_WALLET_VAULTING_ADVANCED",
"CUSTOM_CARD_PROCESSING",
"GOOGLE_PAY"
]
}
],
"capabilities": [{"name": "INSTALLMENTS",
"status": "ACTIVE"
},
{"name": "SUBSCRIPTIONS",
"status": "ACTIVE"
},
{"name": "ACCEPT_DONATIONS",
"status": "ACTIVE"
},
{"name": "PAYPAL_CHECKOUT",
"status": "ACTIVE"
},
{"name": "GUEST_CHECKOUT",
"status": "ACTIVE"
},
{"name": "PAYPAL_CHECKOUT_ALTERNATIVE_PAYMENT_METHODS",
"status": "ACTIVE"
},
{"name": "SEND_INVOICE",
"status": "ACTIVE"
},
{"name": "QR_CODE",
"status": "ACTIVE"
},
{"name": "WITHDRAW_FUNDS_TO_DOMESTIC_BANK",
"status": "ACTIVE"
},
{"name": "PAYPAL_CHECKOUT_PAY_WITH_PAYPAL_CREDIT",
"status": "ACTIVE"
},
{"name": "CARD_PROCESSING_VIRTUAL_TERMINAL",
"status": "IN_REVIEW"
},
{"name": "COMMERCIAL_ENTITY",
"status": "ACTIVE"
},
{"name": "DEBIT_CARD_SWITCH",
"status": "ACTIVE"
},
{"name": "VENMO_PAY_PROCESSING",
"status": "ACTIVE"
},
{"name": "FRAUD_TOOL_ACCESS",
"status": "ACTIVE"
},
{"name": "AMEX_OPTBLUE",
"status": "ACTIVE"
},
{"name": "APPLE_PAY",
"status": "ACTIVE"
},
{"name": "CUSTOM_BANK_PROCESSING",
"status": "ACTIVE"
},
{"name": "PAYPAL_WALLET_VAULTING_ADVANCED",
"status": "ACTIVE"
},
{"name": "CUSTOM_CARD_PROCESSING",
"status": "IN_REVIEW"
},
{"name": "GOOGLE_PAY",
"status": "ACTIVE"
}
],
"payments_receivable": true,
"legal_name": "A STORE",
"primary_email": "[email protected]",
"primary_email_confirmed": true,
"oauth_integrations": [{"integration_type": "OAUTH_THIRD_PARTY",
"oauth_third_party": [{"partner_client_id": "AafBGhBphJ66SHPtbCMTsH1q2HQC2lnf0ER0KWAVSsOqsAtVfnye5Vc8hAOC",
"merchant_client_id": "AafBGhBphJ66SHPtbCMTsH1q2HQC2lnf0ER0KWAVSsOqsAtVfnye5Vc8hAOC",
"scopes": ["https://uri.paypal.com/services/payments/realtimepayment",
"https://uri.paypal.com/services/payments/payment/authcapture",
"https://uri.paypal.com/services/payments/refund"
]
}
]
}
]
}

Fetch merchant credentials

get/v1/customer/partners/{partner_id}/merchant-integrations/credentials

Fetches merchant credentials for a merchant onboarded through downloadable cart flow.

SecurityOauth2

Request

path Parameters

partner_id

required

string

The ID of the partner for which to show onboarded seller's credentials, which is the partner's PayPal account number. To find this ID, log in to the partner's PayPal business account. Navigate to Profile, click Profile and settings, and click My business info. The account number appears in the Merchant account ID section.

Responses

200

A successful request returns the HTTP 200 OK status code and a JSON response body that shows merchant credentials.

Request samples

cURL
Node.js
Java
Python

Response samples

application/json

{"client_id": "Ab27r3fkrQezHdcPrn2b2SYzPEldXx2dWgv76btVfI-eYF8KRAd2WxXAZyb0ETygSNeHBthzlxjlQ_qw",
"client_secret": "EAcTvpnDHZf4icl_2MPnt2gRpOxHVtaQJChWU3PrRbYR4uyvUXV6h4DWQjm7XOfdnk_OrEEWdxY2eUG3",
"payer_id": "QVG98CUNMS2PY"
}

Show partner information - agreements and preferences

get/v1/customer/partners/{id}

Shows partner information - agreements and preferences - by partner ID.

SecurityOauth2

Request

path Parameters

required

string [ 1 .. 20 ] characters ^.*$

The ID of the partner, which is the partner's PayPal account number. To find this ID, log in to the partner's PayPal business account. Navigate to Profile, click Profile and settings, and click My business info. The account number appears in the Merchant account ID section.

query Parameters

country_code	string = 2 characters ^([a-zA-Z]{2})$ The country code to load region preferences.
product	string [ 1 .. 20 ] characters ^.*$ The product to load region and integration preferences.

header Parameters

Content-type

string [ 1 .. 4000 ] characters ^.*$

The Content-type header MUST be described in all externally-accessible APIs.

Request Body schema:
application/json

any

Responses

200

A successful request returns the HTTP 200 OK status code and a JSON response body that shows partner information.

Request samples

Payload
cURL
Node.js
Java
Python

{ }

Response samples

application/json

{"launch_type": "EMBEDDED",
"receives_credential": true,
"product_change_allowed": "Y",
"notification_url": "https://example.com",
"logo_url": "https://example.com",
"agreement_types": ["VENDOR_SECURITY_POLICY_AGREEMENT"
],
"display_name": "Test Partner",
"integration_preferences": [{"product": "EXPRESS_CHECKOUT",
"integration_type": "THIRD_PARTY",
"permissions": ["EXPRESS_CHECKOUT",
"REFUND",
"AUTH_CAPTURE",
"ACCOUNT_BALANCE"
]
},
{"product": "WEBSITE_PAYMENTS_PRO_3_0",
"integration_type": "FIRST_PARTY",
"credential_type": "SIGNATURE"
},
{"product": "HOSTED_SOLE_SOLUTION",
"integration_type": "FIRST_PARTY",
"credential_type": "SIGNATURE"
}
],
"region_preferences": [{"country_code": "US",
"return_messages": [{"message": "come back",
"language_code": "en-US"
}
],
"product_preferences": [{"product": "EXPRESS_CHECKOUT",
"return_url": "https://www.paypal.com/us/webapps/mpp/express-checkout"
},
{"product": "WEBSITE_PAYMENTS_PRO_3_0",
"return_url": "https://www.paypal.com/us/webapps/mpp/paypal-payments-pro"
}
]
},
{"country_code": "FR",
"return_messages": [{"message": "Bonjour",
"language_code": "fr-FR"
}
],
"product_preferences": [{"product": "EXPRESS_CHECKOUT",
"return_url": "https://www.paypal.com/fr/webapps/mpp/express-checkout"
},
{"product": "HOSTED_SOLE_SOLUTION",
"return_url": "https://www.paypal.com/fr/webapps/mpp/hosted"
}
]
}
],
"links": [{"href": "v1/customer/partners/8LQLM2ML4ZTYU",
"rel": "update",
"method": "PUT"
}
]
}

Create partner information - agreements and preferences

post/v1/customer/partners/{id}

Creates partner information - agreements and preferences - for the given partner.

SecurityOauth2

Request

path Parameters

required

string [ 1 .. 20 ] characters ^.*$

header Parameters

Content-type

string [ 1 .. 4000 ] characters ^.*$

The Content-type header MUST be described in all externally-accessible APIs.

Request Body schema:
application/json
required

partner_id

string

The account ID of the partner.

launch_type

string

Default: "FULL_BROWSER"

Indicates whether the onboarding occurs in a full browser, mini-browser, or light box.

Enum: "FULL_BROWSER" "LIGHT_BOX" "EMBEDDED" "MINI_BROWSER"

receives_credential

boolean

Default: false

Indicates whether the partner is integrated to receive a seller credential.

product_selection

string

Indicates whether the seller can select a product with which to integrate.

Enum Value	Description
Y	The seller can choose a partner-supported product.
N	A product change is not allowed.
P	The seller can choose any product.

logo_url

string <uri>

The partner logo URL. Provides a way for partners to update their logo through preferences. This logo over-writes any image URL provided earlier for their business accounts.

notification_url

string <uri>

The partner-provided URL for notifications.

Array of objects (merchant_integration)

An array of required information for a partner to integrate this product. Varies based on the product to integrate.

Array of objects (region_preferences)

An array of region-specific preferences.

agreement_types

Array of any

An array of partner-accepted agreements.

Items Value: "VENDOR_SECURITY_POLICY_AGREEMENT"

Responses

201

A successful request returns the HTTP 201 Created status code and a JSON response body that contains an array of HATEOAS links that show the partner info.

Request samples

Payload
cURL
Node.js
Java
Python

{"launch_type": "EMBEDDED",
"receives_credential": true,
"product_change_allowed": "Y",
"notification_url": "https://example.com",
"logo_url": "https://example.com",
"agreement_types": ["VENDOR_SECURITY_POLICY_AGREEMENT"
],
"integration_preferences": [{"product": "PAYFLOW_LINK",
"integration_type": "THIRD_PARTY",
"permissions": ["EXPRESS_CHECKOUT",
"REFUND",
"ACCOUNT_BALANCE"
]
},
{"product": "EBAY_CHECKOUT",
"integration_type": "FIRST_PARTY",
"credential_type": "SIGNATURE"
}
],
"region_preferences": [{"country_code": "US",
"return_messages": [{"message": "come back",
"language_code": "en-US"
}
],
"product_preferences": [{"product": "PAYFLOW_LINK",
"return_url": "https://www.paypal.com"
},
{"product": "EBAY_CHECKOUT",
"return_url": "https://www.google.com"
}
]
},
{"country_code": "FR",
"return_messages": [{"message": "Bonjour",
"language_code": "fr-FR"
}
],
"product_preferences": [{"product": "PAYFLOW_LINK",
"return_url": "https://www.paypal.com/fr"
},
{"product": "EBAY_CHECKOUT",
"return_url": "https://www.google.com/fr"
}
]
}
]
}

Response samples

application/json

{ }

Update partner information - agreements and preferences

put/v1/customer/partners/{id}

Updates partner information - agreements and preferences - for the given partner.

SecurityOauth2

Request

path Parameters

required

string [ 1 .. 20 ] characters ^.*$

header Parameters

Content-type

string [ 1 .. 4000 ] characters ^.*$

The Content-type header MUST be described in all externally-accessible APIs.

Request Body schema:
application/json
required

partner_id

string

The account ID of the partner.

launch_type

string

Default: "FULL_BROWSER"

Indicates whether the onboarding occurs in a full browser, mini-browser, or light box.

Enum: "FULL_BROWSER" "LIGHT_BOX" "EMBEDDED" "MINI_BROWSER"

receives_credential

boolean

Default: false

Indicates whether the partner is integrated to receive a seller credential.

product_selection

string

Indicates whether the seller can select a product with which to integrate.

Enum Value	Description
Y	The seller can choose a partner-supported product.
N	A product change is not allowed.
P	The seller can choose any product.

logo_url

string <uri>

The partner logo URL. Provides a way for partners to update their logo through preferences. This logo over-writes any image URL provided earlier for their business accounts.

notification_url

string <uri>

The partner-provided URL for notifications.

Array of objects (merchant_integration)

An array of required information for a partner to integrate this product. Varies based on the product to integrate.

Array of objects (region_preferences)

An array of region-specific preferences.

agreement_types

Array of any

An array of partner-accepted agreements.

Items Value: "VENDOR_SECURITY_POLICY_AGREEMENT"

Responses

204

The server has successfully executed the method, but there is no entity body to return.

Request samples

Payload
cURL
Node.js
Java
Python

{"launch_type": "EMBEDDED",
"receives_credential": true,
"product_change_allowed": "Y",
"notification_url": "https://example.com",
"logo_url": "https://example.com",
"agreement_types": ["VENDOR_SECURITY_POLICY_AGREEMENT"
],
"display_name": "Test Partner",
"integration_preferences": [{"product": "EXPRESS_CHECKOUT",
"integration_type": "THIRD_PARTY",
"permissions": ["EXPRESS_CHECKOUT",
"REFUND",
"AUTH_CAPTURE",
"ACCOUNT_BALANCE"
]
},
{"product": "WEBSITE_PAYMENTS_PRO_3_0",
"integration_type": "FIRST_PARTY",
"credential_type": "SIGNATURE"
},
{"product": "HOSTED_SOLE_SOLUTION",
"integration_type": "FIRST_PARTY",
"credential_type": "SIGNATURE"
}
],
"region_preferences": [{"country_code": "US",
"return_messages": [{"message": "come back",
"language_code": "en-US"
}
],
"product_preferences": [{"product": "EXPRESS_CHECKOUT",
"return_url": "https://www.paypal.com/us/webapps/mpp/express-checkout"
},
{"product": "WEBSITE_PAYMENTS_PRO_3_0",
"return_url": "https://www.paypal.com/us/webapps/mpp/paypal-payments-pro"
}
]
},
{"country_code": "FR",
"return_messages": [{"message": "Bonjour",
"language_code": "fr-FR"
}
],
"product_preferences": [{"product": "EXPRESS_CHECKOUT",
"return_url": "https://www.paypal.com/fr/webapps/mpp/express-checkout"
},
{"product": "HOSTED_SOLE_SOLUTION",
"return_url": "https://www.paypal.com/fr/webapps/mpp/hosted"
}
]
}
]
}

Response samples

application/json

{ }

Errors

INTERNAL_ERROR

Message:
The process cannot be processed due to internal error.

Description: An internal error occurred.

PARTNER_BUSINESS_ERROR-BUSINESS_ERROR

Message:
BUSINESS_ERROR.

Description: The caller is not a business account or the account is closed or locked.

PARTNER_BUSINESS_ERROR-CONSENT_ALREADY_EXISTS

Message:
CONSENT_ALREADY_EXISTS.

Description: The consent between this seller and partner already exists.

Note: Use PATCH to update the content.

PARTNER_BUSINESS_ERROR-FAILED_TO_SET_OAUTH_INTEGRATION

Message:
FAILED_TO_SET_OAUTH_INTEGRATION.

Description: The OAuth integrations could not be set for the partner and seller.

PARTNER_BUSINESS_ERROR-FAILED_WHILE_GETTING_OAUTH_INTEGRATION

Message:
FAILED_WHILE_GETTING_OAUTH_INTEGRATION.

Description: The OAuth integrations could not be fetched for the partner and seller.

PARTNER_BUSINESS_ERROR-MERCHANT_ID_SAME_AS_PARTNER_ID

Message:
MERCHANT_ID_SAME_AS_PARTNER_ID.

Description: The seller ID is same as the partner ID.

PARTNER_BUSINESS_ERROR-NO_ATTRIBUTION_WITH_MERCHANT

Message:
NO_ATTRIBUTION_WITH_MERCHANT.

Description: The partner can only get the seller details if the seller is referred by the partner.

PARTNER_BUSINESS_ERROR-PARTNER_MERCHANT_CLIENT_ASSOC_ALREADY_PRESENT

Message:
PARTNER_MERCHANT_CLIENT_ASSOC_ALREADY_PRESENT.

Description: The seller client ID already exists for the PartnerId-MerchantId-PartnerClientId combination.

PARTNER_BUSINESS_ERROR-PARTNER_MERCHANT_CLIENT_ID_COMBINATION_INCORRECT

Message:
PARTNER_MERCHANT_CLIENT_ID_COMBINATION_INCORRECT.

Description: The combination of partnerClientId-merchantClientId is incorrect for this partnerId-merchantId.

PARTNER_BUSINESS_ERROR-PARTNER_REFERRAL_LINK_ALREADY_EXISTS

Message:
PARTNER_REFERRAL_LINK_ALREADY_EXISTS.

Description: The link between this lookup type and referral_id already exists.

PARTNER_BUSINESS_ERROR-PREFERENCES_ALREADY_EXIST

Message:
PREFERENCES_ALREADY_EXIST.

Description: The preferences already exist for this partner account. Note: Use PATCH to update the content.

RESOURCE_NOT_FOUND_ERROR-AGREEMENTS_NOT_FOUND

Message:
AGREEMENTS_NOT_FOUND.

Description: Agreements were not found for this account.

RESOURCE_NOT_FOUND_ERROR-INTEGRATIONS_NOT_FOUND

Message:
INTEGRATIONS_NOT_FOUND.

Description: No integration was found between the partner and seller.

RESOURCE_NOT_FOUND_ERROR-INVALID_CONSENT_ID

Message:
INVALID_CONSENT_ID.

Description: The consent was not found.

RESOURCE_NOT_FOUND_ERROR-INVALID_REFERRAL_ID

Message:
INVALID_REFERRAL_ID.

Description: The referral ID is not valid.

RESOURCE_NOT_FOUND_ERROR-LINK_NOT_FOUND

Message:
LINK_NOT_FOUND.

Description: No referrals are linked with this account.

UNAUTHORIZED

Message:
INVALID_PARTNER_RELATIONSHIP.

Description: The partner cannot use another partner for this API.

UNAUTHORIZED-AUTHORIZATION_ERROR

Message:
AUTHORIZATION_ERROR.

Description: This API call is not authorized.

UNAUTHORIZED-INVALID_CONSENT_OWNERSHIP

Message:
INVALID_CONSENT_OWNERSHIP.

Description: The user is not the owner of the consent.

UNPROCESSABLE_ENTITY

Message:
SUCCESS_WITH_WARNING.

Description: The request is not valid.

USER_BUSINESS_ERROR

Message:
USER_NOT_FOUND.

Description: The account for this ID does not exist.

Definitions

Account Capability

Capability associated with the account.

Array of objects (Capability Limit)

An array of limitations on the capability.

name

string (Capability Name) [ 1 .. 255 ] characters ^[0-9A-Z_]+$

Name of the capability.

Enum Value	Description
APPLE_PAY	Enables Apple Pay capability. Supported only when PAYMENT_METHODS or PPCP, PAYMENT_METHODS is requested.
SEND_INVOICE	Enables users to request money by sending an invoice to another customer.
ACCEPT_DONATIONS	A tailored donations solution for individuals, businesses, and non-profit customers to accept one-time and recurring donations via a Donate button, shareable link, or QR code.
ACCEPT_PYMTS_VIA_ALIPAY	Alipay is a China-based payment method that allows customers to complete transactions online using their Alipay wallet.
ACCEPT_PYMTS_VIA_BANCONTACT	Bancontact is a Belgium-based payment method that allows customers to complete transactions online using their bank credentials.
ACCEPT_PYMTS_VIA_BLIK	Blik is a Poland-based payment method that allows customers to complete transactions online using their bank credentials.
ACCEPT_PYMTS_VIA_EPS	EPS is an Austria-based payment method that allows customers to complete transactions online using their bank credentials.
ACCEPT_PYMTS_VIA_IDEAL	iDEAL is a Netherlands-based payment method that allows customers to complete transactions online using their bank credentials.
ACCEPT_PYMTS_VIA_MB_WAY	MB Way is a Portugal-based payment method that allows customers to complete transactions online using their MB Way wallet.
ACCEPT_PYMTS_VIA_MULTIBANCO	Multibanco is a Portugal-based payment method that allows customers to complete transactions online using their bank credentials or pay in cash at a bank branch.
ACCEPT_PYMTS_VIA_PRZELEWY24	Przelewy24 is a Poland-based payment method that allows customers to complete transactions online.
ACCEPT_PYMTS_VIA_SATISPAY	Satispay is an Italy-based payment method that allows customers to complete transactions online using their bank credentials.
ACCEPT_PYMTS_VIA_TRUSTLY	Trustly is a payment method that allows customers from (Austria (AT), Germany (DE), Denmark (DK), Estonia (EE), Spain (ES), Finland (FI), Great Britain (GB), Lithuania (LT), Latvia (LV), Netherlands (NL), Norway (NO), Sweden (SE)) to complete transactions online using their bank credentials.
ACCEPT_PYMTS_VIA_WECHAT_PAY	WeChat Pay is a China-based payment method that allows customers to complete transactions online using their WeChat Pay wallet.
GOOGLE_PAY	Receive unbranded card payments - Debit or Credit through Google Pay.
CARD_PROCESSING_VIRTUAL_TERMINAL	Enable merchant to receive direct credit card payment via phone/fax/mail. Merchant initiates transaction enters card into virtual terminal
AMEX_OPTBLUE	Enable merchant to accept AMEX. They can receive marketing communication from American express.
CUSTOM_CARD_PROCESSING	Receive direct credit card payment (card-not-present transactions)
FRAUD_TOOL_ACCESS	Access Fraud Protection tool (powered by Simility)
DEBIT_CARD_SWITCH	Receive debit card payment
COMMERCIAL_ENTITY	Merchant is considered as a commercial entity and hence needs to comply with the requirements and use the benefits, such as CE agreement and treatment on the credit card descriptor
GUEST_CHECKOUT	Merchant checkout feature that provides businesses the ability to accept payments from consumers without a PayPal account using a credit or debit card through PayPal.
PAYPAL_CHECKOUT	Receive credit card payment via inline /guest checkout
SUBSCRIPTIONS	Allow merchants to create stable, predictable income by offering subscription plans.
VENMO_PAY_PROCESSING	Receive Venmo pay
PAYPAL_CHECKOUT_ALTERNATIVE_PAYMENT_METHODS	Receive local payment methods specific to a buyer region (eg Giropay, Ideal, Sofort)
QR_CODE	Provide the Integrated QRC solution that is intended to be integrated with Partners who already provide payment acceptance via APMs directly to merchants.
INSTALLMENTS	Merchants can offer equal payment installment financing options as part of the revolving account.
PAYPAL_CHECKOUT_PAY_WITH_PAYPAL_CREDIT	PayPal Checkout - Pay with PayPal Credit.
PAYPAL_WALLET_VAULTING_ADVANCED	Enables the capability to Save payment methods. Supported only when one of PPCP and ADVANCED_VAULTING or EXPRESS_CHECKOUT and ADVANCED_VAULTING combination in the products array is requested.
WITHDRAW_FUNDS_TO_DOMESTIC_BANK	Withdraw money from their PayPal balance to a linked domestic bank account.

status

string (Capability Status) [ 1 .. 64 ] characters ^[A-Z_]+$

The status of the capability.

Enum Value	Description
ACTIVE	The capability is enabled for the account and can be used.
SUSPENDED	The capability can no longer be used, but there are remediation steps to regain access to the corresponding functionality.
REVOKED	The capability can no longer be used and there are no remediation steps available to regain the functionality.
APPROVED	The capability is approved and could be enabled. This capability can not be used currently.
NEED_DATA	Need details or documents required to enable this capability.
DENY	The request to enable this capability is Denied by Policy Systems.
IN_REVIEW	The capability request is in review by policy system. This capability can not be used currently.
INACTIVE	The capability can no longer be used and to enable this capability, please request.
PENDING	The capability is in a pending state waiting for decision from policy systems.

{"limits": [{"type": "GENERAL"
}
],
"name": "APPLE_PAY",
"status": "ACTIVE"
}

account_identifier

The PayPal account ID of the partner.

type required	string The type of ID for the account. Value: "PAYER_ID"
value required	string The ID of the account.

{"type": "PAYER_ID",
"value": "string"
}

bank_details

The required information to add a card as a financial instrument to PayPal through onboarding.

nick_name

string

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

account_number

required

string\d+

The bank account number. These are numeric values only without any additional formatting.

account_type

required

string

The type of account, which is checking or savings.

Enum Value	Description
CHECKING	Checking account.
SAVINGS	Savings accounts.

currency_code

string^([A-Z]){3}$

The primary three-character ISO-4217 currency code for the account.

Array of objects (identifier) non-empty

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_agreed

boolean

Indicates whether the user has agreed to the mandate for financial instrument (FI) authorization.

object (Simple Postal Address (Coarse-Grained))

The branch location, if applicable.

{"nick_name": "string",
"account_number": "string",
"account_type": "CHECKING",
"currency_code": "string",
"identifiers": [{"type": "ROUTING_NUMBER_1",
"value": "string"
}
],
"mandate_agreed": true,
"branch_location": {"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"country_code": "st",
"postal_code": "string"
}
}

Beneficial_owners

Beneficial owners of the entity.

	Array of objects (Individual_beneficial_owner) [ 0 .. 20 ] items Individual beneficial owners.
	Array of objects (Business_beneficial_owner) [ 0 .. 20 ] items Business beneficial owners.

{"individual_beneficial_owners": [{"phone_contacts": [{"phone_number_details": {"country_code": "str",
"national_number": "string",
"extension_number": "string"
},
"phone_type": "FAX"
}
],
"name": {"prefix": "string",
"given_name": "string",
"surname": "string",
"middle_name": "string",
"suffix": "string",
"alternate_full_name": "string",
"full_name": "string"
},
"home_address": {"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"country_code": "st",
"postal_code": "string"
},
"nationality_country_code": "st",
"percentage_of_ownership": "string"
}
],
"business_beneficial_owners": [{"names": [{"type": "LEGAL",
"name": "string"
}
],
"phone_contacts": [{"phone_number_details": {"country_code": "str",
"national_number": "string",
"extension_number": "string"
},
"phone_type": "FAX"
}
],
"business_type": "string",
"category": "string",
"sub_category": "string",
"merchant_category_code": "string",
"purpose_code": ["P0104"
],
"website_urls": ["http://example.com"
],
"business_address": {"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"country_code": "st",
"postal_code": "string"
},
"business_subtype": "ASSO_TYPE_INCORPORATED",
"annual_sales_volume_range": {"minimum_amount": {"currency": "string",
"value": "string"
},
"maximum_amount": {"currency": "string",
"value": "string"
}
},
"average_monthly_volume_range": {"minimum_amount": {"currency": "string",
"value": "string"
},
"maximum_amount": {"currency": "string",
"value": "string"
}
},
"percentage_of_ownership": "string"
}
]
}

billing_agreement

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

description	string The billing agreement description.
	object (billing_experience_preference) The preference that customizes the billing experience of the customer.
merchant_custom_data	string The custom data for the billing agreement.
approval_url	string <uri> The URL to which to redirect seller to accept the billing agreement.
ec_token	string The billing agreement token for the agreement.

{"description": "string",
"billing_experience_preference": {"experience_id": "string",
"billing_context_set": true
},
"merchant_custom_data": "string",
"approval_url": "http://example.com",
"ec_token": "string"
}

billing_experience_preference

The preference that customizes the billing experience of the customer.

experience_id	string The ID of the payment web experience profile, which is returned from a create web experience profile call.
billing_context_set	boolean Indicates whether the partner has already displayed the billing context to the seller.

{"experience_id": "string",
"billing_context_set": true
}

Business

Details of the business entity.

Array of objects (business_name) [ 1 .. 20 ] items

An array of business names.

Array of objects (phone_details) [ 1 .. 20 ] items

An array of phone contacts for the business.

business_type

string [ 1 .. 128 ] characters

The type of business.

Business sub-type

Sub classification of the business type.

string (Business sub-type) [ 1 .. 255 ] characters ^[0-9A-Z_]+$

Sub classification of the business type.

Enum Value	Description
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.

"ASSO_TYPE_INCORPORATED"

Business sub-type

Sub classification of the business type.

string (Business sub-type) [ 1 .. 255 ] characters ^[0-9A-Z_]+$

Sub classification of the business type.

Enum Value	Description
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.

"ASSO_TYPE_INCORPORATED"

Business_beneficial_owner

The individual owner of the account.

Array of objects (business_name) [ 1 .. 20 ] items

An array of business names.

Array of objects (phone_details) [ 1 .. 20 ] items

An array of phone contacts for the business.

business_type

string [ 1 .. 128 ] characters

The type of business.

business_details

The customer's business details.

Array of objects (phone_details)

An array of phone contacts for the business.

business_type

string

The type of business.

business_subtype

string (Business sub-type) [ 1 .. 255 ] characters ^[0-9A-Z_]+$

Sub classification of the business type.

Enum Value	Description
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_name

A name for the business. For example, the legal name or the stock-trading name.

type required	string The legal category of the business. Enum: "LEGAL" "DOING_BUSINESS_AS" "STOCK_TRADING_NAME"
name required	string The business name.

{"type": "LEGAL",
"name": "string"
}

business_type

The business type.

string (business_type) [ 1 .. 255 ] characters

The business type.

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

"INDIVIDUAL"

capability

The required capability to share data.

capability	string The capability to enable for the customer. To enable the collection of the API permissions that you require to integrate with the customer, specify `API_INTEGRATION`. `BANK_ADDITION` is supported only for the US. Enum: "API_INTEGRATION" "BANK_ADDITION" "BILLING_AGREEMENT" "CONTEXTUAL_MARKETING_CONSENT"
	object (integration_details) The integration details for the partner and customer relationship. Required if `capability_type` is `API_INTEGRATION`.
	object (billing_agreement) The details of the billing agreement between the partner and a seller.

{"capability": "API_INTEGRATION",
"api_integration_preference": {"partner_id": "string",
"rest_api_integration": {"integration_method": "PAYPAL",
"integration_type": "string"
},
"rest_third_party_details": {"partner_client_id": "string",
"feature_list": ["PAYMENT"
]
},
"rest_first_party_details": {"partner_client_id": "string",
"feature_list": ["PAYMENT"
],
"seller_nonce": "stringstringstringstringstringstringstringst"
}
},
"billing_agreement": {"description": "string",
"billing_experience_preference": {"experience_id": "string",
"billing_context_set": true
},
"merchant_custom_data": "string",
"approval_url": "http://example.com",
"ec_token": "string"
}
}

Capability Limit

Limit associated with the capability.

type

string (Limit Type) [ 1 .. 255 ] characters ^[0-9A-Z_]+$

Type of the limit.

Value	Description
GENERAL	It means that the customer has access to the capability, but the capability's functionality is limited due to certain policy thresholds or restrictions. This could be due to transaction limits, account balance requirements, or other policy-based restrictions.

{"type": "GENERAL"
}

Capability Name

The name of capability.

string (Capability Name) [ 1 .. 255 ] characters ^[0-9A-Z_]+$

The name of capability.

Enum Value	Description
APPLE_PAY	Enables Apple Pay capability. Supported only when PAYMENT_METHODS or PPCP, PAYMENT_METHODS is requested.
SEND_INVOICE	Enables users to request money by sending an invoice to another customer.
ACCEPT_DONATIONS	A tailored donations solution for individuals, businesses, and non-profit customers to accept one-time and recurring donations via a Donate button, shareable link, or QR code.
ACCEPT_PYMTS_VIA_ALIPAY	Alipay is a China-based payment method that allows customers to complete transactions online using their Alipay wallet.
ACCEPT_PYMTS_VIA_BANCONTACT	Bancontact is a Belgium-based payment method that allows customers to complete transactions online using their bank credentials.
ACCEPT_PYMTS_VIA_BLIK	Blik is a Poland-based payment method that allows customers to complete transactions online using their bank credentials.
ACCEPT_PYMTS_VIA_EPS	EPS is an Austria-based payment method that allows customers to complete transactions online using their bank credentials.
ACCEPT_PYMTS_VIA_IDEAL	iDEAL is a Netherlands-based payment method that allows customers to complete transactions online using their bank credentials.
ACCEPT_PYMTS_VIA_MB_WAY	MB Way is a Portugal-based payment method that allows customers to complete transactions online using their MB Way wallet.
ACCEPT_PYMTS_VIA_MULTIBANCO	Multibanco is a Portugal-based payment method that allows customers to complete transactions online using their bank credentials or pay in cash at a bank branch.
ACCEPT_PYMTS_VIA_PRZELEWY24	Przelewy24 is a Poland-based payment method that allows customers to complete transactions online.
ACCEPT_PYMTS_VIA_SATISPAY	Satispay is an Italy-based payment method that allows customers to complete transactions online using their bank credentials.
ACCEPT_PYMTS_VIA_TRUSTLY	Trustly is a payment method that allows customers from (Austria (AT), Germany (DE), Denmark (DK), Estonia (EE), Spain (ES), Finland (FI), Great Britain (GB), Lithuania (LT), Latvia (LV), Netherlands (NL), Norway (NO), Sweden (SE)) to complete transactions online using their bank credentials.
ACCEPT_PYMTS_VIA_WECHAT_PAY	WeChat Pay is a China-based payment method that allows customers to complete transactions online using their WeChat Pay wallet.
GOOGLE_PAY	Receive unbranded card payments - Debit or Credit through Google Pay.
CARD_PROCESSING_VIRTUAL_TERMINAL	Enable merchant to receive direct credit card payment via phone/fax/mail. Merchant initiates transaction enters card into virtual terminal
AMEX_OPTBLUE	Enable merchant to accept AMEX. They can receive marketing communication from American express.
CUSTOM_CARD_PROCESSING	Receive direct credit card payment (card-not-present transactions)
FRAUD_TOOL_ACCESS	Access Fraud Protection tool (powered by Simility)
DEBIT_CARD_SWITCH	Receive debit card payment
COMMERCIAL_ENTITY	Merchant is considered as a commercial entity and hence needs to comply with the requirements and use the benefits, such as CE agreement and treatment on the credit card descriptor
GUEST_CHECKOUT	Merchant checkout feature that provides businesses the ability to accept payments from consumers without a PayPal account using a credit or debit card through PayPal.
PAYPAL_CHECKOUT	Receive credit card payment via inline /guest checkout
SUBSCRIPTIONS	Allow merchants to create stable, predictable income by offering subscription plans.
VENMO_PAY_PROCESSING	Receive Venmo pay
PAYPAL_CHECKOUT_ALTERNATIVE_PAYMENT_METHODS	Receive local payment methods specific to a buyer region (eg Giropay, Ideal, Sofort)
QR_CODE	Provide the Integrated QRC solution that is intended to be integrated with Partners who already provide payment acceptance via APMs directly to merchants.
INSTALLMENTS	Merchants can offer equal payment installment financing options as part of the revolving account.
PAYPAL_CHECKOUT_PAY_WITH_PAYPAL_CREDIT	PayPal Checkout - Pay with PayPal Credit.
PAYPAL_WALLET_VAULTING_ADVANCED	Enables the capability to Save payment methods. Supported only when one of PPCP and ADVANCED_VAULTING or EXPRESS_CHECKOUT and ADVANCED_VAULTING combination in the products array is requested.
WITHDRAW_FUNDS_TO_DOMESTIC_BANK	Withdraw money from their PayPal balance to a linked domestic bank account.

"APPLE_PAY"

Capability Status

Status of the account capability.

string (Capability Status) [ 1 .. 64 ] characters ^[A-Z_]+$

Status of the account capability.

Enum Value	Description
ACTIVE	The capability is enabled for the account and can be used.
SUSPENDED	The capability can no longer be used, but there are remediation steps to regain access to the corresponding functionality.
REVOKED	The capability can no longer be used and there are no remediation steps available to regain the functionality.
APPROVED	The capability is approved and could be enabled. This capability can not be used currently.
NEED_DATA	Need details or documents required to enable this capability.
DENY	The request to enable this capability is Denied by Policy Systems.
IN_REVIEW	The capability request is in review by policy system. This capability can not be used currently.
INACTIVE	The capability can no longer be used and to enable this capability, please request.
PENDING	The capability is in a pending state waiting for decision from policy systems.

"ACTIVE"

Certificate

A certificate for seller credentials.

api_user_name	string The API user name for the seller.
api_password	string The API password for the seller.
fingerprint	string The fingerprint.
download_link	string The URL to download the certificate.

{"api_user_name": "string",
"api_password": "string",
"fingerprint": "string",
"download_link": "string"
}

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

string <ppaas_common_country_code_v2> (country_code) = 2 characters ^([A-Z]{2}|C2)$

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.

"st"

create_referral_data_response

The shared referral data.

Array of objects (Link Description)

An array of request-related HATEOAS links.

{"links": [{"href": "string",
"rel": "string",
"method": "GET"
}
]
}

Credential

Seller credentials.

	object (Signature) The signature portion of the seller credentials.
	object (Certificate) A certificate for seller credentials.

{"signature": {"api_user_name": "string",
"api_password": "string",
"signature": "string"
},
"certificate": {"api_user_name": "string",
"api_password": "string",
"fingerprint": "string",
"download_link": "string"
}
}

currency

The three-character ISO-4217 currency code.

currency required	string The three-character ISO-4217 currency code.
value required	string The amount, up to `N` digits after the decimal separator. For currencies that do not support decimals, see currency codes.

{"currency": "string",
"value": "string"
}

currency_range

The currency range, from the minimum inclusive amount to the maximum inclusive amount.

	object (currency) The minimum inclusive amount for the range.
	object (currency) The maximum inclusive amount for the range.

{"minimum_amount": {"currency": "string",
"value": "string"
},
"maximum_amount": {"currency": "string",
"value": "string"
}
}

date_of_event

The date for an event type. Typically captured during onboarding.

event_date required	string <date-time> The date portion of the date and time when the event occurred, in Internet date and time format. For accuracy, if you do not know the exact time zone, use the UTC time zone.
event_type required	string (event_type) The event type for an onboarding entity. Enum: "BIRTH" "ESTABLISHED" "INCORPORATION" "OPERATION"

{"event_date": "2019-08-24T14:15:22Z",
"event_type": "BIRTH"
}

email_address

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.

string <ppaas_common_email_address_v2> (email_address) [ 3 .. 254 ] characters ^.+@[^"\-].+$

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.

"string"

email_contact

The email address. Includes the role of the email address.

email_address required	string <ppaas_common_email_address_v2> (email_address) [ 3 .. 254 ] characters ^.+@[^"\-].+$ 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.
role required	string The role of the email address. Value: "CUSTOMER_SERVICE"

{"email_address": "string",
"role": "CUSTOMER_SERVICE"
}

Error

The error details.

name required	string The human-readable, unique name of the error.
message required	string The message that describes the error.
debug_id required	string The PayPal internal ID. Used for correlation purposes.
information_link	string The information link, or URI, that shows detailed information about this error for the developer.
	Array of objects (Error Details) An array of additional details about the error.
	Array of objects (Link Description) An array of request-related HATEOAS links.

{"name": "string",
"message": "string",
"debug_id": "string",
"information_link": "string",
"details": [{"field": "string",
"value": "string",
"location": "body",
"issue": "string",
"description": "string"
}
],
"links": [{"href": "string",
"rel": "string",
"method": "GET"
}
]
}

Error

The error information.

name required	string The human-readable, unique name of the error.
debug_id	string The PayPal internal ID. Used for correlation purposes.
message required	string The message that describes the error.
information_link required	string The URI to detailed information related to this error for the developer.
	Array of objects (Error Details) An array of additional details for the error.

{"name": "string",
"debug_id": "string",
"message": "string",
"information_link": "string",
"details": [{"field": "string",
"issue": "string"
}
]
}

Error Details

The error details. Required for client-side 4XX errors.

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.
value	string The value of the field that caused the error.
location	string Default: "body" The location of the field that caused the error. Value is `body`, `path`, or `query`.
issue required	string 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",
"value": "string",
"location": "body",
"issue": "string",
"description": "string"
}

Error Details

The error details. Required for client-side 4XX errors.

field required	string The name of the field that caused the error.
issue required	string The reason for the error.

{"field": "string",
"issue": "string"
}

Error Details

The error details. Required for client-side 4XX errors.

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.
value	string The value of the field that caused the error.
location	string Default: "body" The location of the field that caused the error. Value is `body`, `path`, or `query`.
issue required	string The unique, fine-grained application-level error code.
	Array of objects (Link Description) [ 1 .. 4 ] items An array of request-related HATEOAS links that are either relevant to the issue by providing additional information or offering potential resolutions.
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",
"value": "string",
"location": "body",
"issue": "string",
"links": [{"href": "string",
"rel": "string",
"method": "GET"
}
],
"description": "string"
}

event_type

The event type for an onboarding entity.

string (event_type)

The event type for an onboarding entity.

Enum: "BIRTH" "ESTABLISHED" "INCORPORATION" "OPERATION"

"BIRTH"

identifier

The attributes for an instrument institute ID. 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.

type

string

The bank account ID type.

Enum Value	Description
ROUTING_NUMBER_1	Routing number 1.
ROUTING_NUMBER_2	Routing number 2.
ROUTING_NUMBER_3	Routing number 3.
BI_CODE	BI code.
BANK_CODE	Bank 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 bank account ID value.

{"type": "ROUTING_NUMBER_1",
"value": "string"
}

identity_document

The authority-issued identification document. Document types include a driver's license, social security number, employee ID number, and so on.

value required	string^[A-Za-z0-9]+$ The identifier value, such as license number, social security number, and so on.
partial_value required	boolean Default: false Indicates whether the value is a partial value. Specify this value when the identifier type supports a partial value, such as four SSN digits instead of the full nine values. Depending on the context, this parameter can be ignored.
issuer_country_code required	string^[A-Z]([A-Z]\|\d)$ The two-character ISO-3166-1 country code for the country that issued the document.
type required	string (identity_document_type) The identifier type in the onboarding domain. Indicates the most specific type or the closest matching value. For example, `SOCIAL_SECURITY_NUMBER` in preference to `TAX_IDENTIFICATION_NUMBER`. Enum: "SOCIAL_SECURITY_NUMBER" "EMPLOYMENT_IDENTIFICATION_NUMBER" "TAX_IDENTIFICATION_NUMBER" "PASSPORT_NUMBER" "PENSION_FUND_ID" "MEDICAL_INSURANCE_ID" "CNPJ" "CPF" "PAN" "NATIONAL_ID_CARD" "BUSINESS_REGISTRATION"

{"value": "string",
"partial_value": false,
"issuer_country_code": "string",
"type": "SOCIAL_SECURITY_NUMBER"
}

identity_document_type

The identifier type in the onboarding domain. Indicates the most specific type or the closest matching value. For example, SOCIAL_SECURITY_NUMBER in preference to TAX_IDENTIFICATION_NUMBER.

string (identity_document_type)

The identifier type in the onboarding domain. Indicates the most specific type or the closest matching value. For example, SOCIAL_SECURITY_NUMBER in preference to TAX_IDENTIFICATION_NUMBER.

Enum: "SOCIAL_SECURITY_NUMBER" "EMPLOYMENT_IDENTIFICATION_NUMBER" "TAX_IDENTIFICATION_NUMBER" "PASSPORT_NUMBER" "PENSION_FUND_ID" "MEDICAL_INSURANCE_ID" "CNPJ" "CPF" "PAN" "NATIONAL_ID_CARD" "BUSINESS_REGISTRATION"

"SOCIAL_SECURITY_NUMBER"

Individual_beneficial_owner

The individual owner of the account.

	Array of objects (phone_details) [ 1 .. 10 ] items An array of contact phone numbers for the customer.
	object (Name) The legal name of the customer.
	object (Simple Postal Address (Coarse-Grained)) The home address of the account holder.
nationality_country_code	string <ppaas_common_country_code_v2> (country_code) = 2 characters ^([A-Z]{2}\|C2)$ The citizenship country code of the person
percentage_of_ownership	string [ 1 .. 20 ] characters The percentage of shares this person owns in the company.

{"phone_contacts": [{"phone_number_details": {"country_code": "str",
"national_number": "string",
"extension_number": "string"
},
"phone_type": "FAX"
}
],
"name": {"prefix": "string",
"given_name": "string",
"surname": "string",
"middle_name": "string",
"suffix": "string",
"alternate_full_name": "string",
"full_name": "string"
},
"home_address": {"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"country_code": "st",
"postal_code": "string"
},
"nationality_country_code": "st",
"percentage_of_ownership": "string"
}

integration_details

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

partner_id	string The payer ID of the partner who integrates with the client. To find this ID, log in to the partner's PayPal business account. Navigate to Profile, click Profile and settings, and click My business info. The account number appears in the Merchant account ID section.
	object (REST API Integration) The integration details for PayPal REST endpoints.
	object (REST Third-Party Details) The integration details for PayPal REST endpoints.
	object (REST First-Party Details) The integration details for PayPal First Party REST endpoints.

{"partner_id": "string",
"rest_api_integration": {"integration_method": "PAYPAL",
"integration_type": "string"
},
"rest_third_party_details": {"partner_client_id": "string",
"feature_list": ["PAYMENT"
]
},
"rest_first_party_details": {"partner_client_id": "string",
"feature_list": ["PAYMENT"
],
"seller_nonce": "stringstringstringstringstringstringstringst"
}
}

legal_consent

The customer-provided consent.

type required	string The type of consent. `SHARE_DATA_CONSENT` gives consent to you to share your customer's data with PayPal. Value: "SHARE_DATA_CONSENT"
granted required	boolean Indicates whether the customer agreed to share this type of data. To give consent, specify `true`. To withhold consent, specify `false`.

{"type": "SHARE_DATA_CONSENT",
"granted": true
}

Limit Type

The type of limit.

string (Limit Type) [ 1 .. 255 ] characters ^[0-9A-Z_]+$

The type of limit.

Value	Description
GENERAL	It means that the customer has access to the capability, but the capability's functionality is limited due to certain policy thresholds or restrictions. This could be due to transaction limits, account balance requirements, or other policy-based restrictions.

"GENERAL"

limitation

The limitations on a seller account.

name	string The title of the limitation that is applied to the account.
restrictions	Array of strings An array of the restriction names.

{"name": "string",
"restrictions": ["string"
]
}

link

The mapping of the lookup key and partner-referral.

submitter_payer_id	string The payer ID of the partner account that shared the referral data.
partner_referral_id	string The partner-referral submitter_payer_id reference key.
lookup_type	string The type of ID that is linked with this referral ID.
lookup_value	string The value of the ID that is linked with this referral ID.

{"submitter_payer_id": "string",
"partner_referral_id": "string",
"lookup_type": "string",
"lookup_value": "string"
}

Link Description

The request-related HATEOAS link information.

href required	string 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.
rel required	string The link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.
method	string The HTTP method required to make the related call. Enum: "GET" "POST" "PUT" "DELETE" "HEAD" "CONNECT" "OPTIONS" "PATCH"

{"href": "string",
"rel": "string",
"method": "GET"
}

Link Description

The request-related HATEOAS link information.

href required	string 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.
rel required	string The link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.
method	string The HTTP method required to make the related call. Enum: "GET" "POST" "PUT" "DELETE" "HEAD" "CONNECT" "OPTIONS" "PATCH"

{"href": "string",
"rel": "string",
"method": "GET"
}

merchant_integration

The merchant-integration status information for a partner.

tracking_id	string The partner-provided tracking ID, if one was provided.
merchant_id	string The payer ID of the seller after creation of their PayPal account.
given_name	string [ 1 .. 140 ] characters ^[a-zA-Z ,.'-]+$ The given name of the seller. Only available for casual sellers.
surname	string [ 1 .. 140 ] characters ^[a-zA-Z ,.'-]+$ The surname of the seller. Only available for casual sellers.
	Array of objects (Product) An array of all products that are integrated with the partner for the seller.
payments_receivable	boolean Indicates whether the seller account can receive payments.
legal_name	string The legal business name of the seller.
primary_email_confirmed	boolean Indicates whether the primary email of the seller has been confirmed.
primary_email	string The primary email address of the seller.
date_created	string The date when the seller account was created, in Internet date and time format.
granted_permissions	Array of strings An array of permissions granted to the partner by the seller. Items Enum: "EXPRESS_CHECKOUT" "REFUND" "DIRECT_PAYMENT" "AUTH_CAPTURE" "BUTTON_MANAGER" "ACCOUNT_BALANCE" "TRANSACTION_DETAILS" "TRANSACTION_SEARCH" "REFERENCE_TRANSACTION" "RECURRING_PAYMENTS" "BILLING_AGREEMENT" "MANAGE_PENDING_TRANSACTION_STATUS" "NON_REFERENCED_CREDIT" "MASS_PAY" "ENCRYPTED_WEBSITE_PAYMENTS" "SETTLEMENT_CONSOLIDATION" "SETTLEMENT_REPORTING" "MOBILE_CHECKOUT" "AIR_TRAVEL" "INVOICING" "RECURRING_PAYMENT_REPORT" "EXTENDED_PRO_PROCESSING_REPORT" "EXCEPTION_PROCESSING_REPORT" "TRANSACTION_DETAIL_REPORT" "ACCOUNT_MANAGEMENT_PERMISSION" "ACCESS_BASIC_PERSONAL_DATA" "ACCESS_ADVANCED_PERSONAL_DATA"
oauth_integrations	Array of objects (merchant_integration) An array of information about OAuth integrations between partners and sellers.
	Array of objects (limitation) An array of limitations on the seller account.
	Array of objects (Account Capability) An array of capabilities associated with the products integrated between seller and partner.
	object (Credential) The API credentials of the seller.

{"tracking_id": "string",
"merchant_id": "string",
"given_name": "string",
"surname": "string",
"products": [{"name": "EXPRESS_CHECKOUT",
"vetting_status": "APPROVED",
"status": "ACTIVE",
"capabilities": ["APPLE_PAY"
]
}
],
"payments_receivable": true,
"legal_name": "string",
"primary_email_confirmed": true,
"primary_email": "string",
"date_created": "string",
"granted_permissions": ["EXPRESS_CHECKOUT"
],
"oauth_integrations": [{ }
],
"limitations": [{"name": "string",
"restrictions": ["string"
]
}
],
"capabilities": [{"limits": [{"type": "GENERAL"
}
],
"name": "APPLE_PAY",
"status": "ACTIVE"
}
],
"api_credentials": {"signature": {"api_user_name": "string",
"api_password": "string",
"signature": "string"
},
"certificate": {"api_user_name": "string",
"api_password": "string",
"fingerprint": "string",
"download_link": "string"
}
}
}

merchant_integration_credentials

The merchant-integration merchant credentials for a downloadable cart seller.

client_id	string [ 1 .. 255 ] characters The client ID of the seller.
client_secret	string [ 1 .. 255 ] characters The client secret of the seller.
payer_id	string [ 1 .. 255 ] characters The payer ID of the seller and the pattern is not provided because the value is defined by an external party.

{"client_id": "string",
"client_secret": "string",
"payer_id": "string"
}

Message

The user- and seller-provided messages.

message	string <= 255 characters The message text.
language_code	string The locale code for the language of the message, such as `en_US`.

{"message": "string",
"language_code": "string"
}

Name

The name of the party.

prefix	string <= 140 characters The prefix, or title, to the party's name.
given_name	string <= 140 characters When the party is a person, the party's given, or first, name.
surname	string <= 140 characters 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.
middle_name	string <= 140 characters 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.
suffix	string <= 140 characters The suffix for the party's name.
alternate_full_name	string <= 300 characters DEPRECATED. The party's alternate name. Can be a business name, nickname, or any other name that cannot be split into first, last name. Required when the party is a business.
full_name	string <= 300 characters When the party is a person, the party's full name.

{"prefix": "string",
"given_name": "string",
"surname": "string",
"middle_name": "string",
"suffix": "string",
"alternate_full_name": "string",
"full_name": "string"
}

oauth_integration

The status of the oauth-integration between a partner and seller.

integration_type	string The type of integration between the partner and the seller. Enum: "FIRST_PARTY_INTEGRATED" "FIRST_PARTY_NON_INTEGRATED" "THIRD_PARTY" "OAUTH_THIRD_PARTY"
integration_method	string The integration method that the partner uses to integrate with PayPal APIs. Enum: "PAYPAL" "BRAINTREE"
status	string The integration status. Enum: "A" "I"
	Array of objects (oauth_third_party) An array of combinations of `partner_client_id` and `merchant_client_id` values and their associated scopes.

{"integration_type": "FIRST_PARTY_INTEGRATED",
"integration_method": "PAYPAL",
"status": "A",
"oauth_third_party": [{"partner_client_id": "string",
"merchant_client_id": "string",
"scopes": ["string"
],
"access_token": "string",
"refresh_token": "string"
}
]
}

oauth_third_party

The seller third-party information for REST API.

partner_client_id	string The client ID of the partner's API caller account.
merchant_client_id	string The client ID of the seller.
scopes	Array of strings An array of scopes that the seller granted the partner.
access_token	string The access token for the partner-selected integration method.
refresh_token	string The refresh token for the partner-selected integration method.

{"partner_client_id": "string",
"merchant_client_id": "string",
"scopes": ["string"
],
"access_token": "string",
"refresh_token": "string"
}

Office_bearer

The office bearers of the account.

Array of objects (phone_details) [ 1 .. 10 ] items

An array of contact phone numbers for the customer.

object (Name)

The legal name of the customer.

object (Simple Postal Address (Coarse-Grained))

The home address of the account holder.

nationality_country_code

string <ppaas_common_country_code_v2> (country_code) = 2 characters ^([A-Z]{2}|C2)$

The citizenship country code of the person

role

string (Role type) [ 1 .. 255 ] characters ^[0-9A-Z_]+$

The role of the person in the company.

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

{"phone_contacts": [{"phone_number_details": {"country_code": "str",
"national_number": "string",
"extension_number": "string"
},
"phone_type": "FAX"
}
],
"name": {"prefix": "string",
"given_name": "string",
"surname": "string",
"middle_name": "string",
"suffix": "string",
"alternate_full_name": "string",
"full_name": "string"
},
"home_address": {"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"country_code": "st",
"postal_code": "string"
},
"nationality_country_code": "st",
"role": "CEO"
}

Partner

The seller acquisition partner-related information. Defines the settings for the customized onboarding experience of the seller.

partner_id

string

The account ID of the partner.

launch_type

string

Default: "FULL_BROWSER"

Indicates whether the onboarding occurs in a full browser, mini-browser, or light box.

Enum: "FULL_BROWSER" "LIGHT_BOX" "EMBEDDED" "MINI_BROWSER"

receives_credential

boolean

Default: false

Indicates whether the partner is integrated to receive a seller credential.

product_selection

string

Indicates whether the seller can select a product with which to integrate.

Enum Value	Description
Y	The seller can choose a partner-supported product.
N	A product change is not allowed.
P	The seller can choose any product.

logo_url

string <uri>

The partner logo URL. Provides a way for partners to update their logo through preferences. This logo over-writes any image URL provided earlier for their business accounts.

notification_url

string <uri>

The partner-provided URL for notifications.

Array of objects (merchant_integration)

An array of required information for a partner to integrate this product. Varies based on the product to integrate.

Array of objects (region_preferences)

An array of region-specific preferences.

agreement_types

Array of any

An array of partner-accepted agreements.

Items Value: "VENDOR_SECURITY_POLICY_AGREEMENT"

display_name

string

The display name of the partner.

{"partner_id": "string",
"launch_type": "FULL_BROWSER",
"receives_credential": false,
"product_selection": "Y",
"logo_url": "http://example.com",
"notification_url": "http://example.com",
"integration_preferences": [{"tracking_id": "string",
"merchant_id": "string",
"given_name": "string",
"surname": "string",
"products": [{"name": "EXPRESS_CHECKOUT",
"vetting_status": "APPROVED",
"status": "ACTIVE",
"capabilities": ["APPLE_PAY"
]
}
],
"payments_receivable": true,
"legal_name": "string",
"primary_email_confirmed": true,
"primary_email": "string",
"date_created": "string",
"granted_permissions": ["EXPRESS_CHECKOUT"
],
"oauth_integrations": [{ }
],
"limitations": [{"name": "string",
"restrictions": ["string"
]
}
],
"capabilities": [{"limits": [{"type": "GENERAL"
}
],
"name": "APPLE_PAY",
"status": "ACTIVE"
}
],
"api_credentials": {"signature": {"api_user_name": "string",
"api_password": "string",
"signature": "string"
},
"certificate": {"api_user_name": "string",
"api_password": "string",
"fingerprint": "string",
"download_link": "string"
}
}
}
],
"region_preferences": [{"country_code": "string",
"product_preferences": [{ }
],
"return_message": [{"message": "string",
"language_code": "string"
}
]
}
],
"agreement_types": ["VENDOR_SECURITY_POLICY_AGREEMENT"
],
"display_name": "string"
}

partner_specific_identifier

The identifier for the customer in the partner's system.

type required	string The identifier type. Value: "TRACKING_ID"
value required	string The identifier value.

{"type": "TRACKING_ID",
"value": "string"
}

Person

Details of the person party.

	Array of objects (phone_details) [ 1 .. 10 ] items An array of contact phone numbers for the customer.
	object (Name) The legal name of the customer.
	object (Simple Postal Address (Coarse-Grained)) The home address of the account holder.
nationality_country_code	string <ppaas_common_country_code_v2> (country_code) = 2 characters ^([A-Z]{2}\|C2)$ The citizenship country code of the person

{"phone_contacts": [{"phone_number_details": {"country_code": "str",
"national_number": "string",
"extension_number": "string"
},
"phone_type": "FAX"
}
],
"name": {"prefix": "string",
"given_name": "string",
"surname": "string",
"middle_name": "string",
"suffix": "string",
"alternate_full_name": "string",
"full_name": "string"
},
"home_address": {"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"country_code": "st",
"postal_code": "string"
},
"nationality_country_code": "st"
}

person_details

The customer's personal details.

	Array of objects (phone_details) An array of contact phone numbers for the customer.
	Array of objects (identity_document) An array of documents that uniquely identify the user, such as a license number, social security number, and so on.
	Array of objects (Seller Account Relationship) An array of familial relationships that are attached to a seller.
email_address	string <ppaas_common_email_address_v2> (email_address) [ 3 .. 254 ] characters ^.+@[^"\-].+$ The primary email address of the account.
	object (Name) The legal name of the customer.
	object (Simple Postal Address (Coarse-Grained)) The home address of the account holder.
nationality_country_code	string <ppaas_common_country_code_v2> (country_code) = 2 characters ^([A-Z]{2}\|C2)$ The two-character ISO-3166-1 country code for the nationality of the account holder. Can include one of the PayPal-supported countries.

{"phone_contacts": [{"phone_number_details": {"country_code": "str",
"national_number": "string",
"extension_number": "string"
},
"phone_type": "FAX"
}
],
"identity_documents": [{"value": "string",
"partial_value": false,
"issuer_country_code": "string",
"type": "SOCIAL_SECURITY_NUMBER"
}
],
"account_owner_relationships": [{"relation": "MOTHER",
"name": {"prefix": "string",
"given_name": "string",
"surname": "string",
"middle_name": "string",
"suffix": "string",
"alternate_full_name": "string",
"full_name": "string"
},
"country_code_of_nationality": "string"
}
],
"email_address": "string",
"name": {"prefix": "string",
"given_name": "string",
"surname": "string",
"middle_name": "string",
"suffix": "string",
"alternate_full_name": "string",
"full_name": "string"
},
"home_address": {"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"country_code": "st",
"postal_code": "string"
},
"nationality_country_code": "string"
}

Phone

The phone number, in its canonical international E.164 numbering plan format.

country_code required	string [ 1 .. 3 ] characters ^[0-9]{1,3}?$ The country calling code (CC), in its canonical international E.164 numbering plan format. The combined length of the CC and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).
national_number required	string [ 1 .. 14 ] characters ^[0-9]{1,14}?$ The national number, in its canonical international E.164 numbering plan format. The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).
extension_number	string [ 1 .. 15 ] characters ^[0-9]{1,15}?$ The extension number.

{"country_code": "str",
"national_number": "string",
"extension_number": "string"
}

Phone Type

The phone type.

string (Phone Type)

The phone type.

Enum: "FAX" "HOME" "MOBILE" "OTHER" "PAGER"

"FAX"

phone_details

The phone number and the phone type.

required	object (Phone) The phone number details.
phone_type required	string (Phone Type) The phone type. Enum: "FAX" "HOME" "MOBILE" "OTHER" "PAGER"

{"phone_number_details": {"country_code": "str",
"national_number": "string",
"extension_number": "string"
},
"phone_type": "FAX"
}

Product

The seller product information.

name

string

The name of the product.

Enum: "EXPRESS_CHECKOUT" "WEBSITE_PAYMENTS_STANDARD" "MASS_PAYMENT" "EMAIL_PAYMENTS" "EBAY_CHECKOUT" "PAYFLOW_LINK" "PAYFLOW_PRO" "WEBSITE_PAYMENTS_PRO_3_0" "WEBSITE_PAYMENTS_PRO_2_0" "VIRTUAL_TERMINAL" "HOSTED_SOLE_SOLUTION" "BILL_ME_LATER" "MOBILE_EXPRESS_CHECKOUT" "PAYPAL_HERE" "MOBILE_IN_STORE" "PAYPAL_STANDARD" "MOBILE_PAYPAL_STANDARD" "MOBILE_PAYMENT_ACCEPTANCE" "PAYPAL_ADVANCED" "PAYPAL_PRO" "ENHANCED_RECURRING_PAYMENTS" "PPCP_STANDARD" "PPCP_CUSTOM"

vetting_status

string

The risk vetting status of product, if applicable.

Enum: "APPROVED" "PENDING" "DECLINED" "SUBSCRIBED" "IN_REVIEW" "NEED_MORE_DATA" "DENIED"

status

string

The status of product bundle, if applicable.

Enum: "ACTIVE" "INACTIVE" "PENDING"

capabilities

Array of strings (Capability Name)

An array of the capability names bundled in the parent product.

Items Enum Value	Description
APPLE_PAY	Enables Apple Pay capability. Supported only when PAYMENT_METHODS or PPCP, PAYMENT_METHODS is requested.
SEND_INVOICE	Enables users to request money by sending an invoice to another customer.
ACCEPT_DONATIONS	A tailored donations solution for individuals, businesses, and non-profit customers to accept one-time and recurring donations via a Donate button, shareable link, or QR code.
ACCEPT_PYMTS_VIA_ALIPAY	Alipay is a China-based payment method that allows customers to complete transactions online using their Alipay wallet.
ACCEPT_PYMTS_VIA_BANCONTACT	Bancontact is a Belgium-based payment method that allows customers to complete transactions online using their bank credentials.
ACCEPT_PYMTS_VIA_BLIK	Blik is a Poland-based payment method that allows customers to complete transactions online using their bank credentials.
ACCEPT_PYMTS_VIA_EPS	EPS is an Austria-based payment method that allows customers to complete transactions online using their bank credentials.
ACCEPT_PYMTS_VIA_IDEAL	iDEAL is a Netherlands-based payment method that allows customers to complete transactions online using their bank credentials.
ACCEPT_PYMTS_VIA_MB_WAY	MB Way is a Portugal-based payment method that allows customers to complete transactions online using their MB Way wallet.
ACCEPT_PYMTS_VIA_MULTIBANCO	Multibanco is a Portugal-based payment method that allows customers to complete transactions online using their bank credentials or pay in cash at a bank branch.
ACCEPT_PYMTS_VIA_PRZELEWY24	Przelewy24 is a Poland-based payment method that allows customers to complete transactions online.
ACCEPT_PYMTS_VIA_SATISPAY	Satispay is an Italy-based payment method that allows customers to complete transactions online using their bank credentials.
ACCEPT_PYMTS_VIA_TRUSTLY	Trustly is a payment method that allows customers from (Austria (AT), Germany (DE), Denmark (DK), Estonia (EE), Spain (ES), Finland (FI), Great Britain (GB), Lithuania (LT), Latvia (LV), Netherlands (NL), Norway (NO), Sweden (SE)) to complete transactions online using their bank credentials.
ACCEPT_PYMTS_VIA_WECHAT_PAY	WeChat Pay is a China-based payment method that allows customers to complete transactions online using their WeChat Pay wallet.
GOOGLE_PAY	Receive unbranded card payments - Debit or Credit through Google Pay.
CARD_PROCESSING_VIRTUAL_TERMINAL	Enable merchant to receive direct credit card payment via phone/fax/mail. Merchant initiates transaction enters card into virtual terminal
AMEX_OPTBLUE	Enable merchant to accept AMEX. They can receive marketing communication from American express.
CUSTOM_CARD_PROCESSING	Receive direct credit card payment (card-not-present transactions)
FRAUD_TOOL_ACCESS	Access Fraud Protection tool (powered by Simility)
DEBIT_CARD_SWITCH	Receive debit card payment
COMMERCIAL_ENTITY	Merchant is considered as a commercial entity and hence needs to comply with the requirements and use the benefits, such as CE agreement and treatment on the credit card descriptor
GUEST_CHECKOUT	Merchant checkout feature that provides businesses the ability to accept payments from consumers without a PayPal account using a credit or debit card through PayPal.
PAYPAL_CHECKOUT	Receive credit card payment via inline /guest checkout
SUBSCRIPTIONS	Allow merchants to create stable, predictable income by offering subscription plans.
VENMO_PAY_PROCESSING	Receive Venmo pay
PAYPAL_CHECKOUT_ALTERNATIVE_PAYMENT_METHODS	Receive local payment methods specific to a buyer region (eg Giropay, Ideal, Sofort)
QR_CODE	Provide the Integrated QRC solution that is intended to be integrated with Partners who already provide payment acceptance via APMs directly to merchants.
INSTALLMENTS	Merchants can offer equal payment installment financing options as part of the revolving account.
PAYPAL_CHECKOUT_PAY_WITH_PAYPAL_CREDIT	PayPal Checkout - Pay with PayPal Credit.
PAYPAL_WALLET_VAULTING_ADVANCED	Enables the capability to Save payment methods. Supported only when one of PPCP and ADVANCED_VAULTING or EXPRESS_CHECKOUT and ADVANCED_VAULTING combination in the products array is requested.
WITHDRAW_FUNDS_TO_DOMESTIC_BANK	Withdraw money from their PayPal balance to a linked domestic bank account.

{"name": "EXPRESS_CHECKOUT",
"vetting_status": "APPROVED",
"status": "ACTIVE",
"capabilities": ["APPLE_PAY"
]
}

product_integration

The required information for a partner to integrate this product.

product	string The product. Enum: "EXPRESS_CHECKOUT" "WEBSITE_PAYMENTS_STANDARD" "MASS_PAYMENT" "EMAIL_PAYMENTS" "EBAY_CHECKOUT" "PAYFLOW_LINK" "PAYFLOW_PRO" "WEBSITE_PAYMENTS_PRO_3_0" "WEBSITE_PAYMENTS_PRO_2_0" "VIRTUAL_TERMINAL" "HOSTED_SOLE_SOLUTION" "BILL_ME_LATER" "MOBILE_EXPRESS_CHECKOUT" "PAYPAL_HERE" "MOBILE_IN_STORE" "PAYPAL_STANDARD" "MOBILE_PAYPAL_STANDARD" "MOBILE_PAYMENT_ACCEPTANCE" "PAYPAL_ADVANCED" "PAYPAL_PRO" "ENHANCED_RECURRING_PAYMENTS"
integration_type	string The integration type for the product as third or first party or sellers that are onboarded through this partner. Enum: "FIRST_PARTY" "THIRD_PARTY"
credential_type	string The credential type for a first-party integration. Required if `integration_type` is provided. Enum: "SIGNATURE" "CERTIFICATE" "OAUTH_TOKEN"
permissions	Array of strings An array of permissions that the partner expects that the seller has granted for a third-party integration. Different products need different permissions, so permissions also depend on the product. Items Enum: "EXPRESS_CHECKOUT" "REFUND" "DIRECT_PAYMENT" "AUTH_CAPTURE" "BUTTON_MANAGER" "ACCOUNT_BALANCE" "TRANSACTION_DETAILS" "TRANSACTION_SEARCH" "REFERENCE_TRANSACTION" "RECURRING_PAYMENTS" "BILLING_AGREEMENT" "MANAGE_PENDING_TRANSACTION_STATUS" "NON_REFERENCED_CREDIT" "MASS_PAY" "ENCRYPTED_WEBSITE_PAYMENTS" "SETTLEMENT_CONSOLIDATION" "SETTLEMENT_REPORTING" "MOBILE_CHECKOUT" "AIR_TRAVEL" "INVOICING" "RECURRING_PAYMENT_REPORT" "EXTENDED_PRO_PROCESSING_REPORT" "EXCEPTION_PROCESSING_REPORT" "TRANSACTION_DETAIL_REPORT" "ACCOUNT_MANAGEMENT_PERMISSION" "ACCESS_BASIC_PERSONAL_DATA" "ACCESS_ADVANCED_PERSONAL_DATA"

{"product": "EXPRESS_CHECKOUT",
"integration_type": "FIRST_PARTY",
"credential_type": "SIGNATURE",
"permissions": ["EXPRESS_CHECKOUT"
]
}

product_name

The PayPal product for which the customer is onboarded.

string (product_name)

The PayPal product for which the customer is onboarded.

Enum: "EXPRESS_CHECKOUT" "PPPLUS" "WP_PRO" "PPCP" "PAYMENT_METHODS" "ADVANCED_VAULTING"

"EXPRESS_CHECKOUT"

product_preferences

The product preferences. A partner can customize these preferences based on the country and product.

product

string

The product to which these preferences belong.

url

string <uri> <= 2048 characters

The URL to which to redirect the seller after sign-up is complete.

{"product": "EXPRESS_CHECKOUT",
"url": "http://example.com"
}

purpose_code

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.

string (purpose_code)

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.

Enum: "P0104" "P0301" "P0801" "P0802" "P0803" "P0805" "P0806" "P0902" "P1004" "P1005" "P1006" "P1007" "P1008" "P1009"

"P0104"

referral_data

The referral data that partners share with PayPal.

	Array of objects (capability) An array of capabilities to enable for the customer while he or she shares the data.
	Array of objects (legal_consent) 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.
products	Array of strings (product_name) An array of PayPal products to which the partner wants to onboard the customer. Items Enum: "EXPRESS_CHECKOUT" "PPPLUS" "WP_PRO" "PPCP" "PAYMENT_METHODS" "ADVANCED_VAULTING"
	object (user) The customer's business and personal data that is required to create an account.
	object (web_experience_preference) The preference to customize the web experience of the customer.

{"requested_capabilities": [{"capability": "API_INTEGRATION",
"api_integration_preference": {"partner_id": "string",
"rest_api_integration": {"integration_method": "PAYPAL",
"integration_type": "string"
},
"rest_third_party_details": {"partner_client_id": "string",
"feature_list": ["PAYMENT"
]
},
"rest_first_party_details": {"partner_client_id": "string",
"feature_list": ["PAYMENT"
],
"seller_nonce": "stringstringstringstringstringstringstringst"
}
},
"billing_agreement": {"description": "string",
"billing_experience_preference": {"experience_id": "string",
"billing_context_set": true
},
"merchant_custom_data": "string",
"approval_url": "http://example.com",
"ec_token": "string"
}
}
],
"collected_consents": [{"type": "SHARE_DATA_CONSENT",
"granted": true
}
],
"products": ["EXPRESS_CHECKOUT"
],
"customer_data": {"customer_type": "CONSUMER",
"person_details": {"phone_contacts": [{"phone_number_details": {"country_code": "str",
"national_number": "string",
"extension_number": "string"
},
"phone_type": "FAX"
}
],
"identity_documents": [{"value": "string",
"partial_value": false,
"issuer_country_code": "string",
"type": "SOCIAL_SECURITY_NUMBER"
}
],
"account_owner_relationships": [{"relation": "MOTHER",
"name": {"prefix": "string",
"given_name": "string",
"surname": "string",
"middle_name": "string",
"suffix": "string",
"alternate_full_name": "string",
"full_name": "string"
},
"country_code_of_nationality": "string"
}
],
"email_address": "string",
"name": {"prefix": "string",
"given_name": "string",
"surname": "string",
"middle_name": "string",
"suffix": "string",
"alternate_full_name": "string",
"full_name": "string"
},
"home_address": {"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"country_code": "st",
"postal_code": "string"
},
"nationality_country_code": "string"
},
"business_details": {"phone_contacts": [{"phone_number_details": {"country_code": "str",
"national_number": "string",
"extension_number": "string"
},
"phone_type": "FAX"
}
],
"business_type": "string",
"business_subtype": "ASSO_TYPE_INCORPORATED",
"category": "string",
"sub_category": "string",
"merchant_category_code": "string",
"purpose_code": ["P0104"
],
"names": [{"type": "LEGAL",
"name": "string"
}
],
"business_description": "string",
"event_dates": [{"event_date": "2019-08-24T14:15:22Z",
"event_type": "BIRTH"
}
],
"website_urls": ["http://example.com"
],
"identity_documents": [{"value": "string",
"partial_value": false,
"issuer_country_code": "string",
"type": "SOCIAL_SECURITY_NUMBER"
}
],
"email_contacts": [{"email_address": "string",
"role": "CUSTOMER_SERVICE"
}
],
"office_bearers": [{"phone_contacts": [{"phone_number_details": {"country_code": null,
"national_number": null,
"extension_number": null
},
"phone_type": "FAX"
}
],
"name": {"prefix": "string",
"given_name": "string",
"surname": "string",
"middle_name": "string",
"suffix": "string",
"alternate_full_name": "string",
"full_name": "string"
},
"home_address": {"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"country_code": "st",
"postal_code": "string"
},
"nationality_country_code": "st",
"role": "CEO"
}
],
"business_address": {"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"country_code": "st",
"postal_code": "string"
},
"annual_sales_volume_range": {"minimum_amount": {"currency": "string",
"value": "string"
},
"maximum_amount": {"currency": "string",
"value": "string"
}
},
"average_monthly_volume_range": {"minimum_amount": {"currency": "string",
"value": "string"
},
"maximum_amount": {"currency": "string",
"value": "string"
}
},
"country_of_incorporation": "string",
"beneficial_owners": {"individual_beneficial_owners": [{"phone_contacts": [{"phone_number_details": null,
"phone_type": null
}
],
"name": {"prefix": "string",
"given_name": "string",
"surname": "string",
"middle_name": "string",
"suffix": "string",
"alternate_full_name": "string",
"full_name": "string"
},
"home_address": {"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"country_code": "st",
"postal_code": "string"
},
"nationality_country_code": "st",
"percentage_of_ownership": "string"
}
],
"business_beneficial_owners": [{"names": [{"type": null,
"name": null
}
],
"phone_contacts": [{"phone_number_details": null,
"phone_type": null
}
],
"business_type": "string",
"category": "string",
"sub_category": "string",
"merchant_category_code": "string",
"purpose_code": ["P0104"
],
"website_urls": ["http://example.com"
],
"business_address": {"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"country_code": "st",
"postal_code": "string"
},
"business_subtype": "ASSO_TYPE_INCORPORATED",
"annual_sales_volume_range": {"minimum_amount": {"currency": null,
"value": null
},
"maximum_amount": {"currency": null,
"value": null
}
},
"average_monthly_volume_range": {"minimum_amount": {"currency": null,
"value": null
},
"maximum_amount": {"currency": null,
"value": null
}
},
"percentage_of_ownership": "string"
}
]
}
},
"financial_instrument_data": {"bank_details": [{"nick_name": "string",
"account_number": "string",
"account_type": "CHECKING",
"currency_code": "string",
"identifiers": [{"type": "ROUTING_NUMBER_1",
"value": "string"
}
],
"mandate_agreed": true,
"branch_location": {"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"country_code": "st",
"postal_code": "string"
}
}
]
},
"preferred_language_code": "string",
"primary_currency_code": null,
"partner_specific_identifiers": [{"type": "TRACKING_ID",
"value": "string"
}
],
"referral_user_payer_id": {"type": "PAYER_ID",
"value": "string"
}
},
"web_experience_preference": {"partner_logo_url": "http://example.com",
"return_url": "http://example.com",
"return_url_description": "string",
"action_renewal_url": "http://example.com",
"show_add_credit_card": true,
"show_mobile_confirm": true,
"use_mini_browser": true,
"use_hua_email_confirmation": true
}
}

referral_data_response

The share referral data response.

partner_referral_id	string The ID to access the customer's data shared by the partner with PayPal.
submitter_payer_id	string The payer ID of the partner who shared the referral data.
	Array of objects (Link Description) An array of request-related HATEOAS links.
	object (referral_data) The referral data that partners share with PayPal.

{"partner_referral_id": "string",
"submitter_payer_id": "string",
"links": [{"href": "string",
"rel": "string",
"method": "GET"
}
],
"referral_data": {"requested_capabilities": [{"capability": "API_INTEGRATION",
"api_integration_preference": {"partner_id": "string",
"rest_api_integration": {"integration_method": "PAYPAL",
"integration_type": "string"
},
"rest_third_party_details": {"partner_client_id": "string",
"feature_list": ["PAYMENT"
]
},
"rest_first_party_details": {"partner_client_id": "string",
"feature_list": ["PAYMENT"
],
"seller_nonce": "stringstringstringstringstringstringstringst"
}
},
"billing_agreement": {"description": "string",
"billing_experience_preference": {"experience_id": "string",
"billing_context_set": true
},
"merchant_custom_data": "string",
"approval_url": "http://example.com",
"ec_token": "string"
}
}
],
"collected_consents": [{"type": "SHARE_DATA_CONSENT",
"granted": true
}
],
"products": ["EXPRESS_CHECKOUT"
],
"customer_data": {"customer_type": "CONSUMER",
"person_details": {"phone_contacts": [{"phone_number_details": {"country_code": "str",
"national_number": "string",
"extension_number": "string"
},
"phone_type": "FAX"
}
],
"identity_documents": [{"value": "string",
"partial_value": false,
"issuer_country_code": "string",
"type": "SOCIAL_SECURITY_NUMBER"
}
],
"account_owner_relationships": [{"relation": "MOTHER",
"name": {"prefix": "string",
"given_name": "string",
"surname": "string",
"middle_name": "string",
"suffix": "string",
"alternate_full_name": "string",
"full_name": "string"
},
"country_code_of_nationality": "string"
}
],
"email_address": "string",
"name": {"prefix": "string",
"given_name": "string",
"surname": "string",
"middle_name": "string",
"suffix": "string",
"alternate_full_name": "string",
"full_name": "string"
},
"home_address": {"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"country_code": "st",
"postal_code": "string"
},
"nationality_country_code": "string"
},
"business_details": {"phone_contacts": [{"phone_number_details": {"country_code": "str",
"national_number": "string",
"extension_number": "string"
},
"phone_type": "FAX"
}
],
"business_type": "string",
"business_subtype": "ASSO_TYPE_INCORPORATED",
"category": "string",
"sub_category": "string",
"merchant_category_code": "string",
"purpose_code": ["P0104"
],
"names": [{"type": "LEGAL",
"name": "string"
}
],
"business_description": "string",
"event_dates": [{"event_date": "2019-08-24T14:15:22Z",
"event_type": "BIRTH"
}
],
"website_urls": ["http://example.com"
],
"identity_documents": [{"value": "string",
"partial_value": false,
"issuer_country_code": "string",
"type": "SOCIAL_SECURITY_NUMBER"
}
],
"email_contacts": [{"email_address": "string",
"role": "CUSTOMER_SERVICE"
}
],
"office_bearers": [{"phone_contacts": [{"phone_number_details": null,
"phone_type": null
}
],
"name": {"prefix": "string",
"given_name": "string",
"surname": "string",
"middle_name": "string",
"suffix": "string",
"alternate_full_name": "string",
"full_name": "string"
},
"home_address": {"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"country_code": "st",
"postal_code": "string"
},
"nationality_country_code": "st",
"role": "CEO"
}
],
"business_address": {"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"country_code": "st",
"postal_code": "string"
},
"annual_sales_volume_range": {"minimum_amount": {"currency": "string",
"value": "string"
},
"maximum_amount": {"currency": "string",
"value": "string"
}
},
"average_monthly_volume_range": {"minimum_amount": {"currency": "string",
"value": "string"
},
"maximum_amount": {"currency": "string",
"value": "string"
}
},
"country_of_incorporation": "string",
"beneficial_owners": {"individual_beneficial_owners": [{"phone_contacts": [null
],
"name": {"prefix": null,
"given_name": null,
"surname": null,
"middle_name": null,
"suffix": null,
"alternate_full_name": null,
"full_name": null
},
"home_address": {"line1": null,
"line2": null,
"city": null,
"state": null,
"country_code": null,
"postal_code": null
},
"nationality_country_code": "st",
"percentage_of_ownership": "string"
}
],
"business_beneficial_owners": [{"names": [null
],
"phone_contacts": [null
],
"business_type": "string",
"category": "string",
"sub_category": "string",
"merchant_category_code": "string",
"purpose_code": [null
],
"website_urls": [null
],
"business_address": {"line1": null,
"line2": null,
"city": null,
"state": null,
"country_code": null,
"postal_code": null
},
"business_subtype": "ASSO_TYPE_INCORPORATED",
"annual_sales_volume_range": {"minimum_amount": null,
"maximum_amount": null
},
"average_monthly_volume_range": {"minimum_amount": null,
"maximum_amount": null
},
"percentage_of_ownership": "string"
}
]
}
},
"financial_instrument_data": {"bank_details": [{"nick_name": "string",
"account_number": "string",
"account_type": "CHECKING",
"currency_code": "string",
"identifiers": [{"type": null,
"value": null
}
],
"mandate_agreed": true,
"branch_location": {"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"country_code": "st",
"postal_code": "string"
}
}
]
},
"preferred_language_code": "string",
"primary_currency_code": null,
"partner_specific_identifiers": [{"type": "TRACKING_ID",
"value": "string"
}
],
"referral_user_payer_id": {"type": "PAYER_ID",
"value": "string"
}
},
"web_experience_preference": {"partner_logo_url": "http://example.com",
"return_url": "http://example.com",
"return_url_description": "string",
"action_renewal_url": "http://example.com",
"show_add_credit_card": true,
"show_mobile_confirm": true,
"use_mini_browser": true,
"use_hua_email_confirmation": true
}
}
}

region_preferences

The region preferences.

country_code	string The two-character ISO-3166-1 country code for the country that is associated with the preferences.
product_preferences	Array of objects (region_preferences) An array of product preferences. Can change for a country or product.
	Array of objects (Message) An array of messages to the seller from the partner after completion of sign-up. The message can change by country and language.

{"country_code": "string",
"product_preferences": [{ }
],
"return_message": [{"message": "string",
"language_code": "string"
}
]
}

rest_endpoint_feature

The REST endpoint.

string (rest_endpoint_feature)

The REST endpoint.

Enum Value	Description
PAYMENT	The REST endpoint feature for payments.
REFUND	The REST endpoint feature for refunds.
PARTNER_FEE	The REST endpoint feature for partner fees.
DELAY_FUNDS_DISBURSEMENT	The REST endpoint feature for delayed funds disbursments.
READ_SELLER_DISPUTE	The REST endpoint feature for read seller disputes.
UPDATE_SELLER_DISPUTE	The REST endpoint feature for updating seller disputes.
ACCESS_MERCHANT_INFORMATION	The REST endpoint feature for allowig partner to access merchant's information.
INVOICE_READ_WRITE	The REST endpoint feature for allowig partner to access and update merchant's invoices.
ADVANCED_TRANSACTIONS_SEARCH	The REST endpoint feature for advanced transactions searches.

"PAYMENT"

Role type

Role of the person party played in the business.

string (Role type) [ 1 .. 255 ] characters ^[0-9A-Z_]+$

Role of the person party played in the business.

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

"CEO"

Seller Account Relationship

The familial relationship of the seller account owner.

relation

required

string

The type of familial relationship.

Value	Description
MOTHER	Maternal relationship.

required

object (Name)

The name of the familial relation.

country_code_of_nationality

required

string <ppaas_common_country_code_v2> (country_code) = 2 characters ^([A-Z]{2}|C2)$

The nationality of the familial relation.

{"relation": "MOTHER",
"name": {"prefix": "string",
"given_name": "string",
"surname": "string",
"middle_name": "string",
"suffix": "string",
"alternate_full_name": "string",
"full_name": "string"
},
"country_code_of_nationality": "string"
}

Signature

The signature portion of the seller credentials.

api_user_name	string The API user name of the seller.
api_password	string The API password of the seller.
signature	string The signature credential of the seller.

{"api_user_name": "string",
"api_password": "string",
"signature": "string"
}

Simple Postal Address (Coarse-Grained)

A simple postal address with coarse-grained fields. Do not use for an international address. Use for backward compatibility only. Does not contain phone.

line1 required	string The first line of the address. For example, number or street.
line2	string The second line of the address. For example, suite or apartment number.
city required	string The city name.
state	string The code for a US state or the equivalent for other countries. Required for transactions if the address is in one of these countries: Argentina, Brazil, Canada, China, India, Italy, Japan, Mexico, Thailand, or United States. Maximum length is 40 single-byte characters.
country_code required	string <ppaas_common_country_code_v2> (country_code) = 2 characters ^([A-Z]{2}\|C2)$ 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.
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.

{"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"country_code": "st",
"postal_code": "string"
}

user

The customer's business and personal data that is required to create an account.

customer_type

string

The type of PayPal account to create, which is consumer or seller.

Enum Value	Description
CONSUMER	Consumer account.
MERCHANT	Seller account.

object (person_details)

The customer's personal details.

object (business_details)

The customer's business details.

object (Financial Instrument Data)

The customer's financial instrument. Use it to add a financial instrument to the customer's PayPal account.

preferred_language_code

string (Preferred Language Code) ^([a-z]){2}_([A-Z]){2}$

The locale code of the user's preferred language.

primary_currency_code

any

The primary three-character ISO-4217 currency code of the account.

Array of objects (partner_specific_identifier)

An array of customer identifiers in the partner's system.

object (account_identifier)

The PayPal account ID of the partner.

{"customer_type": "CONSUMER",
"person_details": {"phone_contacts": [{"phone_number_details": {"country_code": "str",
"national_number": "string",
"extension_number": "string"
},
"phone_type": "FAX"
}
],
"identity_documents": [{"value": "string",
"partial_value": false,
"issuer_country_code": "string",
"type": "SOCIAL_SECURITY_NUMBER"
}
],
"account_owner_relationships": [{"relation": "MOTHER",
"name": {"prefix": "string",
"given_name": "string",
"surname": "string",
"middle_name": "string",
"suffix": "string",
"alternate_full_name": "string",
"full_name": "string"
},
"country_code_of_nationality": "string"
}
],
"email_address": "string",
"name": {"prefix": "string",
"given_name": "string",
"surname": "string",
"middle_name": "string",
"suffix": "string",
"alternate_full_name": "string",
"full_name": "string"
},
"home_address": {"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"country_code": "st",
"postal_code": "string"
},
"nationality_country_code": "string"
},
"business_details": {"phone_contacts": [{"phone_number_details": {"country_code": "str",
"national_number": "string",
"extension_number": "string"
},
"phone_type": "FAX"
}
],
"business_type": "string",
"business_subtype": "ASSO_TYPE_INCORPORATED",
"category": "string",
"sub_category": "string",
"merchant_category_code": "string",
"purpose_code": ["P0104"
],
"names": [{"type": "LEGAL",
"name": "string"
}
],
"business_description": "string",
"event_dates": [{"event_date": "2019-08-24T14:15:22Z",
"event_type": "BIRTH"
}
],
"website_urls": ["http://example.com"
],
"identity_documents": [{"value": "string",
"partial_value": false,
"issuer_country_code": "string",
"type": "SOCIAL_SECURITY_NUMBER"
}
],
"email_contacts": [{"email_address": "string",
"role": "CUSTOMER_SERVICE"
}
],
"office_bearers": [{"phone_contacts": [{"phone_number_details": {"country_code": "str",
"national_number": "string",
"extension_number": "string"
},
"phone_type": "FAX"
}
],
"name": {"prefix": "string",
"given_name": "string",
"surname": "string",
"middle_name": "string",
"suffix": "string",
"alternate_full_name": "string",
"full_name": "string"
},
"home_address": {"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"country_code": "st",
"postal_code": "string"
},
"nationality_country_code": "st",
"role": "CEO"
}
],
"business_address": {"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"country_code": "st",
"postal_code": "string"
},
"annual_sales_volume_range": {"minimum_amount": {"currency": "string",
"value": "string"
},
"maximum_amount": {"currency": "string",
"value": "string"
}
},
"average_monthly_volume_range": {"minimum_amount": {"currency": "string",
"value": "string"
},
"maximum_amount": {"currency": "string",
"value": "string"
}
},
"country_of_incorporation": "string",
"beneficial_owners": {"individual_beneficial_owners": [{"phone_contacts": [{"phone_number_details": {"country_code": null,
"national_number": null,
"extension_number": null
},
"phone_type": "FAX"
}
],
"name": {"prefix": "string",
"given_name": "string",
"surname": "string",
"middle_name": "string",
"suffix": "string",
"alternate_full_name": "string",
"full_name": "string"
},
"home_address": {"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"country_code": "st",
"postal_code": "string"
},
"nationality_country_code": "st",
"percentage_of_ownership": "string"
}
],
"business_beneficial_owners": [{"names": [{"type": "LEGAL",
"name": "string"
}
],
"phone_contacts": [{"phone_number_details": {"country_code": null,
"national_number": null,
"extension_number": null
},
"phone_type": "FAX"
}
],
"business_type": "string",
"category": "string",
"sub_category": "string",
"merchant_category_code": "string",
"purpose_code": ["P0104"
],
"website_urls": ["http://example.com"
],
"business_address": {"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"country_code": "st",
"postal_code": "string"
},
"business_subtype": "ASSO_TYPE_INCORPORATED",
"annual_sales_volume_range": {"minimum_amount": {"currency": "string",
"value": "string"
},
"maximum_amount": {"currency": "string",
"value": "string"
}
},
"average_monthly_volume_range": {"minimum_amount": {"currency": "string",
"value": "string"
},
"maximum_amount": {"currency": "string",
"value": "string"
}
},
"percentage_of_ownership": "string"
}
]
}
},
"financial_instrument_data": {"bank_details": [{"nick_name": "string",
"account_number": "string",
"account_type": "CHECKING",
"currency_code": "string",
"identifiers": [{"type": "ROUTING_NUMBER_1",
"value": "string"
}
],
"mandate_agreed": true,
"branch_location": {"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"country_code": "st",
"postal_code": "string"
}
}
]
},
"preferred_language_code": "string",
"primary_currency_code": null,
"partner_specific_identifiers": [{"type": "TRACKING_ID",
"value": "string"
}
],
"referral_user_payer_id": {"type": "PAYER_ID",
"value": "string"
}
}

web_experience_preference

The preference to customize the web experience of the customer.

partner_logo_url	string <uri> The partner logo URL to display in the seller onboarding flow. Note: While there is no restriction on the size of your image, PayPal forces the max width to 106px and max height to 29px. The best resolution you can provide is 106px x 29px.
return_url	string <uri> The URL to which to redirect the customer upon completion of the onboarding process.
return_url_description	string The description of the return URL.
action_renewal_url	string <uri> If `renew_action_url` expires, redirect the customer to this URL.
show_add_credit_card	boolean Indicates whether to show an add credit card page.
show_mobile_confirm	boolean Indicates whether to ask the customer to initiate confirmation of their mobile phone (the phone that the partner designated as `MOBILE` in the customer data). Default is`false`.
use_mini_browser	boolean Indicates whether to provide a single page signup flow in a mini browser. Default is to provide a full-size, multi-page flow.
use_hua_email_confirmation	boolean Indicates whether to use the `hosted_user_agreement_url` to confirm the customer's email address. If `true`, PayPal appends the email confirmation code to `hosted_user_agreement_url`, and when a customer successfully accesses the hosted user agreement URL, confirms the customer's email address. If `false`, PayPal does not append the confirmation code to the URL and does not confirm the email address.

{"partner_logo_url": "http://example.com",
"return_url": "http://example.com",
"return_url_description": "string",
"action_renewal_url": "http://example.com",
"show_add_credit_card": true,
"show_mobile_confirm": true,
"use_mini_browser": true,
"use_hua_email_confirmation": true
}

Partner Referrals (1)

Create partner referral

Request Body schema: application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/jsonrequired

Show referral data

path Parameters

List seller tracking information

path Parameters

query Parameters

Show seller status

path Parameters

query Parameters

Fetch merchant credentials

path Parameters

Show partner information - agreements and preferences

path Parameters

query Parameters

header Parameters

Request Body schema: application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json

Create partner information - agreements and preferences

path Parameters

header Parameters

Request Body schema: application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/jsonrequired

Update partner information - agreements and preferences

path Parameters

header Parameters

Request Body schema: application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/jsonrequired

Errors

INTERNAL_ERROR

PARTNER_BUSINESS_ERROR-BUSINESS_ERROR

PARTNER_BUSINESS_ERROR-CONSENT_ALREADY_EXISTS

PARTNER_BUSINESS_ERROR-FAILED_TO_SET_OAUTH_INTEGRATION

PARTNER_BUSINESS_ERROR-FAILED_WHILE_GETTING_OAUTH_INTEGRATION

PARTNER_BUSINESS_ERROR-MERCHANT_ID_SAME_AS_PARTNER_ID

PARTNER_BUSINESS_ERROR-NO_ATTRIBUTION_WITH_MERCHANT

PARTNER_BUSINESS_ERROR-PARTNER_MERCHANT_CLIENT_ASSOC_ALREADY_PRESENT

PARTNER_BUSINESS_ERROR-PARTNER_MERCHANT_CLIENT_ID_COMBINATION_INCORRECT

PARTNER_BUSINESS_ERROR-PARTNER_REFERRAL_LINK_ALREADY_EXISTS

PARTNER_BUSINESS_ERROR-PREFERENCES_ALREADY_EXIST

RESOURCE_NOT_FOUND_ERROR-AGREEMENTS_NOT_FOUND

RESOURCE_NOT_FOUND_ERROR-INTEGRATIONS_NOT_FOUND

RESOURCE_NOT_FOUND_ERROR-INVALID_CONSENT_ID

RESOURCE_NOT_FOUND_ERROR-INVALID_REFERRAL_ID

RESOURCE_NOT_FOUND_ERROR-LINK_NOT_FOUND

UNAUTHORIZED

UNAUTHORIZED-AUTHORIZATION_ERROR

UNAUTHORIZED-INVALID_CONSENT_OWNERSHIP

UNPROCESSABLE_ENTITY

USER_BUSINESS_ERROR

Definitions

Account Capability

account_identifier

bank_details

Beneficial_owners

billing_agreement

billing_experience_preference

Business

Business sub-type

Business sub-type

Business_beneficial_owner

business_details

business_name

business_type

capability

Capability Limit

Capability Name

Capability Status

Certificate

country_code

create_referral_data_response

Credential

currency

currency_range

date_of_event

email_address

email_contact

Error

Error

Error Details

Error Details

Error Details

Request Body schema:
application/json
required

Request Body schema:
application/json

Request Body schema:
application/json
required

Request Body schema:
application/json
required