DPSAUTHP COM OBJECT

DpsAuthP is a COM object that encapsulates the interface to a Payment Express Server. It is a COM Object designed for easy integration in Microsoft Site Server Commerce Edition under Windows NT 4.0 or better. For Customers not using Microsoft SiteServer software, please refer to separate software component DPSAuth, a COM object designed for integration with ASP.

Technical Specifications/Features:

  • Multiple Account Selection
  • Transactions can be redirected to different merchant accounts depending on the Account code that is specified with each transaction.
  • Reference fields for reconciliation
  • Optional reference fields are available to hold information that will appear on transaction reports.
  • Multi-Currency Support

Requirements/Downloads:

Installation Instructions

Download the latest DPSAUTHP COM Object kit and run the DPSAUTHP_XXX.EXE

Installation Directory

Indicates the directory where DPSAUTHP files will be installed. For a list of files installed or updated by the installation procedure, refer to section entitled "Files Updated/Installed"

Payment Express Server TCP/IP Address

If the DPSAUTHP COM Object is to be installed on the same NT Server/Workstation as the Payment Express Server, the Local System check box should be checked. If the Payment Express Server is installed on a remote system, remove the check from the "Local System" box and enter the TCP/IP address or hostname of the NT System running Payment Express in the entry field adjacent.

Install

To install DPSAUTHP, Press the Install Button.

Files Installed/Updated

Input Parameters

Filename Description
DPSAUTHP.DLL Pipeline Component
RAUTHP.EXE Removes (uninstalls) from system.

Installation Instructions

Uninstalling DPSAUTHP

To uninstall DPSAUTHP Pipeline Component from a computer, use the Settings/Control Panel/ Add/Remove programs utility. Select DPSAUth pipeline Component and press "Add/Remove".

Using DPSAUTHP.DLL

Ensure the required form properties (_cc_number, _cc_expmonth etc) are being set prior to execution of the pipeline component. Upon completion of processing for the component, the call to Exceute will return with ErrorLevel set.

ErrorLevel Contents after Execute returns

OPPERRORLEV_FAIL A serious error occurred. The request failed. The call will
OPPERRORLEV_WARN The transaction was completed but was declined.
OPPERRORLEV_SUCCESS The transaction was completed and was approved.

vent Logger

The component can be configured to write error events to the NT Error Logger.

PipeLine Editor

Use the Pipeline Editor to add the DPSAuthP Pipeline component as shown in Figure 1.

DPS Auth

Figure 1 Pipeline Editor Insert Component

Select DPSAuthP component and press "OK" to insert the component at the appropriate stage of your order pipeline.

DPS Auth

Figure 2 Site Server Purchase Pipeline

Open the properties option of the of DPSAuthP component. Figure 3 shows an example of the Component Properties dialog.

DPS Auth

Figure 3 DPSAuthP Configuration

Select the transaction type. Unless the Payment Express Server is located on a different computer, Address and Port may be left at default settings. Timeout setting is set to 30sec by default and should not normally be altered.

Configuration Options

The following section provides a detailed description of each DPSAuth configuration option.

Address

The TCP/IP Address of the NT Server running Payment Express NT Server. If the Default box is checked, uses the address of the local system.

Port

The Well Known TCP Port exposed by Payment Express Server. If the Default box is checked, uses the usual default value of 3005.

Timeout

The number of seconds DPSAuthP will wat before timeing-out the transaction. If the Default box is checked, defaults to 30 seconds.

Account

The account number for settlement for this component. A value of 0 to 9999 is permitted.

Trace

If checked, writes diagnostic information to a file DPSAUTHP.LOG, usually located in the WINNT/System32 directory.

Transaction Type

DPSAuthP supports several types of transaction. Default is Purchase Transaction.

ErrorLevel Contents after Execute returns

Transaction Type Description
Auth Authorisation Transaction
Completion Completion (used to complete a transaction originally authorised using the "Auth" transaction type. Requires _auth_code as input (the value returned in _payment_auth_code for the original Auth transaction).
Purchase Purchase. An atomic transaction resulting in immediate funds transfer if succesful.
Refund Refund

DPS Auth

Figure 3 DPSAuthP Values Read/Written Page

Input Order Form Properties

Parameter Description
cc_name Card Holder Name as on Card.
cc_type Credit card Name (eg: "Visa" "Mastercard"). This information is ignored by DPSAuthP. It is not necessary to supply or capture this field. It is provided for compatibility with US based transaction capture solutions.
_cc_number Credit Card Number. Left justified no embedded spaces or other delimitors.
_cc_expmonth Expiry date month 01-12. Note: do not include "/" or other delimitors.
_cc_expyear Expiry date year 00-99. Note: do not include "/" or other delimitors.
_clienttype Indicates transaction source (Web vending machine etc)
_cc_cvc2 Card Verification number. This 3-4 digit number is found on the back of a credit card in the signature panel - it is different from the embossed card number and provides an additional safety check.
_auth_code Used as input for a Completion Transaction
_receipt_email Address to email a receipt to.
_txninfo Velocity and Origin Checking Information

Output Order Form Properties

Parameter Description
_payment_auth_code Authorisation Code (up to 6 character alphanumeric)
_payment_card_name Card used (Visa MCard Bankcard etc)
_payment_date_settlement Date transaction will be settled to Merchant Bank Account
_payment_response_code 2 character response code
_payment_response_text Response Text associated with ResponseCode
_payment_result ATrue if transaction successful False if declined or unsuccessful
_payment_txnref Set to uniquely identify transaction. This is a unique internal reference maintained by the component and is set when the transaction is started and is available for storage by the client application when the

Amount (input)

Total Purchase, Refund, Auth or Completion amount.

_payment_auth_code ( input)

Authorisation code. Returned by Card Acquirer.

_auth_code (input)

Also known as PreAuth Number - only used for completion transactions. This is the value returned by a successful Auth transaction in _payment_auth_code

cc_name (input)

The cardholder name as it appears on customer card.

_cc_number (input)

The card number. No blanks are permitted. Must contain a numeric value. The only exception is for transactions where the ClientType is "C" or "S" indicating a card swipe value. In this case, _cc_number contains the contents of the customer card Track2.

_payment_card_name (output)

The card type used for the transaction. The following values are possible:

Output Order Form Properties

CardName Value Description
Amex American Express
Bankcard Bank Card
Jcb JCB
Mcard Mastercard
Visa Visa

_clienttype (input)

Type of client transaction - Choose from the following values

Value Meaning
V Vending device or kiosk.
W Web Server originated
M Mail Order Transaction
T Telephone Order Transaction
C Card Swipe And Attendant Present
S Card Swipe and no attendant present

The _clienttype property describes the origin of the transaction, for example; Vending machine or from a Web Server. It is also possible to capture magnetic stripe information (Track2 data) for Card Swipe transactions. (eg: a carpark using a magnetic swipe to capture customer card information.

_cvc2 (input)

Card Verification Code 2 number. Some payment cards are issued with additional identifying information. These cards will have the account number printed on the signature panel of the card followed by a three or four digit value. This value is generated by the issuing bank and can be verified by the bank. Payment card brands have varying names for the value:

American Express: Four-digit batch code (4DBC)<

MasterCard: Card Verification Code 2

Visa: Card Verification Value 2

Supplying this value provides evidence that the person participating in a transaction had physical possession of the card at some point in time.

_cc_expmonth (input)

Indicates card expiry month. Format is MM where MM is month 01-12 and Year 00-99. do not insert "/" or other delimitor.

_cc_expyear (input)

Indicates card expiry month. Format is MM where MM is month 01-12 and Year 00-99. do not insert "/" or other delimitor.

_payment_date_settlement (output)

Indicates Date of settlement if this is supported by the Acquirer, otherwise contains the date the transaction was processed in DDMMYYYY format.

_payment_response_code (output)

Response Code generated by Server (for locally declined transactions) or by the Card Acquirer (for host originated responses). The ResponseCode should not be checked by the client application using DPSAUTH as these values differ according to acquirer. Use the Success property to check for successful completion of a transaction. Refer to section Response Codes for a list of valid response codes generated by acquirers and locally by the Payment Express Server or DPSAUTH control.

_receipt_email (input)

Email address to send a transaction receipt. If not blank, this must be a vaild email address in the form user@x.y.z.

_payment_response_text (output)

Refer to section Response Codes for a listing of response text values.

_payment_result (output)

Indicates success or failure of a method call. Either AUTHORISED or DENIED

_payment_txnref (output)

8 digit reference number for the transaction.

_txninfo (input)

Transaction Information (TxnInfo) allows the client to provide PaymentExpress server with information about the type of transaction, in particular expected frequency, expected origin (domestic or foreign) of the cardholder. Separate values with a single space. This additional information allows PaymentExpress to detect questionable transactions.

Token Values
TAG Transaction Tag - identifies the type of transaction being employed and for which the other tokens apply. This is an application defined value and is used to distinguish between different kinds of transactions.
LIMITCARDORIGIN NZ AU ANY. If NZ only NZ issued cards are acceptable AU only australia ANY = no restriction. (values may be combined eg: "NZ AU")
DAILYUSELIMIT Numeric value maximum number of times this transaction card may be used in a 24 hour period for this transaction. For example a prepaid phone card might limit the recharge transactions allowed to one per day as the card should ordinarily only be used to refresh one phonecard (the phon belonging to the cardholder).

Sample string:

"TAG=PREPAY LIMITCARDORIGIN=NZ DAILYUSELIMIT=1"

This value would indicate to the PaymentExpress Server that the card used must be issued by a NZ bank and the cardholer may only perform one transaction of this type per day.

"TAG=PAYPHONE LIMITCARDORIGIN=NZ"

This value would indicate to the PaymentExpress Server that the card used must be issued by a NZ bank but does not restrict the number of transactions per day.

Response Codes

The client application should not interpret the ResponseCode property contents - it is provided as informational only. The Success property determines if the the transaction was successful or not.

Payment Express Server Originated Responses

The following responses are generated by the Payment Express Server locally and indicate a server error condition or a problem with the transaction that caused it to be locally declined.

Output Order Form Properties

Code Text Meaning
S0 SOCKET INIT FAILURE Socket initialisation failed. The TCP/IP protocol must be installed on the computer.
S1 SOCKET CONNECT FAILURE
S2 CONNECT TIMEOUT
S3 SOCKET FAILURE
A8 INVALID AMOUNT Amount value is not of the form d.cc where d is dollars and cc is cents value.
A9 INVALID CARD NUMBER
SA INVALID ACCOUNT
AB INVALID EXPIRY Expiry not in MMYY format or Month not between "01" and "12".
AC CARD EXPIRED
AD ACCOUNT ERROR
AE TIMEOUT
AF RECORD NOT FOUND
B1 IVL REQ TYPE Invalid Transaction Type. Must be one of "P" "R" "A" "C"
X1 TIMEOUT Comms error

Event Logger

By default the installation sets up DPSAUTHP to write events to system event logger.

Overview

The DPSAuthP Component supports Auth/Completion. An "Auth" transaction verifies that funds are available for the requested card and amount and reserves the specified amount. A "Completion" transaction is sent at a later date to cause funds transfer for the previously authorised amount, or a smaller amount if the total original value is no longer required. This transaction set is useful when the merchant needs to ensure that funds up to a certain limit are available but the actual total amount is not yet known or goods or services have not yet been delivered.

Operation

Use a component with Transaction Type set to "Auth". Generate a transaction for the amount to be authorised. The _payment_auth_code will contains an AuthCode of up to 32 alphanumeric characters for successful authorisation. The funds are not tranferred from the cardholder account. At a later time, but within 4-7 days maximum a "completion" transaction must be sent containing the original "authorisation code" returned by the "auth" transaction response. in the _payment_auth_code field. When generating the completion transaction, place this value in the _auth_code field. The completion transaction must supply the card number and expiry date originally used with the Auth transaction for which the Completion transaction is being issued.