Adaptive Payments

Important: Adaptive Payments is now a limited release product. It is restricted to select partners for approved use cases and should not be used for new integrations without guidance from PayPal.

The Adaptive Payments API allows merchants and developers to pay almost anyone and set up automated payments. They can create applications that manage payments, payment pre-approvals, and refunds. They can also send money peer-to-peer, split payments in both parallel and chained models, accept guest payments, and schedule disbursements. The Adaptive Payments API works on multiple platforms including the web and mobile environments.

How it works

Merchants and developers can control their customers' entire transaction within a single interface. PayPal's Adaptive Payments API handles everything from micro-payments for digital goods to a robust payroll system.

Why use Adaptive Payments API

Adaptive Payments API allows merchants to:

Build applications to handle payments

Send simple payments to a single recipient.

Make split payments to multiple recipients.

Send chained payments to multiple recipients, one after the other. Each recipient can take a cut of the payment.

Make parallel payments to multiple recipients at the same time.

Manage refunds

Issue full or partial refunds from your own account or on behalf of someone else.

Obtain currency foreign exchange rates

Convert a specific amount or a list of amounts another currency.

Pay almost anyone with an email address

Make payments to almost anyone with an email address or mobile phone number, with or without a PayPal account. Recipients who do not have a PayPal account can create one in minutes.

Get paid by anyone

Receive payments from anyone with an email address, even if they don't have a PayPal account.

Set up pre-approved payment plans

Secure pre-approval for future payments, including single-payments, multiple-payments, and subscriptions. The payments can be for a fixed or variable amount over the term of the agreement.

Make disbursements

Make payments from any of your available payment methods. You can make payroll payments, rebate payments, reward payments, and more. Schedule disbursements up to 90 days in advance.

Embed payments in applications

Allow customers to check out without leaving your app or website and accept micro-payments for as little as 50 cents.

How to get started

Click the settings icon at the top of your PayPal account page and then click Profile and settings.

In the left menu, click My settings to confirm that your Account Type is either Premier or Business, or upgrade your account.

Check your API settings. Log into PayPal and access your profile as described in the preceding step. In the left menu, click My selling tools. In the Selling online section, click Update next to API access to verify your API access. Click the appropriate link to set up your API signature or certificate.

Test your integration using the PayPal Sandbox, as described in PayPal Sandbox Testing Guide. All Adaptive API calls in the Sandbox must have the following standard value as the App ID:
APP-80W284485P519543T

To go live with your application, follow the submission steps outlined in Go Live with Your App. When you submit your application to PayPal for review, the application is quickly scanned for the requests to PayPal operations. If no advanced operations are found, PayPal issues an App ID for the production servers at the time you submit the application. If your application uses advanced PayPal operations, or if your application implements a complex business model, you can expect the review to take approximately 10 to 15 days.

Countries with Currency Restrictions

If you are a PayPal account holder in a country with currency restrictions, make sure that your Adaptive Payment code or Mass Pay file contains requests that meet your country's requirements. If any of the Mass Pay entries do not comply with the country's restrictions, those entries will fail with an error message.

The following table lists the countries with currency restrictions and describes the restrictions that apply to Adaptive Payments and Mass Payments.

Country

Currency Code

Restrictions

Argentina

ARS

Argentine users can:

Send payments in ARS only to other Argentine users.

Send payments in other currencies to all users, including those in Argentina.

Argentine users cannot:

Send payments in ARS to users outside of Argentina.

Send payments that result in currency conversion to or from ARS.

Note: Non-Argentine users cannot hold currency balances in ARS.

Brazil

BRL

Brazilian users can:

Send payments in BRL only to other Brazilian users.

Send payments in other currencies only to those outside Brazil.

Brazilian users cannot:

Send payments to other Brazilian users in a currency other than BRL.

Send payments that result in currency conversion to or from BRL.

Note: Non-Brazilian users cannot hold currency balances in BRL.

Malaysia

MYR

Malaysian users can:

Send payments in MYR only to other Malaysian users.

Send payments in other currencies to all users, including those in Malaysia.

Malaysian users cannot:

Send payments that result in currency conversion to or from MYR.

Send MYR balances to non-Malaysian users.

Note: Non-Malaysian users cannot hold currency balances in MYR.

Developer and Merchant Support

For answers to PayPal frequently asked questions, go to our Help Center.

Join the PayPal Partner Program

Join the North America Partner Program and enjoy many valuable benefits, including access to solutions integration information, marketing tools and a listing in our Partner Directory. It's free to join! For details, visit the Partner Program website.