| name | paystack-browser-api-operations |
| description | Use when calling browser-safe Paystack API operations with @alexasomba/paystack-browser, including typed requests, path params, query params, transactions, and pagination. |
| license | MIT |
| compatibility | Modern browsers and bundlers; package tooling/SSR builds require Node.js >=22.0.0; ESM package; public-key frontend runtime only. |
Paystack Browser API Operations
The browser SDK exposes generated grouped helpers, but not every Paystack operation is appropriate for frontend use. Never call secret-key-only operations from the browser.
Request shape
const result = await paystack.transaction_initialize({
body: {
email: "customer@example.com",
amount: 5000,
},
});
- JSON request bodies go in
body.
- Path parameters go in
params.path.
- Query parameters go in
params.query.
const verified = await paystack.transaction_verify({
params: { path: { reference: "ref_123" } },
});
Pagination
Use params.query for page, perPage, next, and previous where supported.
const pages = await paystack.page_list({
params: { query: { perPage: 20 } },
});
Best practices
- Do not put secret-key-only workflows in frontend code.
- Verify payments server-side before delivering value.
- Treat
status: false in the response envelope as a failed operation.
- Avoid logging payment metadata in browser consoles.