REST API reference
Payments (resource group)
PayPal provides various payment related operations using the
/payment resource and related sub-resources. Use payment for direct credit card payments and PayPal account payments. You can also use sub-resources to get payment related details.
Execute (complete) a PayPal payment that has been approved by the payer. Optionally update transaction information when executing the payment by passing in one or more transactions.
Get details about payments that have not completed, such as payments that are created and approved, or if a payment has failed.
Partially update the payment resource for the given identifier. Please note that it is not possible to use patch after execute has been called.
Sale Transactions (resource group)
To get details about completed payments (sale transaction) created by a payment request or to refund a direct sale transaction, PayPal provides the
/sale resource and related sub-resources. You can find the sale transactions in the payment resource within
Get details about a sale transaction.
Refund a completed payment. Provide the
sale_id in the URI and an empty JSON payload for a full refund. For partial refunds, you can include an amount.
Refunds (resource group)
Authorizations (resource group)
/authorization resource and related sub-resources to act on a previously created authorization. Options include retrieving, capturing, voiding, and reauthorizing authorizations.
Get details about authorizations.
Use this resource to capture and process a previously created authorization. To use this resource, the original payment call must have the
intent set to
Void a previously authorized payment.
Reauthorize a PayPal account payment. We recommend that you reauthorize a payment after the initial 3-day honor period to ensure that funds are still available.
Captures (resource group)
/capture resource and sub-resources allow you to look up and refund captured payments.
Get details about a captured payment.
Refund a captured payment. Provide the
captureId in the URI and an amount object. For partial refunds, you can include a lower amount object.
Orders (resource group)
/orders resource to take action on a payment with the intent of
order. Actions include authorize, capture, void, and look up orders. Also see create and process an order for further information about using the
/payment resource to create and execute an order.
It is not possible to refund an order directly. Instead, you must refund a completed payment of the order. Refer to the following how-to guides for integration information:
For operation information as well as request and response details, see Refund a captured payment.
order_id to get details about an order.
Capture a payment on an order. To use this call, an original payment call must specify an
Void an existing order.
Create an empty billing plan and add a trial period and/or regular billing. Alternatively, you can create a fully loaded plan that includes both a trial period and regular billing.
Update the information for an existing billing plan. The state of a plan must be active before a billing agreement is created.
Get details about a specific billing plan.
Get a list of all billing plans based on their current state and optional query string parameters.
Creates a billing agreement for the buyer. The response for this call includes these HATEOAS links: an
approval_url link and an
execute link. Each returned link includes the token for the agreement.
Executes an agreement after the buyer approves it.
Updates an agreement, by ID.
Shows details for an agreement, by ID.
Suspends an agreement, by ID.
Reactivates an agreement, by ID.
Cancels an agreement, by ID.
Lists transactions for a billing agreement.
Sets the outstanding amount of an agreement, by ID.
Bills the outstanding amount of an agreement, by ID.
Make payouts to a single or multiple PayPal accounts.
Periodically shows the latest status of a batch payout along with the transaction status and other data for individual items.
Shows the details for a payout item. Review the current status of a previously unclaimed, or pending, payout item.
Cancels an existing, unclaimed transaction. If an unclaimed item is not claimed within 30 days, the funds are automatically returned to the sender. Cancel the unclaimed item before the automatic 30-day refund.
Stores credit card details with PayPal.
Deletes details of a stored credit card. Include the credit card ID in the request URI.
Shows details for a stored credit card. Include the credit card id in the request URI.
Lists stored credit cards.
Updates a stored credit card, by ID.
Grant a new access token, using a refresh token.
Invoices (resource group)
Invoices are objects that you use to track payments.
Sends an invoice, by ID, to the payer. To send an invoice, you must include an
Updates an invoice, by ID.
Shows details for an invoice, by ID.
Lists invoices that belong to the merchant who makes the call.
Generates the next invoice number that is available to the user.
Returns invoices that match the specified search criteria.
Sends a reminder that a payment is due for an existing invoice.
Cancels an invoice and, optionally, notifies the payer about the cancellation.
Deletes a draft invoice. Note that this call works for invoices in the draft state only.
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 online with PayPal or a credit card.
Records a payment and marks an invoice as paid.
Records a refund and marks an invoice as refunded.
Templates (resource group)
Templates are objects that store customized invoice details. You can use templates to quickly create invoices that are populated with predefined data. To create templates, go to Template Settings.
Creates a web experience profile.
Shows details for a web experience profile, by ID.
Lists web experience profiles for a merchant.
Updates a web experience profile, by ID.
Partially updates a web experience profile, by ID.
Deletes a web experience profile, by ID.
Webhooks (resource group)
/webhooks resource to create, show details for, list all, update, and delete webhooks.
Shows details for a webhook, by ID.
Lists all webhooks.
Updates a webhook, by ID. Supports only the
Deletes a webhook, by ID.
Webhook event notifications (resource group)
/webhooks-events resource to show event notification details, list event notifications, and resend the notification for an event.
Shows details for an event notification, by ID.
Lists webhook event notifications. Specify one or more optional query parameters to filter the response.
Resends an event notification, by event ID.
Webhook events (resource group)
/webhooks-event-types resource to list events to which webhooks can subscribe and the
/webhooks/<webhook_id>/event-types resource to list event subscriptions for a webhook.
Lists the event subscriptions for a webhook, by ID.
Simulate webhook event (resource group)
/simulate-event resource to use a sample payload to simulate a webhook event.
Simulates a webhook event by using a sample payload. Also use the Webhooks simulator to send mock event data to the URL that you configured to listen for notification messages. For more information about simulation, see Webhooks simulator.