paystack-axios-typed-payloads

name	paystack-axios-typed-payloads
description	Use when choosing TypeScript typed requests, query params, response types, or grouped client types from the Paystack Axios SDK @alexasomba/paystack-axios.
license	MIT
compatibility	Node.js >=22.0.0; ESM-only package; backend/server runtime; import @alexasomba/paystack-axios.

Paystack Axios Typed Payloads

Prefer exported aliases and grouped client slice types for application services. Use generated OpenAPI types only for advanced cases.

Client slices

import type {
  Paystack,
  PaystackTransactionClient,
  PaystackCustomerClient,
} from "@alexasomba/paystack-axios";

Pass the smallest client slice into a service when possible.

async function verifyPayment(transaction: PaystackTransactionClient, reference: string) {
  return transaction.transaction_verify({
    params: { path: { reference } },
  });
}

Payload aliases

import type {
  TransactionInitializePayload,
  CustomerCreatePayload,
  RefundCreatePayload,
} from "@alexasomba/paystack-axios";

const customer: CustomerCreatePayload = {
  email: "[e-mail]",
};

Best practices

• Avoid rebuilding payload types from ReturnType<typeof createPaystack>.
• Keep user-input validation separate from Paystack SDK payload types.
• Reach for paths, operations, or components only when a curated alias is not exported.