PayPal Checkout Adapter
Overview
The PayPal Checkout Adapter integrates PayPal's payment platform with Norce Checkout, enabling merchants to offer PayPal's comprehensive payment solution within the Norce Commerce platform. PayPal provides a globally recognized payment gateway supporting PayPal accounts, credit/debit cards, Pay Later options, and Venmo (in supported markets) through a single integration.
This adapter is part of Norce Checkout (NCO) and implements PayPal's JavaScript SDK integration. The adapter handles the complete payment flow from checkout initialization through order completion, including webhook handling for asynchronous payment events and post-purchase operations like capture, void, and refund.
Integration Flows
The PayPal adapter supports two integration approaches:
SDK-based Flow (Recommended): The frontend renders PayPal buttons using the JavaScript SDK. The adapter returns SDK settings that the frontend uses to initialize PayPal's UI components. This provides the best user experience with PayPal's native checkout experience.
Redirect Flow: For scenarios where SDK integration isn't possible, the adapter supports a redirect-based flow. The user is redirected to PayPal's hosted checkout page and returns to configured URLs after completing or cancelling payment.
Payment Intent Options
The adapter supports two payment intents configured via the intent option:
Authorize (default): Reserves funds on the customer's payment method without capturing. Use this for scenarios where you need to verify inventory or perform other checks before finalizing the order. The authorization can later be captured or voided.
Capture: Immediately captures funds when the customer approves the payment. Use this for digital goods or scenarios where immediate payment is required.
Capabilities and Supported Flows
Payment Operations
| Feature | Full | Partial | |
|---|---|---|---|
| Capture | ✅ | ❌ | Full order capture only |
| Refund | ✅ | ❌ | Full order refund only |
| Cancel / Void | ✅ | — | Supported for authorized payments |
Supported Payment Methods
| Method | ||
|---|---|---|
| One-time Payment | ✅ | Standard checkout flow |
| Recurring Payment | ❌ | Not currently supported |
| PayPal Account | ✅ | Direct PayPal balance payments |
| Card Payments | ✅ | Credit/debit via PayPal |
| Pay Later | ✅ | Pay in 4 (supported markets) |
| Venmo | ✅ | US only |
Advanced Features
| Feature | ||
|---|---|---|
| B2B Support | ❌ | Consumer payments only |
| Integrated Shipping | ✅ | Shipping address/option callbacks |
| Partner Referral | ✅ | Marketplace onboarding support |
| SDK Settings Endpoint | ✅ | Deferred payment creation |
Limitations:
- Partial capture is not supported through this adapter
- Partial refund is not supported through this adapter
- Recurring payments are not currently supported
Configuration Overview
The PayPal adapter requires configuration in Norce Checkout Admin. Key settings include:
| Setting | Description |
|---|---|
apiUrl | PayPal API environment URL (https://api-m.sandbox.paypal.com for sandbox, https://api-m.paypal.com for production) |
paypalMerchantId | Your PayPal Merchant ID from the PayPal Developer Dashboard |
intent | Payment intent: authorize (default) or capture |
providesCustomer | Whether PayPal provides customer address data |
For detailed configuration options, see the PayPal Checkout Adapter Developer Guide.
Links and References
Norce Checkout API References
PayPal Checkout Adapter API
Norce Checkout Overview
- Norce Checkout Introduction
- Working with Norce Checkout
- Payment Adapters Overview
- PayPal Checkout Adapter Developer Guide