de.wirecard.paymentsdk.models.WirecardPayment Class Reference

Base class of all Payment Methods. More...

Inheritance diagram for de.wirecard.paymentsdk.models.WirecardPayment:

Collaboration diagram for de.wirecard.paymentsdk.models.WirecardPayment:

Public Instance Methods
String	getRequestTimeStamp ()
	Returns date when requestSignature was generated. More...
void	setRequestTimeStamp (String requestTimeStamp)
	Sets date when requestSignature was generated. More...
String	getRequestID ()
	Returns unique identifier associated with the transaction, which is created by the merchant. More...
void	setRequestID (String requestID)
	Sets unique identifier associated with the transaction, which is created by the merchant. More...
String	getMerchantAccountID ()
	Returns unique identifier assigned for every Merchant Account. More...
void	setMerchantAccountID (String merchantAccountID)
	Sets unique identifier assigned for every Merchant Account. More...
WirecardTransactionType	getTransactionType ()
	Returns determines transaction processing behaviour. More...
void	setTransactionType (WirecardTransactionType transactionType)
	Sets determines transaction processing behaviour. More...
BigDecimal	getAmount ()
	Returns the only amount that accompanies the transaction when it is created and/or requested. More...
void	setAmount (BigDecimal amount)
	Sets the only amount that accompanies the transaction when it is created and/or requested. More...
String	getCurrency ()
	Returns currency in which the transaction is processed. More...
void	setCurrency (String currency)
	Sets currency in which the transaction is processed. More...
String	getRequestSignature ()
	Returns request signature - authorize client to process the transaction. More...
void	setRequestSignature (String requestSignature)
	Sets request signature - authorize client to process the transaction. More...
String	getParentTransactionID ()
	Returns transaction ID of the first transaction in the series. More...
void	setParentTransactionID (String parentTransactionID)
	Sets transaction ID of the first transaction in the series. More...
Order	getOrder ()
	Returns customer's order information. More...
void	setOrder (Order order)
	Sets customer's order information. More...
CustomerData	getAccountHolder ()
	Returns customer's order information. More...
void	setAccountHolder (CustomerData accountHolder)
	Sets customer's order information. More...
CustomerData	getShippingAddress ()
	Returns customer's shipping information. More...
void	setShippingAddress (CustomerData shippingAddress)
	Sets customer's shipping information. More...
List< Notification >	getNotifications ()
	Returns list of notifications configuration. More...
void	setNotifications (List< Notification > notifications)
	Sets list of notifications configuration. More...
String	getIpAddress ()
	Returns the IP Address of the Customer as recorded by the entity receiving the Transaction Attempt from the Customer. More...
void	setIpAddress (String ipAddress)
	Sets the IP Address of the Customer as recorded by the entity receiving the Transaction Attempt from the Customer. More...
String	getLocale ()
	Returns locale - defines the user's language and any special variant preferences that the user wants to see in their user interface. More...
void	setLocale (String locale)
	Sets locale - defines the user's language and any special variant preferences that the user wants to see in their user interface. More...
String	getMerchantAccountResolverCategory ()
	Sets merchant account resolver category - category used by frontend merchant to resolve internal merchant for processing payment. More...
void	setMerchantAccountResolverCategory (String merchantAccountResolverCategory)
	Sets merchant account resolver category - category used by frontend merchant to resolve internal merchant for processing payment. More...
String	getSignature ()
	Returns signature - authorize client to process the transaction. More...
void	setSignature (String signature)
	Sets signature - authorize client to process the transaction. More...

Protected Instance Methods
	WirecardPayment (String requestTimeStamp, String requestID, String merchantAccountID, WirecardTransactionType transactionType, BigDecimal amount, String currency, String requestSignature)
	WirecardPayment (String signature, String requestTimeStamp, String requestID, String merchantAccountID, WirecardTransactionType transactionType, BigDecimal amount, String currency)

Private Fields
String	requestTimeStamp
	Date when requestSignature was generated. More...
String	requestID
	Unique identifier associated with the transaction, which is created by the merchant. More...
String	merchantAccountID
	Unique identifier assigned for every Merchant Account. More...
String	merchantAccountResolverCategory
	Category used by frontend merchant to resolve internal merchant for processing payment. More...
String	parentTransactionID
	Transaction ID of the first transaction in the series. More...
String	requestSignature
	Authorize client to process the transaction. More...
String	currency
	Currency in which the transaction is processed. More...
String	ipAddress
	The IP Address of the Customer as recorded by the entity receiving the Transaction Attempt from the Customer. More...
String	locale
	Defines the user's language and any special variant preferences that the user wants to see in their user interface. More...
CustomerData	accountHolder
	Customer's account information. More...
CustomerData	shippingAddress
	Customer's shipping information. More...
WirecardTransactionType	transactionType
	Determines transaction processing behaviour. More...
BigDecimal	amount
	The only amount that accompanies the transaction when it is created and/or requested. More...
Order	order
	Customer's order information. More...
List< Notification >	notifications
	Notifications configuration. More...
String	signature
	Authorize client to process the transaction. More...

Detailed Description

Base class of all Payment Methods.

Constructor & Destructor Documentation

de.wirecard.paymentsdk.models.WirecardPayment.WirecardPayment ( String  requestTimeStamp, String  requestID, String  merchantAccountID, WirecardTransactionType  transactionType, BigDecimal  amount, String  currency, String  requestSignature  )

inlineprotected

de.wirecard.paymentsdk.models.WirecardPayment.WirecardPayment ( String  signature, String  requestTimeStamp, String  requestID, String  merchantAccountID, WirecardTransactionType  transactionType, BigDecimal  amount, String  currency  )

inlineprotected

Method Documentation

CustomerData de.wirecard.paymentsdk.models.WirecardPayment.getAccountHolder ( )

inline

Returns customer's order information.

Returns

BigDecimal de.wirecard.paymentsdk.models.WirecardPayment.getAmount ( )

inline

Returns the only amount that accompanies the transaction when it is created and/or requested.

Returns

String de.wirecard.paymentsdk.models.WirecardPayment.getCurrency ( )

inline

Returns currency in which the transaction is processed.

Returns

String de.wirecard.paymentsdk.models.WirecardPayment.getIpAddress ( )

inline

Returns the IP Address of the Customer as recorded by the entity receiving the Transaction Attempt from the Customer.

Returns

String de.wirecard.paymentsdk.models.WirecardPayment.getLocale ( )

inline

Returns locale - defines the user's language and any special variant preferences that the user wants to see in their user interface.

Returns

String de.wirecard.paymentsdk.models.WirecardPayment.getMerchantAccountID ( )

inline

Returns unique identifier assigned for every Merchant Account.

Returns

String de.wirecard.paymentsdk.models.WirecardPayment.getMerchantAccountResolverCategory ( )

inline

Sets merchant account resolver category - category used by frontend merchant to resolve internal merchant for processing payment.

List<Notification> de.wirecard.paymentsdk.models.WirecardPayment.getNotifications ( )

inline

Returns list of notifications configuration.

Returns

Order de.wirecard.paymentsdk.models.WirecardPayment.getOrder ( )

inline

Returns customer's order information.

Returns

String de.wirecard.paymentsdk.models.WirecardPayment.getParentTransactionID ( )

inline

Returns transaction ID of the first transaction in the series.

Returns

String de.wirecard.paymentsdk.models.WirecardPayment.getRequestID ( )

inline

Returns unique identifier associated with the transaction, which is created by the merchant.

Returns

String de.wirecard.paymentsdk.models.WirecardPayment.getRequestSignature ( )

inline

Returns request signature - authorize client to process the transaction.

Returns

Deprecated:

Use getSignature() method instead. For more information see online documentation.

String de.wirecard.paymentsdk.models.WirecardPayment.getRequestTimeStamp ( )

inline

Returns date when requestSignature was generated.

Returns

CustomerData de.wirecard.paymentsdk.models.WirecardPayment.getShippingAddress ( )

inline

Returns customer's shipping information.

Returns

String de.wirecard.paymentsdk.models.WirecardPayment.getSignature ( )

inline

Returns signature - authorize client to process the transaction.

Returns

WirecardTransactionType de.wirecard.paymentsdk.models.WirecardPayment.getTransactionType ( )

inline

Returns determines transaction processing behaviour.

Returns

void de.wirecard.paymentsdk.models.WirecardPayment.setAccountHolder ( CustomerData  accountHolder )

inline

Sets customer's order information.

Parameters

accountHolder

void de.wirecard.paymentsdk.models.WirecardPayment.setAmount ( BigDecimal  amount )

inline

Sets the only amount that accompanies the transaction when it is created and/or requested.

Parameters

amount

void de.wirecard.paymentsdk.models.WirecardPayment.setCurrency ( String  currency )

inline

Sets currency in which the transaction is processed.

Parameters

currency

void de.wirecard.paymentsdk.models.WirecardPayment.setIpAddress ( String  ipAddress )

inline

Sets the IP Address of the Customer as recorded by the entity receiving the Transaction Attempt from the Customer.

Parameters

ipAddress

void de.wirecard.paymentsdk.models.WirecardPayment.setLocale ( String  locale )

inline

Sets locale - defines the user's language and any special variant preferences that the user wants to see in their user interface.

Parameters

locale

void de.wirecard.paymentsdk.models.WirecardPayment.setMerchantAccountID ( String  merchantAccountID )

inline

Sets unique identifier assigned for every Merchant Account.

Parameters

merchantAccountID

void de.wirecard.paymentsdk.models.WirecardPayment.setMerchantAccountResolverCategory ( String  merchantAccountResolverCategory )

inline

Sets merchant account resolver category - category used by frontend merchant to resolve internal merchant for processing payment.

Parameters

merchantAccountResolverCategory

void de.wirecard.paymentsdk.models.WirecardPayment.setNotifications ( List< Notification >  notifications )

inline

Sets list of notifications configuration.

Parameters

notifications

void de.wirecard.paymentsdk.models.WirecardPayment.setOrder ( Order  order )

inline

Sets customer's order information.

Parameters

order

void de.wirecard.paymentsdk.models.WirecardPayment.setParentTransactionID ( String  parentTransactionID )

inline

Sets transaction ID of the first transaction in the series.

Parameters

parentTransactionID

void de.wirecard.paymentsdk.models.WirecardPayment.setRequestID ( String  requestID )

inline

Sets unique identifier associated with the transaction, which is created by the merchant.

Parameters

requestID

void de.wirecard.paymentsdk.models.WirecardPayment.setRequestSignature ( String  requestSignature )

inline

Sets request signature - authorize client to process the transaction.

Parameters

requestSignature

Deprecated:

Use setSignature() method instead. For more information see online documentation.

void de.wirecard.paymentsdk.models.WirecardPayment.setRequestTimeStamp ( String  requestTimeStamp )

inline

Sets date when requestSignature was generated.

Parameters

requestTimeStamp

void de.wirecard.paymentsdk.models.WirecardPayment.setShippingAddress ( CustomerData  shippingAddress )

inline

Sets customer's shipping information.

Parameters

shippingAddress

void de.wirecard.paymentsdk.models.WirecardPayment.setSignature ( String  signature )

inline

Sets signature - authorize client to process the transaction.

Parameters

signature

void de.wirecard.paymentsdk.models.WirecardPayment.setTransactionType ( WirecardTransactionType  transactionType )

inline

Sets determines transaction processing behaviour.

Parameters

transactionType

Member Data Documentation

CustomerData de.wirecard.paymentsdk.models.WirecardPayment.accountHolder

private

Customer's account information.

BigDecimal de.wirecard.paymentsdk.models.WirecardPayment.amount

private

The only amount that accompanies the transaction when it is created and/or requested.

String de.wirecard.paymentsdk.models.WirecardPayment.currency

private

Currency in which the transaction is processed.

String de.wirecard.paymentsdk.models.WirecardPayment.ipAddress

private

The IP Address of the Customer as recorded by the entity receiving the Transaction Attempt from the Customer.

String de.wirecard.paymentsdk.models.WirecardPayment.locale

private

Defines the user's language and any special variant preferences that the user wants to see in their user interface.

String de.wirecard.paymentsdk.models.WirecardPayment.merchantAccountID

private

Unique identifier assigned for every Merchant Account.

String de.wirecard.paymentsdk.models.WirecardPayment.merchantAccountResolverCategory

private

Category used by frontend merchant to resolve internal merchant for processing payment.

It is optional.

List<Notification> de.wirecard.paymentsdk.models.WirecardPayment.notifications

private

Notifications configuration.

Order de.wirecard.paymentsdk.models.WirecardPayment.order

private

Customer's order information.

String de.wirecard.paymentsdk.models.WirecardPayment.parentTransactionID

private

Transaction ID of the first transaction in the series.

String de.wirecard.paymentsdk.models.WirecardPayment.requestID

private

Unique identifier associated with the transaction, which is created by the merchant.

String de.wirecard.paymentsdk.models.WirecardPayment.requestSignature

private

Authorize client to process the transaction.

Deprecated:

Use signature field only. For more information see online documentation.

String de.wirecard.paymentsdk.models.WirecardPayment.requestTimeStamp

private

Date when requestSignature was generated.

CustomerData de.wirecard.paymentsdk.models.WirecardPayment.shippingAddress

private

Customer's shipping information.

String de.wirecard.paymentsdk.models.WirecardPayment.signature

private

Authorize client to process the transaction.

WirecardTransactionType de.wirecard.paymentsdk.models.WirecardPayment.transactionType

private

Determines transaction processing behaviour.