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

Form3 Direct Debits Reads API

The DirectDebitsReads API from Form3 — 1 operation(s) for directdebitsreads.

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

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

This API exposes 1 operation across 1 path, and defines 48 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.

1 operations 1 paths 48 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 2

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

  • OAuth2 — OAuth 2.0 with Client Credentials Grant type

Paths & Operations 1

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

DirectDebitsReads 1
GET
/transaction/directdebits
List direct debits
GetDirectdebits 34 params → 200

Schemas 48

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

DirectDebitDecisionSubmissionStatus
string
UltimateEntity
object
21 properties
DirectDebitRecall
object
8 properties 1 required
DirectDebitRecallAdmissionStatus
string
[Status](http://draft-api-docs.form3.tech/api.htmlenumerations-payment-admission-status) of the recall admission
DirectDebitDecisionAdmissionStatus
string
DirectDebitDecisionSubmission
object
8 properties 2 required
DirectDebitRecallSubmissionStatus
string
DirectDebitReturnAdmission
object
8 properties 3 required
DirectDebitReversal
object
8 properties 2 required
BeneficiaryDebtorOrganisationIdentification
object
4 properties
DirectDebitSubmissionStatus
string
DirectDebitReversalSubmission
object
8 properties 2 required
DirectDebitMandate
object
2 properties
DirectDebitReturn
object
8 properties 3 required
AccountWithBankId
object
2 properties
DirectDebitReturnReversal
object
8 properties 2 required
Links
object
5 properties 1 required
DirectDebitReturnSubmissionStatus
string
BankIdCode
string
DirectDebitSubmissionRelationships
object
1 property
DirectDebitReturnAdmissionStatus
string
CurrencyAndAmount
object
2 properties
DirectDebitReturnReversalAdmission
object
8 properties 3 required
DirectDebitRelationships
object
7 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
DirectDebitSubmission
object
8 properties 2 required
DirectDebitReversalAdmissionStatus
string
DirectDebitDecisionAdmissionStatusReason
string
DirectDebitReturnAdmissionRelationships
object
2 properties
DirectDebitReversalAdmission
object
8 properties 3 required
RecallStatus
string
The status of the recall, can either be pending, confirmed, or failed.
DirectDebitRecallAdmission
object
8 properties 1 required
DirectDebitReversalSubmissionStatus
string
DirectDebitDecisionAdmissionRelationships
object
2 properties
DirectDebit
object
8 properties 3 required
AccountNumberCode
string
The type of identification given at accountnumber attribute
PostalAddress
object
15 properties
DirectDebitAdmissionRelationships
object
1 property
DirectDebitAdmission
object
8 properties 3 required
DirectDebitDecision
object
8 properties 3 required
DirectDebitAdmissionStatus
string
AccountHoldingEntity
object
Information about the financial institution servicing the account.
6 properties 2 required
DirectDebitAdmissionStatusReason
string
DirectDebitDetailsListResponse
object
2 properties
DirectDebitReturnSubmission
object
8 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

form3-directdebitsreads-api-openapi.yml Raw ↑

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 Mandates API
Form3 Metrics API
Form3 Name Verification API
Where this information came from

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

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

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

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