Quote the payoff amount

GET/api/v1/credit/lines/{credit_line_id}/payoff-quote

Principal plus accrued interest as at a date. Request this rather than reusing the displayed balance: principal and accrued interest settle separately, so the balance alone is not the payoff amount.

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

credit_line_idstringrequired

Query

as_ofstring · date: Quote date. Defaults to today.

Responses

200Successful Response

Schema: SuccessEnvelope_PayoffQuoteResponse_

successboolean
messagestring
codestring
dataPayoffQuoteResponse

400Bad Request - Invalid input

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

404Not Found - Resource does not exist

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError

5 fields

locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject

Code samples

GET/api/v1/credit/lines/{credit_line_id}/payoff-quote

bash

curl -X GET 'https://api.ondayzero.com/api/v1/credit/lines/{credit_line_id}/payoff-quote' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID'