Schedule a pilot

Run the daily credit sweep

POST/api/v1/credit/sweeps/daily

DayZero internal; the nightly schedule runs this per business. Runs every step of the nightly sweep in order (the steps are listed under What runs on DayZero's schedule in the guide, and each run's steps names them). Each step that fails is recorded and the rest still run (status: partial); the run is logged under GET /credit/sweeps/runs/{run_id}. Open to any token on a sandbox business; on a live business an operator action (an API token receives 403).

Operation ID: run_daily_sweep·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: DailySweepRequest

as_ofstring · date
accrueboolean
close_periodsboolean
push_spend_limitsboolean
sync_cardsboolean
reconcile_settlementsboolean
recognize_feesboolean
recognize_interchangeboolean
snapshot_bank_balancesboolean
email_statementsboolean
send_noticesboolean

Email the borrower notices each program has switched on, for the credit events since the last run.

run_assessmentsboolean
alert_adverse_actionsboolean

List pending adverse-action notices and alert on those due within five days or overdue. Nothing is sent.

review_limitsboolean

Review the limit of every line whose program has an enabled limit_review_policy and that has not been reviewed in the current cadence window.

verify_ledgersboolean
evaluate_readinessboolean

Evaluate every active program's launch readiness, store the result, and alert when a check that passed in the previous stored result fails now. Skipped on a sandbox.

run_collectionsboolean

Evaluate the program's delinquency ladder and apply the stage a line has reached (D-31). Actions are reversible; write-off stays an operator decision.

match_bank_settlementsboolean

Settle pending payments, and reverse returned ones, from the bank feed of the last 16 days, on programs with bank_settlement_matching on.

Responses

201Successful Response

Schema: SuccessEnvelope_DailySweepResponse_

successboolean
messagestring
codestring
dataDailySweepResponse

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.

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.