{"openapi":"3.1.0","info":{"title":"POST /api/v1/credit/lines/{credit_line_id}/portal-sessions","version":"1.0.0","description":"Mint a borrower-portal link"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/credit/lines/{credit_line_id}/portal-sessions":{"post":{"tags":["credit"],"summary":"Mint a borrower-portal link","description":"Returns a URL to the hosted, lender-branded borrower portal for this line. The URL holds a secret token and is returned once. The link works for `ttl_hours` (1 to 720) or until revoked. Without `scopes`, a link minted while the line has a disclosure awaiting acknowledgement also carries `acknowledge`. A `credit:read` token may mint links with the read scopes only.","operationId":"create_borrower_portal_session","parameters":[{"name":"credit_line_id","in":"path","required":true,"schema":{"type":"string","title":"Credit Line 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/PortalSessionCreateRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_PortalSessionCreateResponse_"}}}},"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":"create_borrower_portal_session_api_v1_credit_lines__credit_line_id__portal_sessions_post"}}},"components":{"schemas":{"PortalSessionCreateRequest":{"properties":{"ttl_hours":{"type":"integer","maximum":720.0,"minimum":1.0,"title":"Ttl Hours","description":"How long the link works, in hours: 1 to 720 (30 days).","default":72},"scopes":{"anyOf":[{"items":{"type":"string","enum":["statements","payoff","schedule","autopay","cards","acknowledge"]},"type":"array"},{"type":"null"}],"title":"Scopes","description":"What the link may show or do. `schedule`, `statements` and `payoff` are read; `autopay` lets the merchant switch AutoPay, `cards` lets them freeze and unfreeze their cards, and `acknowledge` lets them acknowledge a disclosure (compliance programs). Omit for `schedule`, `statements`, `payoff`, `autopay` and `cards`, plus `acknowledge` while the line has a disclosure awaiting acknowledgement. A read-only token's default is the three read scopes, and it cannot grant `autopay`, `cards` or `acknowledge`."}},"additionalProperties":false,"type":"object","title":"PortalSessionCreateRequest","description":"POST /credit/lines/{id}/portal-sessions."},"PortalSessionCreateResponse":{"properties":{"session_id":{"type":"string","title":"Session Id"},"credit_line_id":{"type":"string","title":"Credit Line Id"},"url":{"type":"string","title":"Url","description":"The borrower's link. Shown once; store or send it now."},"expires_at":{"type":"string","format":"date-time","title":"Expires At"},"scopes":{"items":{"type":"string","enum":["statements","payoff","schedule","autopay","cards","acknowledge"]},"type":"array","title":"Scopes"}},"type":"object","required":["session_id","credit_line_id","url","expires_at","scopes"],"title":"PortalSessionCreateResponse","description":"The new link. ``url`` holds the secret and is never shown again."},"SuccessEnvelope_PortalSessionCreateResponse_":{"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/PortalSessionCreateResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[PortalSessionCreateResponse]"},"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":[]}]}