Form3

Form3 Query API

The query_api API from Form3 — 10 operation(s) for query_api.

GitHub OpenAPI

Operations 11

GET /transaction/queries Get Query #
POST /transaction/queries Create a Query #
GET /transaction/queries/{query_id} Fetch a Query #
GET /transaction/queries/{query_id}/admissions/{query_admission_id} Fetch a Query Admission #
POST /transaction/queries/{query_id}/responses Create a Query Response #
GET /transaction/queries/{query_id}/responses/{query_response_id} Fetch a Query Response #
GET /transaction/queries/{query_id}/responses/{query_response_id}/admissions/{query_response_admission_id} Fetch a Query Response Admission #
POST /transaction/queries/{query_id}/responses/{query_response_id}/submissions Create a Query Response Submission #
GET /transaction/queries/{query_id}/responses/{query_response_id}/submissions/{query_response_submission_id} Fetch a Query Response Submission #
POST /transaction/queries/{query_id}/submissions Create a Query submission #
GET /transaction/queries/{query_id}/submissions/{query_submission_id} Fetch a Query submission #

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-query-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-query-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-query-api-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Form3 Public Query API
  version: '1'
servers:
- url: https://api.form3.tech/v1
security:
- OAuth2: []
tags:
- name: query_api
paths:
  /transaction/queries:
    get:
      operationId: ListQueries
      parameters:
      - description: The organisations to filter on
        in: query
        name: filter[organisation_id]
        schema:
          type: array
          items:
            format: uuid
            type: string
      - description: Find all queries for a given status
        in: query
        name: filter[status]
        schema:
          type: string
          enum:
          - pending
          - closed
      - description: Find all queries for a given query type
        in: query
        name: filter[query_type]
        schema:
          type: string
      - description: Find all queries for given auto handled flag
        in: query
        name: filter[auto_handled]
        schema:
          type: boolean
      - description: Find all queries from a certain value date.
        in: query
        name: filter[processing_date_from]
        schema:
          type: string
          format: date
      - description: Find all queries up to a certain value date.
        in: query
        name: filter[processing_date_to]
        schema:
          type: string
          format: date
      - description: Find all queries from a certain created date.
        in: query
        name: filter[created_on_from]
        schema:
          type: string
          format: date-time
      - description: Find all queries up to a certain created date.
        in: query
        name: filter[created_on_to]
        schema:
          type: string
          format: date-time
      - description: Find all queries with a certain payment id.
        in: query
        name: filter[payment.id]
        schema:
          type: string
          format: uuid
      - description: Find all queries with a certain payment admission id.
        in: query
        name: filter[payment_admission.id]
        schema:
          type: string
          format: uuid
      - description: Find all queries with a certain payment submission id.
        in: query
        name: filter[payment_submission.id]
        schema:
          type: string
          format: uuid
      - description: Find all queries with a certain recall id.
        in: query
        name: filter[recall.id]
        schema:
          type: string
          format: uuid
      - description: Find all queries with a certain recall submission id.
        in: query
        name: filter[recall_submission.id]
        schema:
          type: string
          format: uuid
      - description: Find all queries with a certain query id.
        in: query
        name: filter[query.id]
        schema:
          type: string
          format: uuid
      - description: Which page to select
        in: query
        name: page[number]
        schema:
          type: string
          minimum: 0
          pattern: ^[A-z0-9]{4}$
      - description: Number of items to select
        in: query
        name: page[size]
        schema:
          type: integer
          maximum: 1000
          minimum: 0
      responses:
        200:
          description: Query response
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/QueryListResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/QueryListResponse'
        400:
          description: Query bad request
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        502:
          description: Query gateway issue
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      summary: Get Query
      tags:
      - query_api
      x-access:
      - Public
    post:
      operationId: CreateQuery
      responses:
        201:
          description: creation response
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/QueryFetchResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/QueryFetchResponse'
        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'
        502:
          description: gateway issue
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      summary: Create a Query
      tags:
      - query_api
      x-access:
      - Public
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/QueryCreation'
          application/json:
            schema:
              $ref: '#/components/schemas/QueryCreation'
  /transaction/queries/{query_id}:
    get:
      operationId: GetQuery
      parameters:
      - description: Query ID
        in: path
        name: query_id
        required: true
        schema:
          type: string
          format: uuid
      responses:
        200:
          description: query response
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/QueryFetchResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/QueryFetchResponse'
        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'
      summary: Fetch a Query
      tags:
      - query_api
      x-access:
      - Public
  /transaction/queries/{query_id}/admissions/{query_admission_id}:
    get:
      operationId: GetQueryAdmission
      parameters:
      - description: Query ID
        in: path
        name: query_id
        required: true
        schema:
          type: string
          format: uuid
      - description: Query Admission ID
        in: path
        name: query_admission_id
        required: true
        schema:
          type: string
          format: uuid
      responses:
        200:
          description: query admission response
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/QueryAdmissionResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/QueryAdmissionResponse'
        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'
      summary: Fetch a Query Admission
      tags:
      - query_api
      x-access:
      - Public
  /transaction/queries/{query_id}/responses:
    post:
      operationId: CreateQueryResponse
      parameters:
      - description: Query ID
        in: path
        name: query_id
        required: true
        schema:
          type: string
          format: uuid
      responses:
        201:
          description: creation response
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/QueryResponseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/QueryResponseResponse'
        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'
        502:
          description: gateway issue
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      summary: Create a Query Response
      tags:
      - query_api
      x-access:
      - Public
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/QueryResponseCreation'
          application/json:
            schema:
              $ref: '#/components/schemas/QueryResponseCreation'
  /transaction/queries/{query_id}/responses/{query_response_id}:
    get:
      operationId: GetQueryResponse
      parameters:
      - description: Query ID
        in: path
        name: query_id
        required: true
        schema:
          type: string
          format: uuid
      - description: Query Response ID
        in: path
        name: query_response_id
        required: true
        schema:
          type: string
          format: uuid
      responses:
        200:
          description: Query Response Response
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/QueryResponseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/QueryResponseResponse'
        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'
      summary: Fetch a Query Response
      tags:
      - query_api
      x-access:
      - Public
  /transaction/queries/{query_id}/responses/{query_response_id}/admissions/{query_response_admission_id}:
    get:
      operationId: GetQueryResponseAdmission
      parameters:
      - description: Query ID
        in: path
        name: query_id
        required: true
        schema:
          type: string
          format: uuid
      - description: Query Response ID
        in: path
        name: query_response_id
        required: true
        schema:
          type: string
          format: uuid
      - description: Query Response Admission ID
        in: path
        name: query_response_admission_id
        required: true
        schema:
          type: string
          format: uuid
      responses:
        200:
          description: query response admission response
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/QueryResponseAdmissionResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/QueryResponseAdmissionResponse'
        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'
      summary: Fetch a Query Response Admission
      tags:
      - query_api
      x-access:
      - Public
  /transaction/queries/{query_id}/responses/{query_response_id}/submissions:
    post:
      operationId: CreateQueryResponseSubmission
      parameters:
      - description: Query ID
        in: path
        name: query_id
        required: true
        schema:
          type: string
          format: uuid
      - description: Query Response ID
        in: path
        name: query_response_id
        required: true
        schema:
          type: string
          format: uuid
      responses:
        201:
          description: creation response
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/QueryResponseSubmissionResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/QueryResponseSubmissionResponse'
        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'
        502:
          description: gateway issue
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      summary: Create a Query Response Submission
      tags:
      - query_api
      x-access:
      - Public
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/QueryResponseSubmissionCreation'
          application/json:
            schema:
              $ref: '#/components/schemas/QueryResponseSubmissionCreation'
  /transaction/queries/{query_id}/responses/{query_response_id}/submissions/{query_response_submission_id}:
    get:
      operationId: GetQueryResponseSubmission
      parameters:
      - description: Query ID
        in: path
        name: query_id
        required: true
        schema:
          type: string
          format: uuid
      - description: Query Response ID
        in: path
        name: query_response_id
        required: true
        schema:
          type: string
          format: uuid
      - description: Query Response Submission ID
        in: path
        name: query_response_submission_id
        required: true
        schema:
          type: string
          format: uuid
      responses:
        200:
          description: query response submission response
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/QueryResponseSubmissionResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/QueryResponseSubmissionResponse'
        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'
      summary: Fetch a Query Response Submission
      tags:
      - query_api
      x-access:
      - Public
  /transaction/queries/{query_id}/submissions:
    post:
      operationId: CreateQuerySubmission
      parameters:
      - description: Query ID
        in: path
        name: query_id
        required: true
        schema:
          type: string
          format: uuid
      responses:
        201:
          description: creation response
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/QuerySubmissionResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/QuerySubmissionResponse'
        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'
        502:
          description: gateway issue
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      summary: Create a Query submission
      tags:
      - query_api
      x-access:
      - Public
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/QuerySubmissionCreation'
          application/json:
            schema:
              $ref: '#/components/schemas/QuerySubmissionCreation'
  /transaction/queries/{query_id}/submissions/{query_submission_id}:
    get:
      operationId: GetQuerySubmission
      parameters:
      - description: Query ID
        in: path
        name: query_id
        required: true
        schema:
          type: string
          format: uuid
      - description: Query Submission ID
        in: path
        name: query_submission_id
        required: true
        schema:
          type: string
          format: uuid
      responses:
        200:
          description: query submission response
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/QuerySubmissionResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/QuerySubmissionResponse'
        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'
      summary: Fetch a Query submission
      tags:
      - query_api
      x-access:
      - Public
components:
  schemas:
    RelationshipsQuery:
      properties:
        data:
          items:
            $ref: '#/components/schemas/RelationshipsQueryProperties'
          type: array
      type: object
      x-access:
      - Public
    QueryResponseAnswer:
      enum:
      - accepted
      - rejected
      - pending
      - already_applied
      - modified_as_requested
      - transaction_not_received
      - transaction_rejected
      - transaction_returned
      - transaction_not_processed
      - rejected_regulatory_reason
      type: string
      x-access:
      - Public
      x-parent: data.attributes
    RequestForInformationReferences:
      items:
        properties:
          type:
            type: string
          value:
            type: string
        required:
        - type
        - value
        type: object
      type: array
      x-access:
      - Public
    QueryResponseSubmissionCreation:
      properties:
        data:
          $ref: '#/components/schemas/NewQueryResponseSubmission'
      required:
      - data
      type: object
      x-access:
      - Public
    QueryResponseAttributes:
      properties:
        answer:
          $ref: '#/components/schemas/QueryResponseAnswer'
        charges:
          $ref: '#/components/schemas/QueryResponseCharges'
        compensation:
          $ref: '#/components/schemas/QueryResponseCompensation'
        compensation_amount:
          type: string
          x-parent: data.attributes
        currency:
          type: string
          x-parent: data.attributes
        information:
          $ref: '#/components/schemas/QueryResponseInformation'
        status_code:
          $ref: '#/components/schemas/QueryResponseStatusCode'
      required:
      - answer
      type: object
      x-access:
      - Public
      x-parent: data
    RelationshipsPaymentAdmissionProperties:
      properties:
        id:
          description: The payment admission associated with this query
          format: uuid
          type: string
        type:
          $ref: '#/components/schemas/PaymentAdmissionResourceType'
      required:
      - id
      - type
      type: object
      x-access:
      - Public
    RelationshipQueryResponseAdmission:
      properties:
        data:
          items:
            $ref: '#/components/schemas/QueryResponseAdmission'
          type: array
      type: object
      x-access:
      - Public
    QuerySubmissionCreation:
      properties:
        data:
          $ref: '#/components/schemas/NewQuerySubmission'
      required:
      - data
      type: object
      x-access:
      - Public
    Links:
      properties:
        first:
          description: Link to the first resource in the list
          example: https://api.test.form3.tech/v1/api_name/resource_type
          type:
          - string
          - 'null'
        last:
          description: Link to the last resource in the list
          example: https://api.test.form3.tech/v1/api_name/resource_type
          type:
          - string
          - 'null'
        next:
          description: Link to the next resource in the list
          example: https://api.test.form3.tech/v1/api_name/resource_type
          type:
          - string
          - 'null'
        prev:
          description: Link to the previous resource in the list
          example: https://api.test.form3.tech/v1/api_name/resource_type
          type:
          - string
          - 'null'
        self:
          description: Link to this resource type
          example: https://api.test.form3.tech/v1/api_name/resource_type
          type: string
      required:
      - self
      type: object
      x-access:
      - Public
    QueryBeneficiaryDebtorOrganisationIdentification:
      properties:
        identification:
          description: Another ID of the organisation
          example: H7FNTJ4851HG0EXQ1Z70
          maxLength: 35
          type: string
          x-length: 35
          x-omitempty: true
        identification_code:
          description: Code for the type of other ID of organisation
          example: LEI
          type: string
          x-length: 5
          x-omitempty: true
        identification_issuer:
          description: Issuer of the other ID of organisation
          example: London Stock Exchange
          maxLength: 35
          type: string
          x-length: 35
          x-omitempty: true
        identification_scheme:
          description: Custom internal code for the type of other ID of organisation
          example: Custom code
          maxLength: 35
          type: string
          x-length: 35
          x-omitempty: true
      type: object
      x-access:
      - Public
    RelationshipsQueryResponseProperties:
      properties:
        id:
          description: The Query Response ID
          format: uuid
          type: string
        type:
          $ref: '#/components/schemas/QueryResponseResourceType'
      required:
      - id
      - type
      type: object
      x-access:
      - Public
    RelationshipsFullQueryResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/QueryResponse'
          type: array
      type: object
      x-access:
      - Public
    RelationshipsPaymentSubmission:
      properties:
        data:
          items:
            $ref: '#/components/schemas/RelationshipsPaymentSubmissionProperties'
          type: array
      type: object
      x-access:
      - Public
    QueryResponseResponse:
      properties:
        data:
          $ref: '#/components/schemas/QueryResponse'
        links:
          $ref: '#/components/schemas/Links'
      required:
      - data
      type: object
      x-access:
      - Public
    RelationshipsQueryAdmission:
      properties:
        data:
          items:
            $ref: '#/components/schemas/QueryAdmission'
          type: array
      type: object
      x-access:
      - Public
    RelationshipsPaymentSubmissionProperties:
      properties:
        id:
          description: The payment submission associated with this query
          format: uuid
          type: string
        type:
          $ref: '#/components/schemas/PaymentSubmissionResourceType'
      required:
      - id
      - type
      type: object
      x-access:
      - Public
    QuerySubmissionRelationships:
      properties:
        query:
          $ref: '#/components/schemas/RelationshipsQuery'
      required:
      - query
      type: object
      x-access:
      - Public
    QueryResourceType:
      enum:
      - queries
      type: string
      x-access:
      - Public
    QueryResponseRelationships:
      properties:
        query:
          $ref: '#/components/schemas/RelationshipsFullQuery'
        query_response_admission:
          $ref: '#/components/schemas/RelationshipQueryResponseAdmission'
        query_response_submission:
          $ref: '#/components/schemas/RelationshipQueryResponseSubmission'
      type: object
      x-access:
      - Public
    Query:
      properties:
        attributes:
          $ref: '#/components/schemas/QueryAttributes'
          x-order: 7
        created_on:
          format: date-time
          type: string
          x-order: 5
        id:
          format: uuid
          type: string
          x-order: 2
        modified_on:
          format: date-time
          type: string
          x-order: 6
        organisation_id:
          format: uuid
          type: string
          x-order: 4
        relationships:
          $ref: '#/components/schemas/QueryRelationships'
          x-order: 8
        type:
          $ref: '#/components/schemas/QueryResourceType'
          x-order: 1
        version:
          minimum: 0
          type: integer
          x-order: 3
      required:
      - id
      - organisation_id
      - type
      - attributes
      - version
      type: object
      x-access:
      - Public
    RelationshipsPaymentProperties:
      properties:
        id:
          description: The payment associated with this query
          format: uuid
          type: string
        type:
          $ref: '#/components/schemas/PaymentResourceType'
      required:
      - id
      - type
      type: object
      x-access:
      - Public
    RequestForInformationAgents:
      items:
        properties:
          identification:
            allOf:
            - $ref: '#/components/schemas/RequestForInformationAgentBankId'
            - properties:
                bank_ids:
                  items:
                    $ref: '#/components/schemas/RequestForInformationAgentBankId'
                  type: array
                  x-omitempty: true
              type: object
            type: object
          role:
            type: string
        type: object
      type: array
      x-access:
      - Public
    RelationshipsQuerySubmission:
      properties:
        data:
          items:
            $ref: '#/components/schemas/QuerySubmission'
          type: array
      type: object
      x-access:
      - Public
    NewQuerySubmission:
      properties:
        id:
          format: uuid
          type: string
        organisation_id:
          format: uuid
          type: string
        type:
          $ref: '#/components/schemas/QuerySubmissionResourceType'
      required:
      - id
      - organisation_id
      - type
      type: object
      x-access:
      - Public
    QuerySubmission:
      properties:
        attributes:
          $ref: '#/components/schemas/QuerySubmissionAttributes'
          x-order: 7
        created_on:
          format: date-time
          type: string
          x-order: 5
        id:
          format: uuid
          type: string
          x-order: 2
        modified_on:
          format: date-time
          type: string
          x-order: 6
        organisation_id:
          format: uuid
          type: string
          x-order: 4
        relationships:
          $ref: '#/components/schemas/QuerySubmissionRelationships'
          x-order: 8
        type:
          $ref: '#/components/schemas/QuerySubmissionResourceType'
          x-order: 1
        version:
          minimum: 0
          type: integer
          x-order: 3
      required:
      - id
      - organisation_id
      - type
      - attributes
      - version
      type: object
      x-access:
      - Public
    PaymentAdmissionResourceType:
      enum:
      - payment_admissions
      type: string
      x-access:
      - Public
    PaymentTypeInformation:
      description: Set of elements used to further specify the type of transaction.
      properties:
        amount:
          description: Amount of money to be moved between the debtor and creditor, before deduction of charges.
          pattern: ^[0-9.]{0,14}$
          type: string
          x-length: 14
          x-omitempty: true
        category_purpose:
          description: Specifies the high level purpose of the instruction based on a set of pre-defined categories.
          maxLength: 35
          type: string
          x-length: 35
          x-omitempty: true
        currency:
          description: Currency of the transaction amount. Currency code as defined in [ISO 4217](https://www.iso.org/iso/home/standards/currency_codes.htm)
          maxLength: 3
          minLength: 3
          type: string
          x-length: 3
          x-omitempty: true
        payment_purpose:
          description: Underlying reason for the payment transaction. Defined in external code list (4 char) or proprietary code (35 char)
          maxLength: 35
          minLength: 4
          type: string
          x-omitempty: true
        processing_date:
          description: Date on which the amount of money ceases to be available to the agent that owes it and when the amount of money becomes available to the agent to which it is due.
          example: '2015-12-23'
          format: date
          type:
          - string
          - 'null'
          x-omitempty: true
        remittance_information:
 

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