Form3 Payment Writes API
The PaymentWrites API from Form3 — 18 operation(s) for paymentwrites.
Form3 Payment Writes API is one of 28 APIs that Form3 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include PaymentWrites. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.
This API exposes 18 operations across 18 paths, and defines 188 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.
18 operations
18 paths
188 schemas
5 PATCH13 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Form3 Payment Writes 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 18
Across 18 paths, the API surfaces 18 operations — 5 PATCH, 13 POST. Each is listed below with its method, path, parameters, and response codes.
PaymentWrites 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
Schemas 188
The contract defines 188 schemas that model the data the API accepts and returns. The most detailed are PaymentAttributes (46 properties), UltimateEntity (21 properties), PostalAddress (15 properties), ReturnPaymentAttributes (14 properties). Each schema is shown below with its type and property counts.
Agent
object
6 properties
AdviceCreation
object
1 property
RelationshipPaymentAdmissionTask
object
1 property
ReturnAdmissionTaskRelationships
object
3 properties
PaymentCreationResponse
object
2 properties
RelationshipReversals
object
1 property
RecallRelationships
object
5 properties
NewRecall
object
6 properties
2 required
RelationshipPaymentSubmissions
object
1 property
AdviceSubmissionStatus
string
ReversalSubmissionCreation
object
1 property
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)
RelationshipReturnSubmissions
object
1 property
AgentInstructionRole
string
Links
object
5 properties
1 required
NewReturnSubmission
object
5 properties
2 required
ReversalAdmissionTaskAmendment
object
1 property
ReversalAdmissionTaskUpdate
object
5 properties
Recall
object
8 properties
2 required
PaymentSubmissionTaskStatus
string
status of the submission task
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
RecallSubmissionCreation
object
1 property
ReturnSubmission
object
8 properties
2 required
PaymentSubmissionCreationResponse
object
2 properties
ReturnAdmission
object
8 properties
2 required
PaymentAdmissionTaskGroup
string
Identifies the task group the task belongs to
AdviceSubmissionRelationships
object
2 properties
PaymentAdmissionStatusReason
string
[Payment admission status reason](https://api-docs.form3.tech/api.htmlenumerations-payment-status-codes-payment-admission-status-reasons)
PaymentSubmissionTaskAmendment
object
1 property
ReversalSubmissionRelationships
object
3 properties
PaymentSubmissionTaskAssignee
string
Helps to identify the owner of the task
ReversalAdmissionTaskAssignee
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
AccountHoldingEntity
object
Information about the financial institution servicing the account.
6 properties
2 required
ReturnSubmissionTaskStatus
string
status of the return submission task
RecallStatus
string
The status of the recall, can either be pending, confirmed, or failed.
RelationshipData
object
2 properties
RecallDecisionAttributes
object
10 properties
PaymentAdmission
object
8 properties
2 required
PaymentSubmissionFetchRelationships
object
3 properties
ReturnPayment
object
8 properties
2 required
NewReversalSubmission
object
4 properties
2 required
RecallCreation
object
1 property
RecallDecision
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
PaymentSubmissionCreation
object
1 property
1 required
ReturnCreationResponse
object
2 properties
PaymentSubmissionTaskRelationships
object
2 properties
PostingStatus
string
Displays additional information about the latest response to a transaction, where multiple responses are allowed
RecallSubmission
object
8 properties
2 required
ReturnCreation
object
1 property
AdviceCreationResponse
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
ReturnSubmissionRelationships
object
4 properties
ReturnAdmissionTaskName
string
Identifies the return admission task to be executed
PaymentAdmissionTaskName
string
Identifies the payment admission task to be executed
PaymentSubmissionTaskUpdate
object
5 properties
RecallDecisionSubmissionCreation
object
1 property
PaymentAttributes
object
46 properties
RelationshipReversalAdmissions
object
1 property
RelationshipRecallDecisions
object
1 property
CurrencyAndAmount
object
2 properties
AdviceSubmissionAttributes
object
4 properties
NewAdviceSubmission
object
4 properties
2 required
PaymentAdmissionTaskUpdate
object
5 properties
AdviceSubmissionCreationResponse
object
2 properties
AccountValidationOutcome
string
Outcome of the validation of the beneficiary's account number, which is sometimes performed on a customer's behalf
RelationshipPaymentAdmissionTasks
object
1 property
ClearingChannel
string
Answer to the recall request. Can either be MPNS, RTGS or RTNS.
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
PaymentCreation
object
1 property
1 required
RelationshipReturnAdmissions
object
1 property
RecallCreationResponse
object
2 properties
PostalAddress
object
15 properties
AccountNumberCode
string
The type of identification given at accountnumber attribute
RecallDecisionRelationships
object
4 properties
PaymentRelationships
object
14 properties
ReturnAdmissionRelationships
object
6 properties
ReturnSubmissionCreationResponse
object
2 properties
ReturnReversalCreationResponse
object
2 properties
BeneficiaryDebtorOrganisationIdentification
object
4 properties
RelationshipPayments
object
1 property
PaymentAdmissionTaskStatus
string
status of the task
RecallDecisionSubmissionRelationships
object
3 properties
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
ReturnPaymentAttributes
object
14 properties
NewRecallSubmission
object
6 properties
2 required
RelationshipReturnAdmissionTasks
object
1 property
ReturnAdmissionTaskAssignee
string
Helps to identify the owner of the task
ReversalCreation
object
1 property
NewPaymentSubmission
object
5 properties
2 required
AccountWithBankId
object
2 properties
PaymentAdmissionTask
object
8 properties
AdviceSubmission
object
8 properties
2 required
ReversalAdmissionStatus
string
[Status](http://draft-api-docs.form3.tech/api.htmlenumerations-payment-admission-status) of the reversal admission
RecallDecisionSubmissionCreationResponse
object
2 properties
ReturnAdmissionTaskStatus
string
status of the return admission task
RelationshipPaymentAdmissionBeneficiaryBranch
object
1 property
RecallDecisionSubmissionStatus
string
[Status](http://draft-api-docs.form3.tech/api.htmlenumerations-payment-status-codes-payment-submission-status) of the submission
RecallSubmissionRelationships
object
2 properties
RelationshipRecalls
object
1 property
ApiErrorWithActualResource
object
3 properties
ReturnAdmissionStatus
string
[Status](http://draft-api-docs.form3.tech/api.htmlenumerations-payment-admission-status) of the return admission
ReturnAdmissionTaskAmendment
object
1 property
PaymentAdmissionBeneficiaryAccount
object
3 properties
RelationshipAdvices
object
1 property
ReimbursementAccountHoldingEntity
object
5 properties
ResolutionRelatedInformation
object
3 properties
RecallDecisionCreationResponse
object
1 property
PaymentAdvice
object
8 properties
2 required
ReturnReversal
object
8 properties
2 required
ReturnAdmissionTaskGroup
string
Identifies the task group the task belongs to
PaymentSubmissionTaskName
string
Identifies the payment submission task to be executed
ReversalAdmission
object
8 properties
2 required
ReturnSubmissionCreation
object
1 property
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
PaymentAdmissionTaskAmendment
object
1 property
ReturnSubmissionTaskDetailsResponse
object
2 properties
RecallDecisionAnswer
string
Answer to the recall request.
ReturnSubmissionTaskUpdate
object
5 properties
RelationshipReversalAdmissionTasks
object
1 property
ApiError
object
2 properties
PaymentSubmissionTask
object
8 properties
ReturnReversalCreation
object
1 property
RecallSubmissionAttributes
object
5 properties
ReturnAdmissionTask
object
8 properties
NewRecallDecisionSubmission
object
5 properties
2 required
UltimateEntity
object
21 properties
RelationshipReturnAdmissionBeneficiaryAccount
object
1 property
ReturnSubmissionTaskAmendment
object
1 property
RelationshipPaymentAdmissionBeneficiaryAccount
object
1 property
ReturnSubmissionStatus
string
[Status](http://draft-api-docs.form3.tech/api.htmlenumerations-payment-submission-status) of the submission
AdviceSubmissionCreation
object
1 property
ResourceSignature
object
Structure containing information about cryptographic signature of the payment.
4 properties
ReturnAdmissionBeneficiaryAccount
object
3 properties
RecallDecisionCreation
object
1 property
PaymentSubmissionRelationships
object
3 properties
ReturnAdmissionTaskDetailsResponse
object
2 properties
Party
object
11 properties
ReversalAdmissionTaskDetailsResponse
object
2 properties
BankIdCode
string
RelationshipPaymentSubmissionTasks
object
1 property
ReturnSubmissionTaskName
string
Identifies the return submission task to be executed
PaymentSubmissionFetch
object
8 properties
2 required
NewPayment
object
9 properties
3 required
ReversalPayment
object
8 properties
2 required
ReturnAdmissionTaskUpdate
object
5 properties
ChargesInformation
object
5 properties
BeneficiaryDebtorAccountHoldingEntity
object
14 properties
ReturnSubmissionTask
object
8 properties
UserDefinedData
object
2 properties
2 required
RelationshipReturnSubmissionTasks
object
1 property
ReversalAdmissionTaskRelationships
object
3 properties
ReversalSubmissionCreationResponse
object
2 properties
PaymentAdmissionTaskDetailsResponse
object
2 properties
ReturnSubmissionTaskAttributes
object
6 properties
ReversalAdmissionTaskAttributes
object
5 properties
RecallSubmissionCreationResponse
object
2 properties
IntermediaryBankAccountHoldingEntity
object
5 properties
NewPaymentRelationships
object
13 properties
RecallDecisionSubmission
object
8 properties
2 required
ReversalCreationResponse
object
2 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Form3 12
Other APIs Form3 publishes across the network.
Form3 Account Identification API
Form3 Accounts API
Form3 Account Validation API
Form3 ACE API
Form3 Audit API
Form3 Branches API
Form3 Branch Identification API
Form3 Claims API
Form3 Direct Debits API
Form3 Direct Debits Reads API
Form3 Mandates API
Form3 Metrics API
#PaymentWrites
Where this information came from
This is an independent, third-party profile of Form3 Payment Writes 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.