WDPayment Class Reference

Base class of all Payment Methods. More...

#import <WDPayment.h>

Inheritance diagram for WDPayment:

Collaboration diagram for WDPayment:

Public Instance Methods
(nullable WDNotification *)	- notificationForState:
	Returns the notification for transaction state. More...
Public Instance Methods inherited from NSObject
(Class)	- classForCoder
(id)	- copy
(void)	- dealloc
(void)	- finalize
(id)	- init
(id)	- mutableCopy
Public Instance Methods inherited from <NSObject>
(NSString *)	- description
(NSUInteger)	- hash
(BOOL)	- isEqual:

Properties
NSString *	requestSignature
	Authorize client to process the transaction. More...
NSDate *	requestTimestamp
	Date when requestSignature was generated. More...
NSString *	signature
	2nd generation signature. Authorize client to process the transaction. checkPayment works only with this signature. More...
NSString *	merchantAccountID
	Unique identifier assigned for every Merchant Account. More...
NSString *	merchantAccountResolverCategory
	Category used by frontend merchant to resolve internal merchant for processing payment. More...
NSString *	requestID
	Unique identifier associated with the transaction, which is created by the merchant. More...
NSDecimalNumber *	amount
	The only amount that accompanies the transaction when it is created and/or requested. More...
WDCurrency	amountCurrency
	Currency in which the transaction is processed. More...
WDTransactionType	transactionType
	Determines transaction processing behaviour. More...
WDCustomerData *	accountHolder
	Customer's account information. More...
WDCustomerData *	shipping
	Customer's shipping information. More...
WDOrder *	order
	Customer's order information. More...
NSArray< WDNotification * > *	notifications
	Notifications configuration. More...
NSString *	IPAddress
	The IP Address of the Customer as recorded by the entity receiving the Transaction Attempt from the Customer. More...
WDLocale	locale
	Defines the user's language and any special variant preferences that the user wants to see in their user interface. More...
NSString *	parentTransactionID
	transaction identifier of previous transaction gathered by [WDPaymentResponse transactionIdentifier] More...

Additional Inherited Members
Public Class Methods inherited from NSObject
(id)	+ alloc
(Class)	+ class
(void)	+ initialize
(void)	+ load
(id)	+ new

Detailed Description

Base class of all Payment Methods.

Initialization WDPayment object is unavailable. Please use derived classes for initialization.

Method Documentation

- (nullable WDNotification *) notificationForState:

(WDTransactionState)

state

Returns the notification for transaction state.

Parameters

state

The transaction state defined by WDTransactionState enumaration

Returns

Returns notification or nil if no associated notification.

Property Documentation

- (WDCustomerData*) accountHolder

readwritenonatomicstrong

Customer's account information.

It is optional.

- (NSDecimalNumber*) amount

readwritenonatomicstrong

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

For transactionType WDTransactionTypeAuthorizationOnly the only valid value is [NSDecimalNumber zero]. It is mandatory.

- (WDCurrency) amountCurrency

readwritenonatomicassign

Currency in which the transaction is processed.

It is mandatory.

- (NSString*) IPAddress

readwritenonatomicstrong

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

It is optional.

- (WDLocale) locale

readwritenonatomicassign

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

Typically used by WDPayPalPayment and 3D Secure WDCardPayment HTML formulars. It is optional.

- (NSString*) merchantAccountID

readwritenonatomicstrong

Unique identifier assigned for every Merchant Account.

It is mandatory.

- (NSString*) merchantAccountResolverCategory

readwritenonatomicstrong

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

It is optional.

- (NSArray<WDNotification *>*) notifications

readwritenonatomicstrong

Notifications configuration.

It is optional.

- (WDOrder*) order

readwritenonatomicstrong

Customer's order information.

It is optional.

- (NSString*) parentTransactionID

readwritenonatomicstrong

transaction identifier of previous transaction gathered by [WDPaymentResponse transactionIdentifier]

It is used with referenced transactions: WDTransactionTypeCaptureAuthorization, WDTransactionTypeReferencedAuthorization, WDTransactionTypeReferencedPurchase, WDTransactionTypeRefundCapture, WDTransactionTypeRefundPurchase and WDTransactionTypeVoidAuthorization

- (NSString*) requestID

readwritenonatomicstrong

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

It is mandatory.

- (NSString*) requestSignature

readwritenonatomicstrong

Authorize client to process the transaction.

It is mandatory.

- (NSDate*) requestTimestamp

readwritenonatomicstrong

Date when requestSignature was generated.

It is mandatory for requestSignature

- (WDCustomerData*) shipping

readwritenonatomicstrong

Customer's shipping information.

It is optional.

- (NSString*) signature

readwritenonatomiccopy

2nd generation signature. Authorize client to process the transaction. checkPayment works only with this signature.

It is mandatory. It supersedes requestSignature and requestTimestamp.

- (WDTransactionType) transactionType

readwritenonatomicassign

Determines transaction processing behaviour.

It is mandatory.