Add a New Product to an Existing Organization

To add a product, you must subscribe to it, and if there are configurations available, configure it.

Endpoint

Production:

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

Test:

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

Subscribing to a Product

Product fields are in the

selectedProducts

object. Include the field for the product you are adding, and set

subscriptionInformation.enabled

field for that product to

true

Product Features

Some products also have a

features

block within the

subscriptionInformation

object that gives you the ability to enable features of a product.

"subscriptionInformation": { 
  "enabled": true, 
  "features": { 
    "cardNotPresent": { 
      "enabled": true 
      }, 
    "cardPresent": { 
      "enabled": true 
      }

Configuring a Product

Some products have a

configurationInformation

object that contains a

templateId

field and a

configurations

object.

The

templateId

field refers to a product configuration template that is already created in the Business Center and is required to configure a product using the Boarding API. If the

templateId

field is not submitted or is left blank, the default template for the account is used. For more information about templates, see Product Templates.

You can override product template values by submitting the

configurations

object.

Configurations Object Example

 "configurationInformation": {
  "templateId": "A57EB750-6543-46A5-83BE-CCA38D9C9083",
  "configurations": {
    "common": {
      "defaultAuthTypeCode": "final",
      "foodAndConsumerServiceId": "1234",
      "enablePartialAuth": true,
      "useParentTransactionAmountForFollowOn": false,
      "merchantCategoryCode": "1234",
      "processors": {
        "processorName": {
          "batchGroup": "processorname_batch_00",
          "acquirer": {
            "interbankCardAssociationId": "20490",
            "discoverInstitutionId": "666666",
            "institutionId": "432870",
            "fileDestinationBin": "432870",
            "countryCode": "840_usa"    
            },
          "merchantId": "20003791",
          "terminalId": "yD9mP42e",
          "sicCode": "1234",
          "allowMultipleBills": true,
          "fireSafetyIndicator":false,
          "quasiCash":false,
          "paymentTypes":{
            "VISA": {"enabled": true}, "MASTERCARD": {"enabled": true},"AMERICAN_EXPRESS": {"enabled": true},"CUP": {"enabled": true},"JCB": {"enabled": true},"DISCOVER": {"enabled": true},"FALABELLA_PLCC": {"enabled": true},"COSTCO_PLCC": {"enabled": true},"DINERS_CLUB": {"enabled": true}
            },
          "currencies": {
            "USD": {"enabled": true }
          }
          }
        }
      },
      "features": {
        "cardNotPresent": {
          "ignoreAddressVerificationSystem": true,
          "processors": {
            "gpx": {
              "relaxAddressVerificationSystem":true,
              "relaxAddressVerificationSystemAllowZipWithoutCountry":true,
              "relaxAddressVerificationSystemAllowExpiredCard":false,
              "visaSTPOnly":false,
              "enableEmsTransactionRiskScore":false
              }

Required Fields for Adding a New Products

organizationId
[productSectionName].[productName].subscriptionInformation.enabled: For example, to enable payment subscription information, set the value of the
payments.cardProcessing.subscriptionInformation.enabled
, field to
true
.

Example: Adding a New Product to an Existing Organization Using the PECS API

Request

123456789101112
{"organizationId": "ergaergaerg001",
  "commerceSolutions": {
    "tokenManagement": {
      "subscriptionInformation": {
        "enabled": true,
        "selfServiceability": "NOT_SELF_SERVICEABLE"
      },
      "configurationInformation": {
        "templateId": "43107BC1-E3DA-4019-9306-4510AD4DE05F"
      }
    }
  }}

Response to a 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"}