currencyCode
TypeScriptget currencyCode(): stringlet currencyCode: StringThe ISO 4217 code that indicates the currency type.
ProximityReader · IOS API REFERENCE
PaymentCardTransactionRequest
struct · iOS 15.4+ · SDK 27.1
struct PaymentCardTransactionRequestA request for a contactless purchase or refund that includes the purchase amount and currency information. Create a `PaymentCardTransactionRequest` to specify the amount of a purchase or refund. After you create this object, pass it to the ``PaymentCardReaderSession/readPaymentCard(_:)-8jol5`` or ``PaymentCardReaderSession/readPaymentCard(_:vasRequest:stopOnVASResult:)`` method of ``PaymentCardReaderSession`` to read the card associated with the transaction.
Members (12)
preferredAIDList
TypeScriptget preferredAIDList(): Array<ArrayBuffer>var preferredAIDList: [Data]The preferred Application Identifier (AID) or Registered Application Provider Identifier (RID). An ordered list of valid binary data between 5 and 16 bytes representing the preferred AID or RID. Use the preferred AID or RID when completing transactions with co-badged cards - a *co-badged* or *co-branded* card is a payment card that supports two or more payment brands. > Note: In iOS 16 and earlier, the framework only uses the first entry. In iOS 17 and later, the list can have up to four entries.
preferredAIDList
TypeScriptset preferredAIDList(value: Array<ArrayBuffer>)var preferredAIDList: [Data]The preferred Application Identifier (AID) or Registered Application Provider Identifier (RID). An ordered list of valid binary data between 5 and 16 bytes representing the preferred AID or RID. Use the preferred AID or RID when completing transactions with co-badged cards - a *co-badged* or *co-branded* card is a payment card that supports two or more payment brands. > Note: In iOS 16 and earlier, the framework only uses the first entry. In iOS 17 and later, the list can have up to four entries.
useISOCurrencySymbol
TypeScriptget useISOCurrencySymbol(): booleanvar useISOCurrencySymbol: BoolA boolean value that sets the system UI's currency symbol to ISO 4217 three-letter code. The default value is `false`.
useISOCurrencySymbol
TypeScriptset useISOCurrencySymbol(value: boolean)var useISOCurrencySymbol: BoolA boolean value that sets the system UI's currency symbol to ISO 4217 three-letter code. The default value is `false`.
userInterfaceLanguage
TypeScriptget userInterfaceLanguage(): (_Foundation_Locale_Language) | nullvar userInterfaceLanguage: Locale.Language?The language the framework uses when localizing the user interface. Setting this attribute only affects customer facing elements. Screen elements or audio targeted at the merchant (device owner) remain set to the language defined in the system settings. When you set this option to `nil`, the framework uses the person's preferred language defined in System Settings.
userInterfaceLanguage
TypeScriptset userInterfaceLanguage(value: (_Foundation_Locale_Language) | null)var userInterfaceLanguage: Locale.Language?The language the framework uses when localizing the user interface. Setting this attribute only affects customer facing elements. Screen elements or audio targeted at the merchant (device owner) remain set to the language defined in the system settings. When you set this option to `nil`, the framework uses the person's preferred language defined in System Settings.
transactionDescription
TypeScriptget transactionDescription(): (PaymentCardTransactionRequest_TransactionAmountDescription) | nullvar transactionDescription: PaymentCardTransactionRequest.TransactionAmountDescription?An optional description of the current transaction meant to provide more context, such as a recurring payment being setup or a surcharge applied. This attribute is only displayed when the ``TransactionType`` is compatible with the ``TransactionAmountDescription`` use case.
transactionDescription
TypeScriptset transactionDescription(value: (PaymentCardTransactionRequest_TransactionAmountDescription) | null)var transactionDescription: PaymentCardTransactionRequest.TransactionAmountDescription?An optional description of the current transaction meant to provide more context, such as a recurring payment being setup or a surcharge applied. This attribute is only displayed when the ``TransactionType`` is compatible with the ``TransactionAmountDescription`` use case.
type
TypeScriptget type(): PaymentCardTransactionRequest_TransactionTypelet type: PaymentCardTransactionRequest.TransactionTypeThe type of transaction, either a purchase or a refund.
init
TypeScriptstatic init(amount: _Foundation_Decimal, currencyCode: string, type?: PaymentCardTransactionRequest_TransactionType): PaymentCardTransactionRequestinit(amount: Decimal, currencyCode: String, for type: PaymentCardTransactionRequest.TransactionType = .purchase)Creates a new transaction request for the specified amount in the designated currency. - Parameters: - amount: The purchase or refund price in the specified currency. This value must be greater than 0. - currencyCode: The ISO 4217 code that indicates the currency type for the purchase or refund. - type: A value that indicates whether the transaction is a purchase or refund.
amount
TypeScriptget amount(): _Foundation_Decimallet amount: DecimalThe amount of the purchase or refund in the specified currency. The value in this property must be greater than 0.
Skipped declarations
No declarations were skipped in this snapshot.