VGSCardNumberTokenizationParameters

@MainActor
public struct VGSCardNumberTokenizationParameters : VGSTokenizationParametersProtocol

VGSCardNumberTokenizationParameters - parameters required for tokenization API.

Summary: Defines how primary account number (PAN) input (FieldType .cardNumber) is transformed into an alias for Vault tokenization / alias creation APIs.

Properties:

  • storage: Vault storage type. Uses .PERSISTENT by default to enable downstream reuse in PCI compliant flows (e.g. recurring billing).
  • format: Alias format. Default FPE_SIX_T_FOUR preserves first six (BIN) + last four digits while protecting the middle digits.

Usage:

var cardParams = VGSCardNumberTokenizationParameters()
cardParams.format = VGSVaultAliasFormat.FPE_SIX_T_FOUR.rawValue // or a fully opaque format e.g. UUID
let cardCfg = VGSCardNumberTokenizationConfiguration(collector: collector, fieldName: "card_number")
cardCfg.tokenizationParameters = cardParams
cardField.configuration = cardCfg

Notes:

  • Choose a fully opaque format (e.g. UUID) when BIN + last4 are not required in client logic.
  • Format affects alias output only; validation (length, Luhn) controlled via rules / field type.
Show on GitHub

  • Vault storage type. Card numbers typically require future re-use (e.g. replay with PCI compliant workflows) so .PERSISTENT is used.

    Declaration

    Swift

    @MainActor
public let storage: String
    Show on GitHub

  • Data alias format. Uses a length-preserving format with first six and last four digits exposed (FPE_SIX_T_FOUR) to support BIN + last4 business logic while keeping middle digits protected.

    Declaration

    Swift

    @MainActor
public var format: String
    Show on GitHub