Payments REST API

Use the Payments REST API to easily and securely accept online and mobile payments. You can enable customers to make PayPal payments with only a few clicks, depending on the country.

Important: The use of the PayPal REST /payments APIs to accept credit card payments is restricted. Instead, you can accept credit card payments with Braintree Direct.

You can accept an immediate payment or authorize a payment and capture it later. You can show details for completed payments, refunds, and authorizations. You can make full or partial refunds. You also can void or re-authorize authorizations.

Additionally, you can use the Payouts REST API to make and manage payouts, which are payments to multiple PayPal accounts. Payouts are a fast, convenient way to send commissions, rebates, rewards, and general disbursements.

A billing agreement is a contract based on a plan to send payments from a payer to a payee or facilitator. A billing plan defines the number of payments, the frequency of payments, and other payment details. You use the Billing Plans REST API to create and activate a billing plan. You do this one time. Then, you use the Billing Agreements REST API to create a billing agreement that you base off that plan. You use a billing agreement to create subscriptions for customers, or automated recurring payments at regularly scheduled intervals.

If you are a PayPal partner, you must use a build notation (BN) code in the PayPal-Partner-Attribution-Id header in your calls to receive revenue attribution. To learn more, contact your partner manager or visit the PayPal Partner Portal.


Learn how to accept PayPal payments.

Additional information


Have feedback?

Let us know.