Skip to content

Get current version of Card Product Definition

This method retrieves the current version of the Card Product Definition (CPD), including a complete set of settings and restrictions. If the Card Product Definition does not currently have an active version, it returns the Card Product Definition that was defined as a successor. If no successor was defined, it returns a 404 code.

URL test:

https://dev.lightcms.io/cms/v1/cpds/{code}/successor

URL live:

https://fat.lightcms.io/cms/v1/cpds/{code}/successor

Method:

GET

Path items:

/cpds (Card Product Definition Service)

/{code} (ID code of required CPD)

/successor (method name)

Parameters:

Parameter Location Type Example Description Required
code path string VISA_VIRT_2 CPD code Yes

Example:

curl -X 'GET' \
  'https://dev.lightcms.io/cms/v1/cpds/VISA_VIRT_2/successor' \
  -H 'accept: */*'

Responses:

200 - OK

Status Code: 200 OK

  {
"id": 1,
"code": "VISA_VIRT_2",
"name": "VISA Virtual Retail",
"description": "VISA's virtual \"card\" intended for use in smart consumer electronics such as mobile phones, smart watches....\r\nThe card is primarily intended for retail clients who like to use modern technology.\r\nThe card has set withdrawal limits in such a way as to satisfy more demanding clients.\r\nTransactions on game portals, casinos and servers with adult content are prohibited.",
"images": [
  "virtual.png"
],
"validFrom": "2023-05-29T00:00:00Z",
"validTo": "2999-12-31T23:59:59.999Z",
"associationCode": "VISA",
"technology": [
  "VIRTUAL"
],
"cardType": "DEBIT",
"segment": [
  "RETAIL"
],
"status": "ACTIVE",
"defaultValidity": 48,
"pan": {
  "length": 16,
  "prefix": "451162",
  "lowerRange": "010300000",
  "upperRange": "010499999"
},
"renewalAuto": true,
"embossNameMaxLength": 21,
"embossNameCreateMode": "LAST_FIRST",
"defaultCardStatus": "ACTIVE",
"defaultEcommerceStatus": true,
"limits": [
  {
    "limitId": "LIM_17_POS_AMT_D",
    "name": "POS transactions",
    "issuerBillingCurrency": "CZK",
    "period": "DAILY",
    "transactionTypes": "CSD,CSR,RTL,RTR,CBN,CBR,CNP,CNR,GAM,GAR,PRE,PRR,MTP,MTR",
    "limitType": "AMOUNT",
    "defaultLimitValue": 50000,
    "maximumLimitValue": 100000,
    "customerCanModify": true
  },
  {
    "limitId": "LIM_17_ECOM_AMT_D",
    "name": "E-commerce transactions",
    "issuerBillingCurrency": "CZK",
    "period": "DAILY",
    "transactionTypes": "ECP,ECR,EGM,EGR,EPA,EPR",
    "limitType": "AMOUNT",
    "defaultLimitValue": 20000,
    "maximumLimitValue": 100000,
    "customerCanModify": true
  },
  {
    "limitId": "LIM_17_ATM_AMT_D",
    "name": "ATM withdrawals",
    "issuerBillingCurrency": "CZK",
    "period": "DAILY",
    "transactionTypes": "ATM,ATR",
    "limitType": "AMOUNT",
    "defaultLimitValue": 50000,
    "maximumLimitValue": 100000,
    "customerCanModify": true
  }
],
"handoverType": [
  "INSTANT"
],
"pinChange": false,
"pinView": false,
"embossNameGenerate": true,
"renewalMonthUpfront": 1,
"renewalType": "NEW_CARD",
"deliveryTracking": false,
"persolineCompany": "CARDPROCESSOR",
"processorCompany": "CARDPROCESSOR",
"graphics": "44",
"restrictions": [
  {
    "restrictionId": "TPRF_17_01_2",
    "defaultRestrictionValue": "ENABLED",
    "customerCanModify": false,
    "evaluation": "FLAG",
    "name": "Cash transactions",
    "restrictionType": "TRANSACTION_FLAG"
  },
  {
    "restrictionId": "TPRF_17_01_3",
    "defaultRestrictionValue": "ENABLED",
    "customerCanModify": false,
    "evaluation": "FLAG",
    "name": "Contactless transactions",
    "restrictionType": "TRANSACTION_FLAG"
  },
  {
    "restrictionId": "TPRF_17_01_4",
    "defaultRestrictionValue": "DISABLED",
    "customerCanModify": false,
    "evaluation": "FLAG",
    "name": "Online transactions",
    "restrictionType": "TRANSACTION_FLAG"
  },
  {
    "restrictionId": "TPRF_17_01_5",
    "defaultRestrictionValue": "ENABLED",
    "customerCanModify": false,
    "evaluation": "FLAG",
    "name": "Magstripe transactions",
    "restrictionType": "TRANSACTION_FLAG"
  },
  {
    "restrictionId": "TPRF_17_01_7",
    "defaultRestrictionValue": "ENABLED",
    "customerCanModify": false,
    "evaluation": "FLAG",
    "name": "DCC transactions",
    "restrictionType": "TRANSACTION_FLAG"
  },
  {
    "restrictionId": "TPRF_17_01_8",
    "defaultRestrictionValue": "ENABLED",
    "customerCanModify": false,
    "evaluation": "FLAG",
    "name": "Chip&PIN transactions",
    "restrictionType": "TRANSACTION_FLAG"
  },
  {
    "restrictionId": "TPRF_17_01_9",
    "defaultRestrictionValue": "DISABLED",
    "customerCanModify": true,
    "evaluation": "FLAG",
    "name": "Mobile wallets transactions",
    "restrictionType": "TRANSACTION_FLAG"
  },
  {
    "restrictionId": "TPRF_17_01_6",
    "defaultRestrictionValue": "ENABLED",
    "customerCanModify": false,
    "setting": "7995,7801,7800,7802,5967",
    "evaluation": "BLACKLIST",
    "name": "MCC transactions (no gambling, adult business)",
    "restrictionType": "MCC"
  },
  {
    "restrictionId": "TERMINAL_EU_COUNTRIES",
    "defaultRestrictionValue": "DISABLED",
    "customerCanModify": false,
    "setting": "AUT,BEL,BGR,HRV,CYP,CZE,DNK,EST,FIN,FRA,DEU,GRC,HUN,IRL,ITA,LVA,LTU,LUX,MLT,NLD,POL,PRT,ROU,SVK,SVN,ESP,SWE",
    "evaluation": "WHITELIST",
    "name": "Terminal EU countries",
    "restrictionType": "COUNTRYCODES"
  },
  {
    "restrictionId": "TRANSACTIONS_PERMISSIONS_B",
    "defaultRestrictionValue": "ENABLED",
    "customerCanModify": false,
    "setting": "ECP,ECR,EME,EMR,EGM,EGR,CAV,EPA,EPR",
    "evaluation": "WHITELIST",
    "name": "Transactions permissions",
    "restrictionType": "TRANSACTION_TYPE"
  }
]
  }

Parameter Location Type Example Description
id card "int " 1 CPD ID
cpdCode card "string" "94CHBIA4FX31CUPWFMNSHONI" CPD code
name card "string" "VISA Physical Retail" CPD name
description body "string" "VISA physical card with contact and contactless chip..." Description of CPD
image card "array" "phys_standard.png" List of file names (including suffixes) for UI
validFrom card "string" "2024-04-01"
validTo card "string" "2028-04-01"
associationCode card "string" "VISA"
technology body "array" "CONTACTLESS_CHIP","CONTACT_CHIP","MAGSTRIPE" Card technology with which the Card will be created
cardType card "string" "DEBIT"
segment card "string" "Retail"
status card "string" "ACTIVE"
defaultValidity body "integer" 48 Default Card validity in months
pan body "object" - PAN ranges and prefix
length pan "integer" 16 Number of digits of PAN
prefix pan "string" "484569" Prefix of PAN
lowerRange pan "string" "010000000" Lower range of PAN
upperRange pan "string" "019999999" Upper range of PAN
renewalAuto body "boolean" true If Card will be automatically renewed
embossNameMaxLength body "integer" 21
embossNameCreateMode body "string" "LAST_FIRST" Embossed name format
defaultCardStatus body "string" "DIGITALLY_ACTIVE"
defaultEcommerceStatus body "boolean" true
limits body "object" - Limits details
limitId limits "string" LIM_POS_D Limit ID specified in CPD
name limits "string" "POS DAILY LIMIT" Limit name
issuerBillingCurrency limits "string" "CZK" Limit currency
period limits "string" "DAILY" Limit period
transactionTypes limits "string" "CSD,CSR..." Transaction types for which limit is created
limitType limits "string" "AMOUNT" AMOUNT/COUNT Limit type
defaultlimitValue limits "integer" "50000"
maximumLimitValue limits "integer" "50000"
customerCanModify limits "boolean" true If Cardholder can modify the limit values
handoverType body "array" "POST","INSTANT","BRANCH" Allowed delivery types
pinChange body "boolean" true If Card is allowed to have PIN changed
pinView body "boolean" true If Card is allowed to have PIN viewed
embossNameGenerate body "boolean" true If card has embossed name
renewalMonthUpfront body "integer" 2 Number of months when the card is prepared for renewal
renewalType body "string" "RENEWAL"
deliveryTracking body "boolean" true If delivery of card is tracked
persolineCompany body "string" "CARDPROCESSOR" Code of the company providing processing and distribution of card
processorCompany body "string" "CARDPROCESSOR" Code of the card processor company code
graphics body "string" "41" Number of preset graphics design of Card
restrictions body "object" - Resctions details
restrictionId restrictions "string" "DENYCASH" Restriction ID specified in CPD
defaultRestrictionValue restrictions "string" "ENABLED" ENABLED/DISABLED value for turning ON or OFF the restriction
customerCanModify restrictions "boolean" true If Cardholder can modify the restriction i.e. turn ON or OFF the restriction
evaluation restrictions "string" "FLAG" Restriction logic model
name restrictions "string" "CASH TRANSACTIONS" Restriction name
restrictionType restrictions "string" "TRANSACTION_FLAG" Restriction type
404 - Not found

Status Code: 404 Not found

500 - Internal error

Status Code: 500 Internal error