{"openapi":"3.1.0","info":{"title":"POST /api/v1/payliance/bank-candidates","version":"1.0.0","description":"List Payliance Bank Candidates"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/payliance/bank-candidates":{"post":{"tags":["payliance"],"summary":"List Payliance Bank Candidates","description":"Find bank rows for a selected settlement or return total without applying a match.","operationId":"list_payliance_bank_candidates","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/PaylianceBankCandidatesRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_PaylianceCandidates_"}}}},"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"}}}},"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":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"unauthorized","message":"Authentication required","code":"AUTH_001","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"forbidden","message":"You don't have permission to access this resource","code":"AUTH_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"}}}}},"x-fastapi-operation-id":"list_payliance_bank_candidates_api_v1_payliance_bank_candidates_post"}}},"components":{"schemas":{"PaylianceBankCandidatesRequest":{"properties":{"transaction_ids":{"items":{"type":"string"},"type":"array","maxItems":1000,"minItems":1,"title":"Transaction Ids"},"kind":{"type":"string","enum":["settlement","return"],"title":"Kind","default":"settlement"}},"additionalProperties":false,"type":"object","required":["transaction_ids"],"title":"PaylianceBankCandidatesRequest"},"PaylianceCandidate":{"properties":{"id":{"type":"string","title":"Id"},"label":{"type":"string","title":"Label"},"amount_cents":{"type":"integer","title":"Amount Cents"},"date":{"type":"string","format":"date","title":"Date"}},"type":"object","required":["id","label","amount_cents","date"],"title":"PaylianceCandidate"},"PaylianceCandidates":{"properties":{"items":{"items":{"$ref":"#/components/schemas/PaylianceCandidate"},"type":"array","title":"Items"},"unreconciled_bank_payments":{"items":{"$ref":"#/components/schemas/PaylianceCandidate"},"type":"array","title":"Unreconciled Bank Payments","description":"All unresolved bank-created payments on the selected credit_line_id, regardless of date or amount. Explicitly reconcile these before recording a distinct processor payment."}},"type":"object","required":["items"],"title":"PaylianceCandidates"},"SuccessEnvelope_PaylianceCandidates_":{"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/PaylianceCandidates"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[PaylianceCandidates]"},"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":[]}]}