{"openapi":"3.1.0","info":{"title":"GET /api/v1/credit/lines/{credit_line_id}/payoff-quote","version":"1.0.0","description":"Quote the payoff amount"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/credit/lines/{credit_line_id}/payoff-quote":{"get":{"tags":["credit"],"summary":"Quote the payoff amount","description":"What it takes to pay off as at a date: unpaid principal, the unpaid disbursement fee, and interest accrued to that date (plus, on a future date, the interest projected to it), less any early-payoff rebate and plus any prepayment penalty on a cycle draw. Request this rather than reusing the displayed balance: principal, fee and accrued interest settle separately, so the balance alone is not the payoff amount. On a per-transaction line a past date the line's book has already been processed beyond (a later accrual run or payment) is refused with `CREDIT_730`; today and later dates are always quoted.","operationId":"get_payoff_quote","parameters":[{"name":"credit_line_id","in":"path","required":true,"schema":{"type":"string","title":"Credit Line Id"}},{"name":"as_of","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"Quote date. Defaults to today.","title":"As Of"},"description":"Quote date. Defaults to today."},{"name":"loan_ids","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Comma-separated loan ids to quote. Omit for every open loan.","title":"Loan Ids"},"description":"Comma-separated loan ids to quote. Omit for every open loan."},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-business-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Business-Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_PayoffQuoteResponse_"}}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"example":{"error":"validation_error","message":"Validation failed: due_date: Input should be a valid date","errors":{"due_date":"Input should be a valid date"},"code":"GEN_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized - Missing or expired token, an MCP OAuth token used against the REST API, or no access to this business","content":{"application/json":{"example":{"error":"unauthorized","message":"Authentication required","code":"AUTH_001","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"example":{"error":"forbidden","message":"You don't have permission to access this resource","code":"AUTH_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found - Resource does not exist","content":{"application/json":{"example":{"error":"not_found","message":"Resource not found","code":"NOT_FOUND_001","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"validation_error","message":"Validation failed: amount: Input should be a valid integer","errors":{"amount":"Input should be a valid integer"},"code":"GEN_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"}}}}},"x-fastapi-operation-id":"get_payoff_quote_api_v1_credit_lines__credit_line_id__payoff_quote_get"}}},"components":{"schemas":{"DisclosureFigures":{"properties":{"method":{"type":"string","title":"Method"},"lending_model":{"type":"string","title":"Lending Model"},"transaction_date":{"type":"string","format":"date","title":"Transaction Date"},"due_date":{"type":"string","format":"date","title":"Due Date"},"term_days":{"type":"integer","title":"Term Days"},"amount_financed_cents":{"type":"integer","title":"Amount Financed Cents"},"disbursement_fee_cents":{"type":"integer","title":"Disbursement Fee Cents"},"interest_in_term_cents":{"type":"integer","title":"Interest In Term Cents","description":"Interest owed if repaid exactly on the due date."},"finance_charge_cents":{"type":"integer","title":"Finance Charge Cents","description":"Disbursement fee + interest within the term."},"total_of_payments_cents":{"type":"integer","title":"Total Of Payments Cents"},"apr_bps":{"type":"integer","title":"Apr Bps","description":"Annual percentage rate to the nearest basis point."},"apr_percent":{"type":"string","title":"Apr Percent","description":"The APR as a percent to two places, e.g. \"12.17\"."},"contract_rate_bps":{"type":"integer","title":"Contract Rate Bps"},"disbursement_fee_bps":{"type":"integer","title":"Disbursement Fee Bps"},"day_count":{"type":"string","title":"Day Count"},"days_in_year":{"type":"integer","title":"Days In Year"},"interest_accrual_start":{"type":"string","title":"Interest Accrual Start"},"payment_schedule":{"items":{"$ref":"#/components/schemas/DisclosurePayment"},"type":"array","title":"Payment Schedule"},"prepayment":{"$ref":"#/components/schemas/DisclosurePrepaymentTerms"},"counsel_note":{"type":"string","title":"Counsel Note"}},"type":"object","required":["method","lending_model","transaction_date","due_date","term_days","amount_financed_cents","disbursement_fee_cents","interest_in_term_cents","finance_charge_cents","total_of_payments_cents","apr_bps","apr_percent","contract_rate_bps","disbursement_fee_bps","day_count","days_in_year","interest_accrual_start","prepayment","counsel_note"],"title":"DisclosureFigures","description":"Cost-of-credit figures for a single-payment loan, to the method named."},"DisclosurePayment":{"properties":{"number":{"type":"integer","title":"Number"},"due_date":{"type":"string","format":"date","title":"Due Date"},"amount_cents":{"type":"integer","title":"Amount Cents"}},"type":"object","required":["number","due_date","amount_cents"],"title":"DisclosurePayment","description":"One scheduled payment."},"DisclosurePrepaymentTerms":{"properties":{"decided":{"type":"boolean","title":"Decided"},"prepayment_penalty_bps":{"type":"integer","title":"Prepayment Penalty Bps"},"fee_rebate":{"type":"string","title":"Fee Rebate"},"interest_rebate":{"type":"string","title":"Interest Rebate"},"summary":{"type":"string","title":"Summary"}},"type":"object","required":["decided","prepayment_penalty_bps","fee_rebate","interest_rebate","summary"],"title":"DisclosurePrepaymentTerms","description":"What paying before the due date does to the cost."},"LoanPayoffLineResponse":{"properties":{"loan_id":{"type":"string","title":"Loan Id"},"principal_cents":{"type":"integer","title":"Principal Cents"},"fee_cents":{"type":"integer","title":"Fee Cents"},"interest_cents":{"type":"integer","title":"Interest Cents","description":"Accrued and posted to date."},"projected_interest_cents":{"type":"integer","title":"Projected Interest Cents","description":"Accrual between the last processing date and as_of.","default":0},"total_cents":{"type":"integer","title":"Total Cents"}},"type":"object","required":["loan_id","principal_cents","fee_cents","interest_cents","total_cents"],"title":"LoanPayoffLineResponse","description":"What one loan needs to close as at the quoted date."},"PayoffQuoteResponse":{"properties":{"credit_line_id":{"type":"string","title":"Credit Line Id"},"as_of":{"type":"string","format":"date","title":"As Of"},"principal_cents":{"type":"integer","title":"Principal Cents"},"fee_cents":{"type":"integer","title":"Fee Cents"},"interest_cents":{"type":"integer","title":"Interest Cents","description":"Accrued to date plus accrual projected to as_of."},"interest_rebate_cents":{"type":"integer","title":"Interest Rebate Cents","default":0},"fee_rebate_cents":{"type":"integer","title":"Fee Rebate Cents","default":0},"prepayment_penalty_cents":{"type":"integer","title":"Prepayment Penalty Cents","default":0},"total_cents":{"type":"integer","title":"Total Cents"},"cycle_ids":{"items":{"type":"string"},"type":"array","title":"Cycle Ids"},"loan_ids":{"items":{"type":"string"},"type":"array","title":"Loan Ids"},"loans":{"items":{"$ref":"#/components/schemas/LoanPayoffLineResponse"},"type":"array","title":"Loans"},"quote_expires_on":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Quote Expires On","description":"Last date this figure holds, from the program's `quote_valid_days`. Beyond it, re-quote."},"disclosure":{"anyOf":[{"$ref":"#/components/schemas/DisclosureFigures"},{"type":"null"}],"description":"Cost-of-credit figures for the line's terms applied to the quoted principal as one single-payment loan made on as_of: APR, finance charge, total of payments, schedule and prepayment terms. Null when nothing is outstanding. Whether a disclosure is required is for the lender's counsel."}},"type":"object","required":["credit_line_id","as_of","principal_cents","fee_cents","interest_cents","total_cents"],"title":"PayoffQuoteResponse","description":"The payoff amount as at a date (§14, call 7).\n\n``total_cents`` is unpaid principal plus the unpaid disbursement fee\nplus interest accrued and projected to ``as_of``, less any early-payoff\nrebate and plus any prepayment penalty (cycle draws). The partner must\nrequest this rather than using the displayed balance: principal, fee\nand accrued interest settle separately, so the balance alone is not the\npayoff amount (§10.6)."},"SuccessEnvelope_PayoffQuoteResponse_":{"properties":{"success":{"type":"boolean","title":"Success","default":true},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"data":{"anyOf":[{"$ref":"#/components/schemas/PayoffQuoteResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[PayoffQuoteResponse]"},"ErrorResponse":{"title":"ErrorResponse","type":"object","description":"Envelope returned by every non-2xx response. Branch on `code` (stable) rather than `message` (human-readable, may change).","required":["error","message","code"],"properties":{"error":{"type":"string","description":"Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`."},"message":{"type":"string","description":"Human-readable explanation, safe to show to end users."},"code":{"type":"string","description":"Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`)."},"request_id":{"type":"string","description":"Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied."},"errors":{"type":"object","additionalProperties":{"type":"string"},"description":"Field-level validation messages keyed by field name. Present on 400/422 validation failures only."}}}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Token","description":"API token authentication. Format: `Bearer dz_...`"}}},"security":[{"BearerAuth":[]}]}