On this page
No Headings
The merchant-integration status information for a partner.
objecttracking_idstringThe partner-provided tracking ID, if one was provided.
merchant_idstringThe payer ID of the seller after creation of their PayPal account.
given_namestring^[a-zA-Z ,.'-]+$The given name of the seller. Only available for casual sellers.
surnamestring^[a-zA-Z ,.'-]+$The surname of the seller. Only available for casual sellers.
productsarrayAn array of all products that are integrated with the partner for the seller.
itemsobjectThe seller product information.
namestring"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", "PAYMENT_METHODS", "ADVANCED_VAULTING"The name of the product.
vetting_statusstring"APPROVED", "PENDING", "DECLINED", "SUBSCRIBED", "IN_REVIEW", "NEED_MORE_DATA", "DENIED"The risk vetting status of product, if applicable.
statusstring"ACTIVE", "INACTIVE", "PENDING"The status of product bundle, if applicable.
capabilitiesarrayAn array of the capability names bundled in the parent product.
itemsstring"APPLE_PAY", "SEND_INVOICE", "ACCEPT_DONATIONS", "ACCEPT_PYMTS_VIA_ALIPAY", "ACCEPT_PYMTS_VIA_BANCONTACT", "ACCEPT_PYMTS_VIA_BLIK", "ACCEPT_PYMTS_VIA_EPS", "ACCEPT_PYMTS_VIA_IDEAL", "ACCEPT_PYMTS_VIA_MB_WAY", "ACCEPT_PYMTS_VIA_MULTIBANCO", "ACCEPT_PYMTS_VIA_PRZELEWY24", "ACCEPT_PYMTS_VIA_SATISPAY", "ACCEPT_PYMTS_VIA_TRUSTLY", "ACCEPT_PYMTS_VIA_WECHAT_PAY", "GOOGLE_PAY", "CARD_PROCESSING_VIRTUAL_TERMINAL", "AMEX_OPTBLUE", "CUSTOM_CARD_PROCESSING", "FRAUD_TOOL_ACCESS", "DEBIT_CARD_SWITCH", "COMMERCIAL_ENTITY", "GUEST_CHECKOUT", "PAYPAL_CHECKOUT", "SUBSCRIPTIONS", "VENMO_PAY_PROCESSING", "PAYPAL_CHECKOUT_ALTERNATIVE_PAYMENT_METHODS", "QR_CODE", "INSTALLMENTS", "PAYPAL_CHECKOUT_PAY_WITH_PAYPAL_CREDIT", "PAYPAL_WALLET_VAULTING_ADVANCED", "WITHDRAW_FUNDS_TO_DOMESTIC_BANK", "CHARITY", "SMARTID_TOPUP"^[0-9A-Z_]+$The name of capability.
payments_receivablebooleanIndicates whether the seller account can receive payments.
legal_namestringThe legal business name of the seller.
primary_email_confirmedbooleanIndicates whether the primary email of the seller has been confirmed.
primary_emailstringThe primary email address of the seller.
date_createdstringThe date when the seller account was created, in Internet date and time format.
granted_permissionsarrayAn array of permissions granted to the partner by the seller.
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"The permission granted to the partner.
api_credentialsobjectThe API credentials of the seller.
signatureobjectThe signature portion of the seller credentials.
api_user_namestringThe API user name of the seller.
api_passwordstringThe API password of the seller.
signaturestringThe signature credential of the seller.
certificateobjectA certificate for seller credentials.
api_user_namestringThe API user name for the seller.
api_passwordstringThe API password for the seller.
fingerprintstringThe fingerprint.
download_linkstringThe URL to download the certificate.
oauth_integrationsarrayAn array of information about OAuth integrations between partners and sellers.
itemsobjectThe status of the oauth-integration between a partner and seller.
integration_typestring"FIRST_PARTY_INTEGRATED", "FIRST_PARTY_NON_INTEGRATED", "THIRD_PARTY", "OAUTH_THIRD_PARTY"The type of integration between the partner and the seller.
integration_methodstring"PAYPAL", "BRAINTREE"The integration method that the partner uses to integrate with PayPal APIs.
statusstring"A", "I"The integration status.
oauth_third_partyarrayAn array of combinations of partner_client_id and merchant_client_id values and their associated scopes.
itemsobjectThe seller third-party information for REST API.
partner_client_idstringThe client ID of the partner's API caller account.
merchant_client_idstringThe client ID of the seller.
scopesarrayAn array of scopes that the seller granted the partner.
itemsstringThe individual scope name.
access_tokenstringThe access token for the partner-selected integration method.
refresh_tokenstringThe refresh token for the partner-selected integration method.
limitationsarrayAn array of limitations on the seller account.
itemsobjectThe limitations on a seller account.
namestringThe title of the limitation that is applied to the account.
restrictionsarrayAn array of the restriction names.
itemsstringA restriction name.
capabilitiesarrayAn array of capabilities associated with the products integrated between seller and partner.
itemsobjectCapability associated with the account.
namestring"APPLE_PAY", "SEND_INVOICE", "ACCEPT_DONATIONS", "ACCEPT_PYMTS_VIA_ALIPAY", "ACCEPT_PYMTS_VIA_BANCONTACT", "ACCEPT_PYMTS_VIA_BLIK", "ACCEPT_PYMTS_VIA_EPS", "ACCEPT_PYMTS_VIA_IDEAL", "ACCEPT_PYMTS_VIA_MB_WAY", "ACCEPT_PYMTS_VIA_MULTIBANCO", "ACCEPT_PYMTS_VIA_PRZELEWY24", "ACCEPT_PYMTS_VIA_SATISPAY", "ACCEPT_PYMTS_VIA_TRUSTLY", "ACCEPT_PYMTS_VIA_WECHAT_PAY", "GOOGLE_PAY", "CARD_PROCESSING_VIRTUAL_TERMINAL", "AMEX_OPTBLUE", "CUSTOM_CARD_PROCESSING", "FRAUD_TOOL_ACCESS", "DEBIT_CARD_SWITCH", "COMMERCIAL_ENTITY", "GUEST_CHECKOUT", "PAYPAL_CHECKOUT", "SUBSCRIPTIONS", "VENMO_PAY_PROCESSING", "PAYPAL_CHECKOUT_ALTERNATIVE_PAYMENT_METHODS", "QR_CODE", "INSTALLMENTS", "PAYPAL_CHECKOUT_PAY_WITH_PAYPAL_CREDIT", "PAYPAL_WALLET_VAULTING_ADVANCED", "WITHDRAW_FUNDS_TO_DOMESTIC_BANK", "CHARITY", "SMARTID_TOPUP"^[0-9A-Z_]+$Name of the capability.
statusstring"ACTIVE", "SUSPENDED", "REVOKED", "APPROVED", "NEED_DATA", "DENY", "IN_REVIEW", "INACTIVE", "PENDING"^[A-Z_]+$The status of the capability.
limitsarrayAn array of limitations on the capability.
itemsobjectLimit associated with the capability.
typestring"GENERAL"^[0-9A-Z_]+$Type of the limit.