Skip to main content

Class SaleFromBankAccountRequest


Properties

NAMETYPELENGTHREQUIREDDESCRIPTION
storeIdlongYUnique user ID generated by EPS. (See - Required Data Elements)
storeKeystringYUnique password generated by EPS. (See - Required Data Elements)
entityIdintYUnique identifier that is generated by EPS. (See - Required Data Elements)
locationIdintYUnique identifier generated by EPS for each location. (See - Required Data Elements)
accountReferenceIdstring50YUnique identifier of the account associated with this transaction.
paymentOriginenum of Type WSPaymentOriginIdentifies by what method the transaction was originated. (See - Optional Data Elements)

Valid values are:
  • Internet
  • Telephone_IVR
  • Telephone_Operator
  • Signature_Faxed
  • Signature_Original
  • If null, the default value of Internet is assumed.
notificationMethodenum of WSNotificationMethodMethod by which a customer will be notified of an ACH or credit card transaction. (See - Optional Data Elements)

Valid values are:
  • Merchant_Notify
  • Merchant_Recording
  • Postcard
  • Email
  • If null, the default value of
  • Merchant_Notify is assumed.
AmountdecimalYDollar amount of the transaction. This element cannot be (0) zero or negative.
TaxAmountdecimalNot used at this time. (See - Optional Data Elements)
ShippingAmountdecimalNot used at this time. (See - Optional Data Elements)
terminalNumberstring20Default is “__WebService”. (See - Optional Data Elements)
TransactionNumberstring50Unique identifier of the transaction. (See - System Required/User Optional Data Elements)
Descriptionstring50This optional element can be used to define or explain the purpose of this transaction.
Field1string50Optional information associated with a transaction. Data is stored with the transaction. Indexed field.
Field2string50Data is stored with the transaction. Optional information associated with a transaction.
Field3string50Data is stored with the transaction. Optional information associated with a transaction.
CheckNumberstring17If supplied, is used for duplicate checking.
clientIPstring15IP address of person sending request. May be automatically retrieved.
EffectiveDatestring19Date of the transaction. If null or blank, the current date and time is assumed.

NOTE: This element does not require the Time to be included.(See - System Required/User Optional Data Elements)
faceFeeTypeenum of Type WSFaceFeeTypeValid values are:
ownerApplicationenum of Type WSOwnerApplicationValid Value is:
batchNumberStringBatch to associate this transaction with, if applicable.
holdDaystinyInt1This is an optional element which defines the hold days at the transaction level.

Possible values are:
  • 0-7
  • Default to 255/Null.


Note: This element cannot be empty or blank. You must provide a value of 255 or null if you don’t want to include hold days at the transaction level. The permission Create Transaction Hold Days (under the Customer Services Privilege) is required to apply holdDays.
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>
<pv:SecurityHeader>
<pv:BinarySecurityToken>your security token here</pv:BinarySecurityToken>
</pv:SecurityHeader>
</soapenv:Header>
<soapenv:Body>
<pv:SaleFromBankAccount>
<pv:storeId>0</pv:storeId>
<pv:storeKey isNull="true" />
<pv:entityId>12345</pv:entityId>
<pv:locationId>102030</pv:locationId>
<pv:accountReferenceId>101</pv:accountReferenceId>
<pv:paymentOrigin>Internet</pv:paymentOrigin>
<pv:notificationMethod>Merchant_Notify</pv:notificationMethod>
<pv:Amount>101.01</pv:Amount>
<pv:terminalNumber>__WebService</pv:terminalNumber>
<pv:TransactionNumber>111</pv:TransactionNumber>
<pv:Description></pv:Description>
<pv:Field1></pv:Field1>
<pv:Field2></pv:Field2>
<pv:Field3></pv:Field3>
<pv:CheckNumber></pv:CheckNumber>
<pv:clientIP></pv:clientIP>
<pv:EffectiveDate>12-30-2010</pv:EffectiveDate>
</pv:SaleFromBankAccount>
</soapenv:Body>
</soapenv:Envelope>