Business Platforms and marketplacesPlatforms Enterprise

Business Platforms and marketplaces Enterprise

Sections

Business Platforms and marketplaces Enterprise

Help

FAQs Account help Technical support API Status

APIs & SDKs

JavaScript SDK React SDK REST API Server SDKs Codes Webhook events iOS Android

Integration Details

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

classic_api_integrationobject<classic_api_integration>Optional

The integration details for PayPal CLASSIC endpoints.

rest_api_integrationobject<rest_api_integration>Optional

The integration details for PayPal REST endpoints.

rest_api_integration properties

5 properties

integration_methodenumOptional

The REST-credential integration method.

Match^[0-9A-Z_-]+$Length1 <= length <= 255

Allowed values

"BRAINTREE"
"PAYPAL"Default
"SDK"

integration_channelenumOptional

The rest api integration channel.

Match^[A-Z0-9_]+$Length1 <= length <= 128

Allowed values

"DEFERRED_ONBOARDING"

integration_typeenumRequired

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

Match^[0-9A-Z_-]+$Length1 <= length <= 255

Allowed values

"FIRST_PARTY"
"THIRD_PARTY"

first_party_detailsobject<first_party_details>Optional

The integration details for PayPal first party REST endpoints.

first_party_details properties

2 properties

featuresarray<rest_endpoint_features_enum>Required

An array of features that partner can access, or use, in PayPal on behalf of the seller. The seller grants permission for these features to the partner.

seller_noncestringRequired

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

Match^[a-zA-Z0-9-_:]+$Length44 <= length <= 128

third_party_detailsobject<third_party_details>Optional

The integration details for PayPal REST endpoints.

third_party_details properties

3 properties

featuresarray<rest_endpoint_features_enum>Optional

An array of features that partner can access, or use, in PayPal on behalf of the seller. The seller grants permission for these features to the partner.

Items0 <= length <= 20

signup_modeenum<signup_mode>Optional

Signup Mode to be used for sellers for third party integration.

Length1 <= length <= 255

Allowed values

"VERIFY_WITH_PAYPAL"

organizationstringOptional

The organization to which the account will belong in the partner’s hierarchy, as a path.

Match^.*$Length1 <= length <= 127

Back to top

Integration Details

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

classic_api_integrationobject<classic_api_integration>Optional

The integration details for PayPal CLASSIC endpoints.

rest_api_integrationobject<rest_api_integration>Optional

The integration details for PayPal REST endpoints.

rest_api_integration properties

5 properties

integration_methodenumOptional

The REST-credential integration method.

Match^[0-9A-Z_-]+$Length1 <= length <= 255

Allowed values

"BRAINTREE"
"PAYPAL"Default
"SDK"

integration_channelenumOptional

The rest api integration channel.

Match^[A-Z0-9_]+$Length1 <= length <= 128

Allowed values

"DEFERRED_ONBOARDING"

integration_typeenumRequired

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

Match^[0-9A-Z_-]+$Length1 <= length <= 255

Allowed values

"FIRST_PARTY"
"THIRD_PARTY"

first_party_detailsobject<first_party_details>Optional

The integration details for PayPal first party REST endpoints.

first_party_details properties

2 properties

featuresarray<rest_endpoint_features_enum>Required

An array of features that partner can access, or use, in PayPal on behalf of the seller. The seller grants permission for these features to the partner.

seller_noncestringRequired

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

Match^[a-zA-Z0-9-_:]+$Length44 <= length <= 128

third_party_detailsobject<third_party_details>Optional

The integration details for PayPal REST endpoints.

third_party_details properties

3 properties

featuresarray<rest_endpoint_features_enum>Optional

An array of features that partner can access, or use, in PayPal on behalf of the seller. The seller grants permission for these features to the partner.

Items0 <= length <= 20

signup_modeenum<signup_mode>Optional

Signup Mode to be used for sellers for third party integration.

Length1 <= length <= 255

Allowed values

"VERIFY_WITH_PAYPAL"

organizationstringOptional

The organization to which the account will belong in the partner’s hierarchy, as a path.

Match^.*$Length1 <= length <= 127

Integration Details

rest_api_integration properties

first_party_details properties

third_party_details properties

Back to top

On this page

On this page

Integration Details

rest_api_integration properties

first_party_details properties

third_party_details properties

Back to top

On this page

Integration Details

rest_api_integration properties

first_party_details properties

third_party_details properties

Back to top

On this page

On this page

If you accept cookies, we’ll use them to improve and customize your experience and enable our partners to show you personalized PayPal ads when you visit other sites. Manage cookies and learn more

Integration Details

rest_api_integration properties

first_party_details properties

third_party_details properties

Back to top

On this page