Get Started

Client API Sandbox

Test full invoice lifecycle without real external gateway actions.

Sandbox Mode

Safe Testing for Invoice Flows

Use sandbox mode to simulate statuses and verify your integration before production.

Sandbox Behavior

  • Available only when account mode is sandbox.
  • Invoice code starts with SBOX-.
  • Payment links are internal fake links.
  • No real external payment gateway should be triggered.

Simulate Invoice Status

Endpoint:

POST /api/client/sandbox/invoices/{reference}/simulate

Body:

{
  "status": "paid"
}

Allowed status values: pending, paid, failed.

Common Authenticated Endpoints in Sandbox

POST /api/client/invoices

GET /api/client/invoices/{reference}/status

POST /api/client/invoices/{reference}/refund (invoice must be paid)

POST /api/client/invoices/{reference}/cancel (invoice must be paid)

POST /api/client/invoices/{reference}/refresh

Recommended Test Scenario

  • Create invoice in sandbox.
  • Call simulate endpoint with paid.
  • Fetch status and validate your app logic.
  • Run refund/cancel branches to verify business handling.