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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Modulr

Modulr Payments API

Operations on Payments

Documentation Provider Profile APIs.io OpenAPI GitHub

Modulr 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 Payments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 6 operations across 4 paths, and defines 38 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 4 paths 38 schemas 3 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
License
© Modulr Finance
Resource Areas
1

Authentication & Security 2

Modulr 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 4 paths, the API surfaces 6 operations — 3 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Payments 6

Operations on Payments

GET
/payments
Retrieve payments
getPayments 28 params → 200400
POST
/payments
Create a payment
sendPayment body → 201400
GET
/batchpayments
Get batch payments by a given set of parameters
getBatchPayments 12 params → 200400
POST
/batchpayments
Make a batch payment
submitBatchPayments body → 201400
POST
/batchpayments/{batchPaymentId}/cancel
Cancel the batch payment
cancelBatchPayments 1 param → 204400
GET
/batchpayments/{id}
Get batch payment by ID
getBatchPayment 1 param → 200400

Schemas 38

The contract defines 38 schemas that model the data the API accepts and returns. The most detailed are payment.OfficialOrganisationIdentity (19 properties), payment.PaymentOutRequest (17 properties), payment.BatchPaymentDetailsResponse (17 properties), payment.BatchPayment (16 properties). Each schema is shown below with its type and property counts.

payment.currency
array
payment.PaymentsSummary
object
Summary of payments and approvals
4 properties
payment.PaymentPageResponse
object
5 properties 5 required
payment.status
array
payment.paymentStatuses
array
payment.RegulatoryAuthority
object
2 properties
payment.approvalStatus
array
Payment approval status, multiple statuses can be specified by repeating the parameter
payment.StructuredRegulatoryReporting
object
4 properties
payment.BatchPaymentsResponse
object
5 properties 5 required
payment.Destination
object
13 properties 1 required
payment.batchPaymentStatuses
array
payment.OverseasAccountIdentifier
object
4 properties
payment.POODetails
object
4 properties
payment.BatchSummary
object
7 properties
payment.Charge
object
3 properties 3 required
payment.DestinationCountrySpecificDetails
object
12 properties
payment.id
array
List of batch payment IDs
payment.NameCheck
object
2 properties 1 required
payment.PaymentApproval
object
A single approval against a batch payment request
2 properties
payment.PaymentResponse
object
13 properties 4 required
payment.RegulatoryReporting
object
3 properties
payment.BatchPaymentSummary
object
8 properties
payment.Address
object
5 properties 1 required
payment.customerId
array
Filter on customer ID
payment.BatchPaymentDetailsResponse
object
17 properties
payment.UltimatePayer
object
7 properties 2 required
payment.OfficialOrganisationIdentity
object
19 properties
payment.MessageResponse
object
5 properties
payment.BatchPaymentOutRequest
object
Details of Batch request
4 properties 1 required
payment.BatchPayment
object
16 properties
payment.SchemeInfo
object
4 properties
payment.ids
array
payment.FxDetails
object
1 property 1 required
payment.AddressRequest
object
6 properties 2 required
payment.PaymentDetails
object
3 properties 3 required
payment.OfficialIdDetails
object
6 properties
payment.BirthDetails
object
3 properties
payment.PaymentOutRequest
object
Details of Payment request
17 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

modulr-payments-api-openapi.yml Raw ↑

Other APIs Modulr publishes across the network.

Modulr Access Group API
AE Profile APIs.io
Modulr Accounts API
AE Profile APIs.io
Modulr Async API
AE Profile APIs.io
Modulr Beneficiaries API
AE Profile APIs.io
Modulr Card Simulator API
AE Profile APIs.io
Modulr Cards API
AE Profile APIs.io
Modulr Cards Bulk Operations API
AE Profile APIs.io
Modulr Channel Manager Card API
AE Profile APIs.io
Modulr Channel Manager Webhook Notifications API
AE Profile APIs.io
Modulr Confirmation of Payee API
AE Profile APIs.io
Modulr Customers API
AE Profile APIs.io
Modulr Direct Debit Outbound Mandate Operations API
AE Profile APIs.io
#Payments
← Back to M APIs
API Details
ID
modulr:modulr-payments-api
Base URL
https://api.modulrfinance.com
Docs
https://modulr.readme.io/docs/account
Provider
Modulr
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=modulr-payments-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/modulr-payments-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

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