Form3

Form3 Payment Writes API

The PaymentWrites API from Form3 — 18 operation(s) for paymentwrites.

GitHub OpenAPI

Operations 18

POST /transaction/payments Create payment #
PATCH /transaction/payments/{id}/admissions/{admissionId}/tasks/{taskId} Patch Payment Admission Task #
POST /transaction/payments/{id}/advices Create advice #
POST /transaction/payments/{id}/advices/{adviceId}/submissions create advice submission #
POST /transaction/payments/{id}/recalls Create recall #
POST /transaction/payments/{id}/recalls/{recallId}/decisions Create recall decision #
POST /transaction/payments/{id}/recalls/{recallId}/decisions/{decisionId}/submissions Create recall decision submission #
POST /transaction/payments/{id}/recalls/{recallId}/submissions Create recall submission #
POST /transaction/payments/{id}/returns Create return #
POST /transaction/payments/{id}/returns/{returnId}/reversals Create return reversal #
POST /transaction/payments/{id}/returns/{returnId}/submissions create return submission #
POST /transaction/payments/{id}/reversals Create reversal #
PATCH /transaction/payments/{id}/reversals/{reversalId}/admissions/{admissionId}/tasks/{taskId} Patch Reversal Admission Task #
POST /transaction/payments/{id}/reversals/{reversalId}/submissions Create reversal submission #
POST /transaction/payments/{id}/submissions create submission #
PATCH /transaction/payments/{id}/submissions/{submissionId}/tasks/{taskId} Patch Payment Submission Task #
PATCH /transaction/payments/{paymentId}/returns/{returnId}/admissions/{returnAdmissionId}/tasks/{taskId} Patch Return Admission Task #
PATCH /transaction/payments/{paymentId}/returns/{returnId}/submissions/{returnSubmissionId}/tasks/{taskId} Patch Return 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-paymentwrites-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-paymentwrites-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-paymentwrites-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Form3 Public Payment Writes API
  version: '1'
servers:
- url: https://api.form3.tech/v1
security:
- OAuth2: []
tags:
- name: PaymentWrites
paths:
  /transaction/payments:
    post:
      operationId: CreatePayment
      responses:
        201:
          description: Payment creation response
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/PaymentCreationResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentCreationResponse'
        400:
          description: Payment creation error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      summary: Create payment
      tags:
      - PaymentWrites
      x-access:
      - Public
      - FPS
      - Bacs
      - SEPA
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/PaymentCreation'
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentCreation'
  /transaction/payments/{id}/admissions/{admissionId}/tasks/{taskId}:
    parameters:
    - description: Payment Id
      in: path
      name: id
      required: true
      schema:
        type: string
        format: uuid
    - description: Admission Id
      in: path
      name: admissionId
      required: true
      schema:
        type: string
        format: uuid
    - description: Payment Admission Task Id
      in: path
      name: taskId
      required: true
      schema:
        type: string
        format: uuid
    patch:
      operationId: PatchPaymentAdmissionTask
      responses:
        200:
          description: Payment Admission Task update response
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/PaymentAdmissionTaskDetailsResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentAdmissionTaskDetailsResponse'
        400:
          description: Error
          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'
      summary: Patch Payment Admission Task
      tags:
      - PaymentWrites
      x-access:
      - Public
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentAdmissionTaskAmendment'
  /transaction/payments/{id}/advices:
    post:
      operationId: CreatePaymentAdvice
      parameters:
      - description: Payment Id
        in: path
        name: id
        required: true
        schema:
          type: string
          format: uuid
      responses:
        201:
          description: Advice creation response
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/AdviceCreationResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/AdviceCreationResponse'
        400:
          description: Advice creation error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      summary: Create advice
      tags:
      - PaymentWrites
      x-access:
      - Public
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/AdviceCreation'
          application/json:
            schema:
              $ref: '#/components/schemas/AdviceCreation'
  /transaction/payments/{id}/advices/{adviceId}/submissions:
    post:
      operationId: CreatePaymentAdviceSubmission
      parameters:
      - description: Payment Id
        in: path
        name: id
        required: true
        schema:
          type: string
          format: uuid
      - description: Advice Id
        in: path
        name: adviceId
        required: true
        schema:
          type: string
          format: uuid
      responses:
        201:
          description: Advice submission creation response
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/AdviceSubmissionCreationResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/AdviceSubmissionCreationResponse'
        400:
          description: Advice submission creation error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      summary: create advice submission
      tags:
      - PaymentWrites
      x-access:
      - Public
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/AdviceSubmissionCreation'
          application/json:
            schema:
              $ref: '#/components/schemas/AdviceSubmissionCreation'
  /transaction/payments/{id}/recalls:
    post:
      operationId: CreatePaymentRecall
      parameters:
      - description: Payment Id
        in: path
        name: id
        required: true
        schema:
          type: string
          format: uuid
      responses:
        201:
          description: Recall creation response
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/RecallCreationResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/RecallCreationResponse'
        400:
          description: Recall creation error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      summary: Create recall
      tags:
      - PaymentWrites
      x-access:
      - Public
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/RecallCreation'
          application/json:
            schema:
              $ref: '#/components/schemas/RecallCreation'
  /transaction/payments/{id}/recalls/{recallId}/decisions:
    post:
      operationId: CreatePaymentRecallDecision
      parameters:
      - description: Payment Id
        in: path
        name: id
        required: true
        schema:
          type: string
          format: uuid
      - description: Recall Id
        in: path
        name: recallId
        required: true
        schema:
          type: string
          format: uuid
      responses:
        201:
          description: Recall decision creation response
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/RecallDecisionCreationResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/RecallDecisionCreationResponse'
        400:
          description: Recall decision creation error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      summary: Create recall decision
      tags:
      - PaymentWrites
      x-access:
      - Public
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/RecallDecisionCreation'
          application/json:
            schema:
              $ref: '#/components/schemas/RecallDecisionCreation'
  /transaction/payments/{id}/recalls/{recallId}/decisions/{decisionId}/submissions:
    post:
      operationId: CreatePaymentRecallDecisionSubmission
      parameters:
      - description: Payment Id
        in: path
        name: id
        required: true
        schema:
          type: string
          format: uuid
      - description: Recall Id
        in: path
        name: recallId
        required: true
        schema:
          type: string
          format: uuid
      - description: Decision Id
        in: path
        name: decisionId
        required: true
        schema:
          type: string
          format: uuid
      responses:
        201:
          description: Recall decision submission creation response
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/RecallDecisionSubmissionCreationResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/RecallDecisionSubmissionCreationResponse'
        400:
          description: Recall decision submission creation error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      summary: Create recall decision submission
      tags:
      - PaymentWrites
      x-access:
      - Public
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/RecallDecisionSubmissionCreation'
          application/json:
            schema:
              $ref: '#/components/schemas/RecallDecisionSubmissionCreation'
  /transaction/payments/{id}/recalls/{recallId}/submissions:
    post:
      operationId: CreatePaymentRecallSubmission
      parameters:
      - description: Payment Id
        in: path
        name: id
        required: true
        schema:
          type: string
          format: uuid
      - description: Recall Id
        in: path
        name: recallId
        required: true
        schema:
          type: string
          format: uuid
      responses:
        201:
          description: Recall submission creation response
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/RecallSubmissionCreationResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/RecallSubmissionCreationResponse'
        400:
          description: Recall submission creation error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      summary: Create recall submission
      tags:
      - PaymentWrites
      x-access:
      - Public
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/RecallSubmissionCreation'
          application/json:
            schema:
              $ref: '#/components/schemas/RecallSubmissionCreation'
  /transaction/payments/{id}/returns:
    post:
      operationId: CreatePaymentReturn
      parameters:
      - description: Payment Id
        in: path
        name: id
        required: true
        schema:
          type: string
          format: uuid
      responses:
        201:
          description: Return creation response
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ReturnCreationResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ReturnCreationResponse'
        400:
          description: Return creation error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        401:
          description: Return creation error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        403:
          description: Return creation error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        404:
          description: Return creation error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        409:
          description: Return creation error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        500:
          description: Return creation error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      summary: Create return
      tags:
      - PaymentWrites
      x-access:
      - Public
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/ReturnCreation'
          application/json:
            schema:
              $ref: '#/components/schemas/ReturnCreation'
  /transaction/payments/{id}/returns/{returnId}/reversals:
    post:
      operationId: CreatePaymentReturnReversal
      parameters:
      - description: Payment Id
        in: path
        name: id
        required: true
        schema:
          type: string
          format: uuid
      - description: Return Id
        in: path
        name: returnId
        required: true
        schema:
          type: string
          format: uuid
      responses:
        201:
          description: Reversal creation response
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ReturnReversalCreationResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ReturnReversalCreationResponse'
        400:
          description: Reversal creation error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        401:
          description: Reversal creation error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        403:
          description: Reversal creation error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        404:
          description: Reversal creation error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        409:
          description: Reversal creation error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        500:
          description: Reversal creation error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      summary: Create return reversal
      tags:
      - PaymentWrites
      x-access:
      - Public
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/ReturnReversalCreation'
          application/json:
            schema:
              $ref: '#/components/schemas/ReturnReversalCreation'
  /transaction/payments/{id}/returns/{returnId}/submissions:
    post:
      operationId: CreatePaymentReturnSubmission
      parameters:
      - description: Payment Id
        in: path
        name: id
        required: true
        schema:
          type: string
          format: uuid
      - description: Return Id
        in: path
        name: returnId
        required: true
        schema:
          type: string
          format: uuid
      responses:
        201:
          description: Return submission creation response
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ReturnSubmissionCreationResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ReturnSubmissionCreationResponse'
        400:
          description: Return submission creation error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        401:
          description: Return submission creation error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        403:
          description: Return submission creation error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        404:
          description: Return submission creation error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        409:
          description: Return submission creation error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        500:
          description: Return submission creation error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      summary: create return submission
      tags:
      - PaymentWrites
      x-access:
      - Public
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/ReturnSubmissionCreation'
          application/json:
            schema:
              $ref: '#/components/schemas/ReturnSubmissionCreation'
  /transaction/payments/{id}/reversals:
    post:
      operationId: CreatePaymentReversal
      parameters:
      - description: Payment Id
        in: path
        name: id
        required: true
        schema:
          type: string
          format: uuid
      responses:
        201:
          description: Reversal creation response
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ReversalCreationResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ReversalCreationResponse'
        400:
          description: Reversal creation error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      summary: Create reversal
      tags:
      - PaymentWrites
      x-access:
      - Public
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/ReversalCreation'
          application/json:
            schema:
              $ref: '#/components/schemas/ReversalCreation'
  /transaction/payments/{id}/reversals/{reversalId}/admissions/{admissionId}/tasks/{taskId}:
    parameters:
    - description: Payment Id
      in: path
      name: id
      required: true
      schema:
        type: string
        format: uuid
    - description: Reversal Id
      in: path
      name: reversalId
      required: true
      schema:
        type: string
        format: uuid
    - description: Admission Id
      in: path
      name: admissionId
      required: true
      schema:
        type: string
        format: uuid
    - description: Reversal Admission Task Id
      in: path
      name: taskId
      required: true
      schema:
        type: string
        format: uuid
    patch:
      operationId: PatchReversalAdmissionTask
      responses:
        200:
          description: Reversal Admission Task update response
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ReversalAdmissionTaskDetailsResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ReversalAdmissionTaskDetailsResponse'
        400:
          description: Error
          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'
      summary: Patch Reversal Admission Task
      tags:
      - PaymentWrites
      x-access:
      - Public
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReversalAdmissionTaskAmendment'
  /transaction/payments/{id}/reversals/{reversalId}/submissions:
    post:
      operationId: CreatePaymentReversalSubmission
      parameters:
      - description: Payment Id
        in: path
        name: id
        required: true
        schema:
          type: string
          format: uuid
      - description: Reversal Id
        in: path
        name: reversalId
        required: true
        schema:
          type: string
          format: uuid
      responses:
        201:
          description: Reversal submission creation response
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ReversalSubmissionCreationResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ReversalSubmissionCreationResponse'
        400:
          description: Reversal submission creation error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      summary: Create reversal submission
      tags:
      - PaymentWrites
      x-access:
      - Public
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/ReversalSubmissionCreation'
          application/json:
            schema:
              $ref: '#/components/schemas/ReversalSubmissionCreation'
  /transaction/payments/{id}/submissions:
    post:
      operationId: CreatePaymentSubmission
      parameters:
      - description: Payment Id
        in: path
        name: id
        required: true
        schema:
          type: string
          format: uuid
      responses:
        201:
          description: Submission creation response
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/PaymentSubmissionCreationResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentSubmissionCreationResponse'
        400:
          description: Submission creation error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ApiError'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      summary: create submission
      tags:
      - PaymentWrites
      x-access:
      - Public
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/PaymentSubmissionCreation'
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentSubmissionCreation'
  /transaction/payments/{id}/submissions/{submissionId}/tasks/{taskId}:
    parameters:
    - description: Payment Id
      in: path
      name: id
      required: true
      schema:
        type: string
        format: uuid
    - description: Submission Id
      in: path
      name: submissionId
      required: true
      schema:
        type: string
        format: uuid
    - description: Payment Submission Task Id
      in: path
      name: taskId
      required: true
      schema:
        type: string
        format: uuid
    patch:
      operationId: PatchPaymentSubmissionTask
      responses:
        200:
          description: Payment Submission Task update response
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/PaymentSubmissionTaskDetailsResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentSubmissionTaskDetailsResponse'
        400:
          description: Error
          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'
      summary: Patch Payment Submission Task
      tags:
      - PaymentWrites
      x-access:
      - Public
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/PaymentSubmissionTaskAmendment'
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentSubmissionTaskAmendment'
  /transaction/payments/{paymentId}/returns/{returnId}/admissions/{returnAdmissionId}/tasks/{taskId}:
    parameters:
    - description: Payment ID
      in: path
      name: paymentId
      required: true
      schema:
        type: string
        format: uuid
    - description: Return ID
      in: path
      name: returnId
      required: true
      schema:
        type: string
        format: uuid
    - description: Return Admission ID
      in: path
      name: returnAdmissionId
      required: true
      schema:
        type: string
        format: uuid
    - description: Return Admission Task Id
      in: path
      name: taskId
      required: true
      schema:
        type: string
        format: uuid
    patch:
      operationId: PatchReturnAdmissionTask
      responses:
        200:
          description: Return Admission Task update response
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ReturnAdmissionTaskDetailsResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ReturnAdmissionTaskDetailsResponse'
        400:
          description: Error
          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'
      summary: Patch Return Admission Task
      tags:
      - PaymentWrites
      x-access:
      - Public
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/ReturnAdmissionTaskAmendment'
          application/json:
            schema:
              $ref: '#/components/schemas/ReturnAdmissionTaskAmendment'
  /transaction/payments/{paymentId}/returns/{returnId}/submissions/{returnSubmissionId}/tasks/{taskId}:
    parameters:
    - description: Payment ID
      in: path
      name: paymentId
      required: true
      schema:
        type: string
        format: uuid
    - description: Return ID
      in: path
      name: returnId
      required: true
      schema:
        type: string
        format: uuid
    - description: Return Submission ID
      in: path
      name: returnSubmissionId
      required: true
      schema:
        type: string
        format: uuid
    - description: Return Submission Task Id
      in: path
      name: taskId
      required: true
      schema:
        type: string
        format: uuid
    patch:
      operationId: PatchReturnSubmissionTask
      responses:
        200:
          description: Return Submission Task update response
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ReturnSubmissionTaskDetailsResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ReturnSubmissionTaskDetailsResponse'
        400:
          description: Error
          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'
      summary: Patch Return Submission Task
      tags:
      - PaymentWrites
      x-access:
      - Public
      requestBody:
        content:
  

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