On This Page
REST API

Creating a
UiConfiguration
 Instance

Follow these steps to create the
UiConfiguration
 instance in your app.
In the
UiConfiguration
 instance you create, you can do these tasks:
  • 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 (action) that appears as the primary button on the Summary screen.
  • Configure the Summary screen to be skipped. The default setting is to display the Summary screen.
  • Configure the signature capture to print on the paper receipt. The default setting is on-screen signature capture.
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,
)