{"openapi":"3.1.0","info":{"title":"POST /api/v1/agents/mandates","version":"1.0.0","description":"Propose a payment mandate"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/agents/mandates":{"post":{"tags":["agents"],"summary":"Propose a payment mandate","description":"Propose a mandate for an agent subject. A different owner or admin counter-signs it before it takes effect. The business's only admin may pass `self_sign=true`; the row and the audit log record that.","operationId":"agents_create_mandate","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"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentMandateCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_AgentMandateResponse_"}}}},"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":"agents_create_mandate_api_v1_agents_mandates_post"}}},"components":{"schemas":{"AgentMandateCreate":{"properties":{"subject_type":{"type":"string","enum":["agent_role","mcp_client","api_client"],"title":"Subject Type"},"subject_id":{"type":"string","maxLength":128,"minLength":1,"title":"Subject Id"},"purpose":{"type":"string","maxLength":2000,"minLength":3,"title":"Purpose"},"allowed_vendor_ids":{"anyOf":[{"items":{"type":"string"},"type":"array","maxItems":200},{"type":"null"}],"title":"Allowed Vendor Ids","description":"Vendor ids the mandate covers; null or empty = any vendor."},"per_payment_ceiling_cents":{"type":"integer","exclusiveMinimum":0.0,"title":"Per Payment Ceiling Cents"},"period_ceiling_cents":{"type":"integer","exclusiveMinimum":0.0,"title":"Period Ceiling Cents"},"period":{"type":"string","enum":["month","week"],"title":"Period","default":"month"},"valid_from":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Valid From","description":"Defaults to now (UTC)."},"valid_to":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Valid To"},"self_sign":{"type":"boolean","title":"Self Sign","description":"Counter-sign your own proposal. Allowed only when you are the business's only admin; recorded in the audit log.","default":false}},"type":"object","required":["subject_type","subject_id","purpose","per_payment_ceiling_cents","period_ceiling_cents"],"title":"AgentMandateCreate","description":"Propose a mandate. A second admin counter-signs it, or the proposer\nself-signs with ``self_sign=true`` when they are the business's only admin."},"AgentMandateResponse":{"properties":{"id":{"type":"string","title":"Id"},"business_id":{"type":"string","title":"Business Id"},"subject_type":{"type":"string","enum":["agent_role","mcp_client","api_client"],"title":"Subject Type"},"subject_id":{"type":"string","title":"Subject Id"},"subject_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subject Label"},"purpose":{"type":"string","title":"Purpose"},"allowed_vendor_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Allowed Vendor Ids"},"per_payment_ceiling_cents":{"type":"integer","title":"Per Payment Ceiling Cents"},"period_ceiling_cents":{"type":"integer","title":"Period Ceiling Cents"},"period":{"type":"string","enum":["month","week"],"title":"Period"},"valid_from":{"type":"string","format":"date-time","title":"Valid From"},"valid_to":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Valid To"},"counter_signed_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Counter Signed By"},"counter_signed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Counter Signed At"},"self_signed":{"type":"boolean","title":"Self Signed","default":false},"signature":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Signature"},"revoked_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Revoked At"},"revoked_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Revoked By"},"created_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"status":{"type":"string","enum":["proposed","active","scheduled","expired","revoked"],"title":"Status"},"spent_this_period_cents":{"type":"integer","title":"Spent This Period Cents","default":0},"remaining_this_period_cents":{"type":"integer","title":"Remaining This Period Cents","default":0},"verify_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Verify Url"}},"type":"object","required":["id","business_id","subject_type","subject_id","purpose","per_payment_ceiling_cents","period_ceiling_cents","period","valid_from","created_at","status"],"title":"AgentMandateResponse"},"SuccessEnvelope_AgentMandateResponse_":{"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/AgentMandateResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[AgentMandateResponse]"},"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":[]}]}