ProximityReader · IOS API REFERENCE

VASRequest.Merchant

struct · iOS 15.4+ · SDK 27.1

struct Merchant

The identity of a merchant that offers a loyalty program. Create `Merchant` objects to identify merchants whose loyalty programs you support. When placing a request for loyalty card information, or Value Added Services (VAS) information, specify the associated merchant details. The system uses the merchant information to return details only for those merchants.

Members (7)

get · iOS 15.4+

localizedName

TypeScript

get localizedName(): string

Swift declaration

var localizedName: String

The localized name of the merchant or corresponding loyalty program. Upon a successful read of the Value Added Services (VAS) information, the system displays this information to the customer.

set · iOS 15.4+

localizedName

TypeScript

set localizedName(value: string)

Swift declaration

var localizedName: String

The localized name of the merchant or corresponding loyalty program. Upon a successful read of the Value Added Services (VAS) information, the system displays this information to the customer.

get · iOS 15.4+ · Deprecated in iOS 16.4

shouldSendURLOnly

TypeScript

get shouldSendURLOnly(): boolean

Swift declaration

let shouldSendURLOnly: Bool

A Boolean value that indicates whether to send only the merchant URL to the customer's device without requesting data. The customer's device can use the URL for pass provisioning.

init · iOS 16.4+

init

TypeScript

static initIdUrlLocalizedName(id: string, url?: (string) | null, localizedName?: (string) | null): VASRequest_Merchant

Swift declaration

init(id: String, url: URL? = nil, localizedName: String? = nil)

Creates a new merchant object with the specified information. - Parameters: - id: The merchant's unique identifier. Obtain this value from the merchant. - url: The URL to display if the customer doesn't belong to the merchant's loyalty program. - localizedName: The name of the merchant, localized for the current device.

init · iOS 15.4+ · Deprecated in iOS 16.4

init

TypeScript

static initIdUrlShouldSendURLOnlyLocalizedName(id: string, url?: (string) | null, shouldSendURLOnly?: boolean, localizedName?: (string) | null): VASRequest_Merchant

Swift declaration

init(id: String, url: URL? = nil, shouldSendURLOnly: Bool = false, localizedName: String? = nil)

Creates a new merchant object with the specified information. - Parameters: - id: The merchant's unique identifier. Obtain this value from the merchant. - url: The URL to display if the customer doesn't belong to the merchant's loyalty program. - shouldSendURLOnly: A Boolean value that indicates whether to send the URL information to the customer's device. - localizedName: The name of the merchant, localized for the current device.

get · iOS 15.4+

id

TypeScript

get id(): string

Swift declaration

let id: String

A unique identifier for the merchant. When reading a card, the system sends this identifier to the customer device, which uses the value to retrieve the matching loyalty or reward ID of the customer.

get · iOS 15.4+

url

TypeScript

get url(): (string) | null

Swift declaration

let url: URL?

The URL to display to the customer if the matching loyalty or reward ID isn't found. If the customer isn't part of the merchant's loyalty program, they can use the provided URL to get more information about that program.

Skipped declarations

No declarations were skipped in this snapshot.

All ProximityReader types →