Skip to content

Get list of cards of Cardholder

This method retrieves the list of cards for a specified Cardholder including a complete set of card settings and restrictions.

URL test:

https://dev.lightcms.io/cms/v1/cards/holders/{holderExternalId}

URL live:

https://fat.lightcms.io/cms/v1/cards/holders/{holderExternalId}

Method:

GET

Path items:

/cards (Card Service)

/holders (Cardholder details)

/{holderExternalId} (ID of cardholder)

Parameters:

Parameter Location Type Example Description Required
holderExternalId path string "132132123" External ID of holder Yes

Example:

curl -X 'GET' \
  'https://dev.lightcms.io/cms/v1/cards/holders/132132123' \
  -H 'accept: */*'

Responses:

200 - OK

Status Code: 200 OK 

{
  "card": {
    "cpdCode": "VISA_PHYS_1",
    "cpdVersion": 2,
    "cpdId": "2",
    "cardId": 11,
    "name": "VISA Physical Retail",
    "image": [
      "phys_standard.png"
    ],
    "associationCode": "VISA",
    "cardType": "DEBIT",
    "pan": "4511***5817",
    "cardProcessorId": "777821234",
    "status": "ACTIVE",
    "validFrom": "2024-04-01",
    "validTo": "2028-04-01",
    "expressDelivery": false,
    "ecommerceStatus": true
  },
  "holder": {
    "holderExternalId": "1001863",
    "firstName": "Duncan",
    "lastName": "Clarke",
    "embossName": "CLARKE DUNCAN",
    "sex": "MALE",
    "birthdate": "01-01-1970",
    "phoneNumber": "123456789",
    "residenceAddress": {
      "addressLine1": "Boční 300",
      "city": "Jablonec nad Nisou",
      "country": "CZE",
      "zip": "46801"
    },
    "mailingAddress": {
      "addressLine1": "Českomalínská 1037/ 24",
      "city": "Praha",
      "country": "CZE",
      "zip": "16000"
    },
    "knownAddresses": [
      {
        "addressLine1": "Národní 60/28",
        "city": "Prague",
        "country": "CZE",
        "zip": "110 00"
      },
      {
        "addressLine1": "Českomalínská 1037/ 24",
        "city": "Praha",
        "country": "CZE",
        "zip": "16000"
      },
      {
        "addressLine1": "Boční 300",
        "city": "Jablonec nad Nisou",
        "country": "CZE",
        "zip": "46801"
      }
    ]
  },
  "delivery": {
    "deliveryType": "POST",
    "deliveryAddress": {
      "addressLine1": "Národní 60/28",
      "city": "Prague",
      "country": "CZE",
      "zip": "110 00"
    },
    "expressDelivery": false
  },
  "accounts": {
    "accountOwner": {
      "holderExternalId": "1001863",
      "firstName": "Duncan",
      "lastName": "Clarke"
    },
    "accounts": [
      {
        "accountExternalId": "1000019953",
        "accountCurrency": "CZK"
      }
    ]
  },
  "limits": [
    {
      "limitId": "LIM_17_POS_AMT_D",
      "name": "POS transactions",
      "limitValue": 50000,
      "currentLimitValue": 50000,
      "limitType": "AMOUNT"
    },
    {
      "limitId": "LIM_17_ECOM_AMT_D",
      "name": "E-commerce transactions",
      "limitValue": 20000,
      "currentLimitValue": 20000,
      "limitType": "AMOUNT"
    },
    {
      "limitId": "LIM_17_ATM_AMT_D",
      "name": "ATM withdrawals",
      "limitValue": 50000,
      "currentLimitValue": 50000,
      "limitType": "AMOUNT"
    }
  ],
  "blocks": [
    {
      "blockId": 29,
      "blockReason": "LOST",
      "validFrom": "2024-04-10T00:00:00Z",
      "validTo": "2999-12-31T00:00:00Z",
      "requestedBy": "BANK"
    }
  ],
  "restrictions": [
    {
      "restrictionId": "TPRF_17_01_2",
      "restrictionType": "TRANSACTION_FLAG",
      "restrictionValue": "DISABLED",
      "name": "Cash transactions",
      "restrictionValues": [
        "ENABLED",
        "DISABLED"
      ]
    },
    {
      "restrictionId": "TPRF_17_01_3",
      "restrictionType": "TRANSACTION_FLAG",
      "restrictionValue": "DISABLED",
      "name": "Contactless transactions",
      "restrictionValues": [
        "ENABLED",
        "DISABLED"
      ]
    },
    {
      "restrictionId": "TPRF_17_01_4",
      "restrictionType": "TRANSACTION_FLAG",
      "restrictionValue": "DISABLED",
      "name": "Online transactions",
      "restrictionValues": [
        "ENABLED",
        "DISABLED"
      ]
    },
    {
      "restrictionId": "TPRF_17_01_5",
      "restrictionType": "TRANSACTION_FLAG",
      "restrictionValue": "DISABLED",
      "name": "Magstripe transactions",
      "restrictionValues": [
        "ENABLED",
        "DISABLED"
      ]
    },
    {
      "restrictionId": "TPRF_17_01_9",
      "restrictionType": "TRANSACTION_FLAG",
      "restrictionValue": "DISABLED",
      "name": "Mobile wallets transactions",
      "restrictionValues": [
        "ENABLED",
        "DISABLED"
      ]
    }
  ]
}

Parameter Location Type Example Description
card body "object" - Card details
cpdCode card "string" "94CHBIA4FX31CUPWFMNSHONI" CPD code
cpdVersion card "integer" "2" CPD version
cpdId card "string" "2" CPD ID
name card "string" "VISA Physical Retail" CPD name
image card "array" "phys_standard.png" List of file names (including suffixes) for UI
associationCode card "string" "VISA"
cardType card "string" "DEBIT"
pan card "string" "4511***5817 " Truncated PAN
cardProcessorId card "string" "777821234" Card Processor Card ID
status card "string" "ACTIVE"
validFrom card "string" "2024-04-01"
validTo card "string" "2028-04-01"
expressDelivery card "boolean" true Enables express delivery
ecommerceStatus card "boolean" true
holder body "object" - Holder details
holderExternalId holder "string" "1231354" External holder ID
firstName holder "string" "John"
middleName holder "string" "Michael"
lastName holder "string" "Doe"
sex holder "string" "MALE"
birthdate holder "string" "0001-01-01T00:00:00"
phoneNumber holder "string" "701235698"
residenceAddress holder "object" - Residence address details of holder
city residenceAddress "string" "Příbram"
country residenceAddress "string" "CZE"
state residenceAddress "string" "CZE"
addressLine1 residenceAddress "string" "Barandovská 424"
addressLine2 residenceAddress "string"
zip residenceAddress "string" "26101"
mailingAddress holder "object" - Mailing address details of holder
city mailingAddress "string" "Příbram"
country mailingAddress "string" "CZE"
state mailingAddress "string" "CZE"
addressLine1 mailingAddress "string" "Barandovská 424"
addressLine2 mailingAddress "string"
zip mailingAddress "string" "26101"
knownAddresses holder "object" - Mailing address details of holder
city knownAddresses "string" "Příbram"
country knownAddresses "string" "CZE"
state knownAddresses "string" "CZE"
addressLine1 knownAddresses "string" "Barandovská 424"
addressLine2 knownAddresses "string"
zip knownAddresses "string" "26101"
delivery body "object" -
deliveryType delivery "string" "POST" POST/BRANCH/INSTANT
deliveryPoint delivery "string" - ID of Branch
deliveryAddress delivery "string" - Delivery address of holder
expressDelivery card "boolean" true If Card was expressly delivered
city deliveryAddress "string" "Příbram"
country deliveryAddress "string" "CZE"
state deliveryAddress "string" "CZE"
addressLine1 deliveryAddress "string" "Barandovská 424"
addressLine2 deliveryAddress "string"
zip deliveryAddress "string" "26101"
accounts body "object" - Account information
accountOwner accounts "object" - Account owner details
holderExternalId accountOwner "string" "6546545654" External holder ID of account owner
firstName accountOwner "string" "John"
middleName accountOwner "string" "Michael"
lastName accountOwner "string" "Doe"
accounts accounts "object" - Acounts list
accountExternalId accounts accounts "string" "12313212"
accountCurrency accounts accounts "string" "CZK"
limits body "object" - Limits details
limitId limits "string" LIM_POS_D Limit ID specified in CPD
name limits "string" "POS DAILY LIMIT" Limit name
limitValue limits "integer" "50000"
currentLimitValue limits "integer" "50000"
limitType limits "string" "AMOUNT" AMOUNT/COUNT Limit type
blocks body "object" - Card Blocks details
blockId blocks "string" 29 Block ID
blockReason blocks "string" "LOST" Block reason
validFrom blocks "date" "2024-04-10T00:00:00Z" Beginning of Block validity
validTo blocks "date" "2999-12-31T00:00:00Z" End of Block validity
requestedBy blocks "string" "BANK" Level of user who request the Block
restrictions body "object" - Resctions details
restrictionId restrictions "string" "DENYCASH" Restriction ID specified in CPD
restrictionType restrictions "string" "TRANSACTION_FLAG" Restriction type
restrictionValue restrictions "string" "ENABLED" ENABLED/DISABLED value for turning ON or OFF the restriction
name restrictions "string" "CASH TRANSACTIONS" Restriction name
restrictionsValues restrictions "array" "ENABLED/DISABLED" Possible restriction values
500 - Internal error

Status Code: 500 Internal error

404 - Not found

Status Code: 404 Not found 

{
"errorMessage": "Entity with id 132132123 not found in DB."
}

Parameter Location Type Example Description
errorMessage body string "Entity with id 132132123 not found in DB." Error message