WPPaymentInfo Class Reference

#import <WPPaymentInfo.h>

Inheritance diagram for WPPaymentInfo:

Instance Methods
(instancetype)	- initWithSwipedInfo:
(instancetype)	- initWithEMVInfo:
(instancetype)	- initWithFirstName:lastName:email:billingAddress:shippingAddress:cardNumber:cvv:expMonth:expYear:virtualTerminal:
(void)	- addEmail:

Properties
NSString *	firstName
NSString *	lastName
NSString *	email
NSString *	paymentDescription
BOOL	isVirtualTerminal
WPAddress *	billingAddress
WPAddress *	shippingAddress
id	paymentMethod
id	swiperInfo
id	manualInfo
id	emvInfo

Detailed Description

An instance of this class represents the payment information obtained from the user via any of the supported payment methods. It is used as input for tokenization operations.

Method Documentation

addEmail:()

- (void) addEmail:

(NSString *)

email

Allows adding an email if one is not already present. The call will be ignored if an email is already present.

Parameters

email

the email address to be added

initWithFirstName:lastName:email:billingAddress:shippingAddress:cardNumber:cvv:expMonth:expYear:virtualTerminal:()

- (instancetype) initWithFirstName:		(NSString *)	firstName
lastName:		(NSString *)	lastName
email:		(NSString *)	email
billingAddress:		(WPAddress *)	billingAddress
shippingAddress:		(WPAddress *)	shippingAddress
cardNumber:		(NSString *)	cardNumber
cvv:		(NSString *)	cvv
expMonth:		(NSString *)	expMonth
expYear:		(NSString *)	expYear
virtualTerminal:		(BOOL)	virtualTerminal

Initializes a WPPaymentInfo instance of type kWPPaymentMethodManual.

Parameters

firstName	First name of the payer.
lastName	Last name of the payer.
email	Email address of the payer.
billingAddress	Billing address.
shippingAddress	Shipping address.
cardNumber	The card number.
cvv	The cvv code.
expMonth	The 2-digit expiration month on the credit card.
expYear	The 4-digit expiration year on the credit card.
virtualTerminal	The virtual terminal flag - should be false if payment info was collected on the payer's device.

Returns

A WPPaymentInfo object initialized with manually obtained card info.

Property Documentation

billingAddress

- (WPAddress*) billingAddress

readnonatomicstrong

Billing address.

email

- (NSString*) email

readnonatomicstrong

Email address of the payer.

emvInfo

- (id) emvInfo

readnonatomicstrong

Additional info obtained by using the EMV payment method.

firstName

- (NSString*) firstName

readnonatomicstrong

First name of the payer.

isVirtualTerminal

- (BOOL) isVirtualTerminal

readnonatomicassign

Determines if the card was obtained in virtual terminal mode.

lastName

- (NSString*) lastName

readnonatomicstrong

Last name of the payer.

manualInfo

- (id) manualInfo

readnonatomicstrong

Additional info obtained by using the Manual payment method.

paymentDescription

- (NSString*) paymentDescription

readnonatomicstrong

Masked representation of the payment instrument. e.g. XXXXXXXXXXXX1234 Note: the display format may change depending on the payment instrument and the payment method, so this field should not be parsed. It is meant for display to the end user as-is.

paymentMethod

- (id) paymentMethod

readnonatomicstrong

The payment method used, one of (kWPPaymentMethodManual, kWPPaymentMethodSwipe, kWPPaymentMethodDip).

shippingAddress

- (WPAddress*) shippingAddress

readnonatomicstrong

Shipping address.

swiperInfo

- (id) swiperInfo

readnonatomicstrong

Additional info obtained by using the Swipe payment method.

---

The documentation for this class was generated from the following file:

• WPPaymentInfo.h