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 Variable Recurring Payments API

The Variable Recurring Payments API from Modulr — 5 operation(s) for variable recurring payments.

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

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

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

6 operations 5 paths 17 schemas 1 DELETE2 GET3 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 Variable Recurring Payments 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 6

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

Variable Recurring Payments 6
POST
/vrp
Initiate a Variable Recurring Payment.
initiateVrpPayment body → 201400
POST
/vrp-consents
Create a VRP consent
initiateConsentCreation body → 201400
POST
/vrp-consents/{consentId}/funds-confirmation
Confirm the availability of funds in an account.
confirmFunds 1 param body → 200400
GET
/vrp/{vrpPaymentId}
Get Variable Recurring Payment
getVrpPayment 1 param → 200400
GET
/vrp-consents/{consentId}
Get VRP consent.
getVrpConsent 1 param → 200400
DELETE
/vrp-consents/{consentId}
Revoke a VRP consent.
revokeVrpConsent 1 param → 202400

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are pispgateway.PostalAddress (18 properties), pispgateway.VrpConsentResponse (12 properties), pispgateway.CreateVrpConsentCreationRequest (11 properties), pispgateway.OBRisk (6 properties). Each schema is shown below with its type and property counts.

pispgateway.CreateVrpConsentInitiationResponse
object
Response object to Initiate Vrp Consent
2 properties
pispgateway.VrpConfirmationOfFundsResponse
object
2 properties
pispgateway.Destination
object
The destination account for the payment
5 properties 1 required
pispgateway.Payment
object
3 properties 2 required
pispgateway.PaymentConstraints
object
Limits that will apply to payments initiated using this consent.
2 properties 1 required
pispgateway.VrpPaymentDetailsResponse
object
5 properties 3 required
pispgateway.VrpConfirmationOfFundsRequest
object
Request object to confirm the availability of funds in account
2 properties 1 required
pispgateway.VrpConsentResponse
object
Response object of VRP Consent
12 properties 6 required
pispgateway.CreateVrpConsentCreationRequest
object
Request object to Initiate VRP Consent Creation
11 properties 5 required
pispgateway.OBRisk
object
6 properties 4 required
pispgateway.PostalAddress
object
18 properties
pispgateway.UltimateParty
object
4 properties
pispgateway.VrpPaymentRequest
object
3 properties 2 required
pispgateway.MaximumIndividualVrPayment
object
Maximum amount of any single payment initiated using this consent.
2 properties 1 required
pispgateway.VrpPaymentResponse
object
2 properties 1 required
pispgateway.MessageResponse
object
5 properties
pispgateway.PeriodicLimit
object
Maximum amount of all payments that can be initiated using this consent in a given period. If the periodAlignment is “Calendar”, the limit is pro-rated in the…
4 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

modulr-variable-recurring-payments-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 Variable Recurring Payments 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.