Get started

Your account structure is contingent upon the settlement model you select. There are two settlement models:

Merchant Settlement account: PayPal pays your merchants directly.

Partner Settlement account: PayPal issues payments to you, and you pay your merchants.

Be sure to create all accounts as PayPal business accounts. You'll create the same accounts in both sandbox and live environments.

You need certain accounts, such as API caller and Organization accounts, for both settlement models. Other accounts, such as partner fees and settlement accounts, are necessary only for a specific model.

The following table provides an overview of the different account types in Managed Path:

After creating the accounts, use your sandbox accounts to test onboarding and transactions before going live. You'll need to create and configure accounts to support the testing process.

Create your sandbox accounts

1. Log in to your developer dashboard.
2. Select Testing Tools > Sandbox Accounts > Create account from your developer dashboard.
3. For the customized account, select Create.
   1. In Create Custom Sandbox Account, set Account type to Business.
   2. Select the appropriate country in Country/Region.
   3. In Account details, enter the account information.
   4. In Payment methods, enter the PayPal balance as zero.
   5. Select Create account.
4. Repeat Steps 2-3 for all the required PayPal accounts specific to your integration.

Create a REST API app in your sandbox account

1. From your developer dashboard, select Apps & Credentials.
2. Select Create App.
3. Enter a name for your application.
4. Under Type, select Merchant.
5. Be sure to select your API caller account as the Sandbox Business Account.
6. Select Create App.

Set up webhooks

Webhooks are HTTP callbacks that receive notification messages for events. You can subscribe to webhooks through the developer portal or by making an API call.

To subscribe to webhooks from your developer portal:

1. Log in to your developer dashboard. Select Apps & Credentials. In Production, this should be your API caller account.
2. Select the name of your REST API app for your API caller account
3. Scroll down to Sandbox Webhooks and select Add Webhook.
4. Enter the URL for your listener.
5. Add the event name by selecting the required checkboxes. Select Save.

For more information about onboarding webhooks, payment webhooks, and other types of webhooks, see webhooks.

To subscribe to webhooks by making an API call, see Webhooks for the sample requests and responses. Refer to the event names for details on the webhook type you want to subscribe to.

For successful onboarding, subscribe to the following webhooks:

1. CUSTOMER.MANAGED-ACCOUNT.ACCOUNT-CREATED, which indicates that an account is created.
2. CUSTOMER.MANAGED-ACCOUNT.ACCOUNT-STATUS-CHANGED, which indicates that the verification status of an account has changed.
3. CUSTOMER.MANAGED-ACCOUNT.ACCOUNT-UPDATED, which is returned in response to a request to edit the account data

For more information on these webhooks, see Create merchant accounts, Verify merchant accounts, and Update merchant accounts.

For configuring the applicable accounts in the Live environment, for your integration, work with your PayPal integration engineer (or Contact us) to ensure that the accounts are set up as expected.

The following credentials are essential to integrate and use PayPal REST APIs in your Managed Path integration:

• Client ID: Used to generate the access token required to make PayPal API calls in sandbox and live environments.
• BN code: Build-notation code. Used to:
• Uniquely identify the entity placing the API call as a PayPal partner.
• Enable tracking all transactions that originate from the PayPal partner.

Note: After configuring your sandbox and live accounts, your PayPal integration engineer will provide the BN code.

• Partner-merchant ID (Payer ID): Unique account ID assigned to every PayPal account. (remains constant for entire lifetime of the PayPal account).

The procedure to retrieve the Client ID is the same for sandbox and live environments. In the developer dashboard, ensure that you toggle to the appropriate environment to retrieve the correct credentials.

1. Navigate to the developer dashboard and select Apps & Credentials. The apps page is displayed. 
2. Select the appropriate app. The client ID is displayed at the top of the app settings page.

For related information, see PayPal Partner attribution ID.

After configuring your sandbox and live accounts, your PayPal integration engineer will provide the BN code.

The procedure to retrieve the partner-merchant ID is the same for sandbox and live environments. In the developer dashboard, ensure that you toggle to the appropriate environment to retrieve the correct credentials.

1. Navigate to the developer dashboard > Testing Tools > Sandbox Accounts. All configured accounts are displayed under Account Name.
2. Click on the account whose ID you want to retrieve. The Account ID (partner-merchant ID) is displayed in the Account Info section.