On This Page
REST API

Creating a
UiConfiguration
 Instance

The
UiConfiguration
 instance is required in order to configure the UI functionality of the Tap to Pay on Android SDK.
You can configure these parameters in the
UiConfiguration
 instance that you create:
  • Configure the accessory as Tap to Phone.
  • Configure these Summary screen features:
    • Refund a transaction (
      REFUND_TRANSACTION
      ).
    • Send a receipt by email (
      SEND_RECEIPT_VIA_EMAIL
      ).
    • Capture a transaction (
      CAPTURE_TRANSACTION
      ).
    • Re-try a failed transaction (
      RETRY_TRANSACTION
      ).
    • View all pre-authorizations after an incremental authorization (
      SHOW_TOTAL_PREAUTHORIZED
      ).
  • Configure the feature that appears as the primary button on the Summary screen.
  • Configure the Summary screen so that it can be skipped (
    SKIP_SUMMARY_SCREEN
    ) or so that it closes after 5 seconds (
    CLOSE_AFTER_TIMEOUT
    ). The default setting is to display the Summary screen.
  • Configure the signature capture so that it prints on the paper receipt (
    ON_RECEIPT
    ) or is skipped (
    NONE
    ). The default setting is on-screen signature capture.
Follow this step to create and configure the
UiConfiguration
 instance in your app:
  1. Create the
    UiConfiguration
     instance.
    mposUi.configuration = UiConfiguration(
  terminalParameters = AccessoryParameters.Builder(AccessoryFamily.TAP_TO_PHONE).integrated().build(),
  summaryFeatures = setOf(
            SummaryFeature.REFUND_TRANSACTION,
            SummaryFeature.SEND_RECEIPT_VIA_EMAIL,
            SummaryFeature.CAPTURE_TRANSACTION,
            SummaryFeature.RETRY_TRANSACTION,
            SummaryFeature.SHOW_TOTAL_PREAUTHORIZED
      ),
  defaultSummaryFeature = SummaryFeature.SEND_RECEIPT_VIA_EMAIL
// Use this to skip the summary screen
// resultDisplayBehavior = UiConfiguration.ResultDisplayBehavior.SKIP_SUMMARY_SCREEN,
// Use this to set signature capture to be on paper receipt
// signatureCapture = SignatureCapture.ON_RECEIPT,
)