Class Intents
- java.lang.Object
-
- com.clover.sdk.v1.Intents
-
public class Intents extends Object
This class contains most of the Clover-specific intents available to developer apps. These intents allow apps to listen for events and start Clover activities. See Android documentation for information about how to use Intents:-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Intents.PAYMENT_TOKEN_TYPE
static class
Intents.RemoteViewSize
Values passed withEXTRA_REMOTE_VIEW_SIZE
-
Field Summary
Fields Modifier and Type Field Description static String
ACTION_ACTIVE_REGISTER_ORDER
Broadcast from Clover, indicating the active order in Registerstatic String
ACTION_ADD_TIP
Launch activity to add tip to requested paymentstatic String
ACTION_APP_INSTALL_DONE
A broadcast and service intent action sent to your app when it is initially installed or updated.static String
ACTION_APP_PRE_UNINSTALL
An intent service intent that indicates the target app will be uninstalled in the next 5 seconds.static String
ACTION_AUTHENTICATE_EMPLOYEE
Launch a dialog-style activity to authenticate an employee.static String
ACTION_BILL_SPLIT
Deprecated.static String
ACTION_CLOSEOUT
Launch activity to view batch details for open batchstatic String
ACTION_CLOSEOUT_BATCH
Launch activity to closeout sales and refunds batchstatic String
ACTION_CLOSEOUT_BATCH_SCHEDULED
Broadcast from Clover, indicating a closeout has been scheduledstatic String
ACTION_CLOVER_PAY
Launch Pay activity with the provided order.static String
ACTION_CUSTOMER_ADD_TIP
Launch activity to have a customer add a tip to a payment.static String
ACTION_CUSTOMER_TENDER
Intent passed to start your app's customer-facing extensible tender activity (See Example Usage)static String
ACTION_GIFT_CARD_TX
Deprecated.static String
ACTION_ITEM_SELECT
Launch Register Select Item activity, allowing an employee to add or remove items from an orderstatic String
ACTION_KEYPAD
An activity action that will start an activity that accepts keypad input from the user.static String
ACTION_LINE_ITEM_ADDED
Broadcast from Clover, indicating a lineItem has been added to an orderstatic String
ACTION_LINE_ITEM_DELETED
Broadcast from Clover, line item has been deletedstatic String
ACTION_MANUAL_PAY
Deprecated.Please useACTION_CLOVER_PAY
insteadstatic String
ACTION_MANUAL_REFUND
Deprecated.Please useACTION_CLOVER_PAY
insteadstatic String
ACTION_MERCHANT_TENDER
Intent passed to start your app's merchant-facing extensible tender activity (See Example Usage)static String
ACTION_MODIFY_AMOUNT
The Clover Sale app searches for activities with this action registered in the manifest and for each such activity a button is added which when tapped launches the associated activity.static String
ACTION_MODIFY_ORDER
The Clover Payments app searches for activities with this action registered in the manifest and for each such activity a button is added to the Payments app which when tapped launches the associated activity.static String
ACTION_ORDER_CREATED
Broadcast from Clover, indicating an order was createdstatic String
ACTION_ORDER_SAVED
Broadcast from Clover, indicating an Order has been saved for later processingstatic String
ACTION_PAY
Deprecated.Replaced byACTION_MERCHANT_TENDER
andACTION_CUSTOMER_TENDER
static String
ACTION_PAYMENT_PROCESSED
Broadcast from Clover, indicating a payment has been successfully processedstatic String
ACTION_REFUND
Intent passed to start your app's extensible tender refund activitystatic String
ACTION_REQUEST_PAYMENT_REMOTE_VIEWS
Broadcast sent by Payment screen to request a RemoteViews object from apps to be displayed before an order is complete, Received by your app's broadcast receiverstatic String
ACTION_REQUEST_ROLE
Deprecated.static String
ACTION_SCAN
Deprecated.This does not work on recent devices.static String
ACTION_SECURE_BALANCE_CHECK
Launch activity to check credit/debit card balance.static String
ACTION_SECURE_CARD_DATA
Launch activity to securely capture card data.static String
ACTION_SECURE_PAY
Launch the secure payment activity.static String
ACTION_START_APP_DETAIL
Launch App Market's App Detail activitystatic String
ACTION_START_CUSTOMER_PROFILE
Launch the Customer Profile activitystatic String
ACTION_START_HEADLESS_CLOSEOUT
static String
ACTION_START_ORDER_MANAGE
Launch Order Manage activitystatic String
ACTION_START_PIN_ACTIVITY
Launches PIN Activity in secure-paymentsstatic String
ACTION_START_PRINT_RECEIPTS
Launch the Print Receipts activity, to show receipt printing and sending options for an orderstatic String
ACTION_START_REGISTER
Launch Register Point of Sale activitystatic String
ACTION_START_SELECT_ACCOUNT_ACTIVITY
Launches SelectAccountActivity in secure-paymentsstatic String
ACTION_START_TRANSACTION_DETAIL
Launch Transactions detail activitystatic String
ACTION_STATION_PAY
Launches station pay activity (Only used on Station)static String
ACTION_STATION_SECURE_PAY
Launches station secure pay activity (Only used on Station 2018)static String
ACTION_STORE_CREDIT
Deprecated.static String
ACTION_UPDATE_PAYMENT_REMOTE_VIEWS
Payment screen listens for this broadcast as a response toACTION_REQUEST_PAYMENT_REMOTE_VIEWS
to receive views to be displayed on the tender screenstatic String
ACTION_V1_ACTIVE_PAY_ORDER
Broadcast from Clover, indicating the active order in the Register Pay activitystatic String
ACTION_V1_CUSTOMER_IDENTIFIED
Broadcast indicating that a customer has been identified as a 'current' customer of interest.static String
ACTION_V1_ORDER_BUILD_START
Broadcast from Clover, indicating that we are starting to build an orderstatic String
ACTION_V1_ORDER_BUILD_STOP
Broadcast from Clover, indicating that we have stopped building an orderstatic String
ACTION_V1_PAY_BUILD_HIDE
Broadcast from Clover, indicating that PayActivity was hiddenstatic String
ACTION_V1_PAY_BUILD_SHOW
Broadcast from Clover, indicating that we are showing PayActivitystatic String
ACTION_V1_PAY_BUILD_START
Broadcast from Clover, indicating that we are starting to build a paymentstatic String
ACTION_V1_PAY_BUILD_STOP
Broadcast from Clover, indicating that we have stopped building a paymentstatic String
ACTION_V1_PAY_EXECUTE_START
Broadcast from Clover, indicating that we have started executing a paymentstatic String
ACTION_V1_PAY_EXECUTE_STOP
Broadcast from Clover, indicating that we have stopped executing a paymentstatic String
CARD_DATA_READ_MODE_ENHANCED_CVV
static int
CARD_ENTRY_METHOD_ALL
A bit value forEXTRA_CARD_ENTRY_METHODS
, all card entry methods.static int
CARD_ENTRY_METHOD_ICC_CONTACT
A bit value forEXTRA_CARD_ENTRY_METHODS
, can be bitwise-ored with other CARD_ENTRY_METHOD valuesstatic int
CARD_ENTRY_METHOD_MAG_STRIPE
A bit value forEXTRA_CARD_ENTRY_METHODS
, can be bitwise-ored with other CARD_ENTRY_METHOD valuesstatic int
CARD_ENTRY_METHOD_MANUAL
A bit value forEXTRA_CARD_ENTRY_METHODS
, can be bitwise-ored with other CARD_ENTRY_METHOD valuesstatic int
CARD_ENTRY_METHOD_NFC_CONTACTLESS
A bit value forEXTRA_CARD_ENTRY_METHODS
, can be bitwise-ored with other CARD_ENTRY_METHOD valuesstatic int
CARD_ENTRY_METHOD_SCAN
A bit value forEXTRA_CARD_ENTRY_METHODS
, this value should be used exclusively to scan QR code or barcodestatic int
CARD_ENTRY_METHOD_VAULTED_CARD
A bit value forEXTRA_CARD_ENTRY_METHODS
, this value should be used exclusively if Vaulted Card payment is intended for headless modestatic String
CASHADVANCE_CUSTOMER_IDENTIFICATION
CashAdvanceCustomerIdentification
object used for CashAdvance paymentsstatic String
DATA_ENTRY_LOCATION_NONE
A value forEXTRA_SIGNATURE_ENTRY_LOCATION
static String
DATA_ENTRY_LOCATION_ON_PAPER
A value forEXTRA_SIGNATURE_ENTRY_LOCATION
static String
DATA_ENTRY_LOCATION_ON_SCREEN
A value forEXTRA_SIGNATURE_ENTRY_LOCATION
static String
EXTRA_ACCOUNT
Account
, the Clover account associated with the action or broadcaststatic String
EXTRA_ACCOUNT_ROLES
AnArrayList
ofAccountRole
.static String
EXTRA_ALLOW_FIRE
Boolean
, whether order should respect merchant's setting for firing after paymentstatic String
EXTRA_ALLOW_MANUAL_CARD_ENTRY_ON_MFD
Intent Extra to Allow Manual Card Entry on MFD.static String
EXTRA_ALLOW_OFFLINE_ACCEPTANCE
Boolean
, allow payments to be accepted offlinestatic String
EXTRA_ALLOW_OFFLINE_PAYMENT
Boolean
allow offline payments even if the merchant isn't configured to accept themstatic String
EXTRA_ALLOW_PARTIAL_AUTH
int
, is partial authorization allowed (if it occurs)?static String
EXTRA_ALWAYS_SHOW_RETURN_TO_MERCHANT
Used to indicate if the "return to merchant" screen can/should be skipped.static String
EXTRA_AMOUNT
Long
, a monetary amountstatic String
EXTRA_API_SIGNATURE_PREFER_ON_SCREEN
static String
EXTRA_API_TIP_PREFER_ON_SCREEN
static String
EXTRA_APP
Deprecated.static String
EXTRA_APP_ID
String
, App UUIDstatic String
EXTRA_APP_PACKAGE_NAME
String
, App package namestatic String
EXTRA_APP_TRACKING_ID
int
, does this intent need remote payment confirmation i.e.static String
EXTRA_APPLICATION_SPECIFIC_VALUES
Map
set of key/value pairs used for application specific implementationsstatic String
EXTRA_APPLY_TAXES_AND_FEES
Boolean
whether or not to apply taxes to a transaction (held in the Terminal apps' settings)static String
EXTRA_APPROVE_OFFLINE_PAYMENT_WITHOUT_PROMPT
Boolean
don't prompt for confirmation of an offline paymentstatic String
EXTRA_ASK_FOR_TIP
Boolean
, whether to prompt customers for tipstatic String
EXTRA_AUTHORIZATION
Authorization
, v3 Authorization objectstatic String
EXTRA_AUTHORIZATION_INCREMENT
Boolean
, whether an authorization is being incremented or decrementedstatic String
EXTRA_AUTO_ACCEPT_DUPLICATES
automatically accept the customer signaturestatic String
EXTRA_AUTO_ACCEPT_PAYMENT_CONFIRMATIONS
Boolean
automatically accept payment confirmationsstatic String
EXTRA_AUTO_ACCEPT_SIGNATURE
Boolean
automatically accept payment confirmationsstatic String
EXTRA_AVAILABLE
Deprecated.static String
EXTRA_AVS_POSTAL_CODE
String
, postal code for use with AVSstatic String
EXTRA_AVS_STREET_ADDRESS
String
, street address for use with AVSstatic String
EXTRA_C_TOKEN_REQUEST
Request an C-Token part of Transaction Type link #TRANSACTION_TYPE_PAYMENT} orTRANSACTION_TYPE_AUTH
orTRANSACTION_TYPE_TOKENIZE_CARD
.static String
EXTRA_C_TOKEN_RESULT
Result of C-Token requested part of Transaction Type link #TRANSACTION_TYPE_PAYMENT} orTRANSACTION_TYPE_AUTH
TRANSACTION_TYPE_TOKENIZE_CARD
seeTokenizeCardResponse
static String
EXTRA_CAPTURE
Boolean
If set to true (auth) the payment will be automatically/immediately captured and may be adjustable until closeout runs at which time it will be settled/closed.static String
EXTRA_CARD
static String
EXTRA_CARD_DATA
PaymentRequestCardDetails
, payment card datastatic String
EXTRA_CARD_DATA_MESSAGE
String
, the message to prompt the userstatic String
EXTRA_CARD_ENTRY_METHODS
int
, representation of bit flags for Intents.CARD_ENTRY_METHOD_* values , when not included in the intent all methods will be allowedstatic String
EXTRA_CARD_NOT_PRESENT
Boolean
, card not present, used during manual card entrystatic String
EXTRA_CARD_NUMBER
String
, a card numberstatic String
EXTRA_CASHBACK_AMOUNT
Long
, the pre-selected cash back amountstatic String
EXTRA_CASHBACK_SUGGESTIONS
static String
EXTRA_CHANGE_DUE
static String
EXTRA_CLIENT_ID
String
, the ID of a Client or external paymentstatic String
EXTRA_CLOSEOUT_ALLOW_OPEN_TABS
boolean
, true indicates that a closeout can proceed if open tabs are foundstatic String
EXTRA_CLOSEOUT_BATCH
Batch
, v3 Batch objectstatic String
EXTRA_CLOSEOUT_BATCHID
String
, the UUID of a Batch objectstatic String
EXTRA_CLOSEOUT_RESULT
static String
EXTRA_CLOVER_ITEM_ID
String
, the UUID of an Item objectstatic String
EXTRA_CLOVER_ITEM_IDS
static String
EXTRA_CLOVER_LINE_ITEM_ID
String
, the UUID of a LineItem objectstatic String
EXTRA_CLOVER_ORDER_ID
String
, the UUID of an Order objectstatic String
EXTRA_CLOVER_PAYMENT_ID
String
, the UUID of a Payment objectstatic String
EXTRA_CLOVER_SHOULD_HANDLE_RECEIPTS
static String
EXTRA_CLOVER_SHOULD_HANDLE_TIPS
static String
EXTRA_CLOVER_TENDER_LABEL_KEY
String
, the labelKey of a Tender typestatic String
EXTRA_CREATE_AUTH
Intent to track create an authstatic String
EXTRA_CREDIT
Credit
, v3 Credit object (Manual Refund)static String
EXTRA_CREDIT_ID
String
, the UUID of a Credit objectstatic String
EXTRA_CREDIT_REFUND
CreditRefund
, v3 CreditRefund object (Reversal of Manual Refund)static String
EXTRA_CURRENCY
Currency
, the currency of a transactionstatic String
EXTRA_CURRENT_SHIFT
Shift
, the current employee shiftstatic String
EXTRA_CUSTOMER_ID
String
, UUID of a customerstatic String
EXTRA_CUSTOMER_TENDER
Tender
, Pre-selected customer tenderstatic String
EXTRA_CUSTOMER_V3
Customer
, a customer objectstatic String
EXTRA_CUSTOMERINFO
CustomerInfo
, a customer objectstatic String
EXTRA_DATA_READ_MODE
A value forEXTRA_DATA_READ_MODE
data read mode for specific integration use cases.static String
EXTRA_DECLINE_REASON
String
, an error descriptionstatic String
EXTRA_DIALOG
Deprecated.static String
EXTRA_DISABLE_CASHBACK
Boolean
, true will disable cashback option during secure paymentstatic String
EXTRA_DISABLE_CLOVER_PRINTING
static String
EXTRA_DISABLE_CREDIT_SURCHARGE
Intent Extra to toggle credit surcharge.static String
EXTRA_DISABLE_RECEIPT_OPTIONS
Boolean
, is the receipt options screen disabled for this transactionstatic String
EXTRA_DISABLE_RESTART_TRANSACTION_WHEN_FAILED
Boolean
, if true, the secure payment activity will end after a failed transactionstatic String
EXTRA_DISABLED_TENDER_IDS
static String
EXTRA_DUPLICATE_PAYMENT_CONFIRMATION
int
, does this payment need remote duplicate payment confirmationstatic String
EXTRA_EBT_MANUAL_CARD_ENTRY_SCREEN_FLOW
Intent to define EBT manual card entry screen flow.static String
EXTRA_ECR_MODE
Boolean
flag Indicates if device supports ECR mode or notstatic String
EXTRA_ELV_APPLICATION_LABEL
A value forEXTRA_ELV_APPLICATION_LABEL
static String
EXTRA_EMPLOYEE_ID
String
, the UUID of an Employee objectstatic String
EXTRA_EMPLOYEE_NAME
String
, the Name of employee in Employee objectstatic String
EXTRA_ENABLE_KIOSK_MODE
Boolean
, is the device interaction for this transaction in kioskMode (i.e.static String
EXTRA_ENABLED_RECEIPT_OPTIONS
static String
EXTRA_ENTERED_RECEIPT_VALUE
static String
EXTRA_EXIT_IN_CUSTOMER_MODE
Used (by BillSplit) to have the ensuing activity be in customer mode.static String
EXTRA_EXTERNAL_PAYMENT_ID
String
, external payment id, used for integration with other POS platformsstatic String
EXTRA_EXTERNAL_REFERENCE_ID
String
, external reference idstatic String
EXTRA_EXTERNAL_TOKEN_ID
String
, external token idstatic String
EXTRA_FAILURE_MESSAGE
String
, message shown upon failurestatic String
EXTRA_FORCE_OFFLINE
Boolean
, force payments to be accepted offlinestatic String
EXTRA_FORCE_SWIPE_PIN_ENTRY
Boolean
, if only payment option will be swipe debitstatic String
EXTRA_GERMAN_ELV
String
, elv transaction type for Germanystatic String
EXTRA_GIFT_CARD_RESPONSE
static String
EXTRA_IGNORE_PAYMENT
static String
EXTRA_IMMERSIVE_MODE
Boolean
If set to true, it will hide navigation and status barstatic String
EXTRA_INVOICE_ID_AVAILABLE
Boolean
Flag to check if invoice feature is available for merchantstatic String
EXTRA_INVOICE_ID_REGEX
String
A regular expression to check the validity of invoice numberstatic String
EXTRA_INVOICE_LABEL
String
, Invoice Label of the devicestatic String
EXTRA_INVOICE_NUMBER
String
, the invoice numberstatic String
EXTRA_IS_ADMIN_OR_MANAGER
Boolean
, whether the launched activity should validate if the pin is either admin or managerstatic String
EXTRA_IS_TESTING
Deprecated.static String
EXTRA_KEYPAD_COMPLETIONS
static String
EXTRA_KEYPAD_TEXT
AString
, the initial text to populate into the edit area.static String
EXTRA_KEYPAD_TYPE
An integer, the desired keypad type as an integer.static String
EXTRA_LEAVE_PREAUTHS_OPEN
static String
EXTRA_LED_ON
Boolean
, whether LED will be on during barcode scanning if this device has a barcode LED, generally this option is best left out and the preferred device default with be used.static String
EXTRA_LINE_ITEM_IDS
static String
EXTRA_LINE_ITEM_PAYMENTS
ArrayList
ofLineItemPayment
objectsstatic String
EXTRA_MANUAL_CARD_CVV
Intent Extra to Manual Card CVV Data.static String
EXTRA_MANUAL_CARD_ENTRY_BYPASS_MODE
Intent Extra to Bypass Manual Card Entry Data.static String
EXTRA_MANUAL_CARD_EXPIRY
Intent Extra to Manual Card Expiry Data.static String
EXTRA_MANUAL_CARD_PAN
Intent Extra to Manual Card PAN Data.static String
EXTRA_MD5_HASH
static String
EXTRA_MERCHANT_ID
String
, the UUID of a merchantstatic String
EXTRA_MID
String
, MID of a merchantstatic String
EXTRA_NETWORK_FAILURE
String
, indicator of a network failurestatic String
EXTRA_NO_TIP
static String
EXTRA_NOTE
String
, note contentstatic String
EXTRA_OBEY_AUTO_LOGOUT
Boolean
, whether transaction will respect merchant's auto logout settingsstatic String
EXTRA_OFFLINE_NO_PROMPT
Boolean
, allow offline payments to be accepted without an approval promptstatic String
EXTRA_OFFLINE_PAYMENT_CONFIRMATION
int
, does this payment need remote offline payment confirmationstatic String
EXTRA_OPTED_INTO_MARKETING
static String
EXTRA_ORDER
Order
, an Order objectstatic String
EXTRA_ORDER_ID
String
, the UUID of an Order objectstatic String
EXTRA_ORIGINATING_CREDIT
Credit
, originating credit (applies to reversal, required for Nexo credit reversal)static String
EXTRA_ORIGINATING_PAYMENT
Payment
, originating payment (applies to refunds, required for Interac refunds)static String
EXTRA_ORIGINATING_PAYMENT_PACKAGE
Intent to track package of the Payment.static String
EXTRA_ORIGINATING_TRANSACTION
CardTransaction
, originating transactionstatic String
EXTRA_PACKAGE
String
, package namestatic String
EXTRA_PASS_THROUGH_VALUES
Map
set of key/value pairs that are passed through to the serverstatic String
EXTRA_PAYMENT
Payment
, v3 Payment objectstatic String
EXTRA_PAYMENT_ID
String
, the UUID of a Payment objectstatic String
EXTRA_PAYMENT_IDS
static String
EXTRA_PAYMENT_TYPE
Intent to track payment sub typesstatic String
EXTRA_PAYMENTS
static String
EXTRA_PERMISSIONS
String
, the string constant of a permissionstatic String
EXTRA_PRESENT_QRC_ONLY
Boolean
, a private extra indicating the user selected Scan QR Code for this Payment.static String
EXTRA_PRINT_RECEIPT_ONLY
Boolean
, print receipt extrasstatic String
EXTRA_QUICK_PAYMENT_TRANSACTION_ID
String
, the UUID of the quick pay transaction if collectedstatic String
EXTRA_REASON
String
, written explanationstatic String
EXTRA_RECEIPT_DELIVERY_STATUS
static String
EXTRA_RECEIPT_DELIVERY_TYPE
static String
EXTRA_RECEIPT_FLAG
int
, representation of bit flags fromPrintJob
static String
EXTRA_REFUND
Refund
, v3 Refund objectstatic String
EXTRA_REFUND_ID
static String
EXTRA_REFUND_REASON
String
, merchant provided reason for refund or creditstatic String
EXTRA_REGIONAL_EXTRAS
static String
EXTRA_REMOTE_PRINT
Boolean
, if true printing will be delegated to remote devicestatic String
EXTRA_REMOTE_RECEIPTS
static String
EXTRA_REMOTE_VIEW_SIZE
String
, version of one of the values from the enumIntents.RemoteViewSize
static String
EXTRA_REMOTE_VIEWS
RemoteViews
, RemoteViews sent to Register Payment activitystatic String
EXTRA_REQUEST_ID
String
, a uuid of a requeststatic String
EXTRA_REQUIRES_FINAL_REMOTE_APPROVAL
int
, does this intent need remote payment confirmation i.e.static String
EXTRA_REQUIRES_REMOTE_CONFIRMATION
int
, does this intent need remote payment confirmation i.e.static String
EXTRA_RESULT_SUBSCRIPTION_ID
String
, UUID for result subscription (during an upgrade flow)static String
EXTRA_RETURN_FULL_CARD_DATA
static String
EXTRA_REVERSE_PAYMENT_RESULT
static String
EXTRA_ROLE
AccountRole
, employee role (admin, manager or employee)static String
EXTRA_SCAN_1D_CODE
Boolean
, whether 1D codes will be scannedstatic String
EXTRA_SCAN_QR_CODE
Boolean
, whether QR codes will be scannedstatic String
EXTRA_SCAN_X
static String
EXTRA_SCAN_Y
static String
EXTRA_SCANNER_FACING
On devices where multiple barcode scanners are available, select a barcode scanner to start.static String
EXTRA_SDK_NAME
static String
EXTRA_SDK_VERSION
static String
EXTRA_SELECTED_RECEIPT_OPTION
static String
EXTRA_SEND_DEBUG_LOG_MESSAGE
static String
EXTRA_SEND_RESULT_ON_TRANSACTION_COMPLETE
Boolean
flag Indicates if the secure pay app should send the transaction result when the transaction is complete.static String
EXTRA_SERVICE_CHARGE_AMOUNT
static String
EXTRA_SHOULD_RETRIEVE_OPEN_PAYMENTS
static String
EXTRA_SHOULD_TOKENIZE_CARD
static String
EXTRA_SHOW_CANCEL_BUTTON
Boolean
, whether the launched activity should display a cancel buttonstatic String
EXTRA_SHOW_CLOSE_BUTTON
Boolean
, whether scanner preview video will have a 'close' button.static String
EXTRA_SHOW_CUSTOMER_PREVIEW
Boolean
, whether to show scanner preview video (customer facing mode only)static String
EXTRA_SHOW_LED_BUTTON
Boolean
, whether scanner preview video will have a LED light toggle if this device has a barcode LED, many Clover devices do not have an LED, some devices may not honor this option.static String
EXTRA_SHOW_MERCHANT_PREVIEW
Boolean
, whether to show scanner preview video (merchant facing mode only)static String
EXTRA_SHOW_PREVIEW
Boolean
, whether to show scanner preview video (merchant and customer facing modes) The preview window cannot be hidden on Clover Flex 1 (C401) devices.static String
EXTRA_SHOW_REMAINING
Boolean
, whether to show amount remaining after paymentstatic String
EXTRA_SHOW_SEARCH
static String
EXTRA_SHOW_VOID_BUTTON
Boolean
, whether to show the Void buttonstatic String
EXTRA_SIGNATURE
Signature2
, payment Signature2 signaturestatic String
EXTRA_SIGNATURE_ENTRY_LOCATION
DataEntryLocation
, where signatures are entered (e.g.static String
EXTRA_SIGNATURE_LOCATION
the location for the customer signaturestatic String
EXTRA_SIGNATURE_THRESHOLD
Long
, what is the signature threshold for this transactionstatic String
EXTRA_SIGNATURE_VERIFIED
Boolean
, whether signature is already verifiedstatic String
EXTRA_SKIP_ELV_LIMIT_OVERRIDE
Boolean
, does this intent skip the ELV override screen i.e.static String
EXTRA_SKIP_RECEIPT_SCREEN
Boolean
skip the display of the receipt screenstatic String
EXTRA_SKIP_REPRINT_ROLE_CHECK
Intent to define if manager permission dialog should be skip or notstatic String
EXTRA_START_SCAN
Boolean
, whether to start or stop barcode scannerstatic String
EXTRA_SUPPRESS_CONFIRMATION
static String
EXTRA_TARGET_SUBSCRIPTION_ID
String
, UUID for target subscription (during an upgrade flow)static String
EXTRA_TAX_AMOUNT
Long
, a tax amountstatic String
EXTRA_TAXABLE_AMOUNTS
ArrayList
ofTaxableAmountRate
objects - tax rates, and amounts to which they applystatic String
EXTRA_TAXES_AND_FEES_BREAKDOWN
String
Summary line showing taxes and fees, e.g.static String
EXTRA_TENDER
Tender
, a Tender objectstatic String
EXTRA_TENDER_OPTIONS
static String
EXTRA_THEME_NAME
String
Indicates name of theme to be used in station-pay/secure-paystatic String
EXTRA_THRESHOLD_MANAGER_ID
Intent to track package of the override manager id.static String
EXTRA_THRESHOLD_MANAGER_NAME
Intent to track package of the override manager name.static String
EXTRA_TID
String
, Terminal Id of the devicestatic String
EXTRA_TIMEOUT
Boolean
, flag used to indicate if payment failed due to timeoutstatic String
EXTRA_TIMESTAMP
static String
EXTRA_TIP_AMOUNT
Long
, tip amountstatic String
EXTRA_TIP_AMOUNTS
HashMap
, tip amountsstatic String
EXTRA_TIP_CONFIRM_MODE
Boolean
, whether to display confirmation of tip and total amountstatic String
EXTRA_TIP_MODE
TipMode
, where tips are entered/provided (e.g.static String
EXTRA_TIP_SUGGESTIONS
String
, the json for the tip suggestions associated with a paymentstatic String
EXTRA_TIPPABLE_AMOUNT
Long
, the tippable amount associated with a paymentstatic String
EXTRA_TIPS_ENABLED
Boolean
, are tips enabled for this transactionstatic String
EXTRA_TITLE
String
, On-screen textstatic String
EXTRA_TOKEN
static String
EXTRA_TOKEN_REQUEST
TokenRequest
, token request objectsstatic String
EXTRA_TOKEN_TYPE
static String
EXTRA_TRANSACTION
Transaction
, a Transaction objectstatic String
EXTRA_TRANSACTION_NAME
The transaction name (held in the Terminal apps' settings)static String
EXTRA_TRANSACTION_NO
Deprecated., internally in the SPS/SPAstatic String
EXTRA_TRANSACTION_SETTINGS
static String
EXTRA_TRANSACTION_TYPE
String
, a TRANSACTION_TYPE valuestatic String
EXTRA_TRANSMIT_UPC_A_CHECK_DIGIT
Boolean
, whether UPC-A check digit will be transmittedstatic String
EXTRA_TRANSMIT_UPC_A_PREAMBLE
Boolean
, whether UPC-A preamble will be transmittedstatic String
EXTRA_USE_CONNECTED_DEVICE
static String
EXTRA_USE_LAST_SWIPE
Boolean
flagstatic String
EXTRA_USE_LEGACY_VAULT_CARD
static String
EXTRA_VALIDATE_ROLE
Boolean
, whether the launched activity should validate roles instead of permissions (Required)static String
EXTRA_VAS_PAYLOAD
VasPayload
, v3 VasPayload objectstatic String
EXTRA_VAS_SETTINGS
Vas Settingsstatic String
EXTRA_VAS_URL_TOKENS
VAS URL customization tokensstatic String
EXTRA_VAULTED_CARD
A com.clover.sdk.v3.payments.VaultedCard object that contains a multi-pay token to support paying with card-on-filestatic String
EXTRA_VAULTED_CARD_PAYMENT
static String
EXTRA_VERSION
int
, the version of the servicestatic String
EXTRA_VIEWID
static String
EXTRA_VOICE_AUTH_CODE
String
, the voice auth code for payment by voice authorizationstatic String
EXTRA_VOID_REASON
VoidReason
, v3 VoidReason objectstatic String
EXTRA_VOIDED_PAYMENTS
static String
EXTRA_ZERO_OUT_OPEN_TIPS
static String
GERMAN_ELV
A value forEXTRA_GERMAN_ELV
static String
GERMAN_ELV_OFFLINE
A value forEXTRA_GERMAN_ELV
static String
GERMAN_ELV_ONLINE
A value forEXTRA_GERMAN_ELV
static String
GERMAN_GIROCARD
A value forEXTRA_GERMAN_ELV
static String
GERMAN_INFO
int
, does this intent need german infostatic int
KEYPAD_TYPE_EMAIL
Keypad optimized for email address input.static int
KEYPAD_TYPE_NUMERIC
Keypad optimized for numeric input.static int
KEYPAD_TYPE_PHONESMS
Keypad optimized for phone and SMS number input.static int
KIOSK_MODE_CARD_ENTRY_MASK_ALL
A bit value forEXTRA_CARD_ENTRY_METHODS
, sets kiosk mode mask to ALL entry mode flags permittedstatic int
KIOSK_MODE_CARD_ENTRY_MASK_ICC_CONTACT
A bit value forEXTRA_CARD_ENTRY_METHODS
, can be bitwise-ored with other CARD_ENTRY_METHOD values to provide entry mode mask for device in kiosk modestatic int
KIOSK_MODE_CARD_ENTRY_MASK_MAG_STRIPE
A bit value forEXTRA_CARD_ENTRY_METHODS
, can be bitwise-ored with other CARD_ENTRY_METHOD values to provide entry mode mask for device in kiosk modestatic int
KIOSK_MODE_CARD_ENTRY_MASK_MANUAL
A bit value forEXTRA_CARD_ENTRY_METHODS
, can be bitwise-ored with other CARD_ENTRY_METHOD values to provide entry mode mask for device in kiosk modestatic int
KIOSK_MODE_CARD_ENTRY_MASK_NFC_CONTACTLESS
A bit value forEXTRA_CARD_ENTRY_METHODS
, can be bitwise-ored with other CARD_ENTRY_METHOD values to provide entry mode mask for device in kiosk modestatic int
KIOSK_MODE_CARD_ENTRY_MASK_SUPPLIED
A bit value used to indicate that a kiosk card entry method mode mask is supplied - implicitly set by other mask valuesstatic String
META_CUSTOMER_TENDER_IMAGE
int
, A drawable resource ID, the image to be displayed on the customer-facing tender buttonstatic String
META_MERCHANT_TENDER_IMAGE
int
, A drawable resource ID, the image to be displayed on the merchant-facing tender buttonstatic String
RESULT_KEYPAD_TEXT
AString
, the text entered by the user.static String
SERVICE_VAS_PROVIDER
Services that implement the IVasProvider interfacestatic String
TIP_MODE_NO_TIP
A value forEXTRA_TIP_MODE
static String
TIP_MODE_ON_PAPER
A value forEXTRA_TIP_MODE
static String
TIP_MODE_ON_SCREEN_AFTER_PAYMENT
A value forEXTRA_TIP_MODE
static String
TIP_MODE_ON_SCREEN_BEFORE_PAYMENT
A value forEXTRA_TIP_MODE
static String
TRANSACTION_TYPE_ADJUSTMENT_PAYMENT
A value forEXTRA_TRANSACTION_TYPE
static String
TRANSACTION_TYPE_ADJUSTMENT_REFUND
A value forEXTRA_TRANSACTION_TYPE
static String
TRANSACTION_TYPE_AUTH
A value forEXTRA_TRANSACTION_TYPE
static String
TRANSACTION_TYPE_BALANCE_INQUIRY
A value forEXTRA_TRANSACTION_TYPE
static String
TRANSACTION_TYPE_CAPTURE_PREAUTH
A value forEXTRA_TRANSACTION_TYPE
static String
TRANSACTION_TYPE_CARD_DATA
A value forEXTRA_TRANSACTION_TYPE
static String
TRANSACTION_TYPE_CASH_ADVANCE
A value forEXTRA_TRANSACTION_TYPE
static String
TRANSACTION_TYPE_CREDIT
A value forEXTRA_TRANSACTION_TYPE
static String
TRANSACTION_TYPE_MANUAL_REVERSAL_PAYMENT
A value forEXTRA_TRANSACTION_TYPE
static String
TRANSACTION_TYPE_MANUAL_REVERSAL_REFUND
A value forEXTRA_TRANSACTION_TYPE
static String
TRANSACTION_TYPE_PAYMENT
A value forEXTRA_TRANSACTION_TYPE
static String
TRANSACTION_TYPE_TOKENIZE_CARD
A value forEXTRA_TRANSACTION_TYPE
, a transaction that allows an app to create a token from a card for later use in lieu of the card.static String
TRANSACTION_TYPE_VAS_DATA
A value forEXTRA_TRANSACTION_TYPE
static String
TRANSACTION_TYPE_VERIFY_CARD
A value forEXTRA_TRANSACTION_TYPE
, a transaction that allows an app to verify whether a card is valid.
-
Constructor Summary
Constructors Constructor Description Intents()
-
-
-
Field Detail
-
ACTION_START_REGISTER
public static final String ACTION_START_REGISTER
Launch Register Point of Sale activityExtras passed:
EXTRA_ORDER_ID
- The UUID of the order opened in RegisterEXTRA_CUSTOMER_V3
- a customer object to be associated with the order
Result data includes:
- NONE
- See Also:
- Constant Field Values
-
ACTION_ITEM_SELECT
public static final String ACTION_ITEM_SELECT
Launch Register Select Item activity, allowing an employee to add or remove items from an orderExtras passed:
EXTRA_ORDER_ID
- The UUID of the order to be modified (Required)
Result data includes:
- NONE
- See Also:
- Constant Field Values
-
ACTION_START_PRINT_RECEIPTS
public static final String ACTION_START_PRINT_RECEIPTS
Launch the Print Receipts activity, to show receipt printing and sending options for an orderExtras passed:
EXTRA_ORDER_ID
- The UUID of the target order (Required)
Result data includes:
- NONE
- See Also:
- Constant Field Values
-
ACTION_START_CUSTOMER_PROFILE
public static final String ACTION_START_CUSTOMER_PROFILE
Launch the Customer Profile activityExtras passed:
EXTRA_CUSTOMER_ID
- The UUID of the target customer (Required)
Result data includes:
- NONE
- See Also:
- Constant Field Values
-
ACTION_CLOVER_PAY
public static final String ACTION_CLOVER_PAY
Launch Pay activity with the provided order. This may be used to take a payment or perform a refund. When performing a refund the line items must have negative amounts.See the SaleRefundTestActivity in the clover-android-sdk-example project for a full example.
Extras passed:
EXTRA_CLOVER_ORDER_ID
- The UUID of the order being paid for (REQUIRED)EXTRA_TRANSACTION_TYPE
- may beTRANSACTION_TYPE_CREDIT
for refund, the default isTRANSACTION_TYPE_PAYMENT
EXTRA_OBEY_AUTO_LOGOUT
- If true and merchant uses auto-logout, device logs out after payment, default is falseEXTRA_ASK_FOR_TIP
- If true, customer will be prompted for tip after payment, default is trueEXTRA_ALLOW_FIRE
- If true and merchant fires orders after payment, order is fired after payment, default is true
Result data for this activity will include the same extras passed to it
Result codes:
Activity.RESULT_OK
- payment completed successfullyActivity.RESULT_CANCELED
- payment not completed successfully
- See Also:
- Constant Field Values
-
ACTION_MODIFY_ORDER
public static final String ACTION_MODIFY_ORDER
The Clover Payments app searches for activities with this action registered in the manifest and for each such activity a button is added to the Payments app which when tapped launches the associated activity. The activity may perform some operations on the order and finish itself. Any changes to the order will appear in the Clover Payments app before the payment is taken.See: Example Usage
Extras passed:
EXTRA_ORDER_ID
- the UUID of the order about to paid for
Result data must include:
-
None (Modifications can be made to the Order object directly)
- See Also:
- Constant Field Values
-
ACTION_MODIFY_AMOUNT
public static final String ACTION_MODIFY_AMOUNT
The Clover Sale app searches for activities with this action registered in the manifest and for each such activity a button is added which when tapped launches the associated activity. The activity can inspect the current amount to be paid and transaction type and should return an adjusted amount to be paid by puttingEXTRA_AMOUNT
into a Intent, calling Activity#setResult(int, Intent) and finishing itself. The Clover Sale app will then update the amount to paid.See: Example Usage
Extras passed:
EXTRA_AMOUNT
- the initial amountEXTRA_TRANSACTION_TYPE
- the transaction type
Result data must include:
EXTRA_AMOUNT
- the amount the amount resulting from your activity
- See Also:
- Constant Field Values
-
ACTION_MANUAL_PAY
@Deprecated public static final String ACTION_MANUAL_PAY
Deprecated.Please useACTION_CLOVER_PAY
instead- See Also:
- Constant Field Values
-
ACTION_MANUAL_REFUND
@Deprecated public static final String ACTION_MANUAL_REFUND
Deprecated.Please useACTION_CLOVER_PAY
instead- See Also:
- Constant Field Values
-
ACTION_START_APP_DETAIL
public static final String ACTION_START_APP_DETAIL
Launch App Market's App Detail activityExtras passed (Must include either
EXTRA_APP_PACKAGE_NAME
orEXTRA_APP_ID
):EXTRA_APP_PACKAGE_NAME
- the package name of the app that will be shownEXTRA_APP_ID
- the UUID of the app that will be shownEXTRA_TARGET_SUBSCRIPTION_ID
- the UUID of the subscription tier that will be selected by default
If user changes to a new subscription tier, result data includes:
EXTRA_RESULT_SUBSCRIPTION_ID
- the UUID of the subscription tier installed by user
- See Also:
- Constant Field Values
-
ACTION_START_ORDER_MANAGE
public static final String ACTION_START_ORDER_MANAGE
Launch Order Manage activityExtras passed:
EXTRA_ORDER_ID
- the UUID of the order to be shown (REQUIRED)
Result data includes:
- NONE
- See Also:
- Constant Field Values
-
ACTION_ADD_TIP
public static final String ACTION_ADD_TIP
Launch activity to add tip to requested paymentExtras passed:
EXTRA_PAYMENT_ID
- UUID of payment associated with tipEXTRA_TITLE
- label on the tip activity's back button
Result data includes:
- NONE
- See Also:
- Constant Field Values
-
ACTION_CUSTOMER_ADD_TIP
public static final String ACTION_CUSTOMER_ADD_TIP
Launch activity to have a customer add a tip to a payment. A third party developer firing this intent should invokeCustomerMode#disable
inonActivityResult
to restore the bottom navigation bar and top status bar.Extras passed:
EXTRA_ORDER_ID
- Order UUID, the order associated with the payment and tip (REQUIRED)EXTRA_AMOUNT
- Long, the amount of the payment the tip will be added to (REQUIRED)EXTRA_TIP_CONFIRM_MODE
- Boolean, whether to confirm the tip and total amount (OPTIONAL)
Result data includes:
EXTRA_TIP_AMOUNT
Long, the amount of the added tip
Result codes:
Activity.RESULT_OK
- tip added successfullyActivity.RESULT_CANCELED
- tip not added successfully
- See Also:
- Constant Field Values
-
ACTION_CLOSEOUT
public static final String ACTION_CLOSEOUT
Launch activity to view batch details for open batchExtras passed:
- NONE
Result data includes:
- NONE
- See Also:
- Constant Field Values
-
ACTION_CLOSEOUT_BATCH
public static final String ACTION_CLOSEOUT_BATCH
Launch activity to closeout sales and refunds batchExtras passed:
EXTRA_CLOSEOUT_ALLOW_OPEN_TABS
- a boolean flag indicating if a closeout can proceed if open tabs are found (defaults to false)EXTRA_CLOSEOUT_BATCHID
- the id of the batch to close (Optional - defaults to the current open batch )
Result data includes:
- NONE
- See Also:
- Constant Field Values
-
ACTION_CLOSEOUT_BATCH_SCHEDULED
public static final String ACTION_CLOSEOUT_BATCH_SCHEDULED
Broadcast from Clover, indicating a closeout has been scheduledExtras passed:
EXTRA_CLOSEOUT_BATCH
the scheduled batch, only set when scheduledEXTRA_FAILURE_MESSAGE
a message indicating status when scheduling fails
- See Also:
- Constant Field Values
-
ACTION_START_TRANSACTION_DETAIL
public static final String ACTION_START_TRANSACTION_DETAIL
Launch Transactions detail activityExtras passed (Must include one of the following:
EXTRA_PAYMENT
orEXTRA_CREDIT
orEXTRA_REFUND
):EXTRA_PAYMENT
- the Payment object that will be shownEXTRA_CREDIT
- the Credit (manual refund) object that will be shownEXTRA_REFUND
- the Refund object that will be shown
Result data includes:
- NONE
- See Also:
- Constant Field Values
-
ACTION_REQUEST_PAYMENT_REMOTE_VIEWS
public static final String ACTION_REQUEST_PAYMENT_REMOTE_VIEWS
Broadcast sent by Payment screen to request a RemoteViews object from apps to be displayed before an order is complete, Received by your app's broadcast receiverExtras passed:
EXTRA_VIEWID
- unique id to be used withACTION_UPDATE_PAYMENT_REMOTE_VIEWS
EXTRA_ORDER_ID
- order being processedEXTRA_REMOTE_VIEW_SIZE
- for the size desired
Result data must include:
- NONE (Remote views should be passed back via
ACTION_UPDATE_PAYMENT_REMOTE_VIEWS
-
ACTION_UPDATE_PAYMENT_REMOTE_VIEWS
public static final String ACTION_UPDATE_PAYMENT_REMOTE_VIEWS
Payment screen listens for this broadcast as a response toACTION_REQUEST_PAYMENT_REMOTE_VIEWS
to receive views to be displayed on the tender screenExtras passed:
EXTRA_REMOTE_VIEWS
EXTRA_VIEWID
unique id passed byACTION_REQUEST_PAYMENT_REMOTE_VIEWS
Result data includes:
- NONE
- See Also:
- Constant Field Values
-
ACTION_AUTHENTICATE_EMPLOYEE
public static final String ACTION_AUTHENTICATE_EMPLOYEE
Launch a dialog-style activity to authenticate an employee. All supported modes of authentication that are possible on this device will be enabled, such as: passcode, card swipe, fingerprint. Pick one of the following ways to authentication an employee:- Authenticate an explicit employee by passing
EXTRA_EMPLOYEE_ID
with the employee id - Allow any manager or admin to authenticate by passing
EXTRA_VALIDATE_ROLE
with boolean value true - Authenticate an employee that has the permission specified by
EXTRA_PERMISSIONS
- Authenticate an employee that has one of the provided
AccountRole
s specified inEXTRA_ACCOUNT_ROLES
.
EXTRA_REASON
- written explanation for why authentication is needed (please localize to current locale)EXTRA_SHOW_CANCEL_BUTTON
- if true, show cancel button on the dialog, default falseEXTRA_PACKAGE
- package name associated with permission identified byEXTRA_PERMISSIONS
if validating some other package
Result data includes:
EXTRA_EMPLOYEE_ID
String of the authenticated employee id if successfulEXTRA_EMPLOYEE_NAME
String of the authenticated employee name if successful
Result codes:
Activity.RESULT_OK
- authenticated successfullyActivity.RESULT_CANCELED
- did not authenticate successfully
- See Also:
- Constant Field Values
- Authenticate an explicit employee by passing
-
ACTION_REQUEST_ROLE
public static final String ACTION_REQUEST_ROLE
Deprecated.- See Also:
- Constant Field Values
-
ACTION_SECURE_PAY
public static final String ACTION_SECURE_PAY
Launch the secure payment activity. First check if the device is able to do this usingPlatform2.Feature.SECURE_PAYMENTS
.Extras passed:
EXTRA_AMOUNT
- amount to be paid (Required)EXTRA_ORDER_ID
- order associated with payment, if excluded, a new order record will be createdEXTRA_CARD_ENTRY_METHODS
- (deprecated - replaced byEXTRA_TRANSACTION_SETTINGS
) allowed payment types, default all allowedEXTRA_EMPLOYEE_ID
- employee conducting transactionEXTRA_TIP_AMOUNT
- tip amountEXTRA_TAX_AMOUNT
- tax amountEXTRA_TAXABLE_AMOUNTS
- tax rates, with eligible amountsEXTRA_SERVICE_CHARGE_AMOUNT
- service charge amountEXTRA_DISABLE_CASHBACK
- (deprecated - replaced byEXTRA_TRANSACTION_SETTINGS
) disable option for cashback during payment, default falseEXTRA_IS_TESTING
- whether payment is testing modeEXTRA_VOICE_AUTH_CODE
- voice auth codeEXTRA_AVS_POSTAL_CODE
- postal code associated with paymentEXTRA_CARD_NOT_PRESENT
- whether payment card is not present, default falseEXTRA_REMOTE_PRINT
- if printing will be delegated to remote deviceEXTRA_TRANSACTION_NO
- transaction number for paymentEXTRA_FORCE_SWIPE_PIN_ENTRY
- (deprecated - replaced byEXTRA_TRANSACTION_SETTINGS
) if only payment option will be swipe debit, default falseEXTRA_DISABLE_RESTART_TRANSACTION_WHEN_FAILED
- (deprecated - replaced byEXTRA_TRANSACTION_SETTINGS
) if activity will end after failed transaction, default falseEXTRA_EXTERNAL_PAYMENT_ID
- external payment id, used for integration with other POS platformsEXTRA_CUSTOMER_TENDER
- Pre-selected customer tender. If present, pay with this tender. The customer will not have the option to select a different tender or pay with a card. If the tender is not valid for this merchant this extra is ignored. SeeACTION_CUSTOMER_TENDER
.EXTRA_TRANSACTION_SETTINGS
- pass transaction settings as a single object
Result data includes:
EXTRA_PAYMENT
- created paymentEXTRA_PAYMENT_ID
- created payment's UUIDEXTRA_VAS_PAYLOAD
- any vas payload read during session
Result codes:
Activity.RESULT_OK
- payment successfulActivity.RESULT_CANCELED
- payment not successful (Cancel button)
- See Also:
- Constant Field Values
-
ACTION_STATION_PAY
public static final String ACTION_STATION_PAY
Launches station pay activity (Only used on Station)- See Also:
- Constant Field Values
-
ACTION_STATION_SECURE_PAY
public static final String ACTION_STATION_SECURE_PAY
Launches station secure pay activity (Only used on Station 2018)- See Also:
- Constant Field Values
-
SERVICE_VAS_PROVIDER
public static final String SERVICE_VAS_PROVIDER
Services that implement the IVasProvider interface- See Also:
- Constant Field Values
-
ACTION_SECURE_CARD_DATA
public static final String ACTION_SECURE_CARD_DATA
Launch activity to securely capture card data. First check if the device is able to do this usingPlatform2.Feature.SECURE_PAYMENTS
.Extras passed:
EXTRA_TRANSACTION_TYPE
- must be set toTRANSACTION_TYPE_CARD_DATA
(Required)EXTRA_CARD_DATA_MESSAGE
- written explanation shown on card entry screenEXTRA_CARD_ENTRY_METHODS
- allowed payment types, default all allowed- indicator for card data read mode, only applicable for specific integration use cases
Result data includes:
- {@link #EXTRA_CARD_DATA} - captured card data
Result codes:
- {@link android.app.Activity#RESULT_OK} - card data captured successfully
- {@link android.app.Activity#RESULT_CANCELED} - card data not captured successfully (Cancel button)
- See Also:
- Constant Field Values
-
ACTION_SECURE_BALANCE_CHECK
public static final String ACTION_SECURE_BALANCE_CHECK
Launch activity to check credit/debit card balance. First check if the device is able to do this usingPlatform2.Feature.SECURE_PAYMENTS
.Extras passed:
EXTRA_TRANSACTION_TYPE
- must be set toTRANSACTION_TYPE_BALANCE_INQUIRY
(Required)EXTRA_CARD_ENTRY_METHODS
- allowed payment types, default all allowed
Result data includes:
EXTRA_PAYMENT
- payment object with balance info populated if supported by card/returned by gatewayEXTRA_CARD_DATA
- captured card data
Result codes:
Activity.RESULT_OK
- balance request successfulActivity.RESULT_CANCELED
- balance request not successful
- See Also:
- Constant Field Values
-
ACTION_CUSTOMER_TENDER
public static final String ACTION_CUSTOMER_TENDER
Intent passed to start your app's customer-facing extensible tender activity (See Example Usage)Extras passed:
EXTRA_AMOUNT
- the transaction amountEXTRA_CURRENCY
- the transaction currencyEXTRA_TAX_AMOUNT
- the transaction's tax amountEXTRA_SERVICE_CHARGE_AMOUNT
- the transaction's service charge amountEXTRA_TIP_AMOUNT
- the transaction's tip amountEXTRA_ORDER_ID
- the Clover order IDEXTRA_EMPLOYEE_ID
- the ID of the employee who initiated the paymentEXTRA_TENDER
- the tender for the transaction
Result data must include:
- (Required)
EXTRA_AMOUNT
- the approved transaction amount - (Optional)
EXTRA_TIP_AMOUNT
- the approved transaction's tip amount - (Optional)
EXTRA_CLIENT_ID
- the client ID / external payment ID - (Optional)
EXTRA_NOTE
- the payment note
Result codes:
Activity.RESULT_OK
- payment successfulActivity.RESULT_CANCELED
- payment not successful
-
ACTION_MERCHANT_TENDER
public static final String ACTION_MERCHANT_TENDER
Intent passed to start your app's merchant-facing extensible tender activity (See Example Usage)Extras passed:
EXTRA_AMOUNT
- the transaction amountEXTRA_CURRENCY
- the transaction currencyEXTRA_TAX_AMOUNT
- the transaction's tax amountEXTRA_SERVICE_CHARGE_AMOUNT
- the transaction's service charge amountEXTRA_ORDER_ID
- the Clover order IDEXTRA_EMPLOYEE_ID
- the ID of the employee who initiated the paymentEXTRA_TENDER
- the tender for the transactionEXTRA_ORDER
- the order for the transactionEXTRA_NOTE
- the order note for the transaction
Result data includes:
- (Required)
EXTRA_AMOUNT
- the approved transaction amount - (Optional)
EXTRA_CLIENT_ID
- the client ID / external payment ID - (Optional)
EXTRA_NOTE
- the payment note - (Optional)
EXTRA_TIP_AMOUNT
- the transaction's tip amount
Result codes:
Activity.RESULT_OK
- payment successfulActivity.RESULT_CANCELED
- payment not successful
-
ACTION_REFUND
public static final String ACTION_REFUND
Intent passed to start your app's extensible tender refund activityExtras passed:
EXTRA_MERCHANT_ID
EXTRA_CURRENCY
EXTRA_ORDER_ID
EXTRA_PAYMENT_ID
EXTRA_CLIENT_ID
EXTRA_LINE_ITEM_IDS
EXTRA_AMOUNT
EXTRA_MID
EXTRA_TID
EXTRA_INVOICE_LABEL
Result data includes:
- (Required)
EXTRA_AMOUNT
- (Required)
EXTRA_ORDER_ID
- (Required)
EXTRA_PAYMENT_ID
- (Optional)
EXTRA_LINE_ITEM_IDS
Activity.RESULT_OK
- refund processedActivity.RESULT_CANCELED
- refund canceled
- See Also:
- Constant Field Values
-
ACTION_SCAN
@Deprecated public static final String ACTION_SCAN
Deprecated.This does not work on recent devices. UseBarcodeScanner
instead. Broadcast to start barcode scanner service on Station or Mini (Mobile scanner must be activated via physical trigger) Extras passed:EXTRA_START_SCAN
- true will start scanner, false will close scanner (Required)-
EXTRA_SHOW_PREVIEW
- whether scanner preview video will be shown, default is true. The preview window cannot be hidden on Clover Flex 1 (C401) devices. EXTRA_SHOW_MERCHANT_PREVIEW
- whether scanner preview will be shown in merchant facing mode, default is trueEXTRA_SHOW_CUSTOMER_PREVIEW
- whether scanner preview will be shown in customer facing mode, default is trueEXTRA_LED_ON
- whether LED will be on (selected devices only), default is falseEXTRA_SCAN_QR_CODE
- whether QR codes will be scanned, default is trueEXTRA_SCAN_1D_CODE
- whether 1D codes will be scanned, default is trueEXTRA_SHOW_CLOSE_BUTTON
- whether scanner preview will have a 'close' button, default is trueEXTRA_SHOW_LED_BUTTON
- whether scanner preview will have an LED toggle, default is true
- See Also:
- Constant Field Values
-
ACTION_APP_INSTALL_DONE
public static final String ACTION_APP_INSTALL_DONE
A broadcast and service intent action sent to your app when it is initially installed or updated. When an Android app is first installed it is placed in a stopped state. While in the stopped state an app may not receive implicit broadcasts. An app exits the stopped state when it has had an activity, service, or explicit broadcast started either by user interaction with the app's components or programmatically by another app. This usually means the app won't have any components invoked until the user taps the launcher icon. By implementing a receiver or service for this intent and registering it in the app's manifest it will immediately move out of the stopped state upon installation, on Clover devices. Even if you don't actually need to do any work when your app is installed you may want to implement an empty receiver or service to ensure your app is moved out of the stopped state so it can immediately begin receiving other broadcasts. Ensure that any operation performed in the receiver or service is idempotent. It is guaranteed that your receiver and / or service is invoked at least once, but they may be invoked multiple times for a single install or update of your app. The service version of this intent is deprecated. Versions of Android 26 and greater place restrictions of background execution that prevent non-foreground services from being started. Prefer to receive this intent action as a broadcast, as described below:<receiver android:name=".MyAppInstalledReceiver" android:exported="true"> <intent-filter> <action android:name="com.clover.intent.action.APP_INSTALL_DONE"/> </intent-filter> </receiver>
BroadcastReceiver.onReceive(Context, Intent)
. If you need to perform blocking work as a result on this intent you must offload the work to another component. See https://developer.android.com/guide/background for details. If you are developing an app and installing it via ADB (Android Studio or command line) then you must manually invoke this broadcast receiver with the following command:adb shell am broadcast -a com.clover.intent.action.APP_INSTALL_DONE -n 'your.packagename/.MyAppInstalledReceiver'
This broadcast intent is only received by the app that was installed. You will not receive this intent when other apps are installed or updated.- See Also:
- Constant Field Values
-
ACTION_APP_PRE_UNINSTALL
public static final String ACTION_APP_PRE_UNINSTALL
An intent service intent that indicates the target app will be uninstalled in the next 5 seconds. After 5 seconds any processes associated with the app are killed and the app is uninstalled. The service started by this intent must be an intent service. Apps can use this time to perform any required cleanup actions. For example, remove any inventory items your app created that do not make sense without your app or order types created that are specific to your app. This intent should not trigger anything that is visible to or require any interaction with the user. Preferably all work is completed synchronously within the bounds of theIntentService
'sIntentService.onHandleIntent(Intent)
method. Note that this is a service intent, not a broadcast intent. It must be received by an (intent) service, not a broadcast receiver.<service android:name=".MyCleanupService" android:exported="true"> <intent-filter> <action android:name="com.clover.intent.action._APP_PRE_UNINSTALL"/> </intent-filter> </service>
adb shell am startservice -a com.clover.intent.action.APP_PRE_UNINSTALL -n your.packagename/.MyCleanupService
- See Also:
- Constant Field Values
-
ACTION_PAY
public static final String ACTION_PAY
Deprecated.Replaced byACTION_MERCHANT_TENDER
andACTION_CUSTOMER_TENDER
- See Also:
- Constant Field Values
-
ACTION_BILL_SPLIT
public static final String ACTION_BILL_SPLIT
Deprecated.- See Also:
- Constant Field Values
-
ACTION_GIFT_CARD_TX
public static final String ACTION_GIFT_CARD_TX
Deprecated.- See Also:
- Constant Field Values
-
ACTION_STORE_CREDIT
public static final String ACTION_STORE_CREDIT
Deprecated.- See Also:
- Constant Field Values
-
ACTION_START_PIN_ACTIVITY
public static final String ACTION_START_PIN_ACTIVITY
Launches PIN Activity in secure-payments- See Also:
- Constant Field Values
-
ACTION_START_SELECT_ACCOUNT_ACTIVITY
public static final String ACTION_START_SELECT_ACCOUNT_ACTIVITY
Launches SelectAccountActivity in secure-payments- See Also:
- Constant Field Values
-
EXTRA_TRANSACTION
public static final String EXTRA_TRANSACTION
Transaction
, a Transaction object- See Also:
- Constant Field Values
-
EXTRA_ORDER_ID
public static final String EXTRA_ORDER_ID
String
, the UUID of an Order object- See Also:
- Constant Field Values
-
EXTRA_ORDER
public static final String EXTRA_ORDER
Order
, an Order object- See Also:
- Constant Field Values
-
EXTRA_CLOVER_ORDER_ID
public static final String EXTRA_CLOVER_ORDER_ID
String
, the UUID of an Order object- See Also:
- Constant Field Values
-
EXTRA_CLOSEOUT_ALLOW_OPEN_TABS
public static final String EXTRA_CLOSEOUT_ALLOW_OPEN_TABS
boolean
, true indicates that a closeout can proceed if open tabs are found- See Also:
- Constant Field Values
-
EXTRA_CLOSEOUT_BATCHID
public static final String EXTRA_CLOSEOUT_BATCHID
String
, the UUID of a Batch object- See Also:
- Constant Field Values
-
EXTRA_CLOVER_LINE_ITEM_ID
public static final String EXTRA_CLOVER_LINE_ITEM_ID
String
, the UUID of a LineItem object- See Also:
- Constant Field Values
-
EXTRA_CLOVER_ITEM_ID
public static final String EXTRA_CLOVER_ITEM_ID
String
, the UUID of an Item object- See Also:
- Constant Field Values
-
EXTRA_CLOVER_ITEM_IDS
public static final String EXTRA_CLOVER_ITEM_IDS
- See Also:
- Constant Field Values
-
EXTRA_CLOVER_PAYMENT_ID
public static final String EXTRA_CLOVER_PAYMENT_ID
String
, the UUID of a Payment object- See Also:
- Constant Field Values
-
EXTRA_CLOVER_TENDER_LABEL_KEY
public static final String EXTRA_CLOVER_TENDER_LABEL_KEY
String
, the labelKey of a Tender type- See Also:
- Constant Field Values
-
EXTRA_AMOUNT
public static final String EXTRA_AMOUNT
Long
, a monetary amount- See Also:
- Constant Field Values
-
EXTRA_INVOICE_NUMBER
public static final String EXTRA_INVOICE_NUMBER
String
, the invoice number- See Also:
- Constant Field Values
-
EXTRA_TIPPABLE_AMOUNT
public static final String EXTRA_TIPPABLE_AMOUNT
Long
, the tippable amount associated with a payment- See Also:
- Constant Field Values
-
EXTRA_TIP_SUGGESTIONS
public static final String EXTRA_TIP_SUGGESTIONS
String
, the json for the tip suggestions associated with a payment- See Also:
- Constant Field Values
-
EXTRA_CURRENCY
public static final String EXTRA_CURRENCY
Currency
, the currency of a transaction- See Also:
- Constant Field Values
-
EXTRA_MERCHANT_ID
public static final String EXTRA_MERCHANT_ID
String
, the UUID of a merchant- See Also:
- Constant Field Values
-
EXTRA_MID
public static final String EXTRA_MID
String
, MID of a merchant- See Also:
- Constant Field Values
-
EXTRA_TID
public static final String EXTRA_TID
String
, Terminal Id of the device- See Also:
- Constant Field Values
-
EXTRA_INVOICE_LABEL
public static final String EXTRA_INVOICE_LABEL
String
, Invoice Label of the device- See Also:
- Constant Field Values
-
EXTRA_PAYMENT_ID
public static final String EXTRA_PAYMENT_ID
String
, the UUID of a Payment object- See Also:
- Constant Field Values
-
EXTRA_QUICK_PAYMENT_TRANSACTION_ID
public static final String EXTRA_QUICK_PAYMENT_TRANSACTION_ID
String
, the UUID of the quick pay transaction if collected- See Also:
- Constant Field Values
-
EXTRA_CREDIT_ID
public static final String EXTRA_CREDIT_ID
String
, the UUID of a Credit object- See Also:
- Constant Field Values
-
EXTRA_PAYMENT_IDS
public static final String EXTRA_PAYMENT_IDS
- See Also:
- Constant Field Values
-
EXTRA_NOTE
public static final String EXTRA_NOTE
String
, note content- See Also:
- Constant Field Values
-
EXTRA_LINE_ITEM_IDS
public static final String EXTRA_LINE_ITEM_IDS
- See Also:
- Constant Field Values
-
EXTRA_LINE_ITEM_PAYMENTS
public static final String EXTRA_LINE_ITEM_PAYMENTS
ArrayList
ofLineItemPayment
objects- See Also:
- Constant Field Values
-
EXTRA_DISABLED_TENDER_IDS
public static final String EXTRA_DISABLED_TENDER_IDS
- See Also:
- Constant Field Values
-
EXTRA_ASK_FOR_TIP
public static final String EXTRA_ASK_FOR_TIP
Boolean
, whether to prompt customers for tip- See Also:
- Constant Field Values
-
EXTRA_CUSTOMER_ID
public static final String EXTRA_CUSTOMER_ID
String
, UUID of a customer- See Also:
- Constant Field Values
-
EXTRA_CUSTOMER_V3
public static final String EXTRA_CUSTOMER_V3
Customer
, a customer object- See Also:
- Constant Field Values
-
EXTRA_CUSTOMERINFO
public static final String EXTRA_CUSTOMERINFO
CustomerInfo
, a customer object- See Also:
- Constant Field Values
-
EXTRA_EMPLOYEE_ID
public static final String EXTRA_EMPLOYEE_ID
String
, the UUID of an Employee object- See Also:
- Constant Field Values
-
EXTRA_EMPLOYEE_NAME
public static final String EXTRA_EMPLOYEE_NAME
String
, the Name of employee in Employee object- See Also:
- Constant Field Values
-
EXTRA_ACCOUNT_ROLES
public static final String EXTRA_ACCOUNT_ROLES
AnArrayList
ofAccountRole
.- See Also:
- Constant Field Values
-
EXTRA_CLIENT_ID
public static final String EXTRA_CLIENT_ID
String
, the ID of a Client or external payment- See Also:
- Constant Field Values
-
EXTRA_TIP_AMOUNT
public static final String EXTRA_TIP_AMOUNT
Long
, tip amount- See Also:
- Constant Field Values
-
EXTRA_TIP_AMOUNTS
public static final String EXTRA_TIP_AMOUNTS
HashMap
, tip amounts- See Also:
- Constant Field Values
-
EXTRA_TIP_CONFIRM_MODE
public static final String EXTRA_TIP_CONFIRM_MODE
Boolean
, whether to display confirmation of tip and total amount- See Also:
- Constant Field Values
-
EXTRA_APP
public static final String EXTRA_APP
Deprecated.- See Also:
- Constant Field Values
-
EXTRA_APP_PACKAGE_NAME
public static final String EXTRA_APP_PACKAGE_NAME
String
, App package name- See Also:
- Constant Field Values
-
EXTRA_APP_ID
public static final String EXTRA_APP_ID
String
, App UUID- See Also:
- Constant Field Values
-
EXTRA_TARGET_SUBSCRIPTION_ID
public static final String EXTRA_TARGET_SUBSCRIPTION_ID
String
, UUID for target subscription (during an upgrade flow)- See Also:
- Constant Field Values
-
EXTRA_OBEY_AUTO_LOGOUT
public static final String EXTRA_OBEY_AUTO_LOGOUT
Boolean
, whether transaction will respect merchant's auto logout settings- See Also:
- Constant Field Values
-
EXTRA_RESULT_SUBSCRIPTION_ID
public static final String EXTRA_RESULT_SUBSCRIPTION_ID
String
, UUID for result subscription (during an upgrade flow)- See Also:
- Constant Field Values
-
EXTRA_ACCOUNT
public static final String EXTRA_ACCOUNT
Account
, the Clover account associated with the action or broadcast- See Also:
- Constant Field Values
-
EXTRA_VERSION
public static final String EXTRA_VERSION
int
, the version of the service- See Also:
- Constant Field Values
-
EXTRA_REQUIRES_REMOTE_CONFIRMATION
public static final String EXTRA_REQUIRES_REMOTE_CONFIRMATION
int
, does this intent need remote payment confirmation i.e. RemotePay- See Also:
- Constant Field Values
-
EXTRA_REQUIRES_FINAL_REMOTE_APPROVAL
public static final String EXTRA_REQUIRES_FINAL_REMOTE_APPROVAL
int
, does this intent need remote payment confirmation i.e. RemotePay- See Also:
- Constant Field Values
-
EXTRA_SKIP_ELV_LIMIT_OVERRIDE
public static final String EXTRA_SKIP_ELV_LIMIT_OVERRIDE
Boolean
, does this intent skip the ELV override screen i.e. RemotePay- See Also:
- Constant Field Values
-
EXTRA_APP_TRACKING_ID
public static final String EXTRA_APP_TRACKING_ID
int
, does this intent need remote payment confirmation i.e. RemotePay- See Also:
- Constant Field Values
-
EXTRA_ALLOW_PARTIAL_AUTH
public static final String EXTRA_ALLOW_PARTIAL_AUTH
int
, is partial authorization allowed (if it occurs)?- See Also:
- Constant Field Values
-
GERMAN_INFO
public static final String GERMAN_INFO
int
, does this intent need german info- See Also:
- Constant Field Values
-
CASHADVANCE_CUSTOMER_IDENTIFICATION
public static final String CASHADVANCE_CUSTOMER_IDENTIFICATION
CashAdvanceCustomerIdentification
object used for CashAdvance payments- See Also:
- Constant Field Values
-
EXTRA_OFFLINE_PAYMENT_CONFIRMATION
public static final String EXTRA_OFFLINE_PAYMENT_CONFIRMATION
int
, does this payment need remote offline payment confirmation- See Also:
- Constant Field Values
-
EXTRA_DUPLICATE_PAYMENT_CONFIRMATION
public static final String EXTRA_DUPLICATE_PAYMENT_CONFIRMATION
int
, does this payment need remote duplicate payment confirmation- See Also:
- Constant Field Values
-
EXTRA_REMOTE_VIEWS
public static final String EXTRA_REMOTE_VIEWS
RemoteViews
, RemoteViews sent to Register Payment activity- See Also:
- Constant Field Values
-
EXTRA_VIEWID
public static final String EXTRA_VIEWID
- See Also:
- Constant Field Values
-
EXTRA_REMOTE_VIEW_SIZE
public static final String EXTRA_REMOTE_VIEW_SIZE
String
, version of one of the values from the enumIntents.RemoteViewSize
- See Also:
- Constant Field Values
-
EXTRA_REASON
public static final String EXTRA_REASON
String
, written explanation- See Also:
- Constant Field Values
-
EXTRA_DIALOG
public static final String EXTRA_DIALOG
Deprecated.- See Also:
- Constant Field Values
-
EXTRA_PERMISSIONS
public static final String EXTRA_PERMISSIONS
String
, the string constant of a permission- See Also:
- Constant Field Values
-
EXTRA_PACKAGE
public static final String EXTRA_PACKAGE
String
, package name- See Also:
- Constant Field Values
-
EXTRA_ROLE
public static final String EXTRA_ROLE
AccountRole
, employee role (admin, manager or employee)- See Also:
- Constant Field Values
-
EXTRA_TITLE
public static final String EXTRA_TITLE
String
, On-screen text- See Also:
- Constant Field Values
-
EXTRA_SHOW_CANCEL_BUTTON
public static final String EXTRA_SHOW_CANCEL_BUTTON
Boolean
, whether the launched activity should display a cancel button- See Also:
- Constant Field Values
-
EXTRA_VALIDATE_ROLE
public static final String EXTRA_VALIDATE_ROLE
Boolean
, whether the launched activity should validate roles instead of permissions (Required)- See Also:
- Constant Field Values
-
EXTRA_IS_ADMIN_OR_MANAGER
public static final String EXTRA_IS_ADMIN_OR_MANAGER
Boolean
, whether the launched activity should validate if the pin is either admin or manager- See Also:
- Constant Field Values
-
EXTRA_START_SCAN
public static final String EXTRA_START_SCAN
Boolean
, whether to start or stop barcode scanner- See Also:
- Constant Field Values
-
EXTRA_SHOW_PREVIEW
public static final String EXTRA_SHOW_PREVIEW
Boolean
, whether to show scanner preview video (merchant and customer facing modes) The preview window cannot be hidden on Clover Flex 1 (C401) devices.- See Also:
- Constant Field Values
-
EXTRA_SHOW_MERCHANT_PREVIEW
public static final String EXTRA_SHOW_MERCHANT_PREVIEW
Boolean
, whether to show scanner preview video (merchant facing mode only)- See Also:
- Constant Field Values
-
EXTRA_SHOW_CUSTOMER_PREVIEW
public static final String EXTRA_SHOW_CUSTOMER_PREVIEW
Boolean
, whether to show scanner preview video (customer facing mode only)- See Also:
- Constant Field Values
-
EXTRA_LED_ON
public static final String EXTRA_LED_ON
Boolean
, whether LED will be on during barcode scanning if this device has a barcode LED, generally this option is best left out and the preferred device default with be used.- See Also:
- Constant Field Values
-
EXTRA_REQUEST_ID
public static final String EXTRA_REQUEST_ID
String
, a uuid of a request- See Also:
- Constant Field Values
-
EXTRA_SCAN_QR_CODE
public static final String EXTRA_SCAN_QR_CODE
Boolean
, whether QR codes will be scanned- See Also:
- Constant Field Values
-
EXTRA_SCAN_1D_CODE
public static final String EXTRA_SCAN_1D_CODE
Boolean
, whether 1D codes will be scanned- See Also:
- Constant Field Values
-
EXTRA_TRANSMIT_UPC_A_CHECK_DIGIT
public static final String EXTRA_TRANSMIT_UPC_A_CHECK_DIGIT
Boolean
, whether UPC-A check digit will be transmitted- See Also:
- Constant Field Values
-
EXTRA_TRANSMIT_UPC_A_PREAMBLE
public static final String EXTRA_TRANSMIT_UPC_A_PREAMBLE
Boolean
, whether UPC-A preamble will be transmitted- See Also:
- Constant Field Values
-
EXTRA_SHOW_CLOSE_BUTTON
public static final String EXTRA_SHOW_CLOSE_BUTTON
Boolean
, whether scanner preview video will have a 'close' button. If the scan is occurring in merchant-facing mode the merchant will always have a mechanism to close the scanner app.- See Also:
- Constant Field Values
-
EXTRA_SHOW_LED_BUTTON
public static final String EXTRA_SHOW_LED_BUTTON
Boolean
, whether scanner preview video will have a LED light toggle if this device has a barcode LED, many Clover devices do not have an LED, some devices may not honor this option.- See Also:
- Constant Field Values
-
EXTRA_SCAN_X
public static final String EXTRA_SCAN_X
- See Also:
- Constant Field Values
-
EXTRA_SCAN_Y
public static final String EXTRA_SCAN_Y
- See Also:
- Constant Field Values
-
EXTRA_TIMEOUT
public static final String EXTRA_TIMEOUT
Boolean
, flag used to indicate if payment failed due to timeout- See Also:
- Constant Field Values
-
EXTRA_TIMESTAMP
public static final String EXTRA_TIMESTAMP
- See Also:
- Constant Field Values
-
EXTRA_SDK_NAME
public static final String EXTRA_SDK_NAME
- See Also:
- Constant Field Values
-
EXTRA_SDK_VERSION
public static final String EXTRA_SDK_VERSION
- See Also:
- Constant Field Values
-
EXTRA_MD5_HASH
public static final String EXTRA_MD5_HASH
- See Also:
- Constant Field Values
-
EXTRA_SCANNER_FACING
public static final String EXTRA_SCANNER_FACING
On devices where multiple barcode scanners are available, select a barcode scanner to start. Set this extra into theBundle
passed toBarcodeScanner#startScan(Bundle)
. The value passed must be one of the results fromBarcodeScanner#getAvailable()
. The result of passing a value that is not in the result ofBarcodeScanner#getAvailable()
is undefined. If not present, this defaults to eitherBarcodeScanner#BARCODE_SCANNER_FACING_DUAL
orBarcodeScanner#BARCODE_SCANNER_FACING_MERCHANT
, depending on what is available on the device.- See Also:
BarcodeScanner#getAvailable()
,BarcodeScanner#startScan(Bundle)
,BarcodeScanner#BARCODE_SCANNER_FACING_DUAL
,BarcodeScanner#BARCODE_SCANNER_FACING_MERCHANT
,BarcodeScanner#BARCODE_SCANNER_FACING_CUSTOMER
, Constant Field Values
-
EXTRA_ALLOW_FIRE
public static final String EXTRA_ALLOW_FIRE
Boolean
, whether order should respect merchant's setting for firing after payment- See Also:
- Constant Field Values
-
EXTRA_CURRENT_SHIFT
public static final String EXTRA_CURRENT_SHIFT
Shift
, the current employee shift- See Also:
- Constant Field Values
-
EXTRA_TAX_AMOUNT
public static final String EXTRA_TAX_AMOUNT
Long
, a tax amount- See Also:
- Constant Field Values
-
EXTRA_SERVICE_CHARGE_AMOUNT
public static final String EXTRA_SERVICE_CHARGE_AMOUNT
- See Also:
- Constant Field Values
-
EXTRA_TAXABLE_AMOUNTS
public static final String EXTRA_TAXABLE_AMOUNTS
ArrayList
ofTaxableAmountRate
objects - tax rates, and amounts to which they apply- See Also:
- Constant Field Values
-
EXTRA_CARD_ENTRY_METHODS
public static final String EXTRA_CARD_ENTRY_METHODS
int
, representation of bit flags for Intents.CARD_ENTRY_METHOD_* values , when not included in the intent all methods will be allowed- See Also:
- Constant Field Values
-
EXTRA_DISABLE_CASHBACK
public static final String EXTRA_DISABLE_CASHBACK
Boolean
, true will disable cashback option during secure payment- See Also:
- Constant Field Values
-
EXTRA_VOICE_AUTH_CODE
public static final String EXTRA_VOICE_AUTH_CODE
String
, the voice auth code for payment by voice authorization- See Also:
- Constant Field Values
-
EXTRA_IS_TESTING
public static final String EXTRA_IS_TESTING
Deprecated.- See Also:
- Constant Field Values
-
EXTRA_TRANSACTION_TYPE
public static final String EXTRA_TRANSACTION_TYPE
String
, a TRANSACTION_TYPE value- See Also:
- Constant Field Values
-
TRANSACTION_TYPE_PAYMENT
public static final String TRANSACTION_TYPE_PAYMENT
A value forEXTRA_TRANSACTION_TYPE
- See Also:
- Constant Field Values
-
TRANSACTION_TYPE_CREDIT
public static final String TRANSACTION_TYPE_CREDIT
A value forEXTRA_TRANSACTION_TYPE
- See Also:
- Constant Field Values
-
TRANSACTION_TYPE_AUTH
public static final String TRANSACTION_TYPE_AUTH
A value forEXTRA_TRANSACTION_TYPE
- See Also:
- Constant Field Values
-
TRANSACTION_TYPE_CARD_DATA
public static final String TRANSACTION_TYPE_CARD_DATA
A value forEXTRA_TRANSACTION_TYPE
- See Also:
- Constant Field Values
-
TRANSACTION_TYPE_BALANCE_INQUIRY
public static final String TRANSACTION_TYPE_BALANCE_INQUIRY
A value forEXTRA_TRANSACTION_TYPE
- See Also:
- Constant Field Values
-
TRANSACTION_TYPE_CASH_ADVANCE
public static final String TRANSACTION_TYPE_CASH_ADVANCE
A value forEXTRA_TRANSACTION_TYPE
- See Also:
- Constant Field Values
-
TRANSACTION_TYPE_MANUAL_REVERSAL_PAYMENT
public static final String TRANSACTION_TYPE_MANUAL_REVERSAL_PAYMENT
A value forEXTRA_TRANSACTION_TYPE
- See Also:
- Constant Field Values
-
TRANSACTION_TYPE_ADJUSTMENT_PAYMENT
public static final String TRANSACTION_TYPE_ADJUSTMENT_PAYMENT
A value forEXTRA_TRANSACTION_TYPE
- See Also:
- Constant Field Values
-
TRANSACTION_TYPE_MANUAL_REVERSAL_REFUND
public static final String TRANSACTION_TYPE_MANUAL_REVERSAL_REFUND
A value forEXTRA_TRANSACTION_TYPE
- See Also:
- Constant Field Values
-
TRANSACTION_TYPE_ADJUSTMENT_REFUND
public static final String TRANSACTION_TYPE_ADJUSTMENT_REFUND
A value forEXTRA_TRANSACTION_TYPE
- See Also:
- Constant Field Values
-
TRANSACTION_TYPE_CAPTURE_PREAUTH
public static final String TRANSACTION_TYPE_CAPTURE_PREAUTH
A value forEXTRA_TRANSACTION_TYPE
- See Also:
- Constant Field Values
-
TRANSACTION_TYPE_VAS_DATA
public static final String TRANSACTION_TYPE_VAS_DATA
A value forEXTRA_TRANSACTION_TYPE
- See Also:
- Constant Field Values
-
TRANSACTION_TYPE_VERIFY_CARD
public static final String TRANSACTION_TYPE_VERIFY_CARD
A value forEXTRA_TRANSACTION_TYPE
, a transaction that allows an app to verify whether a card is valid. An external app sends an intent of type Intents.ACTION_SECURE_PAY to secure payment app to launch the card verification workflow,Extras passed:
EXTRA_TRANSACTION_TYPE
- type of transaction to be performed by Secure Payment, set value to TRANSACTION_TYPE_VERIFY_CARDEXTRA_EXTERNAL_REFERENCE_ID
- used for passing in an external reference id which gets stored as part of the transaction at the server
Result data includes:
EXTRA_TOKEN_REQUEST
- created token request, seeTokenRequest
- See Also:
- Constant Field Values
-
TRANSACTION_TYPE_TOKENIZE_CARD
public static final String TRANSACTION_TYPE_TOKENIZE_CARD
A value forEXTRA_TRANSACTION_TYPE
, a transaction that allows an app to create a token from a card for later use in lieu of the card. An external app sends an intent of type Intents.ACTION_SECURE_PAY with TRANSACTION_TYPE_TOKENIZE_CARD as the EXTRA_TRANSACTION_TYPE to the secure payment app to launch the card tokenization workflow,Extras passed:
EXTRA_TRANSACTION_TYPE
- type of transaction to be performed by Secure Payment, set value to TRANSACTION_TYPE_TOKENIZE_CARDEXTRA_EXTERNAL_REFERENCE_ID
- used for passing in an external reference id which gets stored as part of the transaction at the server
Result data includes:
EXTRA_TOKEN_REQUEST
- token request object created, seeTokenRequest
- See Also:
- Constant Field Values
-
EXTRA_EXTERNAL_REFERENCE_ID
public static final String EXTRA_EXTERNAL_REFERENCE_ID
String
, external reference id- See Also:
- Constant Field Values
-
EXTRA_EXTERNAL_TOKEN_ID
public static final String EXTRA_EXTERNAL_TOKEN_ID
String
, external token id- See Also:
- Constant Field Values
-
EXTRA_TOKEN_REQUEST
public static final String EXTRA_TOKEN_REQUEST
TokenRequest
, token request objects- See Also:
- Constant Field Values
-
EXTRA_CARD_NOT_PRESENT
public static final String EXTRA_CARD_NOT_PRESENT
Boolean
, card not present, used during manual card entry- See Also:
- Constant Field Values
-
EXTRA_ALLOW_OFFLINE_ACCEPTANCE
public static final String EXTRA_ALLOW_OFFLINE_ACCEPTANCE
Boolean
, allow payments to be accepted offline- See Also:
- Constant Field Values
-
EXTRA_OFFLINE_NO_PROMPT
public static final String EXTRA_OFFLINE_NO_PROMPT
Boolean
, allow offline payments to be accepted without an approval prompt- See Also:
- Constant Field Values
-
EXTRA_FORCE_OFFLINE
public static final String EXTRA_FORCE_OFFLINE
Boolean
, force payments to be accepted offline- See Also:
- Constant Field Values
-
EXTRA_AVS_STREET_ADDRESS
public static final String EXTRA_AVS_STREET_ADDRESS
String
, street address for use with AVS- See Also:
- Constant Field Values
-
EXTRA_AVS_POSTAL_CODE
public static final String EXTRA_AVS_POSTAL_CODE
String
, postal code for use with AVS- See Also:
- Constant Field Values
-
EXTRA_CARD_DATA
public static final String EXTRA_CARD_DATA
PaymentRequestCardDetails
, payment card data- See Also:
- Constant Field Values
-
EXTRA_CARD_DATA_MESSAGE
public static final String EXTRA_CARD_DATA_MESSAGE
String
, the message to prompt the user- See Also:
- Constant Field Values
-
EXTRA_CASHBACK_AMOUNT
public static final String EXTRA_CASHBACK_AMOUNT
Long
, the pre-selected cash back amount- See Also:
- Constant Field Values
-
EXTRA_REMOTE_PRINT
public static final String EXTRA_REMOTE_PRINT
Boolean
, if true printing will be delegated to remote device- See Also:
- Constant Field Values
-
EXTRA_TRANSACTION_NO
public static final String EXTRA_TRANSACTION_NO
Deprecated., internally in the SPS/SPAString
, payment transaction number- See Also:
- Constant Field Values
-
EXTRA_FORCE_SWIPE_PIN_ENTRY
public static final String EXTRA_FORCE_SWIPE_PIN_ENTRY
Boolean
, if only payment option will be swipe debit- See Also:
- Constant Field Values
-
EXTRA_DISABLE_RESTART_TRANSACTION_WHEN_FAILED
public static final String EXTRA_DISABLE_RESTART_TRANSACTION_WHEN_FAILED
Boolean
, if true, the secure payment activity will end after a failed transaction- See Also:
- Constant Field Values
-
EXTRA_EXTERNAL_PAYMENT_ID
public static final String EXTRA_EXTERNAL_PAYMENT_ID
String
, external payment id, used for integration with other POS platforms- See Also:
- Constant Field Values
-
EXTRA_VAULTED_CARD
public static final String EXTRA_VAULTED_CARD
A com.clover.sdk.v3.payments.VaultedCard object that contains a multi-pay token to support paying with card-on-file- See Also:
- Constant Field Values
-
EXTRA_DECLINE_REASON
public static final String EXTRA_DECLINE_REASON
String
, an error description- See Also:
- Constant Field Values
-
EXTRA_TENDER
public static final String EXTRA_TENDER
Tender
, a Tender object- See Also:
- Constant Field Values
-
EXTRA_CUSTOMER_TENDER
public static final String EXTRA_CUSTOMER_TENDER
Tender
, Pre-selected customer tender- See Also:
- Constant Field Values
-
EXTRA_CARD_NUMBER
public static final String EXTRA_CARD_NUMBER
String
, a card number- See Also:
- Constant Field Values
-
EXTRA_IGNORE_PAYMENT
public static final String EXTRA_IGNORE_PAYMENT
- See Also:
- Constant Field Values
-
EXTRA_GIFT_CARD_RESPONSE
public static final String EXTRA_GIFT_CARD_RESPONSE
- See Also:
- Constant Field Values
-
EXTRA_VAULTED_CARD_PAYMENT
public static final String EXTRA_VAULTED_CARD_PAYMENT
- See Also:
- Constant Field Values
-
EXTRA_FAILURE_MESSAGE
public static final String EXTRA_FAILURE_MESSAGE
String
, message shown upon failure- See Also:
- Constant Field Values
-
EXTRA_NETWORK_FAILURE
public static final String EXTRA_NETWORK_FAILURE
String
, indicator of a network failure- See Also:
- Constant Field Values
-
EXTRA_ORIGINATING_TRANSACTION
public static final String EXTRA_ORIGINATING_TRANSACTION
CardTransaction
, originating transaction- See Also:
- Constant Field Values
-
EXTRA_ORIGINATING_PAYMENT
public static final String EXTRA_ORIGINATING_PAYMENT
Payment
, originating payment (applies to refunds, required for Interac refunds)- See Also:
- Constant Field Values
-
EXTRA_ORIGINATING_CREDIT
public static final String EXTRA_ORIGINATING_CREDIT
Credit
, originating credit (applies to reversal, required for Nexo credit reversal)- See Also:
- Constant Field Values
-
CARD_ENTRY_METHOD_MAG_STRIPE
public static final int CARD_ENTRY_METHOD_MAG_STRIPE
A bit value forEXTRA_CARD_ENTRY_METHODS
, can be bitwise-ored with other CARD_ENTRY_METHOD values- See Also:
- Constant Field Values
-
CARD_ENTRY_METHOD_ICC_CONTACT
public static final int CARD_ENTRY_METHOD_ICC_CONTACT
A bit value forEXTRA_CARD_ENTRY_METHODS
, can be bitwise-ored with other CARD_ENTRY_METHOD values- See Also:
- Constant Field Values
-
CARD_ENTRY_METHOD_NFC_CONTACTLESS
public static final int CARD_ENTRY_METHOD_NFC_CONTACTLESS
A bit value forEXTRA_CARD_ENTRY_METHODS
, can be bitwise-ored with other CARD_ENTRY_METHOD values- See Also:
- Constant Field Values
-
CARD_ENTRY_METHOD_MANUAL
public static final int CARD_ENTRY_METHOD_MANUAL
A bit value forEXTRA_CARD_ENTRY_METHODS
, can be bitwise-ored with other CARD_ENTRY_METHOD values- See Also:
- Constant Field Values
-
CARD_ENTRY_METHOD_VAULTED_CARD
public static final int CARD_ENTRY_METHOD_VAULTED_CARD
A bit value forEXTRA_CARD_ENTRY_METHODS
, this value should be used exclusively if Vaulted Card payment is intended for headless mode- See Also:
- Constant Field Values
-
CARD_ENTRY_METHOD_SCAN
public static final int CARD_ENTRY_METHOD_SCAN
A bit value forEXTRA_CARD_ENTRY_METHODS
, this value should be used exclusively to scan QR code or barcode- See Also:
- Constant Field Values
-
CARD_ENTRY_METHOD_ALL
public static final int CARD_ENTRY_METHOD_ALL
A bit value forEXTRA_CARD_ENTRY_METHODS
, all card entry methods.- See Also:
- Constant Field Values
-
KIOSK_MODE_CARD_ENTRY_MASK_SUPPLIED
public static final int KIOSK_MODE_CARD_ENTRY_MASK_SUPPLIED
A bit value used to indicate that a kiosk card entry method mode mask is supplied - implicitly set by other mask values- See Also:
- Constant Field Values
-
KIOSK_MODE_CARD_ENTRY_MASK_MAG_STRIPE
public static final int KIOSK_MODE_CARD_ENTRY_MASK_MAG_STRIPE
A bit value forEXTRA_CARD_ENTRY_METHODS
, can be bitwise-ored with other CARD_ENTRY_METHOD values to provide entry mode mask for device in kiosk mode- See Also:
- Constant Field Values
-
KIOSK_MODE_CARD_ENTRY_MASK_ICC_CONTACT
public static final int KIOSK_MODE_CARD_ENTRY_MASK_ICC_CONTACT
A bit value forEXTRA_CARD_ENTRY_METHODS
, can be bitwise-ored with other CARD_ENTRY_METHOD values to provide entry mode mask for device in kiosk mode- See Also:
- Constant Field Values
-
KIOSK_MODE_CARD_ENTRY_MASK_NFC_CONTACTLESS
public static final int KIOSK_MODE_CARD_ENTRY_MASK_NFC_CONTACTLESS
A bit value forEXTRA_CARD_ENTRY_METHODS
, can be bitwise-ored with other CARD_ENTRY_METHOD values to provide entry mode mask for device in kiosk mode- See Also:
- Constant Field Values
-
KIOSK_MODE_CARD_ENTRY_MASK_MANUAL
public static final int KIOSK_MODE_CARD_ENTRY_MASK_MANUAL
A bit value forEXTRA_CARD_ENTRY_METHODS
, can be bitwise-ored with other CARD_ENTRY_METHOD values to provide entry mode mask for device in kiosk mode- See Also:
- Constant Field Values
-
KIOSK_MODE_CARD_ENTRY_MASK_ALL
public static final int KIOSK_MODE_CARD_ENTRY_MASK_ALL
A bit value forEXTRA_CARD_ENTRY_METHODS
, sets kiosk mode mask to ALL entry mode flags permitted- See Also:
- Constant Field Values
-
EXTRA_PAYMENT
public static final String EXTRA_PAYMENT
Payment
, v3 Payment object- See Also:
- Constant Field Values
-
EXTRA_VAS_PAYLOAD
public static final String EXTRA_VAS_PAYLOAD
VasPayload
, v3 VasPayload object- See Also:
- Constant Field Values
-
EXTRA_CLOSEOUT_BATCH
public static final String EXTRA_CLOSEOUT_BATCH
Batch
, v3 Batch object- See Also:
- Constant Field Values
-
EXTRA_PAYMENTS
public static final String EXTRA_PAYMENTS
- See Also:
- Constant Field Values
-
EXTRA_VOIDED_PAYMENTS
public static final String EXTRA_VOIDED_PAYMENTS
- See Also:
- Constant Field Values
-
EXTRA_VOID_REASON
public static final String EXTRA_VOID_REASON
VoidReason
, v3 VoidReason object- See Also:
- Constant Field Values
-
EXTRA_REFUND_REASON
public static final String EXTRA_REFUND_REASON
String
, merchant provided reason for refund or credit- See Also:
- Constant Field Values
-
EXTRA_CREDIT
public static final String EXTRA_CREDIT
Credit
, v3 Credit object (Manual Refund)- See Also:
- Constant Field Values
-
EXTRA_REFUND
public static final String EXTRA_REFUND
Refund
, v3 Refund object- See Also:
- Constant Field Values
-
EXTRA_CREDIT_REFUND
public static final String EXTRA_CREDIT_REFUND
CreditRefund
, v3 CreditRefund object (Reversal of Manual Refund)- See Also:
- Constant Field Values
-
EXTRA_AUTHORIZATION
public static final String EXTRA_AUTHORIZATION
Authorization
, v3 Authorization object- See Also:
- Constant Field Values
-
EXTRA_AUTHORIZATION_INCREMENT
public static final String EXTRA_AUTHORIZATION_INCREMENT
Boolean
, whether an authorization is being incremented or decremented- See Also:
- Constant Field Values
-
EXTRA_SHOW_REMAINING
public static final String EXTRA_SHOW_REMAINING
Boolean
, whether to show amount remaining after payment- See Also:
- Constant Field Values
-
EXTRA_SHOW_VOID_BUTTON
public static final String EXTRA_SHOW_VOID_BUTTON
Boolean
, whether to show the Void button- See Also:
- Constant Field Values
-
EXTRA_SIGNATURE_VERIFIED
public static final String EXTRA_SIGNATURE_VERIFIED
Boolean
, whether signature is already verified- See Also:
- Constant Field Values
-
EXTRA_SIGNATURE
public static final String EXTRA_SIGNATURE
Signature2
, payment Signature2 signature- See Also:
- Constant Field Values
-
EXTRA_PRINT_RECEIPT_ONLY
public static final String EXTRA_PRINT_RECEIPT_ONLY
Boolean
, print receipt extras- See Also:
- Constant Field Values
-
EXTRA_RECEIPT_FLAG
public static final String EXTRA_RECEIPT_FLAG
int
, representation of bit flags fromPrintJob
- See Also:
- Constant Field Values
-
EXTRA_VAS_SETTINGS
public static final String EXTRA_VAS_SETTINGS
Vas Settings- See Also:
- Constant Field Values
-
EXTRA_VAS_URL_TOKENS
public static final String EXTRA_VAS_URL_TOKENS
VAS URL customization tokens- See Also:
- Constant Field Values
-
EXTRA_TRANSACTION_SETTINGS
public static final String EXTRA_TRANSACTION_SETTINGS
- See Also:
- Constant Field Values
-
EXTRA_TIPS_ENABLED
public static final String EXTRA_TIPS_ENABLED
Boolean
, are tips enabled for this transaction- See Also:
- Constant Field Values
-
EXTRA_DISABLE_RECEIPT_OPTIONS
public static final String EXTRA_DISABLE_RECEIPT_OPTIONS
Boolean
, is the receipt options screen disabled for this transaction- See Also:
- Constant Field Values
-
EXTRA_PASS_THROUGH_VALUES
public static final String EXTRA_PASS_THROUGH_VALUES
Map
set of key/value pairs that are passed through to the server- See Also:
- Constant Field Values
-
EXTRA_APPLICATION_SPECIFIC_VALUES
public static final String EXTRA_APPLICATION_SPECIFIC_VALUES
Map
set of key/value pairs used for application specific implementations- See Also:
- Constant Field Values
-
EXTRA_API_TIP_PREFER_ON_SCREEN
public static final String EXTRA_API_TIP_PREFER_ON_SCREEN
- See Also:
- Constant Field Values
-
EXTRA_API_SIGNATURE_PREFER_ON_SCREEN
public static final String EXTRA_API_SIGNATURE_PREFER_ON_SCREEN
- See Also:
- Constant Field Values
-
EXTRA_TIP_MODE
public static final String EXTRA_TIP_MODE
TipMode
, where tips are entered/provided (e.g. on screen after/before, on paper, provided or no tip) for this transaction- See Also:
- Constant Field Values
-
TIP_MODE_ON_SCREEN_BEFORE_PAYMENT
public static final String TIP_MODE_ON_SCREEN_BEFORE_PAYMENT
A value forEXTRA_TIP_MODE
- See Also:
- Constant Field Values
-
TIP_MODE_ON_SCREEN_AFTER_PAYMENT
public static final String TIP_MODE_ON_SCREEN_AFTER_PAYMENT
A value forEXTRA_TIP_MODE
- See Also:
- Constant Field Values
-
TIP_MODE_ON_PAPER
public static final String TIP_MODE_ON_PAPER
A value forEXTRA_TIP_MODE
- See Also:
- Constant Field Values
-
TIP_MODE_NO_TIP
public static final String TIP_MODE_NO_TIP
A value forEXTRA_TIP_MODE
- See Also:
- Constant Field Values
-
EXTRA_SIGNATURE_ENTRY_LOCATION
public static final String EXTRA_SIGNATURE_ENTRY_LOCATION
DataEntryLocation
, where signatures are entered (e.g. on screen, on paper, none) for this transaction- See Also:
- Constant Field Values
-
DATA_ENTRY_LOCATION_ON_SCREEN
public static final String DATA_ENTRY_LOCATION_ON_SCREEN
A value forEXTRA_SIGNATURE_ENTRY_LOCATION
- See Also:
- Constant Field Values
-
DATA_ENTRY_LOCATION_ON_PAPER
public static final String DATA_ENTRY_LOCATION_ON_PAPER
A value forEXTRA_SIGNATURE_ENTRY_LOCATION
- See Also:
- Constant Field Values
-
DATA_ENTRY_LOCATION_NONE
public static final String DATA_ENTRY_LOCATION_NONE
A value forEXTRA_SIGNATURE_ENTRY_LOCATION
- See Also:
- Constant Field Values
-
EXTRA_SIGNATURE_THRESHOLD
public static final String EXTRA_SIGNATURE_THRESHOLD
Long
, what is the signature threshold for this transaction- See Also:
- Constant Field Values
-
EXTRA_ENABLE_KIOSK_MODE
public static final String EXTRA_ENABLE_KIOSK_MODE
Boolean
, is the device interaction for this transaction in kioskMode (i.e. customer-only/no merchant present)- See Also:
- Constant Field Values
-
EXTRA_GERMAN_ELV
public static final String EXTRA_GERMAN_ELV
String
, elv transaction type for Germany- See Also:
- Constant Field Values
-
GERMAN_ELV
public static final String GERMAN_ELV
A value forEXTRA_GERMAN_ELV
- See Also:
- Constant Field Values
-
GERMAN_ELV_ONLINE
public static final String GERMAN_ELV_ONLINE
A value forEXTRA_GERMAN_ELV
- See Also:
- Constant Field Values
-
GERMAN_ELV_OFFLINE
public static final String GERMAN_ELV_OFFLINE
A value forEXTRA_GERMAN_ELV
- See Also:
- Constant Field Values
-
GERMAN_GIROCARD
public static final String GERMAN_GIROCARD
A value forEXTRA_GERMAN_ELV
- See Also:
- Constant Field Values
-
EXTRA_ELV_APPLICATION_LABEL
public static final String EXTRA_ELV_APPLICATION_LABEL
A value forEXTRA_ELV_APPLICATION_LABEL
- See Also:
- Constant Field Values
-
CARD_DATA_READ_MODE_ENHANCED_CVV
public static final String CARD_DATA_READ_MODE_ENHANCED_CVV
- See Also:
- Constant Field Values
-
EXTRA_DATA_READ_MODE
public static final String EXTRA_DATA_READ_MODE
A value forEXTRA_DATA_READ_MODE
data read mode for specific integration use cases. supported value(s):CARD_DATA_READ_MODE_ENHANCED_CVV
- See Also:
- Constant Field Values
-
ACTION_ORDER_CREATED
public static final String ACTION_ORDER_CREATED
Broadcast from Clover, indicating an order was createdExtras passed:
EXTRA_CLOVER_ORDER_ID
- the UUID of created order (note that this order may or may not be saved)
- See Also:
- Constant Field Values
-
ACTION_LINE_ITEM_ADDED
public static final String ACTION_LINE_ITEM_ADDED
Broadcast from Clover, indicating a lineItem has been added to an orderExtras passed:
EXTRA_CLOVER_LINE_ITEM_ID
- the UUID of the created LineItemEXTRA_CLOVER_ITEM_ID
- the UUID of the Item associated with the LineItem- - the array of the UUIDs of the added LineItems
- - the array of the UUIDs of associated with lineItems
EXTRA_CLOVER_ORDER_ID
- the UUID of the order associated with the LineItem
_IDS
) to ensure that all item additions are observed.- See Also:
- Constant Field Values
-
ACTION_LINE_ITEM_DELETED
public static final String ACTION_LINE_ITEM_DELETED
Broadcast from Clover, line item has been deletedExtras passed:
EXTRA_CLOVER_LINE_ITEM_ID
- the UUID of the deleted LineItemEXTRA_CLOVER_ITEM_ID
- the UUID of the Item associated with the LineItemEXTRA_LINE_ITEM_IDS
- the array of UUIDs of the deleted LineItemsEXTRA_CLOVER_ITEM_IDS
- the array of UUIDs of associated with LineItemsEXTRA_CLOVER_ORDER_ID
- the UUID of the order associated with the LineItem
_IDS
) to ensure that all item deletions are observed.- See Also:
- Constant Field Values
-
ACTION_PAYMENT_PROCESSED
public static final String ACTION_PAYMENT_PROCESSED
Broadcast from Clover, indicating a payment has been successfully processedExtras passed:
EXTRA_CLOVER_PAYMENT_ID
- the UUID of the processed PaymentEXTRA_CLOVER_TENDER_LABEL_KEY
- the LabelKey of the Tender usedEXTRA_CLOVER_ORDER_ID
- the UUID of the order associated with the Payment
- See Also:
- Constant Field Values
-
ACTION_ORDER_SAVED
public static final String ACTION_ORDER_SAVED
Broadcast from Clover, indicating an Order has been saved for later processingExtras passed:
EXTRA_CLOVER_ORDER_ID
- the UUID of saved Order
- See Also:
- Constant Field Values
-
ACTION_ACTIVE_REGISTER_ORDER
public static final String ACTION_ACTIVE_REGISTER_ORDER
Broadcast from Clover, indicating the active order in RegisterExtras passed:
EXTRA_ORDER_ID
- the UUID of the active order in Register, or null if there is no longer an active order
- See Also:
- Constant Field Values
-
ACTION_V1_ACTIVE_PAY_ORDER
public static final String ACTION_V1_ACTIVE_PAY_ORDER
Broadcast from Clover, indicating the active order in the Register Pay activityExtras passed:
EXTRA_ORDER_ID
- the UUID of the active order in Pay, or null if there is no longer an active order
- See Also:
- Constant Field Values
-
ACTION_V1_ORDER_BUILD_START
public static final String ACTION_V1_ORDER_BUILD_START
Broadcast from Clover, indicating that we are starting to build an orderExtras passed:
EXTRA_ORDER_ID
- the UUID of the order being built
- See Also:
- Constant Field Values
-
ACTION_V1_ORDER_BUILD_STOP
public static final String ACTION_V1_ORDER_BUILD_STOP
Broadcast from Clover, indicating that we have stopped building an orderExtras passed:
EXTRA_ORDER_ID
- the UUID of the order that is no longer being built
- See Also:
- Constant Field Values
-
ACTION_V1_PAY_BUILD_SHOW
public static final String ACTION_V1_PAY_BUILD_SHOW
Broadcast from Clover, indicating that we are showing PayActivityExtras passed:
EXTRA_ORDER_ID
- the UUID of the order active in the PayActivity
- See Also:
- Constant Field Values
-
ACTION_V1_PAY_BUILD_HIDE
public static final String ACTION_V1_PAY_BUILD_HIDE
Broadcast from Clover, indicating that PayActivity was hiddenExtras passed:
EXTRA_ORDER_ID
- the UUID of the order that is no longer active in the PayActivity
- See Also:
- Constant Field Values
-
ACTION_V1_PAY_BUILD_START
public static final String ACTION_V1_PAY_BUILD_START
Broadcast from Clover, indicating that we are starting to build a paymentExtras passed:
EXTRA_ORDER_ID
- the UUID of the order associated with the payment now being built
- See Also:
- Constant Field Values
-
ACTION_V1_PAY_BUILD_STOP
public static final String ACTION_V1_PAY_BUILD_STOP
Broadcast from Clover, indicating that we have stopped building a paymentExtras passed:
EXTRA_ORDER_ID
- the UUID of the order associated with the payment that is no longer being built
- See Also:
- Constant Field Values
-
ACTION_V1_PAY_EXECUTE_START
public static final String ACTION_V1_PAY_EXECUTE_START
Broadcast from Clover, indicating that we have started executing a paymentExtras passed:
EXTRA_ORDER_ID
- the UUID of the order associated with the payment that is now being executed
- See Also:
- Constant Field Values
-
ACTION_V1_PAY_EXECUTE_STOP
public static final String ACTION_V1_PAY_EXECUTE_STOP
Broadcast from Clover, indicating that we have stopped executing a paymentExtras passed:
EXTRA_ORDER_ID
- the UUID of the order associated with the payment that is no longer being executed
- See Also:
- Constant Field Values
-
ACTION_V1_CUSTOMER_IDENTIFIED
public static final String ACTION_V1_CUSTOMER_IDENTIFIED
Broadcast indicating that a customer has been identified as a 'current' customer of interest. This may indicate that the customer was identified by a third party app on the device, or by a Clover application. The customer may or may not exist as a clover customer. The customer set on the intent is a wrapper of the Clover Customer.Extras passed:
EXTRA_CUSTOMERINFO
- the RemoteCustomer object that was identified. (Required)
- See Also:
- Constant Field Values
-
EXTRA_AVAILABLE
public static final String EXTRA_AVAILABLE
Deprecated.- See Also:
- Constant Field Values
-
EXTRA_SHOW_SEARCH
public static final String EXTRA_SHOW_SEARCH
- See Also:
- Constant Field Values
-
META_CUSTOMER_TENDER_IMAGE
public static final String META_CUSTOMER_TENDER_IMAGE
int
, A drawable resource ID, the image to be displayed on the customer-facing tender button- See Also:
- Constant Field Values
-
META_MERCHANT_TENDER_IMAGE
public static final String META_MERCHANT_TENDER_IMAGE
int
, A drawable resource ID, the image to be displayed on the merchant-facing tender button- See Also:
- Constant Field Values
-
EXTRA_USE_LAST_SWIPE
public static final String EXTRA_USE_LAST_SWIPE
Boolean
flag- See Also:
- Constant Field Values
-
EXTRA_ECR_MODE
public static final String EXTRA_ECR_MODE
Boolean
flag Indicates if device supports ECR mode or not- See Also:
- Constant Field Values
-
EXTRA_THEME_NAME
public static final String EXTRA_THEME_NAME
String
Indicates name of theme to be used in station-pay/secure-pay- See Also:
- Constant Field Values
-
EXTRA_SEND_RESULT_ON_TRANSACTION_COMPLETE
public static final String EXTRA_SEND_RESULT_ON_TRANSACTION_COMPLETE
Boolean
flag Indicates if the secure pay app should send the transaction result when the transaction is complete. Usually the result is sent when spa finishes, but this flag indicates, that the result shall be sent as soon as the transaction result is available- See Also:
- Constant Field Values
-
EXTRA_INVOICE_ID_REGEX
public static final String EXTRA_INVOICE_ID_REGEX
String
A regular expression to check the validity of invoice number- See Also:
- Constant Field Values
-
EXTRA_INVOICE_ID_AVAILABLE
public static final String EXTRA_INVOICE_ID_AVAILABLE
Boolean
Flag to check if invoice feature is available for merchant- See Also:
- Constant Field Values
-
ACTION_KEYPAD
public static final String ACTION_KEYPAD
An activity action that will start an activity that accepts keypad input from the user. Start for result, and obtain the text entered by the user from the result data extraRESULT_KEYPAD_TEXT
The type of keypad is selected by setting the extraEXTRA_KEYPAD_TYPE
to eitherKEYPAD_TYPE_NUMERIC
,KEYPAD_TYPE_EMAIL
, orKEYPAD_TYPE_PHONESMS
. The default isKEYPAD_TYPE_NUMERIC
if not specified. To pre-populate the text set the extraEXTRA_KEYPAD_TYPE
. This is optional. To show the user a list of text completions to the user set the extraEXTRA_KEYPAD_COMPLETIONS
. This is optional.- See Also:
- Constant Field Values
-
KEYPAD_TYPE_NUMERIC
public static final int KEYPAD_TYPE_NUMERIC
Keypad optimized for numeric input. Set in the extraEXTRA_KEYPAD_TYPE
.- See Also:
- Constant Field Values
-
KEYPAD_TYPE_EMAIL
public static final int KEYPAD_TYPE_EMAIL
Keypad optimized for email address input. Set in the extraEXTRA_KEYPAD_TYPE
.- See Also:
- Constant Field Values
-
KEYPAD_TYPE_PHONESMS
public static final int KEYPAD_TYPE_PHONESMS
Keypad optimized for phone and SMS number input. Set in the extraEXTRA_KEYPAD_TYPE
.- See Also:
- Constant Field Values
-
EXTRA_KEYPAD_COMPLETIONS
public static final String EXTRA_KEYPAD_COMPLETIONS
AnArrayList
ofString
, word completions to display above the keyboard. For example this can be used to provide a list of email suffixes ("@gmail.com", "@hotmail.com", etc). If absent, the completion bar is hidden. Set this into the start activity intent usingBundle.putStringArrayList(String, ArrayList)
.- See Also:
- Constant Field Values
-
EXTRA_KEYPAD_TYPE
public static final String EXTRA_KEYPAD_TYPE
An integer, the desired keypad type as an integer. EitherKEYPAD_TYPE_NUMERIC
, orKEYPAD_TYPE_EMAIL
, orKEYPAD_TYPE_PHONESMS
. This is optional and defaults toKEYPAD_TYPE_NUMERIC
if not specified.- See Also:
- Constant Field Values
-
EXTRA_KEYPAD_TEXT
public static final String EXTRA_KEYPAD_TEXT
AString
, the initial text to populate into the edit area. This is optional and defaults to the empty string if not specified.- See Also:
- Constant Field Values
-
RESULT_KEYPAD_TEXT
public static final String RESULT_KEYPAD_TEXT
AString
, the text entered by the user. This is returned as an extra in the activity result data. This is only valid if the activity result code isActivity.RESULT_OK
. The entire content of the edit text is returned here, as a string. This includes any initial text provided viaEXTRA_KEYPAD_TEXT
(that wasn't edited away by the user).- See Also:
- Constant Field Values
-
EXTRA_ORIGINATING_PAYMENT_PACKAGE
public static final String EXTRA_ORIGINATING_PAYMENT_PACKAGE
Intent to track package of the Payment.- See Also:
- Constant Field Values
-
EXTRA_DISABLE_CREDIT_SURCHARGE
public static final String EXTRA_DISABLE_CREDIT_SURCHARGE
Intent Extra to toggle credit surcharge.- See Also:
- Constant Field Values
-
EXTRA_PRESENT_QRC_ONLY
public static final String EXTRA_PRESENT_QRC_ONLY
Boolean
, a private extra indicating the user selected Scan QR Code for this Payment. The intent consumer will then display the QR code as the only payment method.- See Also:
- Constant Field Values
-
EXTRA_MANUAL_CARD_ENTRY_BYPASS_MODE
public static final String EXTRA_MANUAL_CARD_ENTRY_BYPASS_MODE
Intent Extra to Bypass Manual Card Entry Data.- See Also:
- Constant Field Values
-
EXTRA_ALLOW_MANUAL_CARD_ENTRY_ON_MFD
public static final String EXTRA_ALLOW_MANUAL_CARD_ENTRY_ON_MFD
Intent Extra to Allow Manual Card Entry on MFD.- See Also:
- Constant Field Values
-
EXTRA_MANUAL_CARD_PAN
public static final String EXTRA_MANUAL_CARD_PAN
Intent Extra to Manual Card PAN Data.- See Also:
- Constant Field Values
-
EXTRA_MANUAL_CARD_CVV
public static final String EXTRA_MANUAL_CARD_CVV
Intent Extra to Manual Card CVV Data.- See Also:
- Constant Field Values
-
EXTRA_MANUAL_CARD_EXPIRY
public static final String EXTRA_MANUAL_CARD_EXPIRY
Intent Extra to Manual Card Expiry Data.- See Also:
- Constant Field Values
-
EXTRA_AUTO_ACCEPT_PAYMENT_CONFIRMATIONS
public static final String EXTRA_AUTO_ACCEPT_PAYMENT_CONFIRMATIONS
Boolean
automatically accept payment confirmations- See Also:
- Constant Field Values
-
EXTRA_AUTO_ACCEPT_SIGNATURE
public static final String EXTRA_AUTO_ACCEPT_SIGNATURE
Boolean
automatically accept payment confirmations- See Also:
- Constant Field Values
-
EXTRA_SKIP_RECEIPT_SCREEN
public static final String EXTRA_SKIP_RECEIPT_SCREEN
Boolean
skip the display of the receipt screen- See Also:
- Constant Field Values
-
EXTRA_APPROVE_OFFLINE_PAYMENT_WITHOUT_PROMPT
public static final String EXTRA_APPROVE_OFFLINE_PAYMENT_WITHOUT_PROMPT
Boolean
don't prompt for confirmation of an offline payment- See Also:
- Constant Field Values
-
EXTRA_ALLOW_OFFLINE_PAYMENT
public static final String EXTRA_ALLOW_OFFLINE_PAYMENT
Boolean
allow offline payments even if the merchant isn't configured to accept them- See Also:
- Constant Field Values
-
EXTRA_SIGNATURE_LOCATION
public static final String EXTRA_SIGNATURE_LOCATION
the location for the customer signature- See Also:
- Constant Field Values
-
EXTRA_REFUND_ID
public static final String EXTRA_REFUND_ID
- See Also:
- Constant Field Values
-
EXTRA_DISABLE_CLOVER_PRINTING
public static final String EXTRA_DISABLE_CLOVER_PRINTING
- See Also:
- Constant Field Values
-
EXTRA_AUTO_ACCEPT_DUPLICATES
public static final String EXTRA_AUTO_ACCEPT_DUPLICATES
automatically accept the customer signature- See Also:
- Constant Field Values
-
EXTRA_CAPTURE
public static final String EXTRA_CAPTURE
Boolean
If set to true (auth) the payment will be automatically/immediately captured and may be adjustable until closeout runs at which time it will be settled/closed. If set to false (preauth) the payment will not be automatically/immediately captured and a subsequent call to capture will be required to do so. Once captured the payment will be settled/closed the next time closeout runs.- See Also:
- Constant Field Values
-
EXTRA_C_TOKEN_RESULT
public static final String EXTRA_C_TOKEN_RESULT
Result of C-Token requested part of Transaction Type link #TRANSACTION_TYPE_PAYMENT} orTRANSACTION_TYPE_AUTH
TRANSACTION_TYPE_TOKENIZE_CARD
seeTokenizeCardResponse
- See Also:
- Constant Field Values
-
EXTRA_C_TOKEN_REQUEST
public static final String EXTRA_C_TOKEN_REQUEST
Request an C-Token part of Transaction Type link #TRANSACTION_TYPE_PAYMENT} orTRANSACTION_TYPE_AUTH
orTRANSACTION_TYPE_TOKENIZE_CARD
. A Valid Api access token must be set onTokenizeCardRequest
which can be obtained from the merchant dashboard- See Also:
- Constant Field Values
-
EXTRA_NO_TIP
public static final String EXTRA_NO_TIP
- See Also:
- Constant Field Values
-
EXTRA_REVERSE_PAYMENT_RESULT
public static final String EXTRA_REVERSE_PAYMENT_RESULT
- See Also:
- Constant Field Values
-
EXTRA_REGIONAL_EXTRAS
public static final String EXTRA_REGIONAL_EXTRAS
- See Also:
- Constant Field Values
-
EXTRA_SUPPRESS_CONFIRMATION
public static final String EXTRA_SUPPRESS_CONFIRMATION
- See Also:
- Constant Field Values
-
EXTRA_USE_LEGACY_VAULT_CARD
public static final String EXTRA_USE_LEGACY_VAULT_CARD
- See Also:
- Constant Field Values
-
EXTRA_TOKEN_TYPE
public static final String EXTRA_TOKEN_TYPE
- See Also:
- Constant Field Values
-
EXTRA_SHOULD_TOKENIZE_CARD
public static final String EXTRA_SHOULD_TOKENIZE_CARD
- See Also:
- Constant Field Values
-
EXTRA_TOKEN
public static final String EXTRA_TOKEN
- See Also:
- Constant Field Values
-
EXTRA_CARD
public static final String EXTRA_CARD
- See Also:
- Constant Field Values
-
EXTRA_RETURN_FULL_CARD_DATA
public static final String EXTRA_RETURN_FULL_CARD_DATA
- See Also:
- Constant Field Values
-
EXTRA_USE_CONNECTED_DEVICE
public static final String EXTRA_USE_CONNECTED_DEVICE
- See Also:
- Constant Field Values
-
EXTRA_RECEIPT_DELIVERY_STATUS
public static final String EXTRA_RECEIPT_DELIVERY_STATUS
- See Also:
- Constant Field Values
-
EXTRA_RECEIPT_DELIVERY_TYPE
public static final String EXTRA_RECEIPT_DELIVERY_TYPE
- See Also:
- Constant Field Values
-
EXTRA_CLOVER_SHOULD_HANDLE_RECEIPTS
public static final String EXTRA_CLOVER_SHOULD_HANDLE_RECEIPTS
- See Also:
- Constant Field Values
-
EXTRA_SELECTED_RECEIPT_OPTION
public static final String EXTRA_SELECTED_RECEIPT_OPTION
- See Also:
- Constant Field Values
-
EXTRA_ENABLED_RECEIPT_OPTIONS
public static final String EXTRA_ENABLED_RECEIPT_OPTIONS
- See Also:
- Constant Field Values
-
EXTRA_ENTERED_RECEIPT_VALUE
public static final String EXTRA_ENTERED_RECEIPT_VALUE
- See Also:
- Constant Field Values
-
EXTRA_SEND_DEBUG_LOG_MESSAGE
public static final String EXTRA_SEND_DEBUG_LOG_MESSAGE
- See Also:
- Constant Field Values
-
EXTRA_CASHBACK_SUGGESTIONS
public static final String EXTRA_CASHBACK_SUGGESTIONS
- See Also:
- Constant Field Values
-
EXTRA_REMOTE_RECEIPTS
public static final String EXTRA_REMOTE_RECEIPTS
- See Also:
- Constant Field Values
-
EXTRA_SHOULD_RETRIEVE_OPEN_PAYMENTS
public static final String EXTRA_SHOULD_RETRIEVE_OPEN_PAYMENTS
- See Also:
- Constant Field Values
-
EXTRA_ZERO_OUT_OPEN_TIPS
public static final String EXTRA_ZERO_OUT_OPEN_TIPS
- See Also:
- Constant Field Values
-
EXTRA_LEAVE_PREAUTHS_OPEN
public static final String EXTRA_LEAVE_PREAUTHS_OPEN
- See Also:
- Constant Field Values
-
ACTION_START_HEADLESS_CLOSEOUT
public static final String ACTION_START_HEADLESS_CLOSEOUT
- See Also:
- Constant Field Values
-
EXTRA_CLOSEOUT_RESULT
public static final String EXTRA_CLOSEOUT_RESULT
- See Also:
- Constant Field Values
-
EXTRA_CLOVER_SHOULD_HANDLE_TIPS
public static final String EXTRA_CLOVER_SHOULD_HANDLE_TIPS
- See Also:
- Constant Field Values
-
EXTRA_OPTED_INTO_MARKETING
public static final String EXTRA_OPTED_INTO_MARKETING
- See Also:
- Constant Field Values
-
EXTRA_TENDER_OPTIONS
public static final String EXTRA_TENDER_OPTIONS
- See Also:
- Constant Field Values
-
EXTRA_CHANGE_DUE
public static final String EXTRA_CHANGE_DUE
- See Also:
- Constant Field Values
-
EXTRA_ALWAYS_SHOW_RETURN_TO_MERCHANT
public static final String EXTRA_ALWAYS_SHOW_RETURN_TO_MERCHANT
Used to indicate if the "return to merchant" screen can/should be skipped.- See Also:
- Constant Field Values
-
EXTRA_EXIT_IN_CUSTOMER_MODE
public static final String EXTRA_EXIT_IN_CUSTOMER_MODE
Used (by BillSplit) to have the ensuing activity be in customer mode.- See Also:
- Constant Field Values
-
EXTRA_THRESHOLD_MANAGER_ID
public static final String EXTRA_THRESHOLD_MANAGER_ID
Intent to track package of the override manager id.- See Also:
- Constant Field Values
-
EXTRA_THRESHOLD_MANAGER_NAME
public static final String EXTRA_THRESHOLD_MANAGER_NAME
Intent to track package of the override manager name.- See Also:
- Constant Field Values
-
EXTRA_EBT_MANUAL_CARD_ENTRY_SCREEN_FLOW
public static final String EXTRA_EBT_MANUAL_CARD_ENTRY_SCREEN_FLOW
Intent to define EBT manual card entry screen flow.- See Also:
- Constant Field Values
-
EXTRA_SKIP_REPRINT_ROLE_CHECK
public static final String EXTRA_SKIP_REPRINT_ROLE_CHECK
Intent to define if manager permission dialog should be skip or not- See Also:
- Constant Field Values
-
EXTRA_IMMERSIVE_MODE
public static final String EXTRA_IMMERSIVE_MODE
Boolean
If set to true, it will hide navigation and status bar- See Also:
- Constant Field Values
-
EXTRA_PAYMENT_TYPE
public static final String EXTRA_PAYMENT_TYPE
Intent to track payment sub types- See Also:
- Constant Field Values
-
EXTRA_CREATE_AUTH
public static final String EXTRA_CREATE_AUTH
Intent to track create an auth- See Also:
- Constant Field Values
-
EXTRA_TRANSACTION_NAME
public static final String EXTRA_TRANSACTION_NAME
The transaction name (held in the Terminal apps' settings)- See Also:
- Constant Field Values
-
EXTRA_APPLY_TAXES_AND_FEES
public static final String EXTRA_APPLY_TAXES_AND_FEES
Boolean
whether or not to apply taxes to a transaction (held in the Terminal apps' settings)- See Also:
- Constant Field Values
-
EXTRA_TAXES_AND_FEES_BREAKDOWN
public static final String EXTRA_TAXES_AND_FEES_BREAKDOWN
String
Summary line showing taxes and fees, e.g. "Tax Rate + Fees: 30% + $2.00" (held in the Terminal apps' settings)- See Also:
- Constant Field Values
-
-
-