Form3

Form3 Transaction File API

The Transaction File API API from Form3 — 7 operation(s) for transaction file api.

GitHub OpenAPI

Operations 10

GET /files/transactions List transaction files #
POST /files/transactions Creates a Transaction File #
GET /files/transactions/{transaction_file_id} Fetch transaction file #
PUT /files/transactions/{transaction_file_id} Put Transaction file chunk #
POST /files/transactions/{transaction_file_id}/admissions Creates a Transaction File Admission #
GET /files/transactions/{transaction_file_id}/admissions/{transaction_file_admission_id} Fetch transaction file admission #
POST /files/transactions/{transaction_file_id}/submissions Creates a Transaction File Submission #
GET /files/transactions/{transaction_file_id}/submissions/{transaction_file_submission_id} Fetch transaction file submission #
GET /files/transactions/{transaction_file_id}/submissions/{transaction_file_submission_id}/tasks/{task_id} Fetch transaction file submission task #
PATCH /files/transactions/{transaction_file_id}/submissions/{transaction_file_submission_id}/tasks/{task_id} Amend transaction file submission task #

Documentation

📖
Documentation
https://www.api-docs.form3.tech/
📖
APIReference
https://api-docs.form3.tech/api.html
📖
GettingStarted
https://www.api-docs.form3.tech/api/tutorials/getting-started/introduction
📖
Documentation
https://www.api-docs.form3.tech/api/tutorials/getting-started/send-a-payment
📖
Documentation
https://www.api-docs.form3.tech/api/tutorials/getting-started/receive-a-payment
📖
Documentation
https://www.api-docs.form3.tech/api/tutorials/bacs/receive-a-direct-debit
📖
Documentation
https://www.api-docs.form3.tech/api/tutorials/confirmation-of-payee/cop-tutorial
📖
Documentation
https://www.api-docs.form3.tech/api/tutorials/bacs/send-transactions-in-a-file
📖
Documentation
https://www.api-docs.form3.tech/api/tutorials/event-notifications/subscriptions-for-event-notifications
📖
Documentation
https://www.api-docs.form3.tech/api/tutorials/event-notifications/verify-event-notifications
📖
Documentation
https://www.api-docs.form3.tech/api/tutorials/security/create-a-read-only-user

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/form3/refs/heads/main/openapi/form3-transaction-file-api-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/form3-transaction-file-api-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

form3-transaction-file-api-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Form3 Public Transaction File API
  version: '1'
servers:
- url: https://api.form3.tech/v1
security:
- OAuth2: []
tags:
- name: Transaction File API
paths:
  /files/transactions:
    get:
      operationId: ListTransactionFiles
      parameters:
      - description: Which page to select
        in: query
        name: page[number]
        required: false
        schema:
          type: string
          minimum: 0
          pattern: ^(first|last|[\d]{1,4})$
      - description: Number of items to select
        in: query
        name: page[size]
        required: false
        schema:
          type: integer
          default: 100
          maximum: 1000
          minimum: 0
      - description: Find all File resources with a given organisation ID
        in: query
        name: filter[organisation_id]
        required: false
        schema:
          type: array
          items:
            format: uuid
            type: string
      - description: Find File resources by a certain scheme
        in: query
        name: filter[payment_scheme]
        required: false
        schema:
          type: string
      - description: Find File resources by the format of the file
        in: query
        name: filter[file_format]
        required: false
        schema:
          type: string
      - description: Find all File resources created from this date, in format YYYY-MM-DD
        in: query
        name: filter[created_on_from]
        required: false
        schema:
          type: string
          format: date
      - description: Find all File resources created up to this date, in format YYYY-MM-DD
        in: query
        name: filter[created_on_to]
        required: false
        schema:
          type: string
          format: date
      - description: Find all File resources with a certain submission status
        in: query
        name: filter[submission.status]
        required: false
        schema:
          type: string
      - description: Find all File resources submitted from and including this date/time
        in: query
        name: filter[submission.submission_date_from]
        required: false
        schema:
          type: string
          format: date-time
      - description: Find all File resources submitted up to and included this date/time
        in: query
        name: filter[submission.submission_date_to]
        required: false
        schema:
          type: string
          format: date-time
      - description: Find File resources the id of the submission to to the scheme
        in: query
        name: filter[submission.scheme_references.file_identifier]
        required: false
        schema:
          type: string
      - description: Find File resources by the id of the file sent to the scheme
        in: query
        name: filter[submission.scheme_references.file_number]
        required: false
        schema:
          type: string
      - description: Find File resources by the Service User Number (SUN) of the payment originator
        in: query
        name: filter[submission.scheme_references.clearing_id]
        required: false
        schema:
          type: string
      - description: Find all File resources with a certain admission status
        in: query
        name: filter[admission.status]
        required: false
        schema:
          type: string
      - description: Find all File resources admitted from and including this date/time
        in: query
        name: filter[admission.admission_date_from]
        required: false
        schema:
          type: string
          format: date-time
      - description: Find all File resources admitted up to and included this date/time
        in: query
        name: filter[admission.admission_date_to]
        required: false
        schema:
          type: string
          format: date-time
      responses:
        200:
          description: List of transaction files
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ListTransactionFilesResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ListTransactionFilesResponse'
        400:
          description: Reports bad request
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        401:
          description: Unauthorized
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        403:
          description: Forbidden
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        500:
          description: Internal Server Error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      summary: List transaction files
      tags:
      - Transaction File API
      x-access:
      - Public
    post:
      operationId: CreateTransactionFile
      responses:
        201:
          description: Transaction File Creation Response
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/TransactionFileResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionFileResponse'
        400:
          description: Bad Request
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        401:
          description: Unauthorized
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        403:
          description: Forbidden
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        409:
          description: Conflict
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        500:
          description: Internal Server Error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      summary: Creates a Transaction File
      tags:
      - Transaction File API
      x-access:
      - Public
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TransactionFileCreation'
  /files/transactions/{transaction_file_id}:
    get:
      operationId: GetTransactionFile
      parameters:
      - description: Transaction File Id
        in: path
        name: transaction_file_id
        required: true
        schema:
          type: string
          format: uuid
      - description: Acceptable Formats, possible values are "application/vnd.api+json", "application/x-ndjson", "application/x.form3.standard18", "application/xml", "application/x.form3.messaging"
        in: header
        name: Accept
        required: false
        schema:
          type: string
      responses:
        200:
          description: Transaction File Response
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/TransactionFileResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionFileResponse'
        401:
          description: Unauthorized
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        403:
          description: Forbidden
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        404:
          description: Not Found
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        500:
          description: Internal Server Error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      summary: Fetch transaction file
      tags:
      - Transaction File API
      x-access:
      - Public
    put:
      operationId: UploadTransactionFile
      parameters:
      - description: Transaction File Id
        in: path
        name: transaction_file_id
        required: true
        schema:
          type: string
          format: uuid
      - description: Which part of the file we are uploading
        in: header
        name: X-Form3-Upload-Part
        required: true
        schema:
          type: string
      responses:
        200:
          description: Transaction File Response
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/TransactionFileResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionFileResponse'
        400:
          description: Bad Request
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        401:
          description: Unauthorized
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        403:
          description: Forbidden
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        404:
          description: Transaction File Not Found
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        409:
          description: Transaction File Conflict
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        500:
          description: Internal Server Error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      summary: Put Transaction file chunk
      tags:
      - Transaction File API
      x-access:
      - Public
      requestBody:
        content:
          application/octet-stream:
            schema:
              format: binary
              type: string
        required: true
  /files/transactions/{transaction_file_id}/admissions:
    post:
      operationId: CreateTransactionFileAdmission
      parameters:
      - description: Transaction File Id
        in: path
        name: transaction_file_id
        required: true
        schema:
          type: string
          format: uuid
      responses:
        201:
          description: Transaction File Admission Response
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/TransactionFileAdmissionResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionFileAdmissionResponse'
        400:
          description: Bad Request
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        401:
          description: Unauthorized
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        403:
          description: Forbidden
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        404:
          description: Not Found
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        409:
          description: Transaction File Admission Conflict
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        500:
          description: Internal Server Error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      summary: Creates a Transaction File Admission
      tags:
      - Transaction File API
      x-access:
      - Public
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TransactionFileAdmissionCreation'
  /files/transactions/{transaction_file_id}/admissions/{transaction_file_admission_id}:
    get:
      operationId: GetTransactionFileAdmission
      parameters:
      - description: Transaction File Id
        in: path
        name: transaction_file_id
        required: true
        schema:
          type: string
          format: uuid
      - description: Transaction File Admission Id
        in: path
        name: transaction_file_admission_id
        required: true
        schema:
          type: string
          format: uuid
      responses:
        200:
          description: Transaction File Admission Response
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/TransactionFileAdmissionResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionFileAdmissionResponse'
        401:
          description: Unauthorized
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        403:
          description: Forbidden
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        404:
          description: Not Found
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        500:
          description: Internal Server Error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      summary: Fetch transaction file admission
      tags:
      - Transaction File API
      x-access:
      - Public
  /files/transactions/{transaction_file_id}/submissions:
    post:
      operationId: CreateTransactionFileSubmission
      parameters:
      - description: Transaction File Id
        in: path
        name: transaction_file_id
        required: true
        schema:
          type: string
          format: uuid
      responses:
        201:
          description: Transaction File Submission Response
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/TransactionFileSubmissionResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionFileSubmissionResponse'
        400:
          description: Bad Request
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        401:
          description: Unauthorized
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        403:
          description: Forbidden
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        404:
          description: Not Found
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        409:
          description: Transaction File Submission Conflict
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/TransactionFileSubmissionConflictError'
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionFileSubmissionConflictError'
        500:
          description: Internal Server Error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      summary: Creates a Transaction File Submission
      tags:
      - Transaction File API
      x-access:
      - Public
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TransactionFileSubmissionCreation'
  /files/transactions/{transaction_file_id}/submissions/{transaction_file_submission_id}:
    get:
      operationId: GetTransactionFileSubmission
      parameters:
      - description: Transaction File Id
        in: path
        name: transaction_file_id
        required: true
        schema:
          type: string
          format: uuid
      - description: Transaction File Submission Id
        in: path
        name: transaction_file_submission_id
        required: true
        schema:
          type: string
          format: uuid
      responses:
        200:
          description: Transaction File Submission Response
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/TransactionFileSubmissionResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionFileSubmissionResponse'
        401:
          description: Unauthorized
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        403:
          description: Forbidden
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        404:
          description: Not Found
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        500:
          description: Internal Server Error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      summary: Fetch transaction file submission
      tags:
      - Transaction File API
      x-access:
      - Public
  /files/transactions/{transaction_file_id}/submissions/{transaction_file_submission_id}/tasks/{task_id}:
    parameters:
    - description: Transaction File Id
      in: path
      name: transaction_file_id
      required: true
      schema:
        type: string
        format: uuid
    - description: Transaction File Submission Id
      in: path
      name: transaction_file_submission_id
      required: true
      schema:
        type: string
        format: uuid
    - description: Transaction File Submission Task Id
      in: path
      name: task_id
      required: true
      schema:
        type: string
        format: uuid
    get:
      operationId: GetTransactionFileSubmissionTask
      responses:
        200:
          description: Transaction File Submission Task Response
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/TransactionFileSubmissionTaskResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionFileSubmissionTaskResponse'
        401:
          description: Unauthorized
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        403:
          description: Forbidden
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        404:
          description: Not Found
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        500:
          description: Internal Server Error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      summary: Fetch transaction file submission task
      tags:
      - Transaction File API
      x-access:
      - Public
    patch:
      operationId: PatchTransactionFileSubmissionTask
      responses:
        200:
          description: Transaction File Submission Task Updated
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/TransactionFileSubmissionTaskResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionFileSubmissionTaskResponse'
        400:
          description: Bad Request
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        403:
          description: Forbidden
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        404:
          description: Not Found
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        409:
          description: Conflict
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiErrorWithActualResource'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorWithActualResource'
        500:
          description: Internal Server Error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      summary: Amend transaction file submission task
      tags:
      - Transaction File API
      x-access:
      - Public
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TransactionFileSubmissionTaskAmendment'
components:
  schemas:
    TransactionFileSubmissionTask:
      properties:
        attributes:
          $ref: '#/components/schemas/TransactionFileSubmissionTaskAttributes'
          x-order: 7
        created_on:
          example: '2017-09-26T15:26:57.494Z'
          format: date-time
          readOnly: true
          type: string
          x-order: 5
        id:
          format: uuid
          type: string
          x-order: 1
        modified_on:
          example: '2017-09-26T15:26:57.494Z'
          format: date-time
          readOnly: true
          type: string
          x-order: 6
        organisation_id:
          description: Unique ID of the organisation this resource is created by
          example: ee2fb143-6dfe-4787-b183-ca8ddd4164d2
          format: uuid
          type: string
          x-order: 3
        relationships:
          $ref: '#/components/schemas/TransactionFileSubmissionTaskRelationships'
          readOnly: true
        type:
          enum:
          - transaction_file_submission_tasks
          type: string
          x-order: 2
        version:
          description: Version number
          example: 0
          minimum: 0
          type: integer
          x-order: 4
      required:
      - id
      - organisation_id
      type: object
      x-access:
      - Public
    TransactionFileSubmissionTaskStatus:
      description: Processing status of the task
      enum:
      - pending
      - on_hold
      - completed
      - failed
      example: pending
      readOnly: true
      type: string
      x-access:
      - Public
    TransactionFileResponse:
      properties:
        data:
          $ref: '#/components/schemas/TransactionFile'
        links:
          $ref: '#/components/schemas/TransactionFileLinks'
      type: object
      x-access:
      - Public
    TransactionFileAdmission:
      properties:
        attributes:
          properties:
            admission_datetime:
              description: Time when the Form3 system begins processing of the admission
              example: '2019-03-13T14:48:29.699Z'
              format: date-time
              readOnly: true
              type: string
            status:
              $ref: '#/components/schemas/TransactionFileAdmissionStatus'
            status_reason:
              description: Plain-text description of the status attribute
              example: accepted
              readOnly: true
              type: string
            transaction_start_datetime:
              description: Time the admission request was received by Form3. Used to compute the total transaction time
              example: '2019-03-13T14:48:29.694Z'
              format: date-time
              readOnly: true
              type: string
          type: object
          x-order: 7
        created_on:
          example: '2017-09-26T15:26:57.494Z'
          format: date-time
          readOnly: true
          type: string
          x-order: 5
        id:
          format: uuid
          type: string
          x-order: 1
        modified_on:
          example: '2017-09-26T15:26:57.494Z'
          format: date-time
          readOnly: true
          type: string
          x-order: 6
        organisation_id:
          description: Unique ID of the organisation this resource is created by
          example: ee2fb143-6dfe-4787-b183-ca8ddd4164d2
          format: uuid
          type: string
          x-order: 3
        relationships:
          $ref: '#/components/schemas/TransactionFileAdmissionRelationships'
          readOnly: true
        type:
          enum:
          - transaction_file_admissions
          type: string
          x-order: 2
        version:
          description: Version number
          example: 0
          minimum: 0
          type: integer
          x-order: 4
      required:
      - id
      - organisation_id
      type: object
      x-access:
      - Public
    TransactionFileSubmission:
      properties:
        attributes:
          properties:
            scheme_references:
              description: Summary of scheme-specific references submission to the scheme
              items:
                $ref: '#/components/schemas/TransactionFileSubmissionSchemeReference'
              type: array
            status:
              $ref: '#/components/schemas/TransactionFileSubmissionStatus'
            status_reason:
              description: Plain-text description of the status attribute
              example: transaction_files.data.attributes.transaction_count does not match file
              readOnly: true
              type: string
            submission_datetime:
              description: Time when the Form3 system begins processing of the submission
              example: '2019-03-13T14:48:29.699Z'
              format: date-time
              readOnly: true
              type: string
            transaction_start_datetime:
              description: Time the submission request was received by Form3. Used to compute the total transaction time
              example: '2019-03-13T14:48:29.694Z'
              format: date-time
              readOnly: true
              type: string
            transaction_validation_error_handling:
              description: Determines how a transaction file should be processed when validation errors are present
              enum:
              - reject_entire_file
              - reject_invalid_transactions
              type: string
          type: object
          x-order: 7
        created_on:
          example: '2017-09-26T15:26:57.494Z'
          format: date-time
          readOnly: tru

# --- truncated at 32 KB (49 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/form3/refs/heads/main/openapi/form3-transaction-file-api-api-openapi.yml