Sandbox scenarios API
Environment: Sandbox
Read the sandbox test catalogue as JSON.
# Sandbox scenarios API
Read the sandbox test catalogue as JSON: the test numbers (last three digits), the magic amounts, the request status values and the outcome each produces. Public and read-only: no keys needed. A test suite can read this instead of hard-coding the numbers.
## Endpoint
- **Method**: POST
- **URL**: https://sandbox.moolre.com/open/sandbox/scenarios
## Headers
| Header | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| X-API-USER | string | No | Optional. Your Moolre username. |
## Response (200 Success)
The catalogue: environment, outcomes (test numbers, magic amounts and statuses), the trigger and reset endpoints, webhook signing, and limits.
```json
{
"status": 1,
"code": "SBX01",
"message": "Sandbox scenarios",
"data": {
"environment": "sandbox",
"outcomes": "...",
"trigger": {
"endpoint": "POST /open/sandbox/trigger"
},
"reset": {
"endpoint": "POST /open/sandbox/reset"
},
"limits": {
"otp": "At most 3 OTP SMS per phone per 10 minutes"
}
},
"go": null,
"meta": {
"requestid": "req_c68f4c66115c26725c796242",
"notices": []
}
}
```
## Fields every response can carry
These fields are additive: existing fields keep their names, order and types.
| Field | Meaning |
| :--- | :--- |
| error | On a failure: { code, message, fields: [{ field, code, message }] } listing every failing field. |
| meta | Always present, last in the object. meta.replayed is true only when the response is the stored answer to a repeated Idempotency-Key (absent otherwise). meta.requestid is the unique id of the request (also the X-Request-Id response header): quote it when you contact support. meta.notices is always an array, empty when there is nothing to report; each notice is { code, message, docs? }, for example that a deprecated way of sending credentials was used. See [Deprecations](https://docs.moolre.com/guides/deprecations). |
There is no outcome field. Decide the result from status, code and, on payment and transfer endpoints, data.txstatus (0 pending, 1 succeeded, 2 failed). These codes mean the result is unknown and may still succeed, so treat them as pending and check the status: PY01, PY02, TR01, TR02, TP11, TP18, APY10, APY16, ASL06, SYS500. Status 1 with TR08, OBGH01, OTGH01, OBNG01, GHQ03 or OM03 is final success; any other status 1 is an accepted, unfinished request.
Send X-Moolre-Http-Status: strict to receive real HTTP status codes (400, 401, 403, 404, 409, 422, 429, 5xx) instead of HTTP 200. See [Responses and request IDs](https://docs.moolre.com/guides/responses).