EVevervault
Payments
Network Tokens

Simulate a Network Token Update

Changed on

Simulates an update to a Network Token so that you can test your integration. Sandbox only.

post/payments/network-tokens/{network_token_id}/simulate

Request

Path parameters

network_token_idstring required

The id of the Network Token

Request body

updateType'new-token-status' | 'new-card-expiry-and-last-four' | 'new-token-expiry-and-number' | 'no-update'

The type of update to simulate.

status'active' | 'inactive' | 'blocked' | 'provisioning' | 'suspended' | 'deleted' | 'expired'

The status to set on the Network Token. Only applies when updateType is new-token-status, and defaults to inactive.

externalCustomerReferencestring

An optional reference of your choice, such as a correlation ID, that is attached to the request. The reference will be visible in your logs. Must be between 1 and 255 characters.

Example request

{
  "status": "suspended",
  "externalCustomerReference": "00-4bf92f3577b34da6a3ce929d3e0e4736-00f067aa0ba902b7-01"
}

Response

Returns the updated Network Token object.

idstring required

A unique identifier representing a specific Network Token.

numberstring required

The unique number of the Network Token.

tokenRequestorIdentifierstring required

The identifier of the Token Requestor (TRID) that requested the Network Token.

tokenServiceProvider'mdes' | 'vts' | 'aets' required

The Token Service Provider (TSP) that issued the Network Token.

paymentAccountReferencestring

The unique identifier of the Payment Account associated with this Network Token.

status'active' | 'inactive' | 'blocked' | 'provisioning' | 'suspended' | 'deleted' | 'expired' required

The status of the Network Token. Active means the token is valid and can be used for payments. Inactive means the token exists but is not currently active. Blocked and provisioning are reserved for future use. Suspended means the token is temporarily unusable but may be reactivated by the issuer or transition to deleted. Deleted is a terminal state where the token is permanently removed and a new credential must be obtained. Expired means the token has passed its expiration date and should not be used for transactions.

merchantstring required

The unique identifier of the Merchant associated with this Network Token.

createdAtinteger required

The exact time, in epoch milliseconds, when this Network Token was created.

updatedAtinteger

The exact time, in epoch milliseconds, when this Network Token was last updated.

Example response

{
  "id": "network_token_eead1d640d7c",
  "number": "4498004918463434",
  "expiry": {
    "month": "13",
    "year": "25"
  },
  "card": {
    "lastFour": "4242",
    "expiry": {
      "month": "09",
      "year": "26"
    },
    "brand": "visa"
  },
  "paymentAccountReference": "512381d9f8e0629211e3949a08002",
  "tokenRequestorIdentifier": "40020248564",
  "tokenServiceProvider": "vts",
  "merchant": "merchant_ddsaJsda9d86",
  "status": "active",
  "createdAt": 1692972623233,
  "updatedAt": 1692972623768
}

Changes

  • 8d0ca833fa04Revision changes
    • warning

      added the new american-express enum value to the / response property for the response status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new no-update enum value to the request property

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

  • 5e1eb58d42d5Revision changes
    • breaking

      removed the enum value deactivate-token of the request property

    • warning

      added the new blocked enum value to the response property for the response status

    • warning

      added the new deleted enum value to the response property for the response status

    • warning

      added the new expired enum value to the response property for the response status

    • warning

      added the new provisioning enum value to the response property for the response status

    • warning

      added the new suspended enum value to the response property for the response status

    • info

      added the new new-token-status enum value to the request property