Create debit card product

Use case

We will create a physical debit card product having the Mastercard scheme with some more sample data. All the cards that are issued under this card product will have these parameter values.

Use case data

API parameters with values

Name and code of the card product (The product code must be a unique value)

"productName": "DEBIT_PHYSICAL_01",
"productCode": "DEBIT_PHYSICAL"

Product settings

"productScheme": "MASTERCARD",
"productClass": "DEBIT",
"productType": "PHYSICAL"

Card account settings

"accountOwnerTypeCode": "PRIVATE"

Currency settings

"currencyCode": "EUR",
"settlementCurrencyCode": "EUR" //The currency that is used for bank transactions. This is an informational field only. This means that although you enter a value for the settlement currency, this parameter is not used in any process. The value is defined between the bank and the scheme.

Reporting product code

"reportingProductCode": "DC0001"

Design for the card product

"design": {
  "defaultDesignId": "01",
  "allowedDesignIds": [
    "01"
  ]
}

Price lists for the card product

"pricing": {
  "defaultPriceListCode": "DEBIT2023",
  "allowedPriceListCodes": [
    "DEBIT2023",
    "PRICELIST-01"
  ]
}

Profile ID

"profileId": "ID-1" //It is the agreed value with the personalisation centre by the issuer.

BIN and PAN details

"bin": "483312",
"binAdditional": "12",
"panLength": 16,
"panNumberRange": {
"startValue": 1111,
"endValue": 9999
}

Card limits and authorisation types for the card product

"limitGroups": {
  "upperGroupName": "DEBIT2023_LIMIT_GROUP",
  "defaultGroupName": "DEBIT2023_LIMIT_GROUP",
  "allowedGroupNames": [
    "DEBIT2023_LIMIT_GROUP",
    "HIGH_LIMIT_GROUP"
  ]
},
"usageGroups": {
  "upperGroupName": "ALL_ALLOWED",
  "defaultGroupName": "ALL_ALLOWED",
  "allowedGroupNames": [
    "ALL_ALLOWED"
  ]
}

Other settings

"defaultExpiryMonths": 5,
"tokenisationAuthenticationRequired": true,
"needsAcceptance": true,
"orderPlasticAutomatically": true,
"usableBeforeDelivery": true,
"cardDeliveryMethod": "POST",
"pinDeliveryMethod": "DIGIPIN",
"cardVendorId": "11",
"tenantCode": "MB",
"replaceable": true,
"avsRequired": true,
"additionalCardAllowed": true,
"renewable": true

Sample API call

To create the card product, use the following request:

https://card-api.sandbox.tuumplatform.com/api/v3/cards/product

Learn more about the create card product endpoint in the Tuum developer portal.

Sample request

The sample request body is as follows:

{
  "productName": "DEBIT_PHYSICAL_01",
  "productScheme": "MASTERCARD",
  "productClass": "DEBIT",
  "productType": "PHYSICAL",
  "accountOwnerTypeCode": "PRIVATE",
  "issuingCountryCode": "EE",
  "currencyCode": "EUR",
  "settlementCurrencyCode": "EUR",
  "reportingProductCode": "DC0001",
  
  "design": {
    "defaultDesignId": "01",
    "allowedDesignIds": [
      "01"
    ]
  },
  
  "pricing": {
    "defaultPriceListCode": "DEBIT2023",
    "allowedPriceListCodes": [
      "DEBIT2023",
      "PRICELIST-01"
    ]
  },
  
  "profileId": "ID-1",
  "bin": "483312",
  "binAdditional": "12",
  "panLength": 16,
  "panNumberRange": {
    "startValue": 1111,
    "endValue": 9999
  },
  
  "defaultExpiryMonths": 5,
  "tokenisationAuthenticationRequired": true,
  "needsAcceptance": true,
  "orderPlasticAutomatically": true,
  "usableBeforeDelivery": true,
  "cardDeliveryMethod": "POST",
  "pinDeliveryMethod": "DIGIPIN",
  "cardVendorId": "11",
  "tenantCode": "MB",
  
  "limitGroups": {
    "upperGroupName": "DEBIT2023_LIMIT_GROUP",
    "defaultGroupName": "DEBIT2023_LIMIT_GROUP",
    "allowedGroupNames": [
      "DEBIT2023_LIMIT_GROUP",
      "HIGH_LIMIT_GROUP"
    ]
  },
  
  "usageGroups": {
    "upperGroupName": "ALL_ALLOWED",
    "defaultGroupName": "ALL_ALLOWED",
    "allowedGroupNames": [
      "ALL_ALLOWED"
    ]
  },
  
  "productCode": "DEBIT_PHYSICAL",
  "replaceable": true,
  "avsRequired": true,
  "additionalCardAllowed": true,
  "renewable": true
}

curl --location 'https://card-api.sandbox.tuumplatform.com/api/v3/cards/product' \
--header 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHBpcnlEVGltZSI6IjIwMjMtMDYtMjhUMTI6NDY6NTYiLCJyb2xlcyI6WyJBRE1JTiJdLCJuYW1lIjoiSm9obiBPZmZpY2VyIiwiZW1wbG95ZWVJZCI6IjEiLCJ0ZW5hbnRDb2RlIjoiTUIiLCJleHAiOjE2ODc5NTY0MTZ9.1WP6V5GX-tmvu2nFR2vSN7uTxq58SU0stCrRIXmDe-w' \
--header 'x-channel-code: system' \
--header 'Content-Type: application/json' \
--data '{
  "productName": "DEBIT_PHYSICAL_01",
  "productScheme": "MASTERCARD",
  "productClass": "DEBIT",
  "productType": "PHYSICAL",
  "accountOwnerTypeCode": "PRIVATE",
  "issuingCountryCode": "EE",
  "currencyCode": "EUR",
  "settlementCurrencyCode": "EUR",
  "reportingProductCode": "DC0001",
  "design": {
    "defaultDesignId": "01",
    "allowedDesignIds": [
      "01"
    ]
  },
  "pricing": {
    "defaultPriceListCode": "DEBIT2023",
    "allowedPriceListCodes": [
      "DEBIT2023",
      "PRICELIST-01"
    ]
  },
  "profileId": "ID-1",
  "bin": "483312",
  "binAdditional": "12",
  "panLength": 16,
  "panNumberRange": {
    "startValue": 1111,
    "endValue": 9999
  },
  "defaultExpiryMonths": 5,
  "tokenisationAuthenticationRequired": true,
  "needsAcceptance": true,
  "orderPlasticAutomatically": true,
  "usableBeforeDelivery": true,
  "closedLoop": false,
  "cardDeliveryMethod": "POST",
  "pinDeliveryMethod": "DIGIPIN",
  "cardVendorId": "11",
  "tenantCode": "MB",
  "limitGroups": {
    "upperGroupName": "DEBIT2023_LIMIT_GROUP",
    "defaultGroupName": "DEBIT2023_LIMIT_GROUP",
    "allowedGroupNames": [
      "DEBIT2023_LIMIT_GROUP",
      "HIGH_LIMIT_GROUP"
    ]
  },
  "usageGroups": {
    "upperGroupName": "ALL_ALLOWED",
    "defaultGroupName": "ALL_ALLOWED",
    "allowedGroupNames": [
      "ALL_ALLOWED"
    ]
  },
  "productCode": "DEBIT_PHYSICAL",
  "replaceable": true,
  "avsRequired": true,
  "additionalCardAllowed": true,
  "renewable": true
}'

Sample response

Below you will find the response to the sample request:

Response

{
  "errors": null,
  "validationErrors": null,
  "data": null
}

Result

We have now created a debit card product. After activating the card product, cards can be issued by creating applications and you can perform other functions.

PreviousCreate card design NextActivate card product

Last updated 1 year ago

Was this helpful?