# Modulr Cards API

**Canonical:** https://apis.io/apis/modulr/modulr-cards-api/  
**Provider:** Modulr — https://apis.io/providers/modulr/  
**Base URL:** https://api.modulrfinance.com  
**Documentation:** https://modulr.readme.io/docs/account

Modulr Cards API is one of 26 APIs that [Modulr](https://apis.io/providers/modulr/) publishes on the [APIs.io](https://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.

## Operations (51)

| Method | Path | Summary |
|---|---|---|
| PUT | `/cards/{cardId}/authentication` | Update card authentication |
| GET | `/partners/{partnerId}/card-report-types/{reportType}/notifications` | Retrieve card report type notification configuration for partner |
| POST | `/partners/{partnerId}/card-report-types/{reportType}/notifications` | Update report type notification configuration for partner |
| DELETE | `/partners/{partnerId}/card-report-types/{reportType}/notifications` | Delete card report notification configuration for partner and report type |
| POST | `/partners/{partnerId}/card-report-types/{reportType}/notifications/status` | Toggle card report notification for partner and report type |
| POST | `/partner/{partnerId}/bulk-card-custom-fields` | Bulk create partner custom field keys |
| GET | `/customers/{customerId}/card-report-types/{reportType}/notifications` | Retrieve card report type notification configuration for customer |
| POST | `/customers/{customerId}/card-report-types/{reportType}/notifications` | Update report type notification configuration for customer |
| DELETE | `/customers/{customerId}/card-report-types/{reportType}/notifications` | Delete card report notification configuration for customer and report type |
| POST | `/customers/{customerId}/card-report-types/{reportType}/notifications/status` | Toggled notifications for customer and card report type |
| POST | `/customer/{customerId}/bulk-card-custom-fields` | Bulk create customer custom field keys |
| GET | `/cards/{cardId}` | View the details of an existing card |
| POST | `/cards/{cardId}` | Update a card |
| PATCH | `/cards/{cardId}` | Update card |
| POST | `/cards/{cardId}/unsuspend` | [Restricted] Unsuspend a card |
| POST | `/cards/{cardId}/unblock` | Unblock an existing card |
| POST | `/cards/{cardId}/suspend` | [Restricted] Suspend an existing card |
| POST | `/cards/{cardId}/secure-details-token` | Create secure card details token |
| POST | `/cards/{cardId}/replace` | Replace a card |
| GET | `/cards/{cardId}/pin` | Retrieve PIN |
| POST | `/cards/{cardId}/pin` | Reset card PIN |
| POST | `/cards/{cardId}/pin/unblock` | Unblock PIN |
| POST | `/cards/{cardId}/in-app-provisioning/apple` | Get in-app provisioning data for Apple Pay |
| POST | `/cards/{cardId}/custom-fields` | Update a card's custom fields |
| POST | `/cards/{cardId}/cancel` | Cancel an existing card |
| POST | `/cards/{cardId}/block` | Block an existing card |
| POST | `/cards/{cardId}/activate` | Activate a physical card |
| POST | `/cards/secure-pin-reset` | Reset card PIN |
| POST | `/cards/enquiry` | Card enquiry |
| POST | `/card-tokens/{tokenId}/unsuspend` | Unsuspend card token |
| POST | `/card-tokens/{tokenId}/suspend` | Suspend card token |
| POST | `/card-tokens/{tokenId}/deactivate` | Deactivate card token |
| POST | `/authorisations/{authId}/expire` | [Restricted] Expire an existing authorisation |
| POST | `/accounts/{accountId}/physical-cards` | Create a new physical card |
| GET | `/accounts/{accountId}/cards` | View the details of existing cards by account |
| POST | `/accounts/{accountId}/cards` | Create a new virtual card |
| GET | `/partner/{partnerId}/card-custom-fields` | View existing partner card custom field keys |
| GET | `/customer/{customerId}/card-custom-fields` | View existing customer card custom field keys |
| GET | `/cards` | View the details of existing cards |
| GET | `/cards/{cardId}/tokens` | Get card tokens |
| GET | `/cards/secure-details` | Retrieve secure card details (PAN + CVV + PIN) |
| GET | `/card-tokens/{tokenId}/otp` | Get card token OTP details |
| GET | `/card-tasks` | Get tasks |
| GET | `/card-reports` | Retrieve card reports |
| GET | `/card-reports/{reportId}/report` | Download a specific card report |
| GET | `/card-reports/{reportId}/download` | Download a specific card report |
| GET | `/activities` | View activities for specific cards or over a date range |
| GET | `/accounts/{accountId}/physical-card-request-tasks` | Get physical card create tasks by account |
| DELETE | `/partner/{partnerId}/card-custom-fields/{key}` | Delete partner custom field key |
| DELETE | `/customer/{customerId}/card-custom-fields/{key}` | Delete customer custom field key |
| DELETE | `/cards/{cardId}/custom-fields/{key}` | Delete card custom field |

## Machine-readable artifacts (6)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/modulr/refs/heads/main/openapi/modulr-cards-api-openapi.yml
- **Documentation** — https://modulr.readme.io/docs/account
- **APIReference** — https://modulr.readme.io/reference
- **Documentation** — https://modulr.readme.io/docs/payments-2
- **Documentation** — https://modulr.readme.io/docs/customer
- **Documentation** — https://modulr.readme.io/docs/notifications-1

## Other Modulr APIs (12)

- [Modulr Access Group API](https://apis.io/apis/modulr/modulr-access-group-api/)
- [Modulr Accounts API](https://apis.io/apis/modulr/modulr-accounts-api/)
- [Modulr Async API](https://apis.io/apis/modulr/modulr-async-api/)
- [Modulr Beneficiaries API](https://apis.io/apis/modulr/modulr-beneficiaries-api/)
- [Modulr Card Simulator API](https://apis.io/apis/modulr/modulr-card-simulator-api/)
- [Modulr Cards Bulk Operations API](https://apis.io/apis/modulr/modulr-cards-bulk-operations-api/)
- [Modulr Channel Manager Card API](https://apis.io/apis/modulr/modulr-channel-manager-card-api/)
- [Modulr Channel Manager Webhook Notifications API](https://apis.io/apis/modulr/modulr-channel-manager-webhook-notifications-api/)
- [Modulr Confirmation of Payee API](https://apis.io/apis/modulr/modulr-confirmation-of-payee-api/)
- [Modulr Customers API](https://apis.io/apis/modulr/modulr-customers-api/)
- [Modulr Direct Debit Outbound Mandate Operations API](https://apis.io/apis/modulr/modulr-direct-debit-outbound-mandate-operations-api/)
- [Modulr Direct Debits API](https://apis.io/apis/modulr/modulr-direct-debits-api/)

## Tags

Cards

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/modulr/modulr-cards-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/modulr/.