paystack-webhook-types 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Erastus Beloved
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,79 @@
+# @types/paystack-webhook-types
+
+TypeScript type definitions for [Paystack Webhooks](https://paystack.com/docs/payments/webhooks).  
+This package provides strongly-typed event objects for Paystack webhooks, making it easier and safer to integrate into your Node.js or TypeScript backend.
+
+---
+
+## Features
+- Full type coverage for Paystack webhook events (e.g., `charge.success`, `transfer.failed`, etc.).  
+- Discriminated union support — safely narrow down events by their `event` property.  
+- Autocomplete & IntelliSense in your IDE.  
+- Easy to extend and contribute.
+
+---
+
+## Installation
+
+```bash
+npm install @types/paystack-webhook-types
+# or
+yarn add @types/paystack-webhook-types
+```
+
+---
+
+## Usage
+
+```ts
+import { PaystackWebhookEvent, ExtractEvent, Events } from "@types/paystack-webhook-types";
+import { Request, Response } from "express";
+
+app.post("/webhook", (req: Request, res: Response) => {
+  const event = req.body as PaystackWebhookEvent;
+
+  switch (event.event as Events) {
+    case "charge.success": {
+      const data = (event as ExtractEvent<"charge.success">).data;
+      console.log("Charge was successful:", data);
+      break;
+    }
+    case "transfer.failed": {
+      const data = (event as ExtractEvent<"transfer.failed">).data;
+      console.error("Transfer failed:", data);
+      break;
+    }
+    default:
+      console.log("Unhandled event:", event.event);
+  }
+
+  res.sendStatus(200);
+});
+```
+
+---
+
+## Contributing
+
+Contributions are welcome
+If you’d like to add new event types, improve docs, or fix issues:
+
+1. Fork the repo
+2. Create a feature branch: `git checkout -b feature/my-update`
+3. Commit changes: `git commit -m "Add XYZ event type"`
+4. Push and open a Pull Request
+
+Please make sure to add/update tests for new event types.
+
+---
+
+## License
+
+MIT License © 2025-present  
+Open to community contributions.
+
+---
+
+## Acknowledgements
+- [Paystack Documentation](https://paystack.com/docs/)
+- Inspired by DefinitelyTyped and similar community-driven type packages

package/dist/events/charge.d.ts

@@ -0,0 +1,125 @@
+import type { Authorization, Currency, Customer, WebhookStatus } from "../shared/common";
+export type ChargeEvents = "charge.success" | "charge.failed";
+export interface ChargeData {
+    id: number;
+    domain: string;
+    status: WebhookStatus;
+    reference: string;
+    amount: number;
+    message: string | null;
+    gateway_response: string;
+    paid_at: string;
+    created_at: string;
+    channel: string;
+    currency: Currency;
+    ip_address: string;
+    metadata: Record<string, any>;
+    log: {
+        start_time: number | null;
+        time_spent: number;
+        attempts: number;
+        authentication: string;
+        errors: number;
+        success: boolean;
+        mobile: boolean;
+        input: any[];
+        history: Array<{
+            type: string;
+            message: string;
+            time: number;
+        }>;
+    } | null;
+    fees: number | null;
+    fees_split: any;
+    authorization: Authorization;
+    customer: Customer;
+    plan: any;
+    split: Record<string, any>;
+    order_id: string | null;
+    requested_amount: number;
+    pos_transaction_data: any;
+    source: any;
+    fees_breakdown: any;
+}
+/**
+ * @description
+ * A successful charge was made
+ * @example
+ * {
+  "event": "charge.success",
+  "data": {
+    "id": 302961,
+    "domain": "live",
+    "status": "success",
+    "reference": "qTPrJoy9Bx",
+    "amount": 10000,
+    "message": null,
+    "gateway_response": "Approved by Financial Institution",
+    "paid_at": "2016-09-30T21:10:19.000Z",
+    "created_at": "2016-09-30T21:09:56.000Z",
+    "channel": "card",
+    "currency": "NGN",
+    "ip_address": "41.242.49.37",
+    "metadata": 0,
+    "log": {
+      "time_spent": 16,
+      "attempts": 1,
+      "authentication": "pin",
+      "errors": 0,
+      "success": false,
+      "mobile": false,
+      "input": [],
+      "channel": null,
+      "history": [
+        {
+          "type": "input",
+          "message": "Filled these fields: card number, card expiry, card cvv",
+          "time": 15
+        },
+        {
+          "type": "action",
+          "message": "Attempted to pay",
+          "time": 15
+        },
+        {
+          "type": "auth",
+          "message": "Authentication Required: pin",
+          "time": 16
+        }
+      ]
+    },
+    "fees": null,
+    "customer": {
+      "id": 68324,
+      "first_name": "BoJack",
+      "last_name": "Horseman",
+      "email": "bojack@horseman.com",
+      "customer_code": "CUS_qo38as2hpsgk2r0",
+      "phone": null,
+      "metadata": null,
+      "risk_action": "default"
+    },
+    "authorization": {
+      "authorization_code": "AUTH_f5rnfq9p",
+      "bin": "539999",
+      "last4": "8877",
+      "exp_month": "08",
+      "exp_year": "2020",
+      "card_type": "mastercard DEBIT",
+      "bank": "Guaranty Trust Bank",
+      "country_code": "NG",
+      "brand": "mastercard",
+      "account_name": "BoJack Horseman"
+    },
+    "plan": {}
+  }
+}
+ */
+export interface ChargeSuccessEvent {
+    event: 'charge.success';
+    data: ChargeData;
+}
+export interface ChargeFailedEvent {
+    event: 'charge.failed';
+    data: ChargeData;
+}

package/dist/events/charge.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=charge.js.map

package/dist/events/charge.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"charge.js","sourceRoot":"","sources":["../../src/events/charge.ts"],"names":[],"mappings":""}

package/dist/events/subscription.d.ts

@@ -0,0 +1,296 @@
+import type { Authorization, Currency, Customer, Domain } from "../shared/common";
+export type SubscriptionStatus = 'active' | 'non-renewing' | 'cancelled' | 'attention' | 'complete';
+export type SubscriptionPlanInterval = 'daily' | 'weekly' | 'monthly' | 'annually';
+export type SubscriptionEvents = 'subscription.create' | 'subscription.disable' | 'subscription.not_renew' | 'subscription.expiring_cards';
+export interface SubscriptionData {
+    id: number | null;
+    domain: Domain;
+    status: SubscriptionStatus;
+    subscription_code: string;
+    email_token: string | null;
+    amount: number;
+    cron_expression: string;
+    next_payment_date: string;
+    open_invoice: string | null;
+    integration: number | null;
+    authorization: Authorization;
+    customer: Customer;
+    invoices: any[] | null;
+    invoices_history: any[] | null;
+    invoice_limit: number | null;
+    split_code: string | null;
+    created_at: string;
+    most_recent_invoice: any | null;
+}
+export interface SubscriptionPlan {
+    name: string;
+    plan_code: string;
+    description: string | null;
+    amount: number;
+    interval: SubscriptionPlanInterval;
+    send_invoices: boolean;
+    send_sms: boolean;
+    currency: Currency;
+}
+/**
+* Subscription plan information when event is "disable".
+*
+* @example
+* {
+*   "id": 67572,
+    "name": "Monthly retainer",
+    "plan_code": "PLN_gx2wn530m0i3w3m",
+    "description": null,
+    "amount": 50000,
+    "interval": "monthly",
+    "send_invoices": true,
+    "send_sms": true,
+    "currency": "NGN"
+ * }
+ */
+export interface SubscriptionPlanWithId extends SubscriptionPlan {
+    id: number;
+}
+export interface SubscriptionPlanWithoutId extends SubscriptionPlan {
+    id: null;
+}
+/**
+ * @description
+ * A subscription has been created
+ * @example
+ * {
+  "event": "subscription.create",
+  "data": {
+    "domain": "test",
+    "status": "active",
+    "subscription_code": "SUB_vsyqdmlzble3uii",
+    "amount": 50000,
+    "cron_expression": "0 0 28 * *",
+    "next_payment_date": "2016-05-19T07:00:00.000Z",
+    "open_invoice": null,
+    "createdAt": "2016-03-20T00:23:24.000Z",
+    "plan": {
+      "name": "Monthly retainer",
+      "plan_code": "PLN_gx2wn530m0i3w3m",
+      "description": null,
+      "amount": 50000,
+      "interval": "monthly",
+      "send_invoices": true,
+      "send_sms": true,
+      "currency": "NGN"
+    },
+    "authorization": {
+      "authorization_code": "AUTH_96xphygz",
+      "bin": "539983",
+      "last4": "7357",
+      "exp_month": "10",
+      "exp_year": "2017",
+      "card_type": "MASTERCARD DEBIT",
+      "bank": "GTBANK",
+      "country_code": "NG",
+      "brand": "MASTERCARD",
+      "account_name": "BoJack Horseman"
+    },
+    "customer": {
+      "first_name": "BoJack",
+      "last_name": "Horseman",
+      "email": "bojack@horsinaround.com",
+      "customer_code": "CUS_xnxdt6s1zg1f4nx",
+      "phone": "",
+      "metadata": {},
+      "risk_action": "default"
+    },
+    "created_at": "2016-10-01T10:59:59.000Z"
+  }
+}
+ */
+export interface SubscriptionCreateEvent {
+    event: 'subscription.create';
+    data: SubscriptionData & {
+        plan: SubscriptionPlanWithoutId;
+    };
+}
+/**
+ * @description
+ * A subscription on your account has been disabled
+ * @example
+ * {
+  "event": "subscription.disable",
+  "data": {
+    "domain": "test",
+    "status": "complete",
+    "subscription_code": "SUB_vsyqdmlzble3uii",
+    "email_token": "ctt824k16n34u69",
+    "amount": 300000,
+    "cron_expression": "0 * * * *",
+    "next_payment_date": "2020-11-26T15:00:00.000Z",
+    "open_invoice": null,
+    "plan": {
+      "id": 67572,
+      "name": "Monthly retainer",
+      "plan_code": "PLN_gx2wn530m0i3w3m",
+      "description": null,
+      "amount": 50000,
+      "interval": "monthly",
+      "send_invoices": true,
+      "send_sms": true,
+      "currency": "NGN"
+    },
+    "authorization": {
+      "authorization_code": "AUTH_96xphygz",
+      "bin": "539983",
+      "last4": "7357",
+      "exp_month": "10",
+      "exp_year": "2017",
+      "card_type": "MASTERCARD DEBIT",
+      "bank": "GTBANK",
+      "country_code": "NG",
+      "brand": "MASTERCARD",
+      "account_name": "BoJack Horseman"
+    },
+    "customer": {
+      "first_name": "BoJack",
+      "last_name": "Horseman",
+      "email": "bojack@horsinaround.com",
+      "customer_code": "CUS_xnxdt6s1zg1f4nx",
+      "phone": "",
+      "metadata": {},
+      "risk_action": "default"
+    },
+    "created_at": "2020-11-26T14:45:06.000Z"
+  }
+}
+ */
+export interface SubscriptionDisableEvent {
+    event: 'subscription.disable';
+    data: SubscriptionData & {
+        plan: SubscriptionPlanWithId;
+    };
+}
+/**
+ * @description
+ * A subscription on your account's status has changed to non-renewing. This means the subscription will not be charged on the next payment date
+ * @example
+ * {
+  "event": "subscription.not_renew",
+  "data": {
+    "id": 317617,
+    "domain": "test",
+    "status": "non-renewing",
+    "subscription_code": "SUB_d638sdiWAio7jnl",
+    "email_token": "086x99rmqc4qhcw",
+    "amount": 120000,
+    "cron_expression": "0 0 8 10 *",
+    "next_payment_date": null,
+    "open_invoice": null,
+    "integration": 116430,
+    "plan": {
+      "id": 103028,
+      "name": "(1,200) - annually - [1 - Year]",
+      "plan_code": "PLN_tlknnnzfi4w2evu",
+      "description": "Subscription not_renewed for sub@notrenew.com",
+      "amount": 120000,
+      "interval": "annually",
+      "send_invoices": true,
+      "send_sms": true,
+      "currency": "NGN"
+    },
+    "authorization": {
+      "authorization_code": "AUTH_5ftfl9xrl0",
+      "bin": "424242",
+      "last4": "4081",
+      "exp_month": "06",
+      "exp_year": "2023",
+      "channel": "card",
+      "card_type": "mastercard debit",
+      "bank": "Guaranty Trust Bank",
+      "country_code": "NG",
+      "brand": "mastercard",
+      "reusable": true,
+      "signature": "SIG_biPYZE4PgDCQUJMIT4sE",
+      "account_name": null
+    },
+    "customer": {
+      "id": 57199167,
+      "first_name": null,
+      "last_name": null,
+      "email": "sub@notrenew.com",
+      "customer_code": "CUS_8gbmdpvn12c67ix",
+      "phone": null,
+      "metadata": null,
+      "risk_action": "default",
+      "international_format_phone": null
+    },
+    "invoices": [],
+    "invoices_history": [],
+    "invoice_limit": 0,
+    "split_code": null,
+    "most_recent_invoice": null,
+    "created_at": "2021-10-08T14:50:39.000Z"
+  }
+}
+ */
+export interface SubscriptionNotRenewingEvent {
+    event: 'subscription.not_renew';
+    data: SubscriptionData & {
+        plan: SubscriptionPlanWithId;
+    };
+}
+/**
+ * @description
+ * Contains information on all subscriptions with cards that are expiring that month. Sent at the beginning of the month, to merchants using Subscriptions
+ * @example
+ * {
+  "event": "subscription.expiring_cards",
+  "data": [
+    {
+      "expiry_date": "12/2021",
+      "description": "visa ending with 4081",
+      "brand": "visa",
+      "subscription": {
+        "id": 94729,
+        "subscription_code": "SUB_lejj927x2kxciw1",
+        "amount": 44000,
+        "next_payment_date": "2021-11-11T00:00:01.000Z",
+        "plan": {
+          "interval": "monthly",
+          "id": 22637,
+          "name": "Premium Service (Monthly)",
+          "plan_code": "PLN_pfmwz75o021slex"
+        }
+      },
+      "customer": {
+        "id": 7808239,
+        "first_name": "Bojack",
+        "last_name": "Horseman",
+        "email": "bojackhoresman@gmail.com",
+        "customer_code": "CUS_8v6g420rc16spqw"
+      }
+    }
+  ]
+}
+ */
+export interface SubscriptionExpiringCardsEvent {
+    event: 'subscription.expiring_cards';
+    data: SubscriptionExpiringCardsEvent[];
+}
+export interface SubscriptionDataExpiringCards {
+    /**
+     * @example "12/2021"
+     */
+    expiry_date: string;
+    description: string;
+    brand: string;
+    subscription: {
+        id: number;
+        subscription_code: string;
+        amount: number;
+        next_payment_date: string;
+        plan: {
+            interval: SubscriptionPlanInterval;
+            id: number;
+            name: string;
+            plan_code: string;
+        };
+    };
+}

package/dist/events/subscription.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=subscription.js.map

package/dist/events/subscription.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"subscription.js","sourceRoot":"","sources":["../../src/events/subscription.ts"],"names":[],"mappings":""}

package/dist/events/transfer.d.ts

@@ -0,0 +1,248 @@
+import type { Currency, Domain } from "../shared/common";
+import type { Without } from "../shared/util";
+export type TransferEvents = 'transfer.success' | 'transfer.failed' | 'transfer.reversed';
+export type TransactionSource = 'balance';
+export type TransferStatus = 'success' | 'failed' | 'pending' | 'reversed' | 'otp' | 'processing';
+export interface TransferData {
+    id: number;
+    amount: number;
+    createdAt: string;
+    currency: Currency;
+    domain: Domain;
+    failures: any | null;
+    integration: {
+        id: number;
+        is_live: boolean;
+        business_name: string;
+        logo_path: string | null;
+    };
+    reason: string;
+    reference: string;
+    source: TransactionSource;
+    source_details: string | null;
+    status: TransferStatus;
+    titan_code: string | null;
+    transfer_code: string;
+    transferred_at: string | null;
+    updatedAt: string | null;
+    recipient: TransferRecipient;
+    session: {
+        provider: string | null;
+        id: number | null;
+    };
+    created_at: string;
+    updated_at: string;
+    fee_charged: number;
+    gateway_response: string;
+}
+export interface TransferRecipient {
+    id: number;
+    active: boolean;
+    currency: Currency;
+    description: string | null;
+    domain: Domain;
+    email: string | null;
+    integration: number;
+    metadata: Record<string, any> | null;
+    name: string;
+    recipient_code: string;
+    type: 'nuban' | 'mobile_money' | 'basa' | 'authorization';
+    createdAt: string | null;
+    updatedAt: string | null;
+    is_deleted: boolean;
+    details: {
+        authorization_code: string | null;
+        account_number: string | null;
+        account_name: string | null;
+        bank_code: string | null;
+        bank_name: string | null;
+    };
+    created_at: string | null;
+    updated_at: string | null;
+}
+/**
+ * @description
+ * A successful transfer has been completed
+ * @example
+ * {
+  "event": "transfer.success",
+  "data": {
+    "amount": 100000,
+    "createdAt": "2025-08-04T10:32:40.000Z",
+    "currency": "NGN",
+    "domain": "test",
+    "failures": null,
+    "id": 860703114,
+    "integration": {
+      "id": 463433,
+      "is_live": true,
+      "business_name": "Paystack Demo",
+      "logo_path": "https://public-files-paystack-prod.s3.eu-west-1.amazonaws.com/integration-logos/hpyxo8n1c7du6gxup7h6.png"
+    },
+    "reason": "Bonus for the week",
+    "reference": "acv_9ee55786-2323-4760-98e2-6380c9cb3f68",
+    "source": "balance",
+    "source_details": null,
+    "status": "success",
+    "titan_code": null,
+    "transfer_code": "TRF_v5tip3zx8nna9o78",
+    "transferred_at": null,
+    "updatedAt": "2025-08-04T10:32:40.000Z",
+    "recipient": {
+      "active": true,
+      "createdAt": "2023-07-11T15:42:27.000Z",
+      "currency": "NGN",
+      "description": "",
+      "domain": "test",
+      "email": null,
+      "id": 56824902,
+      "integration": 463433,
+      "metadata": null,
+      "name": "Jekanmo Padie",
+      "recipient_code": "RCP_gd9vgag7n5lr5ix",
+      "type": "nuban",
+      "updatedAt": "2023-07-11T15:42:27.000Z",
+      "is_deleted": false,
+      "details": {
+        "authorization_code": null,
+        "account_number": "9876543210",
+        "account_name": null,
+        "bank_code": "044",
+        "bank_name": "Access Bank"
+      }
+    },
+    "session": {
+      "provider": null,
+      "id": null
+    },
+    "fee_charged": 0,
+    "gateway_response": null
+  }
+}
+ */
+export interface TransferSuccessEvent {
+    event: 'transfer.success';
+    data: Without<TransferData, 'created_at' | 'updated_at'>;
+}
+/**
+ * @description
+ * A transfer you attempted has failed
+ * @example
+ * {
+  "event": "transfer.failed",
+  "data": {
+    "amount": 200000,
+    "currency": "NGN",
+    "domain": "test",
+    "failures": null,
+    "id": 69123462,
+    "integration": {
+      "id": 100043,
+      "is_live": true,
+      "business_name": "Paystack"
+    },
+    "reason": "Enjoy",
+    "reference": "1976435206",
+    "source": "balance",
+    "source_details": null,
+    "status": "failed",
+    "titan_code": null,
+    "transfer_code": "TRF_chs98y5rykjb47w",
+    "transferred_at": null,
+    "recipient": {
+      "active": true,
+      "currency": "NGN",
+      "description": null,
+      "domain": "test",
+      "email": "test@email.com",
+      "id": 13584206,
+      "integration": 100043,
+      "metadata": null,
+      "name": "Ted Lasso",
+      "recipient_code": "RCP_cjcua8itre45gs",
+      "type": "nuban",
+      "is_deleted": false,
+      "details": {
+        "authorization_code": null,
+        "account_number": "0123456789",
+        "account_name": "Ted Lasso",
+        "bank_code": "011",
+        "bank_name": "First Bank of Nigeria"
+      },
+      "created_at": "2021-04-12T15:30:14.000Z",
+      "updated_at": "2021-04-12T15:30:14.000Z"
+    },
+    "session": {
+      "provider": "nip",
+      "id": "74849400998877667"
+    },
+    "created_at": "2021-04-12T15:30:15.000Z",
+    "updated_at": "2021-04-12T15:41:21.000Z"
+  }
+}
+ */
+export interface TransferFailedEvent {
+    event: 'transfer.failed';
+    data: Without<TransferData, 'fee_charged' | 'gateway_response' | 'createdAt'>;
+}
+/**
+ * @description
+ * A transfer you attempted has been reversed
+ * @example
+ * {
+  "event": "transfer.reversed",
+  "data": {
+    "amount": 10000,
+    "currency": "NGN",
+    "domain": "live",
+    "failures": null,
+    "id": 20615868,
+    "integration": {
+      "id": 100073,
+      "is_live": true,
+      "business_name": "Night's Watch Inc"
+    },
+    "reason": "test balance ledger elastic changes",
+    "reference": "jvrjckwenm",
+    "source": "balance",
+    "source_details": null,
+    "status": "reversed",
+    "titan_code": null,
+    "transfer_code": "TRF_js075pj9u07f34l",
+    "transferred_at": "2020-03-24T07:14:00.000Z",
+    "recipient": {
+      "active": true,
+      "currency": "NGN",
+      "description": null,
+      "domain": "live",
+      "email": "jon@sn.ow",
+      "id": 1476759,
+      "integration": 100073,
+      "metadata": null,
+      "name": "JON SNOW",
+      "recipient_code": "RCP_hmcj8ciho490bvi",
+      "type": "nuban",
+      "is_deleted": false,
+      "details": {
+        "authorization_code": null,
+        "account_number": "0000000000",
+        "account_name": null,
+        "bank_code": "011",
+        "bank_name": "First Bank of Nigeria"
+      },
+      "created_at": "2019-04-10T08:39:10.000Z",
+      "updated_at": "2019-11-27T20:43:57.000Z"
+    },
+    "session": {
+      "provider": "nip",
+      "id": "110006200324071331002061586801"
+    },
+    "created_at": "2020-03-24T07:13:31.000Z",
+    "updated_at": "2020-03-24T07:14:55.000Z"
+  }
+}
+ */
+export interface TransferReversedEvent {
+    event: 'transfer.reversed';
+    data: Without<TransferData, 'fee_charged' | 'gateway_response' | 'createdAt'>;
+}

package/dist/events/transfer.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=transfer.js.map

package/dist/events/transfer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transfer.js","sourceRoot":"","sources":["../../src/events/transfer.ts"],"names":[],"mappings":""}

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+export * from './events/charge';
+export * from './events/subscription';
+export * from './events/transfer';
+export * from './shared/common';
+export * from './webhook';
+export type { PaystackWebhookEvent, Events } from './webhook';
+export type { ExtractEvent } from './shared/util';

package/dist/index.js

@@ -0,0 +1,6 @@
+export * from './events/charge';
+export * from './events/subscription';
+export * from './events/transfer';
+export * from './shared/common';
+export * from './webhook';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAA;AAC/B,cAAc,uBAAuB,CAAA;AACrC,cAAc,mBAAmB,CAAA;AAEjC,cAAc,iBAAiB,CAAA;AAE/B,cAAc,WAAW,CAAA"}

package/dist/shared/common.d.ts

@@ -0,0 +1,29 @@
+export interface Customer {
+    id: number;
+    first_name: string | null;
+    last_name: string | null;
+    email: string;
+    customer_code: string;
+    phone: string | null;
+    metadata: Record<string, any> | null;
+    risk_action: string;
+    international_format_phone: string | null;
+}
+export interface Authorization {
+    authorization_code: string;
+    bin: string;
+    last4: string;
+    exp_month: string;
+    exp_year: string;
+    channel: 'card' | 'bank' | 'ussd' | 'qr' | 'mobile_money' | 'bank_transfer';
+    card_type: string;
+    bank: string;
+    country_code: string;
+    brand: string;
+    reusable: boolean;
+    signature: string | null;
+    account_name: string | null;
+}
+export type WebhookStatus = 'success' | 'failed' | 'pending' | 'abandoned';
+export type Currency = 'NGN' | 'GHS' | 'ZAR' | 'USD';
+export type Domain = 'test' | 'live';

package/dist/shared/common.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=common.js.map

package/dist/shared/common.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.js","sourceRoot":"","sources":["../../src/shared/common.ts"],"names":[],"mappings":""}

package/dist/shared/metadata.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/shared/metadata.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=metadata.js.map

package/dist/shared/metadata.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"metadata.js","sourceRoot":"","sources":["../../src/shared/metadata.ts"],"names":[],"mappings":""}

package/dist/shared/util.d.ts

@@ -0,0 +1,12 @@
+import type { PaystackWebhookEvent } from "../webhook";
+export type Without<T, K extends keyof T> = Omit<T, K> & {
+    [P in K]?: never;
+};
+/**
+ * Extract event type from event name
+ * @example
+ * type ChargeSuccess = ExtractEvent<'charge.success'>
+ */
+export type ExtractEvent<T extends PaystackWebhookEvent['event']> = Extract<PaystackWebhookEvent, {
+    event: T;
+}>;

package/dist/shared/util.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=util.js.map

package/dist/shared/util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.js","sourceRoot":"","sources":["../../src/shared/util.ts"],"names":[],"mappings":""}

package/dist/webhook.d.ts

@@ -0,0 +1,5 @@
+import type { ChargeEvents, ChargeFailedEvent, ChargeSuccessEvent } from "./events/charge";
+import type { SubscriptionCreateEvent, SubscriptionDisableEvent, SubscriptionEvents, SubscriptionExpiringCardsEvent, SubscriptionNotRenewingEvent } from "./events/subscription";
+import type { TransferEvents, TransferFailedEvent, TransferReversedEvent, TransferSuccessEvent } from "./events/transfer";
+export type PaystackWebhookEvent = ChargeSuccessEvent | ChargeFailedEvent | SubscriptionCreateEvent | SubscriptionDisableEvent | SubscriptionNotRenewingEvent | SubscriptionExpiringCardsEvent | TransferSuccessEvent | TransferFailedEvent | TransferReversedEvent;
+export type Events = ChargeEvents | SubscriptionEvents | TransferEvents;

package/dist/webhook.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=webhook.js.map

package/dist/webhook.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"webhook.js","sourceRoot":"","sources":["../src/webhook.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "paystack-webhook-types",
+  "version": "0.1.0",
+  "description": "TypeScript definitions for Paystack webhook events",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "type": "module",
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "lint": "eslint src --ext .ts",
+    "format": "prettier --write \"src/**/*.ts\"",
+    "prepublishOnly": "npm run build && npm test",
+    "docs": "typedoc src/index.ts"
+  },
+  "keywords": [
+    "paystack",
+    "webhook",
+    "types",
+    "typescript",
+    "payments",
+    "events"
+  ],
+  "author": "Erastus ND <belovederastus@gmail.com>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Ndbeloved/paystack-webhook-types.git"
+  },
+  "devDependencies": {
+    "@types/jest": "^30.0.0",
+    "@types/node": "^24.6.2",
+    "@typescript-eslint/eslint-plugin": "^8.45.0",
+    "@typescript-eslint/parser": "^8.45.0",
+    "eslint": "^9.37.0",
+    "jest": "^30.2.0",
+    "prettier": "^3.6.2",
+    "ts-jest": "^29.4.4",
+    "ts-node": "^10.9.2",
+    "tsx": "^4.20.6",
+    "typedoc": "^0.28.13",
+    "typescript": "^5.9.3"
+  }
+}