{"openapi":"3.1.0","info":{"title":"POST /api/v1/credit/programs/{program_id}/mcc-allowlist/apply","version":"1.0.0","description":"Apply an MCC allow list"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/credit/programs/{program_id}/mcc-allowlist/apply":{"post":{"tags":["credit"],"summary":"Apply an MCC allow list","description":"Writes `codes` as the program's `allowed_mcc_codes`, pushes the restriction to every live DayZero-managed card on the program's lines (as the Ramp categories the MCCs fall under), and records the source and, for an upload, the file's SHA-256 in the audit log. A card the issuer refuses is reported in `cards` and does not undo the list. `codes: []` with `unrestricted: true` clears the list as a recorded decision. Operator action.","operationId":"credit_mcc_allowlist_apply","parameters":[{"name":"program_id","in":"path","required":true,"schema":{"type":"string","title":"Program 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/MccAllowlistApplyRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_MccAllowlistApplyResponse_"}}}},"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":"credit_mcc_allowlist_apply_api_v1_credit_programs__program_id__mcc_allowlist_apply_post"}}},"components":{"schemas":{"MccAllowlistApplyRequest":{"properties":{"codes":{"items":{"type":"string"},"type":"array","maxItems":500,"title":"Codes","description":"The allow list: four-digit MCCs. Duplicates are dropped and the list is stored sorted. Empty only with `unrestricted: true`."},"source":{"type":"string","enum":["upload","settlements","preset","manual"],"title":"Source","description":"Where the list came from: the preview source it was chosen in, or `manual` for a list typed or edited by hand."},"file_sha256":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"File Sha256","description":"Required with `source: upload`: the `file_sha256` the preview returned. Not accepted with any other source."},"unrestricted":{"type":"boolean","title":"Unrestricted","description":"Send `true` with empty `codes` to clear the allow list on purpose. Recorded as a decision, so the program reads as deliberately unrestricted rather than never set.","default":false}},"additionalProperties":false,"type":"object","required":["source"],"title":"MccAllowlistApplyRequest","description":"Write the chosen MCCs onto the program and push them to its cards."},"MccAllowlistApplyResponse":{"properties":{"program_id":{"type":"string","title":"Program Id","description":"The program."},"allowed_mcc_codes":{"items":{"type":"string"},"type":"array","title":"Allowed Mcc Codes","description":"The allow list as stored, sorted."},"previous_codes":{"items":{"type":"string"},"type":"array","title":"Previous Codes","description":"The allow list before this call."},"unrestricted":{"type":"boolean","title":"Unrestricted","description":"True when the list was cleared on purpose."},"source":{"type":"string","enum":["upload","settlements","preset","manual"],"title":"Source","description":"As sent."},"file_sha256":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"File Sha256","description":"As sent."},"decided_at":{"type":"string","format":"date-time","title":"Decided At","description":"When this decision was recorded (UTC). Also on the program."},"ramp_categories":{"items":{"$ref":"#/components/schemas/RampCategoryRef"},"type":"array","title":"Ramp Categories","description":"The Ramp categories pushed to the issuer as the allow list."},"unmapped_codes":{"items":{"type":"string"},"type":"array","title":"Unmapped Codes","description":"MCCs on the list with no known Ramp category: kept on the program (spend there still raises no alarm) but not enforceable at the issuer."},"cards":{"items":{"$ref":"#/components/schemas/MccAllowlistCardPush"},"type":"array","title":"Cards","description":"One entry per live DayZero-managed card on the program's lines."},"pushed":{"type":"integer","title":"Pushed","description":"Cards the issuer accepted it for.","default":0},"failed":{"type":"integer","title":"Failed","description":"Cards the push failed for. The list stays applied; re-apply to retry.","default":0},"partner_cards_not_pushed":{"type":"integer","title":"Partner Cards Not Pushed","description":"Live partner-managed cards on the program's lines. DayZero never pushes to these; the partner sets their restrictions.","default":0}},"type":"object","required":["program_id","unrestricted","source","decided_at"],"title":"MccAllowlistApplyResponse","description":"The list as stored, and what reached the issuer."},"MccAllowlistCardPush":{"properties":{"card_id":{"type":"string","title":"Card Id","description":"The card."},"credit_line_id":{"type":"string","title":"Credit Line Id","description":"The line it is on."},"last_four":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Four","description":"The card's last four."},"status":{"type":"string","enum":["pushed","failed"],"title":"Status","description":"`pushed` when the issuer took it; `failed` otherwise."},"detail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Detail","description":"The issuer's reason, when the push failed."}},"type":"object","required":["card_id","credit_line_id","status"],"title":"MccAllowlistCardPush","description":"What happened when the new restriction was pushed to one card."},"RampCategoryRef":{"properties":{"code":{"type":"integer","title":"Code","description":"Ramp's own category code (1–44)."},"name":{"type":"string","title":"Name","description":"Ramp's name for the category."}},"type":"object","required":["code","name"],"title":"RampCategoryRef","description":"A Ramp spending category: what an allowed MCC is pushed to the issuer as."},"SuccessEnvelope_MccAllowlistApplyResponse_":{"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/MccAllowlistApplyResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[MccAllowlistApplyResponse]"},"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":[]}]}