Skip to main content

Class AuthorizeRecurringTransactionRequest


Properties

NAMETYPELENGTHREQUIREDDESCRIPTION
storeIdlongYUnique user ID generated by EPS. (See - Required Data Elements)
storeKeystringYUnique password generated by EPS. (See - Required Data Elements)
WSCustomerWSCustomer
createCustomerIfDoesNotExistsboolShould a customer be created?

Valid values are:
  • 1 - Yes
  • 0 - No
updateCustomerIfExistsboolShould the customer information be updated if it already exists?

Valid values are:
  • 1 – Yes (CustomerNumber required)
  • 0 - No
WSRecurringTransactionWSRecurringTransaction

WSCustomer

NAMETYPELENGTHREQUIREDDESCRIPTION
EntityIdintYUnique identifier that is generated by EPS. (See - Required Data Elements)
IsCompanyboolYIdentifies a customer as an individual or business. (See - Optional Data Elements)
CustomerNumberstring50Y*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’.
Field1string50Optional information associated with a customer. Data is stored with the customer. Indexed field.
Field2string50Optional information associated with a customer.
Field3string50Optional information associated with a customer.
FirstNamestring30This is the first name of an Individual customer (IsCompany = False). The element can be left blank if this is a business customer (IsCompany = True).
LastNamestring60Y*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.
Emailstring60Customer’s email address.
OtherEmailstring120Any additional email addresses associated with this customer.
Address1string50Customer’s home or business address.
Address2string50Additional home or business addresses information.
Citystring40The City where this address is located.
StateRegionstring40The state where this address is located.
PostalCodestring10The zip or postal code of this address.
Countrystring40The country where this address is located.
EveningPhonestring14A phone number where the customer can be reached in the evening.
EveningExtstring6The extension needed to reach the customer in the evening, if applicable.
DaytimePhonestring14The phone number where the customer can be reached during the day.
DaytimeExtstring6The extension needed to reach the customer during the day, if applicable.
Faxstring20A fax number associated with this customer, if available.
SSNstring15The customer’s Social Security Number.
DLStatestring2The state associated with the customer’s driver’s license.
DLNumberstring30The customer’s driver’s license number.

WSRecurringTransaction

NAMETYPELENGTHREQUIREDDESCRIPTION
EntityIdintYUnique identifier that is generated by EPS. (See - Required Data Elements)
LocationIdintYUnique identifier generated by EPS for each location. (See - Required Data Elements)
RecurringPaymentOriginenum of Type WSRecurringPaymentOriginYIdentifies by what method the transaction was originated. (See - Optional Data Elements)

Valid values are:
  • Internet
  • Signature_Faxed
  • Signature_Original
  • Telephone_IVR*
  • Telephone_Operator*
  • Corporate_Trade_Exchange
  • Can’t be null.


*NOTE: Telephone transactions are not permitted if IsBusinessPayment = 1 (true).
EffectiveDatedateTimeDate 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.

Identifies by what method the transaction was originated. (See - Optional Data Elements)
Descriptionstring50This optional element can be used to define or explain the purpose of this transaction.
TotalAmountdecimalYDollar amount of the transaction. This element cannot be zero (0) or negative.
BatchNumberstring40Supply only if a unique userassigned batch number was created using CreateProcessingBatch and the user wants to include this transaction in that batch. If not, leave blank or don’t include it in the request.
TransactionNumberstring50YUnique user-assigned identifier of the transaction being created.
Field1string50Optional information associated with the transaction. Data is stored with the transaction. Indexed field.
Field2string50Optional information associated with the transaction.
Field3string50Optional information associated with the transaction.
RoutingNumberstring9Y**Bank Routing/Transit or ABA number. (See - PaymentOrigin Element Relationships)
AccountNumberstring17Y**This element represents the customer’s account number. Checking or Savings accounts: 3-17 digits. (See - PaymentOrigin Element Relationships)
CheckNumberstring17
IsBusinessPaymentboolIdentifies 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).
NameOnAccountstring50YCustomer’s name as it appears on their account. This field is required for SettlementType ACH when PaymentOrigin is
  • Internet (WEB),
  • Telephone_IVR,
  • Telephone_Operator,
  • Signature_Faxed,
  • Signature_Original
  • Corporate_Trade_Exchange
IpAddressOfOriginatorstring15IP address of person sending request. May be automatically retrieved.
FaceFeeTypeenum of Type WSFaceFeeTypeValid 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)
AccountTypeenum of Type WSAccountTypeY*Valid values are:
  • Savings (Default)
  • Checking


* Note: If Null, and the RoutingNumber element is supplied, the default value of "Savings" is used.
bypassSmartDetectboolThis 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.
companyEntryDescriptionstring10Requested 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:AuthorizeRecurringTransaction>
<pv:storeId>123456</pv:storeId>
<pv:storeKey>3z9em9oxqwX3acsaqc6H0ck8D3Yj </pv:storeKey>
<pv:customer>
<pv:EntityId>12345</pv:EntityId>
<pv:IsCompany>0</pv:IsCompany>
<pv:CustomerNumber>010612</pv:CustomerNumber>
<pv:FirstName>Patricia</pv:FirstName>
<pv:LastName>Lambert</pv:LastName>
</pv:customer>
<pv:createCustomerIfDoesNotExists>1</pv:createCustomerIfDoesNotExists>
<pv:updateCustomerIfExists>0</pv:updateCustomerIfExists>
<pv:recurringTransaction>
<pv:EntityId>12345</pv:EntityId>
<pv:LocationId>10606</pv:LocationId>
<pv:RecurringPaymentOrigin>Telephone_Operator</pv:RecurringPaymentOrigin>
<pv:EffectiveDate>2012-01-06</pv:EffectiveDate>
<pv:Description>Recurring</pv:Description>
<pv:TotalAmount>50.00</pv:TotalAmount>
<pv:TransactionNumber>010612</pv:TransactionNumber>
<pv:RoutingNumber>111000025</pv:RoutingNumber>
<pv:AccountNumber>033589725</pv:AccountNumber>
<pv:IsBusinessPayment>0</pv:IsBusinessPayment>
<pv:NameOnAccount>Patricia Lambert</pv:NameOnAccount>
<pv:companyEntryDescription>PURCHASE</pv:companyEntryDescription>
</pv:recurringTransaction>
</pv:AuthorizeRecurringTransaction>
</soapenv:Body>
</soapenv:Envelope>