Creates a new options structure with the specified list of merchants.
- Parameters:
- vasMerchants: An array of merchants with supported loyalty cards.
get · iOS 15.4+ · Deprecated in iOS 18.0
vasMerchants
TypeScript
get vasMerchants(): Array<VASRequest_Merchant>
Swift declaration
var vasMerchants: [VASRequest.Merchant]
A global list of merchants to use when reading loyalty cards.
When you try to read a loyalty card from your ``PaymentCardReaderSession``
object, specify a custom ``VASRequest`` object to override this list.
set · iOS 15.4+ · Deprecated in iOS 18.0
vasMerchants
TypeScript
set vasMerchants(value: Array<VASRequest_Merchant>)
Swift declaration
var vasMerchants: [VASRequest.Merchant]
A global list of merchants to use when reading loyalty cards.
When you try to read a loyalty card from your ``PaymentCardReaderSession``
object, specify a custom ``VASRequest`` object to override this list.
get · iOS 16.4+
includeErrorInReadResult
TypeScript
get includeErrorInReadResult(): boolean
Swift declaration
var includeErrorInReadResult: Bool
A Boolean value that indicates whether the framework returns a result instead of throwing an error when some data is retrievable.
The default value is `false`.
After the framework reads a payment card, when there's an error, the framework discards ``PaymentCardReadResult`` and throws an error.
When you set this option to `true`, if an error arises, the framework doesn't throw an error, instead the ``PaymentCardReadResult``
includes both the ``PaymentCardReadResult/outcome`` and the data that the framework can retrieve.
You're responsible for checking the outcome in addition to catching errors the framework throws.
set · iOS 16.4+
includeErrorInReadResult
TypeScript
set includeErrorInReadResult(value: boolean)
Swift declaration
var includeErrorInReadResult: Bool
A Boolean value that indicates whether the framework returns a result instead of throwing an error when some data is retrievable.
The default value is `false`.
After the framework reads a payment card, when there's an error, the framework discards ``PaymentCardReadResult`` and throws an error.
When you set this option to `true`, if an error arises, the framework doesn't throw an error, instead the ``PaymentCardReadResult``
includes both the ``PaymentCardReadResult/outcome`` and the data that the framework can retrieve.
You're responsible for checking the outcome in addition to catching errors the framework throws.
get · iOS 16.4+
returnReadResultImmediately
TypeScript
get returnReadResultImmediately(): boolean
Swift declaration
var returnReadResultImmediately: Bool
A Boolean value that indicates whether the framework returns a result as soon as possible before closing the system UI.
The default value is `false`.
After the framework reads a payment card, by default, the UI shows an animation before closing then returning the result.
When you set this option to `true`, the framework returns ``PaymentCardReadResult`` immediately without waiting for the system UI to close.
set · iOS 16.4+
returnReadResultImmediately
TypeScript
set returnReadResultImmediately(value: boolean)
Swift declaration
var returnReadResultImmediately: Bool
A Boolean value that indicates whether the framework returns a result as soon as possible before closing the system UI.
The default value is `false`.
After the framework reads a payment card, by default, the UI shows an animation before closing then returning the result.
When you set this option to `true`, the framework returns ``PaymentCardReadResult`` immediately without waiting for the system UI to close.
init · iOS 18.0+
init
TypeScript
static init(): PaymentCardReader_Options
Swift declaration
init()
Creates a new options structure with default values