Form3

Form3 Direct Debits API

The DirectDebits API from Form3 — 26 operation(s) for directdebits.

GitHub OpenAPI

Operations 26

POST /transaction/directdebits Create Direct debit #
GET /transaction/directdebits/{id} Fetch direct debit #
GET /transaction/directdebits/{id}/admissions/{admissionId} Fetch Direct Debit Admission #
POST /transaction/directdebits/{id}/decisions Create direct debit decision #
GET /transaction/directdebits/{id}/decisions/{decisionId} Get direct debit decision #
GET /transaction/directdebits/{id}/decisions/{decisionId}/admissions/{admissionId} Fetch decision admission #
POST /transaction/directdebits/{id}/decisions/{decisionId}/submissions Create direct debit decision submission #
GET /transaction/directdebits/{id}/decisions/{decisionId}/submissions/{submissionId} Get direct debit decision submission #
POST /transaction/directdebits/{id}/recalls Create recall #
GET /transaction/directdebits/{id}/recalls/{recallId} Fetch recall #
GET /transaction/directdebits/{id}/recalls/{recallId}/admissions/{admissionId} Fetch recall admission #
GET /transaction/directdebits/{id}/recalls/{recallId}/submissions/{submissionId} Fetch recall submission #
POST /transaction/directdebits/{id}/returns Create direct debit return #
GET /transaction/directdebits/{id}/returns/{returnId} Fetch direct debit return #
GET /transaction/directdebits/{id}/returns/{returnId}/admissions/{admissionId} Fetch return admission #
GET /transaction/directdebits/{id}/returns/{returnId}/reversals/{reversalId} Fetch return admission #
GET /transaction/directdebits/{id}/returns/{returnId}/reversals/{reversalId}/admissions/{admissionId} Fetch return admission #
POST /transaction/directdebits/{id}/returns/{returnId}/submissions create direct debit return submission #
GET /transaction/directdebits/{id}/returns/{returnId}/submissions/{submissionId} Fetch return submission #
POST /transaction/directdebits/{id}/reversals Create direct debit reversal #
GET /transaction/directdebits/{id}/reversals/{reversalId} Fetch direct debit reversal #
GET /transaction/directdebits/{id}/reversals/{reversalId}/admissions/{admissionId} Fetch reversal admission #
POST /transaction/directdebits/{id}/reversals/{reversalId}/submissions create reversal submission #
GET /transaction/directdebits/{id}/reversals/{reversalId}/submissions/{submissionId} Fetch reversal submission #
POST /transaction/directdebits/{id}/submissions Create direct debit submission #
GET /transaction/directdebits/{id}/submissions/{submissionId} Get direct debit 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-directdebits-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-directdebits-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-directdebits-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Form3 Public Direct Debits API
  version: '1'
servers:
- url: https://api.form3.tech/v1
security:
- OAuth2: []
tags:
- name: DirectDebits
paths:
  /transaction/directdebits:
    post:
      operationId: PostDirectdebits
      responses:
        201:
          description: Direct Debit creation response
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/DirectDebitCreationResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/DirectDebitCreationResponse'
        400:
          description: Direct Debit creation error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      summary: Create Direct debit
      tags:
      - DirectDebits
      x-access:
      - Public
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/DirectDebitCreation'
          application/json:
            schema:
              $ref: '#/components/schemas/DirectDebitCreation'
  /transaction/directdebits/{id}:
    get:
      operationId: GetDirectdebitsID
      parameters:
      - $ref: '#/components/parameters/directDebitIdParam'
      responses:
        200:
          description: Direct Debit details
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/DirectDebitDetailsResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/DirectDebitDetailsResponse'
        404:
          description: Not found error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      summary: Fetch direct debit
      tags:
      - DirectDebits
      x-access:
      - Public
  /transaction/directdebits/{id}/admissions/{admissionId}:
    get:
      operationId: GetDirectdebitsIDAdmissionsAdmissionID
      parameters:
      - $ref: '#/components/parameters/directDebitIdParam'
      - $ref: '#/components/parameters/admissionIdParam'
      responses:
        200:
          description: Direct Debit Admission details
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/DirectDebitAdmissionDetailsResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/DirectDebitAdmissionDetailsResponse'
        404:
          description: Not found error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      summary: Fetch Direct Debit Admission
      tags:
      - DirectDebits
      x-access:
      - Public
  /transaction/directdebits/{id}/decisions:
    post:
      operationId: PostDirectdebitsIDDecisions
      parameters:
      - $ref: '#/components/parameters/directDebitIdParam'
      responses:
        201:
          description: Direct Debit decision creation response
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/DirectDebitDecisionCreationResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/DirectDebitDecisionCreationResponse'
        400:
          description: Direct Debit decision creation error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        404:
          description: Not found error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        409:
          description: Direct Debit decision creation conflict error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      summary: Create direct debit decision
      tags:
      - DirectDebits
      x-access:
      - Public
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/DirectDebitDecisionCreation'
          application/json:
            schema:
              $ref: '#/components/schemas/DirectDebitDecisionCreation'
  /transaction/directdebits/{id}/decisions/{decisionId}:
    get:
      operationId: GetDirectdebitsIDDecisionsDecisionID
      parameters:
      - $ref: '#/components/parameters/directDebitIdParam'
      - $ref: '#/components/parameters/decisionIdParam'
      responses:
        200:
          description: Direct debit decision details
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/DirectDebitDecisionDetailsResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/DirectDebitDecisionDetailsResponse'
        404:
          description: Not found error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      summary: Get direct debit decision
      tags:
      - DirectDebits
      x-access:
      - Public
  /transaction/directdebits/{id}/decisions/{decisionId}/admissions/{admissionId}:
    get:
      operationId: GetDirectdebitsIDDecisionsDecisionIDAdmissionsAdmissionID
      parameters:
      - $ref: '#/components/parameters/directDebitIdParam'
      - $ref: '#/components/parameters/decisionIdParam'
      - $ref: '#/components/parameters/admissionIdParam'
      responses:
        200:
          description: Decision admission details
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/DirectDebitDecisionAdmissionDetailsResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/DirectDebitDecisionAdmissionDetailsResponse'
        404:
          description: Not found error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      summary: Fetch decision admission
      tags:
      - DirectDebits
      x-access:
      - Public
  /transaction/directdebits/{id}/decisions/{decisionId}/submissions:
    post:
      operationId: PostDirectdebitsIDDecisionsDecisionIDSubmissions
      parameters:
      - $ref: '#/components/parameters/directDebitIdParam'
      - $ref: '#/components/parameters/decisionIdParam'
      responses:
        201:
          description: Direct Debit decision submission creation response
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/DirectDebitDecisionSubmissionCreationResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/DirectDebitDecisionSubmissionCreationResponse'
        400:
          description: Direct Debit decision submission creation error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        409:
          description: Direct Debit decision submission creation conflict error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      summary: Create direct debit decision submission
      tags:
      - DirectDebits
      x-access:
      - Public
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/DirectDebitDecisionSubmissionCreation'
          application/json:
            schema:
              $ref: '#/components/schemas/DirectDebitDecisionSubmissionCreation'
  /transaction/directdebits/{id}/decisions/{decisionId}/submissions/{submissionId}:
    get:
      operationId: GetDirectdebitsIDDecisionsDecisionIDSubmissionsSubmissionID
      parameters:
      - $ref: '#/components/parameters/directDebitIdParam'
      - $ref: '#/components/parameters/decisionIdParam'
      - $ref: '#/components/parameters/submissionIdParam'
      responses:
        200:
          description: Direct debit decision details
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/DirectDebitDecisionSubmissionDetailsResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/DirectDebitDecisionSubmissionDetailsResponse'
        404:
          description: Not found error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      summary: Get direct debit decision submission
      tags:
      - DirectDebits
      x-access:
      - Public
  /transaction/directdebits/{id}/recalls:
    post:
      operationId: PostDirectdebitsIDRecalls
      parameters:
      - $ref: '#/components/parameters/directDebitIdParam'
      responses:
        201:
          description: Recall creation response
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/DirectDebitRecallCreationResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/DirectDebitRecallCreationResponse'
        400:
          description: Recall creation error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        404:
          description: Not found error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      summary: Create recall
      tags:
      - DirectDebits
      x-access:
      - Public
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/DirectDebitRecallCreation'
          application/json:
            schema:
              $ref: '#/components/schemas/DirectDebitRecallCreation'
  /transaction/directdebits/{id}/recalls/{recallId}:
    get:
      operationId: GetDirectdebitsIDRecallsRecallID
      parameters:
      - $ref: '#/components/parameters/directDebitIdParam'
      - $ref: '#/components/parameters/recallIdParam'
      responses:
        200:
          description: Recall details
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/DirectDebitRecallDetailsResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/DirectDebitRecallDetailsResponse'
        404:
          description: Not found error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      summary: Fetch recall
      tags:
      - DirectDebits
      x-access:
      - Public
  /transaction/directdebits/{id}/recalls/{recallId}/admissions/{admissionId}:
    get:
      operationId: GetDirectdebitsIDRecallsRecallIDAdmissionsAdmissionID
      parameters:
      - $ref: '#/components/parameters/directDebitIdParam'
      - $ref: '#/components/parameters/recallIdParam'
      - $ref: '#/components/parameters/admissionIdParam'
      responses:
        200:
          description: Recall admission details
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/DirectDebitRecallAdmissionDetailsResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/DirectDebitRecallAdmissionDetailsResponse'
        404:
          description: Not found error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      summary: Fetch recall admission
      tags:
      - DirectDebits
      x-access:
      - Public
  /transaction/directdebits/{id}/recalls/{recallId}/submissions/{submissionId}:
    get:
      operationId: GetDirectdebitsIDRecallsRecallIDSubmissionsSubmissionID
      parameters:
      - $ref: '#/components/parameters/directDebitIdParam'
      - $ref: '#/components/parameters/recallIdParam'
      - $ref: '#/components/parameters/submissionIdParam'
      responses:
        200:
          description: Recall submission details
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/DirectDebitRecallSubmissionDetailsResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/DirectDebitRecallSubmissionDetailsResponse'
        404:
          description: Not found error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      summary: Fetch recall submission
      tags:
      - DirectDebits
      x-access:
      - Public
  /transaction/directdebits/{id}/returns:
    post:
      operationId: PostDirectdebitsIDReturns
      parameters:
      - $ref: '#/components/parameters/directDebitIdParam'
      responses:
        201:
          description: Return creation response
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/DirectDebitReturnCreationResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/DirectDebitReturnCreationResponse'
        400:
          description: Return creation error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        404:
          description: Not found error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        409:
          description: Return creation conflict error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      summary: Create direct debit return
      tags:
      - DirectDebits
      x-access:
      - Public
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/DirectDebitReturnCreation'
          application/json:
            schema:
              $ref: '#/components/schemas/DirectDebitReturnCreation'
  /transaction/directdebits/{id}/returns/{returnId}:
    get:
      operationId: GetDirectdebitsIDReturnsReturnID
      parameters:
      - $ref: '#/components/parameters/directDebitIdParam'
      - $ref: '#/components/parameters/returnIdParam'
      responses:
        200:
          description: Return details
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/DirectDebitReturnDetailsResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/DirectDebitReturnDetailsResponse'
        404:
          description: Not found error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      summary: Fetch direct debit return
      tags:
      - DirectDebits
      x-access:
      - Public
  /transaction/directdebits/{id}/returns/{returnId}/admissions/{admissionId}:
    get:
      operationId: GetDirectdebitsIDReturnsReturnIDAdmissionsAdmissionID
      parameters:
      - $ref: '#/components/parameters/directDebitIdParam'
      - $ref: '#/components/parameters/returnIdParam'
      - $ref: '#/components/parameters/admissionIdParam'
      responses:
        200:
          description: Reversal admission details
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/DirectDebitReturnAdmissionDetailsResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/DirectDebitReturnAdmissionDetailsResponse'
        404:
          description: Not found error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      summary: Fetch return admission
      tags:
      - DirectDebits
      x-access:
      - Public
  /transaction/directdebits/{id}/returns/{returnId}/reversals/{reversalId}:
    get:
      operationId: GetDirectdebitsIDReturnsReturnIDReversalsReversalID
      parameters:
      - $ref: '#/components/parameters/directDebitIdParam'
      - $ref: '#/components/parameters/returnIdParam'
      - $ref: '#/components/parameters/reversalIdParam'
      responses:
        200:
          description: Reversal reversal details
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/DirectDebitReturnReversalDetailsResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/DirectDebitReturnReversalDetailsResponse'
        404:
          description: Not found error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      summary: Fetch return admission
      tags:
      - DirectDebits
      x-access:
      - Public
  /transaction/directdebits/{id}/returns/{returnId}/reversals/{reversalId}/admissions/{admissionId}:
    get:
      operationId: GetDirectdebitsIDReturnsReturnIDReversalsReversalIDAdmissionsAdmissionID
      parameters:
      - $ref: '#/components/parameters/directDebitIdParam'
      - $ref: '#/components/parameters/returnIdParam'
      - $ref: '#/components/parameters/reversalIdParam'
      - $ref: '#/components/parameters/admissionIdParam'
      responses:
        200:
          description: Reversal admission details
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/DirectDebitReturnReversalAdmissionDetailsResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/DirectDebitReturnReversalAdmissionDetailsResponse'
        404:
          description: Not found error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      summary: Fetch return admission
      tags:
      - DirectDebits
      x-access:
      - Public
  /transaction/directdebits/{id}/returns/{returnId}/submissions:
    post:
      operationId: PostDirectdebitsIDReturnsReturnIDSubmissions
      parameters:
      - $ref: '#/components/parameters/directDebitIdParam'
      - $ref: '#/components/parameters/returnIdParam'
      responses:
        201:
          description: Return submission creation response
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/DirectDebitReturnSubmissionCreationResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/DirectDebitReturnSubmissionCreationResponse'
        400:
          description: Return submission creation error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        404:
          description: Not found error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      summary: create direct debit return submission
      tags:
      - DirectDebits
      x-access:
      - Public
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/DirectDebitReturnSubmissionCreation'
          application/json:
            schema:
              $ref: '#/components/schemas/DirectDebitReturnSubmissionCreation'
  /transaction/directdebits/{id}/returns/{returnId}/submissions/{submissionId}:
    get:
      operationId: GetDirectdebitsIDReturnsReturnIDSubmissionsSubmissionID
      parameters:
      - $ref: '#/components/parameters/directDebitIdParam'
      - $ref: '#/components/parameters/returnIdParam'
      - $ref: '#/components/parameters/submissionIdParam'
      responses:
        200:
          description: Return submission details
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/DirectDebitReturnSubmissionDetailsResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/DirectDebitReturnSubmissionDetailsResponse'
        404:
          description: Not found error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      summary: Fetch return submission
      tags:
      - DirectDebits
      x-access:
      - Public
  /transaction/directdebits/{id}/reversals:
    post:
      operationId: PostDirectdebitsIDReversals
      parameters:
      - $ref: '#/components/parameters/directDebitIdParam'
      responses:
        201:
          description: Reversal creation response
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/DirectDebitReversalCreationResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/DirectDebitReversalCreationResponse'
        400:
          description: Reversal creation error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        404:
          description: Not found error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        409:
          description: Reversal creation conflict error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      summary: Create direct debit reversal
      tags:
      - DirectDebits
      x-access:
      - Public
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/DirectDebitReversalCreation'
          application/json:
            schema:
              $ref: '#/components/schemas/DirectDebitReversalCreation'
  /transaction/directdebits/{id}/reversals/{reversalId}:
    get:
      operationId: GetDirectdebitsIDReversalsReversalID
      parameters:
      - $ref: '#/components/parameters/directDebitIdParam'
      - $ref: '#/components/parameters/reversalIdParam'
      responses:
        200:
          description: Reversal details
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/DirectDebitReversalDetailsResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/DirectDebitReversalDetailsResponse'
        404:
          description: Not found error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      summary: Fetch direct debit reversal
      tags:
      - DirectDebits
      x-access:
      - Public
  /transaction/directdebits/{id}/reversals/{reversalId}/admissions/{admissionId}:
    get:
      operationId: GetDirectdebitsIDReversalsReversalIDAdmissionsAdmissionID
      parameters:
      - $ref: '#/components/parameters/directDebitIdParam'
      - $ref: '#/components/parameters/reversalIdParam'
      - $ref: '#/components/parameters/admissionIdParam'
      responses:
        200:
          description: Reversal admission details
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/DirectDebitReversalAdmissionDetailsResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/DirectDebitReversalAdmissionDetailsResponse'
        404:
          description: Not found error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      summary: Fetch reversal admission
      tags:
      - DirectDebits
      x-access:
      - Public
  /transaction/directdebits/{id}/reversals/{reversalId}/submissions:
    post:
      operationId: PostDirectdebitsIDReversalsReversalIDSubmissions
      parameters:
      - $ref: '#/components/parameters/directDebitIdParam'
      - $ref: '#/components/parameters/reversalIdParam'
      responses:
        201:
          description: Reversal submission creation response
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/DirectDebitReversalSubmissionCreationResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/DirectDebitReversalSubmissionCreationResponse'
        400:
          description: Reversal submission creation error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        404:
          description: Not found error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      summary: create reversal submission
      tags:
      - DirectDebits
      x-access:
      - Public
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/DirectDebitReversalSubmissionCreation'
          application/json:
            schema:
              $ref: '#/components/schemas/DirectDebitReversalSubmissionCreation'
  /transaction/directdebits/{id}/reversals/{reversalId}/submissions/{submissionId}:
    get:
      operationId: GetDirectdebitsIDReversalsReversalIDSubmissionsSubmissionID
      parameters:
      - $ref: '#/components/parameters/directDebitIdParam'
      - $ref: '#/components/parameters/reversalIdParam'
      - $ref: '#/components/parameters/submissionIdParam'
      responses:
        200:
          description: Reversal submission details
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/DirectDebitReversalSubmissionDetailsResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/DirectDebitReversalSubmissionDetailsResponse'
        404:
          description: Not found error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      summary: Fetch reversal submission
      tags:
      - DirectDebits
      x-access:
      - Public
  /transaction/directdebits/{id}/submissions:
    post:
      operationId: PostDirectdebitsIDSubmissions
      parameters:
      - $ref: '#/components/parameters/directDebitIdParam'
      responses:
        201:
          description: Direct debit submission creation response
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/DirectDebitSubmissionCreationResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/DirectDebitSubmissionCreationResponse'
        400:
          description: Direct debit submission creation error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        404:
          description: Not found error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      summary: Create direct debit submission
      tags:
      - DirectDebits
      x-access:
      - Public
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/DirectDebitSubmissionCreation'
          application/json:
            schema:
              $ref: '#/components/schemas/DirectDebitSubmissionCreation'
  /transaction/directdebits/{id}/submissions/{submissionId}:
    get:
      operationId: GetDirectdebitsIDSubmissionsSubmissionID
      parameters:
      - $ref: '#/components/parameters/directDebitIdParam'
      - $ref: '#/components/parameters/submissionIdParam'
      responses:
        200:
          des

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