com.worldpay.cse

Class WorldpayCSE

java.lang.Object

com.worldpay.cse.WorldpayCSE

public class WorldpayCSE
extends java.lang.Object

The main entry point class of the Worldpay CSE(Client Side Encryption) SDK. This class is used to encrypt the provided WPCardData payload.

Example usage:

  WPCardData cardData = new WPCardData();
  cardData.setCardHolderName("John Smith");
  cardData.setCardNumber("444433332221111");
  cardData.setCvc("123");
  cardData.setExpiryMonth("11");
  cardData.setExpiryYear("2020");

  String publicKey = "1#10001#121ad121...";// check setPublicKey(String) for more details
  String encryptedData = "";

  WorldpayCSE worldPayCSE = new WorldpayCSE();
  try {
      worldPayCSE.setPublicKey(publicKey);
      encryptedData = worldPayCSE.encrypt(cardData);
  } catch (WPCSEException e) {
     //show error message
  }

 

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	A_256_GCM
static java.lang.String	API_VERSION
static java.lang.String	CHANNEL
static java.lang.String	LIB_VERSION
static java.lang.String	RSA_1_5

Constructor Summary

Constructors

Constructor and Description
WorldpayCSE() Creates a WorldpayCSE object.

Method Summary

Modifier and Type	Method and Description
java.lang.String	encrypt(WPCardData cardData) Validates and encrypts the supplied card data.
WPPublicKey	getPublicKey() Returns the current public(RSA) key in string format
static boolean	isValidPublicKey(java.lang.String stringKey) Validates in a more convenient way if the public key is valid.
void	setPublicKey(java.lang.String publicKey) Sets the public(RSA) key that will be used for any future encrypt(WPCardData) calls.
void	setPublicKey(WPPublicKey publicKey) Sets the public(RSA) key that will be used for any future encrypt(WPCardData) calls.
static java.util.Set<java.lang.Integer>	validate(WPCardData data) Validates the payment card field values and returns the list of error codes.

Methods inherited from class java.lang.Object

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

Field Detail

RSA_1_5

public static final java.lang.String RSA_1_5

See Also:

Constant Field Values

A_256_GCM

public static final java.lang.String A_256_GCM

See Also:

Constant Field Values

API_VERSION

public static final java.lang.String API_VERSION

See Also:

Constant Field Values

LIB_VERSION

public static final java.lang.String LIB_VERSION

See Also:

Constant Field Values

CHANNEL

public static final java.lang.String CHANNEL

See Also:

Constant Field Values

Constructor Detail

WorldpayCSE

public WorldpayCSE()

Creates a WorldpayCSE object.

Method Detail

setPublicKey

public void setPublicKey(java.lang.String publicKey)
                  throws WPCSEInvalidPublicKey

Sets the public(RSA) key that will be used for any future encrypt(WPCardData) calls.
The key must be provided in the Worldpay format:

sequence#exponent#moduls

Example:

"1#10001#bf49edcaba456c6357e4ace484c3fba212543e78bf
 72a8c2238caaa1c7ed20262956caa61d74840598d9b0707bc8
 2e66f18c8b369c77ae6be0429c93323bb7511fc73d9c7f6988
 72a8384370cd77c7516caa25a195d48701e3e0462d61200983
 ba26cc4a20bb059d5beda09270ea6dcf15dd92084c4d5867b6
 0986151717a8022e4054462ee74ab8533dda77cee227a49fda
 f58eaeb95df90cb8c05ee81f58bec95339b6262633aef216f3
 ae503e8be0650350c48859eef406e63d4399994b147e45aaa1
 4cf9936ac6fdd7d4ec5e66b527d041750ba63a8296b3e6e774
 a02ee6025c6ee66ef54c3688e4844be8951a8435e6b6e8d676
 3d9ee5f16521577e159d"
 

Parameters:

publicKey - the public key in Worldpay text format.

Throws:

WPCSEInvalidPublicKey - if the public key does not adhere to the Worldpay format.

getPublicKey

public WPPublicKey getPublicKey()

Returns the current public(RSA) key in string format

Returns:

a WPPublicKey instance

setPublicKey

public void setPublicKey(WPPublicKey publicKey)

Sets the public(RSA) key that will be used for any future encrypt(WPCardData) calls.

Parameters:

publicKey - a WPPublicKey instance

isValidPublicKey

public static boolean isValidPublicKey(java.lang.String stringKey)

Validates in a more convenient way if the public key is valid. May be useful before calling setPublicKey(String) method and you do not want to handle WPCSEInvalidPublicKey exception.

Parameters:

stringKey - the public key in plain string format

Returns:

true if valid

encrypt

public java.lang.String encrypt(WPCardData cardData)
                         throws WPCSEException

Validates and encrypts the supplied card data. If any validation error occurs, it will throw a WPCSEInvalidCardData exception that contains all error codes.

Parameters:

cardData - An object containing information about the card details to encrypt.

Returns:

The encrypted data to be submitted for processing, or null if a validation error occurs.

Throws:

WPCSEException - could be an instance of WPCSEInvalidCardData or other generic instance.

validate

public static java.util.Set<java.lang.Integer> validate(WPCardData data)

Validates the payment card field values and returns the list of error codes.

Parameters:

data - the WPCardData object

Returns:

the error codes

See Also:

WPValidationErrorCodes