One Logo Pool Ball
ProximityReader · IOS API REFERENCE

StoreAndForwardPaymentCardReaderSession

class · iOS 18.4+ · SDK 27.1

class StoreAndForwardPaymentCardReaderSession

The object you use to start reading a contactless payment or loyalty card in Store and Forward mode. Use a `StoreAndForwardPaymentCardReaderSession` object to read payment and loyalty cards from a properly configured device. You don't create this object directly. Instead, you obtain one by calling the ``PaymentCardReader/prepareStoreAndForward()`` method of your ``PaymentCardReader`` object, which returns a session after the successful configuration of the device. Maintain a strong reference to a session object for the duration of the card-reading process. You may use the same session object to perform multiple read operations, but you may perform only one read operation at a time

Members (2)

method · iOS 18.4+

status

TypeScript
status(): Promise<StoreAndForwardStatus>
Swift declaration
func status() async throws -> StoreAndForwardStatus

Allows the merchant to check the status of the Store and Forward session. - Returns: ``StoreAndForwardStatus`` when successful. - Throws: This method throws a ``ReadError`` if status cannot be retrieved.

method · iOS 18.4+

decline

TypeScript
decline(): Promise<void>
Swift declaration
func decline() async throws

Removes the last read from store. This method should be used after a read, when the merchant receives the ``PaymentCardReadResult`` and decides to not accept the payment. It must be called within the 60 seconds allowance time window and the payment must not have been included in a batch, otherwise an error will be thrown. - Throws: This method throws a ``ReadError`` if no previous read was executed, if invoked after the 60 seconds allowance time window or if the payment you are trying to decline belongs to a batch.

Skipped declarations

No declarations were skipped in this snapshot.

All ProximityReader types →