Sign in

v1

latestOpenAPI 3.1.0© Modulr Finance2026-08-04207430590.4 KB
Channel Manager Card

Channel Manager Card enquiry

Retrieve card details by PAN

post/channel-managers/cards/enquiry

Request body

panstring

pan

providerSuppliedIdstring

providerSuppliedId

Response

Card enquiry successful

idstring

Card identifier. Maximum of 10 alphanumeric characters

expirystring

An ISO 8601 date with year & month components only

statusstring

The current state of the card.

currencystring

A 3 letter ISO 4217 code representing the card currency

limitstring

Total card authorisation limit

maxLimitstring

Maximum limit which can be set on this card and is the maximum lifetime spend the card can have

spendstring

Current total of all authorisations on this card

externalRefstring

Client reference for the newly created card. Maximum of 50 characters.

maskedPanstring

Masked card PAN

cardTypestring

Card product type

cardSchemestring

Card scheme. MASTERCARD or VISA

accountBidstring

Account identifier

productIdstring

Product identifier

format'PHYSICAL' | 'VIRTUAL'

The format of the card. PHYSICAL or VIRTUAL

printedNamestring

Name printed on the card. Will only be returned for physical cards. Maximum of 20 alphanumeric characters (including full stop, hyphen, apostrophe, caret and space)

cancellationDatestring

Date card will be cancelled on

createdDatestring date-time
threeDSecureStatus'NOT_ENROLLED' | 'ENROLLED' | 'UNENROLLED'

The 3DS status of the card, based on the SMS one time password

channelManagerIdstring

Channel Manager identifier

frequencyUsage'SINGLE_USE' | 'MULTI_USE'

Enum that specifies the frequency usage of the card

Example response

{
  "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"
}