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

Modulr Direct Debits API

Direct Debit operations

Modulr Direct Debits API is one of 26 APIs that Modulr 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, and an API reference.

This API exposes 14 operations across 14 paths, and defines 24 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://api-sandbox.modulrfinance.com/api-sandbox-token.

14 operations 14 paths 24 schemas 6 GET8 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.modulrfinance.com
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Modulr Direct Debits API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (modulo_security). An API key is passed in the header as Authorization (TOKEN). By default, every request must be authenticated.

Paths & Operations 14

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

Direct Debits 14

Direct Debit operations

POST
/mandates/{mandateId}/collectionschedules
Create the collection schedule for the given mandate-id.
createCollectionSchedule 1 param body → 200400404
POST
/mandates/{mandateId}/cancel
Cancel Mandate for given mandate-id.
cancelMandate 1 param body → 200400404
POST
/mandates/bulk-create
Bulk request of Direct Debit mandates for the given account-id.
createBulkMandate body → 200400404
POST
/mandates/bulk-cancel
Bulk mandate cancellation request for the given account-id.
cancelBulkMandate body → 200400404
POST
/collectionschedules/{collectionScheduleId}/cancel
Cancel a Direct Debit collection schedule for the given collection-id.
cancelCollectionSchedule 1 param → 200400404
POST
/collections/{collectionId}/cancel
Cancel a Direct Debit collection for the given collection-id.
cancelCollection 1 param → 200400404
POST
/collection/{collectionId}/represent
Represent collection for given collection id
representCollection 1 param → 200400404
POST
/accounts/{accountId}/mandates
Create a Direct Debit mandate for the given account-id.
createMandate 1 param body → 200400404
GET
/reconciliations
Get Reconciliations based on search criteria.
getReconciliations 6 params → 200400404
GET
/mandates
Get Mandates based on search criteria.
getMandates 17 params → 200400404
GET
/indemnity-claims
Get Indemnity Claims based on search criteria
getIndemnityClaims 9 params → 200400404
GET
/indemnity-claims/{indemnityClaimId}
Get an Indemnity Claim for a given id
getIndemnityClaim 1 param → 200400404
GET
/collectionschedules
Get all collectionschedules for a mandate
getCollectionSchedules 5 params → 200400404
GET
/collections
Get all collection activities of an account
getCollections 9 params → 200400404

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are directdebit.Mandate (14 properties), directdebit.IndemnityClaimResponse (13 properties), directdebit.Collection (13 properties), directdebit.CollectionScheduleResponse (11 properties). Each schema is shown below with its type and property counts.

directdebit.IndemnityClaimResponse
object
13 properties
directdebit.MessageResponse
object
5 properties
directdebit.Collection
object
13 properties 11 required
directdebit.MandatePageResponse
object
5 properties 5 required
directdebit.BulkCreateMandateRequest
object
List of Details of the Direct Debit mandates.
4 properties 3 required
directdebit.IndemnityClaimPageResponse
object
5 properties 5 required
directdebit.ReconciliationPageResponse
object
5 properties 5 required
directdebit.status
array
Status of the Mandate
directdebit.accountId
array
Id(s) of account to fetch Mandates for.
directdebit.id
array
Id(s) of Mandate(s) to fetch.
directdebit.DirectDebitPageResponseCollectionScheduleResponse
object
5 properties 5 required
directdebit.CreateMandateRequest
object
Details of the Direct Debit mandate.
10 properties 8 required
directdebit.IndemnityClaimStatusHistoryResponse
object
3 properties
directdebit.DirectDebitPageResponseCollection
object
5 properties 5 required
directdebit.CreateCollectionScheduleRequest
object
Details of collection to create.
10 properties 3 required
directdebit.BulkCreateResponse
object
6 properties 6 required
directdebit.IndemnityClaimDirectDebitResponse
object
3 properties
directdebit.CollectionScheduleResponse
object
11 properties 5 required
directdebit.ReconciliationResponse
object
8 properties
directdebit.Mandate
object
14 properties 9 required
directdebit.CancelMandateRequest
object
Details of Mandate cancellation.
1 property 1 required
directdebit.Address
object
5 properties 4 required
directdebit.BulkCancelMandateRequest
object
List of the Direct Debit mandates to cancel
4 properties 3 required
directdebit.BulkCancelMandateResponse
object
6 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

modulr-direct-debits-api-openapi.yml Raw ↑

Other APIs Modulr publishes across the network.

Modulr Access Group API
Modulr Accounts API
Modulr Async API
Modulr Beneficiaries API
Modulr Card Simulator API
Modulr Cards API
Modulr Cards Bulk Operations API
Modulr Channel Manager Card API
Modulr Channel Manager Webhook Notifications API
Modulr Confirmation of Payee API
Modulr Customers API
Modulr Direct Debit Outbound Mandate Operations API
Where this information came from

This is an independent, third-party profile of Modulr 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.