com.wepay.android

Interface CardReaderHandler

public interface CardReaderHandler

\interface CardReaderHandler The Interface CardReaderHandler defines the methods used to communicate information regarding the card reader.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	CardReaderHandler.ApplicationSelectionCallback \interface ApplicationSelectionCallback The Interface ApplicationSelectionCallback defines the callback method used to provide information to the card reader during a Dip transaction.
static interface	CardReaderHandler.CardReaderEmailCallback \interface CardReaderEmailCallback The Interface CardReaderEmailCallback defines the method used to provide email information to the card reader after a transaction.
static interface	CardReaderHandler.CardReaderResetCallback \interface CardReaderResetCallback The Interface CardReaderResetCallback defines the method used to provide information to the card reader before a transaction.
static interface	CardReaderHandler.CardReaderSelectionCallback \interface CardReaderSelectionCallback The Interface CardReaderSelectionCallback defines the callback method used to select which card reader to initialize.
static interface	CardReaderHandler.CardReaderTransactionInfoCallback \interface CardReaderTransactionInfoCallback The Interface CardReaderTransactionInfoCallback defines the method used to provide transaction information to the card reader before a transaction.

Method Summary

Modifier and Type	Method and Description
void	onCardReaderSelection(CardReaderHandler.CardReaderSelectionCallback callback, java.util.ArrayList<java.lang.String> cardReaderNames) Gets called when card reader devices have been discovered, to give the app an opportunity to select which card reader to initialize.
void	onEMVApplicationSelectionRequested(CardReaderHandler.ApplicationSelectionCallback callback, java.util.ArrayList<java.lang.String> applications) Called when the EMV card contains more than one application.
void	onError(Error error) Gets called when the card reader fails to read a card's information.
void	onPayerEmailRequested(CardReaderHandler.CardReaderEmailCallback callback) Gets called so that an email address can be provided before a transaction is authorized.
void	onReaderResetRequested(CardReaderHandler.CardReaderResetCallback callback) Gets called when the connected card reader is previously configured, to give the app an opportunity to reset the device.
void	onStatusChange(CardReaderStatus status) Gets called whenever the card reader changes status.
void	onSuccess(PaymentInfo paymentInfo) Gets called when the card reader reads a card's information successfully.
void	onTransactionInfoRequested(CardReaderHandler.CardReaderTransactionInfoCallback callback) Gets called so that the app can provide the amount, currency code and the WePay account Id of the merchant.

Method Detail

onEMVApplicationSelectionRequested

void onEMVApplicationSelectionRequested(CardReaderHandler.ApplicationSelectionCallback callback,
                                        java.util.ArrayList<java.lang.String> applications)

Called when the EMV card contains more than one application. The applications should be presented to the payer for selection. Once the payer makes a choice, the app must execute callback.useApplicationAtIndex() with the index of the selected application. The transaction cannot proceed until the callback is executed. Example: callback.useApplicationAtIndex(0);

Parameters:

callback - the callback object.

applications - the array of String containing application names from the card.

onSuccess

void onSuccess(PaymentInfo paymentInfo)

Gets called when the card reader reads a card's information successfully.

Parameters:

paymentInfo - the payment info read from a card.

onError

void onError(Error error)

Gets called when the card reader fails to read a card's information.

Parameters:

error - the error due to which card reading failed.

onStatusChange

void onStatusChange(CardReaderStatus status)

Gets called whenever the card reader changes status.

Parameters:

status - the status.

onReaderResetRequested

void onReaderResetRequested(CardReaderHandler.CardReaderResetCallback callback)

Gets called when the connected card reader is previously configured, to give the app an opportunity to reset the device. The app must respond by executing callback.resetCardReader(). The transaction cannot proceed until this callback is executed. The card reader must be reset here if the merchant manually resets the reader via the hardware reset button on the reader.

Parameters:

callback - the callback object.

onTransactionInfoRequested

void onTransactionInfoRequested(CardReaderHandler.CardReaderTransactionInfoCallback callback)

Gets called so that the app can provide the amount, currency code and the WePay account Id of the merchant. The app must respond by executing callback.useTransactionInfo(). The transaction cannot proceed until this callback is executed.

Parameters:

callback - the callback object.

onPayerEmailRequested

void onPayerEmailRequested(CardReaderHandler.CardReaderEmailCallback callback)

Gets called so that an email address can be provided before a transaction is authorized. The app must respond by executing callback.insertPayerEmail(). The transaction cannot proceed until the callback is executed.

Parameters:

callback - the callback object.

onCardReaderSelection

void onCardReaderSelection(CardReaderHandler.CardReaderSelectionCallback callback,
                           java.util.ArrayList<java.lang.String> cardReaderNames)

Gets called when card reader devices have been discovered, to give the app an opportunity to select which card reader to initialize. The app must respond by executing callback. The card reader will not be initialized until the callback is executed.

Parameters:

callback - the callback object.

cardReaderNames - the list of device names.