Adaptive Payments API Reference
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.
This reference details the endpoints and operations that are available for the PayPal Adaptive Payments API.
Adaptive Payments is another PayPal payments API with some advanced marketplace payment features, such as split and chained payments. To make an API call, see Adaptive Payments API call headers and endpoints and the API reference information below.
Adaptive Payments Endpoints
AppID with your API credentials when making Adaptive Payments API calls.
For Sandbox testing, use the following Sandbox AppID:
|API / Service||Formats||Live and Sandbox Endpoints|
|Adaptive Payments||SOAP with XML,
Name-Value Pairs (NVP),
Adaptive Payments API Operations
Note that some kinds of payments and operations require specific permission for use.
|Pay||Transfers funds from a sender's PayPal account to one or more receivers' PayPal accounts (up to 6 receivers)|
|PaymentDetails||Obtains information about a payment created with the Pay API operation|
|ExecutePayment||Executes a payment|
|GetPaymentOptions||Obtain the settings specified with the SetPaymentOptions API operation|
|GetPrePaymentDisclosure||Provide pre-payment Remittance Transfer Rule disclosure information|
|SetPaymentOptions||Sets payment options|
|Preapproval||Sets up preapprovals, which is an approval to make future payments on the sender's behalf|
|PreapprovalDetails||Obtains information about a preapproval|
|CancelPreapproval||Cancels a preapproval|
|Refund||Refunds all or part of a payment|
|ConvertCurrency||Obtains the current foreign exchange (FX) rate for a specific amount and currency|
|GetFundingPlans||Determines the funding sources that are available for a specified payment|
|GetShippingAddresses||Obtains the selected shipping address|