Form3 Event Notifications API
Subscribe to and receive event notifications (webhooks) for payment and platform lifecycle events, and verify their signatures. Represented by the Subscriptions and notification operations under /notification in the Form3 Public API.
Form3 Event Notifications API is one of 7 APIs that Form3 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Webhook, Event Notifications, and Subscription. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 205 operations across 163 paths, organized into 28 resource areas, and defines 805 schemas. It is described by OpenAPI 2.0, at version 1.
Requests are made against the base URL https://api.form3.tech/v1.
205 operations
163 paths
805 schemas
10 DELETE121 GET14 PATCH58 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Form3 Event Notifications API declares
2 security schemes
for authenticating requests.
It defines a basic scheme (Basic).
It supports OAuth 2.0 (OAuth2) using the application flow.
By default, every request must be authenticated.
OAuth2— OAuth 2.0 with Client Credentials Grant type
Paths & Operations 205
Across 163 paths, the API surfaces 205 operations — 10 DELETE, 121 GET, 14 PATCH, 58 POST, 2 PUT. They span 28 resource areas, including Audit, Scheme File API, Transaction File API, Metrics API, Reports, SchemeMessages, Subscriptions, Oauth2, and 20 more. Each is listed below with its method, path, parameters, and response codes.
Audit 2
GET
/audit/entries/{record_type}
List audit entries for this record type
GET
/audit/entries/{record_type}/{id}
Fetch audit entry list for this record type/id
Scheme File API 8
GET
/files/schemefiles
List Scheme files
POST
/files/schemefiles
Creates a Scheme File
GET
/files/schemefiles/{scheme_file_id}
Get Scheme file
PUT
/files/schemefiles/{scheme_file_id}
Put Scheme file chunk
POST
/files/schemefiles/{scheme_file_id}/admissions
Creates a Scheme File Admission
GET
/files/schemefiles/{scheme_file_id}/admissions/{scheme_file_admission_id}
Fetch scheme file admission
POST
/files/schemefiles/{scheme_file_id}/submissions
Creates a Scheme File Submission
GET
/files/schemefiles/{scheme_file_id}/submissions/{scheme_file_submission_id}
Get Scheme file submission
Transaction File API 10
GET
/files/transactions
List transaction files
POST
/files/transactions
Creates a Transaction File
GET
/files/transactions/{transaction_file_id}
Fetch transaction file
PUT
/files/transactions/{transaction_file_id}
Put Transaction file chunk
POST
/files/transactions/{transaction_file_id}/admissions
Creates a Transaction File Admission
GET
/files/transactions/{transaction_file_id}/admissions/{transaction_file_admission_id}
Fetch transaction file admission
POST
/files/transactions/{transaction_file_id}/submissions
Creates a Transaction File Submission
GET
/files/transactions/{transaction_file_id}/submissions/{transaction_file_submission_id}
Fetch transaction file submission
GET
/files/transactions/{transaction_file_id}/submissions/{transaction_file_submission_id}/tasks/{task_id}
Fetch transaction file submission task
PATCH
/files/transactions/{transaction_file_id}/submissions/{transaction_file_submission_id}/tasks/{task_id}
Amend transaction file submission task
Metrics API 5
GET
/metrics/prometheus/api/v1/query
Query Endpoint for metrics
POST
/metrics/prometheus/api/v1/query
Query Endpoint for metrics
GET
/metrics/prometheus/api/v1/query_range
Query Range Endpoint for metrics
POST
/metrics/prometheus/api/v1/query_range
Query Range Endpoint for metrics
GET
/metrics/prometheus/federate
Federate Endpoint for metrics
Reports 4
GET
/notification/reports
List reports
GET
/notification/reports/{id}
Get report by ID
GET
/notification/reports/{id}/admissions/{admissionId}
Get Report Admission by ID
GET
/notification/reports/{id}/content
Get report content by ID
SchemeMessages 3
GET
/notification/schememessages
List messages
GET
/notification/schememessages/{id}
Fetch message
GET
/notification/schememessages/{id}/admissions/{admissionId}
Get Scheme Message Admission By AdmissionId
Subscriptions 5
GET
/notification/subscriptions
List all subscriptions
POST
/notification/subscriptions
Create subscription
DELETE
/notification/subscriptions/{id}
Deletes a subscription
GET
/notification/subscriptions/{id}
Fetch subscription
PATCH
/notification/subscriptions/{id}
Update subscription details
Oauth2 1
POST
/oauth2/token
Request Access Token
Accounts 6
GET
/organisation/accounts
List accounts
POST
/organisation/accounts
Create account
DELETE
/organisation/accounts/{id}
Delete account
GET
/organisation/accounts/{id}
Fetch account
PATCH
/organisation/accounts/{id}
Amend account
GET
/organisation/accounts/{id}/events
Fetch account events
AccountIdentification 5
GET
/organisation/accounts/{account_id}/identifications
List Account Identifications by Account
POST
/organisation/accounts/{account_id}/identifications
Create an identification for an existing Account
DELETE
/organisation/accounts/{account_id}/identifications/{identification_id}
Delete account identification
GET
/organisation/accounts/{account_id}/identifications/{identification_id}
Get an account identification by id
PATCH
/organisation/accounts/{account_id}/identifications/{identification_id}
Amend Account Identification
Branches 5
GET
/organisation/branches
List branches
POST
/organisation/branches
Create a Branch
DELETE
/organisation/branches/{id}
Delete branch
GET
/organisation/branches/{id}
Fetch branch
PATCH
/organisation/branches/{id}
Amend branch
BranchIdentification 5
GET
/organisation/branches/{branch_id}/identifications
List Branch Identifications by Branch
POST
/organisation/branches/{branch_id}/identifications
Create an identification for an existing Branch
DELETE
/organisation/branches/{branch_id}/identifications/{identification_id}
Delete branch identification
GET
/organisation/branches/{branch_id}/identifications/{identification_id}
Get a branch identification by id
PATCH
/organisation/branches/{branch_id}/identifications/{identification_id}
Amend Branch Identification
Name verification API 1
GET
/organisation/nameverifications
List name verifications
Name Verification API 3
POST
/organisation/nameverifications
Name verification creation request
GET
/organisation/nameverifications/{id}
Fetch name verification resource
GET
/organisation/nameverifications/{name_verification_id}/admissions/{id}
Name verification admission fetch request
PaymentReads 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
Organisations 4
GET
/organisation/units
List all organisations
POST
/organisation/units
Create organisation
GET
/organisation/units/{id}
Fetch organisation
PATCH
/organisation/units/{id}
Update organisation
platformsecurityapi 2
GET
/platform/security/signing_keys
Get a list of Signing Keys
GET
/platform/security/signing_keys/{signingkey_id}
Fetch a Signing Key
Roles 4
GET
/security/roles
List all roles
POST
/security/roles
Create role
DELETE
/security/roles/{role_id}
Delete role
GET
/security/roles/{role_id}
Fetch role
ACE 4
GET
/security/roles/{role_id}/aces
List all Access Controls for role
POST
/security/roles/{role_id}/aces
Create Access Control Entry
DELETE
/security/roles/{role_id}/aces/{ace_id}
Delete Access Control Entry
GET
/security/roles/{role_id}/aces/{ace_id}
Fetch Access Control Entry
Users 17
GET
/security/users
List all users
POST
/security/users
Create user
DELETE
/security/users/{user_id}
Delete user
GET
/security/users/{user_id}
Fetch user
PATCH
/security/users/{user_id}
Update user details
GET
/security/users/{user_id}/aces
Fetch access control list for user
GET
/security/users/{user_id}/authn/public_keys
List all public keys associated with the user
POST
/security/users/{user_id}/authn/public_keys
Create a new public key for user
GET
/security/users/{user_id}/authn/public_keys/{public_key_id}
Fetch public key for user
POST
/security/users/{user_id}/authn/public_keys/{public_key_id}/cancel_deletion
Cancel key deletion
POST
/security/users/{user_id}/authn/public_keys/{public_key_id}/schedule_deletion
Schedule key deletion
GET
/security/users/{user_id}/credentials
Fetch credentials for user
POST
/security/users/{user_id}/credentials
Create new credentials for user
DELETE
/security/users/{user_id}/credentials/{client_id}
Delete credentials for user
GET
/security/users/{user_id}/roles
Fetch all roles for user
DELETE
/security/users/{user_id}/roles/{role_id}
Remove role from user
POST
/security/users/{user_id}/roles/{role_id}
Add role to user
Claims 9
GET
/transaction/claims
List claims
POST
/transaction/claims
Create Claim
GET
/transaction/claims/{id}
Fetch claim
POST
/transaction/claims/{id}/reversals
Create Claim Reversal
GET
/transaction/claims/{id}/reversals/{reversalId}
Fetch Claim Reversal
POST
/transaction/claims/{id}/reversals/{reversalId}/submissions
Create Claim Reversal Submission
GET
/transaction/claims/{id}/reversals/{reversalId}/submissions/{submissionId}
Fetch Claim Reversal Submission
POST
/transaction/claims/{id}/submissions
Create Claim Submission
GET
/transaction/claims/{id}/submissions/{submissionId}
Fetch Claim Submission
DirectDebitsReads 1
GET
/transaction/directdebits
List direct debits
DirectDebits 26
POST
/transaction/directdebits
Create Direct debit
GET
/transaction/directdebits/{id}
Fetch direct debit
GET
/transaction/directdebits/{id}/admissions/{admissionId}
Fetch Direct Debit Admission
POST
/transaction/directdebits/{id}/decisions
Create direct debit decision
GET
/transaction/directdebits/{id}/decisions/{decisionId}
Get direct debit decision
GET
/transaction/directdebits/{id}/decisions/{decisionId}/admissions/{admissionId}
Fetch decision admission
POST
/transaction/directdebits/{id}/decisions/{decisionId}/submissions
Create direct debit decision submission
GET
/transaction/directdebits/{id}/decisions/{decisionId}/submissions/{submissionId}
Get direct debit decision submission
POST
/transaction/directdebits/{id}/recalls
Create recall
GET
/transaction/directdebits/{id}/recalls/{recallId}
Fetch recall
GET
/transaction/directdebits/{id}/recalls/{recallId}/admissions/{admissionId}
Fetch recall admission
GET
/transaction/directdebits/{id}/recalls/{recallId}/submissions/{submissionId}
Fetch recall submission
POST
/transaction/directdebits/{id}/returns
Create direct debit return
GET
/transaction/directdebits/{id}/returns/{returnId}
Fetch direct debit return
GET
/transaction/directdebits/{id}/returns/{returnId}/admissions/{admissionId}
Fetch return admission
GET
/transaction/directdebits/{id}/returns/{returnId}/reversals/{reversalId}
Fetch return admission
GET
/transaction/directdebits/{id}/returns/{returnId}/reversals/{reversalId}/admissions/{admissionId}
Fetch return admission
POST
/transaction/directdebits/{id}/returns/{returnId}/submissions
create direct debit return submission
GET
/transaction/directdebits/{id}/returns/{returnId}/submissions/{submissionId}
Fetch return submission
POST
/transaction/directdebits/{id}/reversals
Create direct debit reversal
GET
/transaction/directdebits/{id}/reversals/{reversalId}
Fetch direct debit reversal
GET
/transaction/directdebits/{id}/reversals/{reversalId}/admissions/{admissionId}
Fetch reversal admission
POST
/transaction/directdebits/{id}/reversals/{reversalId}/submissions
create reversal submission
GET
/transaction/directdebits/{id}/reversals/{reversalId}/submissions/{submissionId}
Fetch reversal submission
POST
/transaction/directdebits/{id}/submissions
Create direct debit submission
GET
/transaction/directdebits/{id}/submissions/{submissionId}
Get direct debit submission
Mandates 11
GET
/transaction/mandates
List mandates
POST
/transaction/mandates
Create Mandate
GET
/transaction/mandates/{id}
Fetch mandate
PATCH
/transaction/mandates/{id}
Update mandate
GET
/transaction/mandates/{id}/admissions/{admissionId}
Fetch Mandate Admission
POST
/transaction/mandates/{id}/returns
Create mandate return
GET
/transaction/mandates/{id}/returns/{returnId}
Fetch mandate return
POST
/transaction/mandates/{id}/returns/{returnId}/submissions
Create mandate return submission
GET
/transaction/mandates/{id}/returns/{returnId}/submissions/{submissionId}
Fetch return submission
POST
/transaction/mandates/{id}/submissions
Create Mandate Submission
GET
/transaction/mandates/{id}/submissions/{submissionId}
Fetch Mandate Submission
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
QualifiedTransactions 2
GET
/transaction/qualified_transactions
List Qualified Transactions
GET
/transaction/qualified_transactions/{id}
Fetch Qualified Transaction by ID
query_api 11
GET
/transaction/queries
Get Query
POST
/transaction/queries
Create a Query
GET
/transaction/queries/{query_id}
Fetch a Query
GET
/transaction/queries/{query_id}/admissions/{query_admission_id}
Fetch a Query Admission
POST
/transaction/queries/{query_id}/responses
Create a Query Response
GET
/transaction/queries/{query_id}/responses/{query_response_id}
Fetch a Query Response
GET
/transaction/queries/{query_id}/responses/{query_response_id}/admissions/{query_response_admission_id}
Fetch a Query Response Admission
POST
/transaction/queries/{query_id}/responses/{query_response_id}/submissions
Create a Query Response Submission
GET
/transaction/queries/{query_id}/responses/{query_response_id}/submissions/{query_response_submission_id}
Fetch a Query Response Submission
POST
/transaction/queries/{query_id}/submissions
Create a Query submission
GET
/transaction/queries/{query_id}/submissions/{query_submission_id}
Fetch a Query submission
AccountValidation 2
GET
/validations/gbdsc/sortcodes/{sortcode}
Fetch sort code details
GET
/validations/gbdsc/sortcodes/{sortcode}/accountnumbers/{accountnumber}
Validate sortcode and account number details
Schemas 805
The contract defines 805 schemas that model the data the API accepts and returns. The most detailed are PaymentAttributes (46 properties), AccountAttributes (32 properties), QueryBeneficiaryDebtorParty (23 properties), UltimateEntity (21 properties). Each schema is shown below with its type and property counts.
AcceptanceQualifier
string
All accepted payments will receive the matching qualifier code
Account
object
6 properties
3 required
AccountAmendment
object
1 property
AccountAttributes
object
32 properties
1 required
AccountAttributesOrganisationIdentification
object
10 properties
AccountAttributesOrganisationIdentificationActor
object
4 properties
AccountAttributesPrivateIdentification
object
9 properties
AccountClassification
string
AccountCreation
object
1 property
1 required
AccountCreationResponse
object
2 properties
AccountDetailsListResponse
object
2 properties
AccountDetailsResponse
object
2 properties
AccountEvent
object
6 properties
5 required
AccountEventAttributes
object
6 properties
4 required
AccountEventDetailsResponse
object
2 properties
AccountEventListResponse
object
2 properties
AccountEventRelationships
object
1 property
AccountHoldingEntity
object
Information about the financial institution servicing the account.
6 properties
2 required
AccountIdentification
object
7 properties
3 required
AccountIdentificationAttributes
object
1 property
1 required
AccountIdentificationData
AccountIdentificationEventData
AccountIdentificationEventRelationships
object
1 property
AccountIdentificationEventResponse
object
1 property
AccountIdentificationListResponse
object
2 properties
AccountIdentificationRelationships
object
1 property
AccountIdentificationRequest
object
1 property
1 required
AccountIdentificationResponse
object
1 property
AccountNumber
object
3 properties
AccountNumberCode
string
The type of identification given at accountnumber attribute
AccountNumberDetailsResponse
object
2 properties
AccountRelationships
object
2 properties
AccountUpdate
object
6 properties
4 required
AccountValidationOutcome
string
Outcome of the validation of the beneficiary's account number, which is sometimes performed on a customer's behalf
AccountWithBankId
object
2 properties
Ace
object
5 properties
3 required
AceCreation
object
1 property
1 required
AceCreationResponse
object
2 properties
1 required
AceDetailsListResponse
object
2 properties
1 required
AceDetailsResponse
object
2 properties
1 required
AdviceCreation
object
1 property
AdviceCreationResponse
object
2 properties
AdviceDetailsResponse
object
2 properties
AdviceSubmission
object
8 properties
2 required
AdviceSubmissionAttributes
object
4 properties
AdviceSubmissionCreation
object
1 property
AdviceSubmissionCreationResponse
object
2 properties
AdviceSubmissionDetailsResponse
object
2 properties
AdviceSubmissionFetch
object
8 properties
2 required
AdviceSubmissionFetchRelationships
object
2 properties
AdviceSubmissionFetchResponse
object
2 properties
AdviceSubmissionRelationships
object
2 properties
AdviceSubmissionStatus
string
Agent
object
6 properties
AgentInstruction
object
2 properties
AgentInstructionRole
string
AgentRole
string
Role of the agent in the payment chain. Enum of pre-defined values, new values can be added when needed
ApiError
object
2 properties
ApiErrorWithActualResource
object
3 properties
AuditEntry
object
5 properties
AuditEntryListResponse
object
2 properties
BankIDCode
string
BankIdAmendment
object
1 property
BankIdCode
string
BankIdPatchAttributes
object
1 property
BankIdPatchSettlementAccount
object
4 properties
BankIdUpdate
object
5 properties
4 required
BeneficiaryDebtorAccountHoldingEntity
object
14 properties
BeneficiaryDebtorAccountProxy
object
3 properties
BeneficiaryDebtorOrganisationIdentification
object
4 properties
Branch
object
7 properties
3 required
BranchAmendment
object
1 property
BranchAttributes
object
6 properties
2 required
BranchCreation
object
1 property
1 required
BranchCreationResponse
object
2 properties
BranchDetailsListResponse
object
2 properties
BranchDetailsResponse
object
2 properties
BranchIdentification
object
7 properties
3 required
BranchIdentificationAttributes
object
1 property
1 required
BranchIdentificationData
BranchIdentificationEventData
BranchIdentificationEventRelationships
object
1 property
BranchIdentificationEventResponse
object
1 property
BranchIdentificationListResponse
object
2 properties
BranchIdentificationRelationships
object
1 property
BranchIdentificationRequest
object
1 property
1 required
BranchIdentificationResponse
object
1 property
BranchUpdate
object
5 properties
4 required
BranchValidationType
string
optional validation to apply to the branch
CallbackTransport
string
CallbackURI
object
2 properties
2 required
ChargesInformation
object
5 properties
Claim
object
8 properties
3 required
ClaimAttributes
object
12 properties
9 required
ClaimCreation
object
1 property
ClaimDetailsListResponse
object
2 properties
ClaimDetailsResponse
object
2 properties
ClaimRelationships
object
2 properties
ClaimResourceType
string
ClaimReversal
object
8 properties
3 required
ClaimReversalCreation
object
1 property
1 required
ClaimReversalDetailsResponse
object
2 properties
ClaimReversalRelationships
object
2 properties
ClaimReversalSubmission
object
8 properties
2 required
ClaimReversalSubmissionCreation
object
1 property
1 required
ClaimReversalSubmissionDetailsResponse
object
2 properties
ClaimReversalSubmissionRelationships
object
2 properties
ClaimSubmission
object
8 properties
2 required
ClaimSubmissionCreation
object
1 property
1 required
ClaimSubmissionDetailsResponse
object
2 properties
ClaimSubmissionRelationships
object
1 property
ClaimSubmissionStatus
string
ClearingChannel
string
Answer to the recall request. Can either be MPNS, RTGS or RTNS.
CorrectionTransactionInformation
object
References a transaction initiated to fix the case under investigation.
8 properties
Credential
object
1 property
CredentialCreationResponse
object
2 properties
1 required
CredentialDetail
object
4 properties
CredentialSecret
object
2 properties
CurrencyAndAmount
object
2 properties
Deadline
object
7 properties
5 required
DebtorParty
object
1 property
DirectDebit
object
8 properties
3 required
DirectDebitAdmission
object
8 properties
3 required
DirectDebitAdmissionDetailsResponse
object
2 properties
DirectDebitAdmissionRelationships
object
1 property
DirectDebitAdmissionStatus
string
DirectDebitAdmissionStatusReason
string
DirectDebitCreation
object
1 property
DirectDebitCreationResponse
object
2 properties
DirectDebitDecision
object
8 properties
3 required
DirectDebitDecisionAdmission
object
8 properties
3 required
DirectDebitDecisionAdmissionCreation
object
1 property
DirectDebitDecisionAdmissionCreationResponse
object
2 properties
DirectDebitDecisionAdmissionDetailsResponse
object
2 properties
DirectDebitDecisionAdmissionRelationships
object
2 properties
DirectDebitDecisionAdmissionStatus
string
DirectDebitDecisionAdmissionStatusReason
string
DirectDebitDecisionCreation
object
1 property
DirectDebitDecisionCreationResponse
object
2 properties
DirectDebitDecisionDetailsResponse
object
2 properties
DirectDebitDecisionSubmission
object
8 properties
2 required
DirectDebitDecisionSubmissionCreation
object
1 property
DirectDebitDecisionSubmissionCreationResponse
object
2 properties
DirectDebitDecisionSubmissionDetailsResponse
object
2 properties
DirectDebitDecisionSubmissionStatus
string
DirectDebitDetailsListResponse
object
2 properties
DirectDebitDetailsResponse
object
2 properties
DirectDebitMandate
object
2 properties
DirectDebitRecall
object
8 properties
1 required
DirectDebitRecallAdmission
object
8 properties
1 required
DirectDebitRecallAdmissionDetailsResponse
object
2 properties
DirectDebitRecallAdmissionStatus
string
[Status](http://draft-api-docs.form3.tech/api.htmlenumerations-payment-admission-status) of the recall admission
DirectDebitRecallCreation
object
1 property
DirectDebitRecallCreationResponse
object
2 properties
DirectDebitRecallDetailsResponse
object
2 properties
DirectDebitRecallSubmission
object
8 properties
2 required
DirectDebitRecallSubmissionDetailsResponse
object
2 properties
DirectDebitRecallSubmissionStatus
string
DirectDebitRelationships
object
7 properties
DirectDebitResourceType
string
DirectDebitReturn
object
8 properties
3 required
DirectDebitReturnAdmission
object
8 properties
3 required
DirectDebitReturnAdmissionDetailsResponse
object
2 properties
DirectDebitReturnAdmissionRelationships
object
2 properties
DirectDebitReturnAdmissionStatus
string
DirectDebitReturnCreation
object
1 property
DirectDebitReturnCreationResponse
object
2 properties
DirectDebitReturnDetailsResponse
object
2 properties
DirectDebitReturnReversal
object
8 properties
2 required
DirectDebitReturnReversalAdmission
object
8 properties
3 required
DirectDebitReturnReversalAdmissionCreation
object
1 property
DirectDebitReturnReversalAdmissionCreationResponse
object
1 property
DirectDebitReturnReversalAdmissionDetailsResponse
object
2 properties
DirectDebitReturnReversalCreation
object
1 property
DirectDebitReturnReversalCreationResponse
object
1 property
DirectDebitReturnReversalDetailsResponse
object
2 properties
DirectDebitReturnSubmission
object
8 properties
2 required
DirectDebitReturnSubmissionCreation
object
1 property
DirectDebitReturnSubmissionCreationResponse
object
2 properties
DirectDebitReturnSubmissionDetailsResponse
object
2 properties
DirectDebitReturnSubmissionStatus
string
DirectDebitReversal
object
8 properties
2 required
DirectDebitReversalAdmission
object
8 properties
3 required
DirectDebitReversalAdmissionDetailsResponse
object
2 properties
DirectDebitReversalAdmissionStatus
string
DirectDebitReversalCreation
object
1 property
DirectDebitReversalCreationResponse
object
2 properties
DirectDebitReversalDetailsResponse
object
2 properties
DirectDebitReversalSubmission
object
8 properties
2 required
DirectDebitReversalSubmissionCreation
object
1 property
DirectDebitReversalSubmissionCreationResponse
object
2 properties
DirectDebitReversalSubmissionDetailsResponse
object
2 properties
DirectDebitReversalSubmissionStatus
string
DirectDebitSubmission
object
8 properties
2 required
DirectDebitSubmissionCreation
object
1 property
DirectDebitSubmissionCreationResponse
object
2 properties
DirectDebitSubmissionDetailsResponse
object
2 properties
DirectDebitSubmissionRelationships
object
1 property
DirectDebitSubmissionStatus
string
DirectDebitSubmissionValidationsRelationships
object
2 properties
DirectDebitWithReturn
object
2 properties
DisputedTransaction
object
2 properties
2 required
DuplicateTransactionInformation
object
3 properties
DynamicDeadline
object
A deadline that the transaction must be processed by, dynamically set by the service producing the TransactionEvent. If a leg needs to be able to change a dead…
2 properties
1 required
ErrorResponse
object
1 property
FetchQualifiedTransactionResponse
object
1 property
Instruction
object
2 properties
IntermediaryBankAccountHoldingEntity
object
5 properties
KeyState
string
Current lifecycle state of the key
Latency
object
3 properties
2 required
LegEvent
object
A single event associated with a leg. A TransactionEvent models a single event, but for historical reasons it can be associated with multiple legs. When an eve…
3 properties
2 required
LegRef
object
Reference to a leg instance within a transaction.
2 properties
2 required
Links
object
5 properties
1 required
ListSchemeFilesResponse
object
2 properties
1 required
ListTransactionFileItem
object
8 properties
3 required
ListTransactionFileItemRelationships
object
4 properties
ListTransactionFilesResponse
object
2 properties
1 required
Mandate
object
8 properties
2 required
MandateAdmission
object
8 properties
MandateAdmissionDetailsResponse
object
2 properties
MandateAdmissionRelationships
object
1 property
MandateAdmissionStatus
string
MandateAdmissionStatusReason
string
MandateAmendment
object
1 property
MandateAttributes
object
16 properties
MandateAttributesBeneficiaryParty
object
8 properties
MandateAttributesDebtorParty
object
6 properties
MandateCreation
object
1 property
MandateCreationResponse
object
2 properties
MandateDetailsListResponse
object
2 properties
MandateDetailsResponse
object
2 properties
MandateFrequency
string
MandateRelationships
object
4 properties
MandateResourceType
string
MandateReturn
object
8 properties
MandateReturnCreation
object
1 property
MandateReturnCreationResponse
object
2 properties
MandateReturnDetailsResponse
object
2 properties
MandateReturnSubmission
object
8 properties
MandateReturnSubmissionCreation
object
1 property
MandateReturnSubmissionCreationResponse
object
2 properties
MandateReturnSubmissionDetailsResponse
object
2 properties
MandateReturnSubmissionStatus
string
MandateStatus
string
MandateSubmission
object
8 properties
MandateSubmissionCreation
object
1 property
MandateSubmissionDetailsResponse
object
2 properties
MandateSubmissionRelationships
object
1 property
MandateSubmissionStatus
string
MetricsQueryResponse
object
5 properties
MostRecentCollection
object
2 properties
NameVerification
object
8 properties
3 required
NameVerificationAdmission
object
8 properties
3 required
NameVerificationAdmissionAnswer
string
NameVerificationAdmissionAttributes
object
7 properties
1 required
NameVerificationAdmissionDetailsResponse
object
1 property
NameVerificationAdmissionReasonCode
string
NameVerificationAdmissionRelationships
object
1 property
NameVerificationAdmissionStatus
string
NameVerificationAttributes
object
12 properties
5 required
NameVerificationCreation
object
1 property
1 required
NameVerificationCreationResponse
object
1 property
NameVerificationDetailsListResponse
object
2 properties
NameVerificationDetailsResponse
object
1 property
NameVerificationRelationships
object
2 properties
NameVerificationResourceType
string
NameVerificationSubmission
object
8 properties
2 required
NameVerificationSubmissionAdditionalMessage
object
3 properties
NameVerificationSubmissionAnswer
string
NameVerificationSubmissionAttributes
object
7 properties
1 required
NameVerificationSubmissionDetailsResponse
object
1 property
NameVerificationSubmissionReasonCode
string
NameVerificationSubmissionRelationships
object
1 property
NameVerificationSubmissionStatus
string
NewAdviceSubmission
object
4 properties
2 required
NewPayment
object
9 properties
3 required
NewPaymentRelationships
object
13 properties
NewPaymentSubmission
object
5 properties
2 required
NewQuery
object
5 properties
4 required
NewQueryRelationships
object
6 properties
NewQueryResponse
object
4 properties
4 required
NewQueryResponseSubmission
object
4 properties
3 required
NewQuerySubmission
object
3 properties
3 required
NewRecall
object
6 properties
2 required
NewRecallDecisionSubmission
object
5 properties
2 required
NewRecallSubmission
object
6 properties
2 required
NewReportRelationships
object
1 property
NewReportRequest
object
5 properties
3 required
NewReportRequestAttributes
object
3 properties
3 required
NewReportRequestFilter
object
3 properties
1 required
NewReportRequestReportUser
object
2 properties
2 required
NewReportRequestSubmission
object
5 properties
3 required
NewReportRequestSubmissionAttributes
object
1 property
NewReturnSubmission
object
5 properties
2 required
NewReversalSubmission
object
4 properties
2 required
NewSchemeFile
object
4 properties
3 required
NewTransactionFile
object
4 properties
3 required
Notification
object
9 properties
Organisation
object
5 properties
OrganisationAttributes
object
1 property
OrganisationCreation
object
1 property
1 required
OrganisationCreationResponse
object
2 properties
1 required
OrganisationDetailsListResponse
object
2 properties
1 required
OrganisationDetailsResponse
object
2 properties
1 required
OrganisationUpdate
object
1 property
1 required
Party
object
11 properties
PartyRole
string
Role of the party. Enum of pre-defined values, new values can be added when needed
Payment
object
9 properties
3 required
PaymentAdmission
object
8 properties
2 required
PaymentAdmissionBeneficiaryAccount
object
3 properties
PaymentAdmissionBeneficiaryBranch
object
3 properties
PaymentAdmissionDetailsResponse
object
2 properties
PaymentAdmissionFetch
object
8 properties
2 required
PaymentAdmissionFetchResponse
object
2 properties
PaymentAdmissionResourceType
string
PaymentAdmissionStatus
string
[Status of the admission](https://api-docs.form3.tech/api.htmlenumerations-payment-status-codes-admission-status)
PaymentAdmissionStatusReason
string
[Payment admission status reason](https://api-docs.form3.tech/api.htmlenumerations-payment-status-codes-payment-admission-status-reasons)
PaymentAdmissionTask
object
8 properties
PaymentAdmissionTaskAmendment
object
1 property
PaymentAdmissionTaskAssignee
string
Helps to identify the owner of the task
PaymentAdmissionTaskDetailsResponse
object
2 properties
PaymentAdmissionTaskGroup
string
Identifies the task group the task belongs to
PaymentAdmissionTaskListResponse
object
2 properties
PaymentAdmissionTaskName
string
Identifies the payment admission task to be executed
PaymentAdmissionTaskRelationships
object
3 properties
PaymentAdmissionTaskStatus
string
status of the task
PaymentAdmissionTaskUpdate
object
5 properties
PaymentAdmissionUpdateRelationships
object
1 property
PaymentAdvice
object
8 properties
2 required
PaymentAttributes
object
46 properties
PaymentCreation
object
1 property
1 required
PaymentCreationResponse
object
2 properties
PaymentDetailsListResponse
object
2 properties
PaymentDetailsResponse
object
2 properties
PaymentRecallResourceType
string
PaymentRecallSubmissionResourceType
string
PaymentRelationships
object
14 properties
PaymentResourceType
string
PaymentScheme
string
PaymentSubmission
object
8 properties
2 required
PaymentSubmissionCreation
object
1 property
1 required
PaymentSubmissionCreationResponse
object
2 properties
PaymentSubmissionDetailsResponse
object
2 properties
PaymentSubmissionFetch
object
8 properties
2 required
PaymentSubmissionFetchRelationships
object
3 properties
PaymentSubmissionFetchResponse
object
2 properties
PaymentSubmissionRelationships
object
3 properties
PaymentSubmissionResourceType
string
PaymentSubmissionStatus
string
[Status of the submission](https://api-docs.form3.tech/api.htmlenumerations-payment-status-codes-submission-status)
PaymentSubmissionTask
object
8 properties
PaymentSubmissionTaskAmendment
object
1 property
PaymentSubmissionTaskAssignee
string
Helps to identify the owner of the task
PaymentSubmissionTaskDetailsResponse
object
2 properties
PaymentSubmissionTaskGroup
string
Identifies the task group the task belongs to
PaymentSubmissionTaskName
string
Identifies the payment submission task to be executed
PaymentSubmissionTaskRelationships
object
2 properties
PaymentSubmissionTaskStatus
string
status of the submission task
PaymentSubmissionTaskUpdate
object
5 properties
PaymentSubmissionUpdateRelationships
object
1 property
PaymentTypeInformation
object
Set of elements used to further specify the type of transaction.
8 properties
PaymentUpdate
object
8 properties
4 required
PaymentUpdateRelationships
object
12 properties
Position
object
6 properties
3 required
PositionDetailsListResponse
object
1 property
PostalAddress
object
15 properties
PostingStatus
string
Displays additional information about the latest response to a transaction, where multiple responses are allowed
PrivateIdentification
object
4 properties
PublicKey
object
8 properties
PublicKeyCreation
object
1 property
1 required
PublicKeyCreationResponse
object
2 properties
1 required
PublicKeyResponse
object
2 properties
1 required
PublicKeysListResponse
object
2 properties
1 required
QualificationStatus
string
QualifiedLeg
object
8 properties
5 required
QualifiedLegRelationship
object
Defines an association from a qualified leg to one of its child legs.
2 properties
1 required
QualifiedLegRelationships
object
1 property
QualifiedTransaction
object
Qualified transaction as a resource envelope: identifiers at the top level, full qualified transaction payload under attributes.
7 properties
3 required
QualifiedTransactionAttributes
object
8 properties
7 required
QualifiedTransactionsListResponse
object
Paginated list of qualified transactions (list endpoint).
2 properties
1 required
Query
object
8 properties
5 required
QueryAccountNumberCode
string
The type of identification given at accountnumber attribute
QueryAdmission
object
8 properties
5 required
QueryAdmissionAttributes
object
2 properties
1 required
QueryAdmissionRelationships
object
1 property
1 required
QueryAdmissionResourceType
string
QueryAdmissionResponse
object
2 properties
1 required
QueryAdmissionStatus
string
QueryAttributes
object
12 properties
1 required
QueryBeneficiaryDebtorAccountProxy
object
3 properties
QueryBeneficiaryDebtorOrganisationIdentification
object
4 properties
QueryBeneficiaryDebtorParty
object
23 properties
QueryCreation
object
1 property
1 required
QueryFetchResponse
object
2 properties
1 required
QueryListResponse
object
2 properties
2 required
QueryPrivateIdentification
object
4 properties
QueryReference
object
Arbitrary references for payment or case. Defined by a pair of reference type and reference value.
2 properties
2 required
QueryRelationships
object
9 properties
QueryResourceType
string
QueryResponse
object
8 properties
5 required
QueryResponseAdmission
object
8 properties
5 required
QueryResponseAdmissionAttributes
object
2 properties
1 required
QueryResponseAdmissionRelationships
object
4 properties
QueryResponseAdmissionResourceType
string
QueryResponseAdmissionResponse
object
2 properties
1 required
QueryResponseAdmissionStatus
string
QueryResponseAnswer
string
QueryResponseAttributes
object
7 properties
1 required
QueryResponseCharges
object
4 properties
QueryResponseCompensation
object
4 properties
QueryResponseCreation
object
1 property
1 required
QueryResponseInformation
object
8 properties
QueryResponseRelationships
object
3 properties
QueryResponseResourceType
string
QueryResponseResponse
object
2 properties
1 required
QueryResponseStatusCode
string
QueryResponseSubmission
object
8 properties
5 required
QueryResponseSubmissionAttributes
object
3 properties
QueryResponseSubmissionCreation
object
1 property
1 required
QueryResponseSubmissionRelationships
object
2 properties
QueryResponseSubmissionResourceType
string
QueryResponseSubmissionResponse
object
2 properties
1 required
QueryResponseSubmissionStatus
string
QuerySubmission
object
8 properties
5 required
QuerySubmissionAttributes
object
2 properties
QuerySubmissionCreation
object
1 property
1 required
QuerySubmissionRelationships
object
1 property
1 required
QuerySubmissionResourceType
string
QuerySubmissionResponse
object
2 properties
1 required
QuerySubmissionStatus
string
QueryUltimateEntity
object
19 properties
Recall
object
8 properties
2 required
RecallAdmission
object
8 properties
2 required
RecallAdmissionAttributes
object
5 properties
RecallAdmissionDetailsResponse
object
2 properties
RecallAdmissionFetch
object
8 properties
2 required
RecallAdmissionFetchRelationships
object
2 properties
RecallAdmissionFetchResponse
object
2 properties
RecallAdmissionRelationships
object
2 properties
RecallAdmissionStatus
string
[Status](http://draft-api-docs.form3.tech/api.htmlenumerations-payment-admission-status) of the recall admission
RecallAdmissionUpdate
object
8 properties
2 required
RecallCreation
object
1 property
RecallCreationResponse
object
2 properties
RecallDecision
object
8 properties
2 required
RecallDecisionAdmission
object
8 properties
2 required
RecallDecisionAdmissionAttributes
object
5 properties
RecallDecisionAdmissionDetailsResponse
object
2 properties
RecallDecisionAdmissionFetch
object
8 properties
2 required
RecallDecisionAdmissionFetchRelationships
object
3 properties
RecallDecisionAdmissionFetchResponse
object
2 properties
RecallDecisionAdmissionRelationships
object
3 properties
RecallDecisionAdmissionStatus
string
[Status](http://draft-api-docs.form3.tech/api.htmlenumerations-payment-admission-status) of the admission
RecallDecisionAdmissionUpdate
object
5 properties
2 required
RecallDecisionAnswer
string
Answer to the recall request.
RecallDecisionAttributes
object
10 properties
RecallDecisionCreation
object
1 property
RecallDecisionCreationResponse
object
1 property
RecallDecisionDetailsResponse
object
2 properties
RecallDecisionFetch
object
8 properties
2 required
RecallDecisionFetchRelationships
object
4 properties
RecallDecisionFetchResponse
object
2 properties
RecallDecisionRelationships
object
4 properties
RecallDecisionSubmission
object
8 properties
2 required
RecallDecisionSubmissionAttributes
object
5 properties
RecallDecisionSubmissionCreation
object
1 property
RecallDecisionSubmissionCreationResponse
object
2 properties
RecallDecisionSubmissionDetailsResponse
object
2 properties
RecallDecisionSubmissionFetch
object
8 properties
2 required
RecallDecisionSubmissionFetchRelationships
object
3 properties
RecallDecisionSubmissionFetchResponse
object
2 properties
RecallDecisionSubmissionRelationships
object
3 properties
RecallDecisionSubmissionStatus
string
[Status](http://draft-api-docs.form3.tech/api.htmlenumerations-payment-status-codes-payment-submission-status) of the submission
RecallDecisionSubmissionUpdate
object
5 properties
2 required
RecallDetailsResponse
object
2 properties
RecallRelationships
object
5 properties
RecallReversal
object
8 properties
2 required
RecallReversalAdmission
object
8 properties
2 required
RecallReversalAdmissionAttributes
object
2 properties
RecallReversalAdmissionDetailsResponse
object
2 properties
RecallReversalAdmissionFetch
object
8 properties
2 required
RecallReversalAdmissionFetchResponse
object
2 properties
RecallReversalDetailsResponse
object
2 properties
RecallStatus
string
The status of the recall, can either be pending, confirmed, or failed.
RecallSubmission
object
8 properties
2 required
RecallSubmissionAttributes
object
5 properties
RecallSubmissionCreation
object
1 property
RecallSubmissionCreationResponse
object
2 properties
RecallSubmissionDetailsResponse
object
2 properties
RecallSubmissionFetch
object
8 properties
2 required
RecallSubmissionFetchRelationships
object
2 properties
RecallSubmissionFetchResponse
object
2 properties
RecallSubmissionRelationships
object
2 properties
RecallSubmissionStatus
string
[Status](http://draft-api-docs.form3.tech/api.htmlenumerations-payment-status-codes-payment-submission-status) of the submission
RecallSubmissionUpdate
object
5 properties
2 required
ReceiversCorrespondentAccountHoldingEntity
object
5 properties
Reference
object
Payment reference. Defined by a pair of reference type and reference value
2 properties
2 required
ReferenceMask
string
Account number of the account. A unique number will automatically be generated if not provided.
ReimbursementAccountHoldingEntity
object
5 properties
RelationshipAccount
object
1 property
RelationshipAdvices
object
1 property
RelationshipBranch
object
1 property
RelationshipData
object
2 properties
RelationshipLinks
object
1 property
RelationshipPaymentAdmissionBeneficiaryAccount
object
1 property
RelationshipPaymentAdmissionBeneficiaryBranch
object
1 property
RelationshipPaymentAdmissionTask
object
1 property
RelationshipPaymentAdmissionTasks
object
1 property
RelationshipPaymentAdmissions
object
1 property
RelationshipPaymentSubmissionTasks
object
1 property
RelationshipPaymentSubmissions
object
1 property
RelationshipPayments
object
1 property
RelationshipQueryResponseAdmission
object
1 property
RelationshipQueryResponseSubmission
object
1 property
RelationshipQuerySubmission
object
1 property
RelationshipRecallAdmissions
object
1 property
RelationshipRecallDecisionSubmissions
object
1 property
RelationshipRecallDecisions
object
1 property
RelationshipRecallReversals
object
1 property
RelationshipRecallSubmissions
object
1 property
RelationshipRecalls
object
1 property
RelationshipReturnAdmissionBeneficiaryAccount
object
1 property
RelationshipReturnAdmissionBeneficiaryBranch
object
1 property
RelationshipReturnAdmissionTasks
object
1 property
RelationshipReturnAdmissions
object
1 property
RelationshipReturnReversals
object
1 property
RelationshipReturnSubmissionTasks
object
1 property
RelationshipReturnSubmissions
object
1 property
RelationshipReturnSubmissionsFetch
object
1 property
RelationshipReturns
object
1 property
RelationshipReversalAdmissionTasks
object
1 property
RelationshipReversalAdmissions
object
1 property
RelationshipReversalAdmissionsFetch
object
1 property
RelationshipReversals
object
1 property
RelationshipsFullQuery
object
1 property
RelationshipsFullQueryResponse
object
1 property
RelationshipsPayment
object
1 property
RelationshipsPaymentAdmission
object
1 property
RelationshipsPaymentAdmissionProperties
object
2 properties
2 required
RelationshipsPaymentProperties
object
2 properties
2 required
RelationshipsPaymentRecall
object
1 property
RelationshipsPaymentRecallProperties
object
2 properties
2 required
RelationshipsPaymentRecallSubmission
object
1 property
RelationshipsPaymentRecallSubmissionProperties
object
2 properties
2 required
RelationshipsPaymentSubmission
object
1 property
RelationshipsPaymentSubmissionProperties
object
2 properties
2 required
RelationshipsQuery
object
1 property
RelationshipsQueryAdmission
object
1 property
RelationshipsQueryAdmissionProperties
object
2 properties
2 required
RelationshipsQueryProperties
object
2 properties
2 required
RelationshipsQueryResponse
object
1 property
RelationshipsQueryResponseAdmissionProperties
object
2 properties
2 required
RelationshipsQueryResponseProperties
object
2 properties
2 required
RelationshipsQuerySubmission
object
1 property
RelationshipsQuerySubmissionProperties
object
2 properties
2 required
Report
object
8 properties
3 required
ReportAdmission
object
8 properties
2 required
ReportAdmissionAttributes
object
4 properties
ReportAdmissionDetailsResponse
object
2 properties
1 required
ReportAdmissionRelationships
object
1 property
ReportAdmissionStatus
string
ReportAttributes
object
7 properties
ReportDetailsListResponse
object
2 properties
1 required
ReportDetailsResponse
object
2 properties
1 required
ReportLink
object
2 properties
1 required
ReportLinks
object
1 property
1 required
ReportRelationships
object
3 properties
ReportRequest
object
8 properties
3 required
ReportRequestAttributes
object
4 properties
4 required
ReportRequestCreation
object
1 property
1 required
ReportRequestDetailsListResponse
object
2 properties
1 required
ReportRequestDetailsResponse
object
2 properties
1 required
ReportRequestFilter
object
3 properties
1 required
ReportRequestLink
object
2 properties
1 required
ReportRequestLinks
object
1 property
1 required
ReportRequestRelationships
object
2 properties
ReportRequestStatus
string
ReportRequestSubmission
object
8 properties
6 required
ReportRequestSubmissionAttributes
object
3 properties
1 required
ReportRequestSubmissionDetailsResponse
object
2 properties
2 required
ReportRequestSubmissionRelationships
object
1 property
ReportRequestSubmissionStatus
string
ReportRequestUserIdCode
string
ReportUser
object
2 properties
ReportUsers
array
Users or organisations this report was generated for
RequestForInformationAgentBankId
object
2 properties
RequestForInformationAgents
array
RequestForInformationCreatorParty
object
11 properties
RequestForInformationQuerySubTypes
array
RequestForInformationReferences
array
RequestForInformationRequestedInformation
array
Requester
object
2 properties
2 required
ResolutionRelatedInformation
object
3 properties
ResourceSignature
object
Structure containing information about cryptographic signature of the payment.
4 properties
ResourceType
string
Responsibility
object
Indicates whether responsibility for a leg sits with Form3 or the customer. If unset, the responsibility is assumed to be with Form3.
1 property
ResponsibleEntity
string
The entity responsible. Either Form3 or the customer.
ReturnAdmission
object
8 properties
2 required
ReturnAdmissionBeneficiaryAccount
object
3 properties
ReturnAdmissionBeneficiaryBranch
object
3 properties
ReturnAdmissionDetailsResponse
object
2 properties
ReturnAdmissionFetch
object
8 properties
2 required
ReturnAdmissionFetchRelationships
object
6 properties
ReturnAdmissionFetchResponse
object
2 properties
ReturnAdmissionRelationships
object
6 properties
ReturnAdmissionStatus
string
[Status](http://draft-api-docs.form3.tech/api.htmlenumerations-payment-admission-status) of the return admission
ReturnAdmissionTask
object
8 properties
ReturnAdmissionTaskAmendment
object
1 property
ReturnAdmissionTaskAssignee
string
Helps to identify the owner of the task
ReturnAdmissionTaskDetailsResponse
object
2 properties
ReturnAdmissionTaskGroup
string
Identifies the task group the task belongs to
ReturnAdmissionTaskName
string
Identifies the return admission task to be executed
ReturnAdmissionTaskRelationships
object
3 properties
ReturnAdmissionTaskStatus
string
status of the return admission task
ReturnAdmissionTaskUpdate
object
5 properties
ReturnCreation
object
1 property
ReturnCreationResponse
object
2 properties
ReturnDetailsResponse
object
2 properties
ReturnFetchResponse
object
2 properties
ReturnPayment
object
8 properties
2 required
ReturnPaymentAttributes
object
14 properties
ReturnPaymentFetch
object
8 properties
2 required
ReturnPaymentFetchRelationships
object
5 properties
ReturnPaymentRelationships
object
5 properties
ReturnReversal
object
8 properties
2 required
ReturnReversalAdmission
object
8 properties
2 required
ReturnReversalAdmissionDetailsResponse
object
2 properties
ReturnReversalAdmissionFetch
object
8 properties
2 required
ReturnReversalAdmissionFetchRelationships
object
3 properties
ReturnReversalAdmissionFetchResponse
object
2 properties
ReturnReversalAdmissionRelationships
object
3 properties
ReturnReversalCreation
object
1 property
ReturnReversalCreationResponse
object
2 properties
ReturnReversalDetailsResponse
object
2 properties
ReturnSubmission
object
8 properties
2 required
ReturnSubmissionCreation
object
1 property
ReturnSubmissionCreationResponse
object
2 properties
ReturnSubmissionDetailsResponse
object
2 properties
ReturnSubmissionFetch
object
8 properties
2 required
ReturnSubmissionFetchRelationships
object
4 properties
ReturnSubmissionFetchResponse
object
2 properties
ReturnSubmissionRelationships
object
4 properties
ReturnSubmissionStatus
string
[Status](http://draft-api-docs.form3.tech/api.htmlenumerations-payment-submission-status) of the submission
ReturnSubmissionTask
object
8 properties
ReturnSubmissionTaskAmendment
object
1 property
ReturnSubmissionTaskAssignee
string
Helps to identify the owner of the task
ReturnSubmissionTaskAttributes
object
6 properties
ReturnSubmissionTaskDetailsResponse
object
2 properties
ReturnSubmissionTaskFetch
object
8 properties
ReturnSubmissionTaskFetchRelationships
object
3 properties
ReturnSubmissionTaskFetchResponse
object
2 properties
ReturnSubmissionTaskGroup
string
Identifies the task group the task belongs to
ReturnSubmissionTaskListResponse
object
2 properties
ReturnSubmissionTaskName
string
Identifies the return submission task to be executed
ReturnSubmissionTaskRelationships
object
3 properties
ReturnSubmissionTaskStatus
string
status of the return submission task
ReturnSubmissionTaskUpdate
object
5 properties
ReturnSubmissionUpdate
object
6 properties
3 required
ReturnSubmissionUpdateRelationships
object
1 property
ReversalAdmission
object
8 properties
2 required
ReversalAdmissionDetailsResponse
object
2 properties
ReversalAdmissionFetch
object
8 properties
2 required
ReversalAdmissionFetchResponse
object
2 properties
ReversalAdmissionStatus
string
[Status](http://draft-api-docs.form3.tech/api.htmlenumerations-payment-admission-status) of the reversal admission
ReversalAdmissionTask
object
8 properties
ReversalAdmissionTaskAmendment
object
1 property
ReversalAdmissionTaskAssignee
string
Helps to identify the owner of the task
ReversalAdmissionTaskAttributes
object
5 properties
ReversalAdmissionTaskDetailsResponse
object
2 properties
ReversalAdmissionTaskFetch
object
8 properties
ReversalAdmissionTaskFetchRelationships
object
3 properties
ReversalAdmissionTaskFetchResponse
object
2 properties
ReversalAdmissionTaskGroup
string
Identifies the task group the task belongs to
ReversalAdmissionTaskListResponse
object
2 properties
ReversalAdmissionTaskName
string
Identifies the reversal admission task to be executed
ReversalAdmissionTaskRelationships
object
3 properties
ReversalAdmissionTaskStatus
string
status of the task
ReversalAdmissionTaskUpdate
object
5 properties
ReversalAdmissionUpdate
object
6 properties
3 required
ReversalAdmissionUpdateRelationships
object
1 property
ReversalCreation
object
1 property
ReversalCreationResponse
object
2 properties
ReversalDetailsResponse
object
2 properties
ReversalPayment
object
8 properties
2 required
ReversalPaymentUpdate
object
8 properties
3 required
ReversalSubmission
object
8 properties
2 required
ReversalSubmissionAttributes
object
8 properties
ReversalSubmissionCreation
object
1 property
ReversalSubmissionCreationResponse
object
2 properties
ReversalSubmissionDetailsResponse
object
2 properties
ReversalSubmissionFetch
object
8 properties
2 required
ReversalSubmissionFetchRelationships
object
2 properties
ReversalSubmissionFetchResponse
object
2 properties
ReversalSubmissionRelationships
object
3 properties
ReversalSubmissionStatus
string
[Status of the reversal submission](http://draft-api-docs.form3.tech/api.htmlenumerations-reversal-submission-status)
Role
object
5 properties
RoleAttributes
object
2 properties
RoleCreation
object
1 property
1 required
RoleCreationResponse
object
2 properties
1 required
RoleDetailsListResponse
object
2 properties
1 required
RoleDetailsResponse
object
2 properties
1 required
ScheduleDeletionResponse
object
1 property
SchemeFile
object
8 properties
3 required
SchemeFileAdmission
object
8 properties
2 required
SchemeFileAdmissionCreation
object
1 property
1 required
SchemeFileAdmissionRelationships
object
1 property
SchemeFileAdmissionResponse
object
2 properties
SchemeFileAdmissionStatus
string
Status of the scheme file admission
SchemeFileAttributes
object
7 properties
7 required
SchemeFileCreation
object
1 property
1 required
SchemeFileLink
object
2 properties
1 required
SchemeFileLinks
object
1 property
1 required
SchemeFileRelationships
object
2 properties
SchemeFileResponse
object
2 properties
1 required
SchemeFileSubmission
object
8 properties
2 required
SchemeFileSubmissionConflictError
object
3 properties
SchemeFileSubmissionCreation
object
1 property
1 required
SchemeFileSubmissionRelationships
object
1 property
SchemeFileSubmissionResponse
object
2 properties
SchemeFileSubmissionStatus
string
Status of the scheme file submission
SchemeMessage
object
6 properties
3 required
SchemeMessageAdmission
object
6 properties
2 required
SchemeMessageAdmissionAttributes
object
4 properties
SchemeMessageAdmissionDetailsResponse
object
2 properties
1 required
SchemeMessageAdmissionRelationships
object
1 property
SchemeMessageAdmissionStatus
string
SchemeMessageAttributes
object
5 properties
4 required
SchemeMessageDetailsListResponse
object
2 properties
1 required
SchemeMessageDetailsResponse
object
2 properties
1 required
SchemeMessageEntryItem
object
2 properties
1 required
SchemeMessageRelationships
object
1 property
Self
object
1 property
SendersCorrespondentAccountHoldingEntity
object
5 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
SigningKeysAttributes
object
5 properties
1 required
SigningKeysListResponse
object
1 property
1 required
SigningKeysResourceType
string
SigningKeysResponse
object
1 property
1 required
SigningKeysResponseData
object
7 properties
5 required
SortCode
object
3 properties
SortCodeDetailsResponse
object
2 properties
StatusReason
string
Used to determine appropriate scheme or internal payment reject code. Account status field must be set to closed to use this functionality.
Subscription
object
7 properties
3 required
SubscriptionAmendment
object
1 property
1 required
SubscriptionAttributes
object
9 properties
2 required
SubscriptionCreate
object
4 properties
3 required
SubscriptionCreation
object
1 property
1 required
SubscriptionCreationResponse
object
2 properties
SubscriptionDeliveryError
object
8 properties
SubscriptionDeliveryErrorCountResponse
object
2 properties
SubscriptionDeliveryErrorListResponse
object
2 properties
SubscriptionDeliveryErrorResponse
object
2 properties
SubscriptionDeliveryErrorType
string
SubscriptionDetailsListResponse
object
2 properties
SubscriptionDetailsResponse
object
2 properties
SubscriptionRelationship
object
1 property
SubscriptionUpdate
object
5 properties
3 required
SubscriptionUpdateAttributes
object
9 properties
SubscriptionUserDefinedData
object
2 properties
2 required
SwitchedAccountDetails
object
Alternate Account details to use in case the account has been switched away from this organisation.
5 properties
4 required
ThinRelationship
object
1 property
Token
object
3 properties
TransactionFile
object
8 properties
3 required
TransactionFileAdmission
object
8 properties
2 required
TransactionFileAdmissionCreation
object
1 property
1 required
TransactionFileAdmissionRelationships
object
1 property
TransactionFileAdmissionResponse
object
2 properties
TransactionFileAdmissionStatus
string
Status of the transaction file admission
TransactionFileAttributes
object
9 properties
7 required
TransactionFileCreation
object
1 property
1 required
TransactionFileLink
object
2 properties
1 required
TransactionFileLinks
object
1 property
1 required
TransactionFileRelationships
object
4 properties
TransactionFileResponse
object
2 properties
TransactionFileSubmission
object
8 properties
2 required
TransactionFileSubmissionConflictError
object
3 properties
TransactionFileSubmissionCreation
object
1 property
1 required
TransactionFileSubmissionRelationships
object
2 properties
TransactionFileSubmissionResponse
object
2 properties
TransactionFileSubmissionSchemeReference
object
5 properties
TransactionFileSubmissionShortRelationship
object
3 properties
1 required
TransactionFileSubmissionStatus
string
Status of the transaction file submission
TransactionFileSubmissionTask
object
8 properties
2 required
TransactionFileSubmissionTaskAmendment
object
1 property
1 required
TransactionFileSubmissionTaskAttributes
object
6 properties
TransactionFileSubmissionTaskOutcome
string
Result of the task when in a terminal state
TransactionFileSubmissionTaskRelationships
object
Thin relationships returned on GET (id and type only)
3 properties
TransactionFileSubmissionTaskResponse
object
2 properties
TransactionFileSubmissionTaskStatus
string
Processing status of the task
TransactionFileSubmissionTaskUpdate
object
4 properties
TransactionGroupCode
string
TransactionInfo
object
6 properties
5 required
UltimateEntity
object
21 properties
User
object
5 properties
UserCreation
object
1 property
1 required
UserCreationResponse
object
2 properties
1 required
UserCredentialListResponse
object
2 properties
1 required
UserDefinedData
object
2 properties
2 required
UserDetailsListResponse
object
2 properties
1 required
UserDetailsResponse
object
2 properties
1 required
UserRoleListResponse
object
2 properties
1 required
ValidationType
string
optional validation to apply to the account
VerificationScheme
string
prometheusMetric
object
prometheusMetricData
object
2 properties
prometheusResult
array
prometheusResultItem
object
2 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Form3 6
Other APIs Form3 publishes across the network.
Form3 Public API
Form3 Payments API
Form3 Direct Debits & Mandates API
Form3 Account Identification & Verification API
Form3 Files API
Form3 Security & Access API
#Webhook#Event Notifications#Subscription
Where this information came from
This is an independent, third-party profile of Form3 Event Notifications 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.