Class AuthorizeTransactionWithCustomerRequest

Properties

NAME	TYPE	LENGTH	REQUIRED	DESCRIPTION
storeId	long		Y	Unique user ID generated by EPS. (See - Required Data Elements)
storeKey	string		Y	Unique password generated by EPS. (See - Required Data Elements)
WSCustomer	WSCustomer
createCustomerIfDoesNotExists	Bool			Should a customer be created? Valid values are: 1 - Yes 0 - No
updateCustomerIfExists	bool			Should the customer information be updated if it already exists? Valid values are: 1 – Yes (CustomerNumber required) 0 - No
WSTransaction	WSTransaction
ownerApplication	enum of type WSOwnerApplication			Valid Value is: Web_Service Can be Null; can’t be empty.(See - Optional Data Elements)
holdDays	tinyInt	1		This is an optional element which defines the hold days at the transaction level. This element is not applicable to IRD transactions. Possible values are 0-7 Default to 255/Null. Note: This element cannot be Empty or Blank. User must provide 255 or Null if they don’t want hold days at transaction. Additional Permission is required to apply holdDays.
bypassSmartDetect	bool			This is an optional element which will bypass the SmartDetect Service. Possible values are: 0 = False; 1 = True and Null Default to False Note: This element cannot be empty or blank. If you are not using the SmartDetect service, you must provide a value of False or Null. If you are using the SmartDetect service but do not wish to bypass SmartDetect for a given transaction, you must also provide a value of False or Null.

WSCustomer

NAME	TYPE	LENGTH	REQUIRED	DESCRIPTION
EntityId	int		Y	Unique identifier that is generated by EPS. (See - Required Data Elements)
IsCompany	bool		Y	Identifies a customer as an individual or business. (See - Optional Data Elements)
CustomerNumber	string	50	Y*	A unique identifier that references a specific customer. It is a required element whose value can be supplied by the user or left blank. If this element is included in the request and it is left blank, a system-generated value will be assigned. It is highly recommended that users assign their own unique value to this element to facilitate any update of their customer’s information. *Required when updateCustomerIfExists is ‘Yes’.
Field1	string	50		Optional information associated with a customer. Data is stored with the customer. Indexed field.
Field2	string	50		Optional information associated with a customer.
Field3	string	50		Optional information associated with a customer.
FirstName	string	30		This is the first name of an Individual customer (IsCompany = False). The element can be left blank if this is a business customer (IsCompany = True).
LastName	string	60	Y*	This is either the last name of an individual customer or the company name on a business account. *This element is required if createCustomerIfDoesNotExists OR updateCustomerIfExists = 1.
Email	string	60		Customer’s email address.
OtherEmail	string	120		Any additional email addresses associated with this customer.
Address1	string	50		Customer’s home or business address.
Address2	string	50		Additional home or business addresses information.
City	string	40		The City where this address is located.
StateRegion	string	40		The state where this address is located.
PostalCode	string	10		The zip or postal code of this address.
Country	string	40		The country where this address is located.
EveningPhone	string	14		A phone number where the customer can be reached in the evening.
EveningExt	string	6		The extension needed to reach the customer in the evening, if applicable.
DaytimePhone	string	14		The phone number where the customer can be reached during the day.
DaytimeExt	string	6		The extension needed to reach the customer during the day, if applicable.
Fax	string	20		A fax number associated with this customer, if available.
SSN	string	15		The customer’s Social Security Number.
DLState	string	2		The state associated with the customer’s driver’s license.
DLNumber	string	30		The customer’s driver’s license number.

WSTransaction

NAME	TYPE	LENGTH	REQUIRED	DESCRIPTION
EntityId	int		Y	Unique identifier that is generated by EPS. (See - Required Data Elements)
LocationId	int		Y	Unique identifier generated by EPS for each location. (See - Required Data Elements)
PaymentOrigin	enum of Type WSPaymentOrigin			Identifies by what method the transaction was originated.(See - Optional Data Elements & PaymentOrigin Element Relationships) Valid values are: Back_Office Bounced_Check Drop_Box Internet Mailed_In Represented_Check Retail__POS Telephone_IVR Telephone_Operator Signature_Faxed Signature_Original Corporate_Trade_Excha nge If null, the default value of ‘Internet’ is assumed.
AccountType	enum of Type WSAccountType		Y*	Valid values are: Checking Savings Treasury_Check Money_Order Travelers_Check Convenience_Check Visa MasterCard Discover__Novus American_Express Diners__Carte_Blanche enRoute JCB Bank_Card Gift_Card On_Us_Card Payroll_Card Cashiers_Check Virtual Card __None *NOTE: Required for Credit Card transactions.(See - Optional Data Elements) for handling of Checking or Savings accounts. If Null, and the RoutingNumber element is supplied, the default value of ‘Checking’ is used.
OperationType	enum of Type WSOperationType			Valid values are: Sale Auth Auth_Only Credit __NONE SDCredit (See - Special Requirements) SDSale (See - Special Requirements) Reversal If null, the default value of ‘Sale’ is assumed. (See - Optional Data Elements)
SettlementType	enum of Type WSSettlementType			Valid values are: ACH Check_Image Card_Transfer None If null, the default value of ‘ACH’ will be assumed. (See - Optional Data Elements)
TransactionStatus	enum of Type WSTransactionStatus			Do NOT include this element in your request. The appropriate value will be set by EPS.
SettlementStatus	enum of Type WSSettlementStatus			Do NOT include this element in your request. The appropriate value will be set by EPS.
EffectiveDate	dateTime			Date and time of the transaction. If null, the current date and time is assumed. NOTE: This element does not require the Time to be included. (See - Optional Data Elements)
Description	string	50		This optional element can be used to define or explain the purpose of this transaction.
TotalAmount	decimal		Y	Dollar amount of the transaction. This element cannot be zero (0) or negative.
TaxAmount	decimal			Not used at this time. (See - Optional Data Elements)
ShippingAmount	decimal			Not used at this time. (See - Optional Data Elements)
Sale	string			Applicable to Credit Card transactions only. Not used at this time. No input required.
ConvenienceFeeAmount	string			Applicable to Credit Card transactions only. Fee added to the face value of the transaction.
BatchNumber	string	40		Supply only if a unique user-assigned batch number was created using CreateProcessingBatch and the user wants to include this transaction in that batch. If not, leave it blank or don’t include it in the request.
TerminalNumber	string	20		(See - Optional Data Elements)
TransactionNumber	string	50	Y	Unique user-assigned identifier of the transaction being created.
Field1	string	50		Optional information associated with the transaction. Data is stored with the transaction. Indexed field.
Field2	string	50		Optional information associated with the transaction.
Field3	string	50		Optional information associated with the transaction.
CheckMICRLine	string		Y*	*Scanned MICR line of the check. (See - PaymentOrigin Element Relationships)
CheckMICRSymbolSet	string		Y*	*Identifies the symbol set used by the scanner (e.g. “TOAD ?”). (See - PaymentOrigin Element Relationships)
RoutingNumber	string	9	Y*	*Bank Routing/Transit or ABA number. (See - PaymentOrigin Element Relationships)
AccountNumber	string	17	Y*	*This element represents the customer’s account number. Checking or Savings accounts: 3-17 digits; Credit Card accounts: 16 digits or less. (See - PaymentOrigin Element Relationships)
CheckNumber	string	17	Y*	*Required if the ACH transaction PaymentOrigin is Bounced_Check or Represented_Check. (See - PaymentOrigin Element Relationships)
SwipeTrack1	string			Credit Card only. Track 1 for device used for card swipe.
SwipeTrack2	string			Credit Card only. Track 2 for device used for card swipe.
SwipeTrack3	string			Credit Card only. Track 3 for device used for card swipe.
CardExpiresMonth	byte	2	Y*	*Required for Credit Card accounts only if SwipeTrack2 is not included. Valid values must be between 01 and 12. Element should be removed if this is a checking or savings account
CardExpiresYear	short	2	Y*	*Required for Credit Card accounts only if SwipeTrack2 is not included. Valid values must not exceed 10 years out from the current year. (I.e. for year 2011, the value cannot be greater than 2021). Element should be removed if this is a checking or savings account.
CVVNumber	int	4	Y*	*Required for Credit Card accounts only. This element cannot be null or empty. If a value is not available, enter 0.
IsBusinessPayment	bool			Identifies the ACH only transaction as either drawn on a business or personal account. (See - Optional Data Elements) Valid values are: 1 (True) or 0 (False).
NameOnAccount	string	50	Y*	Customer’s name as it appears on their card or account. *This field is required for ALL Credit Card transactions and for SettlementType Check_Image or ACH when PaymentOrigin is Internet (WEB), Telephone_IVR, Telephone_Operator, Signature_Faxed, Signature_Original, Retail__POS, Represented_Check, Bounced_Check OR Corporate_Trade_Exchange
BillingAddress1	string	50		Street address associated with this account.
BillingAddress2	string	50		Additional street address information associated with this account.
BillingCity	string	40		City associated with this account.
BillingStateRegion	string	40		State/Region associated with this account.
BillingPostalCode	string	10		Zip/Postal Code associated with this account.
BillingCountry	string	40		Country associated with this account.
BillingPhone	string	14		Telephone number associated with this account, if available.
IPAddressOfOriginator	string	15		IP address of person sending request.
EmailAddress	string	60		Email address associated with this account, if available.
SSN	string	15		Social Security Number associated with this account, if available.
DLState	string	2		State where the driver’s license associated with this account is registered, if available.
DLNumber	string	30		Driver’s license number associated with this account, if available.
NotificationMethod	enum of Type WSNotificationMethod			Method by which a merchant’s customer will be notified of an ACH or Credit Card transaction. Valid values are: Merchant_Notify Merchant_Recording Postcard Email If null, the default value ‘Merchant_Notify’ is assumed.(See - Optional Data Elements)
FaceFeeType	enum of Type WSFaceFeeType			Valid values are: __None Face Bill_Convenience_Face NSF_Fee Bill_Convenience_Fee If set to‘__None’ or Null, the default value ‘Face’ will be used. (See - Optional Data Elements)
CheckFrontImageBytes_TiffG4	Binary		Y*	*Compressed image of the front of a scanned check. (See - PaymentOrigin Element Relationships)
CheckRearImageBytes_TiffG4	Binary			Compressed image of the back of a scanned check.
OptionalThirdImageBytes_TiffG4	Binary			Encoded image of the check.
OptionalThirdImageDescription	string	50		Description of the optional third scanned document image
PresentmentNumber	int		Y*	The value in this element indicates which representment of the item this is. *Required for RCK (Bounced_Check or Represented_Check) Optional for ARC, BOC, POP, PPD & TEL represented Face and NSF-Fee transactions. Valid values are: 1 – First Representment. 2 – Second Representment. Do not include this element if the item is the original transaction.(See - Optional Data Elements)
companyEntryDescription	string	10		Requested ACH Company Entry Description to use for the transaction in the ACH Batch Header. Note: Provided ACH Company Entry Description value may be overwritten with a system value where required.

Examples

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:pv="https://ssl.selectpayment.com/PV">
<soapenv:Header/>
	<soapenv:Body>
		<pv:AuthorizeTransactionWithCustomer>
			<pv:storeId>123456</pv:storeId>
			<pv:storeKey>3z9em9oxqwX3acsaqc6H0ck8D3Yj</pv:storeKey>
			<pv:customer>
				<pv:EntityId>12345</pv:EntityId>
				<pv:IsCompany>1</pv:IsCompany>
				<pv:CustomerNumber>102030</pv:CustomerNumber>
				<pv:Field1></pv:Field1>
				<pv:Field2></pv:Field2>
				<pv:Field3></pv:Field3>
				<pv:FirstName></pv:FirstName>
				<pv:LastName>Global Transportation</pv:LastName>
				<pv:Email></pv:Email>
				<pv:OtherEmail></pv:OtherEmail>
				<pv:Address1>1231 Lakeview Hwy</pv:Address1>
				<pv:Address2></pv:Address2>
				<pv:City>Miami</pv:City>
				<pv:StateRegion>FL</pv:StateRegion>
				<pv:PostalCode>60332</pv:PostalCode>
				<pv:Country>USA</pv:Country>
				<pv:EveningPhone></pv:EveningPhone>
				<pv:EveningExt></pv:EveningExt>
				<pv:DaytimePhone></pv:DaytimePhone>
				<pv:DaytimeExt></pv:DaytimeExt>
				<pv:Fax></pv:Fax>
				<pv:SSN></pv:SSN>
				<pv:DLState></pv:DLState>
				<pv:DLNumber></pv:DLNumber>
			</pv:customer>
			<pv:createCustomerIfDoesNotExists>1</pv:createCustomerIfDoesNotExists>
			<pv:updateCustomerIfExists>0</pv:updateCustomerIfExists>
			<pv:transaction>
				<pv:EntityId>12345</pv:EntityId>
				<pv:LocationId>102030</pv:LocationId>
				<pv:PaymentOrigin>Signature_Original</pv:PaymentOrigin>
				<pv:AccountType>Checking</pv:AccountType>
				<pv:OperationType>Sale</pv:OperationType>
				<pv:SettlementType>ACH</pv:SettlementType>
				<pv:EffectiveDate>2011-02-17</pv:EffectiveDate>
				<pv:Description></pv:Description>
				<pv:TotalAmount>117.22</pv:TotalAmount>
				<pv:Sale></pv:Sale>
				<pv:ConvenienceFeeAmount></pv:ConvenienceFeeAmount>
				<pv:BatchNumber></pv:BatchNumber>
				<pv:TerminalNumber>__WebService</pv:TerminalNumber>
				<pv:TransactionNumber>3213</pv:TransactionNumber>
				<pv:Field1>Bldg. 10203</pv:Field1>
				<pv:Field2>Unit 5C</pv:Field2>
				<pv:Field3></pv:Field3>
				<pv:CheckMICRLine></pv:CheckMICRLine>
				<pv:CheckMICRSymbolSet></pv:CheckMICRSymbolSet>
				<pv:RoutingNumber>123456789</pv:RoutingNumber>
				<pv:AccountNumber>12345678901</pv:AccountNumber>
				<pv:CheckNumber></pv:CheckNumber> <!--Optional:-->
				<pv:SwipeTrack1>1254</pv:SwipeTrack1>
				<pv:SwipeTrack2></pv:SwipeTrack2>
				<pv:SwipeTrack3></pv:SwipeTrack3>
				<pv:IsBusinessPayment>1</pv:IsBusinessPayment>
				<pv:NameOnAccount>Global Transportation</pv:NameOnAccount>
				<pv:BillingAddress1></pv:BillingAddress1>
				<pv:BillingAddress2></pv:BillingAddress2>
				<pv:BillingCity></pv:BillingCity>
				<pv:BillingStateRegion></pv:BillingStateRegion>
				<pv:BillingPostalCode></pv:BillingPostalCode>
				<pv:BillingCountry></pv:BillingCountry>
				<pv:BillingPhone></pv:BillingPhone>
				<pv:IpAddressOfOriginator></pv:IpAddressOfOriginator>
				<pv:EmailAddress></pv:EmailAddress>
				<pv:SSN></pv:SSN>
				<pv:DLState></pv:DLState>
				<pv:DLNumber></pv:DLNumber>
				<pv:CheckFrontImageBytes_TiffG4></pv:CheckFrontImageBytes_TiffG4>
				<pv:CheckRearImageBytes_TiffG4></pv:CheckRearImageBytes_TiffG4>
				<pv:OptionalThirdImageBytes_TiffG4></pv:OptionalThirdImageBytes_TiffG4>
				<pv:OptionalThirdImageDescription></pv:OptionalThirdImageDescription>
				<pv:companyEntryDescription>PURCHASE</pv:companyEntryDescription>
			</pv:transaction>
		</pv:AuthorizeTransactionWithCustomer>
	</soapenv:Body>
</soapenv:Envelope>

Properties​

WSCustomer​

WSTransaction​

Examples​

Properties

WSCustomer

WSTransaction

Examples