{"openapi":"3.1.0","info":{"title":"GET /api/v1/credit/lines/{credit_line_id}/payment-matches","version":"1.0.0","description":"List the bank-settlement decisions on a line"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/credit/lines/{credit_line_id}/payment-matches":{"get":{"tags":["credit"],"summary":"List the bank-settlement decisions on a line","description":"Every decision the bank-settlement matcher took for this line, newest bank date first: `settled` (a pending payment confirmed as at the bank date), `returned` (a payment reversed as an ACH return), `ambiguous` (more than one payment fit, nothing applied) and `unmatched_candidate` (looks like this line's repayment, but the sender is not a recorded alias). `rule` says which rule decided and `notes` the evidence. Pass `unresolved=true` for the rows waiting on an operator.","operationId":"list_payment_matches","parameters":[{"name":"credit_line_id","in":"path","required":true,"schema":{"type":"string","title":"Credit Line Id"}},{"name":"kind","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Comma-separated: settled, returned, ambiguous, unmatched_candidate.","title":"Kind"},"description":"Comma-separated: settled, returned, ambiguous, unmatched_candidate."},{"name":"unresolved","in":"query","required":false,"schema":{"type":"boolean","description":"Only ambiguous and candidate rows no one has decided.","default":false,"title":"Unresolved"},"description":"Only ambiguous and candidate rows no one has decided."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":50,"title":"Limit"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`next_cursor` from the last page.","title":"Cursor"},"description":"`next_cursor` from the last page."},{"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_PaymentMatchListResponse_"}}}},"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":"list_payment_matches_api_v1_credit_lines__credit_line_id__payment_matches_get"}}},"components":{"schemas":{"PaymentMatchListResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/PaymentMatchResponse"},"type":"array","title":"Items"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"},"has_next":{"type":"boolean","title":"Has Next","default":false},"limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Limit"}},"type":"object","title":"PaymentMatchListResponse"},"PaymentMatchResponse":{"properties":{"id":{"type":"string","title":"Id"},"credit_line_id":{"type":"string","title":"Credit Line Id"},"payment_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Id"},"transaction_id":{"type":"string","title":"Transaction Id"},"transaction_business_id":{"type":"string","title":"Transaction Business Id"},"kind":{"type":"string","enum":["settled","returned","ambiguous","unmatched_candidate"],"title":"Kind"},"rule":{"type":"string","enum":["linked_account","alias","ach_return"],"title":"Rule"},"amount_cents":{"type":"integer","title":"Amount Cents"},"matched_on":{"type":"string","format":"date","title":"Matched On","description":"The bank transaction's date: the settled_on or reversed_on it applied."},"confidence":{"type":"number","title":"Confidence","description":"0 to 1. Informational; never a threshold."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"},"candidate_payment_ids":{"items":{"type":"string"},"type":"array","title":"Candidate Payment Ids"},"resolution":{"anyOf":[{"type":"string","enum":["confirmed","rejected","superseded"]},{"type":"null"}],"title":"Resolution"},"resolved_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Resolved At"},"resolved_by_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Resolved By Label"},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"}},"type":"object","required":["id","credit_line_id","transaction_id","transaction_business_id","kind","rule","amount_cents","matched_on","confidence"],"title":"PaymentMatchResponse","description":"One decision the matcher took about one bank transaction for one line."},"SuccessEnvelope_PaymentMatchListResponse_":{"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/PaymentMatchListResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[PaymentMatchListResponse]"},"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":[]}]}