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

Cards API

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 51 operations across 43 paths, and defines 66 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.

51 operations 43 paths 66 schemas 5 DELETE17 GET1 PATCH27 POST1 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
License
© Modulr Finance
Resource Areas
1

Authentication & Security 2

Modulr Cards 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 51

Across 43 paths, the API surfaces 51 operations — 5 DELETE, 17 GET, 1 PATCH, 27 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Cards 51

Cards API

PUT
/cards/{cardId}/authentication
Update card authentication
updateCardAuthentication 1 param body → 204400
GET
/partners/{partnerId}/card-report-types/{reportType}/notifications
Retrieve card report type notification configuration for partner
getNotificationConfigurationsForAGivenPartnerAndReportType 4 params → 200400403
POST
/partners/{partnerId}/card-report-types/{reportType}/notifications
Update report type notification configuration for partner
updateNotificationConfigurationsForAGivenPartnerAndReportType 2 params body → 201400403
DELETE
/partners/{partnerId}/card-report-types/{reportType}/notifications
Delete card report notification configuration for partner and report type
deleteAllNotificationConfigurationsForAGivenPartnerAndReportType 2 params → 204400403
POST
/partners/{partnerId}/card-report-types/{reportType}/notifications/status
Toggle card report notification for partner and report type
toggleNotificationsForAGivenPartnerAndReportType 2 params body → 204400403
POST
/partner/{partnerId}/bulk-card-custom-fields
Bulk create partner custom field keys
bulkCreatePartnerCustomFieldKeys 1 param body → 201400
GET
/customers/{customerId}/card-report-types/{reportType}/notifications
Retrieve card report type notification configuration for customer
getNotificationConfigurationsForAGivenCustomerAndReportType 4 params → 200400403
POST
/customers/{customerId}/card-report-types/{reportType}/notifications
Update report type notification configuration for customer
updateNotificationConfigurationsForAGivenCustomerAndReportType 2 params body → 201400403
DELETE
/customers/{customerId}/card-report-types/{reportType}/notifications
Delete card report notification configuration for customer and report type
deleteAllNotificationConfigurationsForAGivenCustomerAndReportType 2 params → 204400403
POST
/customers/{customerId}/card-report-types/{reportType}/notifications/status
Toggled notifications for customer and card report type
toggleNotificationsForAGivenCustomerAndReportType 2 params body → 204400403
POST
/customer/{customerId}/bulk-card-custom-fields
Bulk create customer custom field keys
bulkCreateCustomerCustomFieldKeys 1 param body → 201400
GET
/cards/{cardId}
View the details of an existing card
getCard 1 param → 200400
POST
/cards/{cardId}
Update a card
update 1 param body → 204400
PATCH
/cards/{cardId}
Update card
updateCard 1 param body → 204400403
POST
/cards/{cardId}/unsuspend
[Restricted] Unsuspend a card
unsuspendCard 1 param → 204400
POST
/cards/{cardId}/unblock
Unblock an existing card
unblockCard 1 param → 200400
POST
/cards/{cardId}/suspend
[Restricted] Suspend an existing card
suspendCard 1 param → 204400
POST
/cards/{cardId}/secure-details-token
Create secure card details token
generateCardHolderToken 2 params body → 200400
POST
/cards/{cardId}/replace
Replace a card
replaceCard 1 param body → 201400
GET
/cards/{cardId}/pin
Retrieve PIN
retrievePIN 2 params → 200400403
POST
/cards/{cardId}/pin
Reset card PIN
resetPin 2 params body → 204400403
POST
/cards/{cardId}/pin/unblock
Unblock PIN
unblockPin 1 param → 204400
POST
/cards/{cardId}/in-app-provisioning/apple
Get in-app provisioning data for Apple Pay
getInAppProvisioningForApple 1 param body → 200400
POST
/cards/{cardId}/custom-fields
Update a card's custom fields
updateCardCustomFields 1 param body → 204400
POST
/cards/{cardId}/cancel
Cancel an existing card
cancelCard 1 param body → 200400
POST
/cards/{cardId}/block
Block an existing card
blockCard 1 param → 200400
POST
/cards/{cardId}/activate
Activate a physical card
activateCard 2 params → 204400403
POST
/cards/secure-pin-reset
Reset card PIN
secureResetPin body → 204400403
POST
/cards/enquiry
Card enquiry
cardEnquiry body → 200400
POST
/card-tokens/{tokenId}/unsuspend
Unsuspend card token
unsuspendCardToken 1 param → 204400404
POST
/card-tokens/{tokenId}/suspend
Suspend card token
suspendCardToken 1 param → 204400404
POST
/card-tokens/{tokenId}/deactivate
Deactivate card token
deactivateCardToken 1 param → 204400404
POST
/authorisations/{authId}/expire
[Restricted] Expire an existing authorisation
expireAuthorisation 1 param → 204400404
POST
/accounts/{accountId}/physical-cards
Create a new physical card
createPhysicalCard 1 param body → 202400
GET
/accounts/{accountId}/cards
View the details of existing cards by account
getCardsByAccount 4 params → 200400
POST
/accounts/{accountId}/cards
Create a new virtual card
createCard 1 param body → 201400
GET
/partner/{partnerId}/card-custom-fields
View existing partner card custom field keys
getPartnerCustomFieldKeys 4 params → 200400
GET
/customer/{customerId}/card-custom-fields
View existing customer card custom field keys
getCustomerCustomFieldKeys 4 params → 200400
GET
/cards
View the details of existing cards
getCards 15 params → 200400
GET
/cards/{cardId}/tokens
Get card tokens
getCardTokens 2 params → 200400
GET
/cards/secure-details
Retrieve secure card details (PAN + CVV + PIN)
getSecureCardDetails → 200400403
GET
/card-tokens/{tokenId}/otp
Get card token OTP details
getOtpDetails 1 param → 200400404
GET
/card-tasks
Get tasks
getAsyncTasks 6 params → 200400
GET
/card-reports
Retrieve card reports
searchReports 8 params → 200400403
GET
/card-reports/{reportId}/report
Download a specific card report
retrieveReport 1 param → 200400403404
GET
/card-reports/{reportId}/download
Download a specific card report
retrievePreSignedReportUrl 1 param → 200400403404
GET
/activities
View activities for specific cards or over a date range
getCardActivities 13 params → 200400
GET
/accounts/{accountId}/physical-card-request-tasks
Get physical card create tasks by account
getCreatePhysicalCardAsyncTasksByAccount 4 params → 200400
DELETE
/partner/{partnerId}/card-custom-fields/{key}
Delete partner custom field key
deletePartnerCustomFieldKey 2 params → 202400
DELETE
/customer/{customerId}/card-custom-fields/{key}
Delete customer custom field key
deleteCustomerCustomFieldKey 2 params → 202400
DELETE
/cards/{cardId}/custom-fields/{key}
Delete card custom field
deleteCardCustomField 2 params → 204400

Schemas 66

The contract defines 66 schemas that model the data the API accepts and returns. The most detailed are card.CardResponse (27 properties), card.CardActivityResponse (21 properties), card.CreatePhysicalCardRequest (14 properties), card.CreateCardRequest (11 properties). Each schema is shown below with its type and property counts.

card.ReportTypeNotificationResponse
object
1 property
card.CreateCardRequest
object
Card
11 properties 4 required
card.CardKnowledgeBasedAuthentication
object
2 properties 2 required
card.CardAuthentication
object
1 property 1 required
card.OneTimeTokenResponse
object
4 properties 2 required
card.CardConstraints
object
2 properties 1 required
card.UpdateCardHolder
object
5 properties
card.BulkCreateCustomFieldKeysRequest
object
Bulk create custom field keys request
1 property 1 required
card.AsyncTaskResponse
object
7 properties 4 required
card.CardActivityResponse
object
21 properties 11 required
card.AuthorisationWindow
object
2 properties
card.CardPageResponse
object
5 properties 5 required
card.DownloadReportResponse
object
1 property
card.CardCustomFieldKeyPageResponse
object
5 properties 5 required
card.MessageResponse
object
5 properties
card.CardCustomFieldKeyResponse
object
2 properties
card.CancelCardRequest
object
Reason for cancellation
1 property
card.NotificationRequest
object
Notification request containing the emails to send the report to
1 property
card.CardCustomFieldRequest
object
2 properties 2 required
card.Remove
Remove field
2 required
card.ReportTypeNotificationPageResponse
object
5 properties 5 required
card.SecureCardDetails
object
3 properties 2 required
card.Copy
Copy field
3 required
card.AuthorisationWindowRequest
object
2 properties
card.UpdateCardCustomFieldsRequest
object
Custom fields to be updated
1 property 1 required
card.SpendConstraintDetail
object
Spending constraints
3 properties 1 required
card.CardEnquiryRequest
object
Enquiry
2 properties
card.OtpDetails
object
4 properties 4 required
card.AsyncTaskPageResponse
object
5 properties 5 required
card.Add
Add field
3 required
card.AddressDetail
object
Address details for the cardholder. Optional for individual customers whose partner has verification type EXTERNAL.
5 properties 4 required
card.AppleInAppProvisioningResponse
object
AppleInAppProvisioningRequest
3 properties 3 required
card.CardReplacementRequest
object
Replacement
5 properties 1 required
card.CardThreeDSecureAuthentication
object
2 properties
card.CardCustomFieldResponse
object
2 properties
card.CardResponse
object
27 properties
card.ResetCardPinRequest
object
Reset PIN
2 properties 2 required
card.reportSubjectIds
array
Report subject Ids (Customer BID, Partner BID or Channel Manager BID)
card.CardHolder
object
7 properties 2 required
card.PatchOperation
object
2 properties 2 required
card.CardReplacementResponse
object
8 properties 7 required
card.CardToken
object
Payment token details for a card
8 properties 6 required
card.reportTypes
array
Report types
card.Test
Test field
3 required
card.ReportPageResponse
object
5 properties 5 required
card.CreatePhysicalCardRequest
object
Card
14 properties 6 required
card.CardPinResponse
object
1 property
card.JsonNode
card.ProductDesignDetail
object
2 properties 2 required
card.CreateCardResponse
object
9 properties 7 required
card.AuthorisationConstraints
object
Authorisation constraints
1 property
card.UpdateCardRequest
object
Update card
5 properties
card.CardTokenDevice
object
6 properties 6 required
card.CardActivityPageResponse
object
5 properties 5 required
card.AsyncTaskCreatedResponse
object
3 properties 2 required
card.AppleInAppProvisioningRequest
object
Apple in app provisioning request
4 properties 4 required
card.Replace
Replace field
3 required
card.OneTimeTokenRequest
object
2 properties
card.Move
Move field
3 required
card.UpdateCardAuthenticationRequest
object
Authentication
1 property 1 required
card.Constraints
object
1 property
card.ReportResponse
object
4 properties
card.AuthInfo
object
2 properties 2 required
card.CustomFields
object
2 properties 2 required
card.UpdateCardReportNotificationRequest
object
Notification request containing the status of the notification
1 property 1 required
card.GetCardTokensResponse
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

modulr-cards-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 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
Modulr Direct Debits API
AE Profile APIs.io
#Cards
← Back to M APIs
API Details
ID
modulr:modulr-cards-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-cards-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/modulr-cards-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 Cards 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.