{"openapi":"3.1.0","info":{"title":"GET /api/v1/credit/payments/resolve","version":"1.0.0","description":"Resolve an inbound payment to a credit line"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/credit/payments/resolve":{"get":{"tags":["credit"],"summary":"Resolve an inbound payment to a credit line","description":"Given the description an incoming payment arrives with, return the credit line it belongs to. A line id comes back only on an exact match against a recorded alias; a partial overlap is returned as a candidate for a person to confirm and never as a match. Nothing is recorded here — take the id and post the payment as usual.","operationId":"resolve_payment","parameters":[{"name":"description","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":255,"description":"Sender name or reference.","title":"Description"},"description":"Sender name or reference."},{"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_PaymentResolveResponse_"}}}},"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":"resolve_payment_api_v1_credit_payments_resolve_get"}}},"components":{"schemas":{"PaymentAliasCandidate":{"properties":{"credit_line_id":{"type":"string","title":"Credit Line Id"},"alias":{"type":"string","title":"Alias"},"normalised":{"type":"string","title":"Normalised"}},"type":"object","required":["credit_line_id","alias","normalised"],"title":"PaymentAliasCandidate"},"PaymentResolveResponse":{"properties":{"description":{"type":"string","title":"Description"},"normalised":{"type":"string","title":"Normalised"},"credit_line_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Credit Line Id","description":"Set only on an exact match against a recorded alias. Null means unresolved — record the alias, or identify the merchant yourself and post the payment with its credit_line_id."},"matched_on":{"anyOf":[{"type":"string","const":"alias"},{"type":"null"}],"title":"Matched On"},"candidates":{"items":{"$ref":"#/components/schemas/PaymentAliasCandidate"},"type":"array","title":"Candidates","description":"Partial overlaps, for a person to confirm. Never treated as a match: applying one merchant's money to another's loan is worse than applying none."}},"type":"object","required":["description","normalised"],"title":"PaymentResolveResponse","description":"Who an inbound payment belongs to, or why we will not guess."},"SuccessEnvelope_PaymentResolveResponse_":{"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/PaymentResolveResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[PaymentResolveResponse]"},"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":[]}]}