Network Tokens for Partners

Network tokens are network scheme generated tokens that represent customer card information for secure transactions. Network tokens can be provisioned through Cybersource for partners.

Manage Network Tokens for Partners

This section contains information on managing network tokens for partners.

Network tokens are generated by the network scheme and represent customer card information for secure transactions. Network schemes include but are not limited to Visa, Mastercard, and American Express. Network tokens are mapped to instrument identifier tokens. The minimum card data required to request a network token is the PAN and the expiration date.

You can provision network tokens for a card number or an existing instrument identifier. For example:

Provision a Network Token for a Card Number

Provision a Network Token for an Existing Instrument Identifier

You can also retrieve a network tokens for existing payment credentials. For example:

Retrieve a Network Token for Payment Credentials

For more information on network tokens, see Network Tokens.

Provision a Network Token for a Card Number

This section shows you how to provision a network token for a card number.

Endpoint

Test:

POST https://apitest.cybersource.com/tms/v1/instrumentidentifiers

Production:

POST https://api.cybersource.com/tms/v1/instrumentidentifiers

Production in India:

POST https://api.in.cybersource.com/tms/v1/instrumentidentifiers

Provision a Network Token for an Existing Instrument Identifier

This section shows you how to provision a network token for an existing instrument identifier.

Endpoint

Test:

GET https://apitest.cybersource.com/tms/v1/instrumentidentifiers/{instrumentIdentifierTokenId}/enrollment

Production:

GET https://api.cybersource.com/tms/v1/instrumentidentifiers/{instrumentIdentifierTokenId}/enrollment

Production in India:

GET https://api.in.cybersource.com/tms/v1/instrumentidentifiers/{instrumentIdentifierTokenId}/enrollment

instrumentIdentifierTokenId

is the instrument identifier token ID returned in the

field when you created the instrument identifier token. For more information, see Create an Instrument Identifier.

Retrieve a Network Token for Payment Credentials

This section shows you how to retrieve a network token for payment credentials.

Endpoint

Test:

POST https://apitest.cybersource.com/tms/v2/tokens/
{tokenId}/
payment-credentials

Production:

POST https://api.cybersource.com/tms/v2/tokens/
{tokenId}
/payment-credentials

Production in India:

POST https://api.in.cybersource.com/tms/v2/tokens/
{tokenId}
/payment-credentials

The

{tokenId}

is the token ID returned in the

field when you created the customer, payment instrument or instrument identifier token. For more information, see Create an Instrument Identifier for more information.

Retrieve an Instrument Identifier

This section shows you how to retrieve an instrument identifier.

Endpoint

Test:

GET https://apitest.cybersource.com/tms/v1/instrumentidentifiers/{instrumentIdentifierTokenId}

Production:

GET https://api.cybersource.com/tms/v1/instrumentidentifiers/{instrumentIdentifierTokenId}

Production in India:

GET https://api.in.cybersource.com/tms/v1/instrumentidentifiers/{instrumentIdentifierTokenId}

{instrumentIdentifierTokenId}

is the instrument identifier token ID returned in the

field when you created the instrument identifier token. For more information, see Create an Instrument Identifier.

Delete an Instrument Identifier

This section shows you how to delete an instrument identifier.

Endpoint

Test:

DELETE https://apitest.cybersource.com/tms/v1/instrumentidentifiers/{instrumentIdentifierTokenId}

Production:

DELETE https://api.cybersource.com/tms/v1/instrumentidentifiers/{instrumentIdentifierTokenId}

Production in India:

DELETE https://api.in.cybersource.com/tms/v1/instrumentidentifiers/{instrumentIdentifierTokenId}

{instrumentIdentifierTokenId}

is the instrument identifier token ID returned in the

field in the

field when you created the instrument identifier token. For more information, see Create an Instrument Identifier.

Network Token Provision Failures

Network Token Provision Failure Reason Codes and Descriptions
Reason Code	Description
INVALID_REQUEST	The network token provision request contained invalid data.
CARD_VERIFICATION_FAILED	The network token provision request contained data that could not be verified.
CARD_NOT_ELIGIBLE	Card cannot be used currently with issuer for tokenization.
CARD_NOT_ALLOWED	Card cannot be used currently with card association for tokenization.
DECLINED	Card cannot be used currently with issuer for tokenization.
SERVICE_UNAVAILABLE	The network token service was unavailable or timed out.
SYSTEM_ERROR	An unexpected error occurred with network token service, check configuration.

Lost and Stolen Card Response

    {
    "_links": {
        "self": {
            "href": "
      https://apitest.cybersource.com
      /tms/v1/instrumentidentifiers/7030000000041554452"
        },
        "paymentInstruments": {
            "href": "
      https://apitest.cybersource.com
      /tms/v1/instrumentidentifiers/7030000000041554452/paymentinstruments"
        }
    },
    "id": "7030000000041554452",
    "object": "instrumentIdentifier",
    "state": "ACTIVE",
    "tokenizedCard": {
        "state": "UNPROVISIONED",
        "reason": "CARD_NOT_ELIGIBLE",
        "type": "visa"
    },
    "card": {
        "number": "400555XXXXXX4452"
    },
    "metadata": {
        "creator": "testrest"
    }
}

Issuer Decline Response

    {
    "_links": {
        "self": {
            "href": "
      https://apitest.cybersource.com
      /tms/v1/instrumentidentifiers/7030000000051790079"
        },
        "paymentInstruments": {
            "href": "
      https://apitest.cybersource.com
      /tms/v1/instrumentidentifiers/7030000000051790079/paymentinstruments"
        }
    },
    "id": "7030000000051790079",
    "object": "instrumentIdentifier",
    "state": "ACTIVE",
    "tokenizedCard": {
        "state": "UNPROVISIONED",
        "reason": "CARD_NOT_ALLOWED",
        "type": "visa"
    },
    "card": {
        "number": "462294XXXXXX0079"
    },
    "metadata": {
        "creator": "testrest"
    }
}

Past Expiration Date Response

    {
    "_links": {
        "self": {
            "href": "
      https://apitest.cybersource.com
      /tms/v1/instrumentidentifiers/7030000000224170019"
        },
        "paymentInstruments": {
            "href": "
      https://apitest.cybersource.com
      /tms/v1/instrumentidentifiers/7030000000224170019/paymentinstruments"
        }
    },
    "id": "7030000000224170019",
    "object": "instrumentIdentifier",
    "state": "ACTIVE",
    "tokenizedCard": {
        "state": "UNPROVISIONED",
        "reason": "CARD_NOT_ALLOWED",
        "type": "visa"
    },
    "card": {
        "number": "476134XXXXXX0019"
    },
    "metadata": {
        "creator": "testrest"
    }
}

Issuer Not Participating Response

    {
    "_links": {
        "self": {
            "href": "
      https://apitest.cybersource.com
      /tms/v1/instrumentidentifiers/7030000000224170019"
        },
        "paymentInstruments": {
            "href": "
      https://apitest.cybersource.com
      /tms/v1/instrumentidentifiers/7030000000224170019/paymentinstruments"
        }
    },
    "id": "7030000000224170019",
    "object": "instrumentIdentifier",
    "state": "ACTIVE",
    "tokenizedCard": {
        "state": "UNPROVISIONED",
        "reason": "CARD_NOT_ALLOWED",
        "type": "visa"
    },
    "card": {
        "number": "476134XXXXXX0019"
    },
    "metadata": {
        "creator": "testrest"
    }
}