# StoredNetworkToken

A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.

A network-issued token (DPAN) stored on a payment method, together with the provider
metadata needed to keep it current.

## Fields
- `tokenReference` (string): The network token (DPAN) reference value. Encrypted at rest; never logged. (nullable)
- `tokenRequestorId` (string): The token-requestor identifier the network token was provisioned under. (nullable)
- `tokenStatus` ([StoredTokenStatus](https://devportal.signapay-sbx.winkpg.io/docs/api/models/StoredTokenStatus.md)): The token's status as last known to the gateway, in the vocabulary shared with processor tokens. Kept in step with `lifecycleState` by `ApplyLifecycleState`. (nullable)
  Values:
  - `Active`: The token is active and may be replayed at the rail.
  - `Inactive`: The token is present but should not currently be used (for example the processor reported it inactive). Retained so it can be reactivated rather than re-minted.
  - `Invalidated`: The token has been invalidated or replaced and cannot be used.
- `expiryMonth` (integer(int32)): The network token's expiry month (1 to 12), when provided by the token service. (nullable)
- `expiryYear` (integer(int32)): The network token's expiry year, when provided by the token service. (nullable)
- `createdAt` (string(date-time)): When the network token was provisioned and stored. (nullable)
- `providerName` (string): The provider that holds the token, for example `cybersource`. (nullable)
- `providerTokenReference` (string): The provider's identifier for the token. Encrypted at rest with deterministic encryption so an equality lookup still works; never logged and never returned on a read. (nullable)
- `providerAccountId` (string): The provider account or organization the token was provisioned under. Retrieving or deleting the token must run under the same account. Never returned on a read. (nullable)
- `environment` ([NetworkTokenEnvironment](https://devportal.signapay-sbx.winkpg.io/docs/api/models/NetworkTokenEnvironment.md)): The provider environment the token was provisioned in. Retrieving or deleting the token must run against the same environment. Null when the environment is not known. (nullable)
  Values:
  - `Sandbox`: The provider's sandbox (test) environment.
  - `Production`: The provider's production (live) environment.
- `paymentAccountReference` (string): The network's payment account reference for the card. Encrypted at rest; never logged and never returned on a read. (nullable)
- `cardNetwork` (string): The card network that issued the token, for example `Visa`. (nullable)
- `tokenSuffix` (string): The last four digits of the token number. (nullable)
- `lifecycleState` ([NetworkTokenLifecycleState](https://devportal.signapay-sbx.winkpg.io/docs/api/models/NetworkTokenLifecycleState.md)): The token's life-cycle state as last reported by the provider. (nullable)
  Values:
  - `Active`: The token is active and may be used.
  - `Suspended`: The token is suspended by the issuer or the network and must not be used for now.
  - `Deleted`: The token was deleted and can never be used again.
  - `Expired`: The token expired.
- `cardSuffix` (string): The last four digits of the underlying card as last reported by the network. Can differ from the vaulted card after a reissue. (nullable)
- `cardExpiryMonth` (integer(int32)): The underlying card's expiry month as last reported by the network. (nullable)
- `cardExpiryYear` (integer(int32)): The underlying card's expiry year as last reported by the network. (nullable)
- `underlyingCardChangedAt` (string(date-time)): When the provider last reported that the card behind the token changed. (nullable)
- `lastLifecycleEventAt` (string(date-time)): When the provider observed the last life-cycle event applied to this token. Used to ignore a delayed notification that is older than the state already stored. (nullable)
- `lastVerifiedAt` (string(date-time)): When the gateway last confirmed the token's state with the provider. (nullable)
- `lastLifecycleReason` (string): The provider's reason code for the last life-cycle event. A code, never free text. (nullable)

## See also

- [All documentation](https://devportal.signapay-sbx.winkpg.io/llms.txt): the machine-readable index of every public page on this site.