{
 "openapi": "3.1.0",
 "info": {
  "title": "Bank Data Recipients (Accounting)",
  "version": "20261030b",
  "description": "What a bank, or an aggregator network, issued this company so it can be signed in to: a client id, a client secret and the redirect URI it declared. The secret is sealed on the way in and never comes back out. Without a row here a bank can still be reached by download credential or through the aggregator."
 },
 "servers": [
  {
   "url": "https://{tenant}.tranxact.ai",
   "variables": {
    "tenant": {
     "default": "demo"
    }
   }
  }
 ],
 "components": {
  "securitySchemes": {
   "bearer": {
    "type": "http",
    "scheme": "bearer"
   }
  },
  "schemas": {
   "bank-data-recipients": {
    "type": "object",
    "required": [
     "network",
     "label"
    ],
    "properties": {
     "id": {
      "type": "string",
      "format": "uuid",
      "description": "Id",
      "readOnly": true
     },
     "org_id": {
      "type": "string",
      "format": "uuid",
      "description": "Org id",
      "readOnly": true
     },
     "org_unit_id": {
      "type": "string",
      "format": "uuid",
      "description": "Org unit id",
      "readOnly": true
     },
     "network": {
      "type": "string",
      "description": "Issued by",
      "enum": [
       "bank",
       "akoya",
       "plaid",
       "finicity",
       "mx",
       "tink",
       "truelayer",
       "sandbox"
      ]
     },
     "institution_id": {
      "type": "string",
      "format": "uuid",
      "description": "One bank only"
     },
     "label": {
      "type": "string",
      "description": "Registration name"
     },
     "environment": {
      "type": "string",
      "description": "Environment",
      "enum": [
       "sandbox",
       "development",
       "production"
      ]
     },
     "client_id": {
      "type": "string",
      "description": "Client id"
     },
     "client_secret_cipher": {
      "type": "string",
      "description": "Client secret cipher",
      "readOnly": true
     },
     "redirect_uri": {
      "type": "string",
      "description": "Redirect URI"
     },
     "authorize_url": {
      "type": "string",
      "description": "Authorization endpoint"
     },
     "token_url": {
      "type": "string",
      "description": "Token endpoint"
     },
     "data_api_base": {
      "type": "string",
      "description": "Data API base"
     },
     "scopes": {
      "type": "array",
      "items": {
       "type": "string"
      },
      "description": "Scopes"
     },
     "is_active": {
      "type": "boolean",
      "description": "Active"
     },
     "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Created at",
      "readOnly": true
     },
     "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Updated at",
      "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_by": {
      "type": "string",
      "format": "uuid",
      "description": "Updated by",
      "readOnly": true
     }
    }
   }
  }
 },
 "security": [
  {
   "bearer": []
  }
 ],
 "paths": {
  "/api/accounting/bank-data-recipients": {
   "get": {
    "summary": "list bank-data-recipients",
    "operationId": "list_bank_data_recipients_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-data-recipients",
    "operationId": "create_bank_data_recipients_1_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/accounting/bank-data-recipients/{id}": {
   "get": {
    "summary": "get bank-data-recipients",
    "operationId": "get_bank_data_recipients_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-data-recipients",
    "operationId": "change_bank_data_recipients_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-data-recipients",
    "operationId": "delete_bank_data_recipients_2_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/accounting/bank-data-recipients/{id}/copy": {
   "post": {
    "summary": "Copy",
    "operationId": "action_bank_data_recipients_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"
     }
    }
   }
  },
  "/api/accounting/bank-data-recipients/{id}/secret": {
   "put": {
    "summary": "Secret",
    "operationId": "action_bank_data_recipients_0_6",
    "description": "Body keys: clientSecret",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  }
 }
}