---
title: "View the details of an existing card"
method: GET
path: "/cards/{cardId}"
tags: ["Cards"]
---

# View the details of an existing card

`GET /cards/{cardId}`

## Path parameters

- `cardId` string, required

## Response `200`

Card returned successfully

- CardCardResponse
  - `id` string — Card identifier. Maximum of 10 alphanumeric characters
  - `holder` CardCardHolder
    - `title` string — Cardholder title is optional for all card types. Maximum of 4 alphanumeric characters.
    - `firstName` string, required — Cardholder first name. Maximum of 20 alphanumeric characters including space, hyphen and apostrophe. Optional for individual customers whose partner has verification type EXTERNAL and for Virtual Business customers.
    - `lastName` string, required — Cardholder last name. Maximum of 20 alphanumeric characters including space, hyphen and apostrophe. Optional for individual customers whose partner has verification type EXTERNAL and for Virtual Business customers.
    - `billingAddress` CardAddressDetail — Address details for the cardholder. Optional for individual customers whose partner has verification type EXTERNAL.
      - `addressLine1` string, required — First line of address
      - `addressLine2` string — Second line of address
      - `postTown` string, required — Post town
      - `postCode` string, required — Postcode
      - `country` 'AT' | 'BE' | 'BG' | 'CY' | 'CZ' | 'DK' | 'EE' | 'FI' | 'FR' | 'DE' | 'GR' | 'HR' | 'HU' | 'IS' | 'IE' | 'IT' | 'LV' | 'LI' | 'LT' | 'LU' | 'MT' | 'NL' | 'NO' | 'PL' | 'PT' | 'RO' | 'SK' | 'SI' | 'ES' | 'SE' | 'AX' | 'AW' | 'BL' | 'CW' | 'GF' | 'GL' | 'GP' | 'ME' | 'MF' | 'MQ' | 'NC' | 'PF' | 'PM' | 'RE' | 'SX' | 'TF' | 'WF' | 'YT' | 'AI' | 'BM' | 'FK' | 'GB' | 'GG' | 'GI' | 'GS' | 'IO' | 'JE' | 'KY' | 'MS' | 'PN' | 'SH' | 'TC' | 'VG', required — Country (ISO 3166 alpha-2 country code)
    - `dateOfBirth` string, date — Cardholder date of birth. Must match date format of yyyy-mm-dd. Required for virtual consumer and physical cards. Optional for individual customers.
    - `mobileNumber` string — Cardholder mobile number. Must start with a '+', followed by the country code and then the mobile number. Required for virtual consumer and physical cards.
    - `email` string, email — Cardholder email
  - `expiry` string — An ISO 8601 date with year & month components only
  - `status` string — The current state of the card.
  - `currency` string — A 3 letter ISO 4217 code representing the card currency
  - `limit` string — Total card authorisation limit
  - `maxLimit` string — Maximum limit which can be set on this card and is the maximum lifetime spend the card can have
  - `spend` string — Current total of all authorisations on this card
  - `externalRef` string — Client reference for the newly created card. Maximum of 50 characters.
  - `maskedPan` string — Masked card PAN
  - `cardType` string — Card product type
  - `cardScheme` string — Card scheme. MASTERCARD or VISA
  - `accountBid` string — Account identifier
  - `productId` string — Product identifier
  - `format` 'PHYSICAL' | 'VIRTUAL' — The format of the card. PHYSICAL or VIRTUAL
  - `constraints` CardCardConstraints
    - `mccWhitelist` string[], required — mccWhitelist
    - `authorisation` CardAuthorisationConstraints — Authorisation constraints
      - `spend` CardSpendConstraintDetail[] — Spending constraints
        - `currency` 'GBP' | 'EUR' | 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'FJD' | 'FKP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'SHP' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL', required — A 3 letter ISO 4217 code representing the transaction currency
        - `min` number — Minimum spend amount (inclusive)
        - `max` number — Maximum spend amount (inclusive)
  - `design` CardProductDesignDetail
    - `cardRef` string, required — Design reference for card
    - `packagingRef` string, required — Design reference for card packaging
  - `printedName` string — 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)
  - `cancellationDate` string — Date card will be cancelled on
  - `createdDate` string, date-time
  - `threeDSecureStatus` 'NOT_ENROLLED' | 'ENROLLED' | 'UNENROLLED' — The 3DS status of the card, based on the SMS one time password
  - `authentication` CardCardThreeDSecureAuthentication
    - `otpSmsStatus` 'NOT_ENROLLED' | 'ENROLLED' | 'UNENROLLED' — The SMS one time password authentication status
    - `knowledgeBaseStatus` 'NOT_ENROLLED' | 'ENROLLED' | 'UNENROLLED' — The knowledge based authentication (KBA) status
  - `shippingAddress` CardAddressDetail — Address details for the cardholder. Optional for individual customers whose partner has verification type EXTERNAL.
    - `addressLine1` string, required — First line of address
    - `addressLine2` string — Second line of address
    - `postTown` string, required — Post town
    - `postCode` string, required — Postcode
    - `country` 'AT' | 'BE' | 'BG' | 'CY' | 'CZ' | 'DK' | 'EE' | 'FI' | 'FR' | 'DE' | 'GR' | 'HR' | 'HU' | 'IS' | 'IE' | 'IT' | 'LV' | 'LI' | 'LT' | 'LU' | 'MT' | 'NL' | 'NO' | 'PL' | 'PT' | 'RO' | 'SK' | 'SI' | 'ES' | 'SE' | 'AX' | 'AW' | 'BL' | 'CW' | 'GF' | 'GL' | 'GP' | 'ME' | 'MF' | 'MQ' | 'NC' | 'PF' | 'PM' | 'RE' | 'SX' | 'TF' | 'WF' | 'YT' | 'AI' | 'BM' | 'FK' | 'GB' | 'GG' | 'GI' | 'GS' | 'IO' | 'JE' | 'KY' | 'MS' | 'PN' | 'SH' | 'TC' | 'VG', required — Country (ISO 3166 alpha-2 country code)
  - `customFields` CardCardCustomFieldResponse[] — Custom fields currently defined for card
    - `key` string — Custom field key
    - `value` string — Custom field value
  - `authWindow` CardAuthorisationWindow
    - `startDate` string, date-time — Authorisation window start date
    - `endDate` string, date-time — Authorisation window end date
  - `channelManagerId` string — Channel Manager identifier
  - `frequencyUsage` 'SINGLE_USE' | 'MULTI_USE' — Enum that specifies the frequency usage of the card

## Other responses

- `400` — Invalid request

---

[API](https://skmtc.net/modulrfinance/apis/modulr-api.md) · [All operations](https://skmtc.net/modulrfinance/apis/modulr-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/modulrfinance/modulr-api/versions/cbd52524c8ef/schema)