API Overview

Merchant Boarding Developer Guide
- Recent Revisions to This Document
- VISA Platform Connect: Specifications and Conditions for Resellers/Partners

Introduction to the Boarding Registration Service
- Requirements
- Understanding Accounts and Organizations
- Understanding Organization IDs
- Configure a Single Merchant
- Configure Multiple Merchants
- Configure Multiple Merchants with an Extended Hierarchy

Product Templates
- Template Components
- Products

Using Templates
- Retrieving Templates
- Add Templates
- Editing Templates
- Deleting Templates
- Setting the Default Template

Product Boarding Template Reference
- Account Updater Templates
- Card Processing Templates
  - Configuring a Card Processing Template
  - Processor-Specific Fields
- Customer Invoicing
- ACH Templates
- Fraud Management Essentials Templates
- Gift Card Templates
- Payer Authentication Templates
- Pay By Link
- Secure Acceptance Templates
- Token Management Service Templates
- Unified Checkout
- Virtual Terminal Templates

Create Organizations
- Create a Merchant Organization
- Add a Transacting Organization to a New Merchant Organization
- Add a Transacting Organization to an Existing Organization

Manage Organizations
- Retrieve a List of Organizations
- Retrieve Organization Details
- Update an Organization's Information
- Change an Organization's Status

Product Enablement and Configuration Using the BRS API
- Payer Authentication
  - Enable Payer Authentication
- Token Management Service
  - Token Vault Management
    - Token Requestor IDs
    - Configure the Token Vault Settings Using the Business Center
    - Configure the Token Vault Access Using the Business Center
  - Enable Token Management Service Using a Template
  - Enable TMS and Enroll in Network Tokenization for a New Merchant
  - Enable TMS and Enroll in Network Tokenization for an Existing Merchant

Product Enablement and Configuration Using the PECS API
- Add a New Product to an Existing Organization
- Update Batch Group Using the PECS API
- Add a Processor Using the PECS API
- pecs-delete-processor
  - Required Fields for Deleting a Processor Using the PECS API
  - Example: Deleting a Processor Using the PECS API
- Add and Delete a Processor Using the PECS API
- Payer Authentication
  - Configure Payer Authentication Using the PECS API
- Token Management Service
  - Enable TMS with a Template Using the PECS API
  - Enable TMS and Enroll in Network Tokenization Using the PECS API

Extending the Hierarchy
- Hierarchy Example
- Add a Structural Organization to a Merchant Organization

Product Boarding Template Reference
- Account Updater Templates
- Card Processing Templates
  - Configuring a Card Processing Template
  - Processor-Specific Fields
- Customer Invoicing
- ACH Templates
- Fraud Management Essentials Templates
- Gift Card Templates
- Payer Authentication Templates
- Pay By Link
- Secure Acceptance Templates
- Token Management Service Templates
- Unified Checkout
- Virtual Terminal Templates

ISO Standard Currency Codes

Reason Codes

Working with a Technology Partner
- Set Up Tasks
- Add a Transacting Merchant with a Partner Solution Key
- Add a Partner Solution Key to an Existing Transacting Merchant

On This Page

Enable `TMS` with a Template Using the PECS API

This section shows you how to enable TMS with a template.

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` with a Template Using the PECS API

organizationId
commerceSolutions.tokenManagement.subscriptionInformation.enabled: Set to
true
.
commerceSolutions.tokenManagement.configurationInformation.templateId

Related Information

API Field Reference for the REST API

REST Example: Enabling `TMS` with a Template Using the PECS API

Request

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

Response to Successful Request

{
  "setups": {
    "commerceSolutions": {
      "tokenManagement": {
        "configurationStatus": {
          "status": "SUCCESS",
          "message": "Profile Assigned Successfully"
        },
        "subscriptionStatus": {
          "status": "SUCCESS",
          "message": "success"
        }
      }
    }
  },
  "status": "PROCESSED",
  "submitTimeUtc": "2022-06-03T08:46:13+0000"
}

Back to top