Enable
TMS
 and Enroll in Network Tokenization Using the PECS API

This section shows you how to enable
TMS
 and enroll in network tokenization.

Endpoint

Production:
POST
https://api.cybersource.com
/products/v1/product-setups
Test:
POST
https://apitest.cybersource.com
/products/v1/product-setups

Required Fields for Enabling
TMS
 and Enrolling in Network Tokenization Using the PECS API

commerceSolutions.tokenManagement.configurationInformation.configurations.vault.defaultTokenType
commerceSolutions.tokenManagement.configurationInformation.configurations.vault.location
commerceSolutions.tokenManagement.configurationInformation.configurations. vault.sensitivePrivileges.cardNumberMaskingFormat
commerceSolutions.tokenManagement.configurationInformation.configurations.vault.tokenFormats.customer
commerceSolutions.tokenManagement.configurationInformation.configurations. vault.tokenFormats.instrumentIdentifierBankAccount
commerceSolutions.tokenManagement.configurationInformation.configurations.vault.tokenFormats.instrumentIdentifierCard
commerceSolutions.tokenManagement.configurationInformation.configurations.vault.tokenFormats.paymentInstrument
commerceSolutions.tokenManagement.configurationInformation.configurations.networkTokenEnrollment.acquirer.acquirerId
commerceSolutions.tokenManagement.configurationInformation.configurations. networkTokenEnrollment.acquirer.acquirerMerchantId
commerceSolutions.tokenManagement.configurationInformation.configurations. networkTokenEnrollment.businessInformation.address.country
commerceSolutions.tokenManagement.configurationInformation.configurations. networkTokenEnrollment.businessInformation.address.locality
commerceSolutions.tokenManagement.configurationInformation.configurations. networkTokenEnrollment.businessInformation.doingBusinessAs
commerceSolutions.tokenManagement.configurationInformation.configurations. networkTokenEnrollment.businessInformation.name
commerceSolutions.tokenManagement.configurationInformation.configurations. networkTokenEnrollment.networkTokenServices.mastercardDigitalEnablementService.enrollment
Set to
true
.
commerceSolutions.tokenManagement.configurationInformation.configurations. networkTokenEnrollment.networkTokenServices.visaTokenService.enrollment
Set to
true
.
commerceSolutions.tokenManagement.configurationInformation.configurations.networkTokenEnrollment.websiteUrl
commerceSolutions.tokenManagement.configurationInformation.configurations. networkTokenServices.mastercardDigitalEnablementService.enableService
Set to
true
.
commerceSolutions.tokenManagement.configurationInformation.configurations. networkTokenServices.mastercardDigitalEnablementService.enableTransactionalTokens
Set to
true
.
commerceSolutions.tokenManagement.configurationInformation.configurations.networkTokenServices.notifications.enabled
commerceSolutions.tokenManagement.configurationInformation.configurations. networkTokenServices.paymentCredentials.enabled
commerceSolutions.tokenManagement.configurationInformation.configurations. networkTokenServices.visaTokenService.enableService
Set to
true
.
commerceSolutions.tokenManagement.configurationInformation.configurations. networkTokenServices.visaTokenService.enableTransactionalTokens
Set to
true
.

REST Example: Enabling
TMS
 and Enrolling in Network Tokenization Using the PECS API

Light Dark
Request
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
{"organizationId": "ergaergaerg001",
  "commerceSolutions": {
    "tokenManagement": {
      "subscriptionInformation": {
        "enabled": true
      },
      "configurationInformation": {
        "configurations": {
          "vault": {
            "location": "GDC",
            "defaultTokenType": "CUSTOMER",
            "tokenFormats": {
              "customer": "32_HEX",
              "paymentInstrument": "32_HEX",
              "instrumentIdentifierCard": "19_DIGIT_LAST_4",
              "instrumentIdentifierBankAccount": "32_HEX"
            },
            "sensitivePrivileges": {
              "cardNumberMaskingFormat": "FIRST_6_LAST_4"
            }
          },
          "networkTokenEnrollment": {
            "businessInformation": {
              "name": "TokenMerchant",
              "doingBusinessAs": "NetworkTokenCo1",
              "address": {
                "country": "US",
                "locality": "ORMOND BEACH"
              },
              "websiteUrl": "https://www.MerchantUrlHere.com",
              "acquirer": {
                "acquirerId": "40010052242",
                "acquirerMerchantId": "yourmerchantorgidhere"
              }
            },
            "networkTokenServices": {
              "visaTokenService": {
                "enrollment": true
              },
              "mastercardDigitalEnablementService": {
                "enrollment": true
              }
            }
          },
          "networkTokenServices": {
            "notifications": {
              "enabled": true
            },
            "paymentCredentials": {
              "enabled": true
            },
            "visaTokenService": {
              "enableService": true,
              "enableTransactionalTokens": true
            },
            "mastercardDigitalEnablementService": {
              "enableService": true,
              "enableTransactionalTokens": true
            }
          }
        }
      }
    }
  }}
Response to Successful Request
12345678910111213141516
{"setups": {
    "commerceSolutions": {
      "tokenManagement": {
        "configurationStatus": {
          "status": "SUCCESS",
          "message": "Profile Assigned Successfully"
        },
        "subscriptionStatus": {
          "status": "SUCCESS",
          "message": "success"
        }
      }
    }
  },
  "status": "PROCESSED",
  "submitTimeUtc": "2022-06-03T08:46:13+0000"}