Operation

The required operation to share data.

Schema Information

Type:object

Properties

operationrequired

Type: string

Enum:

"API_INTEGRATION", "BANK_ADDITION", "BILLING_AGREEMENT", "CONTEXTUAL_MARKETING_CONSENT", "OFFLINE_ONBOARDING", "SALESFORCE_REFERRAL"

Pattern: ^[0-9A-Z_-]+$

Min length: 1

Max length: 255

The operation to enable for the customer. To enable the collection of the API permissions that you require to integrate with the customer, specify API_INTEGRATION. BANK_ADDITION is supported only for the US.

api_integration_preference

Type: object

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

classic_api_integration

Type: object

The integration details for PayPal CLASSIC endpoints.

rest_api_integration

Type: object

The integration details for PayPal REST endpoints.

integration_method

Type: string

Enum: "BRAINTREE", "PAYPAL", "SDK"

Pattern: ^[0-9A-Z_-]+$

Min length: 1

Max length: 255

Default: "PAYPAL"

The REST-credential integration method.

integration_channel

Type: string

Enum: "DEFERRED_ONBOARDING"

Pattern: ^[A-Z0-9_]+$

Min length: 1

Max length: 128

The rest api integration channel.

integration_typerequired

Type: string

Enum: "FIRST_PARTY", "THIRD_PARTY"

Pattern: ^[0-9A-Z_-]+$

Min length: 1

Max length: 255

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

first_party_details

Type: object

The integration details for PayPal first party REST endpoints.

featuresrequired

Type: array

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.

Array Items

items

Type: string

Enum:

"PAYOUTS", "PAYMENT", "REFUND", "FUTURE_PAYMENT", "DIRECT_PAYMENT", "PARTNER_FEE", "DELAY_FUNDS_DISBURSEMENT", "READ_SELLER_DISPUTE", "UPDATE_SELLER_DISPUTE", "ADVANCED_TRANSACTIONS_SEARCH", "SWEEP_FUNDS_EXTERNAL_SINK", "ACCESS_MERCHANT_INFORMATION", "TRACKING_SHIPMENT_READWRITE", "INVOICE_READ_WRITE", "DISPUTE_READ_BUYER", "UPDATE_CUSTOMER_DISPUTES", "VAULT", "BILLING_AGREEMENT", "WITHDRAWALS", "LINKED_FINANCIAL_INSTRUMENTS", "USER_PROFILE", "TRANSACTION_RISK_DATA", "PAYPAL_BALANCE", "EXCHANGE_CURRENCY", "SCREEN_CONTENT", "SCREEN_CONTENT_DECISIONS", "MEDIA_INVALIDATE_CACHE_READWRITE", "MEDIA_DIGITALASSETS_READWRITE", "MEDIA_DIGITALASSETS_DELETE", "COMMERCE_ADMIN"

Pattern: ^[0-9A-Z_-]+$

Min length: 1

Max length: 100

The REST endpoint.

seller_noncerequired

Type: string

Pattern: ^[a-zA-Z0-9-_:]+$

Min length: 44

Max length: 128

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

third_party_details

Type: object

The integration details for PayPal REST endpoints.

features

Type: array

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.

Array Items

items

Type: string

Enum:

"PAYOUTS", "PAYMENT", "REFUND", "FUTURE_PAYMENT", "DIRECT_PAYMENT", "PARTNER_FEE", "DELAY_FUNDS_DISBURSEMENT", "READ_SELLER_DISPUTE", "UPDATE_SELLER_DISPUTE", "ADVANCED_TRANSACTIONS_SEARCH", "SWEEP_FUNDS_EXTERNAL_SINK", "ACCESS_MERCHANT_INFORMATION", "TRACKING_SHIPMENT_READWRITE", "INVOICE_READ_WRITE", "DISPUTE_READ_BUYER", "UPDATE_CUSTOMER_DISPUTES", "VAULT", "BILLING_AGREEMENT", "WITHDRAWALS", "LINKED_FINANCIAL_INSTRUMENTS", "USER_PROFILE", "TRANSACTION_RISK_DATA", "PAYPAL_BALANCE", "EXCHANGE_CURRENCY", "SCREEN_CONTENT", "SCREEN_CONTENT_DECISIONS", "MEDIA_INVALIDATE_CACHE_READWRITE", "MEDIA_DIGITALASSETS_READWRITE", "MEDIA_DIGITALASSETS_DELETE", "COMMERCE_ADMIN"

Pattern: ^[0-9A-Z_-]+$

Min length: 1

Max length: 100

The REST endpoint.

signup_mode

Type: string

Enum: "VERIFY_WITH_PAYPAL"

Min length: 1

Max length: 255

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

organization

Type: string

Pattern: ^.*$

Min length: 1

Max length: 127

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

offline_onboarding_preference

Type: object

The preference details for offline onboarding without UI.

billing_agreement

Type: object

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

description

Type: string

Pattern: ^.+$

Min length: 1

Max length: 125

The billing agreement description.

billing_experience_preference

Type: object

The preference that customizes the billing experience of the customer.

experience_id

Type: string

Pattern: ^[a-zA-Z0-9-]+$

Min length: 1

Max length: 20

The ID of the payment web experience profile.

billing_context_set

Type: boolean

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

merchant_custom_data

Type: string

Pattern: ^[a-zA-Z0-9-]+$

Min length: 1

Max length: 125

The custom data for the billing agreement.

approval_url

Type: string

Format: uri

Min length: 1

Max length: 125

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

ec_token

Type: string

Pattern: ^[0-9A-Z_-]+$

Min length: 1

Max length: 50

The billing agreement token for the agreement.

Properties

operationrequired

Type: string

Enum:

"API_INTEGRATION", "BANK_ADDITION", "BILLING_AGREEMENT", "CONTEXTUAL_MARKETING_CONSENT", "OFFLINE_ONBOARDING", "SALESFORCE_REFERRAL"

Pattern: ^[0-9A-Z_-]+$

Min length: 1

Max length: 255

api_integration_preference

Type: object

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

classic_api_integration

Type: object

The integration details for PayPal CLASSIC endpoints.

rest_api_integration

Type: object

The integration details for PayPal REST endpoints.

integration_method

Type: string

Enum: "BRAINTREE", "PAYPAL", "SDK"

Pattern: ^[0-9A-Z_-]+$

Min length: 1

Max length: 255

Default: "PAYPAL"

The REST-credential integration method.

integration_channel

Type: string

Enum: "DEFERRED_ONBOARDING"

Pattern: ^[A-Z0-9_]+$

Min length: 1

Max length: 128

The rest api integration channel.

integration_typerequired

Type: string

Enum: "FIRST_PARTY", "THIRD_PARTY"

Pattern: ^[0-9A-Z_-]+$

Min length: 1

Max length: 255

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

first_party_details

Type: object

The integration details for PayPal first party REST endpoints.

featuresrequired

Type: array

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.

Array Items

items

Type: string

Enum:

"PAYOUTS", "PAYMENT", "REFUND", "FUTURE_PAYMENT", "DIRECT_PAYMENT", "PARTNER_FEE", "DELAY_FUNDS_DISBURSEMENT", "READ_SELLER_DISPUTE", "UPDATE_SELLER_DISPUTE", "ADVANCED_TRANSACTIONS_SEARCH", "SWEEP_FUNDS_EXTERNAL_SINK", "ACCESS_MERCHANT_INFORMATION", "TRACKING_SHIPMENT_READWRITE", "INVOICE_READ_WRITE", "DISPUTE_READ_BUYER", "UPDATE_CUSTOMER_DISPUTES", "VAULT", "BILLING_AGREEMENT", "WITHDRAWALS", "LINKED_FINANCIAL_INSTRUMENTS", "USER_PROFILE", "TRANSACTION_RISK_DATA", "PAYPAL_BALANCE", "EXCHANGE_CURRENCY", "SCREEN_CONTENT", "SCREEN_CONTENT_DECISIONS", "MEDIA_INVALIDATE_CACHE_READWRITE", "MEDIA_DIGITALASSETS_READWRITE", "MEDIA_DIGITALASSETS_DELETE", "COMMERCE_ADMIN"

Pattern: ^[0-9A-Z_-]+$

Min length: 1

Max length: 100

The REST endpoint.

seller_noncerequired

Type: string

Pattern: ^[a-zA-Z0-9-_:]+$

Min length: 44

Max length: 128

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

third_party_details

Type: object

The integration details for PayPal REST endpoints.

features

Type: array

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.

Array Items

items

Type: string

Enum:

"PAYOUTS", "PAYMENT", "REFUND", "FUTURE_PAYMENT", "DIRECT_PAYMENT", "PARTNER_FEE", "DELAY_FUNDS_DISBURSEMENT", "READ_SELLER_DISPUTE", "UPDATE_SELLER_DISPUTE", "ADVANCED_TRANSACTIONS_SEARCH", "SWEEP_FUNDS_EXTERNAL_SINK", "ACCESS_MERCHANT_INFORMATION", "TRACKING_SHIPMENT_READWRITE", "INVOICE_READ_WRITE", "DISPUTE_READ_BUYER", "UPDATE_CUSTOMER_DISPUTES", "VAULT", "BILLING_AGREEMENT", "WITHDRAWALS", "LINKED_FINANCIAL_INSTRUMENTS", "USER_PROFILE", "TRANSACTION_RISK_DATA", "PAYPAL_BALANCE", "EXCHANGE_CURRENCY", "SCREEN_CONTENT", "SCREEN_CONTENT_DECISIONS", "MEDIA_INVALIDATE_CACHE_READWRITE", "MEDIA_DIGITALASSETS_READWRITE", "MEDIA_DIGITALASSETS_DELETE", "COMMERCE_ADMIN"

Pattern: ^[0-9A-Z_-]+$

Min length: 1

Max length: 100

The REST endpoint.

signup_mode

Type: string

Enum: "VERIFY_WITH_PAYPAL"

Min length: 1

Max length: 255

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

organization

Type: string

Pattern: ^.*$

Min length: 1

Max length: 127

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

offline_onboarding_preference

Type: object

The preference details for offline onboarding without UI.

billing_agreement

Type: object

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

description

Type: string

Pattern: ^.+$

Min length: 1

Max length: 125

The billing agreement description.

billing_experience_preference

Type: object

The preference that customizes the billing experience of the customer.

experience_id

Type: string

Pattern: ^[a-zA-Z0-9-]+$

Min length: 1

Max length: 20

The ID of the payment web experience profile.

billing_context_set

Type: boolean

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

merchant_custom_data

Type: string

Pattern: ^[a-zA-Z0-9-]+$

Min length: 1

Max length: 125

The custom data for the billing agreement.

approval_url

Type: string

Format: uri

Min length: 1

Max length: 125

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

ec_token

Type: string

Pattern: ^[0-9A-Z_-]+$

Min length: 1

Max length: 50

The billing agreement token for the agreement.

Operation

Schema Information

Properties

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

Operation

Schema Information

Properties