Sign in

v1

latestOpenAPI 3.1.0© Modulr Finance2026-08-04207430590.4 KB
Cards

View the details of existing cards

get/cards

Query parameters

fromCreatedDatestring

Cards created on or after this date. Cannot be older than 7 days. Format is yyyy-MM-dd'T'HH:mm:ss with zero offset from UTC. Required if toCreatedDate is supplied.

toCreatedDatestring

Cards created on or before this date. Format is yyyy-MM-dd'T'HH:mm:ss with zero offset from UTC. Optional if fromCreatedDate is supplied.

statuses'CREATED' | 'ACTIVE' | 'BLOCKED' | 'SUSPENDED' | 'CANCELLED' | 'EXPIRED'

Statuses of cards to be retrieved

idstring

The ID of the card to view.

accountIdstring

The ID of account to retrieve cards for.

externalRefstring

The client reference of the card to retrieve.

customerIdstring

The ID of the customer to retrieve cards for.

currencystring

Currency to get cards for. Expected ISO Standard currency name i.e. GBP, EUR etc

customFieldKeystring

Custom Field Key to get cards for

customFieldValuestring

Custom Field Value corresponding to the custom field key to get cards for

accountIdsstring[]

Set of account Ids to retrieve cards for.

channelManagerIdstring

The Id of the Channel manager

frequencyUsage'SINGLE_USE' | 'MULTI_USE'

How many times a card can be authorised against. This parameter is rejected for physical cards

pageinteger

Page to fetch (0 indexed)

sizeinteger

Size of page to fetch

Response

Cards returned successfully

sizeinteger required

Page size

totalSizeinteger required

Total count

pageinteger required

Current page number, 0 based; i.e first-page = 0, second-page = 1

totalPagesinteger required

Total pages

Example response

{
  "content": [
    {
      "id": "V000000001",
      "holder": {
        "title": "Mr",
        "firstName": "Joe",
        "lastName": "Bloggs",
        "billingAddress": {
          "addressLine1": "Floor 10",
          "addressLine2": "80 George Street",
          "postTown": "EDINBURGH",
          "postCode": "EH2 3BU",
          "country": "GB"
        },
        "dateOfBirth": "2001-01-01",
        "mobileNumber": "+447123456000",
        "email": "cardholder@example.com"
      },
      "expiry": "2018-12",
      "currency": "GBP",
      "limit": "1000.00",
      "maxLimit": "4000.00",
      "spend": "250.00",
      "externalRef": "TTQ_51211",
      "maskedPan": "527095******3544",
      "cardType": "Business",
      "cardScheme": "MASTERCARD",
      "accountBid": "A020N8PD",
      "productId": "O210003A",
      "format": "PHYSICAL",
      "constraints": {
        "mccWhitelist": [
          "1000",
          "1002-3000",
          "5060"
        ],
        "authorisation": {
          "spend": [
            {
              "currency": "GBP"
            }
          ]
        }
      },
      "cancellationDate": "2025-01-01",
      "threeDSecureStatus": "ENROLLED",
      "authentication": {
        "otpSmsStatus": "ENROLLED",
        "knowledgeBaseStatus": "ENROLLED"
      },
      "shippingAddress": {
        "addressLine1": "Floor 10",
        "addressLine2": "80 George Street",
        "postTown": "EDINBURGH",
        "postCode": "EH2 3BU",
        "country": "GB"
      },
      "channelManagerId": "M883412312",
      "frequencyUsage": "SINGLE_USE"
    }
  ]
}