{"openapi":"3.1.0","info":{"title":"GET /api/v1/credit/merchant-data","version":"1.0.0","description":"What DayZero holds for a merchant's underwriting"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/credit/merchant-data":{"get":{"tags":["credit"],"summary":"What DayZero holds for a merchant's underwriting","description":"One entry per data source (bank, shopify, meta_ads, profile, debt_facilities, ad_spend, receivables): `provided`, `not_provided` or `stale`, when it last arrived, how many rows, the criterion keys it feeds and what to send when it is missing. Only the bank is `required`: underwriting waits for it, and a missing optional source leaves its measures unmeasured. Name the merchant by `merchant_business_id`, `credit_line_id`, or `program_id` with `external_merchant_id`. Creates nothing; an unknown merchant is `404` `CREDIT_836`.","operationId":"get_credit_merchant_data","parameters":[{"name":"program_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Your program, with `external_merchant_id`.","title":"Program Id"},"description":"Your program, with `external_merchant_id`."},{"name":"external_merchant_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Your id for the merchant.","title":"External Merchant Id"},"description":"Your id for the merchant."},{"name":"credit_line_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The merchant's line.","title":"Credit Line Id"},"description":"The merchant's line."},{"name":"merchant_business_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The merchant's DayZero business.","title":"Merchant Business Id"},"description":"The merchant's DayZero business."},{"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_MerchantDataStatusResponse_"}}}},"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":"get_credit_merchant_data_api_v1_credit_merchant_data_get"}}},"components":{"schemas":{"MerchantDataSource":{"properties":{"source":{"type":"string","title":"Source","description":"bank, shopify, meta_ads, profile, debt_facilities, ad_spend or receivables."},"status":{"type":"string","enum":["provided","not_provided","stale"],"title":"Status","description":"provided: DayZero holds it and it is current. not_provided: nothing has arrived. stale: it arrived but has not been refreshed lately (see `detail`)."},"required":{"type":"boolean","title":"Required","description":"Whether underwriting waits for it. Only the bank is; the rest leave the measures that read them unmeasured when missing."},"last_received_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Received At","description":"When it last arrived or synced, UTC."},"items":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Items","description":"Rows held: transactions, orders, facilities, days or invoices."},"measures":{"items":{"type":"string"},"type":"array","title":"Measures","description":"The criterion keys that read it."},"detail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Detail","description":"What is missing or old."}},"type":"object","required":["source","status","required"],"title":"MerchantDataSource","description":"One underwriting data source and whether DayZero has it."},"MerchantDataStatusResponse":{"properties":{"merchant_business_id":{"type":"string","title":"Merchant Business Id","description":"The merchant's DayZero business."},"sources":{"items":{"$ref":"#/components/schemas/MerchantDataSource"},"type":"array","title":"Sources","description":"One entry per source, bank first."}},"type":"object","required":["merchant_business_id","sources"],"title":"MerchantDataStatusResponse","description":"Every data source underwriting reads for one merchant."},"SuccessEnvelope_MerchantDataStatusResponse_":{"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/MerchantDataStatusResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[MerchantDataStatusResponse]"},"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":[]}]}