API Overview

Token Management Service Developer Guide
- Recent Revisions to This Document
- TERMS OF USE APPLICABLE TO CARD NETWORK TOKENS

Introduction to the Token Management Service
- Types of Tokens
  - Instrument Identifier Tokens
  - Customer Tokens
  - Shipping Address Tokens
  - Payment Instrument Tokens
  - Network Tokens

Token Management Service Workflows
- PAN Tokenization Process Using TMS
- Network Token Tokenization Process
- Push Provisioning Process
- Network Token Provisioning for Merchants
- Network Token CIT for Merchants
- Network Token MIT for Merchants
- Network Token Provisioning for Partners
- Network Token CIT for Partners
- Network Token MIT for Partners

Requesting the Token Management Service API
- HTTP Response Headers
- Case Sensitivity
- Metadata
- Patching Considerations
  - Pagination
- Test Card Numbers

Token Management Service Onboarding
- Merchant ID Hierarchy
- Merchant ID Registration
- Portfolio MIDs for Partners
- Token Vault Management
  - Configure the Token Vault Settings Using the Smartpay Fuse Portal
  - Configure the Token Vault Access Using the Smartpay Fuse Portal
  - Configure Network Tokenization Using the Smartpay Fuse Portal
- Token Management Message-Level Encryption Keys
  - Creating a Token Management MLE Key

Network Tokenization
- Network Token Enablement
- Network Token Onboarding—Partner Model
- Network Token Life-Cycle Management
- Network Token Life-Cycle Management Reports
- Manage Webhook Subscriptions
  - Create a Digital Signature Key
  - Create Webhook Subscription
  - Retrieve the Details of a Webhook Subscription
  - Update Webhook Subscription
  - Delete Webhook Subscription
  - Network Token Life-Cycle Management Notification Examples
- Token Requestor IDs
- Digital Commerce Authentication Program

Manage Network Tokens
- Authorize a Payment While Ignoring Network Token
- Update Merchant-Initiated Transaction Authorization Options
- Provision a Network Token for a Card Number
- Provision a Network Token for an Existing Instrument Identifier
- Provision a Network Token for a Customer
- Provision a Network Token for a Token
- Retrieve a Standalone Network Token
- Delete a Standalone Network Token
- Retrieve Network Token Payment Credentials
- Retrieve Network Token AFT Payment Credentials
- Provision a Network Token with Push Provisioning
- Generate Payment Credentials
- Generate Payment Credentials for Digital Commerce Authentication Program
- Generate Payment Passkey Credentials
- Simulate Life-Cycle Management Events
  - Available Fields for Simulating Life-Cycle Management Events
  - REST Example: Simulating Life-Cycle Management Events
- Network Token Provision Failures

Create Tokens
- Create an Instrument Identifier and Provision a Network Token
- Create an Instrument Identifier and Provision a Network Token Using a Transient Token
- Create a Customer Payment Instrument
- Create a Token with a Request ID

Instrument Identifier Tokens
- Manage Instrument Identifier Tokens
  - Create an Instrument Identifier
  - Create an Instrument Identifier for Enrollable Network Tokens
  - Create an Instrument Identifier and Network Token Using EMV Tags
  - Retrieve an Instrument Identifier
  - Update an Instrument Identifier
  - Retrieve an Instrument Identifier's Payment Instruments
  - Retrieve an Instrument Identifier with an Unmasked Card Number
  - Delete an Instrument Identifier
- Payments with Instrument Identifier Tokens
  - Create an Instrument Identifier Token with Validated Payment Details
  - Authorize a Payment with an Instrument Identifier
  - Making a Credit with an Instrument Identifier

Payment Instrument Tokens
- Manage Payment Instrument Tokens
  - Create a Payment Instrument
  - Retrieve a Payment Instrument
  - Find Payment Instruments by Card Number
  - Retrieve a Payment Instrument with an Unmasked Card Number
  - Update a Payment Instrument
  - Delete a Payment Instrument
- Payments with Payment Instrument Tokens
  - Authorizing a Payment with a Payment Instrument
  - Making a Credit with a Payment Instrument

Customer Tokens
- Manage Customer Tokens
  - Create a Customer
  - Retrieve a Customer
  - Update a Customer
  - Delete a Customer
  - Retrieve a Customer's Default Payment with an Unmasked Card Number
  - Retrieve a Customer's Default Payment and Shipping Details
- Payments with Customer Tokens
  - Create a Customer Token with Validated Payment Details
  - Authorizing a Payment with a Customer Token
  - Making a Credit with a Customer Token
- Shipping Address Tokens
  - Manage Shipping Address Tokens
  - Create a Customer Shipping Address
  - Add a Default Shipping Address
  - Add a Non-Default Shipping Address
  - Change a Default Shipping Address
  - Retrieve a Customer Shipping Address
  - Retrieve All Customer Shipping Addresses
  - Update a Customer Shipping Address
  - Delete a Customer Shipping Address
  - Payments with Shipping Address Tokens
  - Authorizing a Payment with a Non-Default Shipping Address
- Customer Payment Instruments
  - Manage Customer Payment Instruments
    - Create a Customer Payment Instrument
    - Add a Default Payment Instrument Using Instrument Identifier
    - Add a Default Payment Instrument with Validated Payment
    - Add a Non-Default Payment Instrument Using Instrument Identifier
    - Add a Non-Default Payment Instrument with Validated Payment
    - Change a Customer's Default Payment Instrument
    - Retrieve a Customer Payment Instrument
    - Retrieve a Customer Payment Instrument with an Unmasked Card Number
    - List Payment Instruments for a Customer
    - Update a Customer Payment Instrument
    - Delete a Customer Payment Instrument
  - Payments with Customer Payment Instruments
    - Authorizing a Payment with a Non-Default Payment Instrument
    - Making a Credit with a Non-Default Payment Instrument

Card Art
- Retrieve Card Art

Using Token Management Service with Wallet Apps
- Manage Tokens with Wallet Apps
  - Create a New Customer Account
  - Add a New Shipping Address
  - Edit or Delete a Shipping Address
  - Create a New Payment Instrument with the Payments API
  - Edit or Delete a Payment Method
  - Change the Default Payment Method
  - Add a New Payment Method Address
  - View Wallet
- Payments with Tokens and Wallet Apps
  - Authorize a Payment

Reference Information
- Encrypt and Decrypt Data
- HTTP Status Codes

On This Page

Recent Revisions to This Document

26.05.02

Updated the graphics for token types. See Types of Tokens.

Added information about creating a network token using a transient token. See Provision a Network Using a Transient Token.

Added information about the tokenized cards API. See Manage Network Tokens.

26.05.01

Added information about the Digital Commerce Authentication Program (DCAP) for network tokens. See Digital Commerce Authentication Program.

Added information about generating payment credentials. See these topics:

Generate Payment Credentials

Generate Payment Credentials for Digital Commerce Authentication Program

Generate Payment Passkey Credentials

Added information about tokenizing payment information. See Create Tokens.

26.04.01

Moved the

card.type

field from required fields to optional fields. See Create a Payment Instrument.

Moved the

paymentInformation.card.type

field from required fields to optional fields. See these topics:

Create a Customer Payment Instrument

Create a Customer Token with Validated Payment Details

Add a Default Payment Instrument with Validated Payment

Add a Non-Default Payment Instrument with Validated Payment

Create an Instrument Identifier Token with Validated Payment Details

Updated the example for creating a device. See Create a Device
in Bind a Device and Bind a Device with Step-Up Authentication.

Removed the clinetCorrelationId field from the examples for creating tokenized card credentials. See Create Tokenized Card Authentication Options and Create Tokenized Card Payment Credentials with.

26.03.01

Network Tokens: Removed the
card.securityCode
field from the example for provisioning a network token for a card number. See Provision a Network Token for a Card Number.; Added information and examples for these life-cycle management events:
Network token suspended
Network token deleted
Network token activated
Network token card updated
Network token expiration updated
Network token metadata updated
Network token redigitalization
See Network Token Life-Cycle Management and Network Token Life-Cycle Management Notification Examples.

25.12.01

Network Tokens: Added
card.securityCode
to the list of optional fields. See these topics:
Provision a Network Token for an Existing Instrument Identifier
Provision a Network Token for a Consumer
Provision a Network Token for a Device Token; Updated the response to a successful request for provisioning a network token for an existing instrument identifier. See Provision a Network Token for an Existing Instrument Identifier.

25.11.02

This revision contains only editorial changes and no technical updates.

25.11.01

This revision contains only editorial changes and no technical updates.

25.10.01

This revision contains only editorial changes and no technical updates.

25.09.02

This revision contains only editorial changes and no technical updates.

25.09.01

Instrument Identifier Tokens: Updated the response for retrieving an instrument identifier to include card art data. See Retrieve an Instrument Identifier.
Multiple Tokens: Added information about creating multiple tokens in a single request. See Create Tokens.
Network Tokens: Added information about simulating life-cycle management events. See Simulate Life-Cycle Management Events.
Card Art: Updated the information about where to retrieve card art content. See Retrieve Card Art.; Added card art metadata to the example responses in these topics:
Provision a Network Token for a Card Number
Provision a Network Token for an Existing Instrument Identifier
Create an Instrument Identifier for Enrollable Network Tokens
Retrieve a Customer's Default Payment and Shipping Details
Encrypt and Decrypt Data

25.07.01

TMS Onboarding: Updated the steps for configuring network tokenization in the Smartpay Fuse Portal to include support for American Express. See Configure Network Tokenization Using the Smartpay Fuse Portal; Added a note about using keys to authenticate TMS requests. See Requesting the Token Management Service API.
Network Tokens: Added prerequisites for retrieving network token payment credentials. See Retrieve Network Token Payment Credentials

25.06.01

This revision contains only editorial changes and no technical updates.

25.04.01

TMS Workflows: Updated the PAN tokenization workflow and steps. See PAN Tokenization Process Using TMS.

25.01.01

Network Tokens: Added support for retrieving an AFT cryptogram as a network token payment credential. See Retrieve Network Token AFT Payment Credentials.; Updated the endpoint for generating a network token for an existing instrument identifier. See Provision a Network Token for an Existing Instrument Identifier.
TMS Workflows: Updated the MIT workflows for
merchants and
partners. See
Network Token MIT for Merchants and
Network Token MIT for Partners.
Life-Cycle Management: Added examples for life-cycle management notifications after a network token update. See Network Token Life-Cycle Management.; Added life-cycle management reason values. See Network Token Life-Cycle Management.; Added a note about setting the organization ID to that of the vault owner when creating a new webhook subscription. See Create Webhook Subscription.

Back to top