Quickstart

This walkthrough gets you from install to a successful payment in under 15 minutes.

1) Install

npm install @miniduck/stash

2) Create a payment

Choose a provider and use the unified createStash API.

• Ozow example: examples/make-payment-ozow.ts
• Payfast example: examples/make-payment-payfast.ts
• Paystack example: examples/make-payment-paystack.ts

Test mode

Use testMode: true to target sandbox endpoints during local development. Set it to false for live production traffic.

Required environment variables

Ozow

• OZOW_SITE_CODE
• OZOW_API_KEY
• OZOW_PRIVATE_KEY

Payfast

• PAYFAST_MERCHANT_ID
• PAYFAST_MERCHANT_KEY
• PAYFAST_PASSPHRASE

Paystack

• PAYSTACK_SECRET_KEY

You can copy .env.example and fill in the values.

3) Handle webhooks

Verify the signature before you update your order.

• Ozow webhook: examples/webhook-ozow.ts
• Payfast ITN: examples/webhook-payfast.ts
• Paystack webhook: examples/webhook-paystack.ts

4) Optional checks

• Ozow transaction status: examples/ozow-status.ts

Paystack amounts must be provided in minor units.