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 Direct Debits API

The DirectDebits API from Form3 — 26 operation(s) for directdebits.

Documentation Provider Profile APIs.io OpenAPI GitHub

Form3 Direct Debits API is one of 28 APIs that Form3 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Direct Debits. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

This API exposes 26 operations across 26 paths, and defines 83 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.

26 operations 26 paths 83 schemas 17 GET9 POST

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 Direct Debits 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 26

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

DirectDebits 26
POST
/transaction/directdebits
Create Direct debit
PostDirectdebits body → 201400
GET
/transaction/directdebits/{id}
Fetch direct debit
GetDirectdebitsID 1 param → 200404
GET
/transaction/directdebits/{id}/admissions/{admissionId}
Fetch Direct Debit Admission
GetDirectdebitsIDAdmissionsAdmissionID 2 params → 200404
POST
/transaction/directdebits/{id}/decisions
Create direct debit decision
PostDirectdebitsIDDecisions 1 param body → 201400404409
GET
/transaction/directdebits/{id}/decisions/{decisionId}
Get direct debit decision
GetDirectdebitsIDDecisionsDecisionID 2 params → 200404
GET
/transaction/directdebits/{id}/decisions/{decisionId}/admissions/{admissionId}
Fetch decision admission
GetDirectdebitsIDDecisionsDecisionIDAdmissionsAdmissionID 3 params → 200404
POST
/transaction/directdebits/{id}/decisions/{decisionId}/submissions
Create direct debit decision submission
PostDirectdebitsIDDecisionsDecisionIDSubmissions 2 params body → 201400409
GET
/transaction/directdebits/{id}/decisions/{decisionId}/submissions/{submissionId}
Get direct debit decision submission
GetDirectdebitsIDDecisionsDecisionIDSubmissionsSubmissionID 3 params → 200404
POST
/transaction/directdebits/{id}/recalls
Create recall
PostDirectdebitsIDRecalls 1 param body → 201400404
GET
/transaction/directdebits/{id}/recalls/{recallId}
Fetch recall
GetDirectdebitsIDRecallsRecallID 2 params → 200404
GET
/transaction/directdebits/{id}/recalls/{recallId}/admissions/{admissionId}
Fetch recall admission
GetDirectdebitsIDRecallsRecallIDAdmissionsAdmissionID 3 params → 200404
GET
/transaction/directdebits/{id}/recalls/{recallId}/submissions/{submissionId}
Fetch recall submission
GetDirectdebitsIDRecallsRecallIDSubmissionsSubmissionID 3 params → 200404
POST
/transaction/directdebits/{id}/returns
Create direct debit return
PostDirectdebitsIDReturns 1 param body → 201400404409
GET
/transaction/directdebits/{id}/returns/{returnId}
Fetch direct debit return
GetDirectdebitsIDReturnsReturnID 2 params → 200404
GET
/transaction/directdebits/{id}/returns/{returnId}/admissions/{admissionId}
Fetch return admission
GetDirectdebitsIDReturnsReturnIDAdmissionsAdmissionID 3 params → 200404
GET
/transaction/directdebits/{id}/returns/{returnId}/reversals/{reversalId}
Fetch return admission
GetDirectdebitsIDReturnsReturnIDReversalsReversalID 3 params → 200404
GET
/transaction/directdebits/{id}/returns/{returnId}/reversals/{reversalId}/admissions/{admissionId}
Fetch return admission
GetDirectdebitsIDReturnsReturnIDReversalsReversalIDAdmissionsAdmissionID 4 params → 200404
POST
/transaction/directdebits/{id}/returns/{returnId}/submissions
create direct debit return submission
PostDirectdebitsIDReturnsReturnIDSubmissions 2 params body → 201400404
GET
/transaction/directdebits/{id}/returns/{returnId}/submissions/{submissionId}
Fetch return submission
GetDirectdebitsIDReturnsReturnIDSubmissionsSubmissionID 3 params → 200404
POST
/transaction/directdebits/{id}/reversals
Create direct debit reversal
PostDirectdebitsIDReversals 1 param body → 201400404409
GET
/transaction/directdebits/{id}/reversals/{reversalId}
Fetch direct debit reversal
GetDirectdebitsIDReversalsReversalID 2 params → 200404
GET
/transaction/directdebits/{id}/reversals/{reversalId}/admissions/{admissionId}
Fetch reversal admission
GetDirectdebitsIDReversalsReversalIDAdmissionsAdmissionID 3 params → 200404
POST
/transaction/directdebits/{id}/reversals/{reversalId}/submissions
create reversal submission
PostDirectdebitsIDReversalsReversalIDSubmissions 2 params body → 201400404
GET
/transaction/directdebits/{id}/reversals/{reversalId}/submissions/{submissionId}
Fetch reversal submission
GetDirectdebitsIDReversalsReversalIDSubmissionsSubmissionID 3 params → 200404
POST
/transaction/directdebits/{id}/submissions
Create direct debit submission
PostDirectdebitsIDSubmissions 1 param body → 201400404
GET
/transaction/directdebits/{id}/submissions/{submissionId}
Get direct debit submission
GetDirectdebitsIDSubmissionsSubmissionID 2 params → 200404

Schemas 83

The contract defines 83 schemas that model the data the API accepts and returns. The most detailed are UltimateEntity (21 properties), PostalAddress (15 properties), DirectDebitReturn (8 properties), DirectDebitAdmission (8 properties). Each schema is shown below with its type and property counts.

DirectDebitReversalCreationResponse
object
2 properties
DirectDebitRecallAdmissionStatus
string
[Status](http://draft-api-docs.form3.tech/api.htmlenumerations-payment-admission-status) of the recall admission
DirectDebitDecisionSubmission
object
8 properties 2 required
DirectDebitDetailsResponse
object
2 properties
DirectDebitReturn
object
8 properties 3 required
DirectDebitReturnReversal
object
8 properties 2 required
Links
object
5 properties 1 required
DirectDebitRecallCreationResponse
object
2 properties
DirectDebitDecisionAdmission
object
8 properties 3 required
Settlement
object
Specifies the details on how the settlement of the transaction between the instructing agent and the instructed agent is completed
5 properties
DirectDebitRecallSubmission
object
8 properties 2 required
PrivateIdentification
object
4 properties
DirectDebitDecisionDetailsResponse
object
2 properties
DirectDebitRecallAdmission
object
8 properties 1 required
DirectDebitReversalSubmissionStatus
string
DirectDebitAdmission
object
8 properties 3 required
DirectDebitReturnCreationResponse
object
2 properties
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.
DirectDebitReturnReversalAdmissionDetailsResponse
object
2 properties
DirectDebitCreation
object
1 property
DirectDebitRecall
object
8 properties 1 required
DirectDebitDecisionAdmissionStatus
string
DirectDebitReversal
object
8 properties 2 required
DirectDebitDecisionCreation
object
1 property
DirectDebitReturnSubmissionDetailsResponse
object
2 properties
DirectDebitReversalSubmissionDetailsResponse
object
2 properties
DirectDebitReturnSubmissionStatus
string
DirectDebitSubmissionRelationships
object
1 property
DirectDebitRecallCreation
object
1 property
CurrencyAndAmount
object
2 properties
DirectDebitReturnReversalAdmission
object
8 properties 3 required
DirectDebitRecallDetailsResponse
object
2 properties
DirectDebitSubmissionCreation
object
1 property
DirectDebitReversalSubmissionCreationResponse
object
2 properties
DirectDebitReversalAdmissionDetailsResponse
object
2 properties
DirectDebitReversalDetailsResponse
object
2 properties
DirectDebitDecisionAdmissionRelationships
object
2 properties
AccountNumberCode
string
The type of identification given at accountnumber attribute
PostalAddress
object
15 properties
DirectDebitAdmissionRelationships
object
1 property
DirectDebitSubmissionDetailsResponse
object
2 properties
DirectDebitDecisionSubmissionCreationResponse
object
2 properties
DirectDebitReturnAdmissionDetailsResponse
object
2 properties
DirectDebitReturnAdmission
object
8 properties 3 required
DirectDebitMandate
object
2 properties
DirectDebitSubmissionCreationResponse
object
2 properties
AccountWithBankId
object
2 properties
DirectDebitReturnSubmissionCreation
object
1 property
DirectDebitReturnAdmissionStatus
string
DirectDebitReversalSubmissionCreation
object
1 property
DirectDebitReturnCreation
object
1 property
DirectDebitReturnDetailsResponse
object
2 properties
DirectDebitReversalAdmissionStatus
string
DirectDebitReturnAdmissionRelationships
object
2 properties
DirectDebitReversalAdmission
object
8 properties 3 required
DirectDebitReturnReversalDetailsResponse
object
2 properties
DirectDebitDecision
object
8 properties 3 required
DirectDebitAdmissionStatusReason
string
ApiError
object
2 properties
DirectDebitRecallSubmissionDetailsResponse
object
2 properties
DirectDebitSubmissionStatus
string
DirectDebitReturnSubmission
object
8 properties 2 required
DirectDebitDecisionSubmissionCreation
object
1 property
DirectDebitDecisionSubmissionStatus
string
UltimateEntity
object
21 properties
DirectDebitDecisionCreationResponse
object
2 properties
DirectDebitRecallSubmissionStatus
string
DirectDebitReversalCreation
object
1 property
DirectDebitReversalSubmission
object
8 properties 2 required
DirectDebitDecisionAdmissionDetailsResponse
object
2 properties
BankIdCode
string
DirectDebitRecallAdmissionDetailsResponse
object
2 properties
DirectDebitReturnSubmissionCreationResponse
object
2 properties
DirectDebitCreationResponse
object
2 properties
DirectDebitRelationships
object
7 properties
DirectDebitSubmission
object
8 properties 2 required
DirectDebitAdmissionDetailsResponse
object
2 properties
DirectDebitDecisionAdmissionStatusReason
string
DirectDebitDecisionSubmissionDetailsResponse
object
2 properties
DirectDebit
object
8 properties 3 required
DirectDebitAdmissionStatus
string
BeneficiaryDebtorOrganisationIdentification
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

form3-directdebits-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 Reads API
AE Profile APIs.io
Form3 Mandates API
AE Profile APIs.io
Form3 Metrics API
AE Profile APIs.io
Form3 Name Verification API
AE Profile APIs.io
#Direct Debits
← Back to F APIs
API Details
ID
form3:form3-directdebits-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-directdebits-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/form3-directdebits-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 Direct Debits 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.