Class AuthorizeRecurringTransactionRequest
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:
| ||
| updateCustomerIfExists | bool | Should the customer information be updated if it already exists? Valid values are:
| ||
| WSRecurringTransaction | WSRecurringTransaction |
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. |
| 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. |
WSRecurringTransaction
| 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) | |
| RecurringPaymentOrigin | enum of Type WSRecurringPaymentOrigin | Y | Identifies by what method the transaction was originated. (See - Optional Data Elements) Valid values are:
*NOTE: Telephone transactions are not permitted if IsBusinessPayment = 1 (true). | |
| 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. Identifies by what method the transaction was originated. (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. | |
| BatchNumber | string | 40 | Supply 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. | |
| 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. | |
| 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. (See - PaymentOrigin Element Relationships) |
| CheckNumber | string | 17 | ||
| IsBusinessPayment | bool | Identifies the ACH only transaction as either drawn on a business or personal account. (See - Optional Data Elements) Valid values are:
| ||
| NameOnAccount | string | 50 | Y | Customer’s name as it appears on their account. This field is required for SettlementType ACH when PaymentOrigin is
|
| IpAddressOfOriginator | string | 15 | IP address of person sending request. May be automatically retrieved. | |
| FaceFeeType | enum of Type WSFaceFeeType | Valid values are:
| ||
| AccountType | enum of Type WSAccountType | Y* | Valid values are:
* Note: If Null, and the RoutingNumber element is supplied, the default value of "Savings" is used. | |
| bypassSmartDetect | bool | This is an optional element which will bypass the SmartDetect Service. Possible values are:
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. | ||
| 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: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>