Classic API Reference

This reference details the endpoints and operations that are available for the PayPal Classic APIs. The APIs and services are organized as follows:

 

PayPal Payments

Express Checkout

Send your API calls to one of the following endpoints, depending on whether you are making a Name-Value Pair (NVP) or SOAP call. Make sure you have the correct API credentials to use this API.

Express Checkout Endpoints

Authentication Format Live and Sandbox Endpoints
API Certificate Name-Value Pair Live: https://api.paypal.com/nvp
Sandbox: https://api.sandbox.paypal.com/nvp
SOAP Live: https://api.paypal.com/2.0/
Sandbox: https://api.sandbox.paypal.com/2.0/
API Signature Name-Value Pair Live: https://api-3t.paypal.com/nvp
Sandbox: https://api-3t.sandbox.paypal.com/nvp
SOAP Live: https://api-3t.paypal.com/2.0/
Sandbox: https://api-3t.sandbox.paypal.com/2.0/

 

Express Checkout API Operations

Alphabetical List Grouped by Feature
AddressVerify (NVP) (SOAP)
BAUpdate (NVP) (SOAP)
BillOutstandingAmount (NVP) (SOAP)
Callback (NVP)
CreateBillingAgreement (NVP) (SOAP)
CreateRecurringPaymentsProfile (NVP) (SOAP)
DoAuthorization (NVP) (SOAP)
DoCapture (NVP) (SOAP)
DoExpressCheckoutPayment (NVP) (SOAP)
DoReauthorization (NVP) (SOAP)
DoReferenceTransaction (NVP) (SOAP)
DoVoid (NVP) (SOAP)
GetBalance (NVP) (SOAP)
GetBillingAgreementCustomerDetails (NVP) (SOAP)
GetExpressCheckoutDetails (NVP) (SOAP)
GetPalDetails (NVP) (SOAP)
GetRecurringPaymentsProfileDetails (NVP) (SOAP)
GetTransactionDetails (NVP) (SOAP)
ManageRecurringPaymentsProfileStatus (NVP) (SOAP)
RefundTransaction (NVP) (SOAP)
SetCustomerBillingAgreement (NVP) (SOAP)
SetExpressCheckout (NVP) (SOAP)
TransactionSearch (NVP) (SOAP)
UpdateAuthorization (NVP) (SOAP)
UpdateRecurringPaymentsProfile (NVP) (SOAP)

Express Checkout
SetExpressCheckout (NVP) (SOAP)
GetExpressCheckoutDetails (NVP) (SOAP)
DoExpressCheckoutPayment (NVP) (SOAP)
Callback (NVP)

Authorization and Capture
DoAuthorization (NVP) (SOAP)
DoCapture (NVP) (SOAP)
DoReauthorization (NVP) (SOAP)
DoVoid (NVP) (SOAP)
UpdateAuthorization (NVP) (SOAP)

Recurring Payments / Reference Transactions
BAUpdate (NVP) (SOAP)
BillOutstandingAmount (NVP) (SOAP)
CreateBillingAgreement (NVP) (SOAP)
CreateRecurringPaymentsProfile (NVP) (SOAP)
DoReferenceTransaction (NVP) (SOAP)
GetBillingAgreementCustomerDetails (NVP) (SOAP)Deprecated after version 54.0
GetRecurringPaymentsProfileDetails (NVP) (SOAP)
ManageRecurringPaymentsProfileStatus (NVP) (SOAP)
SetCustomerBillingAgreement (NVP) (SOAP)Deprecated after version 54.0
UpdateRecurringPaymentsProfile (NVP) (SOAP)

Refunds
RefundTransaction (NVP) (SOAP)

Inventory Management
GetTransactionDetails (NVP) (SOAP)
TransactionSearch (NVP) (SOAP)

PayPal Accounts
AddressVerify (NVP) (SOAP)
GetBalance (NVP) (SOAP)
GetPalDetails (NVP) (SOAP)

Adaptive Payments

Try the API Explorer to browse the Adaptive Payments API structures, or see the reference information below.

Adaptive Payments Endpoints

Include an AppID with your API credentials when making Adaptive Payments API calls.
For Sandbox testing, use the following Sandbox AppID: APP-80W284485P519543T

API / Service Format Live and Sandbox Endpoints
Adaptive Payments JSON, NVP, SOAP, XML https://svcs.paypal.com/AdaptivePayments/<API-Operation>
https://svcs.sandbox.paypal.com/AdaptivePayments/<API-Operation>

Adaptive Payments API Operations

Click the following links to view the API reference documentation.

CancelPreapproval
ConvertCurrency
ExecutePayment
GetFundingPlans
GetPaymentOptions
GetPrePaymentDisclosure
GetShippingAddresses
Pay
PaymentDetails
Preapproval
PreapprovalDetails
Refund
SetPaymentOptions

 

Credit Card Payments

Payflow Gateway API

  • PayPal Payments Pro and PayPal Payments Advanced
  • Payflow Pro and Payflow Link

The Payflow API is a secure, open payment gateway supporting PayPal Payments Pro / Advanced and Payflow Pro / Link and is the preferred integration method for these products. You can choose to have PayPal host your payment pages or have total control over the payment process on your website.

With PayPal Payments Pro and Advanced, PayPal is your merchant bank, or with Payflow Pro and Link, you can use your existing merchant bank. Regardless which of these products you select, the Payflow API allows you to accept debit and credit card payments. It also allows you to accept PayPal Express Checkout and PayPal Credit® (formerly Bill Me Later®) payments all within one API.

Payflow Endpoints

Send your API calls to one of the following endpoints, depending on whether you are making a call to the live environment or the pilot (test) environment. Be sure to pass the correct user credentials set in your account on https://manager.paypal.com/.

Format Live and Sandbox Endpoints
Name-Value Pair https://payflowpro.paypal.com
https://pilot-payflowpro.paypal.com

Payflow Parameters

If you would like PayPal to host your payment pages, see Configuring Hosted Checkout Pages. For direct API calls, click on the following API reference links:

Website Payments Pro

Note Website Payments Pro is a legacy product and has been replaced by PayPal Payments Pro. Website Payments Pro is still supported for existing merchants.

Try the API Explorer to browse the Merchant API structures, or click the following links to read the API reference documentation.

Website Payments Pro Endpoints

Send your API calls to one of the following endpoints, depending on whether you are making a Name-Value Pair (NVP) or SOAP call. Make sure you have the correct API credentials to use this API.

Authentication Format Live and Sandbox Endpoints
API Certificate Name-Value Pair Live: https://api.paypal.com/nvp
Sandbox: https://api.sandbox.paypal.com/nvp
SOAP Live: https://api.paypal.com/2.0/
Sandbox: https://api.sandbox.paypal.com/2.0/
API Signature Name-Value Pair Live: https://api-3t.paypal.com/nvp
Sandbox: https://api-3t.sandbox.paypal.com/nvp
SOAP Live: https://api-3t.paypal.com/2.0/
Sandbox: https://api-3t.sandbox.paypal.com/2.0/

 

Website Payments Pro API Operations

Alphabetical List Grouped by Feature
BillOutstandingAmount (NVP) (SOAP)
CreateRecurringPaymentsProfile (NVP) (SOAP)
DoCapture (NVP) (SOAP)
DoDirectPayment (NVP) (SOAP)
DoNonReferencedCredit (NVP) (SOAP)
DoReauthorization (NVP) (SOAP)
DoReferenceTransaction (NVP) (SOAP)
DoVoid (NVP) (SOAP)
GetBalance (NVP) (SOAP)
GetRecurringPaymentsProfileDetails (NVP) (SOAP)
GetTransactionDetails (NVP) (SOAP)
ManagePendingTransactionStatus (NVP) (SOAP)
ManageRecurringPaymentsProfileStatus (NVP) (SOAP)
RefundTransaction (NVP) (SOAP)
TransactionSearch (NVP) (SOAP)
UpdateAuthorization (NVP) (SOAP)
UpdateRecurringPaymentsProfile (NVP) (SOAP)

Direct Credit Card Payment DoDirectPayment (NVP) (SOAP)

Authorization and Capture DoAuthorization (NVP) (SOAP)
DoCapture (NVP) (SOAP)
DoReauthorization (NVP) (SOAP)
DoVoid (NVP) (SOAP)
UpdateAuthorization (NVP) (SOAP)

Recurring Payments / Reference Transactions
BillOutstandingAmount (NVP) (SOAP)
CreateRecurringPaymentsProfile (NVP) (SOAP)
DoReferenceTransaction (NVP) (SOAP)
GetRecurringPaymentsProfileDetails (NVP) (SOAP)
ManageRecurringPaymentsProfileStatus (NVP) (SOAP)
UpdateRecurringPaymentsProfile (NVP) (SOAP)

Refunds
DoNonReferencedCredit (NVP) (SOAP)
RefundTransaction (NVP) (SOAP)

Fraud Management Filters
ManagePendingTransactionStatus (NVP) (SOAP)

Transaction Management
GetTransactionDetails (NVP) (SOAP)
TransactionSearch (NVP) (SOAP)

PayPal Accounts
GetBalance (NVP) (SOAP)

 

Advanced Payment Solutions

Mass Payments

Merchants use Mass Payments to send money instantly to up to 250 recipients at once. To send payments to multiple recipients, merchants only need the recipient's PayPal account email address, the payment amount, and the currency code. Merchants can manually upload a file listing payments or create them programmatically using the `MassPay` API. For manual payment information, refer to the Sending Mass Payments from your PayPal Account.

Mass Payments Endpoints

Send your API calls to one of the following endpoints, depending on whether you are making a Name-Value Pair (NVP) or SOAP call. Make sure you have the correct API credentials to use this API.

Authentication Format Live and Sandbox Endpoints
API Certificate Name-Value Pair Live: https://api.paypal.com/nvp
Sandbox: https://api.sandbox.paypal.com/nvp
SOAP Live: https://api.paypal.com/2.0/
Sandbox: https://api.sandbox.paypal.com/2.0/
API Signature Name-Value Pair Live: https://api-3t.paypal.com/nvp
Sandbox: https://api-3t.sandbox.paypal.com/nvp
SOAP Live: https://api-3t.paypal.com/2.0/
Sandbox: https://api-3t.sandbox.paypal.com/2.0/

 

Mass Payments API Operation

Click the following links to view the API reference documentation.

MassPay (NVP) (SOAP)

Adaptive Accounts

Try the API Explorer to browse the Adaptive Accounts API structures, or see the reference information below.

Adaptive Accounts Endpoints

Include an AppID with your API credentials when making Adaptive Accounts API calls.
For Sandbox testing, use the following Sandbox AppID: APP-80W284485P519543T

API / Service Format Live and Sandbox Endpoints
Adaptive Accounts JSON, NVP, SOAP, XML https://svcs.paypal.com/AdaptiveAccounts/<API-Operation>
https://svcs.sandbox.paypal.com/AdaptiveAccounts/<API-Operation>

Adaptive Accounts API Operations

Click the following links to view the API reference documentation.

AddBankAccount
AddPaymentCard
CheckComplianceStatus
CreateAccount
GetUserAgreement
GetVerifiedStatus
SetFundingSourceConfirmed
UpdateComplianceStatus

Invoicing

Try the API Explorer to browse the Invoicing API structures, or see the reference information below.

Invoicing Endpoints

Include an AppID with your API credentials when making API calls to the Invoicing service.
For Sandbox testing, use the following Sandbox AppID: APP-80W284485P519543T

API / Service Format Live and Sandbox Endpoints
Invoicing Service JSON, NVP, SOAP, XML https://svcs.paypal.com/Invoice/<API-Operation>
https://svcs.sandbox.paypal.com/Invoice/<API-Operation>

Invoicing API Operations

Click the following links to view the API reference documentation.

CancelInvoice
CreateAndSendInvoice
CreateInvoice
DeleteInvoice
GenerateInvoiceNumber
GetInvoiceDetails
MarkInvoiceAsPaid
MarkInvoiceAsRefunded
MarkInvoiceAsUnpaid
RemindInvoice
SearchInvoices
SendInvoice
UpdateInvoice

Permissions

Try the API Explorer to browse the Permissions API structures, or see the reference information below.

Permissions Endpoints

Include an AppID with your API credentials when making API calls to the Permissions service.
For Sandbox testing, use the following Sandbox AppID: APP-80W284485P519543T

API / Service Format Live and Sandbox Endpoints
Permissions Service JSON, NVP, SOAP, XML https://svcs.paypal.com/Permissions/<API-Operation>
https://svcs.sandbox.paypal.com/Permissions/<API-Operation>

Permissions API Operations

Click the following links to view the API reference documentation.

CancelPermissions
GetAccessToken
GetAdvancedPersonalData
GetBasicPersonalData
GetPermissions
RequestPermissions

 

PayPal Payments Standard

PayPal Payments Standard

If you have a PayPal Business or Premier account, you can use the PayPal Button Factory to create the HTML code needed to place a PayPal button on your website. The generated HTML code, when pasted into one of your website pages, displays a PayPal button that lets customers use their PayPal account to purchase the item(s) associated with the button. Adding a PayPal button to your website does not require advanced coding experience. Refer to the HowTo guide for creating buttons for more information.

To modify your PayPal buttons using HTML code, refer to:

Button Manager

For more advanced PayPal button manipulation, use the ButtonManager API.

Button Manager Endpoints

Send your API calls to one of the following endpoints, depending on whether you are making a Name-Value Pair (NVP) or SOAP call. Make sure you have the correct API credentials to use this API.

Authentication Format Live and Sandbox Endpoints
API Certificate Name-Value Pair Live: https://api.paypal.com/nvp
Sandbox: https://api.sandbox.paypal.com/nvp
SOAP Live: https://api.paypal.com/2.0/
Sandbox: https://api.sandbox.paypal.com/2.0/
API Signature Name-Value Pair Live: https://api-3t.paypal.com/nvp
Sandbox: https://api-3t.sandbox.paypal.com/nvp
SOAP Live: https://api-3t.paypal.com/2.0/
Sandbox: https://api-3t.sandbox.paypal.com/2.0/

 

Button Manager API Operations

Click the following links to view the API reference documentation.

BMButtonSearch (NVP) (SOAP)
BMCreateButton (NVP) (SOAP)
BMGetButtonDetails (NVP) (SOAP)
BMGetInventory (NVP) (SOAP)
BMManageButtonStatus (NVP) (SOAP)
BMSetInventory (NVP) (SOAP)
BMUpdateButton (NVP) (SOAP)