{"openapi":"3.1.0","info":{"title":"POST /api/v1/credit/interchange/report","version":"1.0.0","description":"Ingest the issuer's interchange report"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/credit/interchange/report":{"post":{"tags":["credit"],"summary":"Ingest the issuer's interchange report","description":"Rows from the issuer's interchange or rebate report. Each row is attributed by issuer transaction id, card id, or credit line; a row for a settlement that was already estimated supersedes the estimate and the books move by the difference. Idempotent on the row's `external_reference`.","operationId":"ingest_interchange_report","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/InterchangeReportRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_InterchangeReportResponse_"}}}},"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"}}}},"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":"ingest_interchange_report_api_v1_credit_interchange_report_post"}}},"components":{"schemas":{"InterchangeReportItem":{"properties":{"external_reference":{"type":"string","maxLength":128,"title":"External Reference","description":"Issuer row id; idempotency key for the row."},"interchange_cents":{"type":"integer","title":"Interchange Cents"},"recognized_on":{"type":"string","format":"date","title":"Recognized On"},"external_settlement_id":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"External Settlement Id","description":"Issuer transaction id, when the report is per transaction."},"provider_card_id":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Provider Card Id"},"credit_line_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Credit Line Id"},"gross_spend_cents":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Gross Spend Cents"},"memo":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Memo"}},"additionalProperties":false,"type":"object","required":["external_reference","interchange_cents","recognized_on"],"title":"InterchangeReportItem","description":"One row from the issuer's interchange or rebate report."},"InterchangeReportRequest":{"properties":{"program_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Program Id"},"rows":{"items":{"$ref":"#/components/schemas/InterchangeReportItem"},"type":"array","maxItems":5000,"minItems":1,"title":"Rows"}},"additionalProperties":false,"type":"object","required":["rows"],"title":"InterchangeReportRequest"},"InterchangeReportResponse":{"properties":{"accepted":{"type":"integer","title":"Accepted","default":0},"duplicates":{"type":"integer","title":"Duplicates","default":0},"unattributed":{"type":"integer","title":"Unattributed","default":0},"trued_up":{"type":"integer","title":"Trued Up","default":0},"interchange_cents":{"type":"integer","title":"Interchange Cents","default":0},"results":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Results"}},"type":"object","title":"InterchangeReportResponse"},"SuccessEnvelope_InterchangeReportResponse_":{"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/InterchangeReportResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[InterchangeReportResponse]"},"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":[]}]}