Technologies›Commerce, Payments & Ads

ProximityReader

iOSmacOStvOSwatchOSvisionOS

ProximityReader brings Tap to Pay on iPhone and mobile-document reading to iOS apps, letting you accept contactless payments and verify IDs using the device's built-in NFC reader. To take payments, configure a PaymentCardReader and PaymentCardReaderSession, then process a PaymentCardTransactionRequest or PaymentCardVerificationRequest and inspect the resulting PaymentCardReadResult, with StoreAndForwardPaymentCardReaderSession supporting offline batches. To read identity credentials, use a MobileDocumentReader and MobileDocumentReaderSession with requests such as MobileDriversLicenseDataRequest, MobileNationalIDCardDataRequest, and MobilePhotoIDDataRequest, and discover available readers through ProximityReaderDiscovery.

Accepting Payments 7

Configure the contactless card reader and run transaction and verification requests through a payment session.

  • Cl
    PaymentCardReader
    An object you use to configure Tap to Pay on iPhone on the current device.
  • Cl
    PaymentCardReaderSession
    The object you use to start reading a contactless payment or loyalty card.
  • St
    PaymentCardReaderStore
    A structure that manages the store that contains all the Store and Forward reads.
  • St
    PaymentCardTransactionRequest
    A request for a contactless purchase or refund that includes the purchase amount and currency information.
  • St
    PaymentCardVerificationRequest
    A request to verify details for a contactless payment card.
  • St
    PaymentCardReadResult
    The result of a payment card read operation.
  • En
    PaymentCardReaderError
    An error type that indicates problems with the configuration of the reader.

Offline Store and Forward 4

Take payments while offline and forward queued transaction batches once connectivity returns.

  • Cl
    StoreAndForwardPaymentCardReaderSession
    The object you use to start reading a contactless payment or loyalty card in Store and Forward mode.
  • St
    StoreAndForwardBatch
    A structure that stores the data to send to the payment service provider to process.
  • St
    StoreAndForwardBatchDeletionToken
    A secure token that you use to delete a Store and Forward batch.
  • St
    StoreAndForwardStatus
    A structure that describes the Store and Forward session status.

Value-Added Services 4

Present loyalty and value-added service passes during a payment interaction.

  • Cl
    VASRequest
    A request to read a contactless loyalty card and retrieve loyalty program
  • St
    VASReadResult
    The result of a request to read loyalty card information.
  • Cl
    CustomerEngagementSession
    An object that manages an interaction presenting value-added services to a customer during a payment.
  • En
    CustomerEngagement
    Constants that specify the kinds of customer engagement presented during a payment.

Reading Mobile Documents 4

Discover and drive a mobile-document reader session to verify identity credentials.

  • Cl
    MobileDocumentReader
    An object for configuring mobile document reading on the current device.
  • Cl
    MobileDocumentReaderSession
    The object you use to start reading a mobile document.
  • Cl
    ProximityReaderDiscovery
    An object that presents a UI with information about how to use
  • En
    MobileDocumentReaderError
    An error type that indicates problems when preparing a mobile document reader session and performing document requests.

Document Requests and Responses 8

Base protocols and combinators describing what identity data a session reads and returns.

  • Pr
    MobileDocumentRequest
    A type that represents a mobile document request.
  • Pr
    MobileDocumentDataRequest
    A type that represents a mobile document data request.
  • Pr
    MobileDocumentRawDataRequest
    A type that represents a mobile document raw data request.
  • Pr
    MobileDocumentDataResponse
    A type that represents a mobile document data response.
  • St
    MobileDocumentAnyOfDataRequest
    A type that describes a data request for any mobile document from a group of requests.
  • St
    MobileDocumentAnyOfRawDataRequest
    A type that describes a raw data request for any mobile document from a group of requests.
  • St
    MobileDocumentDisplayRequest
    A mobile document request that retrieves elements from the holder
  • St
    MobileDocumentHolderName
    A type that represents the mobile identity document holder's name.

Driver's License Credentials 3

Request elements, raw data, and on-screen presentation for a mobile driver's license.

  • St
    MobileDriversLicenseDataRequest
    A mobile driver's license request that retrieves elements from the holder and returns the validated document elements.
  • St
    MobileDriversLicenseRawDataRequest
    A mobile driver's license request which retrieves elements from the holder and returns the raw response data for processing.
  • St
    MobileDriversLicenseDisplayRequest
    A mobile driver's license request that retrieves elements from the holder

National ID and Photo ID Credentials 5

Request data and presentation for national identity cards and other photo identification documents.

  • St
    MobileNationalIDCardDataRequest
    A mobile national ID card request that retrieves elements from the holder and returns the validated document elements.
  • St
    MobileNationalIDCardRawDataRequest
    A mobile national ID card request which retrieves elements from the holder and returns the raw response data for processing.
  • St
    MobileNationalIDCardDisplayRequest
    A mobile national ID card request that retrieves elements from the holder
  • St
    MobilePhotoIDDataRequest
    A photo ID request that retrieves elements from the holder and returns the validated document elements.
  • St
    MobilePhotoIDRawDataRequest
    A photo ID request which retrieves elements from the holder and returns the raw response data for processing.
← Commerce, Payments & Ads