On This Page

Enable
TMS
 and Enroll in Network Tokenization for an Existing Merchant

This section shows you how to enable
TMS
 and enroll in network tokenization for an existing merchant organization.

Endpoint

Production:
POST
https://api.visaacceptance.com
/boarding/v1/registrations
Test:
POST
https://apitest.visaacceptance.com
/boarding/v1/registrations

Required Fields for Enabling
TMS
 and Enrolling in Network Tokenization for an Existing Merchant

organizationInformation.parentOrganizationId
organizationInformation.type
Set to
MERCHANT
.
organizationInformation.configurable
Set to
true
.
registrationInformation.boardingFlow
Set to
ADDPRODUCT
.
organizationInformation.businessInformation.name
organizationInformation.businessInformation.address.country
organizationInformation.businessInformation.address.address1
organizationInformation.businessInformation.address.postalCode
organizationInformation.businessInformation.address.administrativeArea
organizationInformation.businessInformation.address.locality
organizationInformation.businessInformation.businessContact.firstName
organizationInformation.businessInformation.businessContact.lastName
organizationInformation.businessInformation.businessContact.phoneNumber
organizationInformation.businessInformation.businessContact.email
organizationInformation.organizationId
productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.vault.location
productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.vault.defaultTokenType
productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.vault.tokenFormats.customer
productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.vault.tokenFormats.paymentInstrument
productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.vault.tokenFormats.instrumentIdentifierCard
productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.vault.tokenFormats.instrumentIdentifierBankAccount
productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.vault.sensitivePrivileges.cardNumberMaskingFormat
productInformation.selectedProducts.commerceSolutions.tokenManagement.configurationInformation. configurations.networkTokenEnrollment.businessInformation.name
productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.networkTokenEnrollment.businessInformation.doingBusinessAs
productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.networkTokenEnrollment.businessInformation.address.country
productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.networkTokenEnrollment.businessInformation.address.locality
productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.networkTokenEnrollment.businessInformation.websiteUrl
productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.networkTokenEnrollment.businessInformation.acquirer.acquirerId
productInformation.selectedProducts.commerceSolutions.tokenManagement.configurationInformation. configurations.networkTokenEnrollment.businessInformation.acquirer.acquirerMerchantId
productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.networkTokenEnrollment.networkTokenServices.visaTokenService.enrollment
Set to
true
.
productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.networkTokenEnrollment.networkTokenServices. mastercardDigitalEnablementService.enrollment
Set to
true
.
productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.networkTokenServices.notifications.enabled
productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.networkTokenServices.paymentCredentials.enabled
productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.networkTokenServices.visaTokenService.enableService
Set to
true
.
productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.networkTokenServices.visaTokenService.enableTransactionalTokens
Set to
true
.
productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.networkTokenServices.mastercardDigitalEnablementService.enableService
Set to
true
.
productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.networkTokenServices.mastercardDigitalEnablementService.enableTransactionalTokens
Set to
true
.

REST Example: Enabling
TMS
 and Enrolling in Network Tokenization for an Existing Merchant

Request
{
   "registrationInformation":{
      "boardingFlow":"ADDPRODUCT"
   },
   "organizationInformation":{
      "organizationId":"yourmerchantorgidhere",
      "parentOrganizationId":"yourportfolioorgidhere",
      "type":"MERCHANT",
      "configurable":true,
      "businessInformation":{
         "name":"TokenMerchant",
         "address":{
            "country":"US",
            "address1":"123456 SandMarket",
            "locality":"ORMOND BEACH",
            "administrativeArea":"FL",
            "postalCode":"32176"
         },
         "websiteUrl":"https://www.MerchantUrlHere.com",
         "businessContact":{
            "firstName":"Token",
            "lastName":"Man",
            "phoneNumber":"6574567813",
            "email":"[email protected]"
         }
      }
   },
   "productInformation":{
      "selectedProducts":{
         "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
{
  "id": "94498504004",
  "submitTimeUtc": "2024-07-01T16:25:20Z",
  "status": "SUCCESS",
  "registrationInformation": {
    "mode": "COMPLETE",
    "boardingPackageId": "1168704004"
  },
  "organizationInformation": {
    "organizationId": "{MerchantAccountOrgId}",
    "parentOrganizationId": "{PortfolioOrgId}"
  },
  "message": "Request was processed successfully"
}