@reeboot/strapi-payment-plugin 0.0.0

package/README.md

@@ -0,0 +1,112 @@
+# Strapi v5 Payment Plugin (Stripe & PayPal)
+
+This plugin provides a unified interface for processing payments through Stripe and PayPal in Strapi v5.
+
+## Features
+
+- Payment initiation (Stripe Payment Intents, PayPal Orders)
+- Webhook handling for payment status updates
+- Refund processing
+- Payment details retrieval
+- Admin panel configuration interface
+
+## Installation
+
+1. Install the plugin:
+   ```bash
+   npm install @reeboot/payment-plugin
+   ```
+
+2. Add the plugin to your Strapi configuration:
+   ```javascript
+   // config/plugins.js
+   module.exports = {
+     'payment-plugin': {
+       enabled: true,
+     },
+   };
+   ```
+
+## Configuration
+
+1. Set up environment variables:
+   ```
+   STRIPE_SECRET_KEY=your_stripe_secret_key
+   STRIPE_PUBLISHABLE_KEY=your_stripe_publishable_key
+   STRIPE_WEBHOOK_SECRET=your_stripe_webhook_secret
+   PAYPAL_CLIENT_ID=your_paypal_client_id
+   PAYPAL_CLIENT_SECRET=your_paypal_client_secret
+   PAYPAL_WEBHOOK_ID=your_paypal_webhook_id
+   ```
+
+2. Configure the plugin through the admin panel:
+   - Go to the "Payment Plugin Configuration" page
+   - Enter your API keys and secrets
+   - Save the configuration
+
+## API Usage
+
+### Initiate Payment
+
+```javascript
+// POST /payment-plugin/initiate-payment
+const response = await fetch('/payment-plugin/initiate-payment', {
+  method: 'POST',
+  headers: {
+    'Content-Type': 'application/json',
+  },
+  body: JSON.stringify({
+    gateway: 'stripe', // or 'paypal'
+    amount: 1000, // in cents
+    currency: 'usd',
+    orderId: 'order_123',
+    options: {
+      // gateway-specific options
+    },
+  }),
+});
+const payment = await response.json();
+```
+
+### Process Webhook
+
+```javascript
+// POST /payment-plugin/webhook/:gateway
+// The webhook URL should be configured in your Stripe/PayPal dashboard
+```
+
+### Refund Payment
+
+```javascript
+// POST /payment-plugin/refund
+const response = await fetch('/payment-plugin/refund', {
+  method: 'POST',
+  headers: {
+    'Content-Type': 'application/json',
+  },
+  body: JSON.stringify({
+    gateway: 'stripe', // or 'paypal'
+    transactionId: 'pi_123', // or PayPal transaction ID
+    amount: 500, // refund amount in cents
+    options: {
+      // gateway-specific options
+    },
+  }),
+});
+const refund = await response.json();
+```
+
+### Get Payment Details
+
+```javascript
+// GET /payment-plugin/payments/:id
+const response = await fetch('/payment-plugin/payments/pi_123');
+const paymentDetails = await response.json();
+```
+
+## Development
+
+1. Clone the repository
+2. Install dependencies: `npm install`
+3. Build the plugin: `npm run build`
+4. Link the plugin to your Strapi project: `npm link`