public class WalletPassEntry

  1. Object
  2. WalletPassEntry

A card entry published to the Apple Wallet issuer-provisioning extension through WalletExtension. Each entry describes one card the user can add to Apple Wallet from inside the Wallet app.

The identifier must match the card’s primary account identifier known to the issuer backend; Wallet uses it to filter out cards that are already provisioned on the device, and it is echoed back to the issuer endpoint when the user adds the card.

The card art must be a PNG without personally identifiable information (Apple requirement: square corners, no PII such as the full card number).

Constructors

public WalletPassEntry()Creates a blank entry; populate it with the fluent setters.
public WalletPassEntry(String identifier, String title, byte[] artPng)Creates an entry with the required fields.

Methods

public WalletPassEntry identifier(String identifier)Sets the card’s primary account identifier.
public WalletPassEntry title(String title)Sets the user visible card title shown in Wallet.
public WalletPassEntry cardholderName(String cardholderName)Sets the cardholder name shown during provisioning.
public WalletPassEntry primaryAccountSuffix(String primaryAccountSuffix)Sets the last digits of the card number shown during provisioning, e.g. "1234".
public WalletPassEntry paymentNetwork(String paymentNetwork)Sets the payment network, e.g. "Visa" or "MasterCard".
public WalletPassEntry localizedDescription(String localizedDescription)Sets the description shown during provisioning, e.g. "My Bank Debit Card".
public WalletPassEntry artPng(byte[] artPng)Sets the PNG bytes of the card art, e.g. EncodedImage.getImageData().
public String getIdentifier()Returns the card’s primary account identifier.
public String getTitle()Returns the user visible card title.
public String getCardholderName()Returns the cardholder name.
public String getPrimaryAccountSuffix()Returns the last digits of the card number.
public String getPaymentNetwork()Returns the payment network.
public String getLocalizedDescription()Returns the description shown during provisioning.
public byte[] getArtPng()Returns the PNG bytes of the card art.

Inherited methods

From Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait, clone

Constructor details

WalletPassEntry

public WalletPassEntry()
Creates a blank entry; populate it with the fluent setters.

WalletPassEntry

public WalletPassEntry(String identifier, String title, byte[] artPng)
Creates an entry with the required fields.

Parameters

identifier String
the card’s primary account identifier
title String
user visible card title shown in Wallet
artPng byte[]
PNG bytes of the card art, e.g. EncodedImage.getImageData()

Method details

identifier

public WalletPassEntry identifier(String identifier)
Sets the card’s primary account identifier. Required.

title

public WalletPassEntry title(String title)
Sets the user visible card title shown in Wallet. Required.

cardholderName

public WalletPassEntry cardholderName(String cardholderName)
Sets the cardholder name shown during provisioning.

primaryAccountSuffix

public WalletPassEntry primaryAccountSuffix(String primaryAccountSuffix)
Sets the last digits of the card number shown during provisioning, e.g. "1234".

paymentNetwork

public WalletPassEntry paymentNetwork(String paymentNetwork)
Sets the payment network, e.g. "Visa" or "MasterCard". Must match one of Apple’s PKPaymentNetwork constant values.

localizedDescription

public WalletPassEntry localizedDescription(String localizedDescription)
Sets the description shown during provisioning, e.g. "My Bank Debit Card".

artPng

public WalletPassEntry artPng(byte[] artPng)
Sets the PNG bytes of the card art, e.g. EncodedImage.getImageData(). Required; entries without art are not shown by Wallet.

getIdentifier

public String getIdentifier()
Returns the card’s primary account identifier.

getTitle

public String getTitle()
Returns the user visible card title.

getCardholderName

public String getCardholderName()
Returns the cardholder name.

getPrimaryAccountSuffix

public String getPrimaryAccountSuffix()
Returns the last digits of the card number.

getPaymentNetwork

public String getPaymentNetwork()
Returns the payment network.

getLocalizedDescription

public String getLocalizedDescription()
Returns the description shown during provisioning.

getArtPng

public byte[] getArtPng()
Returns the PNG bytes of the card art.