How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Form3

Form3 Payment Reads API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

Form3 Payment Reads API is one of 28 APIs that Form3 publishes on the 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.

This API exposes 31 operations across 31 paths, and defines 194 schemas. It is described by OpenAPI 3.2.0, at version 1.

Requests are made against a single base URL, https://api.form3.tech/v1.

31 operations 31 paths 194 schemas 31 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1
Base URL
https://api.form3.tech/v1
Authentication
HTTP Basic, OAuth 2.0
Resource Areas
1

Authentication & Security 2

Form3 Payment Reads API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (Basic). It supports OAuth 2.0 (OAuth2) using the clientCredentials flow. By default, every request must be authenticated.

  • OAuth2 — OAuth 2.0 with Client Credentials Grant type

Paths & Operations 31

Across 31 paths, the API surfaces 31 operations — 31 GET. Each is listed below with its method, path, parameters, and response codes.

PaymentReads 31
GET
/organisation/positions
List Positions
ListPositions → 200
GET
/transaction/payments
List payments
ListPayments 72 params → 200
GET
/transaction/payments/{id}
Fetch payment
GetPayment 1 param → 200
GET
/transaction/payments/{id}/admissions/{admissionId}
Fetch admission
GetPaymentAdmission 2 params → 200
GET
/transaction/payments/{id}/admissions/{admissionId}/tasks
List tasks
ListPaymentAdmissionTasks 2 params → 200
GET
/transaction/payments/{id}/admissions/{admissionId}/tasks/{taskId}
Get Payment Admission Task By ID
GetPaymentAdmissionTask 3 params → 200
GET
/transaction/payments/{id}/advices/{adviceId}
Fetch advice
GetPaymentAdvice 2 params → 200
GET
/transaction/payments/{id}/advices/{adviceId}/submissions/{submissionId}
Fetch Advice Submission
GetPaymentAdviceSubmission 3 params → 200
GET
/transaction/payments/{id}/recalls/{recallId}
Fetch recall
GetPaymentRecall 2 params → 200
GET
/transaction/payments/{id}/recalls/{recallId}/admissions/{admissionId}
Fetch Recall Admission
GetPaymentRecallAdmission 3 params → 200
GET
/transaction/payments/{id}/recalls/{recallId}/decisions/{decisionId}
Fetch Recall Decision
GetPaymentRecallDecision 3 params → 200
GET
/transaction/payments/{id}/recalls/{recallId}/decisions/{decisionId}/admissions/{admissionId}
Fetch Recall Decision Admission
GetPaymentRecallDecisionAdmission 4 params → 200
GET
/transaction/payments/{id}/recalls/{recallId}/decisions/{decisionId}/submissions/{submissionId}
Fetch Recall Decision Submission
GetPaymentRecallDecisionSubmission 4 params → 200
GET
/transaction/payments/{id}/recalls/{recallId}/reversals/{reversalId}
Fetch recall reversal
GetPaymentRecallReversal 3 params → 200
GET
/transaction/payments/{id}/recalls/{recallId}/reversals/{reversalId}/admissions/{admissionId}
Fetch recall reversal admission
GetPaymentRecallReversalAdmission 4 params → 200
GET
/transaction/payments/{id}/recalls/{recallId}/submissions/{submissionId}
Fetch Recall Submission
GetPaymentRecallSubmission 3 params → 200
GET
/transaction/payments/{id}/returns/{returnId}
Fetch Return
GetPaymentReturn 2 params → 200
GET
/transaction/payments/{id}/returns/{returnId}/admissions/{admissionId}
Fetch return admission
GetPaymentReturnAdmission 3 params → 200
GET
/transaction/payments/{id}/returns/{returnId}/reversals/{reversalId}
Fetch return reversal
GetPaymentReturnReversal 3 params → 200
GET
/transaction/payments/{id}/returns/{returnId}/reversals/{reversalId}/admissions/{admissionId}
Fetch return reversal admission
GetPaymentReturnReversalAdmission 4 params → 200
GET
/transaction/payments/{id}/returns/{returnId}/submissions/{submissionId}
Fetch return submission
GetPaymentReturnSubmission 3 params → 200
GET
/transaction/payments/{id}/reversals/{reversalId}
Fetch reversal
GetPaymentReversal 2 params → 200
GET
/transaction/payments/{id}/reversals/{reversalId}/admissions/{admissionId}
Fetch reversal admission
GetPaymentReversalAdmission 3 params → 200
GET
/transaction/payments/{id}/reversals/{reversalId}/admissions/{admissionId}/tasks
List tasks
ListReversalAdmissionTasks 3 params → 200
GET
/transaction/payments/{id}/reversals/{reversalId}/admissions/{admissionId}/tasks/{taskId}
Fetch Reversal Admission Task
GetReversalAdmissionTask 4 params → 200
GET
/transaction/payments/{id}/reversals/{reversalId}/submissions/{submissionId}
Fetch Reversal Submission
GetPaymentReversalSubmission 3 params → 200
GET
/transaction/payments/{id}/submissions/{submissionId}
Fetch submission
GetPaymentSubmission 2 params → 200
GET
/transaction/payments/{id}/submissions/{submissionId}/tasks/{taskId}
Get Payment Submission Task By ID
GetPaymentSubmissionTask 3 params → 200
GET
/transaction/payments/{paymentId}/returns/{returnId}/admissions/{returnAdmissionId}/tasks/{taskId}
Fetch Return Admission Task By ID
GetReturnAdmissionTask 4 params → 200
GET
/transaction/payments/{paymentId}/returns/{returnId}/submissions/{returnSubmissionId}/tasks
List tasks
ListReturnSubmissionTasks 3 params → 200
GET
/transaction/payments/{paymentId}/returns/{returnId}/submissions/{returnSubmissionId}/tasks/{taskId}
Fetch Return Submission Task
GetReturnSubmissionTask 4 params → 200

Schemas 194

The contract defines 194 schemas that model the data the API accepts and returns. The most detailed are PaymentAttributes (46 properties), UltimateEntity (21 properties), PostalAddress (15 properties), BeneficiaryDebtorAccountHoldingEntity (14 properties). Each schema is shown below with its type and property counts.

Agent
object
6 properties
RelationshipPaymentAdmissionTask
object
1 property
ReturnAdmissionTaskRelationships
object
3 properties
ReversalAdmissionTaskListResponse
object
2 properties
RelationshipReversals
object
1 property
RecallRelationships
object
5 properties
RecallReversalAdmissionFetch
object
8 properties 2 required
RelationshipPaymentSubmissions
object
1 property
AdviceSubmissionStatus
string
PaymentSubmissionTaskDetailsResponse
object
2 properties
RecallDecisionSubmissionAttributes
object
5 properties
PaymentAdmissionTaskRelationships
object
3 properties
Payment
object
9 properties 3 required
RelationshipLinks
object
1 property
AgentInstruction
object
2 properties
PaymentAdmissionStatus
string
[Status of the admission](https://api-docs.form3.tech/api.htmlenumerations-payment-status-codes-admission-status)
RecallAdmissionStatus
string
[Status](http://draft-api-docs.form3.tech/api.htmlenumerations-payment-admission-status) of the recall admission
RelationshipReturnSubmissions
object
1 property
AgentInstructionRole
string
Links
object
5 properties 1 required
PaymentAdmissionFetch
object
8 properties 2 required
RecallSubmissionFetchRelationships
object
2 properties
RecallSubmissionFetchResponse
object
2 properties
Recall
object
8 properties 2 required
PaymentSubmissionTaskStatus
string
status of the submission task
PaymentSubmissionFetchResponse
object
2 properties
Settlement
object
Specifies the details on how the settlement of the transaction between the instructing agent and the instructed agent is completed
5 properties
ReceiversCorrespondentAccountHoldingEntity
object
5 properties
PrivateIdentification
object
4 properties
AdviceDetailsResponse
object
2 properties
AdviceSubmissionFetch
object
8 properties 2 required
ReturnSubmission
object
8 properties 2 required
ReturnAdmission
object
8 properties 2 required
PaymentAdmissionTaskGroup
string
Identifies the task group the task belongs to
PaymentAdmissionStatusReason
string
[Payment admission status reason](https://api-docs.form3.tech/api.htmlenumerations-payment-status-codes-payment-admission-status-reasons)
ReturnReversalAdmissionFetchResponse
object
2 properties
ReversalSubmissionRelationships
object
3 properties
ReversalAdmissionTaskAssignee
string
Helps to identify the owner of the task
PaymentSubmissionTaskAssignee
string
Helps to identify the owner of the task
ReversalAdmissionTask
object
8 properties
RelationshipPaymentAdmissions
object
1 property
PartyRole
string
Role of the party. Enum of pre-defined values, new values can be added when needed
RecallDecisionSubmissionFetchRelationships
object
3 properties
ReturnSubmissionTaskStatus
string
status of the return submission task
AccountHoldingEntity
object
Information about the financial institution servicing the account.
6 properties 2 required
RecallStatus
string
The status of the recall, can either be pending, confirmed, or failed.
ReversalSubmissionFetchRelationships
object
2 properties
RelationshipData
object
2 properties
RecallDecisionAttributes
object
10 properties
PaymentAdmission
object
8 properties 2 required
PaymentSubmissionFetchRelationships
object
3 properties
ReturnPayment
object
8 properties 2 required
ReversalSubmissionStatus
string
[Status of the reversal submission](http://draft-api-docs.form3.tech/api.htmlenumerations-reversal-submission-status)
AgentRole
string
Role of the agent in the payment chain. Enum of pre-defined values, new values can be added when needed
PaymentSubmission
object
8 properties 2 required
ReturnReversalAdmissionFetchRelationships
object
3 properties
RecallDecisionAdmissionAttributes
object
5 properties
PaymentSubmissionTaskRelationships
object
2 properties
PostingStatus
string
Displays additional information about the latest response to a transaction, where multiple responses are allowed
ReversalAdmissionFetchResponse
object
2 properties
RecallSubmissionStatus
string
[Status](http://draft-api-docs.form3.tech/api.htmlenumerations-payment-status-codes-payment-submission-status) of the submission
ReversalSubmissionAttributes
object
8 properties
PaymentAdmissionBeneficiaryBranch
object
3 properties
BeneficiaryDebtorAccountProxy
object
3 properties
PaymentAdmissionTaskName
string
Identifies the payment admission task to be executed
ReturnSubmissionRelationships
object
4 properties
ReturnAdmissionTaskName
string
Identifies the return admission task to be executed
ReturnAdmissionFetchRelationships
object
6 properties
PaymentAttributes
object
46 properties
RelationshipReversalAdmissions
object
1 property
RecallAdmissionFetch
object
8 properties 2 required
CurrencyAndAmount
object
2 properties
RecallAdmissionAttributes
object
5 properties
Position
object
6 properties 3 required
ReturnSubmissionTaskListResponse
object
2 properties
AdviceSubmissionAttributes
object
4 properties
ReversalAdmissionTaskFetchResponse
object
2 properties
AccountValidationOutcome
string
Outcome of the validation of the beneficiary's account number, which is sometimes performed on a customer's behalf
ReturnReversalAdmissionFetch
object
8 properties 2 required
PaymentDetailsResponse
object
2 properties
RelationshipPaymentAdmissionTasks
object
1 property
ClearingChannel
string
Answer to the recall request. Can either be MPNS, RTGS or RTNS.
RelationshipReturnSubmissionsFetch
object
1 property
PaymentSubmissionStatus
string
[Status of the submission](https://api-docs.form3.tech/api.htmlenumerations-payment-status-codes-submission-status)
ReturnAdmissionBeneficiaryBranch
object
3 properties
ReturnSubmissionTaskAssignee
string
Helps to identify the owner of the task
ReturnPaymentRelationships
object
5 properties
RecallReversalAdmissionAttributes
object
2 properties
RecallDecisionAdmissionFetchRelationships
object
3 properties
RelationshipReturnAdmissions
object
1 property
PostalAddress
object
15 properties
AccountNumberCode
string
The type of identification given at accountnumber attribute
ReversalAdmissionTaskFetchRelationships
object
3 properties
PaymentRelationships
object
14 properties
ReturnAdmissionRelationships
object
6 properties
ReturnSubmissionFetch
object
8 properties 2 required
RelationshipPayments
object
1 property
PaymentAdmissionTaskStatus
string
status of the task
ReversalAdmissionTaskStatus
string
status of the task
Instruction
object
2 properties
Reference
object
Payment reference. Defined by a pair of reference type and reference value
2 properties 2 required
PaymentSubmissionTaskGroup
string
Identifies the task group the task belongs to
RelationshipReturns
object
1 property
ReturnPaymentFetchRelationships
object
5 properties
PositionDetailsListResponse
object
1 property
ReturnPaymentAttributes
object
14 properties
RecallDecisionSubmissionFetch
object
8 properties 2 required
RelationshipReturnAdmissionTasks
object
1 property
RecallDecisionFetchRelationships
object
4 properties
RecallDetailsResponse
object
2 properties
ReturnAdmissionTaskAssignee
string
Helps to identify the owner of the task
AccountWithBankId
object
2 properties
PaymentAdmissionTask
object
8 properties
ReturnFetchResponse
object
2 properties
ReversalAdmissionStatus
string
[Status](http://draft-api-docs.form3.tech/api.htmlenumerations-payment-admission-status) of the reversal admission
ReturnAdmissionTaskStatus
string
status of the return admission task
RelationshipPaymentAdmissionBeneficiaryBranch
object
1 property
RecallAdmissionFetchRelationships
object
2 properties
AdviceSubmissionFetchResponse
object
2 properties
RecallDecisionSubmissionStatus
string
[Status](http://draft-api-docs.form3.tech/api.htmlenumerations-payment-status-codes-payment-submission-status) of the submission
RecallReversal
object
8 properties 2 required
ReturnAdmissionFetchResponse
object
2 properties
ReversalAdmissionFetch
object
8 properties 2 required
ReturnAdmissionStatus
string
[Status](http://draft-api-docs.form3.tech/api.htmlenumerations-payment-admission-status) of the return admission
ReversalSubmissionFetch
object
8 properties 2 required
PaymentAdmissionFetchResponse
object
2 properties
PaymentAdmissionBeneficiaryAccount
object
3 properties
ReimbursementAccountHoldingEntity
object
5 properties
ResolutionRelatedInformation
object
3 properties
RecallReversalAdmissionFetchResponse
object
2 properties
PaymentAdvice
object
8 properties 2 required
ReturnReversal
object
8 properties 2 required
ReversalDetailsResponse
object
2 properties
ReturnAdmissionTaskGroup
string
Identifies the task group the task belongs to
PaymentSubmissionTaskName
string
Identifies the payment submission task to be executed
RecallDecisionFetchResponse
object
2 properties
ReversalAdmission
object
8 properties 2 required
RecallDecisionAdmissionFetchResponse
object
2 properties
ReversalSubmission
object
8 properties 2 required
PaymentAdmissionTaskAssignee
string
Helps to identify the owner of the task
RelationshipReturnAdmissionBeneficiaryBranch
object
1 property
SendersCorrespondentAccountHoldingEntity
object
5 properties
ReturnSubmissionTaskRelationships
object
3 properties
RecallDecisionFetch
object
8 properties 2 required
RecallDecisionAnswer
string
Answer to the recall request.
Self
object
1 property
RecallSubmissionFetch
object
8 properties 2 required
RecallAdmissionFetchResponse
object
2 properties
RelationshipReversalAdmissionTasks
object
1 property
PaymentSubmissionTask
object
8 properties
ReturnSubmissionFetchResponse
object
2 properties
RecallReversalDetailsResponse
object
2 properties
AdviceSubmissionFetchRelationships
object
2 properties
RecallSubmissionAttributes
object
5 properties
ReturnAdmissionTask
object
8 properties
UltimateEntity
object
21 properties
RelationshipReturnAdmissionBeneficiaryAccount
object
1 property
RelationshipPaymentAdmissionBeneficiaryAccount
object
1 property
ReturnSubmissionStatus
string
[Status](http://draft-api-docs.form3.tech/api.htmlenumerations-payment-submission-status) of the submission
RecallDecisionAdmissionFetch
object
8 properties 2 required
RecallDecisionSubmissionFetchResponse
object
2 properties
ResourceSignature
object
Structure containing information about cryptographic signature of the payment.
4 properties
RecallDecisionAdmissionStatus
string
[Status](http://draft-api-docs.form3.tech/api.htmlenumerations-payment-admission-status) of the admission
ReturnSubmissionTaskFetch
object
8 properties
ReversalAdmissionTaskFetch
object
8 properties
RelationshipReversalAdmissionsFetch
object
1 property
ReturnAdmissionBeneficiaryAccount
object
3 properties
PaymentDetailsListResponse
object
2 properties
PaymentSubmissionRelationships
object
3 properties
ReturnAdmissionTaskDetailsResponse
object
2 properties
Party
object
11 properties
ReturnSubmissionFetchRelationships
object
4 properties
BankIdCode
string
RelationshipPaymentSubmissionTasks
object
1 property
PaymentSubmissionFetch
object
8 properties 2 required
ReturnPaymentFetch
object
8 properties 2 required
ReversalPayment
object
8 properties 2 required
ChargesInformation
object
5 properties
ReturnSubmissionTaskFetchResponse
object
2 properties
ReturnAdmissionFetch
object
8 properties 2 required
ReturnSubmissionTaskFetchRelationships
object
3 properties
ReturnReversalDetailsResponse
object
2 properties
BeneficiaryDebtorAccountHoldingEntity
object
14 properties
ReturnSubmissionTask
object
8 properties
UserDefinedData
object
2 properties 2 required
RelationshipReturnSubmissionTasks
object
1 property
ReversalAdmissionTaskRelationships
object
3 properties
PaymentAdmissionTaskDetailsResponse
object
2 properties
ReturnSubmissionTaskAttributes
object
6 properties
ReversalAdmissionTaskAttributes
object
5 properties
ReversalSubmissionFetchResponse
object
2 properties
IntermediaryBankAccountHoldingEntity
object
5 properties
BeneficiaryDebtorOrganisationIdentification
object
4 properties
PaymentAdmissionTaskListResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

form3-paymentreads-api-openapi.yml Raw ↑

Other APIs Form3 publishes across the network.

Form3 Account Identification API
AE Profile APIs.io
Form3 Accounts API
AE Profile APIs.io
Form3 Account Validation API
AE Profile APIs.io
Form3 ACE API
AE Profile APIs.io
Form3 Audit API
AE Profile APIs.io
Form3 Branches API
AE Profile APIs.io
Form3 Branch Identification API
AE Profile APIs.io
Form3 Claims API
AE Profile APIs.io
Form3 Direct Debits API
AE Profile APIs.io
Form3 Direct Debits Reads API
AE Profile APIs.io
Form3 Mandates API
AE Profile APIs.io
Form3 Metrics API
AE Profile APIs.io
#PaymentReads
← Back to F APIs
API Details
ID
form3:form3-paymentreads-api
Base URL
https://api.form3.tech/v1
Docs
https://www.api-docs.form3.tech/
Provider
Form3
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=form3-paymentreads-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/form3-paymentreads-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Form3 Payment Reads API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.