Payments overview

The Payments API provides an easy and secure way to accept online and mobile payments. You can take advantage of all the great benefits of PayPal while enabling customers to make payments with only a few clicks.

Payments can be made with PayPal and with credit cards, depending on the country.

You can accept an immediate payment, or authorize a payment and capture it later.

Additionally, you can use the Payout APIs to make and manage payments to multiple PayPal accounts. Payouts is a fast, convenient way to send commissions, rebates, rewards, and general disbursements.

Using Payments

The Payments API enables you to accept PayPal and credit card payments. When creating a payment, you set an intent (sale or authorize), and specify the transaction details.

You can get details on completed payments (sale transactions), make full or partial refunds, or look up details of a refund. If you have authorized a payment, you can retrieve information about the authorization. You also can void or reauthorize an existing authorization.

Subscription billing plans allow automated recurring payments at regularly scheduled intervals. Billing agreements are contracts between a payer and a payee or between payer and facilitator to send payments according to a plan which consists of payment amount, billing cycle, number of billing cycles, etc.

If you are a PayPal partner, you will need to include a unique BN Code in your calls, to receive revenue attribution. To learn more or to request a BN Code, contact your Partner Manager or visit the PayPal Partner Portal. After you have a BN Code, see REST API authentication and headers for the header to use for revenue attribution.

Try making a call and reviewing the SDKs. Each API response includes HATEOAS links, enabling you to construct a payment flow with links returned by an API call.

More Payments information

Reference and other resources for the Payments API are available at: