{"openapi":"3.1.0","info":{"title":"Banking API","version":"1.0.0","description":"Connect your banks and build with your financial data. API keys are created through Banking MCP or Account → API keys. Keep keys on your server. Reads use stored data; request a refresh explicitly. Payments cannot be made."},"servers":[{"url":"https://api.bankmcp.app"}],"security":[{"apiKey":[]}],"paths":{"/v1/access":{"get":{"operationId":"access","summary":"Inspect this API key","tags":["access"],"description":"Returns key metadata, never the secret.","x-permission":null,"security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":100},"prefix":{"type":"string"},"permissions":{"type":"array","items":{"type":"string","enum":["banks:read","accounts:read","balances:read","transactions:read","institutions:read","connections:create","banks:refresh","history:import","banks:disconnect","merchants:resolve","merchants:correct"]}},"resources":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["all"]}},"required":["type"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["banks"]},"bank_ids":{"type":"array","items":{"type":"string","pattern":"^[A-Z]{2}:.{1,200}$","description":"Bank ID from list_banks, e.g. \"DE:N26\" (country code and bank name).","examples":["DE:N26"],"minLength":1},"minItems":1,"maxItems":1000}},"required":["type","bank_ids"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["accounts"]},"account_ids":{"type":"array","items":{"type":"string","minLength":1},"minItems":1,"maxItems":1000}},"required":["type","account_ids"],"additionalProperties":false}]},"created_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$"},"expires_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$"},"last_used_at":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$"},{"type":"null"}]},"revoked_at":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$"},{"type":"null"}]},"issued_by":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","prefix","permissions","resources","created_at","expires_at","last_used_at","revoked_at","issued_by"],"additionalProperties":false}}}},"400":{"description":"Codes: INVALID_INPUT.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["INVALID_INPUT"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"INVALID_INPUT"}}}},"401":{"description":"Codes: INVALID_API_KEY.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["INVALID_API_KEY"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"INVALID_API_KEY"}}}},"403":{"description":"Codes: STEP_UP_REQUIRED, PASSKEY_STEP_UP_REQUIRED, PILOT_ACCESS_DENIED, FORBIDDEN, INSUFFICIENT_PERMISSION, RESOURCE_SCOPE_REQUIRED, entitlement.access_paused, entitlement.feature_disabled.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["STEP_UP_REQUIRED","PASSKEY_STEP_UP_REQUIRED","PILOT_ACCESS_DENIED","FORBIDDEN","INSUFFICIENT_PERMISSION","RESOURCE_SCOPE_REQUIRED","entitlement.access_paused","entitlement.feature_disabled"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"STEP_UP_REQUIRED"}}}},"404":{"description":"Codes: NOT_FOUND.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["NOT_FOUND"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Resource not found.","code":"NOT_FOUND"}}}},"409":{"description":"Codes: CONFLICT, BANK_REAUTH_REQUIRED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["CONFLICT","BANK_REAUTH_REQUIRED"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"CONFLICT"}}}},"413":{"description":"Codes: REQUEST_TOO_LARGE.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["REQUEST_TOO_LARGE"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"REQUEST_TOO_LARGE"}}}},"429":{"description":"Rate limited; retry after Retry-After seconds. Codes: RATE_LIMITED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["RATE_LIMITED"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Too many requests. Wait a minute and try again.","code":"RATE_LIMITED"}}},"headers":{"Retry-After":{"schema":{"type":"string"},"example":"60","description":"Seconds to wait before retrying."}}},"500":{"description":"Codes: REQUEST_FAILED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["REQUEST_FAILED"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"REQUEST_FAILED"}}}},"502":{"description":"Codes: INVALID_RESPONSE, UPSTREAM_FAILURE.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["INVALID_RESPONSE","UPSTREAM_FAILURE"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"INVALID_RESPONSE"}}}},"503":{"description":"Codes: UNAVAILABLE.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["UNAVAILABLE"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"UNAVAILABLE"}}}}}}},"/v1/banks":{"get":{"operationId":"banks","summary":"List connected banks","tags":["banks"],"description":"Requires `banks:read`. Resource restrictions also apply. List connected banks.","x-permission":"banks:read","security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"banks":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string","pattern":"^[A-Z]{2}:.{1,200}$","description":"Bank ID from list_banks, e.g. \"DE:N26\" (country code and bank name).","examples":["DE:N26"]},"name":{"type":"string"},"country":{"type":"string","pattern":"^[A-Z]{2}$","description":"ISO 3166-1 alpha-2 country code, e.g. DE","examples":["DE"]}},"required":["bank_id","name","country"],"additionalProperties":false}}},"required":["banks"],"additionalProperties":false}}}},"400":{"description":"Codes: INVALID_INPUT.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["INVALID_INPUT"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"INVALID_INPUT"}}}},"401":{"description":"Codes: INVALID_API_KEY.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["INVALID_API_KEY"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"INVALID_API_KEY"}}}},"403":{"description":"Codes: INSUFFICIENT_PERMISSION, entitlement.access_paused, entitlement.feature_disabled.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["INSUFFICIENT_PERMISSION","entitlement.access_paused","entitlement.feature_disabled"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"INSUFFICIENT_PERMISSION"}}}},"404":{"description":"Codes: NOT_FOUND.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["NOT_FOUND"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Resource not found.","code":"NOT_FOUND"}}}},"409":{"description":"Codes: CONFLICT, BANK_REAUTH_REQUIRED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["CONFLICT","BANK_REAUTH_REQUIRED"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"CONFLICT"}}}},"413":{"description":"Codes: REQUEST_TOO_LARGE.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["REQUEST_TOO_LARGE"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"REQUEST_TOO_LARGE"}}}},"429":{"description":"Rate limited; retry after Retry-After seconds. Codes: rate_limit.feature, RATE_LIMITED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["rate_limit.feature","RATE_LIMITED"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"rate_limit.feature"}}},"headers":{"Retry-After":{"schema":{"type":"string"},"example":"60","description":"Seconds to wait before retrying."}}},"500":{"description":"Codes: REQUEST_FAILED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["REQUEST_FAILED"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"REQUEST_FAILED"}}}},"502":{"description":"Codes: INVALID_RESPONSE, UPSTREAM_FAILURE.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["INVALID_RESPONSE","UPSTREAM_FAILURE"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"INVALID_RESPONSE"}}}},"503":{"description":"Codes: UNAVAILABLE.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["UNAVAILABLE"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"UNAVAILABLE"}}}}}}},"/v1/accounts":{"get":{"operationId":"accounts","summary":"List accessible accounts","tags":["accounts"],"description":"Requires `accounts:read`. Resource restrictions also apply. Read account details.","x-permission":"accounts:read","security":[{"apiKey":[]}],"parameters":[{"name":"bank_id","in":"query","required":false,"schema":{"type":"string","pattern":"^[A-Z]{2}:.{1,200}$","description":"Bank ID from list_banks, e.g. \"DE:N26\" (country code and bank name).","examples":["DE:N26"]}},{"name":"include_closed","in":"query","required":false,"schema":{"type":"string","enum":["true","false"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"environment":{"type":"string","enum":["sandbox","production"]},"accounts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"bank_id":{"type":"string","pattern":"^[A-Z]{2}:.{1,200}$","description":"Bank ID from list_banks, e.g. \"DE:N26\" (country code and bank name).","examples":["DE:N26"]},"name":{"type":"string"},"product":{"anyOf":[{"type":"string"},{"type":"null"}]},"bank":{"type":"object","properties":{"name":{"type":"string"},"country":{"type":"string","pattern":"^[A-Z]{2}$","description":"ISO 3166-1 alpha-2 country code, e.g. DE","examples":["DE"]}},"required":["name","country"],"additionalProperties":false},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]},"iban_last4":{"anyOf":[{"type":"string"},{"type":"null"}]},"closed":{"type":"boolean"},"consent_expires_at":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$"},"consent_expired":{"type":"boolean"}},"required":["id","bank_id","name","product","bank","currency","iban_last4","closed","consent_expires_at","consent_expired"],"additionalProperties":false}}},"required":["environment","accounts"],"additionalProperties":false}}}},"400":{"description":"Codes: INVALID_INPUT.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["INVALID_INPUT"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"INVALID_INPUT"}}}},"401":{"description":"Codes: INVALID_API_KEY.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["INVALID_API_KEY"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"INVALID_API_KEY"}}}},"403":{"description":"Codes: INSUFFICIENT_PERMISSION, entitlement.access_paused, entitlement.feature_disabled.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["INSUFFICIENT_PERMISSION","entitlement.access_paused","entitlement.feature_disabled"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"INSUFFICIENT_PERMISSION"}}}},"404":{"description":"Codes: NOT_FOUND.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["NOT_FOUND"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Resource not found.","code":"NOT_FOUND"}}}},"409":{"description":"Codes: CONFLICT, BANK_REAUTH_REQUIRED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["CONFLICT","BANK_REAUTH_REQUIRED"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"CONFLICT"}}}},"413":{"description":"Codes: REQUEST_TOO_LARGE.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["REQUEST_TOO_LARGE"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"REQUEST_TOO_LARGE"}}}},"429":{"description":"Rate limited; retry after Retry-After seconds. Codes: rate_limit.feature, RATE_LIMITED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["rate_limit.feature","RATE_LIMITED"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"rate_limit.feature"}}},"headers":{"Retry-After":{"schema":{"type":"string"},"example":"60","description":"Seconds to wait before retrying."}}},"500":{"description":"Codes: REQUEST_FAILED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["REQUEST_FAILED"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"REQUEST_FAILED"}}}},"502":{"description":"Codes: INVALID_RESPONSE, UPSTREAM_FAILURE.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["INVALID_RESPONSE","UPSTREAM_FAILURE"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"INVALID_RESPONSE"}}}},"503":{"description":"Codes: UNAVAILABLE.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["UNAVAILABLE"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"UNAVAILABLE"}}}}}}},"/v1/accounts/{id}/balances":{"get":{"operationId":"balances","summary":"Read stored balances","tags":["accounts"],"description":"Requires `balances:read`. Resource restrictions also apply. Read balances.","x-permission":"balances:read","security":[{"apiKey":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"environment":{"type":"string","enum":["sandbox","production"]},"account_id":{"type":"string","minLength":1},"retrieved_at":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$"},{"type":"null"}]},"source":{"type":"string","enum":["stored","live"]},"warning":{"type":"string"},"balances":{"type":"array","items":{"type":"object","properties":{"balance_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"balance_amount":{"type":"object","properties":{"amount":{"type":"string","pattern":"^-?\\d+(\\.\\d+)?$","description":"Exact decimal amount as a string","examples":["12.30","-4.99"]},"currency":{"type":"string","pattern":"^[A-Z]{3}$","description":"ISO 4217 currency code","examples":["EUR"]}},"required":["amount","currency"],"additionalProperties":false},"reference_date":{"anyOf":[{"type":"string","description":"Calendar date (YYYY-MM-DD)","examples":["2026-10-15"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}]}},"required":["balance_amount"],"additionalProperties":false}}},"required":["environment","account_id","retrieved_at","source","balances"],"additionalProperties":false}}}},"400":{"description":"Codes: INVALID_INPUT.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["INVALID_INPUT"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"INVALID_INPUT"}}}},"401":{"description":"Codes: INVALID_API_KEY.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["INVALID_API_KEY"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"INVALID_API_KEY"}}}},"403":{"description":"Codes: INSUFFICIENT_PERMISSION, entitlement.access_paused, entitlement.feature_disabled.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["INSUFFICIENT_PERMISSION","entitlement.access_paused","entitlement.feature_disabled"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"INSUFFICIENT_PERMISSION"}}}},"404":{"description":"Codes: NOT_FOUND.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["NOT_FOUND"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Resource not found.","code":"NOT_FOUND"}}}},"409":{"description":"Codes: CONFLICT, BANK_REAUTH_REQUIRED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["CONFLICT","BANK_REAUTH_REQUIRED"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"CONFLICT"}}}},"413":{"description":"Codes: REQUEST_TOO_LARGE.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["REQUEST_TOO_LARGE"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"REQUEST_TOO_LARGE"}}}},"429":{"description":"Rate limited; retry after Retry-After seconds. Codes: rate_limit.feature, RATE_LIMITED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["rate_limit.feature","RATE_LIMITED"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"rate_limit.feature"}}},"headers":{"Retry-After":{"schema":{"type":"string"},"example":"60","description":"Seconds to wait before retrying."}}},"500":{"description":"Codes: REQUEST_FAILED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["REQUEST_FAILED"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"REQUEST_FAILED"}}}},"502":{"description":"Codes: INVALID_RESPONSE, UPSTREAM_FAILURE.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["INVALID_RESPONSE","UPSTREAM_FAILURE"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"INVALID_RESPONSE"}}}},"503":{"description":"Codes: UNAVAILABLE.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["UNAVAILABLE"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"UNAVAILABLE"}}}}}}},"/v1/accounts/{id}/transactions":{"get":{"operationId":"transactions","summary":"Read stored transactions","tags":["accounts"],"description":"Requires `transactions:read`. Resource restrictions also apply. Read transactions.","x-permission":"transactions:read","security":[{"apiKey":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"date_from","in":"query","required":false,"schema":{"type":"string","description":"Calendar date (YYYY-MM-DD)","examples":["2026-10-15"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$"}},{"name":"date_to","in":"query","required":false,"schema":{"type":"string","description":"Calendar date (YYYY-MM-DD)","examples":["2026-10-15"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$"}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"environment":{"type":"string","enum":["sandbox","production"]},"account_id":{"type":"string","minLength":1},"retrieved_at":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$"},{"type":"null"}]},"source":{"type":"string","enum":["stored","live"]},"coverage":{"anyOf":[{"type":"object","properties":{"from":{"type":"string","description":"Calendar date (YYYY-MM-DD)","examples":["2026-10-15"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"to":{"type":"string","description":"Calendar date (YYYY-MM-DD)","examples":["2026-10-15"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$"}},"required":["from","to"],"additionalProperties":false},{"type":"null"}]},"transactions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"booking_date":{"anyOf":[{"type":"string","description":"Calendar date (YYYY-MM-DD)","examples":["2026-10-15"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}]},"value_date":{"anyOf":[{"type":"string","description":"Calendar date (YYYY-MM-DD)","examples":["2026-10-15"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}]},"amount":{"type":"object","properties":{"amount":{"type":"string","pattern":"^-?\\d+(\\.\\d+)?$","description":"Exact decimal amount as a string","examples":["12.30","-4.99"]},"currency":{"type":"string","pattern":"^[A-Z]{3}$","description":"ISO 4217 currency code","examples":["EUR"]}},"required":["amount","currency"],"additionalProperties":false},"direction":{"anyOf":[{"type":"string","enum":["CRDT","DBIT"]},{"type":"null"}]},"description":{"type":"array","items":{"type":"string"}},"counterparty":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]},"balance_after_transaction":{"anyOf":[{"type":"object","properties":{"amount":{"type":"string","pattern":"^-?\\d+(\\.\\d+)?$","description":"Exact decimal amount as a string","examples":["12.30","-4.99"]},"currency":{"type":"string","pattern":"^[A-Z]{3}$","description":"ISO 4217 currency code","examples":["EUR"]}},"required":["amount","currency"],"additionalProperties":false},{"type":"null"}],"description":"The account balance after this transaction, when the bank reports one."},"merchant":{"anyOf":[{"type":"object","properties":{"logo_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"type":"string","description":"The exact merchant name it is stored under (its logo is keyed by it)."},"kind":{"type":"string","enum":["logo","category"]},"category":{"type":"string","enum":["groceries","restaurant","coffee","fast_food","food_delivery","bar","bakery","pharmacy","health","beauty","fashion","electronics","home","shopping","software","subscription","music","streaming","entertainment","events","sports","fitness","travel","hotel","transport","taxi","fuel","parking","utilities","telecom","housing","insurance","education","books","pets","gifts","charity","government","other"]},"brand":{"anyOf":[{"type":"string"},{"type":"null"}]},"domain":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["name","kind","category","brand","domain"],"additionalProperties":false},{"type":"null"}]},"category":{"anyOf":[{"type":"string","enum":["groceries","restaurant","coffee","fast_food","food_delivery","bar","bakery","pharmacy","health","beauty","fashion","electronics","home","shopping","software","subscription","music","streaming","entertainment","events","sports","fitness","travel","hotel","transport","taxi","fuel","parking","utilities","telecom","housing","insurance","education","books","pets","gifts","charity","government","other","transfer","income","fees","cash"]},{"type":"null"}]},"via":{"anyOf":[{"type":"object","properties":{"provider":{"type":"string","description":"The wallet, e.g. PayPal."},"role":{"type":"string","enum":["funding","payment","transfer"],"description":"funding: a bank debit that paid a wallet payment; payment: the wallet paying the merchant; transfer: between the wallet and a bank."},"payee":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For funding: who the wallet paid (the merchant)."},"linked":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"bank":{"type":"string"},"day":{"type":"string","description":"Calendar date (YYYY-MM-DD)","examples":["2026-10-15"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"amount":{"type":"string","pattern":"^-?\\d+(\\.\\d+)?$","description":"Exact decimal amount as a string","examples":["12.30","-4.99"]},"currency":{"type":"string","pattern":"^[A-Z]{3}$","description":"ISO 4217 currency code","examples":["EUR"]},"method":{"type":"string","enum":["exact","amount_date","currency","partial"]},"confidence":{"type":"number"}},"required":["id","bank","day","amount","currency","method","confidence"],"additionalProperties":false},{"type":"null"}]}},"required":["provider","role","payee","linked"],"additionalProperties":false},{"type":"null"}]}},"required":["id","booking_date","value_date","amount","direction","description","counterparty","status","balance_after_transaction","merchant","category","via"],"additionalProperties":false}},"complete":{"type":"boolean"},"next_cursor":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"continuation_instructions":{"type":"string"},"warning":{"type":"string"}},"required":["environment","account_id","retrieved_at","source","coverage","transactions","complete","next_cursor"],"additionalProperties":false}}}},"400":{"description":"Codes: INVALID_INPUT.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["INVALID_INPUT"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"INVALID_INPUT"}}}},"401":{"description":"Codes: INVALID_API_KEY.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["INVALID_API_KEY"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"INVALID_API_KEY"}}}},"403":{"description":"Codes: INSUFFICIENT_PERMISSION, entitlement.access_paused, entitlement.feature_disabled.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["INSUFFICIENT_PERMISSION","entitlement.access_paused","entitlement.feature_disabled"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"INSUFFICIENT_PERMISSION"}}}},"404":{"description":"Codes: NOT_FOUND.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["NOT_FOUND"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Resource not found.","code":"NOT_FOUND"}}}},"409":{"description":"Codes: CONFLICT, BANK_REAUTH_REQUIRED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["CONFLICT","BANK_REAUTH_REQUIRED"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"CONFLICT"}}}},"413":{"description":"Codes: REQUEST_TOO_LARGE.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["REQUEST_TOO_LARGE"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"REQUEST_TOO_LARGE"}}}},"429":{"description":"Rate limited; retry after Retry-After seconds. Codes: rate_limit.feature, RATE_LIMITED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["rate_limit.feature","RATE_LIMITED"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"rate_limit.feature"}}},"headers":{"Retry-After":{"schema":{"type":"string"},"example":"60","description":"Seconds to wait before retrying."}}},"500":{"description":"Codes: REQUEST_FAILED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["REQUEST_FAILED"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"REQUEST_FAILED"}}}},"502":{"description":"Codes: INVALID_RESPONSE, UPSTREAM_FAILURE.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["INVALID_RESPONSE","UPSTREAM_FAILURE"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"INVALID_RESPONSE"}}}},"503":{"description":"Codes: UNAVAILABLE.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["UNAVAILABLE"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"UNAVAILABLE"}}}}}}},"/v1/institutions":{"get":{"operationId":"institutions","summary":"Search supported banks","tags":["institutions"],"description":"Requires `institutions:read`. Resource restrictions also apply. Search supported banks.","x-permission":"institutions:read","security":[{"apiKey":[]}],"parameters":[{"name":"query","in":"query","required":false,"schema":{"type":"string"}},{"name":"country","in":"query","required":false,"schema":{"type":"string","pattern":"^[A-Z]{2}$","description":"ISO 3166-1 alpha-2 country code, e.g. DE","examples":["DE"]}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"environment":{"type":"string","enum":["sandbox","production"]},"institutions":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"options":{"type":"array","items":{"type":"object","properties":{"country":{"type":"string","pattern":"^[A-Z]{2}$","description":"Catalog entry the connection uses: the BIC's own country when listed.","examples":["DE"]},"countries":{"type":"array","items":{"type":"string","pattern":"^[A-Z]{2}$","description":"ISO 3166-1 alpha-2 country code, e.g. DE","examples":["DE"]},"description":"Every market this option serves."},"bic":{"anyOf":[{"type":"string"},{"type":"null"}]},"psu_types":{"type":"array","items":{"type":"string","enum":["personal","business"]}},"beta":{"type":"boolean"},"maximum_consent_validity":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["country","countries","bic","psu_types","beta","maximum_consent_validity"],"additionalProperties":false}},"logo_url":{"type":"string"}},"required":["name","options"],"additionalProperties":false}},"next_cursor":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"total":{"type":"integer","minimum":0}},"required":["environment","institutions","next_cursor"],"additionalProperties":false}}}},"400":{"description":"Codes: INVALID_INPUT.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["INVALID_INPUT"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"INVALID_INPUT"}}}},"401":{"description":"Codes: INVALID_API_KEY.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["INVALID_API_KEY"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"INVALID_API_KEY"}}}},"403":{"description":"Codes: INSUFFICIENT_PERMISSION, entitlement.access_paused, entitlement.feature_disabled.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["INSUFFICIENT_PERMISSION","entitlement.access_paused","entitlement.feature_disabled"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"INSUFFICIENT_PERMISSION"}}}},"404":{"description":"Codes: NOT_FOUND.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["NOT_FOUND"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Resource not found.","code":"NOT_FOUND"}}}},"409":{"description":"Codes: CONFLICT, BANK_REAUTH_REQUIRED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["CONFLICT","BANK_REAUTH_REQUIRED"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"CONFLICT"}}}},"413":{"description":"Codes: REQUEST_TOO_LARGE.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["REQUEST_TOO_LARGE"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"REQUEST_TOO_LARGE"}}}},"429":{"description":"Rate limited; retry after Retry-After seconds. Codes: rate_limit.feature, RATE_LIMITED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["rate_limit.feature","RATE_LIMITED"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"rate_limit.feature"}}},"headers":{"Retry-After":{"schema":{"type":"string"},"example":"60","description":"Seconds to wait before retrying."}}},"500":{"description":"Codes: REQUEST_FAILED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["REQUEST_FAILED"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"REQUEST_FAILED"}}}},"502":{"description":"Codes: INVALID_RESPONSE, UPSTREAM_FAILURE.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["INVALID_RESPONSE","UPSTREAM_FAILURE"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"INVALID_RESPONSE"}}}},"503":{"description":"Codes: UNAVAILABLE.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["UNAVAILABLE"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"UNAVAILABLE"}}}}}}},"/v1/institutions/{name}":{"get":{"operationId":"institution","summary":"Get a supported bank","tags":["institutions"],"description":"Requires `institutions:read`. Resource restrictions also apply. Search supported banks.","x-permission":"institutions:read","security":[{"apiKey":[]}],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":200}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"institution":{"type":"object","properties":{"name":{"type":"string"},"options":{"type":"array","items":{"type":"object","properties":{"country":{"type":"string","pattern":"^[A-Z]{2}$","description":"Catalog entry the connection uses: the BIC's own country when listed.","examples":["DE"]},"countries":{"type":"array","items":{"type":"string","pattern":"^[A-Z]{2}$","description":"ISO 3166-1 alpha-2 country code, e.g. DE","examples":["DE"]},"description":"Every market this option serves."},"bic":{"anyOf":[{"type":"string"},{"type":"null"}]},"psu_types":{"type":"array","items":{"type":"string","enum":["personal","business"]}},"beta":{"type":"boolean"},"maximum_consent_validity":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["country","countries","bic","psu_types","beta","maximum_consent_validity"],"additionalProperties":false}},"logo_url":{"type":"string"}},"required":["name","options"],"additionalProperties":false}},"required":["institution"],"additionalProperties":false}}}},"400":{"description":"Codes: INVALID_INPUT.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["INVALID_INPUT"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"INVALID_INPUT"}}}},"401":{"description":"Codes: INVALID_API_KEY.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["INVALID_API_KEY"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"INVALID_API_KEY"}}}},"403":{"description":"Codes: INSUFFICIENT_PERMISSION, entitlement.access_paused, entitlement.feature_disabled.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["INSUFFICIENT_PERMISSION","entitlement.access_paused","entitlement.feature_disabled"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"INSUFFICIENT_PERMISSION"}}}},"404":{"description":"Codes: NOT_FOUND.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["NOT_FOUND"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Resource not found.","code":"NOT_FOUND"}}}},"409":{"description":"Codes: CONFLICT, BANK_REAUTH_REQUIRED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["CONFLICT","BANK_REAUTH_REQUIRED"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"CONFLICT"}}}},"413":{"description":"Codes: REQUEST_TOO_LARGE.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["REQUEST_TOO_LARGE"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"REQUEST_TOO_LARGE"}}}},"429":{"description":"Rate limited; retry after Retry-After seconds. Codes: rate_limit.feature, RATE_LIMITED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["rate_limit.feature","RATE_LIMITED"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"rate_limit.feature"}}},"headers":{"Retry-After":{"schema":{"type":"string"},"example":"60","description":"Seconds to wait before retrying."}}},"500":{"description":"Codes: REQUEST_FAILED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["REQUEST_FAILED"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"REQUEST_FAILED"}}}},"502":{"description":"Codes: INVALID_RESPONSE, UPSTREAM_FAILURE.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["INVALID_RESPONSE","UPSTREAM_FAILURE"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"INVALID_RESPONSE"}}}},"503":{"description":"Codes: UNAVAILABLE.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["UNAVAILABLE"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"UNAVAILABLE"}}}}}}},"/v1/connection-links":{"post":{"operationId":"connect","summary":"Create a customer-approved connection link","tags":["connection-links"],"description":"Requires `connections:create`. Resource restrictions also apply. Create connection links.","x-permission":"connections:create","security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200,"description":"Bank name exactly as returned by search_banks."},"country":{"type":"string","pattern":"^[A-Z]{2}$","description":"Only for banks with several options (distinct BICs, e.g. ING or N26): any country of the option that holds the account. Omit it to let the user choose on the page.","examples":["DE"]},"psu_type":{"type":"string","enum":["personal","business"],"description":"Defaults to personal, or to the only type the bank offers. Pass business only for business accounts."}},"required":["name"],"additionalProperties":false,"examples":[{"name":"Example Bank","country":"DE","psu_type":"personal"}]},"example":{"name":"Example Bank","country":"DE","psu_type":"personal"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"The bank's connect page in the portal: give it to the user to open."},"bank":{"type":"object","properties":{"name":{"type":"string"},"country":{"anyOf":[{"type":"string","pattern":"^[A-Z]{2}$","description":"ISO 3166-1 alpha-2 country code, e.g. DE","examples":["DE"]},{"type":"null"}]}},"required":["name","country"],"additionalProperties":false},"psu_type":{"anyOf":[{"type":"string","enum":["personal","business"]},{"type":"null"}]},"options":{"type":"array","items":{"type":"object","properties":{"country":{"type":"string","pattern":"^[A-Z]{2}$","description":"ISO 3166-1 alpha-2 country code, e.g. DE","examples":["DE"]},"countries":{"type":"array","items":{"type":"string","pattern":"^[A-Z]{2}$","description":"ISO 3166-1 alpha-2 country code, e.g. DE","examples":["DE"]}},"bic":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["country","countries","bic"],"additionalProperties":false}},"instructions":{"type":"string"}},"required":["url","bank","psu_type","instructions"],"additionalProperties":false}}}},"400":{"description":"Codes: INVALID_INPUT.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["INVALID_INPUT"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"INVALID_INPUT"}}}},"401":{"description":"Codes: INVALID_API_KEY.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["INVALID_API_KEY"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"INVALID_API_KEY"}}}},"403":{"description":"Codes: INSUFFICIENT_PERMISSION, entitlement.access_paused, entitlement.feature_disabled, RESOURCE_SCOPE_REQUIRED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["INSUFFICIENT_PERMISSION","entitlement.access_paused","entitlement.feature_disabled","RESOURCE_SCOPE_REQUIRED"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"INSUFFICIENT_PERMISSION"}}}},"404":{"description":"Codes: NOT_FOUND.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["NOT_FOUND"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Resource not found.","code":"NOT_FOUND"}}}},"409":{"description":"Codes: CONFLICT, BANK_REAUTH_REQUIRED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["CONFLICT","BANK_REAUTH_REQUIRED"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"CONFLICT"}}}},"413":{"description":"Codes: REQUEST_TOO_LARGE.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["REQUEST_TOO_LARGE"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"REQUEST_TOO_LARGE"}}}},"429":{"description":"Rate limited; retry after Retry-After seconds. Codes: rate_limit.feature, RATE_LIMITED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["rate_limit.feature","RATE_LIMITED"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"rate_limit.feature"}}},"headers":{"Retry-After":{"schema":{"type":"string"},"example":"60","description":"Seconds to wait before retrying."}}},"500":{"description":"Codes: REQUEST_FAILED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["REQUEST_FAILED"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"REQUEST_FAILED"}}}},"502":{"description":"Codes: INVALID_RESPONSE, UPSTREAM_FAILURE.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["INVALID_RESPONSE","UPSTREAM_FAILURE"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"INVALID_RESPONSE"}}}},"503":{"description":"Codes: UNAVAILABLE.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["UNAVAILABLE"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"UNAVAILABLE"}}}}}}},"/v1/banks/{id}/refresh":{"post":{"operationId":"refresh","summary":"Refresh a bank","tags":["banks"],"description":"Requires `banks:refresh`. Resource restrictions also apply. Refresh banks.","x-permission":"banks:refresh","security":[{"apiKey":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Z]{2}:.{1,200}$","description":"Bank ID from list_banks, e.g. \"DE:N26\" (country code and bank name).","examples":["DE:N26"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false},"example":{}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"warning":{"type":"string"}},"required":["ok"],"additionalProperties":false}}}},"400":{"description":"Codes: INVALID_INPUT.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["INVALID_INPUT"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"INVALID_INPUT"}}}},"401":{"description":"Codes: INVALID_API_KEY.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["INVALID_API_KEY"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"INVALID_API_KEY"}}}},"403":{"description":"Codes: INSUFFICIENT_PERMISSION, entitlement.access_paused, entitlement.feature_disabled.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["INSUFFICIENT_PERMISSION","entitlement.access_paused","entitlement.feature_disabled"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"INSUFFICIENT_PERMISSION"}}}},"404":{"description":"Codes: NOT_FOUND.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["NOT_FOUND"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Resource not found.","code":"NOT_FOUND"}}}},"409":{"description":"Codes: CONFLICT, BANK_REAUTH_REQUIRED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["CONFLICT","BANK_REAUTH_REQUIRED"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"CONFLICT"}}}},"413":{"description":"Codes: REQUEST_TOO_LARGE.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["REQUEST_TOO_LARGE"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"REQUEST_TOO_LARGE"}}}},"429":{"description":"Rate limited; retry after Retry-After seconds. Codes: rate_limit.feature, RATE_LIMITED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["rate_limit.feature","RATE_LIMITED"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"rate_limit.feature"}}},"headers":{"Retry-After":{"schema":{"type":"string"},"example":"60","description":"Seconds to wait before retrying."}}},"500":{"description":"Codes: REQUEST_FAILED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["REQUEST_FAILED"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"REQUEST_FAILED"}}}},"502":{"description":"Codes: INVALID_RESPONSE, UPSTREAM_FAILURE.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["INVALID_RESPONSE","UPSTREAM_FAILURE"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"INVALID_RESPONSE"}}}},"503":{"description":"Codes: UNAVAILABLE.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["UNAVAILABLE"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"UNAVAILABLE"}}}}}}},"/v1/banks/{id}/import-history":{"post":{"operationId":"history","summary":"Import full history","tags":["banks"],"description":"Requires `history:import`. Resource restrictions also apply. Import history.","x-permission":"history:import","security":[{"apiKey":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Z]{2}:.{1,200}$","description":"Bank ID from list_banks, e.g. \"DE:N26\" (country code and bank name).","examples":["DE:N26"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false},"example":{}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"status":{"type":"string","enum":["complete"]},"since":{"anyOf":[{"type":"string","description":"Calendar date (YYYY-MM-DD)","examples":["2026-10-15"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}]},"message":{"type":"string"}},"required":["status","since","message"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","enum":["running"]},"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["status","done","total"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","enum":["consent_required"]},"url":{"type":"string","description":"The bank's connect page in the portal: give it to the user to open."},"bank":{"type":"object","properties":{"name":{"type":"string"},"country":{"anyOf":[{"type":"string","pattern":"^[A-Z]{2}$","description":"ISO 3166-1 alpha-2 country code, e.g. DE","examples":["DE"]},{"type":"null"}]}},"required":["name","country"],"additionalProperties":false},"psu_type":{"anyOf":[{"type":"string","enum":["personal","business"]},{"type":"null"}]},"options":{"type":"array","items":{"type":"object","properties":{"country":{"type":"string","pattern":"^[A-Z]{2}$","description":"ISO 3166-1 alpha-2 country code, e.g. DE","examples":["DE"]},"countries":{"type":"array","items":{"type":"string","pattern":"^[A-Z]{2}$","description":"ISO 3166-1 alpha-2 country code, e.g. DE","examples":["DE"]}},"bic":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["country","countries","bic"],"additionalProperties":false}},"instructions":{"type":"string"},"message":{"type":"string"}},"required":["status","url","bank","psu_type","instructions","message"],"additionalProperties":false}]}}}},"400":{"description":"Codes: INVALID_INPUT.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["INVALID_INPUT"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"INVALID_INPUT"}}}},"401":{"description":"Codes: INVALID_API_KEY.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["INVALID_API_KEY"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"INVALID_API_KEY"}}}},"403":{"description":"Codes: INSUFFICIENT_PERMISSION, entitlement.access_paused, entitlement.feature_disabled.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["INSUFFICIENT_PERMISSION","entitlement.access_paused","entitlement.feature_disabled"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"INSUFFICIENT_PERMISSION"}}}},"404":{"description":"Codes: NOT_FOUND.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["NOT_FOUND"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Resource not found.","code":"NOT_FOUND"}}}},"409":{"description":"Codes: CONFLICT.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["CONFLICT"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"CONFLICT"}}}},"413":{"description":"Codes: REQUEST_TOO_LARGE.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["REQUEST_TOO_LARGE"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"REQUEST_TOO_LARGE"}}}},"429":{"description":"Rate limited; retry after Retry-After seconds. Codes: rate_limit.feature, RATE_LIMITED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["rate_limit.feature","RATE_LIMITED"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"rate_limit.feature"}}},"headers":{"Retry-After":{"schema":{"type":"string"},"example":"60","description":"Seconds to wait before retrying."}}},"500":{"description":"Codes: REQUEST_FAILED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["REQUEST_FAILED"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"REQUEST_FAILED"}}}},"502":{"description":"Codes: INVALID_RESPONSE, UPSTREAM_FAILURE.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["INVALID_RESPONSE","UPSTREAM_FAILURE"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"INVALID_RESPONSE"}}}},"503":{"description":"Codes: UNAVAILABLE.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["UNAVAILABLE"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"UNAVAILABLE"}}}}}}},"/v1/banks/{id}/disconnect":{"post":{"operationId":"disconnect","summary":"Disconnect a bank","tags":["banks"],"description":"Requires `banks:disconnect`. Resource restrictions also apply. Disconnect banks.","x-permission":"banks:disconnect","security":[{"apiKey":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Z]{2}:.{1,200}$","description":"Bank ID from list_banks, e.g. \"DE:N26\" (country code and bank name).","examples":["DE:N26"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false},"example":{}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"disconnected":{"type":"string","pattern":"^[A-Z]{2}:.{1,200}$","description":"Bank ID from list_banks, e.g. \"DE:N26\" (country code and bank name).","examples":["DE:N26"]},"consents_revoked":{"type":"integer","minimum":0},"note":{"type":"string"}},"required":["disconnected","consents_revoked","note"],"additionalProperties":false}}}},"400":{"description":"Codes: INVALID_INPUT.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["INVALID_INPUT"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"INVALID_INPUT"}}}},"401":{"description":"Codes: INVALID_API_KEY.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["INVALID_API_KEY"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"INVALID_API_KEY"}}}},"403":{"description":"Codes: INSUFFICIENT_PERMISSION.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["INSUFFICIENT_PERMISSION"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"INSUFFICIENT_PERMISSION"}}}},"404":{"description":"Codes: NOT_FOUND.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["NOT_FOUND"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Resource not found.","code":"NOT_FOUND"}}}},"409":{"description":"Codes: CONFLICT.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["CONFLICT"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"CONFLICT"}}}},"413":{"description":"Codes: REQUEST_TOO_LARGE.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["REQUEST_TOO_LARGE"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"REQUEST_TOO_LARGE"}}}},"429":{"description":"Rate limited; retry after Retry-After seconds. Codes: RATE_LIMITED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["RATE_LIMITED"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Too many requests. Wait a minute and try again.","code":"RATE_LIMITED"}}},"headers":{"Retry-After":{"schema":{"type":"string"},"example":"60","description":"Seconds to wait before retrying."}}},"500":{"description":"Codes: REQUEST_FAILED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["REQUEST_FAILED"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"REQUEST_FAILED"}}}},"502":{"description":"Codes: INVALID_RESPONSE, UPSTREAM_FAILURE.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["INVALID_RESPONSE","UPSTREAM_FAILURE"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"INVALID_RESPONSE"}}}},"503":{"description":"Codes: UNAVAILABLE, CAPABILITY_DISABLED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["UNAVAILABLE","CAPABILITY_DISABLED"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"UNAVAILABLE"}}}}}}},"/v1/merchants/resolve":{"post":{"operationId":"resolve","summary":"Resolve merchants","tags":["merchants"],"description":"Requires `merchants:resolve`. Resource restrictions also apply. Resolve merchants.","x-permission":"merchants:resolve","security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false},"example":{}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["started","already_running","nothing_to_do"]},"pending":{"type":"integer","minimum":0}},"required":["status","pending"],"additionalProperties":false}}}},"400":{"description":"Codes: INVALID_INPUT.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["INVALID_INPUT"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"INVALID_INPUT"}}}},"401":{"description":"Codes: INVALID_API_KEY.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["INVALID_API_KEY"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"INVALID_API_KEY"}}}},"403":{"description":"Codes: INSUFFICIENT_PERMISSION, entitlement.access_paused, entitlement.feature_disabled, RESOURCE_SCOPE_REQUIRED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["INSUFFICIENT_PERMISSION","entitlement.access_paused","entitlement.feature_disabled","RESOURCE_SCOPE_REQUIRED"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"INSUFFICIENT_PERMISSION"}}}},"404":{"description":"Codes: NOT_FOUND.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["NOT_FOUND"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Resource not found.","code":"NOT_FOUND"}}}},"409":{"description":"Codes: CONFLICT, BANK_REAUTH_REQUIRED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["CONFLICT","BANK_REAUTH_REQUIRED"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"CONFLICT"}}}},"413":{"description":"Codes: REQUEST_TOO_LARGE.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["REQUEST_TOO_LARGE"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"REQUEST_TOO_LARGE"}}}},"429":{"description":"Rate limited; retry after Retry-After seconds. Codes: rate_limit.feature, RATE_LIMITED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["rate_limit.feature","RATE_LIMITED"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"rate_limit.feature"}}},"headers":{"Retry-After":{"schema":{"type":"string"},"example":"60","description":"Seconds to wait before retrying."}}},"500":{"description":"Codes: REQUEST_FAILED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["REQUEST_FAILED"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"REQUEST_FAILED"}}}},"502":{"description":"Codes: INVALID_RESPONSE, UPSTREAM_FAILURE.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["INVALID_RESPONSE","UPSTREAM_FAILURE"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"INVALID_RESPONSE"}}}},"503":{"description":"Codes: UNAVAILABLE, CAPABILITY_DISABLED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["UNAVAILABLE","CAPABILITY_DISABLED"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"UNAVAILABLE"}}}}}}},"/v1/merchants/corrections":{"post":{"operationId":"correct","summary":"Correct a merchant","tags":["merchants"],"description":"Requires `merchants:correct`. Resource restrictions also apply. Correct merchants.","x-permission":"merchants:correct","security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":300,"description":"Exact merchant name (counterparty) as it appears on transactions."},"query":{"type":"string","minLength":1,"maxLength":200,"description":"logo.dev search, ideally the brand's website domain, e.g. \"railway.app\"."},"brand":{"anyOf":[{"type":"string","minLength":1,"maxLength":100},{"type":"null"}],"description":"Display name. Omit to keep the current one; null resets it to logo.dev's name."},"category":{"anyOf":[{"type":"string","enum":["groceries","restaurant","coffee","fast_food","food_delivery","bar","bakery","pharmacy","health","beauty","fashion","electronics","home","shopping","software","subscription","music","streaming","entertainment","events","sports","fitness","travel","hotel","transport","taxi","fuel","parking","utilities","telecom","housing","insurance","education","books","pets","gifts","charity","government","other"]},{"type":"null"}],"description":"Omit to keep the current category; null resets it to \"other\"."}},"required":["name","query"],"additionalProperties":false,"examples":[{"name":"EXAMPLE COFFEE","query":"example.com","brand":"Example Coffee","category":"coffee"}]},"example":{"name":"EXAMPLE COFFEE","query":"example.com","brand":"Example Coffee","category":"coffee"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"brand":{"type":"string"},"domain":{"type":"string"},"category":{"type":"string","enum":["groceries","restaurant","coffee","fast_food","food_delivery","bar","bakery","pharmacy","health","beauty","fashion","electronics","home","shopping","software","subscription","music","streaming","entertainment","events","sports","fitness","travel","hotel","transport","taxi","fuel","parking","utilities","telecom","housing","insurance","education","books","pets","gifts","charity","government","other"]}},"required":["name","brand","domain","category"],"additionalProperties":false}}}},"400":{"description":"Codes: INVALID_INPUT.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["INVALID_INPUT"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"INVALID_INPUT"}}}},"401":{"description":"Codes: INVALID_API_KEY.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["INVALID_API_KEY"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"INVALID_API_KEY"}}}},"403":{"description":"Codes: INSUFFICIENT_PERMISSION, entitlement.access_paused, entitlement.feature_disabled, RESOURCE_SCOPE_REQUIRED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["INSUFFICIENT_PERMISSION","entitlement.access_paused","entitlement.feature_disabled","RESOURCE_SCOPE_REQUIRED"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"INSUFFICIENT_PERMISSION"}}}},"404":{"description":"Codes: NOT_FOUND.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["NOT_FOUND"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Resource not found.","code":"NOT_FOUND"}}}},"409":{"description":"Codes: CONFLICT, BANK_REAUTH_REQUIRED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["CONFLICT","BANK_REAUTH_REQUIRED"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"CONFLICT"}}}},"413":{"description":"Codes: REQUEST_TOO_LARGE.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["REQUEST_TOO_LARGE"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"REQUEST_TOO_LARGE"}}}},"429":{"description":"Rate limited; retry after Retry-After seconds. Codes: rate_limit.feature, RATE_LIMITED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["rate_limit.feature","RATE_LIMITED"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"rate_limit.feature"}}},"headers":{"Retry-After":{"schema":{"type":"string"},"example":"60","description":"Seconds to wait before retrying."}}},"500":{"description":"Codes: REQUEST_FAILED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["REQUEST_FAILED"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"REQUEST_FAILED"}}}},"502":{"description":"Codes: UPSTREAM_FAILURE.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["UPSTREAM_FAILURE"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"UPSTREAM_FAILURE"}}}},"503":{"description":"Codes: UNAVAILABLE, CAPABILITY_DISABLED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string","enum":["UNAVAILABLE","CAPABILITY_DISABLED"]},"action":{"type":"string"},"reauthenticate":{"type":"boolean"},"retryable":{"type":"boolean"},"feature":{"type":"string","enum":["read","connect","refresh","history","query","enrich","keys"]},"plan":{"type":"string","enum":["free","pro","business"]},"retry_after":{"type":"integer","minimum":0},"resets_at":{"type":"string"}},"required":["error","code"],"additionalProperties":false},"example":{"error":"Request could not be completed.","code":"UNAVAILABLE"}}}}}}}},"components":{"securitySchemes":{"apiKey":{"type":"http","scheme":"bearer","bearerFormat":"Banking API key"}}}}