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 File Upload API

Upload payment files

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

Tagged areas include File Upload. 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 12 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 12 schemas 2 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 File Upload 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 — 2 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

File Upload 5

Upload payment files

POST
/payment-files
Upload payment file and store valid payments
upload-payment-file body → 200400500
POST
/payment-files/{fileId}/proceed
Create payments from an uploaded file
proceed 1 param body → 201400
POST
/payment-files/proceed
Create payments from one or more uploaded files
proceed_1 body → 201400
GET
/payment-files/{fileId}
Get an upload file latest status
status 1 param → 200400
GET
/payment-files/{fileId}/summaries
Get paginated summaries of child file uploads
summaries 3 params → 200400404

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are paymentfileupload.FileUploadSummariesResponse (7 properties), paymentfileupload.FileUploadStatusResponse (7 properties), paymentfileupload.FileCreatePaymentsResult (5 properties), paymentfileupload.MessageResponse (5 properties). Each schema is shown below with its type and property counts.

paymentfileupload.FileUploadResponse
object
1 property 1 required
paymentfileupload.MessageResponse
object
5 properties
paymentfileupload.FileCreateRequest
object
File create payments request body
1 property
paymentfileupload.FileCreatePaymentsResponse
object
File create payments response
4 properties 3 required
paymentfileupload.FileUploadSummaryContent
object
Summary of a single child file upload
4 properties
paymentfileupload.FileUploadRequest
object
File upload request body
4 properties 2 required
paymentfileupload.FilesCreatePaymentsRequest
object
Request body containing file IDs to process for payment creation
2 properties 1 required
paymentfileupload.FileUploadStatusResponse
object
File upload Status Response
7 properties 1 required
paymentfileupload.PaymentSummary
object
Aggregated payment count per destination account
3 properties
paymentfileupload.FilesCreatePaymentsResponse
object
Response containing payment creation results for multiple files
1 property
paymentfileupload.FileUploadSummariesResponse
object
Paginated summaries of child file uploads for a delegate payment file
7 properties
paymentfileupload.FileCreatePaymentsResult
object
Payment creation result for an individual file in a multi-file request
5 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

modulr-file-upload-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 File Upload 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.