API reference
Test mode
Drive the sandbox lifecycle deterministically.
get
/api/v1/testmodeInspect the sandbox state for this key
Responses
- 200Current simulated state.object
- 400Invalid request.CodeError
- 401Missing, empty, or invalid API key. No machine-readable code is returned.BareError
- 403Forbidden: a missing capability, unapproved KYB, a source IP outside your allowlist, or a frozen wallet.CodeError
- 429Rate limited. Respect
Retry-Afterand back off exponentially.CodeError - 503A rail or dependency is unavailable. Nothing moved; retry with backoff.CodeError
Request
curl "https://www.ntzs.co.tz/api/v1/testmode" \
-H "Authorization: Bearer $NTZS_API_KEY"post
/api/v1/testmode/advanceSettle every pending simulated transaction now
The reason the sandbox is worth building against: no waiting on a rail. Write code, run it, advance, observe the webhook, correct. Test keys only: a live key gets test_mode_only.
Responses
- 200Everything pending was settled.object
- 400Invalid request.CodeError
- 401Missing, empty, or invalid API key. No machine-readable code is returned.BareError
- 403Forbidden: a missing capability, unapproved KYB, a source IP outside your allowlist, or a frozen wallet.CodeError
- 429Rate limited. Respect
Retry-Afterand back off exponentially.CodeError - 503A rail or dependency is unavailable. Nothing moved; retry with backoff.CodeError
Request
curl -X POST "https://www.ntzs.co.tz/api/v1/testmode/advance" \
-H "Authorization: Bearer $NTZS_API_KEY"post
/api/v1/testmode/resetWipe every simulated user and transaction on this key
Responses
- 200Sandbox reset.object
- 400Invalid request.CodeError
- 401Missing, empty, or invalid API key. No machine-readable code is returned.BareError
- 403Forbidden: a missing capability, unapproved KYB, a source IP outside your allowlist, or a frozen wallet.CodeError
- 429Rate limited. Respect
Retry-Afterand back off exponentially.CodeError - 503A rail or dependency is unavailable. Nothing moved; retry with backoff.CodeError
Request
curl -X POST "https://www.ntzs.co.tz/api/v1/testmode/reset" \
-H "Authorization: Bearer $NTZS_API_KEY"post
/api/v1/testmode/users/{id}/approveClear a simulated manual KYC review
Use a NIDA ending 0000 to force a review, then clear it here to exercise the pending-review branch.
Parameters
idstring (uuid)pathrequired
Responses
- 200Review cleared.object
- 400Invalid request.CodeError
- 401Missing, empty, or invalid API key. No machine-readable code is returned.BareError
- 403Forbidden: a missing capability, unapproved KYB, a source IP outside your allowlist, or a frozen wallet.CodeError
- 404No such simulated user on this key.CodeError
- 429Rate limited. Respect
Retry-Afterand back off exponentially.CodeError - 503A rail or dependency is unavailable. Nothing moved; retry with backoff.CodeError
Request
curl -X POST "https://www.ntzs.co.tz/api/v1/testmode/users/14e17d04-ec7f-4d99-91a3-dfbaca19fba1/approve" \
-H "Authorization: Bearer $NTZS_API_KEY"