Packages@g14o/paystack

API Reference

Paystack client types, params, and webhook delivery options.

PaystackClientOptions

Option	Type	Description
`baseUrl?`	`string`	Override the Paystack API base URL (defaults to `https://api.paystack.co`). Default: `https://api.paystack.co`
`fetch?`	`function`	Custom fetch implementation (useful for tests or proxies). Default: `fetch`
`maxRetries?`	`number`	Maximum retry attempts on transient failures (default: 3). Default: `3`
`publicKey?`	`string`	Public key for client-side Paystack Popup integrations. Default: `undefined`
`secretKey`	`string`	Secret key used for API authentication and webhook HMAC verification.
`timeoutMs?`	`number`	Request timeout in milliseconds. Default: `30000`

InitializeTransactionParams

Prop	Type	Description
`amount`	`number`	The amount to charge.
`callback_url?`	`string`	The callback URL to be called after the transaction is completed. Default: `undefined`
`channels?`	`array`	The channels to be used for the transaction. Default: `undefined`
`currency?`	`string`	The currency of the transaction. Default: `undefined`
`email`	`string`	The email address of the customer.
`metadata?`	`Record<string, unknown>`	Additional metadata about the transaction. Default: `undefined`
`plan?`	`string`	The plan to be used for the transaction. Default: `undefined`
`reference?`	`string`	The reference to be used for the transaction. Default: `undefined`

ChargeAuthorizationParams

Prop	Type	Description
`amount`	`number`	The amount to charge.
`authorization_code`	`string`	The authorization code to be used for the transaction.
`currency?`	`string`	The currency of the transaction. Default: `undefined`
`email`	`string`	The email address of the customer.
`metadata?`	`Record<string, unknown>`	Additional metadata about the transaction. Default: `undefined`
`reference?`	`string`	The reference to be used for the transaction. Default: `undefined`

CreateCustomerParams

Prop	Type	Description
`email`	`string`	The email address of the customer.
`first_name?`	`string`	The first name of the customer. Default: `undefined`
`last_name?`	`string`	The last name of the customer. Default: `undefined`
`metadata?`	`Record<string, unknown>`	Additional metadata about the customer. Default: `undefined`
`phone?`	`string`	The phone number of the customer. Default: `undefined`

CreatePlanParams

Prop	Type	Description
`amount`	`number`	The amount to charge.
`currency?`	`string`	The currency of the transaction. Default: `undefined`
`description?`	`string`	The description of the plan. Default: `undefined`
`interval`	`string`	The interval of the plan.
`invoice_limit?`	`number`	The invoice limit of the plan. Default: `undefined`
`name`	`string`	The name of the plan.
`send_invoices?`	`boolean \| undefined`	Whether to send invoices for the plan. Default: `undefined`
`send_sms?`	`boolean \| undefined`	Whether to send SMS for the plan. Default: `undefined`

CreateSubscriptionParams

Prop	Type	Description
`authorization?`	`string`	The authorization code to be used for the subscription. Default: `undefined`
`customer`	`string`	The customer code to be used for the subscription.
`plan`	`string`	The plan code to be used for the subscription.
`start_date?`	`string`	The start date of the subscription. Default: `undefined`

DisableSubscriptionParams

Prop	Type	Description
`code`	`string`	The code of the subscription to disable.
`token`	`string`	The token of the subscription to disable.

WebhookDeliveryStore

Method	Type	Description
`claim`	`function`	Atomically claims a webhook delivery for processing. Returns `duplicate` when the event was already processed or is in-flight.
`markFailed`	`function`	Marks a webhook delivery as failed.
`markProcessed`	`function`	Marks a webhook delivery as processed.

ProcessWebhookDeliveryRequestOptions

Option	Type	Description
`disablePersistence?`	`boolean \| undefined`	Whether to disable persistence of the webhook delivery. Default: `false`
`handler`	`function`	The handler to process the webhook event.
`store?`	`object`	The store to persist the webhook event. Default: `undefined`

ProcessWebhookDeliveryOptions

Option	Type	Description
`disablePersistence?`	`boolean \| undefined`	Whether to disable persistence of the webhook delivery. Default: `false`
`event`	`PaystackWebhookEvent`	The webhook event to process.
`handler`	`function`	The handler to process the webhook event.
`rawBody`	`string`	The raw body of the webhook event.
`store?`	`object`	The store to persist the webhook event. Default: `undefined`

Webhooks

Verify, parse, and process Paystack webhook deliveries with typed events and optional deduplication.

Overview

Paystack billing plugin for Better Auth — checkout, subscriptions, and webhooks.

On this page

PaystackClientOptions InitializeTransactionParams ChargeAuthorizationParams CreateCustomerParams CreatePlanParams CreateSubscriptionParams DisableSubscriptionParams WebhookDeliveryStore ProcessWebhookDeliveryRequestOptions ProcessWebhookDeliveryOptions