com.wepay.android

Class WePay

java.lang.Object

com.wepay.android.WePay

public class WePay
extends java.lang.Object

Main Class containing all public endpoints.

Constructor Summary

Constructors

Constructor and Description
WePay(Config config) Instantiates a new WePay instance.

Method Summary

Modifier and Type	Method and Description
void	calibrateCardReader(CalibrationHandler calibrationHandler) Use this method to try calibrating a charged card reader that doesn't seem to work on a device.
void	forgetRememberedCardReader() Use this method to clear the name of the most recently used card reader.
void	getCardReaderBatteryLevel(CardReaderHandler cardReaderHandler, BatteryLevelHandler batteryLevelHandler) Use this method to get the current battery level of the card reader.
java.lang.String	getRememberedCardReader() Use this method to get the name of the most recently used card reader.
void	startTransactionForReading(CardReaderHandler cardReaderHandler) Use this method if you just want to read non-sensitive data from the card, without actually charging the card.
void	startTransactionForTokenizing(CardReaderHandler cardReaderHandler, TokenizationHandler tokenizationHandler, AuthorizationHandler authorizationHandler) Use this method if you want to tokenize the card info.
void	stopCardReader() Stops the reader.
void	storeSignatureImage(android.graphics.Bitmap image, java.lang.String checkoutId, CheckoutHandler checkoutHandler) Use this method to store a signature image associated with a checkout id on WePay's servers.
void	tokenize(PaymentInfo paymentInfo, TokenizationHandler tokenizationHandler) Use this method to tokenize any PaymentInfo object, such as one representing credit card info obtained manually.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WePay

public WePay(Config config)

Instantiates a new WePay instance.

Parameters:

config - the WePay config

Method Detail

startTransactionForReading

public void startTransactionForReading(CardReaderHandler cardReaderHandler)

Use this method if you just want to read non-sensitive data from the card, without actually charging the card. Non-sensitive info from the card will be returned via the CardReaderHandler interface. The reader will wait 60 seconds for a card, and then return a timout error if a card is not detected. The reader will automatically stop waiting for card if: - a timeout occurs - a successful swipe/dip is detected - an unexpected error occurs - stopReader is called However, if a general error (errorCategory:ERROR_CATEGORY_CARD_READER, errorCode:CARD_READER_GENERAL_ERROR) occurs while reading, after a few seconds delay, the reader will automatically start waiting again for another 60 seconds. At that time, CardReaderHandler's onStatusChange() method will be called with status = WAITING_FOR_CARD, and the user can try to swipe/dip again. This behavior can be configured with com.wepay.android.models.Config. WARNING: When this method is called, if the "AUDIOJACK" device is selected via the onCardReaderSelection method in the CardReaderHandler interface, a (normally inaudible) signal is sent to the headphone jack of the phone, where the reader is expected to be connected. If headphones are connected instead of the reader, they may emit a very loud audible tone on receiving this signal. This method should only be called when the user intends to use a reader.

Parameters:

cardReaderHandler - the card reader handler

startTransactionForTokenizing

public void startTransactionForTokenizing(CardReaderHandler cardReaderHandler,
                                          TokenizationHandler tokenizationHandler,
                                          AuthorizationHandler authorizationHandler)

Use this method if you want to tokenize the card info. Non-sensitive info from the card will be returned via the CardReaderHandler interface. The card info will be tokenized by WePay's servers, and the token will be returned via the TokenizationHandler interface. The reader will wait 60 seconds for a card, and then return a timout error if a card is not detected. The reader will automatically stop waiting for card if: - a timeout occurs - a successful swipe/dip is detected - an unexpected error occurs - stopReader is called However, if a general error (errorCategory:ERROR_CATEGORY_CARD_READER, errorCode:CARD_READER_GENERAL_ERROR) occurs while reading, after a few seconds delay, the reader will automatically start waiting again for another 60 seconds. At that time, CardReaderHandler's onStatusChange() method will be called with status = WAITING_FOR_CARD, and the user can try to swipe/dip again. This behavior can be configured with com.wepay.android.models.Config. WARNING: When this method is called, if the "AUDIOJACK" device is selected via the onCardReaderSelection method in the CardReaderHandler interface, a (normally inaudible) signal is sent to the headphone jack of the phone, where the reader is expected to be connected. If headphones are connected instead of the reader, they may emit a very loud audible tone on receiving this signal. This method should only be called when the user intends to use a reader.

Parameters:

cardReaderHandler - the card reader handler

tokenizationHandler - the tokenization handler

authorizationHandler - the authorization handler

stopCardReader

public void stopCardReader()

Stops the reader. In response, CardReaderHandler's onStatusChange() method will be called with status = STOPPED. The status can only be returned if you've provided a CardReaderHandler by starting a card reader operation after the WePay object was initialized. Any operation in progress may not stop, and its result will be delivered to the appropriate handler.

calibrateCardReader

public void calibrateCardReader(CalibrationHandler calibrationHandler)

Use this method to try calibrating a charged card reader that doesn't seem to work on a device. If successful, we will store the calibration parameters on the device, and use them to connect to the card reader in future transactions. This operation only needs to be performed once during first-time setup, and only if the card reader is not automatically detected on a device.

Parameters:

calibrationHandler - the calibration handler

getCardReaderBatteryLevel

public void getCardReaderBatteryLevel(CardReaderHandler cardReaderHandler,
                                      BatteryLevelHandler batteryLevelHandler)

Use this method to get the current battery level of the card reader. If no card reader is currently connected, this method will try to find and connect to one.

Parameters:

cardReaderHandler - the card reader handler

batteryLevelHandler - the battery level handler

tokenize

public void tokenize(PaymentInfo paymentInfo,
                     TokenizationHandler tokenizationHandler)

Use this method to tokenize any PaymentInfo object, such as one representing credit card info obtained manually. The payment info will be tokenized by WePay's servers, and the token will be returned via the TokenizationHandler interface.

Parameters:

paymentInfo - the payment info to be tokenized

tokenizationHandler - the tokenization handler

storeSignatureImage

public void storeSignatureImage(android.graphics.Bitmap image,
                                java.lang.String checkoutId,
                                CheckoutHandler checkoutHandler)

Use this method to store a signature image associated with a checkout id on WePay's servers. The signature can be retrieved via a server-to-server call that fetches the checkout object. The aspect ratio (width:height) of the image must be between 1:4 and 4:1. If needed, the image will internally be scaled to fit inside 256x256 pixels, while maintaining the original aspect ratio.

Parameters:

image - the signature image to be stored.

checkoutId - the checkout id associated with the signature

checkoutHandler - the signature handler

getRememberedCardReader

public java.lang.String getRememberedCardReader()

Use this method to get the name of the most recently used card reader.

Returns:

the name of the card reader.

forgetRememberedCardReader

public void forgetRememberedCardReader()

Use this method to clear the name of the most recently used card reader.