Form3

Form3 Payment Reads API

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

GitHub OpenAPI
Business capability
Payment Processing Management BC-1340.20

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:


# --- 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