@voxepay/checkout 0.5.3 → 0.5.5

package/src/api/client.ts

@@ -11,6 +11,7 @@ export interface InitiatePaymentRequest {
     customerId?: string;
     customerEmail?: string;
     customerPhone?: string;
+    customerName?: string;
     amount: number;
     currency: string;
     paymentMethod: 'CARD' | 'BANK_TRANSFER';
@@ -102,11 +103,11 @@ export interface ResendOTPRequest {
 }
 
 export class VoxePayApiClient {
-    private apiKey: string;
+    private apiKey?: string;
     private bearerToken?: string;
     private baseUrl: string;
 
-    constructor(apiKey: string, baseUrl?: string, bearerToken?: string) {
+    constructor(apiKey?: string, baseUrl?: string, bearerToken?: string) {
         this.apiKey = apiKey;
         this.bearerToken = bearerToken;
         this.baseUrl = baseUrl || DEFAULT_BASE_URL;
@@ -127,7 +128,7 @@ export class VoxePayApiClient {
             'Accept': 'application/json',
         };
 
-        if (includeApiKey) {
+        if (includeApiKey && this.apiKey) {
             headers['X-API-Key'] = this.apiKey;
         }
 
@@ -160,7 +161,7 @@ export class VoxePayApiClient {
 
         if (authType === 'bearer' && this.bearerToken) {
             headers['Authorization'] = `Bearer ${this.bearerToken}`;
-        } else if (authType === 'api-key') {
+        } else if (authType === 'api-key' && this.apiKey) {
             headers['X-API-Key'] = this.apiKey;
         }
         // authType === 'none' → no auth header added
@@ -186,16 +187,31 @@ export class VoxePayApiClient {
     }
 
     /**
-     * Initiate a payment (card or bank transfer)
-     * BANK_TRANSFER uses the public endpoint — no X-API-Key required
-     * CARD uses X-API-Key authentication
+     * Initiate card payment via standard payments endpoint.
      */
     async initiatePayment(data: InitiatePaymentRequest): Promise<InitiatePaymentResponse> {
-        const includeApiKey = data.paymentMethod !== 'BANK_TRANSFER';
         const response = await this.request<{ success?: boolean; data?: InitiatePaymentResponse } & InitiatePaymentResponse>(
             '/api/v1/payments/initiate',
             data,
-            includeApiKey
+            true
+        );
+        if (response.data && typeof response.data === 'object' && 'transactionRef' in response.data) {
+            return response.data;
+        }
+        return response;
+    }
+
+    /**
+     * Initiate bank transfer via public payment-link endpoint.
+     */
+    async initiateTransferPayment(
+        paymentLinkSlug: string,
+        data: InitiatePaymentRequest
+    ): Promise<InitiatePaymentResponse> {
+        const response = await this.request<{ success?: boolean; data?: InitiatePaymentResponse } & InitiatePaymentResponse>(
+            `/api/v1/payment-links/public/${encodeURIComponent(paymentLinkSlug)}/pay`,
+            data,
+            false
         );
         // Handle both wrapped { success, data: {...} } and flat response formats
         if (response.data && typeof response.data === 'object' && 'transactionRef' in response.data) {

package/src/components/modal.ts

@@ -773,22 +773,33 @@ export class VoxePayModal {
         // Use merchant-provided callback
         details = await this.options.onBankTransferRequested();
       } else if (this.apiClient && this.options._sdkConfig) {
+        if (!this.options._sdkConfig.paymentLinkSlug) {
+          throw {
+            code: 'MISSING_PAYMENT_LINK_SLUG',
+            message: 'paymentLinkSlug is required in VoxePay.init() for bank transfer.',
+          };
+        }
+
         // Call real DVA API
         const transactionRef = `VP-${Date.now().toString(36).toUpperCase()}-${Math.random().toString(36).substring(2, 8).toUpperCase()}`;
 
-        const response = await this.apiClient.initiatePayment({
-          organizationId: this.options._sdkConfig.organizationId,
-          transactionRef,
-          customerId: this.options.customerEmail || '',
-          customerEmail: this.options.customerEmail,
-          customerPhone: this.options.customerPhone,
-          amount: this.options.amount / 100, // Convert from kobo/cents to main unit
-          currency: this.options.currency,
-          paymentMethod: 'BANK_TRANSFER',
-          authData: btoa(JSON.stringify({ source: 'web', method: 'bank_transfer' })),
-          narration: this.options.description,
-          durationMinutes: 30,
-        });
+        const response = await this.apiClient.initiateTransferPayment(
+          this.options._sdkConfig.paymentLinkSlug,
+          {
+            organizationId: this.options._sdkConfig.organizationId,
+            transactionRef,
+            customerId: this.options.customerEmail || '',
+            customerEmail: this.options.customerEmail,
+            customerPhone: this.options.customerPhone,
+            customerName: this.options.customerName,
+            amount: this.options.amount / 100,
+            currency: this.options.currency,
+            paymentMethod: 'BANK_TRANSFER',
+            authData: btoa(JSON.stringify({ source: 'web', method: 'bank_transfer' })),
+            narration: this.options.description,
+            durationMinutes: 30,
+          }
+        );
 
         // Store transaction ref for status polling
         // API may return 'id' (DVA) or 'paymentId' (card) depending on payment method
@@ -814,7 +825,7 @@ export class VoxePayModal {
           expiresAt: va.expires_at,
         };
       } else {
-        throw { code: 'SDK_ERROR', message: 'SDK not properly initialized. Missing API key or organization ID.' };
+        throw { code: 'SDK_ERROR', message: 'SDK not properly initialized. Missing required organizationId.' };
       }
 
       this.state.bankTransferDetails = details;

package/src/types.ts

@@ -6,12 +6,14 @@
  * Configuration for initializing VoxePay
  */
 export interface VoxePayConfig {
-    /** Your VoxePay API key (e.g., vxp_live_xxxxx) */
-    apiKey: string;
+    /** Optional API key (not required for public transfer/status flow) */
+    apiKey?: string;
     /** Your VoxePay organization ID */
     organizationId: string;
     /** API base URL (defaults to https://devpay.voxepay.app) */
     baseUrl?: string;
+    /** Public payment link slug used for bank transfer initiation endpoint */
+    paymentLinkSlug?: string;
     /** Theme mode: 'dark' (default), 'light', or 'auto' (follows system) */
     theme?: 'dark' | 'light' | 'auto';
     /** Locale for formatting (e.g., 'en-US', 'en-NG') */
@@ -80,6 +82,8 @@ export interface CheckoutOptions {
     customerEmail?: string;
     /** Customer's phone number */
     customerPhone?: string;
+    /** Customer's full name */
+    customerName?: string;
     /** Additional metadata to attach to the payment */
     metadata?: Record<string, unknown>;
     /** Payment methods to show. Defaults to ['card', 'bank_transfer'] */
@@ -90,9 +94,10 @@ export interface CheckoutOptions {
     onBankTransferRequested?: () => Promise<BankTransferDetails>;
     /** @internal SDK config passed from VoxePaySDK to modal */
     _sdkConfig?: {
-        apiKey: string;
+        apiKey?: string;
         organizationId: string;
         baseUrl?: string;
+        paymentLinkSlug?: string;
         simulateWebhook?: boolean;
         bypassKey?: string;
     };

package/src/voxepay.ts

@@ -29,14 +29,9 @@ class VoxePaySDK {
 
     /**
      * Initialize VoxePay with your configuration
-     * @param config - Configuration object with API key and optional settings
+     * @param config - Configuration object with required organizationId and optional settings
      */
     init(config: VoxePayConfig): void {
-        if (!config.apiKey) {
-            console.error('[VoxePay] API key is required. Get your API key from the VoxePay dashboard: Settings > API Keys');
-            return;
-        }
-
         if (!config.organizationId) {
             console.error('[VoxePay] Organization ID is required. Find it in your VoxePay dashboard.');
             return;
@@ -109,6 +104,7 @@ class VoxePaySDK {
                 apiKey: this.config!.apiKey,
                 organizationId: this.config!.organizationId,
                 baseUrl: this.config!.baseUrl,
+                paymentLinkSlug: this.config!.paymentLinkSlug,
                 simulateWebhook: this.config!.simulateWebhook,
                 bypassKey: this.config!.bypassKey,
             },
@@ -181,7 +177,7 @@ class VoxePaySDK {
      * Get the SDK version
      */
     get version(): string {
-        return '0.3.0';
+        return '0.5.4';
     }
 
     /**