X
DocsPayPal

PayPal

Integrate PayPal payments with PayKit.

PayKit provides a unified PayPal integration that follows the same API as other providers.

Quick Start

Install the PayPal provider:


Setup

Create a provider entry that exports a PayKit instance and generated endpoints.


Alternatively, configure directly:


Basic Usage


Next.js catch‑all route. This forwards calls to the generated handlers.


Webhook Setup

Enable Events

In your PayPal Application, enable the following webhook events:

  • CHECKOUT.ORDER.APPROVED
  • CHECKOUT.ORDER.COMPLETED
  • PAYMENT.CAPTURE.COMPLETED
  • PAYMENT.CAPTURE.REFUNDED
  • BILLING.SUBSCRIPTION.CREATED
  • BILLING.SUBSCRIPTION.UPDATED
  • BILLING.SUBSCRIPTION.CANCELLED
  • BILLING.SUBSCRIPTION.EXPIRED
  • BILLING.SUBSCRIPTION.SUSPENDED

Webhook route. This validates and dispatches events.


Environment Variables


Example checkout


Support

  • PayPal Docs: https://developer.paypal.com/docs/
  • PayKit Issues: https://github.com/usepaykit/paykit-sdk/issues