# Adaptive Payments API Reference (/archive/adaptive-payments/api)



> **Note:** **Important:** Adaptive Payments is not available for new integrations. PayPal provides this documentation to support existing integrations. If you're starting an integration, [we recommend our latest solutions](https://www.paypal.com/us/business/accept-payments).

This reference details the endpoints and operations that are available for the PayPal [Adaptive Payments](/archive/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](/archive/adaptive-payments/integration-guide/APCallsHeadersAndPaymentTypes) and the API reference information below.

## Adaptive Payments endpoints [#adaptive-payments-endpoints]

Include an `AppID` with your [API credentials](/api/nvp-soap/apiCredentials/) when making Adaptive Payments API calls.
For Sandbox testing, use the following **Sandbox AppID**: `APP-80W284485P519543T`

| API               | Formats                                                  | Live endpoints                                             | Sandbox endpoint                                                   |
| ----------------- | -------------------------------------------------------- | ---------------------------------------------------------- | ------------------------------------------------------------------ |
| Adaptive Payments | SOAP with XML,<br />Name-Value Pairs (NVP),<br />or JSON | `https://svcs.paypal.com/AdaptivePayments/<API-Operation>` | `https://svcs.sandbox.paypal.com/AdaptivePayments/<API-Operation>` |

## Adaptive Payments API operations [#adaptive-payments-api-operations]

Note that some kinds of payments and operations require specific permission for use.

### Payments [#payments]

| API operation                                                                       | Description                                                                                                  |
| ----------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
| [Pay](/archive/adaptive-payments/api/pay)                                           | Transfers funds from a sender's PayPal account to one or more receivers' PayPal accounts (up to 6 receivers) |
| [PaymentDetails](/archive/adaptive-payments/api/payment-details)                    | Obtains information about a payment created with the Pay API operation                                       |
| [ExecutePayment](/archive/adaptive-payments/api/execute-payment)                    | Executes a payment                                                                                           |
| [GetPaymentOptions](/archive/adaptive-payments/api/get-payment-options)             | Obtain the settings specified with the SetPaymentOptions API operation                                       |
| [GetPrePaymentDisclosure](/archive/adaptive-payments/api/get-prepayment-disclosure) | Provide pre-payment Remittance Transfer Rule disclosure information                                          |
| [SetPaymentOptions](/archive/adaptive-payments/api/set-payment-options)             | Sets payment options                                                                                         |

### Preapprovals [#preapprovals]

| API operation                                                             | Description                                                                               |
| ------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| [Preapproval](/archive/adaptive-payments/api/preapproval)                 | Sets up preapprovals, which is an approval to make future payments on the sender's behalf |
| [preapproval-details](/archive/adaptive-payments/api/preapproval-details) | Obtains information about a preapproval                                                   |
| [cancel-preapproval](/archive/adaptive-payments/api/cancel-preapproval)   | Cancels a preapproval                                                                     |

### Other Operations [#other-operations]

| API Operation                                                                 | Description                                                               |
| ----------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| [Refund](/archive/adaptive-payments/api/refund)                               | Refunds all or part of a payment                                          |
| [ConvertCurrency](/archive/adaptive-payments/api/convert-currency)            | Obtains the current foreign exchange (FX) rate for an amount and currency |
| [GetFundingPlans](/archive/adaptive-payments/api/get-funding-plans)           | Determines the available funding sources for a payment                    |
| [GetShippingAddresses](/archive/adaptive-payments/api/get-shipping-addresses) | Obtains the shipping address                                              |