@paykit-sdk/gopay 1.0.5 → 1.1.2

package/README.md

@@ -1,6 +1,6 @@
 # @paykit-sdk/gopay
 
-Stripe provider for PayKit
+GoPay provider for PayKit
 
 ## Quick Start
 
@@ -9,15 +9,16 @@ import { createEndpointHandlers, PayKit } from '@paykit-sdk/core';
 import { gopay, createGopay } from '@paykit-sdk/gopay';
 
 // Method 1: Using environment variables
-const provider = gopay(); // Ensure GOPAY_CLIENT_ID, GOPAY_CLIENT_SECRET, GOPAY_GO_ID, GOPAY_SANDBOX, GOPAY_WEBHOOK_URL   environment variables are set
+const provider = gopay(); // Ensure required environment variables are set
 
 // Method 2: Direct configuration
 const provider = createGopay({
-  clientId: 'sk_test_...',
-  clientSecret: 'clsec_...',
-  goId: 'go...',
+  clientId: process.env.GOPAY_CLIENT_ID,
+  clientSecret: process.env.GOPAY_CLIENT_SECRET,
+  goId: process.env.GOPAY_GO_ID,
   isSandbox: true,
-  webhookUrl: 'http://localhost:8080/api/paykit/webhook',
+  webhookUrl: 'https://your-domain.com/api/paykit/webhooks',
+  debug: true, // Enable to see helpful logs about provider_metadata
 });
 
 export const paykit = new PayKit(provider);
@@ -27,16 +28,18 @@ export const endpoints = createEndpointHandlers(paykit);
 ### Next.js Catch All API Route (/api/paykit/[...endpoint]/route.ts)
 
 ```typescript
-import { paykit } from '@/lib/paykit';
+import { endpoints } from '@/lib/paykit';
 import { EndpointPath } from '@paykit-sdk/core';
+import { NextRequest, NextResponse } from 'next/server';
 
 export async function POST(
   request: NextRequest,
-  { params }: { params: { endpoint: string[] } },
+  { params }: { params: Promise<{ endpoint: string[] }> },
 ) {
   try {
+    const { endpoint: endpointArray } = await params;
     // Construct the endpoint path with full type safety
-    const endpoint = ('/' + params.endpoint.join('/')) as EndpointPath;
+    const endpoint = ('/' + endpointArray.join('/')) as EndpointPath;
     const handler = endpoints[endpoint];
 
     if (!handler) {
@@ -62,36 +65,42 @@ export async function POST(
 
 ### Next.js Webhooks (/api/paykit/webhooks/route.ts)
 
+**⚠️ IMPORTANT:** GoPay webhooks use GET requests instead of POST. Your webhook route must export a GET handler, not POST.
+
 ```typescript
 import { paykit } from '@/lib/paykit';
-import { NextRequest } from 'next/server';
+import { NextRequest, NextResponse } from 'next/server';
 
-export async function POST(request: NextRequest) {
+export async function GET(request: NextRequest) {
   const webhook = paykit.webhooks
-    .setup({ webhookSecret: '' })
+    .setup({ webhookSecret: '' }) // GoPay doesn't use webhook secrets
     .on('customer.created', async event => {
       console.log('Customer created:', event.data);
-    });
+    })
     .on('subscription.created', async event => {
       console.log('Subscription created:', event.data);
-    });
+    })
     .on('payment.created', async event => {
       console.log('Payment created:', event.data);
-    });
+    })
     .on('refund.created', async event => {
-     console.log('Refund created:', event.data);
-    });
+      console.log('Refund created:', event.data);
+    })
     .on('invoice.generated', async event => {
       console.log('Invoice generated:', event.data);
     });
 
-  const body = await request.text();
-  const headers = Object.fromEntries(request.headers.entries());
-  const url = request.url
-  await webhook.handle({ body, headers, fullUrl: url });
+  const headers = request.headers;
+  const url = request.url;
 
-  // Return immediately, processing happens in background
-  return NextResponse.json({ success: true });
+  try {
+    console.log('Webhook handled');
+    await webhook.handle({ body: '', headers, fullUrl: url });
+    return NextResponse.json({ success: true });
+  } catch (error) {
+    console.error('Webhook error:', error);
+    return NextResponse.json({ success: false }, { status: 500 });
+  }
 }
 ```
 
@@ -99,51 +108,46 @@ export async function POST(request: NextRequest) {
 
 ```typescript
 import { paykit, endpoints } from '@/lib/paykit';
-import { createEndpointHandlers, EndpointPath } from '@paykit-sdk/core';
+import { EndpointPath } from '@paykit-sdk/core';
 import express from 'express';
 
 const app = express();
 
-// IMPORTANT: Webhook route must come BEFORE express.json() middleware
-// This ensures we get the raw body for signature verification
-app.post(
-  '/api/webhooks/gopay',
-  express.raw({ type: 'application/json' }),
-  async (req, res) => {
-    try {
-      const webhook = paykit.webhooks
-        .setup({ webhookSecret: '' })
-        .on('customer.created', async event => {
-          console.log('Customer created:', event.data);
-        })
-        .on('subscription.created', async event => {
-          console.log('Subscription created:', event.data);
-        })
-        .on('payment.created', async event => {
-          console.log('Payment created:', event.data);
-        })
-        .on('refund.created', async event => {
-          console.log('Refund created:', event.data);
-        })
-        .on('invoice.generated', async event => {
-          console.log('Invoice generated:', event.data);
-        });
-
-      const body = req.body; // Raw buffer from express.raw()
-      const headers = req.headers;
-      const url = request.url;
-      await webhook.handle({ body, headers, fullUrl: url });
-
-      // Return immediately, processing happens in background
-      res.json({ success: true });
-    } catch (error) {
-      console.error('Webhook error:', error);
-      res.status(500).json({
-        message: error instanceof Error ? error.message : 'Webhook processing failed',
+// IMPORTANT: GoPay webhooks use GET requests, not POST
+app.get('/api/webhooks/gopay', async (req, res) => {
+  try {
+    const webhook = paykit.webhooks
+      .setup({ webhookSecret: '' }) // GoPay doesn't use webhook secrets
+      .on('customer.created', async event => {
+        console.log('Customer created:', event.data);
+      })
+      .on('subscription.created', async event => {
+        console.log('Subscription created:', event.data);
+      })
+      .on('payment.created', async event => {
+        console.log('Payment created:', event.data);
+      })
+      .on('refund.created', async event => {
+        console.log('Refund created:', event.data);
+      })
+      .on('invoice.generated', async event => {
+        console.log('Invoice generated:', event.data);
       });
-    }
-  },
-);
+
+    const body = ''; // GoPay sends data via URL query params
+    const headers = req.headers;
+    const url = req.url;
+    await webhook.handle({ body, headers, fullUrl: url });
+
+    // Return immediately, processing happens in background
+    res.json({ success: true });
+  } catch (error) {
+    console.error('Webhook error:', error);
+    res.status(500).json({
+      message: error instanceof Error ? error.message : 'Webhook processing failed',
+    });
+  }
+});
 
 // Regular API routes use JSON middleware
 app.use(express.json());
@@ -173,19 +177,52 @@ app.listen(3000, () => {
 });
 ```
 
+## Subscription Management
+
+```typescript
+// Cancel subscription
+await paykit.subscriptions.cancel('sub_123');
+```
+
+## Provider Metadata
+
+GoPay requires specific `provider_metadata` fields for different operations. Enable `debug: true` when initializing the provider to see helpful console logs that recommend which fields to use.
+
+```typescript
+const checkout = await paykit.checkouts.create({
+  customer: { email: 'user@example.com' },
+  item_id: 'item_123',
+  session_type: 'one_time',
+  quantity: 1,
+  metadata: { plan: 'pro' },
+  success_url: 'http://localhost:3000/success',
+  cancel_url: 'http://localhost:3000/cancel',
+  provider_metadata: {
+    amount: '2900',
+    currency: 'CZK',
+    lang: 'en', // Language for the payment gateway (default: 'EN')
+  },
+});
+```
+
 ## Environment Variables
 
 ```bash
-GOPAY_CLIENT_ID=sk_test_...
-GOPAY_CLIENT_SECRET=clsec_...
-GOPAY_GO_ID=go...
+GOPAY_CLIENT_ID=140...
+GOPAY_CLIENT_SECRET=n6W...
+GOPAY_GO_ID=864....
 GOPAY_SANDBOX=true
-GOPAY_WEBHOOK_URL=http://localhost:8080/api/paykit/webhook
+GOPAY_WEBHOOK_URL=https://your-domain.com/api/paykit/webhooks
 ```
 
+## Documentation
+
+For detailed documentation, including setup guides, webhook configuration, and provider metadata requirements, see the [GoPay Provider Documentation](https://usepaykit.com/docs/providers/gopay).
+
 ## Support
 
-- [Gopay Documentation](https://doc.gopay.com/)
+- [GoPay Documentation](https://doc.gopay.com/)
+- [PayKit Issues](https://github.com/usepaykit/paykit-sdk/issues)
 
 ## License
 

package/dist/gopay-provider.d.mts

@@ -13,10 +13,6 @@ interface GoPayOptions extends PaykitProviderOptions {
      * The GoID for the GoPay API
      */
     goId: string;
-    /**
-     * Whether to use the sandbox environment
-     */
-    isSandbox: boolean;
     /**
      * The webhook URL for the GoPay API
      */
@@ -27,7 +23,7 @@ declare class GoPayProvider extends AbstractPayKitProvider implements PayKitProv
     readonly providerName = "gopay";
     private _client;
     private baseUrl;
-    private authController;
+    private tokenManager;
     constructor(opts: GoPayOptions);
     createCheckout: (params: CreateCheckoutSchema) => Promise<Checkout>;
     retrieveCheckout: (id: string) => Promise<Checkout | null>;

package/dist/gopay-provider.d.ts

@@ -13,10 +13,6 @@ interface GoPayOptions extends PaykitProviderOptions {
      * The GoID for the GoPay API
      */
     goId: string;
-    /**
-     * Whether to use the sandbox environment
-     */
-    isSandbox: boolean;
     /**
      * The webhook URL for the GoPay API
      */
@@ -27,7 +23,7 @@ declare class GoPayProvider extends AbstractPayKitProvider implements PayKitProv
     readonly providerName = "gopay";
     private _client;
     private baseUrl;
-    private authController;
+    private tokenManager;
     constructor(opts: GoPayOptions);
     createCheckout: (params: CreateCheckoutSchema) => Promise<Checkout>;
     retrieveCheckout: (id: string) => Promise<Checkout | null>;