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 

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

Output Order Form Properties

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:

_clienttype  (input)

Type of client transaction - Choose from the following values

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. 

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.

Event Logger

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

Auth / Completion Mode

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.