Get started

Test & live

Use the test secret while you build. Test mode never calls PalmPay or Paystack and never puts money in a withdrawable balance.

How mode is chosen

API: the secret key itself selects the mode.
Dashboard: the Test / Live switch sends X-NeratPay-Mode: test with the browser session. A live API key ignores that header.

Simulate a deposit

Amount is in naira. This fires the same webhooks a live deposit would, with livemode: false.

POST /virtual-accounts/:id/simulate-payment

curl https://api.nerat.app/api/virtual-accounts/ACCOUNT_ID/simulate-payment \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{"amount":2500}'

Never credit a real user for an event with livemode false. Payouts are rejected in test mode.