CardRequest

public struct CardRequest : Encodable, Sendable

Card request model.

  • Unique identification of the card in your system.

    Declaration

    Swift

    public let externalId: String
  • This product ID is assigned to you by the Alviere team when you setup your card issuance service.

    Declaration

    Swift

    public let productId: String
  • This is the initial balance that the card being issued will have, in cents.

    Declaration

    Swift

    public let initialBalance: Int?
  • Address to ship the card to. If not present, the system will send the card to the address defined in the user account profile.

    Declaration

    Swift

    public let shippingAddress: Address?
  • The rules this card should use when authorizing a transaction.

    Declaration

    Swift

    public let authRules: AuthRules?
  • The ID to be used at the embossing process.

    Declaration

    Swift

    public let embossId: String?
  • Card custom fields. The keys can be mapped from CardCustomField if you want type safety.

    Declaration

    Swift

    public let customFields: [String : CustomValue]?
  • Service fees to be applied to a transaction.

    Declaration

    Swift

    public let serviceFees: [CardServiceFee]?
  • Card metadata fields.

    Declaration

    Swift

    public let metadata: [String : CustomValue]?
  • Array of incentive rules that should apply to this card.

    Declaration

    Swift

    public let incentives: CardIncentivesRules?
  • If the pin should be automatically generated.

    Declaration

    Swift

    public let autoPinGeneration: Bool?
  • Auxiliary constructor

    Declaration

    Swift

    public init(productId: String,
                externalId: String = "",
                initialBalance: Int? = nil,
                shippingAddress: AddressModel? = nil,
                authRules: AuthRules? = nil,
                embossId: String? = nil,
                customFields: [String: CustomValue]? = nil,
                serviceFees: [CardServiceFee]? = nil,
                metadata: [String: CustomValue]? = nil,
                incentives: CardIncentivesRules? = nil,
                // swiftlint:disable discouraged_optional_boolean
                autoPinGeneration: Bool? = nil)

    Parameters

    externalId

    Unique identification of the card in your system.

    productId

    This product ID is assigned to you by the Alviere team when you setup your card issuance service.

    initialBalance

    This is the initial balance that the card being issued will have, in cents.

    shippingAddress

    Address to ship the card to. If not present, the system will send the card to the address defined in the user account profile.

    authRules

    The rules this card should use when authorizing a transaction.

    embossId

    The ID to be used at the embossing process.

    customFields

    Card custom fields. The keys can be mapped from CardCustomField if you want type safety.

    serviceFee

    Service fees to be applied to a transaction.

    metadata

    Card metadata fields.

    incentives

    Array of incentive rules that should apply to this card.

    autoPinGeneration

    If the pin should be automatically generated.