Form3

Form3 Payment Reads API

The PaymentReads API from Form3 — 31 operation(s) for paymentreads.

GitHub OpenAPI

Operations 31

GET /organisation/positions List Positions #
GET /transaction/payments List payments #
GET /transaction/payments/{id} Fetch payment #
GET /transaction/payments/{id}/admissions/{admissionId} Fetch admission #
GET /transaction/payments/{id}/admissions/{admissionId}/tasks List tasks #
GET /transaction/payments/{id}/admissions/{admissionId}/tasks/{taskId} Get Payment Admission Task By ID #
GET /transaction/payments/{id}/advices/{adviceId} Fetch advice #
GET /transaction/payments/{id}/advices/{adviceId}/submissions/{submissionId} Fetch Advice Submission #
GET /transaction/payments/{id}/recalls/{recallId} Fetch recall #
GET /transaction/payments/{id}/recalls/{recallId}/admissions/{admissionId} Fetch Recall Admission #
GET /transaction/payments/{id}/recalls/{recallId}/decisions/{decisionId} Fetch Recall Decision #
GET /transaction/payments/{id}/recalls/{recallId}/decisions/{decisionId}/admissions/{admissionId} Fetch Recall Decision Admission #
GET /transaction/payments/{id}/recalls/{recallId}/decisions/{decisionId}/submissions/{submissionId} Fetch Recall Decision Submission #
GET /transaction/payments/{id}/recalls/{recallId}/reversals/{reversalId} Fetch recall reversal #
GET /transaction/payments/{id}/recalls/{recallId}/reversals/{reversalId}/admissions/{admissionId} Fetch recall reversal admission #
GET /transaction/payments/{id}/recalls/{recallId}/submissions/{submissionId} Fetch Recall Submission #
GET /transaction/payments/{id}/returns/{returnId} Fetch Return #
GET /transaction/payments/{id}/returns/{returnId}/admissions/{admissionId} Fetch return admission #
GET /transaction/payments/{id}/returns/{returnId}/reversals/{reversalId} Fetch return reversal #
GET /transaction/payments/{id}/returns/{returnId}/reversals/{reversalId}/admissions/{admissionId} Fetch return reversal admission #
GET /transaction/payments/{id}/returns/{returnId}/submissions/{submissionId} Fetch return submission #
GET /transaction/payments/{id}/reversals/{reversalId} Fetch reversal #
GET /transaction/payments/{id}/reversals/{reversalId}/admissions/{admissionId} Fetch reversal admission #
GET /transaction/payments/{id}/reversals/{reversalId}/admissions/{admissionId}/tasks List tasks #
GET /transaction/payments/{id}/reversals/{reversalId}/admissions/{admissionId}/tasks/{taskId} Fetch Reversal Admission Task #
GET /transaction/payments/{id}/reversals/{reversalId}/submissions/{submissionId} Fetch Reversal Submission #
GET /transaction/payments/{id}/submissions/{submissionId} Fetch submission #
GET /transaction/payments/{id}/submissions/{submissionId}/tasks/{taskId} Get Payment Submission Task By ID #
GET /transaction/payments/{paymentId}/returns/{returnId}/admissions/{returnAdmissionId}/tasks/{taskId} Fetch Return Admission Task By ID #
GET /transaction/payments/{paymentId}/returns/{returnId}/submissions/{returnSubmissionId}/tasks List tasks #
GET /transaction/payments/{paymentId}/returns/{returnId}/submissions/{returnSubmissionId}/tasks/{taskId} Fetch 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-paymentreads-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-paymentreads-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-paymentreads-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Form3 Public Payment Reads API
  version: '1'
servers:
- url: https://api.form3.tech/v1
security:
- OAuth2: []
tags:
- name: PaymentReads
paths:
  /organisation/positions:
    get:
      operationId: ListPositions
      responses:
        200:
          description: List of position details
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/PositionDetailsListResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/PositionDetailsListResponse'
      summary: List Positions
      tags:
      - PaymentReads
      x-access:
      - Public
  /transaction/payments:
    get:
      operationId: ListPayments
      parameters:
      - description: Which page to select. page[number] * page[size] is restricted to less than 10,000.
        in: query
        name: page[number]
        required: false
        schema:
          type: string
          minimum: 0
          pattern: ^[A-z0-9]{4}$
      - description: Number of items to select.
        in: query
        name: page[size]
        required: false
        schema:
          type: integer
          maximum: 1000
          minimum: 0
      - description: Cursor for previous page (this is a base64-encoded UUID continuation token returned from the application and should not be manually generated, unless requesting the last page, where the value should be set to "end").
        in: query
        name: page[before]
        required: false
        schema:
          type: string
      - description: Cursor for next page (this is a base64-encoded UUID continuation token returned from the application and should not be manually generated, unless requesting the first page, where the value should be set to "start").
        in: query
        name: page[after]
        required: false
        schema:
          type: string
      - description: Filter by organisation id
        in: query
        name: filter[organisation_id]
        required: false
        schema:
          type: array
          items:
            format: uuid
            type: string
      - in: query
        name: filter[debtor_party.account_number]
        required: false
        schema:
          type: string
      - in: query
        name: filter[debtor_party.account_name]
        required: false
        schema:
          type: string
      - in: query
        name: filter[debtor_party.bank_id]
        required: false
        schema:
          type: string
      - in: query
        name: filter[beneficiary_party.account_number]
        required: false
        schema:
          type: string
      - in: query
        name: filter[beneficiary_party.account_name]
        required: false
        schema:
          type: string
      - in: query
        name: filter[beneficiary_party.bank_id]
        required: false
        schema:
          type: string
      - in: query
        name: filter[currency]
        required: false
        schema:
          type: string
      - in: query
        name: filter[end_to_end_reference]
        required: false
        schema:
          type: string
      - in: query
        name: filter[scheme_transaction_id]
        required: false
        schema:
          type: string
      - in: query
        name: filter[payment_scheme]
        required: false
        schema:
          type: string
      - in: query
        name: filter[payment_type]
        required: false
        schema:
          type: string
      - in: query
        name: filter[processing_date_from]
        required: false
        schema:
          type: string
          format: date
      - in: query
        name: filter[processing_date_to]
        required: false
        schema:
          type: string
          format: date
      - in: query
        name: filter[unique_scheme_id]
        required: false
        schema:
          type: string
      - description: Filter by route
        in: query
        name: filter[route]
        required: false
        schema:
          type: string
      - in: query
        name: filter[amount]
        required: false
        schema:
          type: string
      - in: query
        name: filter[amount][from]
        required: false
        schema:
          type: number
      - in: query
        name: filter[amount][to]
        required: false
        schema:
          type: number
      - in: query
        name: filter[reference]
        required: false
        schema:
          type: string
      - in: query
        name: filter[created_date_from]
        required: false
        schema:
          type: string
          format: date
      - in: query
        name: filter[created_date_to]
        required: false
        schema:
          type: string
          format: date
      - in: query
        name: filter[return.id]
        required: false
        schema:
          type: string
          format: uuid
      - in: query
        name: filter[return.unique_scheme_id]
        required: false
        schema:
          type: string
      - in: query
        name: filter[submission.id]
        required: false
        schema:
          type: string
          format: uuid
      - in: query
        name: filter[submission.submission_date_from]
        required: false
        schema:
          type: string
          format: date-time
      - in: query
        name: filter[submission.submission_date_to]
        required: false
        schema:
          type: string
          format: date-time
      - description: Filter by submission status
        in: query
        name: filter[submission.status]
        required: false
        schema:
          type: string
      - description: Filter by submission scheme status code
        in: query
        name: filter[submission.scheme_status_code]
        required: false
        schema:
          type: string
      - in: query
        name: filter[submission.settlement_cycle]
        required: false
        schema:
          type: integer
          minimum: 0
      - in: query
        name: filter[submission.settlement_date]
        required: false
        schema:
          type: string
          format: date
      - in: query
        name: filter[return_submission.submission_date_from]
        required: false
        schema:
          type: string
          format: date-time
      - in: query
        name: filter[return_submission.submission_date_to]
        required: false
        schema:
          type: string
          format: date-time
      - description: Filter by return submission status
        in: query
        name: filter[return_submission.status]
        required: false
        schema:
          type: string
      - in: query
        name: filter[return_submission.settlement_cycle]
        required: false
        schema:
          type: integer
          minimum: 0
      - in: query
        name: filter[return_submission.settlement_date]
        required: false
        schema:
          type: string
          format: date
      - in: query
        name: filter[admission.id]
        required: false
        schema:
          type: string
          format: uuid
      - in: query
        name: filter[admission.admission_date_from]
        required: false
        schema:
          type: string
          format: date-time
      - in: query
        name: filter[admission.admission_date_to]
        required: false
        schema:
          type: string
          format: date-time
      - description: Filter by admission status
        in: query
        name: filter[admission.status]
        required: false
        schema:
          type: string
      - description: Filter by admission scheme status code
        in: query
        name: filter[admission.scheme_status_code]
        required: false
        schema:
          type: string
      - in: query
        name: filter[admission.settlement_cycle]
        required: false
        schema:
          type: integer
          minimum: 0
      - in: query
        name: filter[admission.settlement_date]
        required: false
        schema:
          type: string
          format: date
      - in: query
        name: filter[recall.id]
        required: false
        schema:
          type: string
          format: uuid
      - in: query
        name: filter[reversal.id]
        required: false
        schema:
          type: string
          format: uuid
      - in: query
        name: filter[reversal_admission.admission_date_from]
        required: false
        schema:
          type: string
          format: date-time
      - in: query
        name: filter[reversal_admission.admission_date_to]
        required: false
        schema:
          type: string
          format: date-time
      - in: query
        name: filter[reversal_admission.status]
        required: false
        schema:
          type: string
      - in: query
        name: filter[reversal_submission.submission_date_from]
        required: false
        schema:
          type: string
          format: date-time
      - in: query
        name: filter[reversal_submission.submission_date_to]
        required: false
        schema:
          type: string
          format: date-time
      - in: query
        name: filter[reversal_submission.status]
        required: false
        schema:
          type: string
      - in: query
        name: filter[return_admission.admission_date_from]
        required: false
        schema:
          type: string
          format: date-time
      - in: query
        name: filter[return_admission.admission_date_to]
        required: false
        schema:
          type: string
          format: date-time
      - in: query
        name: filter[return_admission.status]
        required: false
        schema:
          type: string
      - in: query
        name: filter[return_admission.settlement_cycle]
        required: false
        schema:
          type: integer
          minimum: 0
      - in: query
        name: filter[return_admission.settlement_date]
        required: false
        schema:
          type: string
          format: date
      - in: query
        name: filter[recall_admission.admission_date_from]
        required: false
        schema:
          type: string
          format: date-time
      - in: query
        name: filter[recall_admission.admission_date_to]
        required: false
        schema:
          type: string
          format: date-time
      - in: query
        name: filter[recall_admission.status]
        required: false
        schema:
          type: string
      - in: query
        name: filter[recall_submission.submission_date_from]
        required: false
        schema:
          type: string
          format: date-time
      - in: query
        name: filter[recall_submission.submission_date_to]
        required: false
        schema:
          type: string
          format: date-time
      - in: query
        name: filter[recall_submission.status]
        required: false
        schema:
          type: string
      - in: query
        name: filter[recall_submission.id]
        required: false
        schema:
          type: string
          format: uuid
      - in: query
        name: filter[recall_decision_submission.submission_date_from]
        required: false
        schema:
          type: string
          format: date-time
      - in: query
        name: filter[recall_decision_submission.submission_date_to]
        required: false
        schema:
          type: string
          format: date-time
      - in: query
        name: filter[recall_decision_submission.status]
        required: false
        schema:
          type: string
      - description: Filter for payments containing all of the requested relationships
        in: query
        name: filter[relationships]
        required: false
        schema:
          type: array
          items:
            enum:
            - payment_submissions
            - payment_admissions
            - reversals
            - recalls
            - returns
            - payment_advices
            type: string
      - description: Filter for payments containing none of the requested relationships
        in: query
        name: filter[not_relationships]
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            enum:
            - payment_submissions
            - payment_admissions
            - reversals
            - recalls
            - returns
            - payment_advices
            type: string
      responses:
        200:
          description: List of payment details
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/PaymentDetailsListResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentDetailsListResponse'
      summary: List payments
      tags:
      - PaymentReads
      x-access:
      - Public
  /transaction/payments/{id}:
    get:
      operationId: GetPayment
      parameters:
      - description: Payment Id
        in: path
        name: id
        required: true
        schema:
          type: string
          format: uuid
      responses:
        200:
          description: Payment details
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/PaymentDetailsResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentDetailsResponse'
      summary: Fetch payment
      tags:
      - PaymentReads
      x-access:
      - Public
  /transaction/payments/{id}/admissions/{admissionId}:
    get:
      operationId: GetPaymentAdmission
      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
      responses:
        200:
          description: Admission details
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/PaymentAdmissionFetchResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentAdmissionFetchResponse'
      summary: Fetch admission
      tags:
      - PaymentReads
      x-access:
      - Public
  /transaction/payments/{id}/admissions/{admissionId}/tasks:
    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
    get:
      operationId: ListPaymentAdmissionTasks
      responses:
        200:
          description: List of Task Details
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/PaymentAdmissionTaskListResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentAdmissionTaskListResponse'
      summary: List tasks
      tags:
      - PaymentReads
      x-access:
      - Public
  /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
    get:
      operationId: GetPaymentAdmissionTask
      responses:
        200:
          description: Payment Admission Task Details details
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/PaymentAdmissionTaskDetailsResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentAdmissionTaskDetailsResponse'
      summary: Get Payment Admission Task By ID
      tags:
      - PaymentReads
      x-access:
      - Public
  /transaction/payments/{id}/advices/{adviceId}:
    get:
      operationId: GetPaymentAdvice
      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:
        200:
          description: Advice details
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/AdviceDetailsResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/AdviceDetailsResponse'
      summary: Fetch advice
      tags:
      - PaymentReads
      x-access:
      - Public
  /transaction/payments/{id}/advices/{adviceId}/submissions/{submissionId}:
    get:
      operationId: GetPaymentAdviceSubmission
      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
      - description: Submission Id
        in: path
        name: submissionId
        required: true
        schema:
          type: string
          format: uuid
      responses:
        200:
          description: Advice Submission Details
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/AdviceSubmissionFetchResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/AdviceSubmissionFetchResponse'
      summary: Fetch Advice Submission
      tags:
      - PaymentReads
      x-access:
      - Public
  /transaction/payments/{id}/recalls/{recallId}:
    get:
      operationId: GetPaymentRecall
      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:
        200:
          description: Recall details
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/RecallDetailsResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/RecallDetailsResponse'
      summary: Fetch recall
      tags:
      - PaymentReads
      x-access:
      - Public
  /transaction/payments/{id}/recalls/{recallId}/admissions/{admissionId}:
    get:
      operationId: GetPaymentRecallAdmission
      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: Admission Id
        in: path
        name: admissionId
        required: true
        schema:
          type: string
          format: uuid
      responses:
        200:
          description: Recall Admission Details
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/RecallAdmissionFetchResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/RecallAdmissionFetchResponse'
      summary: Fetch Recall Admission
      tags:
      - PaymentReads
      x-access:
      - Public
  /transaction/payments/{id}/recalls/{recallId}/decisions/{decisionId}:
    get:
      operationId: GetPaymentRecallDecision
      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:
        200:
          description: Recall Decision Details
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/RecallDecisionFetchResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/RecallDecisionFetchResponse'
      summary: Fetch Recall Decision
      tags:
      - PaymentReads
      x-access:
      - Public
  /transaction/payments/{id}/recalls/{recallId}/decisions/{decisionId}/admissions/{admissionId}:
    get:
      operationId: GetPaymentRecallDecisionAdmission
      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
      - description: Admission Id
        in: path
        name: admissionId
        required: true
        schema:
          type: string
          format: uuid
      responses:
        200:
          description: Recall Decision Admission Details
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/RecallDecisionAdmissionFetchResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/RecallDecisionAdmissionFetchResponse'
      summary: Fetch Recall Decision Admission
      tags:
      - PaymentReads
      x-access:
      - Public
  /transaction/payments/{id}/recalls/{recallId}/decisions/{decisionId}/submissions/{submissionId}:
    get:
      operationId: GetPaymentRecallDecisionSubmission
      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
      - description: Submission Id
        in: path
        name: submissionId
        required: true
        schema:
          type: string
          format: uuid
      responses:
        200:
          description: Recall Decision Submission Details
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/RecallDecisionSubmissionFetchResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/RecallDecisionSubmissionFetchResponse'
      summary: Fetch Recall Decision Submission
      tags:
      - PaymentReads
      x-access:
      - Public
  /transaction/payments/{id}/recalls/{recallId}/reversals/{reversalId}:
    get:
      operationId: GetPaymentRecallReversal
      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: Reversal Id
        in: path
        name: reversalId
        required: true
        schema:
          type: string
          format: uuid
      responses:
        200:
          description: Recall Reversal details
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/RecallReversalDetailsResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/RecallReversalDetailsResponse'
      summary: Fetch recall reversal
      tags:
      - PaymentReads
      x-access:
      - Public
  /transaction/payments/{id}/recalls/{recallId}/reversals/{reversalId}/admissions/{admissionId}:
    get:
      operationId: GetPaymentRecallReversalAdmission
      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: 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
      responses:
        200:
          description: Reversal admission details
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/RecallReversalAdmissionFetchResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/RecallReversalAdmissionFetchResponse'
      summary: Fetch recall reversal admission
      tags:
      - PaymentReads
      x-access:
      - Public
  /transaction/payments/{id}/recalls/{recallId}/submissions/{submissionId}:
    get:
      operationId: GetPaymentRecallSubmission
      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: Submission Id
        in: path
        name: submissionId
        required: true
        schema:
          type: string
          format: uuid
      responses:
        200:
          description: Recall Submission Details
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/RecallSubmissionFetchResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/RecallSubmissionFetchResponse'
      summary: Fetch Recall Submission
      tags:
      - PaymentReads
      x-access:
      - Public
  /transaction/payments/{id}/returns/{returnId}:
    get:
      operationId: GetPaymentReturn
      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:
        200:
          description: Return Details
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ReturnFetchResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ReturnFetchResponse'
      summary: Fetch Return
      tags:
      - PaymentReads
      x-access:
      - Public
  /transaction/payments/{id}/returns/{returnId}/admissions/{admissionId}:
    get:
      operationId: GetPaymentReturnAdmission
      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
      - description: Admission Id
        in: path
        name: admissionId
        required: true
        schema:
          type: string
          format: uuid
      responses:
        200:
          description: Return admission details
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ReturnAdmissionFetchResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ReturnAdmissionFetchResponse'
      summary: Fetch return admission
      tags:
      - PaymentReads
      x-access:
      - Public
  /transaction/payments/{id}/returns/{returnId}/reversals/{reversalId}:
    get:
      operationId: GetPaymentReturnReversal
      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
      - description: Reversal Id
        in: path
        name: reversalId
        required: true
        schema:
          type: string
          format: uuid
      responses:
        200:
          description: Return reversal details
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ReturnReversalDetailsResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ReturnReversalDetailsResponse'
      summary: Fetch return reversal
      tags:
      - PaymentReads
      x-access:
      - Public
  /transaction/payments/{id}/returns/{returnId}/reversals/{reversalId}/admissions/{admissionId}:
    get:
      operationId: GetPaymentReturnReversalAdmission
      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
      - 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
      responses:
        200:
          description: Return reversal admission details
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ReturnReversalAdmissionFetchResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ReturnReversalAdmissionFetchResponse'
      summary: Fetch return reversal admission
      tags:
      - PaymentReads
      x-access:
      - Public
  /transaction/payments/{id}/returns/{returnId}/submissions/{submissionId}:
    get:
      operationId: GetPaymentReturnSubmission
      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
      - description: Submission Id
        in: path
        name: submissionId
        required: true
        schema:
          type: string
          format: uuid
      responses:
        200:
          description: Return submission details
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ReturnSubmissionFetchResponse'
            application/json:
              schema:
                $re

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