clover-android-sdk/com.clover.sdk.v1/Intents

Intents

public class Intents

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:

Constructors

Intents

public void Intents()

Types

PAYMENT_TOKEN_TYPE

public class PAYMENT_TOKEN_TYPE

RemoteViewSize

public enum RemoteViewSize

Values passed with EXTRA_REMOTE_VIEW_SIZE

Properties

ACTION_ACTIVE_REGISTER_ORDER

public final static String ACTION_ACTIVE_REGISTER_ORDER

Broadcast from Clover, indicating the active order in Register Extras passed:

EXTRA_ORDER_ID - the UUID of the active order in Register, or null if there is no longer an active order

ACTION_ADD_TIP

public final static String ACTION_ADD_TIP

Launch activity to add tip to requested payment Extras passed:

EXTRA_PAYMENT_ID - UUID of payment associated with tip
EXTRA_TITLE - label on the tip activity's back button

Result data includes:

NONE

ACTION_APP_INSTALL_DONE

public final static String ACTION_APP_INSTALL_DONE

A broadcast and service intent action sent to your app when it is initially installed or updated.

ACTION_APP_PRE_UNINSTALL

public final static String ACTION_APP_PRE_UNINSTALL

An intent service intent that indicates the target app will be uninstalled in the next 5 seconds.

ACTION_AUTHENTICATE_EMPLOYEE

public final static String ACTION_AUTHENTICATE_EMPLOYEE

Launch a dialog-style activity to authenticate an employee.

ACTION_BILL_SPLIT

public final static String ACTION_BILL_SPLIT

ACTION_CLOSEOUT

public final static String ACTION_CLOSEOUT

Launch activity to view batch details for open batch Extras passed:

NONE

Result data includes:

NONE

ACTION_CLOSEOUT_BATCH

public final static String ACTION_CLOSEOUT_BATCH

Launch activity to closeout sales and refunds 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:

NONE

ACTION_CLOSEOUT_BATCH_SCHEDULED

public final static String ACTION_CLOSEOUT_BATCH_SCHEDULED

Broadcast from Clover, indicating a closeout has been scheduled Extras passed:

EXTRA_CLOSEOUT_BATCH the scheduled batch, only set when scheduled
EXTRA_FAILURE_MESSAGE a message indicating status when scheduling fails

ACTION_CLOVER_PAY

public final static String ACTION_CLOVER_PAY

Launch Pay activity with the provided order.

ACTION_CUSTOMER_ADD_TIP

public final static String ACTION_CUSTOMER_ADD_TIP

Launch activity to have a customer add a tip to a payment.

ACTION_CUSTOMER_TENDER

public final static 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 amount
EXTRA_CURRENCY - the transaction currency
EXTRA_TAX_AMOUNT - the transaction's tax amount
EXTRA_SERVICE_CHARGE_AMOUNT - the transaction's service charge amount
EXTRA_TIP_AMOUNT - the transaction's tip amount
EXTRA_ORDER_ID - the Clover order ID
EXTRA_EMPLOYEE_ID - the ID of the employee who initiated the payment
EXTRA_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:

RESULT_OK - payment successful
RESULT_CANCELED - payment not successful

ACTION_GIFT_CARD_TX

public final static String ACTION_GIFT_CARD_TX

ACTION_ITEM_SELECT

public final static String ACTION_ITEM_SELECT

Launch Register Select Item activity, allowing an employee to add or remove items from an order Extras passed:

EXTRA_ORDER_ID - The UUID of the order to be modified (Required)

Result data includes:

NONE

ACTION_KEYPAD

public final static String ACTION_KEYPAD

An activity action that will start an activity that accepts keypad input from the user.

ACTION_LINE_ITEM_ADDED

public final static String ACTION_LINE_ITEM_ADDED

Broadcast from Clover, indicating a lineItem has been added to an order Extras passed:

EXTRA_CLOVER_LINE_ITEM_ID - the UUID of the created LineItem
EXTRA_CLOVER_ITEM_ID - the UUID of the Item associated with the LineItem
{@Link #EXTRA_LINE_ITEM_IDS} - the array of the UUIDs of the added LineItems
{@Link #EXTRA_CLOVER_ITEM_IDS} - the array of the UUIDs of associated with lineItems
EXTRA_CLOVER_ORDER_ID - the UUID of the order associated with the LineItem

Several item additions may be combined into a single broadcast message.

ACTION_LINE_ITEM_DELETED

public final static String ACTION_LINE_ITEM_DELETED

Broadcast from Clover, line item has been deleted Extras passed:

EXTRA_CLOVER_LINE_ITEM_ID - the UUID of the deleted LineItem
EXTRA_CLOVER_ITEM_ID - the UUID of the Item associated with the LineItem
EXTRA_LINE_ITEM_IDS - the array of UUIDs of the deleted LineItems
EXTRA_CLOVER_ITEM_IDS - the array of UUIDs of associated with LineItems
EXTRA_CLOVER_ORDER_ID - the UUID of the order associated with the LineItem

Several item deletions may be combined into a single broadcast message.

ACTION_MANUAL_PAY

@Deprecated()

public final static String ~~ACTION_MANUAL_PAY~~

ACTION_MANUAL_REFUND

@Deprecated()

public final static String ~~ACTION_MANUAL_REFUND~~

ACTION_MERCHANT_TENDER

public final static 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 amount
EXTRA_CURRENCY - the transaction currency
EXTRA_TAX_AMOUNT - the transaction's tax amount
EXTRA_SERVICE_CHARGE_AMOUNT - the transaction's service charge amount
EXTRA_ORDER_ID - the Clover order ID
EXTRA_EMPLOYEE_ID - the ID of the employee who initiated the payment
EXTRA_TENDER - the tender for the transaction
EXTRA_ORDER - the order for the transaction
EXTRA_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:

RESULT_OK - payment successful
RESULT_CANCELED - payment not successful

ACTION_MODIFY_AMOUNT

public final 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.

ACTION_MODIFY_ORDER

public final 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.

ACTION_ORDER_CREATED

public final static String ACTION_ORDER_CREATED

Broadcast from Clover, indicating an order was created Extras passed:

EXTRA_CLOVER_ORDER_ID - the UUID of created order (note that this order may or may not be saved)

ACTION_ORDER_SAVED

public final static String ACTION_ORDER_SAVED

Broadcast from Clover, indicating an Order has been saved for later processing Extras passed:

EXTRA_CLOVER_ORDER_ID - the UUID of saved Order

ACTION_PAY

public final static String ACTION_PAY

ACTION_PAYMENT_PROCESSED

public final static String ACTION_PAYMENT_PROCESSED

Broadcast from Clover, indicating a payment has been successfully processed Extras passed:

EXTRA_CLOVER_PAYMENT_ID - the UUID of the processed Payment
EXTRA_CLOVER_TENDER_LABEL_KEY - the LabelKey of the Tender used
EXTRA_CLOVER_ORDER_ID - the UUID of the order associated with the Payment

ACTION_REFUND

public final static String ACTION_REFUND

Intent passed to start your app's extensible tender refund activity Extras passed:

Result data includes:

(Required) EXTRA_AMOUNT
(Required) EXTRA_ORDER_ID
(Required) EXTRA_PAYMENT_ID
(Optional) EXTRA_LINE_ITEM_IDS

Result codes:

RESULT_OK - refund processed
RESULT_CANCELED - refund canceled

ACTION_REQUEST_PAYMENT_REMOTE_VIEWS

public final 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 Extras passed:

EXTRA_VIEWID - unique id to be used with ACTION_UPDATE_PAYMENT_REMOTE_VIEWS
EXTRA_ORDER_ID - order being processed
EXTRA_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_REQUEST_ROLE

public final static String ACTION_REQUEST_ROLE

ACTION_SCAN

@Deprecated()

public final static String ~~ACTION_SCAN~~

ACTION_SECURE_BALANCE_CHECK

public final static String ACTION_SECURE_BALANCE_CHECK

Launch activity to check credit/debit card balance.

ACTION_SECURE_CARD_DATA

public final static String ACTION_SECURE_CARD_DATA

Launch activity to securely capture card data.

ACTION_SECURE_PAY

public final static String ACTION_SECURE_PAY

Launch the secure payment activity.

ACTION_START_APP_DETAIL

public final static String ACTION_START_APP_DETAIL

Launch App Market's App Detail activity 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 shown
EXTRA_APP_ID - the UUID of the app that will be shown
EXTRA_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

ACTION_START_CUSTOMER_PROFILE

public final static String ACTION_START_CUSTOMER_PROFILE

Launch the Customer Profile activity Extras passed:

EXTRA_CUSTOMER_ID - The UUID of the target customer (Required)

Result data includes:

NONE

ACTION_START_HEADLESS_CLOSEOUT

public final static String ACTION_START_HEADLESS_CLOSEOUT

ACTION_START_ORDER_MANAGE

public final static String ACTION_START_ORDER_MANAGE

Launch Order Manage activity Extras passed:

EXTRA_ORDER_ID - the UUID of the order to be shown (REQUIRED)

Result data includes:

NONE

ACTION_START_PIN_ACTIVITY

public final static String ACTION_START_PIN_ACTIVITY

Launches PIN Activity in secure-payments

ACTION_START_PRINT_RECEIPTS

public final static String ACTION_START_PRINT_RECEIPTS

Launch the Print Receipts activity, to show receipt printing and sending options for an order Extras passed:

EXTRA_ORDER_ID - The UUID of the target order (Required)

Result data includes:

NONE

ACTION_START_REGISTER

public final static String ACTION_START_REGISTER

Launch Register Point of Sale activity Extras passed:

EXTRA_ORDER_ID - The UUID of the order opened in Register
EXTRA_CUSTOMER_V3 - a customer object to be associated with the order

Result data includes:

NONE

ACTION_START_SELECT_ACCOUNT_ACTIVITY

public final static String ACTION_START_SELECT_ACCOUNT_ACTIVITY

Launches SelectAccountActivity in secure-payments

ACTION_START_TRANSACTION_DETAIL

public final static String ACTION_START_TRANSACTION_DETAIL

Launch Transactions detail activity Extras passed (Must include one of the following: EXTRA_PAYMENT or EXTRA_CREDIT or EXTRA_REFUND):

EXTRA_PAYMENT - the Payment object that will be shown
EXTRA_CREDIT - the Credit (manual refund) object that will be shown
EXTRA_REFUND - the Refund object that will be shown

Result data includes:

NONE

ACTION_STATION_PAY

public final static String ACTION_STATION_PAY

Launches station pay activity (Only used on Station)

ACTION_STATION_SECURE_PAY

public final static String ACTION_STATION_SECURE_PAY

Launches station secure pay activity (Only used on Station 2018)

ACTION_STORE_CREDIT

public final static String ACTION_STORE_CREDIT

ACTION_UPDATE_PAYMENT_REMOTE_VIEWS

public final 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 Extras passed:

EXTRA_REMOTE_VIEWS
EXTRA_VIEWID unique id passed by ACTION_REQUEST_PAYMENT_REMOTE_VIEWS

Result data includes:

NONE

ACTION_V1_ACTIVE_PAY_ORDER

public final static String ACTION_V1_ACTIVE_PAY_ORDER

Broadcast from Clover, indicating the active order in the Register Pay activity Extras passed:

EXTRA_ORDER_ID - the UUID of the active order in Pay, or null if there is no longer an active order

ACTION_V1_CUSTOMER_IDENTIFIED

public final static String ACTION_V1_CUSTOMER_IDENTIFIED

Broadcast indicating that a customer has been identified as a 'current' customer of interest.

ACTION_V1_ORDER_BUILD_START

public final static String ACTION_V1_ORDER_BUILD_START

Broadcast from Clover, indicating that we are starting to build an order Extras passed:

EXTRA_ORDER_ID - the UUID of the order being built

ACTION_V1_ORDER_BUILD_STOP

public final static String ACTION_V1_ORDER_BUILD_STOP

Broadcast from Clover, indicating that we have stopped building an order Extras passed:

EXTRA_ORDER_ID - the UUID of the order that is no longer being built

ACTION_V1_PAY_BUILD_HIDE

public final static String ACTION_V1_PAY_BUILD_HIDE

Broadcast from Clover, indicating that PayActivity was hidden Extras passed:

EXTRA_ORDER_ID - the UUID of the order that is no longer active in the PayActivity

ACTION_V1_PAY_BUILD_SHOW

public final static String ACTION_V1_PAY_BUILD_SHOW

Broadcast from Clover, indicating that we are showing PayActivity Extras passed:

EXTRA_ORDER_ID - the UUID of the order active in the PayActivity

ACTION_V1_PAY_BUILD_START

public final static String ACTION_V1_PAY_BUILD_START

Broadcast from Clover, indicating that we are starting to build a payment Extras passed:

EXTRA_ORDER_ID - the UUID of the order associated with the payment now being built

ACTION_V1_PAY_BUILD_STOP

public final static String ACTION_V1_PAY_BUILD_STOP

Broadcast from Clover, indicating that we have stopped building a payment Extras passed:

EXTRA_ORDER_ID - the UUID of the order associated with the payment that is no longer being built

ACTION_V1_PAY_EXECUTE_START

public final static String ACTION_V1_PAY_EXECUTE_START

Broadcast from Clover, indicating that we have started executing a payment Extras passed:

EXTRA_ORDER_ID - the UUID of the order associated with the payment that is now being executed

ACTION_V1_PAY_EXECUTE_STOP

public final static String ACTION_V1_PAY_EXECUTE_STOP

Broadcast from Clover, indicating that we have stopped executing a payment Extras passed:

EXTRA_ORDER_ID - the UUID of the order associated with the payment that is no longer being executed

ACTION_V1_POST_CFD_MESSAGE

public final static String ACTION_V1_POST_CFD_MESSAGE

CARD_DATA_READ_MODE_ENHANCED_CVV

public final static String CARD_DATA_READ_MODE_ENHANCED_CVV

CARD_ENTRY_METHOD_ALL

public final static int CARD_ENTRY_METHOD_ALL

A bit value for EXTRA_CARD_ENTRY_METHODS, all card entry methods.

CARD_ENTRY_METHOD_ICC_CONTACT

public final 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

CARD_ENTRY_METHOD_MAG_STRIPE

public final 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

CARD_ENTRY_METHOD_MANUAL

public final static int CARD_ENTRY_METHOD_MANUAL

A bit value for EXTRA_CARD_ENTRY_METHODS, can be bitwise-ored with other CARD_ENTRY_METHOD values

CARD_ENTRY_METHOD_NFC_CONTACTLESS

public final 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

CARD_ENTRY_METHOD_SCAN

public final static int CARD_ENTRY_METHOD_SCAN

A bit value for EXTRA_CARD_ENTRY_METHODS, this value should be used exclusively to scan QR code or barcode

CARD_ENTRY_METHOD_VAULTED_CARD

public final 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

CASHADVANCE_CUSTOMER_IDENTIFICATION

public final static String CASHADVANCE_CUSTOMER_IDENTIFICATION

com.clover.sdk.v3.payments.CashAdvanceCustomerIdentification object used for CashAdvance payments

DATA_ENTRY_LOCATION_NONE

public final static String DATA_ENTRY_LOCATION_NONE

A value for EXTRA_SIGNATURE_ENTRY_LOCATION

DATA_ENTRY_LOCATION_ON_PAPER

public final static String DATA_ENTRY_LOCATION_ON_PAPER

A value for EXTRA_SIGNATURE_ENTRY_LOCATION

DATA_ENTRY_LOCATION_ON_SCREEN

public final static String DATA_ENTRY_LOCATION_ON_SCREEN

A value for EXTRA_SIGNATURE_ENTRY_LOCATION

EXTRA_ACCOUNT

public final static String EXTRA_ACCOUNT

android.accounts.Account, the Clover account associated with the action or broadcast

EXTRA_ACCOUNT_ROLES

public final static String EXTRA_ACCOUNT_ROLES

An java.util.ArrayList of com.clover.sdk.v3.employees.AccountRole.

EXTRA_ALLOW_FIRE

public final static String EXTRA_ALLOW_FIRE

Boolean, whether order should respect merchant's setting for firing after payment

EXTRA_ALLOW_MANUAL_CARD_ENTRY_ON_MFD

public final static String EXTRA_ALLOW_MANUAL_CARD_ENTRY_ON_MFD

Intent Extra to Allow Manual Card Entry on MFD.

EXTRA_ALLOW_OFFLINE_ACCEPTANCE

public final static String EXTRA_ALLOW_OFFLINE_ACCEPTANCE

Boolean, allow payments to be accepted offline

EXTRA_ALLOW_OFFLINE_PAYMENT

public final static String EXTRA_ALLOW_OFFLINE_PAYMENT

Boolean allow offline payments even if the merchant isn't configured to accept them

EXTRA_ALLOW_PARTIAL_AUTH

public final static String EXTRA_ALLOW_PARTIAL_AUTH

, is partial authorization allowed (if it occurs)?

EXTRA_ALWAYS_SHOW_RETURN_TO_MERCHANT

public final static String EXTRA_ALWAYS_SHOW_RETURN_TO_MERCHANT

Used to indicate if the "return to merchant" screen can/should be skipped.

EXTRA_AMOUNT

public final static String EXTRA_AMOUNT

Long, a monetary amount

EXTRA_API_SIGNATURE_PREFER_ON_SCREEN

public final static String EXTRA_API_SIGNATURE_PREFER_ON_SCREEN

EXTRA_API_TIP_PREFER_ON_SCREEN

public final static String EXTRA_API_TIP_PREFER_ON_SCREEN

EXTRA_APP

public final static String EXTRA_APP

EXTRA_APP_ID

public final static String EXTRA_APP_ID

String, App UUID

EXTRA_APP_PACKAGE_NAME

public final static String EXTRA_APP_PACKAGE_NAME

String, App package name

EXTRA_APP_TRACKING_ID

public final static String EXTRA_APP_TRACKING_ID

, does this intent need remote payment confirmation i.e.

EXTRA_APPLICATION_SPECIFIC_VALUES

public final static String EXTRA_APPLICATION_SPECIFIC_VALUES

, set of key/value pairs used for application specific implementations

EXTRA_APPLY_REALTIME_DISCOUNT_FOR_PKG_NAME

public final static String EXTRA_APPLY_REALTIME_DISCOUNT_FOR_PKG_NAME

Intent to track apply realtime discount for package name

EXTRA_APPLY_TAXES_AND_FEES

public final static String EXTRA_APPLY_TAXES_AND_FEES

Boolean whether or not to apply taxes to a transaction (held in the Terminal apps' settings)

EXTRA_APPROVE_OFFLINE_PAYMENT_WITHOUT_PROMPT

public final static String EXTRA_APPROVE_OFFLINE_PAYMENT_WITHOUT_PROMPT

Boolean don't prompt for confirmation of an offline payment

EXTRA_ASK_FOR_TIP

public final static String EXTRA_ASK_FOR_TIP

Boolean, whether to prompt customers for tip

EXTRA_AUTHORIZATION

public final static String EXTRA_AUTHORIZATION

com.clover.sdk.v3.payments.Authorization, v3 Authorization object

EXTRA_AUTHORIZATION_INCREMENT

public final static String EXTRA_AUTHORIZATION_INCREMENT

Boolean, whether an authorization is being incremented or decremented

EXTRA_AUTO_ACCEPT_DUPLICATES

public final static String EXTRA_AUTO_ACCEPT_DUPLICATES

automatically accept the customer signature

EXTRA_AUTO_ACCEPT_PAYMENT_CONFIRMATIONS

public final static String EXTRA_AUTO_ACCEPT_PAYMENT_CONFIRMATIONS

Boolean automatically accept payment confirmations

EXTRA_AUTO_ACCEPT_SIGNATURE

public final static String EXTRA_AUTO_ACCEPT_SIGNATURE

Boolean automatically accept payment confirmations

EXTRA_AVAILABLE

public final static String EXTRA_AVAILABLE

EXTRA_AVS_POSTAL_CODE

public final static String EXTRA_AVS_POSTAL_CODE

String, postal code for use with AVS

EXTRA_AVS_STREET_ADDRESS

public final static String EXTRA_AVS_STREET_ADDRESS

String, street address for use with AVS

EXTRA_C_TOKEN_REQUEST

public final 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.

EXTRA_C_TOKEN_RESULT

public final 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 com.clover.sdk.v3.payments.TokenizeCardResponse

EXTRA_CAPTURE

public final 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.

EXTRA_CARD

public final static String EXTRA_CARD

EXTRA_CARD_DATA

public final static String EXTRA_CARD_DATA

com.clover.sdk.v3.pay.PaymentRequestCardDetails, payment card data

EXTRA_CARD_DATA_MESSAGE

public final static String EXTRA_CARD_DATA_MESSAGE

String, the message to prompt the user

EXTRA_CARD_ENTRY_METHODS

public final static String EXTRA_CARD_ENTRY_METHODS

, representation of bit flags for Intents.

EXTRA_CARD_NOT_PRESENT

public final static String EXTRA_CARD_NOT_PRESENT

Boolean, card not present, used during manual card entry

EXTRA_CARD_NUMBER

public final static String EXTRA_CARD_NUMBER

String, a card number

EXTRA_CASHBACK_AMOUNT

public final static String EXTRA_CASHBACK_AMOUNT

Long, the pre-selected cash back amount

EXTRA_CASHBACK_SUGGESTIONS

public final static String EXTRA_CASHBACK_SUGGESTIONS

EXTRA_CFD_MESSAGE

public final static String EXTRA_CFD_MESSAGE

EXTRA_CHANGE_DUE

public final static String EXTRA_CHANGE_DUE

EXTRA_CLIENT_ID

public final static String EXTRA_CLIENT_ID

String, the ID of a Client or external payment

EXTRA_CLOSEOUT_ALLOW_OPEN_TABS

public final static String EXTRA_CLOSEOUT_ALLOW_OPEN_TABS

, true indicates that a closeout can proceed if open tabs are found

EXTRA_CLOSEOUT_BATCH

public final static String EXTRA_CLOSEOUT_BATCH

com.clover.sdk.v3.payments.Batch, v3 Batch object

EXTRA_CLOSEOUT_BATCHID

public final static String EXTRA_CLOSEOUT_BATCHID

String, the UUID of a Batch object

EXTRA_CLOSEOUT_RESULT

public final static String EXTRA_CLOSEOUT_RESULT

EXTRA_CLOVER_ITEM_ID

public final static String EXTRA_CLOVER_ITEM_ID

String, the UUID of an Item object

EXTRA_CLOVER_ITEM_IDS

public final static String EXTRA_CLOVER_ITEM_IDS

java.util.ArrayList of String objects - LineItem UUIDs

EXTRA_CLOVER_LINE_ITEM_ID

public final static String EXTRA_CLOVER_LINE_ITEM_ID

String, the UUID of a LineItem object

EXTRA_CLOVER_ORDER_ID

public final static String EXTRA_CLOVER_ORDER_ID

String, the UUID of an Order object

EXTRA_CLOVER_PAYMENT_ID

public final static String EXTRA_CLOVER_PAYMENT_ID

String, the UUID of a Payment object

EXTRA_CLOVER_SHOULD_HANDLE_RECEIPTS

public final static String EXTRA_CLOVER_SHOULD_HANDLE_RECEIPTS

EXTRA_CLOVER_SHOULD_HANDLE_TIPS

public final static String EXTRA_CLOVER_SHOULD_HANDLE_TIPS

EXTRA_CLOVER_TENDER_LABEL_KEY

public final static String EXTRA_CLOVER_TENDER_LABEL_KEY

String, the labelKey of a Tender type

EXTRA_CREATE_AUTH

public final static String EXTRA_CREATE_AUTH

Intent to track create an auth

EXTRA_CREDIT

public final static String EXTRA_CREDIT

com.clover.sdk.v3.payments.Credit, v3 Credit object (Manual Refund)

EXTRA_CREDIT_ID

public final static String EXTRA_CREDIT_ID

String, the UUID of a Credit object

EXTRA_CREDIT_REFUND

public final static String EXTRA_CREDIT_REFUND

com.clover.sdk.v3.payments.CreditRefund, v3 CreditRefund object (Reversal of Manual Refund)

EXTRA_CURRENCY

public final static String EXTRA_CURRENCY

java.util.Currency, the currency of a transaction

EXTRA_CURRENT_SHIFT

public final static String EXTRA_CURRENT_SHIFT

com.clover.sdk.v3.employees.Shift, the current employee shift

EXTRA_CUSTOMER_ID

public final static String EXTRA_CUSTOMER_ID

String, UUID of a customer

EXTRA_CUSTOMER_TENDER

public final static String EXTRA_CUSTOMER_TENDER

com.clover.sdk.v3.base.Tender, Pre-selected customer tender

EXTRA_CUSTOMER_V3

public final static String EXTRA_CUSTOMER_V3

com.clover.sdk.v3.customers.Customer, a customer object

EXTRA_CUSTOMERINFO

public final static String EXTRA_CUSTOMERINFO

com.clover.sdk.v3.customers.CustomerInfo, a customer object

EXTRA_DATA_READ_MODE

public final static String EXTRA_DATA_READ_MODE

A value for EXTRA_DATA_READ_MODE data read mode for specific integration use cases.

EXTRA_DECLINE_REASON

public final static String EXTRA_DECLINE_REASON

String, an error description

EXTRA_DIALOG

public final static String EXTRA_DIALOG

EXTRA_DISABLE_CASHBACK

public final static String EXTRA_DISABLE_CASHBACK

Boolean, true will disable cashback option during secure payment

EXTRA_DISABLE_CLOVER_PRINTING

public final static String EXTRA_DISABLE_CLOVER_PRINTING

EXTRA_DISABLE_CREDIT_SURCHARGE

public final static String EXTRA_DISABLE_CREDIT_SURCHARGE

Intent Extra to toggle credit surcharge.

EXTRA_DISABLE_RECEIPT_OPTIONS

public final static String EXTRA_DISABLE_RECEIPT_OPTIONS

Boolean, is the receipt options screen disabled for this transaction

EXTRA_DISABLE_RESTART_TRANSACTION_WHEN_FAILED

public final static String EXTRA_DISABLE_RESTART_TRANSACTION_WHEN_FAILED

Boolean, if true, the secure payment activity will end after a failed transaction

EXTRA_DISABLED_TENDER_IDS

public final static String EXTRA_DISABLED_TENDER_IDS

java.util.ArrayList of String objects - UUIDs of disabled tenders

EXTRA_DUPLICATE_PAYMENT_CONFIRMATION

public final static String EXTRA_DUPLICATE_PAYMENT_CONFIRMATION

, does this payment need remote duplicate payment confirmation

EXTRA_EBT_MANUAL_CARD_ENTRY_SCREEN_FLOW

public final static String EXTRA_EBT_MANUAL_CARD_ENTRY_SCREEN_FLOW

Intent to define EBT manual card entry screen flow.

EXTRA_ECR_MODE

public final static String EXTRA_ECR_MODE

Boolean flag Indicates if device supports ECR mode or not

EXTRA_ELV_APPLICATION_LABEL

public final static String EXTRA_ELV_APPLICATION_LABEL

A value for EXTRA_ELV_APPLICATION_LABEL

EXTRA_EMPLOYEE_ID

public final static String EXTRA_EMPLOYEE_ID

String, the UUID of an Employee object

EXTRA_EMPLOYEE_NAME

public final static String EXTRA_EMPLOYEE_NAME

String, the Name of employee in Employee object

EXTRA_ENABLE_KIOSK_MODE

public final static String EXTRA_ENABLE_KIOSK_MODE

Boolean, is the device interaction for this transaction in kioskMode (i.e.

EXTRA_ENABLED_RECEIPT_OPTIONS

public final static String EXTRA_ENABLED_RECEIPT_OPTIONS

EXTRA_ENTERED_RECEIPT_VALUE

public final static String EXTRA_ENTERED_RECEIPT_VALUE

EXTRA_EXIT_IN_CUSTOMER_MODE

public final static String EXTRA_EXIT_IN_CUSTOMER_MODE

Used (by BillSplit) to have the ensuing activity be in customer mode.

EXTRA_EXTERNAL_PAYMENT_ID

public final static String EXTRA_EXTERNAL_PAYMENT_ID

String, external payment id, used for integration with other POS platforms

EXTRA_EXTERNAL_REFERENCE_ID

public final static String EXTRA_EXTERNAL_REFERENCE_ID

String, external reference id

EXTRA_EXTERNAL_TOKEN_ID

public final static String EXTRA_EXTERNAL_TOKEN_ID

String, external token id

EXTRA_FAILURE_MESSAGE

public final static String EXTRA_FAILURE_MESSAGE

String, message shown upon failure

EXTRA_FORCE_OFFLINE

public final static String EXTRA_FORCE_OFFLINE

Boolean, force payments to be accepted offline

EXTRA_FORCE_SWIPE_PIN_ENTRY

public final static String EXTRA_FORCE_SWIPE_PIN_ENTRY

Boolean, if only payment option will be swipe debit

EXTRA_GERMAN_ELV

public final static String EXTRA_GERMAN_ELV

String, elv transaction type for Germany

EXTRA_GIFT_CARD_RESPONSE

public final static String EXTRA_GIFT_CARD_RESPONSE

com.clover.sdk.v3.payments.GiftCardResponse

EXTRA_IGNORE_PAYMENT

public final static String EXTRA_IGNORE_PAYMENT

Boolean

EXTRA_IMMERSIVE_MODE

public final static String EXTRA_IMMERSIVE_MODE

Boolean If set to true, it will hide navigation and status bar

EXTRA_INITIATE_REFUND

public final static String EXTRA_INITIATE_REFUND

A value for EXTRA_INITIATE_REFUND data read mode for specific integration use cases where want trigger refund flow through transaction app

EXTRA_INVOICE_ID_AVAILABLE

public final static String EXTRA_INVOICE_ID_AVAILABLE

Boolean Flag to check if invoice feature is available for merchant

EXTRA_INVOICE_ID_REGEX

public final static String EXTRA_INVOICE_ID_REGEX

String A regular expression to check the validity of invoice number

EXTRA_INVOICE_LABEL

public final static String EXTRA_INVOICE_LABEL

String, Invoice Label of the device

EXTRA_INVOICE_NUMBER

public final static String EXTRA_INVOICE_NUMBER

String, the invoice number

EXTRA_IS_ADMIN_OR_MANAGER

public final static String EXTRA_IS_ADMIN_OR_MANAGER

Boolean, whether the launched activity should validate if the pin is either admin or manager

EXTRA_IS_TESTING

public final static String EXTRA_IS_TESTING

EXTRA_KEYPAD_COMPLETIONS

public final static String EXTRA_KEYPAD_COMPLETIONS

An ArrayList of String, word completions to display above the keyboard.

EXTRA_KEYPAD_TEXT

public final static String EXTRA_KEYPAD_TEXT

A String, the initial text to populate into the edit area.

EXTRA_KEYPAD_TYPE

public final static String EXTRA_KEYPAD_TYPE

An integer, the desired keypad type as an integer.

EXTRA_KIOSK_FULFILLMENT_INFO_PHONE_NUMBER

public final static String EXTRA_KIOSK_FULFILLMENT_INFO_PHONE_NUMBER

String, Is the customer phone number associated with Kiosk order

EXTRA_LEAVE_PREAUTHS_OPEN

public final static String EXTRA_LEAVE_PREAUTHS_OPEN

EXTRA_LED_ON

public final 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.

EXTRA_LINE_ITEM_IDS

public final static String EXTRA_LINE_ITEM_IDS

java.util.ArrayList of String objects - LineItem UUIDs

EXTRA_LINE_ITEM_PAYMENTS

public final static String EXTRA_LINE_ITEM_PAYMENTS

java.util.ArrayList of com.clover.sdk.v3.payments.LineItemPayment objects

EXTRA_LOCALE

public final static String EXTRA_LOCALE

, optionally set the desired locale)?

EXTRA_MANUAL_CARD_CVV

public final static String EXTRA_MANUAL_CARD_CVV

Intent Extra to Manual Card CVV Data.

EXTRA_MANUAL_CARD_ENTRY_BYPASS_MODE

public final static String EXTRA_MANUAL_CARD_ENTRY_BYPASS_MODE

Intent Extra to Bypass Manual Card Entry Data.

EXTRA_MANUAL_CARD_EXPIRY

public final static String EXTRA_MANUAL_CARD_EXPIRY

Intent Extra to Manual Card Expiry Data.

EXTRA_MANUAL_CARD_PAN

public final static String EXTRA_MANUAL_CARD_PAN

Intent Extra to Manual Card PAN Data.

EXTRA_MD5_HASH

public final static String EXTRA_MD5_HASH

EXTRA_MERCHANT_ID

public final static String EXTRA_MERCHANT_ID

String, the UUID of a merchant

EXTRA_MID

public final static String EXTRA_MID

String, MID of a merchant

EXTRA_NETWORK_FAILURE

public final static String EXTRA_NETWORK_FAILURE

String, indicator of a network failure

EXTRA_NO_TIP

public final static String EXTRA_NO_TIP

EXTRA_NOTE

public final static String EXTRA_NOTE

String, note content

EXTRA_OBEY_AUTO_LOGOUT

public final static String EXTRA_OBEY_AUTO_LOGOUT

Boolean, whether transaction will respect merchant's auto logout settings

EXTRA_OFFLINE_NO_PROMPT

public final static String EXTRA_OFFLINE_NO_PROMPT

Boolean, allow offline payments to be accepted without an approval prompt

EXTRA_OFFLINE_PAYMENT_CONFIRMATION

public final static String EXTRA_OFFLINE_PAYMENT_CONFIRMATION

, does this payment need remote offline payment confirmation

EXTRA_OPEN_PAYMENT_OPTIONS

public final static String EXTRA_OPEN_PAYMENT_OPTIONS

EXTRA_OPTED_INTO_MARKETING

public final static String EXTRA_OPTED_INTO_MARKETING

EXTRA_ORDER

public final static String EXTRA_ORDER

com.clover.sdk.v3.order.Order, an Order object

EXTRA_ORDER_ID

public final static String EXTRA_ORDER_ID

String, the UUID of an Order object

EXTRA_ORIGINATING_CREDIT

public final static String EXTRA_ORIGINATING_CREDIT

com.clover.sdk.v3.payments.Credit, originating credit (applies to reversal, required for Nexo credit reversal)

EXTRA_ORIGINATING_PAYMENT

public final static String EXTRA_ORIGINATING_PAYMENT

com.clover.sdk.v3.payments.Payment, originating payment (applies to refunds, required for Interac refunds)

EXTRA_ORIGINATING_PAYMENT_PACKAGE

public final static String EXTRA_ORIGINATING_PAYMENT_PACKAGE

Intent to track package of the Payment.

EXTRA_ORIGINATING_TRANSACTION

public final static String EXTRA_ORIGINATING_TRANSACTION

com.clover.sdk.v3.payments.CardTransaction, originating transaction

EXTRA_PACKAGE

public final static String EXTRA_PACKAGE

String, package name

EXTRA_PASS_THROUGH_VALUES

public final static String EXTRA_PASS_THROUGH_VALUES

, set of key/value pairs that are passed through to the server

EXTRA_PAYMENT

public final static String EXTRA_PAYMENT

com.clover.sdk.v3.payments.Payment, v3 Payment object

EXTRA_PAYMENT_ID

public final static String EXTRA_PAYMENT_ID

String, the UUID of a Payment object

EXTRA_PAYMENT_IDS

public final static String EXTRA_PAYMENT_IDS

java.util.List of String objects - UUIDs of payments

EXTRA_PAYMENT_TYPE

public final static String EXTRA_PAYMENT_TYPE

Intent to track payment sub types

EXTRA_PAYMENTS

public final static String EXTRA_PAYMENTS

java.util.ArrayList of com.clover.sdk.v3.payments.Payment objects

EXTRA_PERMISSIONS

public final static String EXTRA_PERMISSIONS

String, the string constant of a permission

EXTRA_PRESENT_QRC_ONLY

public final static String EXTRA_PRESENT_QRC_ONLY

Boolean, a private extra indicating the user selected Scan QR Code for this Payment.

EXTRA_PRINT_RECEIPT_ONLY

public final static String EXTRA_PRINT_RECEIPT_ONLY

Boolean, print receipt extras

EXTRA_QUICK_PAYMENT_TRANSACTION_ID

public final static String EXTRA_QUICK_PAYMENT_TRANSACTION_ID

String, the UUID of the quick pay transaction if collected

EXTRA_REASON

public final static String EXTRA_REASON

String, written explanation

EXTRA_RECEIPT_DELIVERY_STATUS

public final static String EXTRA_RECEIPT_DELIVERY_STATUS

EXTRA_RECEIPT_DELIVERY_TYPE

public final static String EXTRA_RECEIPT_DELIVERY_TYPE

EXTRA_RECEIPT_FLAG

public final static String EXTRA_RECEIPT_FLAG

, representation of bit flags from com.clover.sdk.v1.printer.job.PrintJob

EXTRA_RECEIPT_SELECTION_TIMEOUT_THRESHOLD

public final static String EXTRA_RECEIPT_SELECTION_TIMEOUT_THRESHOLD

EXTRA_REFUND

public final static String EXTRA_REFUND

com.clover.sdk.v3.payments.Refund, v3 Refund object

EXTRA_REFUND_ID

public final static String EXTRA_REFUND_ID

EXTRA_REFUND_REASON

public final static String EXTRA_REFUND_REASON

java.lang.String, merchant provided reason for refund or credit

EXTRA_REGIONAL_EXTRAS

public final static String EXTRA_REGIONAL_EXTRAS

EXTRA_REMOTE_PRINT

public final static String EXTRA_REMOTE_PRINT

Boolean, if true printing will be delegated to remote device

EXTRA_REMOTE_RECEIPTS

public final static String EXTRA_REMOTE_RECEIPTS

EXTRA_REMOTE_VIEW_SIZE

public final static String EXTRA_REMOTE_VIEW_SIZE

String, version of one of the values from the enum com.clover.sdk.v1.Intents.RemoteViewSize

EXTRA_REMOTE_VIEWS

public final static String EXTRA_REMOTE_VIEWS

android.widget.RemoteViews, RemoteViews sent to Register Payment activity

EXTRA_REPRINT_RECEIPT_FLAG

public final static String EXTRA_REPRINT_RECEIPT_FLAG

Boolean If set to true, it will reprint the transaction receipt.

EXTRA_REQUEST_ID

public final static String EXTRA_REQUEST_ID

String, a uuid of a request

EXTRA_REQUEST_TYPE

public final static String EXTRA_REQUEST_TYPE

EXTRA_REQUIRES_FINAL_REMOTE_APPROVAL

public final static String EXTRA_REQUIRES_FINAL_REMOTE_APPROVAL

, does this intent need remote payment confirmation i.e.

EXTRA_REQUIRES_REMOTE_CONFIRMATION

public final static String EXTRA_REQUIRES_REMOTE_CONFIRMATION

, does this intent need remote payment confirmation i.e.

EXTRA_RESULT_SUBSCRIPTION_ID

public final static String EXTRA_RESULT_SUBSCRIPTION_ID

String, UUID for result subscription (during an upgrade flow)

EXTRA_RETURN_FULL_CARD_DATA

public final static String EXTRA_RETURN_FULL_CARD_DATA

EXTRA_REVERSE_PAYMENT_RESULT

public final static String EXTRA_REVERSE_PAYMENT_RESULT

EXTRA_ROLE

public final static String EXTRA_ROLE

com.clover.sdk.v3.employees.AccountRole, employee role (admin, manager or employee)

EXTRA_SCAN_1D_CODE

public final static String EXTRA_SCAN_1D_CODE

Boolean, whether 1D codes will be scanned

EXTRA_SCAN_QR_CODE

public final static String EXTRA_SCAN_QR_CODE

Boolean, whether QR codes will be scanned

EXTRA_SCAN_X

public final static String EXTRA_SCAN_X

EXTRA_SCAN_Y

public final static String EXTRA_SCAN_Y

EXTRA_SCANNER_FACING

public final static String EXTRA_SCANNER_FACING

On devices where multiple barcode scanners are available, select a barcode scanner to start.

EXTRA_SDK_NAME

public final static String EXTRA_SDK_NAME

EXTRA_SDK_VERSION

public final static String EXTRA_SDK_VERSION

EXTRA_SELECTED_RECEIPT_OPTION

public final static String EXTRA_SELECTED_RECEIPT_OPTION

EXTRA_SEND_DEBUG_LOG_MESSAGE

public final static String EXTRA_SEND_DEBUG_LOG_MESSAGE

EXTRA_SEND_RESULT_ON_TRANSACTION_COMPLETE

public final 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.

EXTRA_SERVICE_CHARGE_AMOUNT

public final static String EXTRA_SERVICE_CHARGE_AMOUNT

com.clover.sdk.v3.payments.ServiceChargeAmount

EXTRA_SHOULD_RETRIEVE_OPEN_PAYMENTS

public final static String EXTRA_SHOULD_RETRIEVE_OPEN_PAYMENTS

EXTRA_SHOULD_TOKENIZE_CARD

public final static String EXTRA_SHOULD_TOKENIZE_CARD

EXTRA_SHOW_CANCEL_BUTTON

public final static String EXTRA_SHOW_CANCEL_BUTTON

Boolean, whether the launched activity should display a cancel button

EXTRA_SHOW_CLOSE_BUTTON

public final static String EXTRA_SHOW_CLOSE_BUTTON

Boolean, whether scanner preview video will have a 'close' button.

EXTRA_SHOW_CUSTOMER_PREVIEW

public final static String EXTRA_SHOW_CUSTOMER_PREVIEW

Boolean, whether to show scanner preview video (customer facing mode only)

EXTRA_SHOW_LED_BUTTON

public final 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.

EXTRA_SHOW_MERCHANT_PREVIEW

public final static String EXTRA_SHOW_MERCHANT_PREVIEW

Boolean, whether to show scanner preview video (merchant facing mode only)

EXTRA_SHOW_PREVIEW

public final 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.

EXTRA_SHOW_REMAINING

public final static String EXTRA_SHOW_REMAINING

Boolean, whether to show amount remaining after payment

EXTRA_SHOW_SEARCH

public final static String EXTRA_SHOW_SEARCH

Boolean

EXTRA_SHOW_VOID_BUTTON

public final static String EXTRA_SHOW_VOID_BUTTON

Boolean, whether to show the Void button

EXTRA_SIGNATURE

public final static String EXTRA_SIGNATURE

com.clover.common2.Signature2, payment Signature2 signature