{
 "openapi": "3.1.0",
 "info": {
  "title": "Bank Catalogue (Accounting)",
  "version": "20261030b",
  "description": "Which banks can be connected and how: a sign-in on the bank’s own site, the bank’s own download service, or through the aggregator. Where a bank offers a sign-in, its authorization and token endpoints belong here — they come from the developer portal with the client credentials."
 },
 "servers": [
  {
   "url": "https://{tenant}.tranxact.ai",
   "variables": {
    "tenant": {
     "default": "demo"
    }
   }
  }
 ],
 "components": {
  "securitySchemes": {
   "bearer": {
    "type": "http",
    "scheme": "bearer"
   }
  },
  "schemas": {
   "bank-catalogue": {
    "type": "object",
    "required": [
     "code",
     "name"
    ],
    "properties": {
     "id": {
      "type": "string",
      "format": "uuid",
      "description": "Id",
      "readOnly": true
     },
     "org_id": {
      "type": "string",
      "format": "uuid",
      "description": "Org id",
      "readOnly": true
     },
     "code": {
      "type": "string",
      "description": "Bank code"
     },
     "name": {
      "type": "string",
      "description": "Legal name"
     },
     "short_name": {
      "type": "string",
      "description": "Short name"
     },
     "country": {
      "type": "string",
      "description": "Country"
     },
     "external_id": {
      "type": "string",
      "description": "External id"
     },
     "aggregator": {
      "type": "string",
      "description": "Aggregator"
     },
     "brand_color": {
      "type": "string",
      "description": "Brand colour"
     },
     "initials": {
      "type": "string",
      "description": "Initials"
     },
     "provider_id": {
      "type": "string",
      "format": "uuid",
      "description": "Provider id"
     },
     "auth_flow": {
      "type": "string",
      "description": "Aggregator sign-in",
      "enum": [
       "credentials",
       "oauth"
      ]
     },
     "needs_mfa": {
      "type": "boolean",
      "description": "Asks a second question"
     },
     "products": {
      "type": "array",
      "items": {
       "type": "string"
      },
      "description": "Products"
     },
     "popularity": {
      "type": "integer",
      "description": "Rank on the front page"
     },
     "is_active": {
      "type": "boolean",
      "description": "Offered"
     },
     "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Created at",
      "readOnly": true
     },
     "supports_direct_connect": {
      "type": "boolean",
      "description": "Runs its own download service"
     },
     "ofx_url": {
      "type": "string",
      "description": "OFX endpoint"
     },
     "ofx_org": {
      "type": "string",
      "description": "OFX organization"
     },
     "ofx_fid": {
      "type": "string",
      "description": "OFX financial institution id"
     },
     "ofx_version": {
      "type": "integer",
      "description": "OFX version"
     },
     "ofx_app_id": {
      "type": "string",
      "description": "Ofx app id",
      "readOnly": true
     },
     "ofx_app_ver": {
      "type": "string",
      "description": "Ofx app ver",
      "readOnly": true
     },
     "credential_label": {
      "type": "string",
      "description": "What the bank calls the credential"
     },
     "credential_help": {
      "type": "string",
      "description": "How to get one"
     },
     "enrolment_url": {
      "type": "string",
      "description": "Where to enrol"
     },
     "credential_ttl_days": {
      "type": "integer",
      "description": "Credential lasts (days)"
     },
     "supports_oauth": {
      "type": "boolean",
      "description": "Offers a sign-in on its own site"
     },
     "oauth_network": {
      "type": "string",
      "description": "Reached through",
      "enum": [
       "bank",
       "akoya",
       "plaid",
       "finicity",
       "mx",
       "tink",
       "truelayer",
       "sandbox"
      ]
     },
     "oauth_authorize_url": {
      "type": "string",
      "description": "Authorization endpoint"
     },
     "oauth_token_url": {
      "type": "string",
      "description": "Token endpoint"
     },
     "oauth_scopes": {
      "type": "array",
      "items": {
       "type": "string"
      },
      "description": "Scopes"
     },
     "data_api_base": {
      "type": "string",
      "description": "Data API base"
     },
     "data_api_standard": {
      "type": "string",
      "description": "Data API dialect",
      "enum": [
       "fdx",
       "plaid",
       "custom"
      ]
     },
     "oauth_uses_pkce": {
      "type": "boolean",
      "description": "Uses PKCE"
     },
     "developer_url": {
      "type": "string",
      "description": "Where to register"
     },
     "consent_ttl_days": {
      "type": "integer",
      "description": "Consent lasts (days)"
     },
     "org_unit_id": {
      "type": "string",
      "format": "uuid",
      "description": "Org unit id",
      "readOnly": true
     },
     "xf_text_1": {
      "type": "string",
      "description": "Xf text 1",
      "readOnly": true
     },
     "xf_text_2": {
      "type": "string",
      "description": "Xf text 2",
      "readOnly": true
     },
     "xf_text_3": {
      "type": "string",
      "description": "Xf text 3",
      "readOnly": true
     },
     "xf_text_4": {
      "type": "string",
      "description": "Xf text 4",
      "readOnly": true
     },
     "xf_text_5": {
      "type": "string",
      "description": "Xf text 5",
      "readOnly": true
     },
     "xf_num_1": {
      "type": "string",
      "format": "decimal",
      "description": "Xf num 1",
      "readOnly": true
     },
     "xf_num_2": {
      "type": "string",
      "format": "decimal",
      "description": "Xf num 2",
      "readOnly": true
     },
     "xf_num_3": {
      "type": "string",
      "format": "decimal",
      "description": "Xf num 3",
      "readOnly": true
     },
     "xf_date_1": {
      "type": "string",
      "format": "date",
      "description": "Xf date 1",
      "readOnly": true
     },
     "xf_date_2": {
      "type": "string",
      "format": "date",
      "description": "Xf date 2",
      "readOnly": true
     },
     "created_by": {
      "type": "string",
      "format": "uuid",
      "description": "Created by",
      "readOnly": true
     },
     "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Updated at",
      "readOnly": true
     },
     "updated_by": {
      "type": "string",
      "format": "uuid",
      "description": "Updated by",
      "readOnly": true
     }
    }
   }
  }
 },
 "security": [
  {
   "bearer": []
  }
 ],
 "paths": {
  "/api/accounting/bank-catalogue": {
   "get": {
    "summary": "list bank-catalogue",
    "operationId": "list_bank_catalogue_0_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "post": {
    "summary": "create bank-catalogue",
    "operationId": "create_bank_catalogue_1_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/accounting/bank-catalogue/{id}": {
   "get": {
    "summary": "get bank-catalogue",
    "operationId": "get_bank_catalogue_0_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "put": {
    "summary": "change bank-catalogue",
    "operationId": "change_bank_catalogue_1_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "delete": {
    "summary": "delete bank-catalogue",
    "operationId": "delete_bank_catalogue_2_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/accounting/bank-catalogue/{id}/copy": {
   "post": {
    "summary": "Copy",
    "operationId": "action_bank_catalogue_0_6",
    "description": "Body keys: overrides, preview, withLines",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  }
 }
}