---
title: "Simulate a Network Token Update"
method: POST
path: "/payments/network-tokens/{network_token_id}/simulate"
tags: ["Payments", "Network Tokens"]
---

# Simulate a Network Token Update

`POST /payments/network-tokens/{network_token_id}/simulate`

## Request

- Base URL: `https://api.evervault.com`
- URL: `https://api.evervault.com/payments/network-tokens/{network_token_id}/simulate`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/evervault/apis/evervault-api/docs/payments/network-tokens/:network_token_id/simulate/post.ts> (a function with typed inputs; its response is checked against the schema)

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

## Path parameters

- `network_token_id` string, required

## Request body

- object
  - `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`.
  - `externalCustomerReference` string: 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.

## Response `200`

Returns the updated Network Token object.

- NetworkToken
  - `id` string, required: A unique identifier representing a specific Network Token.
  - `number` string, required: The unique number of the Network Token.
  - `expiry` NetworkTokenExpiry, required: The network token expiry date.
    - `month` string, required: The network token expiry month, in MM format (e.g. 12 for December)
    - `year` string, required: The network token expiry year, in YY format (e.g. 29 for 2029)
  - `card` object, required: The details of the underlying encrypted card.
    - `lastFour` string, required: The last four digits of the card number.
    - `expiry` object, required: The expiry details of the card.
      - `month` string: The month of the card's expiry date, in MM format (e.g. 12 for December)
      - `year` string: The year of the card's expiry date, in YY format (e.g. 26 for 2026)
    - `brand` 'visa' | 'mastercard' | 'american-express', required: The card brand associated with the payment card.
  - `tokenRequestorIdentifier` string, 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.
  - `paymentAccountReference` string: 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.
  - `merchant` string, required: The unique identifier of the Merchant associated with this Network Token.
  - `createdAt` integer, required: The exact time, in epoch milliseconds, when this Network Token was created.
  - `updatedAt` integer: The exact time, in epoch milliseconds, when this Network Token was last updated.

## Changes

- **2026-11-06** `8d0ca833fa04`: 1 warning, 8 info
  - added the new `american-express` enum value to the `card/brand` response property for the response status `200`
  - added the new optional request property `externalCustomerReference`
  - added the new optional request property `status`
  - added the new `no-update` enum value to the request property `updateType`
  - …5 more
- **2026-04-17** `5e1eb58d42d5`: 1 breaking, 5 warning, 1 info
  - removed the enum value `deactivate-token` of the request property `updateType`
  - added the new `blocked` enum value to the `status` response property for the response status `200`
  - added the new `deleted` enum value to the `status` response property for the response status `200`
  - added the new `expired` enum value to the `status` response property for the response status `200`
  - …3 more
- **2025-11-18** `30ea25af4354`: 4 info
  - api tag `Network Tokens` added
  - api tag `Payments` added
  - api tag `payments` removed
  - request body became optional

[Operation history](https://skmtc.dev/evervault/apis/evervault-api/changes/payments/network-tokens/:network_token_id/simulate/post.md)

---

[API](https://skmtc.dev/evervault/apis/evervault-api.md) - [All operations](https://skmtc.dev/evervault/apis/evervault-api/llms.txt) - [OpenAPI document](https://skmtc.dev/evervault/apis/evervault-api/revisions/8d0ca833fa04?raw)