On this page
No Headings
The seller acquisition partner-related information. Defines the settings for the customized onboarding experience of the seller.
objectpartner_idstringThe account ID of the partner.
launch_typestring"FULL_BROWSER", "LIGHT_BOX", "EMBEDDED", "MINI_BROWSER""FULL_BROWSER"Indicates whether the onboarding occurs in a full browser, mini-browser, or light box.
receives_credentialbooleanfalseIndicates whether the partner is integrated to receive a seller credential.
product_selectionstring"Y", "N", "P"Indicates whether the seller can select a product with which to integrate.
logo_urlstringuriThe 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_urlstringuriThe partner-provided URL for notifications.
integration_preferencesarrayAn array of required information for a partner to integrate this product. Varies based on the product to integrate.
itemsobjectThe required information for a partner to integrate this product.
productstring"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"The product.
integration_typestring"FIRST_PARTY", "THIRD_PARTY"The integration type for the product as third or first party or sellers that are onboarded through this partner.
credential_typestring"SIGNATURE", "CERTIFICATE", "OAUTH_TOKEN"The credential type for a first-party integration. Required if integration_type is provided.
permissionsarrayAn 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.
itemsstring"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"Permission given to the partner.
region_preferencesarrayAn array of region-specific preferences.
itemsobjectThe region preferences.
country_codestringThe two-character ISO-3166-1 country code for the country that is associated with the preferences.
product_preferencesarrayAn array of product preferences. Can change for a country or product.
itemsobjectThe product preferences. A partner can customize these preferences based on the country and product.
productstring"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"The product to which these preferences belong.
urlstringuriThe URL to which to redirect the seller after sign-up is complete.
return_messagearrayAn array of messages to the seller from the partner after completion of sign-up. The message can change by country and language.
itemsobjectThe user- and seller-provided messages.
messagestringThe message text.
agreement_typesarrayAn array of partner-accepted agreements.
items"VENDOR_SECURITY_POLICY_AGREEMENT"A partner-accepted agreement.
display_namestringThe display name of the partner.