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 Notification API

Operations on Notifications

Modulr Notification API is one of 26 APIs that Modulr publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Notification. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 9 operations across 5 paths, and defines 6 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.

9 operations 5 paths 6 schemas 5 GET2 POST2 PUT

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 Notification 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 9

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

Notification 9

Operations on Notifications

GET
/partners/{partnerId}/notifications/{notificationId}
Retrieve a specific notification by unique reference for a specific partner
getPartnerNotification 2 params → 200400404
PUT
/partners/{partnerId}/notifications/{notificationId}
Update a specific notification by unique reference for a specific partner
editPartnerNotification 2 params body → 200400404
GET
/customers/{customerId}/notifications/{notificationId}
Retrieve a specific notification by unique reference for a specific customer
getCustomerNotification 2 params → 200400404
PUT
/customers/{customerId}/notifications/{notificationId}
Update a specific notification by unique reference for a specific customer
editCustomerNotification 2 params body → 200400404
GET
/partners/{partnerId}/notifications
Get all Notifications linked directly to a Partner
getAllPartnerNotifications 1 param → 200400404
POST
/partners/{partnerId}/notifications
Set up a Notification for a Partner
addPartnerNotification 1 param body → 201400
GET
/customers/{customerId}/notifications
Get all Notifications for a Customer
getAllCustomerNotifications 1 param → 200400404
POST
/customers/{customerId}/notifications
Set up a Notification for a Customer
addCustomerNotification 1 param body → 201400
GET
/webhooks/{webhookId}/failures
Check if a particular webhook has failed
getFailedWebHooks 2 params → 200400

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are notification.NotificationResponse (7 properties), notification.WebHookFailureResponse (6 properties), notification.NotificationConfig (6 properties), notification.MessageResponse (5 properties). Each schema is shown below with its type and property counts.

notification.MessageResponse
object
5 properties
notification.NotificationRequest
object
4 properties 4 required
notification.NotificationConfig
object
6 properties
notification.UpdateNotificationRequest
object
3 properties 3 required
notification.NotificationResponse
object
7 properties 7 required
notification.WebHookFailureResponse
object
6 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

modulr-notification-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 Notification 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.