{"openapi":"3.1.0","info":{"title":"GET /api/v1/credit/compliance/held-increases","version":"1.0.0","description":"List held limit increases"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/credit/compliance/held-increases":{"get":{"tags":["credit"],"summary":"List held limit increases","description":"Every limit increase held until the merchant acknowledges its disclosure, oldest first: the line, the limit in force, the held limit, and `blocked_reason` when it can no longer be applied (the program's limit envelope narrowed past it, or the line is suspended or closed).","operationId":"credit_list_held_increases","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"description":"Held increases per page (1-500).","default":50,"title":"Limit"},"description":"Held increases per page (1-500)."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`next_cursor` from the last page.","title":"Cursor"},"description":"`next_cursor` from the last page."},{"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_HeldIncreasePage_"}}}},"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"}}}},"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":"credit_list_held_increases_api_v1_credit_compliance_held_increases_get"}}},"components":{"schemas":{"HeldIncreasePage":{"properties":{"items":{"items":{"$ref":"#/components/schemas/HeldIncreaseResponse"},"type":"array","title":"Items","description":"The held increases."},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor","description":"Pass back as `cursor`. Null on the last page."},"has_next":{"type":"boolean","title":"Has Next","description":"More pages follow.","default":false},"limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Limit","description":"The page size."}},"type":"object","title":"HeldIncreasePage","description":"Held increases, oldest first."},"HeldIncreaseResponse":{"properties":{"disclosure_id":{"type":"string","title":"Disclosure Id","description":"The `limit_change` disclosure holding it."},"credit_line_id":{"type":"string","title":"Credit Line Id","description":"The line."},"external_line_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Line Id","description":"Your id for the line."},"line_status":{"type":"string","title":"Line Status","description":"The line's status now."},"credit_limit_cents":{"type":"integer","title":"Credit Limit Cents","description":"The limit in force now."},"held_limit_cents":{"type":"integer","title":"Held Limit Cents","description":"The limit that applies once the merchant acknowledges."},"issued_at":{"type":"string","format":"date-time","title":"Issued At","description":"When the disclosure was issued."},"delivered_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Delivered At","description":"When the merchant first opened it on the portal."},"blocked_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Blocked Reason","description":"Why the increase cannot be applied now: the program's limit envelope narrowed past it, or the line is suspended or closed. Null when acknowledging would apply it. Withdraw it, or fix the cause and let the merchant acknowledge."}},"type":"object","required":["disclosure_id","credit_line_id","line_status","credit_limit_cents","held_limit_cents","issued_at"],"title":"HeldIncreaseResponse","description":"A limit increase held until the merchant acknowledges its disclosure."},"SuccessEnvelope_HeldIncreasePage_":{"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/HeldIncreasePage"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[HeldIncreasePage]"},"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":[]}]}