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.
Values
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields
| Field | Type | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
tokenReference
required |
string | The network token (DPAN) reference value. Encrypted at rest; never logged.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
tokenRequestorId
required |
string | The token-requestor identifier the network token was provisioned under.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
tokenStatus
required |
StoredTokenStatus StoredTokenStatus | 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:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
expiryMonth
required |
integer (int32) | The network token's expiry month (1 to 12), when provided by the token service.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
expiryYear
required |
integer (int32) | The network token's expiry year, when provided by the token service.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
createdAt
required |
string (date-time) | When the network token was provisioned and stored.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
providerName
required |
string | The provider that holds the token, for example `cybersource`.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
providerTokenReference
required |
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
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
providerAccountId
required |
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
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
environment
required |
NetworkTokenEnvironment NetworkTokenEnvironment | 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:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
paymentAccountReference
required |
string | The network's payment account reference for the card. Encrypted at rest; never logged and
never returned on a read.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
cardNetwork
required |
string | The card network that issued the token, for example `Visa`.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
tokenSuffix
required |
string | The last four digits of the token number.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
lifecycleState
required |
NetworkTokenLifecycleState NetworkTokenLifecycleState | The token's life-cycle state as last reported by the provider.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
cardSuffix
required |
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
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
cardExpiryMonth
required |
integer (int32) | The underlying card's expiry month as last reported by the network.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
cardExpiryYear
required |
integer (int32) | The underlying card's expiry year as last reported by the network.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
underlyingCardChangedAt
required |
string (date-time) | When the provider last reported that the card behind the token changed.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
lastLifecycleEventAt
required |
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
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
lastVerifiedAt
required |
string (date-time) | When the gateway last confirmed the token's state with the provider.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
lastLifecycleReason
required |
string | The provider's reason code for the last life-cycle event. A code, never free text.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This model has no documented fields.