Dry-run or attach a staged payments or statements history file

POST/api/v1/credit/programs/{program_id}/history/import

Attaches a staged history file across the program's lines, in the request, under one savepoint: with dry_run (the default), or a control total that does not match, nothing is attached. A payment is attached with the split the previous system gave it, or a split derived oldest loan first and interest, fee, principal within a loan, against what each loan carried as paid at import, recorded on the row; it must be dated before the line's cut-over and never splits more onto a loan than the loan carried as paid. A statement is attached as issued, outside every DayZero statement period. Nothing moves a balance, posts a journal or appends an event. Idempotent on the partner's payment or statement id. Open to any token on a sandbox business; on a live business an operator action (an API token receives 403).

Operation ID: credit_history_run·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.

Parameters

Path

program_idstringrequired: The program.

Request body

Schema: HistoryImportRequest

staging_idstringrequired: The batch from the parse step.
dry_runboolean: Check every row and report, then write nothing. On by default.
expected_countinteger: Payments or statements the file holds (a split payment counts once). A different count attaches nothing.
expected_amount_centsinteger: Payments: their amounts summed. Statements: their statement balances summed. A different total attaches nothing.
dry_run_tokenstring: On an apply: the dry_run_token of the dry run you checked. The apply then runs only with exactly that dry run's control totals, mapping and (statements) documents; otherwise 400 CREDIT_690.

Responses

201Successful Response

Schema: SuccessEnvelope_HistoryImportResponse_

successboolean
messagestring
codestring
dataHistoryImportResponse

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/programs/{program_id}/history/import

bash

curl -X POST 'https://api.ondayzero.com/api/v1/credit/programs/{program_id}/history/import' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "staging_id": "string"
}'