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 Payment Initiations API

The Payment Initiations API from Modulr — 5 operation(s) for payment initiations.

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

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

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

5 operations 5 paths 18 schemas 3 GET2 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 Payment Initiations 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 5

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

Payment Initiations 5
POST
/standing-order-initiations
Initiate standing order from ASPSP
createStandingOrderInitiation body → 201400
POST
/payment-initiations
Initiate payment from ASPSP
createPaymentInitiation body → 201400
GET
/standing-order-initiations/{standingOrderInitiationId}
Get standing order initiation request details
getStandingOrderInitiation 1 param → 200400404
GET
/payment-initiations/{paymentInitiationId}
Get payment initiation request details
getPaymentInitiation 1 param → 200400404
GET
/aspsps
Get supported ASPSPs
getAspsProviders → 200400

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are pispgateway.PaymentInitiationResponse (7 properties), pispgateway.StandingOrderInitiationResponse (6 properties), pispgateway.CreatePaymentInitiationRequest (5 properties), pispgateway.Destination (5 properties). Each schema is shown below with its type and property counts.

pispgateway.DeliveryAddress
object
Information that locates and identifies a specific address, as defined by postal services or in free format text, must be specified if paymentContextCode is EC…
5 properties 4 required
pispgateway.StandingOrderSchedule
object
The schedule of the standing order
3 properties 2 required
pispgateway.PaymentAmount
object
The amount of the payment
2 properties 2 required
pispgateway.PaymentInitiationResponse
object
Response object for Get Payment Initiation
7 properties
pispgateway.Destination
object
The destination account for the payment
5 properties 1 required
pispgateway.AspsProviderResponse
object
3 properties
pispgateway.CreateStandingOrderInitiationRequest
object
Request object to Initiate Standing Order
4 properties 4 required
pispgateway.PaymentContext
object
Payment context for the initiation request
3 properties 1 required
pispgateway.CreatePaymentInitiationRequest
object
Request object to Initiate Payment
5 properties 4 required
pispgateway.Capability
object
2 properties
pispgateway.CreatePaymentInitiationResponse
object
Response object to Initiate Payment
2 properties
pispgateway.LegacyPaymentContext
object
Payment context for the initiation request
4 properties
pispgateway.CreateStandingOrderInitiationResponse
object
Response object to Initiate Standing Order
2 properties
pispgateway.MerchantDetails
object
Merchant details for the payment context
2 properties
pispgateway.StandingOrderInitiationResponse
object
Response object for Get Standing Order Initiation
6 properties
pispgateway.StandingOrderPayment
object
The payment of the standing order
3 properties 3 required
pispgateway.MessageResponse
object
5 properties
pispgateway.StandingOrderPaymentAmount
object
The amount of the standing order
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

modulr-payment-initiations-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 Payment Initiations 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.