Note: the old API docs
are no longer maintained but are still available.
Get details about a specific refund.
To get a list of your refunds, you can first get a list of payments. Within the list, you can see the
state of the
sale object as
refunded and a
refund object with the
The Payouts feature enables you to make PayPal payments to multiple PayPal accounts in a single API call. You can specify the recipients using their PayPal email addresses, phone numbers, or encrypted PayPal account numbers.
The Payout APIs are a fast, convenient way to send commissions, rebates, rewards, and general disbursements. Payouts appear as Mass Payments in the sender's PayPal account and are provided with the Mass Payment reports.
Important: To use Payouts, you must request access through your account page. Alternatively, contact your Account Manager or PayPal Customer Support. You must have a PayPal business account.
As in the case of other REST APIs, the Payouts APIs use ISO 8601 as the date format.
Get data about a payout item, including the status, without retrieving an entire batch. Get the status of an individual payout item in a batch in order to review the current status of a previously-unclaimed, or pending, payout item.
Cancel an existing, unclaimed transaction. If an unclaimed item is not claimed within 30 days, the funds will be automatically returned to the sender. This call can be used to cancel the unclaimed item prior to the automatic 30-day return.
PayPal offers merchants a
/vault API to store sensitive details like credit card related details.
You can currently use the
/vault API to store credit card details with PayPal instead of storing them on your own server. After storing a credit card, you can then pass the credit card
id instead of the related credit card details to complete a payment.
For more information, learn about using the
/vault API to store a credit card.
Note: Direct credit card payment and related features are restricted in some countries.
Use the Invoicing service to create, send, and manage invoices. Also use the Invoicing service to track payments.
When you send an invoice, PayPal emails the specified customer with a link to the invoice on PayPal's website.
Customers who have a PayPal account can log in and pay with PayPal. Alternatively, customers can pay with a check, debit card, or credit card.
Sends an invoice, by ID, to the payer. To send an invoice, you must include an
Gets a QR code for an invoice, by ID. The QR code is a PNG image in base-64 encoded format that corresponds to the invoice ID. A QR code for an invoice can be added to a paper or PDF invoice. When a customer uses their mobile device to scan the QR code, the customer is redirected to the PayPal mobile payment flow, where they can pay on-line with PayPal or a credit card.
/webhooks-event-types for listing webhook event types.
/webhooks for creating, listing, updating, and deleting webhooks.
/webhooks-events for searching and resending webhook events.
Simulate a webhook event using a sample payload. Also use the Webhooks Simulator interface to send static mock event data to the URLs that you have configured to accept webhooks. For more information about simulation capabilities, see the webhooks overview.