{"openapi":"3.1.0","info":{"title":"GET /api/v1/credit/environment","version":"1.0.0","description":"Which book am I on?"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/credit/environment":{"get":{"tags":["credit"],"summary":"Which book am I on?","description":"The business the call resolved to, whether it is a sandbox, and for each program whether its cards come from the mock issuer or the live one. Assert on this before a test run.","operationId":"get_environment","parameters":[{"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_CreditEnvironmentResponse_"}}}},"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":"get_environment_api_v1_credit_environment_get"}}},"components":{"schemas":{"CreditEnvironmentResponse":{"properties":{"business_id":{"type":"string","title":"Business Id"},"sandbox":{"type":"boolean","title":"Sandbox","description":"True when this business is a sandbox (`is_demo`)."},"sandbox_business_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sandbox Business Id","description":"On a live business with a paired sandbox (see `POST /credit/sandbox/provision`), the sandbox's business id."},"live_business_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Live Business Id","description":"On a provisioned sandbox, the live business it rehearses. Null on a sandbox staff marked by hand."},"programs":{"items":{"$ref":"#/components/schemas/EnvironmentProgram"},"type":"array","title":"Programs"}},"type":"object","required":["business_id","sandbox"],"title":"CreditEnvironmentResponse"},"EnvironmentProgram":{"properties":{"id":{"type":"string","title":"Id"},"display_name":{"type":"string","title":"Display Name"},"issuing_enabled":{"type":"boolean","title":"Issuing Enabled"},"issuing_provider":{"type":"string","title":"Issuing Provider"},"issuing_provider_mode":{"type":"string","enum":["mock","live"],"title":"Issuing Provider Mode","description":"`mock` when the program's cards come from DayZero's in-memory test issuer (no money moves, nothing reaches Ramp); `live` when they come from the real issuer."}},"type":"object","required":["id","display_name","issuing_enabled","issuing_provider","issuing_provider_mode"],"title":"EnvironmentProgram"},"SuccessEnvelope_CreditEnvironmentResponse_":{"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/CreditEnvironmentResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[CreditEnvironmentResponse]"},"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":[]}]}