public class Intents extends Object
Modifier and Type | Class and Description |
---|---|
static class |
Intents.PAYMENT_TOKEN_TYPE |
static class |
Intents.RemoteViewSize
Values passed with
EXTRA_REMOTE_VIEW_SIZE |
Modifier and Type | Field and Description |
---|---|
static String |
ACTION_ACTIVE_REGISTER_ORDER
Broadcast from Clover, indicating the active order in Register
|
static String |
ACTION_ADD_TIP
Launch activity to add tip to requested payment
|
static String |
ACTION_APP_INSTALL_DONE
A broadcast intent sent to your app when it is installed or updated to a
new version.
|
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 batch
|
static String |
ACTION_CLOSEOUT_BATCH
Launch activity to closeout sales and refunds batch
|
static String |
ACTION_CLOSEOUT_BATCH_SCHEDULED
Broadcast from Clover, indicating a closeout has been scheduled
|
static 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 order
|
static 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 order
|
static String |
ACTION_MANUAL_PAY
Deprecated.
Please use
ACTION_CLOVER_PAY instead |
static String |
ACTION_MANUAL_REFUND
Deprecated.
Please use
ACTION_CLOVER_PAY instead |
static 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 created
|
static String |
ACTION_ORDER_SAVED
Broadcast from Clover, indicating an Order has been saved for later processing
|
static String |
ACTION_PAY
Deprecated.
Replaced by
ACTION_MERCHANT_TENDER and ACTION_CUSTOMER_TENDER |
static String |
ACTION_PAYMENT_PROCESSED
Broadcast from Clover, indicating a payment has been successfully processed
|
static String |
ACTION_REFUND
Intent passed to start your app's extensible tender refund activity
|
static 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 receiver
|
static String |
ACTION_REQUEST_ROLE
Deprecated.
|
static String |
ACTION_SCAN
Deprecated.
This does not work on recent devices. Use
BarcodeScanner instead.
Broadcast to start barcode scanner service on Station or Mini (Mobile scanner must be activated via physical trigger)
Extras passed:
|
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 activity
|
static String |
ACTION_START_CUSTOMER_PROFILE
Launch the Customer Profile activity
|
static String |
ACTION_START_ORDER_MANAGE
Launch Order Manage activity
|
static String |
ACTION_START_PIN_ACTIVITY
Launches PIN Activity in secure-payments
|
static String |
ACTION_START_PRINT_RECEIPTS
Launch the Print Receipts activity, to show receipt printing and sending options for an order
|
static String |
ACTION_START_REGISTER
Launch Register Point of Sale activity
|
static String |
ACTION_START_SELECT_ACCOUNT_ACTIVITY
Launches SelectAccountActivity in secure-payments
|
static String |
ACTION_START_TRANSACTION_DETAIL
Launch Transactions detail activity
|
static 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 to
ACTION_REQUEST_PAYMENT_REMOTE_VIEWS to receive views to be
displayed on the tender screen |
static String |
ACTION_V1_ACTIVE_PAY_ORDER
Broadcast from Clover, indicating the active order in the Register Pay activity
|
static 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 order
|
static String |
ACTION_V1_ORDER_BUILD_STOP
Broadcast from Clover, indicating that we have stopped building an order
|
static String |
ACTION_V1_PAY_BUILD_HIDE
Broadcast from Clover, indicating that PayActivity was hidden
|
static String |
ACTION_V1_PAY_BUILD_SHOW
Broadcast from Clover, indicating that we are showing PayActivity
|
static String |
ACTION_V1_PAY_BUILD_START
Broadcast from Clover, indicating that we are starting to build a payment
|
static String |
ACTION_V1_PAY_BUILD_STOP
Broadcast from Clover, indicating that we have stopped building a payment
|
static String |
ACTION_V1_PAY_EXECUTE_START
Broadcast from Clover, indicating that we have started executing a payment
|
static String |
ACTION_V1_PAY_EXECUTE_STOP
Broadcast from Clover, indicating that we have stopped executing a payment
|
static String |
CARD_DATA_READ_MODE_ENHANCED_CVV |
static int |
CARD_ENTRY_METHOD_ALL
A bit value for
EXTRA_CARD_ENTRY_METHODS , all card entry methods. |
static int |
CARD_ENTRY_METHOD_ICC_CONTACT
A bit value for
EXTRA_CARD_ENTRY_METHODS , can be bitwise-ored with other CARD_ENTRY_METHOD values |
static int |
CARD_ENTRY_METHOD_MAG_STRIPE
A bit value for
EXTRA_CARD_ENTRY_METHODS , can be bitwise-ored with other CARD_ENTRY_METHOD values |
static int |
CARD_ENTRY_METHOD_MANUAL
A bit value for
EXTRA_CARD_ENTRY_METHODS , can be bitwise-ored with other CARD_ENTRY_METHOD values |
static int |
CARD_ENTRY_METHOD_NFC_CONTACTLESS
A bit value for
EXTRA_CARD_ENTRY_METHODS , can be bitwise-ored with other CARD_ENTRY_METHOD values |
static int |
CARD_ENTRY_METHOD_VAULTED_CARD
A bit value for
EXTRA_CARD_ENTRY_METHODS , this value should be used exclusively if Vaulted Card payment is intended for headless mode |
static String |
CASHADVANCE_CUSTOMER_IDENTIFICATION
CashAdvanceCustomerIdentification object used for CashAdvance payments |
static String |
DATA_ENTRY_LOCATION_NONE
A value for
EXTRA_SIGNATURE_ENTRY_LOCATION |
static String |
DATA_ENTRY_LOCATION_ON_PAPER
A value for
EXTRA_SIGNATURE_ENTRY_LOCATION |
static String |
DATA_ENTRY_LOCATION_ON_SCREEN
A value for
EXTRA_SIGNATURE_ENTRY_LOCATION |
static String |
EXTRA_ACCOUNT
Account , the Clover account associated with the action or broadcast |
static String |
EXTRA_ACCOUNT_ROLES
An
ArrayList of AccountRole . |
static String |
EXTRA_ALLOW_FIRE
Boolean , whether order should respect merchant's setting for firing after payment |
static 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 offline |
static String |
EXTRA_ALLOW_OFFLINE_PAYMENT
Boolean allow offline payments even if the merchant isn't configured to accept them |
static String |
EXTRA_ALLOW_PARTIAL_AUTH
int , is partial authorization allowed (if it occurs)? |
static String |
EXTRA_AMOUNT
Long , a monetary amount |
static 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 UUID |
static String |
EXTRA_APP_PACKAGE_NAME
String , App package name |
static String |
EXTRA_APP_TRACKING_ID
int , does this intent need remote payment confirmation i.e. |
static String |
EXTRA_APPLICATION_SPECIFIC_VALUES
java.util.Map set of key/value pairs used for application specific implementations |
static String |
EXTRA_APPROVE_OFFLINE_PAYMENT_WITHOUT_PROMPT
Boolean don't prompt for confirmation of an offline payment |
static String |
EXTRA_ASK_FOR_TIP
Boolean , whether to prompt customers for tip |
static String |
EXTRA_AUTHORIZATION
Authorization , v3 Authorization object |
static String |
EXTRA_AUTHORIZATION_INCREMENT
Boolean , whether an authorization is being incremented or decremented |
static String |
EXTRA_AUTO_ACCEPT_DUPLICATES
automatically accept the customer signature
|
static String |
EXTRA_AUTO_ACCEPT_PAYMENT_CONFIRMATIONS
Boolean automatically accept payment confirmations |
static String |
EXTRA_AUTO_ACCEPT_SIGNATURE
Boolean automatically accept payment confirmations |
static String |
EXTRA_AVAILABLE
Deprecated.
|
static String |
EXTRA_AVS_POSTAL_CODE
String , postal code for use with AVS |
static String |
EXTRA_AVS_STREET_ADDRESS
String , street address for use with AVS |
static String |
EXTRA_C_TOKEN_REQUEST
Request an C-Token part of Transaction Type link #TRANSACTION_TYPE_PAYMENT} or
TRANSACTION_TYPE_AUTH
or TRANSACTION_TYPE_TOKENIZE_CARD . |
static String |
EXTRA_C_TOKEN_RESULT
Result of C-Token requested part of Transaction Type link #TRANSACTION_TYPE_PAYMENT} or
TRANSACTION_TYPE_AUTH
TRANSACTION_TYPE_TOKENIZE_CARD see TokenizeCardResponse |
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 data |
static String |
EXTRA_CARD_DATA_MESSAGE
String , the message to prompt the user |
static 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 |
static String |
EXTRA_CARD_NOT_PRESENT
Boolean , card not present, used during manual card entry |
static String |
EXTRA_CARD_NUMBER
String , a card number |
static String |
EXTRA_CASHBACK_AMOUNT
Long , the pre-selected cash back amount |
static String |
EXTRA_CASHBACK_SUGGESTIONS |
static String |
EXTRA_CLIENT_ID
String , the ID of a Client or external payment |
static String |
EXTRA_CLOSEOUT_ALLOW_OPEN_TABS
boolean , true indicates that a closeout can proceed if open tabs are found |
static String |
EXTRA_CLOSEOUT_BATCH
Batch , v3 Batch object |
static String |
EXTRA_CLOSEOUT_BATCHID
String , the UUID of a Batch object |
static String |
EXTRA_CLOVER_ITEM_ID
String , the UUID of an Item object |
static String |
EXTRA_CLOVER_LINE_ITEM_ID
String , the UUID of a LineItem object |
static String |
EXTRA_CLOVER_ORDER_ID
String , the UUID of an Order object |
static String |
EXTRA_CLOVER_PAYMENT_ID
String , the UUID of a Payment object |
static String |
EXTRA_CLOVER_SHOULD_HANDLE_RECEIPTS |
static String |
EXTRA_CLOVER_TENDER_LABEL_KEY
String , the labelKey of a Tender type |
static String |
EXTRA_CREDIT
Credit , v3 Credit object (Manual Refund) |
static String |
EXTRA_CREDIT_ID
String , the UUID of a Credit object |
static String |
EXTRA_CREDIT_REFUND
CreditRefund , v3 CreditRefund object (Reversal of Manual Refund) |
static String |
EXTRA_CURRENCY
Currency , the currency of a transaction |
static String |
EXTRA_CURRENT_SHIFT
Shift , the current employee shift |
static String |
EXTRA_CUSTOMER_ID
String , UUID of a customer |
static String |
EXTRA_CUSTOMER_TENDER
Tender , Pre-selected customer tender |
static String |
EXTRA_CUSTOMER_V3
Customer , a customer object |
static String |
EXTRA_CUSTOMERINFO
CustomerInfo , a customer object |
static String |
EXTRA_DATA_READ_MODE
A value for
EXTRA_DATA_READ_MODE data read mode for specific integration use cases. |
static String |
EXTRA_DECLINE_REASON
String , an error description |
static String |
EXTRA_DIALOG
Deprecated.
|
static String |
EXTRA_DISABLE_CASHBACK
Boolean , true will disable cashback option during secure payment |
static 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 transaction |
static String |
EXTRA_DISABLE_RESTART_TRANSACTION_WHEN_FAILED
Boolean , if true, the secure payment activity will end after a failed transaction |
static String |
EXTRA_DISABLED_TENDER_IDS
|
static String |
EXTRA_DUPLICATE_PAYMENT_CONFIRMATION
int , does this payment need remote duplicate payment confirmation |
static String |
EXTRA_ECR_MODE
Boolean flag Indicates if device supports ECR mode or not |
static String |
EXTRA_ELV_APPLICATION_LABEL
A value for
EXTRA_ELV_APPLICATION_LABEL |
static String |
EXTRA_EMPLOYEE_ID
String , the UUID of an Employee object |
static String |
EXTRA_ENABLED_RECEIPT_OPTIONS |
static String |
EXTRA_ENTERED_RECEIPT_VALUE |
static String |
EXTRA_EXTERNAL_PAYMENT_ID
String , external payment id, used for integration with other POS platforms |
static String |
EXTRA_EXTERNAL_REFERENCE_ID
String , external reference id |
static String |
EXTRA_EXTERNAL_TOKEN_ID
String , external token id |
static String |
EXTRA_FAILURE_MESSAGE
String , message shown upon failure |
static String |
EXTRA_FORCE_OFFLINE
Boolean , force payments to be accepted offline |
static String |
EXTRA_FORCE_SWIPE_PIN_ENTRY
Boolean , if only payment option will be swipe debit |
static String |
EXTRA_GERMAN_ELV
String , elv transaction type for Germany |
static String |
EXTRA_GIFT_CARD_RESPONSE
|
static String |
EXTRA_IGNORE_PAYMENT
|
static String |
EXTRA_INVOICE_ID_AVAILABLE
Boolean Flag to check if invoice feature is available for merchant |
static String |
EXTRA_INVOICE_ID_REGEX
String A regular expression to check the validity of invoice number |
static String |
EXTRA_INVOICE_LABEL
String , Invoice Label of the device |
static String |
EXTRA_INVOICE_NUMBER
String , the invoice number |
static String |
EXTRA_IS_TESTING
Deprecated.
|
static String |
EXTRA_KEYPAD_COMPLETIONS
|
static String |
EXTRA_KEYPAD_TEXT
A
String , 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_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 of LineItemPayment objects |
static 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 merchant |
static String |
EXTRA_MID
String , MID of a merchant |
static String |
EXTRA_NETWORK_FAILURE
String , indicator of a network failure |
static String |
EXTRA_NO_TIP |
static String |
EXTRA_NOTE
String , note content |
static String |
EXTRA_OBEY_AUTO_LOGOUT
Boolean , whether transaction will respect merchant's auto logout settings |
static String |
EXTRA_OFFLINE_NO_PROMPT
Boolean , allow offline payments to be accepted without an approval prompt |
static String |
EXTRA_OFFLINE_PAYMENT_CONFIRMATION
int , does this payment need remote offline payment confirmation |
static String |
EXTRA_ORDER
Order , an Order object |
static String |
EXTRA_ORDER_ID
Deprecated.
|
static 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 transaction |
static String |
EXTRA_PACKAGE
String , package name |
static String |
EXTRA_PASS_THROUGH_VALUES
java.util.Map set of key/value pairs that are passed through to the server |
static String |
EXTRA_PAYMENT
Payment , v3 Payment object |
static String |
EXTRA_PAYMENT_ID
String , the UUID of a Payment object |
static String |
EXTRA_PAYMENT_IDS
|
static String |
EXTRA_PAYMENTS
|
static String |
EXTRA_PERMISSIONS
String , the string constant of a permission |
static 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 extras |
static String |
EXTRA_QUICK_PAYMENT_TRANSACTION_ID
String , the UUID of the quick pay transaction if collected |
static String |
EXTRA_REASON
String , written explanation |
static String |
EXTRA_RECEIPT_DELIVERY_STATUS |
static String |
EXTRA_RECEIPT_DELIVERY_TYPE |
static String |
EXTRA_RECEIPT_FLAG
int , representation of bit flags from PrintJob |
static String |
EXTRA_REFUND
Refund , v3 Refund object |
static String |
EXTRA_REFUND_ID |
static String |
EXTRA_REFUND_REASON
String , merchant provided reason for refund or credit |
static String |
EXTRA_REGIONAL_EXTRAS |
static String |
EXTRA_REMOTE_PRINT
Boolean , if true printing will be delegated to remote device |
static String |
EXTRA_REMOTE_RECEIPTS |
static String |
EXTRA_REMOTE_VIEW_SIZE
String , version of one of the values from the enum Intents.RemoteViewSize |
static String |
EXTRA_REMOTE_VIEWS
RemoteViews , RemoteViews sent to Register Payment activity |
static String |
EXTRA_REQUEST_ID
String , a uuid of a request |
static 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 scanned |
static String |
EXTRA_SCAN_QR_CODE
Boolean , whether QR codes will be scanned |
static 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_TOKENIZE_CARD |
static String |
EXTRA_SHOW_CANCEL_BUTTON
Boolean , whether the launched activity should display a cancel button |
static 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 payment |
static String |
EXTRA_SHOW_SEARCH
|
static String |
EXTRA_SHOW_VOID_BUTTON
Boolean , whether to show the Void button |
static String |
EXTRA_SIGNATURE
Signature2 , payment Signature2 signature |
static String |
EXTRA_SIGNATURE_ENTRY_LOCATION
DataEntryLocation , where signatures are entered (e.g. |
static String |
EXTRA_SIGNATURE_LOCATION
the location for the customer signature
|
static String |
EXTRA_SIGNATURE_THRESHOLD
Long , what is the signature threshold for this transaction |
static String |
EXTRA_SIGNATURE_VERIFIED
Boolean , whether signature is already verified |
static 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 screen |
static String |
EXTRA_START_SCAN
Boolean , whether to start or stop barcode scanner |
static 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 amount |
static String |
EXTRA_TAXABLE_AMOUNTS
ArrayList of TaxableAmountRate objects - tax rates, and amounts to which they apply |
static String |
EXTRA_TENDER
Tender , a Tender object |
static String |
EXTRA_THEME_NAME
String Indicates name of theme to be used in station-pay/secure-pay |
static String |
EXTRA_TID
String , Terminal Id of the device |
static String |
EXTRA_TIMESTAMP |
static String |
EXTRA_TIP_AMOUNT
Long , tip amount |
static String |
EXTRA_TIP_AMOUNTS
HashMap , tip amounts |
static String |
EXTRA_TIP_CONFIRM_MODE
Boolean , whether to display confirmation of tip and total amount |
static 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 payment |
static String |
EXTRA_TIPPABLE_AMOUNT
Long , the tippable amount associated with a payment |
static String |
EXTRA_TIPS_ENABLED
Boolean , are tips enabled for this transaction |
static String |
EXTRA_TITLE
String , On-screen text |
static String |
EXTRA_TOKEN |
static String |
EXTRA_TOKEN_REQUEST
TokenRequest , token request objects |
static String |
EXTRA_TOKEN_TYPE |
static String |
EXTRA_TRANSACTION
Transaction , a Transaction object |
static String |
EXTRA_TRANSACTION_NO
Deprecated.
, internally in the SPS/SPA
|
static String |
EXTRA_TRANSACTION_SETTINGS |
static String |
EXTRA_TRANSACTION_TYPE
String , a TRANSACTION_TYPE value |
static String |
EXTRA_USE_CONNECTED_DEVICE |
static String |
EXTRA_USE_LAST_SWIPE
Boolean flag |
static 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 object |
static String |
EXTRA_VAS_SETTINGS
Vas Settings
|
static String |
EXTRA_VAS_URL_TOKENS
VAS URL customization tokens
|
static 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
|
static String |
EXTRA_VAULTED_CARD_PAYMENT
|
static String |
EXTRA_VERSION
int , the version of the service |
static String |
EXTRA_VIEWID
|
static String |
EXTRA_VOICE_AUTH_CODE
String , the voice auth code for payment by voice authorization |
static String |
EXTRA_VOID_REASON
VoidReason , v3 VoidReason object |
static String |
EXTRA_VOIDED_PAYMENTS
|
static String |
GERMAN_ELV
A value for
EXTRA_GERMAN_ELV |
static String |
GERMAN_ELV_OFFLINE
A value for
EXTRA_GERMAN_ELV |
static String |
GERMAN_ELV_ONLINE
A value for
EXTRA_GERMAN_ELV |
static String |
GERMAN_GIROCARD
A value for
EXTRA_GERMAN_ELV |
static String |
GERMAN_INFO
int , does this intent need german info |
static 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 for
EXTRA_CARD_ENTRY_METHODS , sets kiosk mode mask to ALL entry mode flags permitted |
static int |
KIOSK_MODE_CARD_ENTRY_MASK_ICC_CONTACT
A bit value for
EXTRA_CARD_ENTRY_METHODS , can be bitwise-ored with other CARD_ENTRY_METHOD values to provide entry mode mask for device in kiosk mode |
static int |
KIOSK_MODE_CARD_ENTRY_MASK_MAG_STRIPE
A bit value for
EXTRA_CARD_ENTRY_METHODS , can be bitwise-ored with other CARD_ENTRY_METHOD values to provide entry mode mask for device in kiosk mode |
static int |
KIOSK_MODE_CARD_ENTRY_MASK_MANUAL
A bit value for
EXTRA_CARD_ENTRY_METHODS , can be bitwise-ored with other CARD_ENTRY_METHOD values to provide entry mode mask for device in kiosk mode |
static int |
KIOSK_MODE_CARD_ENTRY_MASK_NFC_CONTACTLESS
A bit value for
EXTRA_CARD_ENTRY_METHODS , can be bitwise-ored with other CARD_ENTRY_METHOD values to provide entry mode mask for device in kiosk mode |
static 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
|
static String |
META_CUSTOMER_TENDER_IMAGE
int , A drawable resource ID, the image to be displayed on the customer-facing tender button |
static String |
META_MERCHANT_TENDER_IMAGE
int , A drawable resource ID, the image to be displayed on the merchant-facing tender button |
static String |
RESULT_KEYPAD_TEXT
A
String , the text entered by the user. |
static String |
SERVICE_VAS_PROVIDER
Services that implement the IVasProvider interface
|
static String |
TIP_MODE_NO_TIP
A value for
EXTRA_TIP_MODE |
static String |
TIP_MODE_ON_PAPER
A value for
EXTRA_TIP_MODE |
static String |
TIP_MODE_ON_SCREEN_AFTER_PAYMENT
A value for
EXTRA_TIP_MODE |
static String |
TIP_MODE_ON_SCREEN_BEFORE_PAYMENT
A value for
EXTRA_TIP_MODE |
static String |
TRANSACTION_TYPE_ADJUSTMENT_PAYMENT
A value for
EXTRA_TRANSACTION_TYPE |
static String |
TRANSACTION_TYPE_ADJUSTMENT_REFUND
A value for
EXTRA_TRANSACTION_TYPE |
static String |
TRANSACTION_TYPE_AUTH
A value for
EXTRA_TRANSACTION_TYPE |
static String |
TRANSACTION_TYPE_BALANCE_INQUIRY
A value for
EXTRA_TRANSACTION_TYPE |
static String |
TRANSACTION_TYPE_CAPTURE_PREAUTH
A value for
EXTRA_TRANSACTION_TYPE |
static String |
TRANSACTION_TYPE_CARD_DATA
A value for
EXTRA_TRANSACTION_TYPE |
static String |
TRANSACTION_TYPE_CASH_ADVANCE
A value for
EXTRA_TRANSACTION_TYPE |
static String |
TRANSACTION_TYPE_CREDIT
A value for
EXTRA_TRANSACTION_TYPE |
static String |
TRANSACTION_TYPE_MANUAL_REVERSAL_PAYMENT
A value for
EXTRA_TRANSACTION_TYPE |
static String |
TRANSACTION_TYPE_MANUAL_REVERSAL_REFUND
A value for
EXTRA_TRANSACTION_TYPE |
static String |
TRANSACTION_TYPE_PAYMENT
A value for
EXTRA_TRANSACTION_TYPE |
static String |
TRANSACTION_TYPE_TOKENIZE_CARD
A value for
EXTRA_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 for
EXTRA_TRANSACTION_TYPE |
static String |
TRANSACTION_TYPE_VERIFY_CARD
A value for
EXTRA_TRANSACTION_TYPE , a transaction that allows an app to verify whether a card is valid. |
Constructor and Description |
---|
Intents() |
public static final String ACTION_START_REGISTER
Extras passed:
EXTRA_ORDER_ID
- The UUID of the order opened in RegisterEXTRA_CUSTOMER_V3
- a customer object to be associated with the orderResult data includes:
public static final String ACTION_ITEM_SELECT
Extras passed:
EXTRA_ORDER_ID
- The UUID of the order to be modified (Required)Result data includes:
public static final String ACTION_START_PRINT_RECEIPTS
Extras passed:
EXTRA_ORDER_ID
- The UUID of the target order (Required)Result data includes:
public static final String ACTION_START_CUSTOMER_PROFILE
Extras passed:
EXTRA_CUSTOMER_ID
- The UUID of the target customer (Required)Result data includes:
public static final String ACTION_CLOVER_PAY
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 be TRANSACTION_TYPE_CREDIT
for refund, the default is TRANSACTION_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 trueResult 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 successfullypublic static final String ACTION_MODIFY_ORDER
See: Example Usage
Extras passed:
EXTRA_ORDER_ID
- the UUID of the order about to paid forResult data must include:
public static final String ACTION_MODIFY_AMOUNT
EXTRA_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 typeResult data must include:
EXTRA_AMOUNT
- the amount the amount resulting from your activity@Deprecated public static final String ACTION_MANUAL_PAY
ACTION_CLOVER_PAY
instead@Deprecated public static final String ACTION_MANUAL_REFUND
ACTION_CLOVER_PAY
insteadpublic static final String ACTION_START_APP_DETAIL
Extras passed (Must include either EXTRA_APP_PACKAGE_NAME
or EXTRA_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 defaultIf user changes to a new subscription tier, result data includes:
EXTRA_RESULT_SUBSCRIPTION_ID
- the UUID of the subscription tier installed by userpublic static final String ACTION_START_ORDER_MANAGE
Extras passed:
EXTRA_ORDER_ID
- the UUID of the order to be shown (REQUIRED)Result data includes:
public static final String ACTION_ADD_TIP
Extras passed:
EXTRA_PAYMENT_ID
- UUID of payment associated with tipEXTRA_TITLE
- label on the tip activity's back buttonResult data includes:
public static final String ACTION_CUSTOMER_ADD_TIP
CustomerMode#disable
in
onActivityResult
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 successfullypublic static final String ACTION_CLOSEOUT
Extras passed:
Result data includes:
public static final String ACTION_CLOSEOUT_BATCH
Extras 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:
public static final String ACTION_CLOSEOUT_BATCH_SCHEDULED
Extras passed:
EXTRA_CLOSEOUT_BATCH
the scheduled batch, only set when scheduled EXTRA_FAILURE_MESSAGE
a message indicating status when scheduling fails public static final String ACTION_START_TRANSACTION_DETAIL
Extras passed (Must include one of the following: EXTRA_PAYMENT
or EXTRA_CREDIT
or EXTRA_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 shownResult data includes:
public static final String ACTION_REQUEST_PAYMENT_REMOTE_VIEWS
Extras passed:
EXTRA_VIEWID
- unique id to be used with ACTION_UPDATE_PAYMENT_REMOTE_VIEWS
EXTRA_ORDER_ID
- order being processedEXTRA_REMOTE_VIEW_SIZE
- for the size desiredResult data must include:
ACTION_UPDATE_PAYMENT_REMOTE_VIEWS
public static final String ACTION_UPDATE_PAYMENT_REMOTE_VIEWS
ACTION_REQUEST_PAYMENT_REMOTE_VIEWS
to receive views to be
displayed on the tender screen
Extras passed:
EXTRA_REMOTE_VIEWS
EXTRA_VIEWID
unique id passed by ACTION_REQUEST_PAYMENT_REMOTE_VIEWS
Result data includes:
public static final String ACTION_AUTHENTICATE_EMPLOYEE
EXTRA_EMPLOYEE_ID
with the employee idEXTRA_VALIDATE_ROLE
with boolean value trueEXTRA_PERMISSIONS
AccountRole
s specified in EXTRA_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 by EXTRA_PERMISSIONS
if validating some other packageResult data includes:
EXTRA_EMPLOYEE_ID
String of the authenticated employee id if successfulResult codes:
Activity.RESULT_OK
- authenticated successfullyActivity.RESULT_CANCELED
- did not authenticate successfullypublic static final String ACTION_REQUEST_ROLE
ACTION_AUTHENTICATE_EMPLOYEE
with EXTRA_ACCOUNT_ROLES
.public static final String ACTION_SECURE_PAY
Platform2.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 by EXTRA_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 by EXTRA_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 by EXTRA_TRANSACTION_SETTINGS
) if only payment option will be swipe debit, default falseEXTRA_DISABLE_RESTART_TRANSACTION_WHEN_FAILED
- (deprecated - replaced by EXTRA_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.
See ACTION_CUSTOMER_TENDER
.EXTRA_TRANSACTION_SETTINGS
- pass transaction settings as a single objectResult data includes:
EXTRA_PAYMENT
- created paymentEXTRA_PAYMENT_ID
- created payment's UUIDEXTRA_VAS_PAYLOAD
- any vas payload read during sessionResult codes:
Activity.RESULT_OK
- payment successfulActivity.RESULT_CANCELED
- payment not successful (Cancel button)public static final String ACTION_STATION_PAY
public static final String ACTION_STATION_SECURE_PAY
public static final String SERVICE_VAS_PROVIDER
public static final String ACTION_SECURE_CARD_DATA
Platform2.Feature.SECURE_PAYMENTS
.
Extras passed:
EXTRA_TRANSACTION_TYPE
- must be set to TRANSACTION_TYPE_CARD_DATA
(Required)EXTRA_CARD_DATA_MESSAGE
- written explanation shown on card entry screenEXTRA_CARD_ENTRY_METHODS
- allowed payment types, default all allowedResult data includes:
Result codes:
public static final String ACTION_SECURE_BALANCE_CHECK
Platform2.Feature.SECURE_PAYMENTS
.
Extras passed:
EXTRA_TRANSACTION_TYPE
- must be set to TRANSACTION_TYPE_BALANCE_INQUIRY
(Required)EXTRA_CARD_ENTRY_METHODS
- allowed payment types, default all allowedResult data includes:
EXTRA_PAYMENT
- payment object with balance info populated if supported by card/returned by gatewayEXTRA_CARD_DATA
- captured card dataResult codes:
Activity.RESULT_OK
- balance request successfulActivity.RESULT_CANCELED
- balance request not successfulpublic static final String ACTION_CUSTOMER_TENDER
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 transactionResult data must include:
EXTRA_AMOUNT
- the approved transaction amountEXTRA_TIP_AMOUNT
- the approved transaction's tip amountEXTRA_CLIENT_ID
- the client ID / external payment IDEXTRA_NOTE
- the payment noteResult codes:
Activity.RESULT_OK
- payment successfulActivity.RESULT_CANCELED
- payment not successfulpublic static final String ACTION_MERCHANT_TENDER
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 transactionResult data includes:
EXTRA_AMOUNT
- the approved transaction amount EXTRA_CLIENT_ID
- the client ID / external payment IDEXTRA_NOTE
- the payment noteEXTRA_TIP_AMOUNT
- the transaction's tip amountResult codes:
Activity.RESULT_OK
- payment successfulActivity.RESULT_CANCELED
- payment not successfulpublic static final String ACTION_REFUND
Extras 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:
EXTRA_AMOUNT
EXTRA_ORDER_ID
EXTRA_PAYMENT_ID
EXTRA_LINE_ITEM_IDS
Activity.RESULT_OK
- refund processedActivity.RESULT_CANCELED
- refund canceled@Deprecated public static final String ACTION_SCAN
BarcodeScanner
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 truepublic static final String ACTION_APP_INSTALL_DONE
<receiver
android:name=".MyAppInstalledReceiver"
android:exported="true">
<intent-filter>
<action android:name="com.clover.intent.action.APP_INSTALL_DONE"/>
</intent-filter>
</receiver>
Apps are restricted from performing blocking or otherwise long running operations in
a receiver's BroadcastReceiver.onReceive(Context, Intent)
.
If you need to perform such work as a result on this intent use
JobIntentService
from the support or androidx library.
You can find an example of this in AppInstallDoneService
in
the SDK Examples.
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/.MyAppInstalledReceiverThis broadcast intent is only received by the app that was installed. You will not receive this intent when other apps are installed or updated.
public static final String ACTION_APP_PRE_UNINSTALL
IntentService
's
IntentService.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>
This is only invoked for apps installed via the Clover app store, it is not invoked
on development devices when adb uninstall is used. To test during development you
may invoke this manually with the following command:
adb shell am startservice -a com.clover.intent.action.APP_PRE_UNINSTALL -n your.packagename/.MyCleanupService
public static final String ACTION_PAY
ACTION_MERCHANT_TENDER
and ACTION_CUSTOMER_TENDER
public static final String ACTION_BILL_SPLIT
public static final String ACTION_GIFT_CARD_TX
public static final String ACTION_STORE_CREDIT
public static final String ACTION_START_PIN_ACTIVITY
public static final String ACTION_START_SELECT_ACCOUNT_ACTIVITY
public static final String EXTRA_TRANSACTION
Transaction
, a Transaction object@Deprecated public static final String EXTRA_ORDER_ID
public static final String EXTRA_ORDER
Order
, an Order objectpublic static final String EXTRA_CLOVER_ORDER_ID
String
, the UUID of an Order objectpublic static final String EXTRA_CLOSEOUT_ALLOW_OPEN_TABS
boolean
, true indicates that a closeout can proceed if open tabs are foundpublic static final String EXTRA_CLOSEOUT_BATCHID
String
, the UUID of a Batch objectpublic static final String EXTRA_CLOVER_LINE_ITEM_ID
String
, the UUID of a LineItem objectpublic static final String EXTRA_CLOVER_ITEM_ID
String
, the UUID of an Item objectpublic static final String EXTRA_CLOVER_PAYMENT_ID
String
, the UUID of a Payment objectpublic static final String EXTRA_CLOVER_TENDER_LABEL_KEY
String
, the labelKey of a Tender typepublic static final String EXTRA_AMOUNT
Long
, a monetary amountpublic static final String EXTRA_INVOICE_NUMBER
String
, the invoice numberpublic static final String EXTRA_TIPPABLE_AMOUNT
Long
, the tippable amount associated with a paymentpublic static final String EXTRA_TIP_SUGGESTIONS
String
, the json for the tip suggestions associated with a paymentpublic static final String EXTRA_CURRENCY
Currency
, the currency of a transactionpublic static final String EXTRA_MERCHANT_ID
String
, the UUID of a merchantpublic static final String EXTRA_MID
String
, MID of a merchantpublic static final String EXTRA_TID
String
, Terminal Id of the devicepublic static final String EXTRA_INVOICE_LABEL
String
, Invoice Label of the devicepublic static final String EXTRA_PAYMENT_ID
String
, the UUID of a Payment objectpublic static final String EXTRA_QUICK_PAYMENT_TRANSACTION_ID
String
, the UUID of the quick pay transaction if collectedpublic static final String EXTRA_CREDIT_ID
String
, the UUID of a Credit objectpublic static final String EXTRA_PAYMENT_IDS
public static final String EXTRA_NOTE
String
, note contentpublic static final String EXTRA_LINE_ITEM_IDS
public static final String EXTRA_LINE_ITEM_PAYMENTS
ArrayList
of LineItemPayment
objectspublic static final String EXTRA_DISABLED_TENDER_IDS
public static final String EXTRA_ASK_FOR_TIP
Boolean
, whether to prompt customers for tippublic static final String EXTRA_CUSTOMER_ID
String
, UUID of a customerpublic static final String EXTRA_CUSTOMER_V3
Customer
, a customer objectpublic static final String EXTRA_CUSTOMERINFO
CustomerInfo
, a customer objectpublic static final String EXTRA_EMPLOYEE_ID
String
, the UUID of an Employee objectpublic static final String EXTRA_ACCOUNT_ROLES
ArrayList
of AccountRole
.public static final String EXTRA_CLIENT_ID
String
, the ID of a Client or external paymentpublic static final String EXTRA_TIP_AMOUNT
Long
, tip amountpublic static final String EXTRA_TIP_AMOUNTS
HashMap
, tip amountspublic static final String EXTRA_TIP_CONFIRM_MODE
Boolean
, whether to display confirmation of tip and total amountpublic static final String EXTRA_APP
public static final String EXTRA_APP_PACKAGE_NAME
String
, App package namepublic static final String EXTRA_APP_ID
String
, App UUIDpublic static final String EXTRA_TARGET_SUBSCRIPTION_ID
String
, UUID for target subscription (during an upgrade flow)public static final String EXTRA_OBEY_AUTO_LOGOUT
Boolean
, whether transaction will respect merchant's auto logout settingspublic static final String EXTRA_RESULT_SUBSCRIPTION_ID
String
, UUID for result subscription (during an upgrade flow)public static final String EXTRA_ACCOUNT
Account
, the Clover account associated with the action or broadcastpublic static final String EXTRA_VERSION
int
, the version of the servicepublic static final String EXTRA_REQUIRES_REMOTE_CONFIRMATION
int
, does this intent need remote payment confirmation i.e. RemotePaypublic static final String EXTRA_REQUIRES_FINAL_REMOTE_APPROVAL
int
, does this intent need remote payment confirmation i.e. RemotePaypublic static final String EXTRA_SKIP_ELV_LIMIT_OVERRIDE
Boolean
, does this intent skip the ELV override screen i.e. RemotePaypublic static final String EXTRA_APP_TRACKING_ID
int
, does this intent need remote payment confirmation i.e. RemotePaypublic static final String EXTRA_ALLOW_PARTIAL_AUTH
int
, is partial authorization allowed (if it occurs)?public static final String GERMAN_INFO
int
, does this intent need german infopublic static final String CASHADVANCE_CUSTOMER_IDENTIFICATION
CashAdvanceCustomerIdentification
object used for CashAdvance paymentspublic static final String EXTRA_OFFLINE_PAYMENT_CONFIRMATION
int
, does this payment need remote offline payment confirmationpublic static final String EXTRA_DUPLICATE_PAYMENT_CONFIRMATION
int
, does this payment need remote duplicate payment confirmationpublic static final String EXTRA_REMOTE_VIEWS
RemoteViews
, RemoteViews sent to Register Payment activitypublic static final String EXTRA_VIEWID
public static final String EXTRA_REMOTE_VIEW_SIZE
String
, version of one of the values from the enum Intents.RemoteViewSize
public static final String EXTRA_REASON
String
, written explanationpublic static final String EXTRA_DIALOG
public static final String EXTRA_PERMISSIONS
String
, the string constant of a permissionpublic static final String EXTRA_PACKAGE
String
, package namepublic static final String EXTRA_ROLE
AccountRole
, employee role (admin, manager or employee)public static final String EXTRA_TITLE
String
, On-screen textpublic static final String EXTRA_SHOW_CANCEL_BUTTON
Boolean
, whether the launched activity should display a cancel buttonpublic static final String EXTRA_VALIDATE_ROLE
Boolean
, whether the launched activity should validate roles instead of permissions (Required)public static final String EXTRA_START_SCAN
Boolean
, whether to start or stop barcode scannerpublic 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.public static final String EXTRA_SHOW_MERCHANT_PREVIEW
Boolean
, whether to show scanner preview video (merchant facing mode only)public static final String EXTRA_SHOW_CUSTOMER_PREVIEW
Boolean
, whether to show scanner preview video (customer facing mode only)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.public static final String EXTRA_REQUEST_ID
String
, a uuid of a requestpublic static final String EXTRA_SCAN_QR_CODE
Boolean
, whether QR codes will be scannedpublic static final String EXTRA_SCAN_1D_CODE
Boolean
, whether 1D codes will be scannedpublic 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.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.public static final String EXTRA_SCAN_X
public static final String EXTRA_SCAN_Y
public static final String EXTRA_TIMESTAMP
public static final String EXTRA_SDK_NAME
public static final String EXTRA_SDK_VERSION
public static final String EXTRA_MD5_HASH
public static final String EXTRA_SCANNER_FACING
Bundle
passed to
BarcodeScanner#startScan(Bundle)
.
The value passed must be one of the results from
BarcodeScanner#getAvailable()
. The result of passing a value that is not in
the result of BarcodeScanner#getAvailable()
is undefined.
If not present, this defaults to either BarcodeScanner#BARCODE_SCANNER_FACING_DUAL
or
BarcodeScanner#BARCODE_SCANNER_FACING_MERCHANT
,
depending on what is available on the device.BarcodeScanner#getAvailable()
,
BarcodeScanner#startScan(Bundle)
,
BarcodeScanner#BARCODE_SCANNER_FACING_DUAL
,
BarcodeScanner#BARCODE_SCANNER_FACING_MERCHANT
,
BarcodeScanner#BARCODE_SCANNER_FACING_CUSTOMER
,
Constant Field Valuespublic static final String EXTRA_ALLOW_FIRE
Boolean
, whether order should respect merchant's setting for firing after paymentpublic static final String EXTRA_CURRENT_SHIFT
Shift
, the current employee shiftpublic static final String EXTRA_TAX_AMOUNT
Long
, a tax amountpublic static final String EXTRA_SERVICE_CHARGE_AMOUNT
public static final String EXTRA_TAXABLE_AMOUNTS
ArrayList
of TaxableAmountRate
objects - tax rates, and amounts to which they applypublic 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 allowedpublic static final String EXTRA_DISABLE_CASHBACK
Boolean
, true will disable cashback option during secure paymentpublic static final String EXTRA_VOICE_AUTH_CODE
String
, the voice auth code for payment by voice authorizationpublic static final String EXTRA_IS_TESTING
public static final String EXTRA_TRANSACTION_TYPE
String
, a TRANSACTION_TYPE valuepublic static final String TRANSACTION_TYPE_PAYMENT
EXTRA_TRANSACTION_TYPE
public static final String TRANSACTION_TYPE_CREDIT
EXTRA_TRANSACTION_TYPE
public static final String TRANSACTION_TYPE_AUTH
EXTRA_TRANSACTION_TYPE
public static final String TRANSACTION_TYPE_CARD_DATA
EXTRA_TRANSACTION_TYPE
public static final String TRANSACTION_TYPE_BALANCE_INQUIRY
EXTRA_TRANSACTION_TYPE
public static final String TRANSACTION_TYPE_CASH_ADVANCE
EXTRA_TRANSACTION_TYPE
public static final String TRANSACTION_TYPE_MANUAL_REVERSAL_PAYMENT
EXTRA_TRANSACTION_TYPE
public static final String TRANSACTION_TYPE_ADJUSTMENT_PAYMENT
EXTRA_TRANSACTION_TYPE
public static final String TRANSACTION_TYPE_MANUAL_REVERSAL_REFUND
EXTRA_TRANSACTION_TYPE
public static final String TRANSACTION_TYPE_ADJUSTMENT_REFUND
EXTRA_TRANSACTION_TYPE
public static final String TRANSACTION_TYPE_CAPTURE_PREAUTH
EXTRA_TRANSACTION_TYPE
public static final String TRANSACTION_TYPE_VAS_DATA
EXTRA_TRANSACTION_TYPE
public static final String TRANSACTION_TYPE_VERIFY_CARD
EXTRA_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_CARD EXTRA_EXTERNAL_REFERENCE_ID
- used for passing in an external reference id which gets stored as part of the transaction at the server EXTRA_TOKEN_REQUEST
- created token request, see TokenRequest
public static final String TRANSACTION_TYPE_TOKENIZE_CARD
EXTRA_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_CARD EXTRA_EXTERNAL_REFERENCE_ID
- used for passing in an external reference id which gets stored as part of the transaction at the server EXTRA_TOKEN_REQUEST
- token request object created, see TokenRequest
public static final String EXTRA_EXTERNAL_REFERENCE_ID
String
, external reference idpublic static final String EXTRA_EXTERNAL_TOKEN_ID
String
, external token idpublic static final String EXTRA_TOKEN_REQUEST
TokenRequest
, token request objectspublic static final String EXTRA_CARD_NOT_PRESENT
Boolean
, card not present, used during manual card entrypublic static final String EXTRA_ALLOW_OFFLINE_ACCEPTANCE
Boolean
, allow payments to be accepted offlinepublic static final String EXTRA_OFFLINE_NO_PROMPT
Boolean
, allow offline payments to be accepted without an approval promptpublic static final String EXTRA_FORCE_OFFLINE
Boolean
, force payments to be accepted offlinepublic static final String EXTRA_AVS_STREET_ADDRESS
String
, street address for use with AVSpublic static final String EXTRA_AVS_POSTAL_CODE
String
, postal code for use with AVSpublic static final String EXTRA_CARD_DATA
PaymentRequestCardDetails
, payment card datapublic static final String EXTRA_CARD_DATA_MESSAGE
String
, the message to prompt the userpublic static final String EXTRA_CASHBACK_AMOUNT
Long
, the pre-selected cash back amountpublic static final String EXTRA_REMOTE_PRINT
Boolean
, if true printing will be delegated to remote devicepublic static final String EXTRA_TRANSACTION_NO
String
, payment transaction numberpublic static final String EXTRA_FORCE_SWIPE_PIN_ENTRY
Boolean
, if only payment option will be swipe debitpublic static final String EXTRA_DISABLE_RESTART_TRANSACTION_WHEN_FAILED
Boolean
, if true, the secure payment activity will end after a failed transactionpublic static final String EXTRA_EXTERNAL_PAYMENT_ID
String
, external payment id, used for integration with other POS platformspublic static final String EXTRA_VAULTED_CARD
public static final String EXTRA_DECLINE_REASON
String
, an error descriptionpublic static final String EXTRA_TENDER
Tender
, a Tender objectpublic static final String EXTRA_CUSTOMER_TENDER
Tender
, Pre-selected customer tenderpublic static final String EXTRA_CARD_NUMBER
String
, a card numberpublic static final String EXTRA_IGNORE_PAYMENT
public static final String EXTRA_GIFT_CARD_RESPONSE
public static final String EXTRA_VAULTED_CARD_PAYMENT
public static final String EXTRA_FAILURE_MESSAGE
String
, message shown upon failurepublic static final String EXTRA_NETWORK_FAILURE
String
, indicator of a network failurepublic static final String EXTRA_ORIGINATING_TRANSACTION
CardTransaction
, originating transactionpublic static final String EXTRA_ORIGINATING_PAYMENT
Payment
, originating payment (applies to refunds, required for Interac refunds)public static final String EXTRA_ORIGINATING_CREDIT
Credit
, originating credit (applies to reversal, required for Nexo credit reversal)public static final int CARD_ENTRY_METHOD_MAG_STRIPE
EXTRA_CARD_ENTRY_METHODS
, can be bitwise-ored with other CARD_ENTRY_METHOD valuespublic static final int CARD_ENTRY_METHOD_ICC_CONTACT
EXTRA_CARD_ENTRY_METHODS
, can be bitwise-ored with other CARD_ENTRY_METHOD valuespublic static final int CARD_ENTRY_METHOD_NFC_CONTACTLESS
EXTRA_CARD_ENTRY_METHODS
, can be bitwise-ored with other CARD_ENTRY_METHOD valuespublic static final int CARD_ENTRY_METHOD_MANUAL
EXTRA_CARD_ENTRY_METHODS
, can be bitwise-ored with other CARD_ENTRY_METHOD valuespublic static final int CARD_ENTRY_METHOD_VAULTED_CARD
EXTRA_CARD_ENTRY_METHODS
, this value should be used exclusively if Vaulted Card payment is intended for headless modepublic static final int CARD_ENTRY_METHOD_ALL
EXTRA_CARD_ENTRY_METHODS
, all card entry methods.public static final int KIOSK_MODE_CARD_ENTRY_MASK_SUPPLIED
public static final int KIOSK_MODE_CARD_ENTRY_MASK_MAG_STRIPE
EXTRA_CARD_ENTRY_METHODS
, can be bitwise-ored with other CARD_ENTRY_METHOD values to provide entry mode mask for device in kiosk modepublic static final int KIOSK_MODE_CARD_ENTRY_MASK_ICC_CONTACT
EXTRA_CARD_ENTRY_METHODS
, can be bitwise-ored with other CARD_ENTRY_METHOD values to provide entry mode mask for device in kiosk modepublic static final int KIOSK_MODE_CARD_ENTRY_MASK_NFC_CONTACTLESS
EXTRA_CARD_ENTRY_METHODS
, can be bitwise-ored with other CARD_ENTRY_METHOD values to provide entry mode mask for device in kiosk modepublic static final int KIOSK_MODE_CARD_ENTRY_MASK_MANUAL
EXTRA_CARD_ENTRY_METHODS
, can be bitwise-ored with other CARD_ENTRY_METHOD values to provide entry mode mask for device in kiosk modepublic static final int KIOSK_MODE_CARD_ENTRY_MASK_ALL
EXTRA_CARD_ENTRY_METHODS
, sets kiosk mode mask to ALL entry mode flags permittedpublic static final String EXTRA_PAYMENT
Payment
, v3 Payment objectpublic static final String EXTRA_VAS_PAYLOAD
VasPayload
, v3 VasPayload objectpublic static final String EXTRA_CLOSEOUT_BATCH
Batch
, v3 Batch objectpublic static final String EXTRA_PAYMENTS
public static final String EXTRA_VOIDED_PAYMENTS
public static final String EXTRA_VOID_REASON
VoidReason
, v3 VoidReason objectpublic static final String EXTRA_REFUND_REASON
String
, merchant provided reason for refund or creditpublic static final String EXTRA_CREDIT
Credit
, v3 Credit object (Manual Refund)public static final String EXTRA_REFUND
Refund
, v3 Refund objectpublic static final String EXTRA_CREDIT_REFUND
CreditRefund
, v3 CreditRefund object (Reversal of Manual Refund)public static final String EXTRA_AUTHORIZATION
Authorization
, v3 Authorization objectpublic static final String EXTRA_AUTHORIZATION_INCREMENT
Boolean
, whether an authorization is being incremented or decrementedpublic static final String EXTRA_SHOW_REMAINING
Boolean
, whether to show amount remaining after paymentpublic static final String EXTRA_SHOW_VOID_BUTTON
Boolean
, whether to show the Void buttonpublic static final String EXTRA_SIGNATURE_VERIFIED
Boolean
, whether signature is already verifiedpublic static final String EXTRA_SIGNATURE
Signature2
, payment Signature2 signaturepublic static final String EXTRA_PRINT_RECEIPT_ONLY
Boolean
, print receipt extraspublic static final String EXTRA_RECEIPT_FLAG
int
, representation of bit flags from PrintJob
public static final String EXTRA_VAS_SETTINGS
public static final String EXTRA_VAS_URL_TOKENS
public static final String EXTRA_TRANSACTION_SETTINGS
public static final String EXTRA_TIPS_ENABLED
Boolean
, are tips enabled for this transactionpublic static final String EXTRA_DISABLE_RECEIPT_OPTIONS
Boolean
, is the receipt options screen disabled for this transactionpublic static final String EXTRA_PASS_THROUGH_VALUES
java.util.Map
set of key/value pairs that are passed through to the serverpublic static final String EXTRA_APPLICATION_SPECIFIC_VALUES
java.util.Map
set of key/value pairs used for application specific implementationspublic static final String EXTRA_API_TIP_PREFER_ON_SCREEN
public static final String EXTRA_API_SIGNATURE_PREFER_ON_SCREEN
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 transactionpublic static final String TIP_MODE_ON_SCREEN_BEFORE_PAYMENT
EXTRA_TIP_MODE
public static final String TIP_MODE_ON_SCREEN_AFTER_PAYMENT
EXTRA_TIP_MODE
public static final String TIP_MODE_ON_PAPER
EXTRA_TIP_MODE
public static final String TIP_MODE_NO_TIP
EXTRA_TIP_MODE
public static final String EXTRA_SIGNATURE_ENTRY_LOCATION
DataEntryLocation
, where signatures are entered (e.g. on screen, on paper, none) for this transactionpublic static final String DATA_ENTRY_LOCATION_ON_SCREEN
EXTRA_SIGNATURE_ENTRY_LOCATION
public static final String DATA_ENTRY_LOCATION_ON_PAPER
EXTRA_SIGNATURE_ENTRY_LOCATION
public static final String DATA_ENTRY_LOCATION_NONE
EXTRA_SIGNATURE_ENTRY_LOCATION
public static final String EXTRA_SIGNATURE_THRESHOLD
Long
, what is the signature threshold for this transactionpublic static final String EXTRA_GERMAN_ELV
String
, elv transaction type for Germanypublic static final String GERMAN_ELV
EXTRA_GERMAN_ELV
public static final String GERMAN_ELV_ONLINE
EXTRA_GERMAN_ELV
public static final String GERMAN_ELV_OFFLINE
EXTRA_GERMAN_ELV
public static final String GERMAN_GIROCARD
EXTRA_GERMAN_ELV
public static final String EXTRA_ELV_APPLICATION_LABEL
EXTRA_ELV_APPLICATION_LABEL
public static final String CARD_DATA_READ_MODE_ENHANCED_CVV
public static final String EXTRA_DATA_READ_MODE
EXTRA_DATA_READ_MODE
data read mode for specific integration use cases. supported value(s):
CARD_DATA_READ_MODE_ENHANCED_CVV
public static final String ACTION_ORDER_CREATED
Extras passed:
EXTRA_CLOVER_ORDER_ID
- the UUID of created order (note that this order may or may not be saved) public static final String ACTION_LINE_ITEM_ADDED
Extras passed:
EXTRA_CLOVER_LINE_ITEM_ID
- the UUID of the created LineItemEXTRA_CLOVER_ITEM_ID
- the UUID of the Item associated with the LineItemEXTRA_CLOVER_ORDER_ID
- the UUID of the order associated with the LineItempublic static final String ACTION_PAYMENT_PROCESSED
Extras 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 Paymentpublic static final String ACTION_ORDER_SAVED
Extras passed:
EXTRA_CLOVER_ORDER_ID
- the UUID of saved Orderpublic static final String ACTION_ACTIVE_REGISTER_ORDER
Extras passed:
EXTRA_ORDER_ID
- the UUID of the active order in Register, or null if there is no longer an active order public static final String ACTION_V1_ACTIVE_PAY_ORDER
Extras passed:
EXTRA_ORDER_ID
- the UUID of the active order in Pay, or null if there is no longer an active order public static final String ACTION_V1_ORDER_BUILD_START
Extras passed:
EXTRA_ORDER_ID
- the UUID of the order being builtpublic static final String ACTION_V1_ORDER_BUILD_STOP
Extras passed:
EXTRA_ORDER_ID
- the UUID of the order that is no longer being builtpublic static final String ACTION_V1_PAY_BUILD_SHOW
Extras passed:
EXTRA_ORDER_ID
- the UUID of the order active in the PayActivitypublic static final String ACTION_V1_PAY_BUILD_HIDE
Extras passed:
EXTRA_ORDER_ID
- the UUID of the order that is no longer active in the PayActivitypublic static final String ACTION_V1_PAY_BUILD_START
Extras passed:
EXTRA_ORDER_ID
- the UUID of the order associated with the payment now being builtpublic static final String ACTION_V1_PAY_BUILD_STOP
Extras passed:
EXTRA_ORDER_ID
- the UUID of the order associated with the payment that is no longer being builtpublic static final String ACTION_V1_PAY_EXECUTE_START
Extras passed:
EXTRA_ORDER_ID
- the UUID of the order associated with the payment that is now being executedpublic static final String ACTION_V1_PAY_EXECUTE_STOP
Extras passed:
EXTRA_ORDER_ID
- the UUID of the order associated with the payment that is no longer being executedpublic static final String ACTION_V1_CUSTOMER_IDENTIFIED
Extras passed:
EXTRA_CUSTOMERINFO
- the RemoteCustomer object that was identified. (Required)public static final String EXTRA_AVAILABLE
public static final String EXTRA_SHOW_SEARCH
public static final String META_CUSTOMER_TENDER_IMAGE
int
, A drawable resource ID, the image to be displayed on the customer-facing tender buttonpublic static final String META_MERCHANT_TENDER_IMAGE
int
, A drawable resource ID, the image to be displayed on the merchant-facing tender buttonpublic static final String EXTRA_USE_LAST_SWIPE
Boolean
flagpublic static final String EXTRA_ECR_MODE
Boolean
flag Indicates if device supports ECR mode or notpublic static final String EXTRA_THEME_NAME
String
Indicates name of theme to be used in station-pay/secure-paypublic 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 availablepublic static final String EXTRA_INVOICE_ID_REGEX
String
A regular expression to check the validity of invoice numberpublic static final String EXTRA_INVOICE_ID_AVAILABLE
Boolean
Flag to check if invoice feature is available for merchantpublic static final String ACTION_KEYPAD
RESULT_KEYPAD_TEXT
The type of keypad is selected by setting the extra EXTRA_KEYPAD_TYPE
to either
KEYPAD_TYPE_NUMERIC
, KEYPAD_TYPE_EMAIL
, or
KEYPAD_TYPE_PHONESMS
. The default is KEYPAD_TYPE_NUMERIC
if not
specified.
To pre-populate the text set the extra EXTRA_KEYPAD_TYPE
. This is optional.
To show the user a list of text completions to the user set the extra
EXTRA_KEYPAD_COMPLETIONS
. This is optional.public static final int KEYPAD_TYPE_NUMERIC
EXTRA_KEYPAD_TYPE
.public static final int KEYPAD_TYPE_EMAIL
EXTRA_KEYPAD_TYPE
.public static final int KEYPAD_TYPE_PHONESMS
EXTRA_KEYPAD_TYPE
.public static final String EXTRA_KEYPAD_COMPLETIONS
ArrayList
of String
, 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 using
Bundle.putStringArrayList(String, ArrayList)
.public static final String EXTRA_KEYPAD_TYPE
KEYPAD_TYPE_NUMERIC
, or
KEYPAD_TYPE_EMAIL
, or KEYPAD_TYPE_PHONESMS
.
This is optional and defaults to KEYPAD_TYPE_NUMERIC
if not specified.public static final String EXTRA_KEYPAD_TEXT
String
, the initial text to populate into the edit area.
This is optional and defaults to the empty string if not specified.public static final String RESULT_KEYPAD_TEXT
String
, 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 is Activity.RESULT_OK
.
The entire content of the edit text is returned here, as a string. This includes
any initial text provided via EXTRA_KEYPAD_TEXT
(that wasn't edited away by the
user).public static final String EXTRA_ORIGINATING_PAYMENT_PACKAGE
public static final String EXTRA_DISABLE_CREDIT_SURCHARGE
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.public static final String EXTRA_MANUAL_CARD_ENTRY_BYPASS_MODE
public static final String EXTRA_ALLOW_MANUAL_CARD_ENTRY_ON_MFD
public static final String EXTRA_MANUAL_CARD_PAN
public static final String EXTRA_MANUAL_CARD_CVV
public static final String EXTRA_MANUAL_CARD_EXPIRY
public static final String EXTRA_AUTO_ACCEPT_PAYMENT_CONFIRMATIONS
Boolean
automatically accept payment confirmationspublic static final String EXTRA_AUTO_ACCEPT_SIGNATURE
Boolean
automatically accept payment confirmationspublic static final String EXTRA_SKIP_RECEIPT_SCREEN
Boolean
skip the display of the receipt screenpublic static final String EXTRA_APPROVE_OFFLINE_PAYMENT_WITHOUT_PROMPT
Boolean
don't prompt for confirmation of an offline paymentpublic static final String EXTRA_ALLOW_OFFLINE_PAYMENT
Boolean
allow offline payments even if the merchant isn't configured to accept thempublic static final String EXTRA_SIGNATURE_LOCATION
public static final String EXTRA_REFUND_ID
public static final String EXTRA_DISABLE_CLOVER_PRINTING
public static final String EXTRA_AUTO_ACCEPT_DUPLICATES
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.public static final String EXTRA_C_TOKEN_RESULT
TRANSACTION_TYPE_AUTH
TRANSACTION_TYPE_TOKENIZE_CARD
see TokenizeCardResponse
public static final String EXTRA_C_TOKEN_REQUEST
TRANSACTION_TYPE_AUTH
or TRANSACTION_TYPE_TOKENIZE_CARD
. A Valid Api access token must be set on TokenizeCardRequest
which can be
obtained from the merchant dashboardpublic static final String EXTRA_NO_TIP
public static final String EXTRA_REVERSE_PAYMENT_RESULT
public static final String EXTRA_REGIONAL_EXTRAS
public static final String EXTRA_SUPPRESS_CONFIRMATION
public static final String EXTRA_USE_LEGACY_VAULT_CARD
public static final String EXTRA_TOKEN_TYPE
public static final String EXTRA_SHOULD_TOKENIZE_CARD
public static final String EXTRA_TOKEN
public static final String EXTRA_CARD
public static final String EXTRA_RETURN_FULL_CARD_DATA
public static final String EXTRA_USE_CONNECTED_DEVICE
public static final String EXTRA_RECEIPT_DELIVERY_STATUS
public static final String EXTRA_RECEIPT_DELIVERY_TYPE
public static final String EXTRA_CLOVER_SHOULD_HANDLE_RECEIPTS
public static final String EXTRA_SELECTED_RECEIPT_OPTION
public static final String EXTRA_ENABLED_RECEIPT_OPTIONS
public static final String EXTRA_ENTERED_RECEIPT_VALUE
public static final String EXTRA_SEND_DEBUG_LOG_MESSAGE
public static final String EXTRA_CASHBACK_SUGGESTIONS
public static final String EXTRA_REMOTE_RECEIPTS