Generate a whole sandbox book from a seed

POST/api/v1/credit/sandbox/scenarios/portfolio-50

Sandbox only. Queues a job that generates merchants merchants (default 50) over months months (default 6) from seed through the real services: lines opened, settlements and refunds ingested, statements closed and interest accrued month by month, payments recorded on time, late and in part, one returned, one dispute, one write-off, and lines at every collections stage. Poll GET /credit/sandbox/jobs/{id} until status is succeeded or failed. The same seed, size and as_of always give the same book (result.loan_tape_digest). Asking again while the seed's job is queued or running returns that job (created: false), unless it is stale (past its one-hour limit): that job is recorded failed and a new one is queued.

Operation ID: credit_stage_portfolio_scenario·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Request body

Schema: PortfolioScenarioRequest

seedinteger: The same seed (and as_of) always generates the same book.
merchantsinteger: How many merchants (lines).
monthsinteger: How many months of history.
program_idstring: A per-transaction program to stage it on. Omitted: a program named for the seed is created (or reused), with a three-stage collections ladder.
as_ofstring · date: The last day of the book. Defaults to today (UTC); the history starts months calendar months before its month.

Responses

202Successful Response

Schema: SuccessEnvelope_SandboxJobResponse_

successboolean
messagestring
codestring
dataSandboxJobResponse

400Bad Request - Invalid input

Schema: ErrorResponse

errorstringrequired: Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequired: Human-readable explanation, safe to show to end users.
codestringrequired: Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstring: Correlation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobject: Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

401Unauthorized - Missing or expired token, an MCP OAuth token used against the REST API, or no access to this business

Schema: ErrorResponse

errorstringrequired: Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequired: Human-readable explanation, safe to show to end users.
codestringrequired: Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstring: Correlation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobject: Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

403Forbidden - Insufficient permissions

Schema: ErrorResponse

errorstringrequired: Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequired: Human-readable explanation, safe to show to end users.
codestringrequired: Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstring: Correlation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobject: Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

404Not Found - Resource does not exist

Schema: ErrorResponse

errorstringrequired: Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequired: Human-readable explanation, safe to show to end users.
codestringrequired: Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstring: Correlation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobject: Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

422Validation Error

Schema: ErrorResponse

errorstringrequired: Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequired: Human-readable explanation, safe to show to end users.
codestringrequired: Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstring: Correlation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobject: Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

Code samples

POST/api/v1/credit/sandbox/scenarios/portfolio-50

bash

curl -X POST 'https://api.ondayzero.com/api/v1/credit/sandbox/scenarios/portfolio-50' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "seed": 0,
  "merchants": 0,
  "months": 0,
  "program_id": "string",
  "as_of": "2026-01-01"
}'