paystack-axios-api-operations

name	paystack-axios-api-operations
description	Use when calling Paystack API operations with the Paystack Axios SDK @alexasomba/paystack-axios, including transactions, request bodies, path params, query params, and pagination.
license	MIT
compatibility	Node.js >=22.0.0; ESM-only package; backend/server runtime; import @alexasomba/paystack-axios.

Paystack Axios API Operations

The Axios SDK exposes the same grouped operation helpers as the generated OpenAPI surface while using Axios under the hood.

Request shape

• JSON request bodies go in body.
• Path parameters go in params.path.
• Query parameters go in params.query.

const initialized = await paystack.transaction_initialize({
  body: {
    email: "[e-mail]",
    amount: 5000,
  },
});

const verified = await paystack.transaction_verify({
  params: { path: { reference: "ref_123" } },
});

const banks = await paystack.bank_list({
  params: { query: { country: "nigeria", perPage: 100 } },
});

Operation naming

Use generated helpers such as transaction_initialize, customer_create, paymentRequest_create, transferrecipient_create, and refund_create. Do not infer nested resource names that are not exported by the SDK.

Pagination

Keep pagination in params.query. Inspect the returned envelope meta and response headers when building a pager.

Best practices

• Keep mutation references unique in your application.
• Use typed request bodies instead of manually building JSON strings.
• Treat status: false in the Paystack envelope as a failed operation.