# TokenRegenerationResultDto

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

Result DTO returned after token regeneration.

## Fields
- `newToken` ([PaymentTokenDto](https://devportal.demo.winkpg.io/docs/api/models/PaymentTokenDto.md)): The new regenerated token.
  Fields:
  - `extraProperties` (object): (nullable, read only)
  - `id` (string(uuid))
  - `creationTime` (string(date-time)): The date and time when this entity was created.
  - `creatorId` (string(uuid)): The ID of the user who created this entity. (nullable)
  - `lastModificationTime` (string(date-time)): The date and time when this entity was last modified. (nullable)
  - `lastModifierId` (string(uuid)): The ID of the user who last modified this entity. (nullable)
  - `isDeleted` (boolean): Indicates whether this entity has been deleted.
  - `deleterId` (string(uuid)): The ID of the user who deleted this entity, if it is deleted. (nullable)
  - `deletionTime` (string(date-time)): The date and time when this entity was deleted, if it is deleted. (nullable)
  - `tenantId` (string(uuid)): Id of the related tenant. (nullable, read only)
  - `concurrencyStamp` (string): (nullable)
  - `numericToken` (integer(int64)): The numeric representation of the token. (nullable)
  - `cardFormatToken` (string): The card format representation of the token. (nullable)
  - `transactionId` (string(uuid)): The unique identifier of the associated transaction when the token was created. (nullable)
  - `paymentDetails` ([PaymentDetailSnapshot](https://devportal.demo.winkpg.io/docs/api/models/PaymentDetailSnapshot.md)): The payment details snapshot associated with this token.
  - `type` ([TokenType](https://devportal.demo.winkpg.io/docs/api/models/TokenType.md)): The underlying payment type of the token.
    Values:
    - `Card`: A card, keyed or read.
    - `Check`: A bank account debited over ACH, or a check.
    - `Cash`: Cash, which carries no instrument block of its own.
    - `DigitalWallet`: A digital wallet (Apple Pay, Google Pay, Paze), which rides the card networks.
    - `AlternativePayment`: An alternative payment method approved inside a provider (PayPal, Venmo, Pay Later, Affirm, Klarna, Afterpay) and presented to the gateway as an approval reference.
  - `category` ([TokenCategory](https://devportal.demo.winkpg.io/docs/api/models/TokenCategory.md)): The category of the token (e.g., internal, network).
    Values:
    - `Internal`
    - `Network`
    - `Wallet`
  - `merchantId` (string(uuid)): Id of the related Merchant. (nullable)
  - `customerId` (string(uuid)): The customer this stored credential is bound to, or `null` when it is not bound to one. (nullable)
  - `tokenSharing` (boolean): The sharing status of the token.
  - `label` (string): Optional human-readable label for the token. (nullable)
  - `status` ([TokenStatus](https://devportal.demo.winkpg.io/docs/api/models/TokenStatus.md)): The status of the token (Active, Inactive, Invalidated).
    Values:
    - `Active`: Token is active and can be used for transactions.
    - `Inactive`: Token is inactive but can be reactivated.
    - `Invalidated`: Token has been invalidated and replaced by a new token. Cannot be used for new transactions and cannot be reactivated.
    - `Redacted`: The vaulted account data has been wiped at the owner's request, leaving an audit shell: the last four, brand, BIN metadata, expiry, customer, merchant and lifecycle history survive, and the card number, cardholder name, bank account / routing / MICR values and any stored processor or network token do not.
  - `invalidatedByTokenId` (string(uuid)): The ID of the token that replaced this one (if invalidated and regenerated). (nullable)
  - `replacesTokenId` (string(uuid)): The ID of the token that this token replaced (if this is a regenerated token). (nullable)
  - `regenerationReason` ([TokenRegenerationReason](https://devportal.demo.winkpg.io/docs/api/models/TokenRegenerationReason.md)): The reason for token regeneration (if applicable). (nullable)
    Values:
    - `Manual`: Manually initiated by user.
    - `NearExpiration`: Automated regeneration due to near expiration.
    - `SuspectedCompromise`: Suspected compromise or security concern.
    - `Other`: Other reason.
  - `lastRegeneratedAt` (string(date-time)): The timestamp when this token was last regenerated. (nullable)
  - `redactedAt` (string(date-time)): When the token's stored card or bank account details were erased, or `null` for a token  that has not been redacted. (nullable)
  - `redactionReason` (string): The reason recorded when the token's stored details were erased, or `null` for a token  that has not been redacted. (nullable)
  - `publicReference` (string): The stable, opaque `pt_`-prefixed handle for this token: the only token identifier  permitted to leave the gateway, and the value to charge against on a merchant-initiated  transaction. Distinct from the internal id, which correlates to a card number and is never  treated as a merchant-facing handle. (nullable)
- `originalToken` ([PaymentTokenDto](https://devportal.demo.winkpg.io/docs/api/models/PaymentTokenDto.md)): The original invalidated token.
  Fields:
  - `extraProperties` (object): (nullable, read only)
  - `id` (string(uuid))
  - `creationTime` (string(date-time)): The date and time when this entity was created.
  - `creatorId` (string(uuid)): The ID of the user who created this entity. (nullable)
  - `lastModificationTime` (string(date-time)): The date and time when this entity was last modified. (nullable)
  - `lastModifierId` (string(uuid)): The ID of the user who last modified this entity. (nullable)
  - `isDeleted` (boolean): Indicates whether this entity has been deleted.
  - `deleterId` (string(uuid)): The ID of the user who deleted this entity, if it is deleted. (nullable)
  - `deletionTime` (string(date-time)): The date and time when this entity was deleted, if it is deleted. (nullable)
  - `tenantId` (string(uuid)): Id of the related tenant. (nullable, read only)
  - `concurrencyStamp` (string): (nullable)
  - `numericToken` (integer(int64)): The numeric representation of the token. (nullable)
  - `cardFormatToken` (string): The card format representation of the token. (nullable)
  - `transactionId` (string(uuid)): The unique identifier of the associated transaction when the token was created. (nullable)
  - `paymentDetails` ([PaymentDetailSnapshot](https://devportal.demo.winkpg.io/docs/api/models/PaymentDetailSnapshot.md)): The payment details snapshot associated with this token.
  - `type` ([TokenType](https://devportal.demo.winkpg.io/docs/api/models/TokenType.md)): The underlying payment type of the token.
    Values:
    - `Card`: A card, keyed or read.
    - `Check`: A bank account debited over ACH, or a check.
    - `Cash`: Cash, which carries no instrument block of its own.
    - `DigitalWallet`: A digital wallet (Apple Pay, Google Pay, Paze), which rides the card networks.
    - `AlternativePayment`: An alternative payment method approved inside a provider (PayPal, Venmo, Pay Later, Affirm, Klarna, Afterpay) and presented to the gateway as an approval reference.
  - `category` ([TokenCategory](https://devportal.demo.winkpg.io/docs/api/models/TokenCategory.md)): The category of the token (e.g., internal, network).
    Values:
    - `Internal`
    - `Network`
    - `Wallet`
  - `merchantId` (string(uuid)): Id of the related Merchant. (nullable)
  - `customerId` (string(uuid)): The customer this stored credential is bound to, or `null` when it is not bound to one. (nullable)
  - `tokenSharing` (boolean): The sharing status of the token.
  - `label` (string): Optional human-readable label for the token. (nullable)
  - `status` ([TokenStatus](https://devportal.demo.winkpg.io/docs/api/models/TokenStatus.md)): The status of the token (Active, Inactive, Invalidated).
    Values:
    - `Active`: Token is active and can be used for transactions.
    - `Inactive`: Token is inactive but can be reactivated.
    - `Invalidated`: Token has been invalidated and replaced by a new token. Cannot be used for new transactions and cannot be reactivated.
    - `Redacted`: The vaulted account data has been wiped at the owner's request, leaving an audit shell: the last four, brand, BIN metadata, expiry, customer, merchant and lifecycle history survive, and the card number, cardholder name, bank account / routing / MICR values and any stored processor or network token do not.
  - `invalidatedByTokenId` (string(uuid)): The ID of the token that replaced this one (if invalidated and regenerated). (nullable)
  - `replacesTokenId` (string(uuid)): The ID of the token that this token replaced (if this is a regenerated token). (nullable)
  - `regenerationReason` ([TokenRegenerationReason](https://devportal.demo.winkpg.io/docs/api/models/TokenRegenerationReason.md)): The reason for token regeneration (if applicable). (nullable)
    Values:
    - `Manual`: Manually initiated by user.
    - `NearExpiration`: Automated regeneration due to near expiration.
    - `SuspectedCompromise`: Suspected compromise or security concern.
    - `Other`: Other reason.
  - `lastRegeneratedAt` (string(date-time)): The timestamp when this token was last regenerated. (nullable)
  - `redactedAt` (string(date-time)): When the token's stored card or bank account details were erased, or `null` for a token  that has not been redacted. (nullable)
  - `redactionReason` (string): The reason recorded when the token's stored details were erased, or `null` for a token  that has not been redacted. (nullable)
  - `publicReference` (string): The stable, opaque `pt_`-prefixed handle for this token: the only token identifier  permitted to leave the gateway, and the value to charge against on a merchant-initiated  transaction. Distinct from the internal id, which correlates to a card number and is never  treated as a merchant-facing handle. (nullable)
- `reason` ([TokenRegenerationReason](https://devportal.demo.winkpg.io/docs/api/models/TokenRegenerationReason.md)): The reason for regeneration.
  Values:
  - `Manual`: Manually initiated by user.
  - `NearExpiration`: Automated regeneration due to near expiration.
  - `SuspectedCompromise`: Suspected compromise or security concern.
  - `Other`: Other reason.
- `regeneratedAt` (string(date-time)): Timestamp when regeneration occurred.
- `success` (boolean): Success status of the regeneration.
- `message` (string): Message describing the result. (nullable)

## See also

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