# Form3 Payment Reads API

**Canonical:** https://apis.io/apis/form3/form3-paymentreads-api/  
**Provider:** Form3 — https://apis.io/providers/form3/  
**Base URL:** https://api.form3.tech/v1  
**Documentation:** https://www.api-docs.form3.tech/

Form3 Payment Reads API is one of 28 APIs that [Form3](https://apis.io/providers/form3/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include PaymentReads. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

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

## Operations (31)

| Method | Path | Summary |
|---|---|---|
| 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 |

## Machine-readable artifacts (12)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/form3/refs/heads/main/openapi/form3-paymentreads-api-openapi.yml
- **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

## Other Form3 APIs (12)

- [Form3 Account Identification API](https://apis.io/apis/form3/form3-accountidentification-api/)
- [Form3 Accounts API](https://apis.io/apis/form3/form3-accounts-api/)
- [Form3 Account Validation API](https://apis.io/apis/form3/form3-accountvalidation-api/)
- [Form3 ACE API](https://apis.io/apis/form3/form3-ace-api/)
- [Form3 Audit API](https://apis.io/apis/form3/form3-audit-api/)
- [Form3 Branches API](https://apis.io/apis/form3/form3-branches-api/)
- [Form3 Branch Identification API](https://apis.io/apis/form3/form3-branchidentification-api/)
- [Form3 Claims API](https://apis.io/apis/form3/form3-claims-api/)
- [Form3 Direct Debits API](https://apis.io/apis/form3/form3-directdebits-api/)
- [Form3 Direct Debits Reads API](https://apis.io/apis/form3/form3-directdebitsreads-api/)
- [Form3 Mandates API](https://apis.io/apis/form3/form3-mandates-api/)
- [Form3 Metrics API](https://apis.io/apis/form3/form3-metrics-api-api/)

## Tags

PaymentReads

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/form3/form3-paymentreads-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/form3/.