{"openapi":"3.1.0","info":{"title":"GET /api/v1/credit/lines/{credit_line_id}/loans","version":"1.0.0","description":"List loans on a line"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/credit/lines/{credit_line_id}/loans":{"get":{"tags":["credit"],"summary":"List loans on a line","description":"One row per card transaction, oldest first, with the platform cursor envelope. Filter by status and by a date range on transaction date or due date. Status is authoritative: a client must not compute it from dates or balances.","operationId":"list_loans","parameters":[{"name":"credit_line_id","in":"path","required":true,"schema":{"type":"string","title":"Credit Line Id"}},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Comma-separated loan states.","title":"Status"},"description":"Comma-separated loan states."},{"name":"start","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Start"}},{"name":"end","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"End"}},{"name":"date_basis","in":"query","required":false,"schema":{"enum":["transaction","due"],"type":"string","default":"transaction","title":"Date Basis"}},{"name":"cycle_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Loans originated in this period.","title":"Cycle Id"},"description":"Loans originated in this period."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"default":100,"title":"Limit"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"include_total_count","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Include Total Count"}},{"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_CreditLoanListResponse_"}}}},"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/invalid token 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":"list_loans_api_v1_credit_lines__credit_line_id__loans_get"}}},"components":{"schemas":{"CreditLoanListResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/CreditLoanResponse"},"type":"array","title":"Items"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"},"has_next":{"type":"boolean","title":"Has Next","default":false},"limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Limit"},"total":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total"}},"type":"object","title":"CreditLoanListResponse","description":"A page of loans with the platform cursor envelope."},"CreditLoanResponse":{"properties":{"id":{"type":"string","title":"Id"},"credit_line_id":{"type":"string","title":"Credit Line Id"},"cycle_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cycle Id"},"settlement_id":{"type":"string","title":"Settlement Id"},"external_settlement_id":{"type":"string","title":"External Settlement Id"},"status":{"$ref":"#/components/schemas/LoanStatusEnum"},"transaction_date":{"type":"string","format":"date","title":"Transaction Date","description":"Issuer posting date. The term runs from here (D-12)."},"merchant_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Merchant Name"},"card_last_four":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Card Last Four"},"term_days":{"type":"integer","title":"Term Days"},"due_date":{"type":"string","format":"date","title":"Due Date"},"rate_bps":{"type":"integer","title":"Rate Bps"},"principal_cents":{"type":"integer","title":"Principal Cents","description":"Principal advanced: the settled amount."},"disbursement_fee_cents":{"type":"integer","title":"Disbursement Fee Cents"},"principal_paid_cents":{"type":"integer","title":"Principal Paid Cents"},"fee_paid_cents":{"type":"integer","title":"Fee Paid Cents"},"interest_paid_cents":{"type":"integer","title":"Interest Paid Cents"},"credit_applied_cents":{"type":"integer","title":"Credit Applied Cents"},"interest_accrued_cents":{"type":"integer","title":"Interest Accrued Cents","description":"Accrued to date. Zero until the loan passes its due date (D-07)."},"principal_outstanding_cents":{"type":"integer","title":"Principal Outstanding Cents"},"fee_outstanding_cents":{"type":"integer","title":"Fee Outstanding Cents"},"interest_outstanding_cents":{"type":"integer","title":"Interest Outstanding Cents"},"outstanding_cents":{"type":"integer","title":"Outstanding Cents","description":"Unpaid principal + unpaid fee + accrued interest."},"last_accrued_on":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Last Accrued On"},"past_due_since":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Past Due Since"},"paid_on":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Paid On"},"written_off_on":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Written Off On"},"written_off_cents":{"type":"integer","title":"Written Off Cents","default":0}},"type":"object","required":["id","credit_line_id","settlement_id","external_settlement_id","status","transaction_date","term_days","due_date","rate_bps","principal_cents","disbursement_fee_cents","principal_paid_cents","fee_paid_cents","interest_paid_cents","credit_applied_cents","interest_accrued_cents","principal_outstanding_cents","fee_outstanding_cents","interest_outstanding_cents","outstanding_cents"],"title":"CreditLoanResponse","description":"One row of the Transactions tab: one card transaction, one loan.\n\nEvery figure is served, never derived. ``status`` is authoritative —\na client must not compute it from dates or balances (§10.5)."},"LoanStatusEnum":{"type":"string","enum":["active","past_due","paid","written_off"],"title":"LoanStatusEnum","description":"Per-transaction loan state (FRD v2 §10.5 status vocabulary).\n\nThe API status is authoritative; a client must not compute it from\ndates or balances."},"SuccessEnvelope_CreditLoanListResponse_":{"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/CreditLoanListResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[CreditLoanListResponse]"},"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":[]}]}