{"openapi":"3.1.0","info":{"title":"POST /api/v1/credit/loans/{loan_id}/dispute","version":"1.0.0","description":"Open a dispute on a loan"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/credit/loans/{loan_id}/dispute":{"post":{"tags":["credit"],"summary":"Open a dispute on a loan","description":"Puts the loan on hold while the merchant's dispute of the card transaction runs: no interest accrues for hold days, the loan is out of days past due, AutoPay and the amount due, and its balance is shown flagged. Omit `amount_cents` to dispute the whole transaction. Idempotent on `provider_dispute_id`, otherwise on the loan's open dispute.","operationId":"open_credit_dispute","parameters":[{"name":"loan_id","in":"path","required":true,"schema":{"type":"string","title":"Loan Id"}},{"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"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditDisputeOpenRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_CreditDisputeResponse_"}}}},"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":"open_credit_dispute_api_v1_credit_loans__loan_id__dispute_post"}}},"components":{"schemas":{"CreditDisputeOpenRequest":{"properties":{"amount_cents":{"anyOf":[{"type":"integer","exclusiveMinimum":0.0},{"type":"null"}],"title":"Amount Cents","description":"Principal in dispute. Omit to dispute the whole transaction (its principal less anything an earlier dispute already reversed)."},"reason":{"type":"string","maxLength":2000,"minLength":1,"title":"Reason","description":"Why the merchant disputes the charge, in words."},"provider_dispute_id":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Provider Dispute Id","description":"The issuer's id for the dispute. When sent it is the idempotency key: opening it again returns the dispute already recorded."},"opened_on":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Opened On","description":"First day of the hold. Defaults to today (UTC). It may be earlier than today, but not before the loan's transaction date or on or before the date of a payment already applied to the loan."}},"additionalProperties":false,"type":"object","required":["reason"],"title":"CreditDisputeOpenRequest","description":"Open a dispute against one loan and put it on hold."},"CreditDisputeResponse":{"properties":{"id":{"type":"string","title":"Id"},"credit_line_id":{"type":"string","title":"Credit Line Id"},"loan_id":{"type":"string","title":"Loan Id"},"settlement_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Settlement Id"},"external_settlement_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Settlement Id","description":"The issuer transaction the loan came from."},"merchant_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Merchant Name"},"kind":{"type":"string","enum":["dispute","void"],"title":"Kind"},"status":{"type":"string","enum":["open","resolved"],"title":"Status"},"provider":{"type":"string","title":"Provider"},"provider_dispute_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Provider Dispute Id"},"provider_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Provider Status","description":"The issuer's latest word on the dispute, as it reported it."},"amount_cents":{"type":"integer","title":"Amount Cents","description":"Principal in dispute."},"opened_on":{"type":"string","format":"date","title":"Opened On","description":"First hold day."},"reported_opened_on":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Reported Opened On","description":"The date the issuer reported the dispute opened, when that is before the loan was imported; the hold (opened_on) then counts from the import date. Null otherwise."},"resolved_on":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Resolved On","description":"First day accrual runs again. Null while open."},"hold_days":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Hold Days","description":"Days the loan was on hold for this dispute. Null while open."},"outcome":{"anyOf":[{"type":"string","enum":["merchant_won","lender_won","voided","released"]},{"type":"null"}],"title":"Outcome"},"reason":{"type":"string","title":"Reason"},"source":{"type":"string","enum":["webhook","reconciliation","operator","partner"],"title":"Source"},"resolution_source":{"anyOf":[{"type":"string","enum":["webhook","reconciliation","operator","partner"]},{"type":"null"}],"title":"Resolution Source"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"},"principal_reversed_cents":{"type":"integer","title":"Principal Reversed Cents","description":"Principal the resolution reversed.","default":0},"fee_reversed_cents":{"type":"integer","title":"Fee Reversed Cents","description":"Disbursement fee the resolution reversed.","default":0},"interest_reversed_cents":{"type":"integer","title":"Interest Reversed Cents","description":"Accrued interest the resolution reversed.","default":0},"credited_cents":{"type":"integer","title":"Credited Cents","description":"Part of the reversal the merchant had already paid, carried forward as credit balance.","default":0},"loan_status":{"type":"string","title":"Loan Status","description":"The loan's status after this call."},"loan_hold_status":{"type":"string","enum":["none","disputed","voided"],"title":"Loan Hold Status","description":"Whether the loan is on hold after this call."},"loan_outstanding_cents":{"type":"integer","title":"Loan Outstanding Cents","description":"What the loan owes after this call."}},"type":"object","required":["id","credit_line_id","loan_id","kind","status","provider","amount_cents","opened_on","reason","source","loan_status","loan_hold_status","loan_outstanding_cents"],"title":"CreditDisputeResponse","description":"One dispute or void, with the loan's state after the call."},"SuccessEnvelope_CreditDisputeResponse_":{"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/CreditDisputeResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[CreditDisputeResponse]"},"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":[]}]}