PX Access Interface for the Hosted Payments PackageThe PX Access interface allows merchants with websites running in a Windows environment to accept credit card details using the Payment Express® SSL-secured payments page. The merchant's website communicates transaction details to a COM object (PXACCESS.DLL) and the object returns a URL at which the card details can be accepted. Once the user has completed the transaction they are directed back to the merchant's website. The merchant website is able to identify the transaction and any other pertinent details by extracting a query string value and supplying this to the COM object. To ensure that the merchant website is always able to recognize that a transaction has taken place an HTTP GET is made to the merchant website independently of the user. Note that, as this request is made by DPS directly, the merchant website will not be able recognize sessions maintained using cookies or query string values for this request however the session can be identified by populating one of a number of free text properties of the COM Object with a session ID or similar identifier. If you intend to run PX Access on a 64-bit server please mention this to our technical support team at the time of setup so that they can provide you with a compatible version of the COM object. Websites running on platforms other than Microsoft Windows should use the PX Pay interface to access and present the Payment Express® SSL-secured payments page. The PxPay interface is language and platform independent as it does not require any specific proprietary software to be installed on the server.
Output Properties
DoProcessResponse (Response)DoProcessResponse is used to decode the result of the transaction after it has been submitted. Input Properties
Output Properties
PropertiesAmountInput (input) Datatype: BSTR
Max 13 characters
Total Purchase, Refund, Auth or Completion amount. Format is d.cc where d is
dollar amount (no currency indicator) and cc is cents amount. For example,
$1.80 (one dollar and eighty cents) is represented as "1.80", not
"1.8". A string value is used rather than the conventional Currency
Datatype to allow for easy integration with Web applications. The currently
Maximum value allowable is $99,999.99. Note that acquirer or card limits may be
lower than this amount.
AmountSettlement (output) Datatype: BSTR
Max 13 characters
Total Purchase, Refund, Auth or Completion amount that was settled with your bank.
AuthCode (output) Datatype: BSTR Max 22
characters
Authorisation code returned for approved transactions.
BillingId (input) Datatype: BSTR Max 32
characters
If a token based billing transaction is to be created, a BillingId may be
supplied. This is an identifier generated by the merchant application that is
used to identify a customer or billing entry and can be used as input
instead of card number and date expiry for subsequent billing transactions.
CardHolderName (output)Datatype:
BSTR Max 64 bytes
The cardholder name as it appears on customer card.
CardName (output)Datatype: BSTR
Max 16 bytes
The card type used for the transaction.
CardNumber (output) Datatype:
BSTR Max 20 bytes
The card number used for the transaction. The full credit card number isn't shown, however the bin range is given (first 6 characters).
CurrencyInput (input) Datatype:
BSTR Max 4 characters
Used to specify the currency to be used: AUD, USD, NZD etc.
CurrencySettlement (output) Datatype: BSTR Max 4 characters
Used to specify the currency that was used for the transaction: AUD, USD, NZD etc.
DpsBillingId (input) Datatype: BSTR
Max 16 characters
When output, contains the Payment Express generated BillingId. Only returned for
transactions that are requested by the application with the EnableAddBillCard
value is set to true indicating a token billing entry should be created.
DpsTxnRef (input/output) Datatype: BSTR Max
16 bytes
Returned for every transaction. If the transaction was approved, DpsTxnRef can
be used as input to a Refund transaction. Used to specify a transaction for
refund without supplying the original card number and expiry date.
EmailAddress (input) Datatype: BSTR Max 255 bytes
Optional Email Address field. Will be returned to origin site for emailing of
receipts etc.
EnableAddBillCard (input) Datatype:
Long
To automatically add a card for subsequent billing purposes, set this to 1.
When generating a Billing Transaction for a previously loaded BillingId or
DpsBillingId, EnableAddBillCard must be 0.
MerchantReference (input) Datatype: BSTR Max 64 bytes
Free text to appear on transaction reports.
Request (output) Datatype: BSTR
URL to https://www.paymentexpress.com with encrypted transaction parameters. The browser should simply redirect to this URL.
ResponseText (output) Datatype: BSTR Max 32 bytes
Response Text associated with the response code of the transaction
Success (output) Datatype: Long
Indicates success or failure of the transaction.
A value of 0 indicates the transaction was declined or there was an error.
A value of 1 indicates the transaction was approved.
TxnData1, TxnData2, TxnData3 (input) Datatype:
BSTR Max 255 bytes
Optional free text fields. Usually assigned at origin web site.
TxnId (input/output) Datatype: BSTR Max 16
bytes
Contains a unique, merchant application generated value that uniquely
identifies the transaction. Used by Payment Express to check for a duplicate
transaction generated from Merchant web site. If a duplicate is detected (same
transaction id used for an approved transaction within the previous 48 hours),
the transaction is not retried, but an "approved" message is
displayed and the merchant site is informed of the result. If the merchant does
not supply a value for TxnId, PXACCESS.DLL generates a merchant unique value.
Where possible it is recommended that the merchant application sets this value.
TxnType (input) Datatype: BSTR
UrlFail (input) Datatype: BSTR Max 255 bytes
Url of page to redirect to if transaction failed. No parameters (&, ?) are
permitted.
UrlSuccess (input) Datatype:
BSTR Max 255 bytes
Url of page to redirect to if transaction successful. No parameters (&, ?)
are permitted.
UserId (input) Datatype: BSTR Max 32
bytes
Unique username to identify customer. Assigned on Account Setup by Payment
Express support team.
Registry SettingsSeveral registry settings are read by PXACCESS. All Subkeys are registered in the path: HKEY_LOCAL_MACHINE\SOFTWARE\DirectPaymentSolutions\PXACCESS\KEYS
The following path is the URL of the Hosted Payments Page for the response redirect call. This should only be changed when talking in conjunction with DPS support. HKEY_LOCAL_MACHINE\SOFTWARE\DirectPaymentSolutions\PXACCESS\SERVER
Fail-proof Result NotificationFail-proof result notification (FPRN) is a service that provides additional assurance that the merchant website will receive notification regarding the outcome of transactions completed via the DPS-hosted payment page. FPRN helps cater for the possibility that a user may not successfully navigate to the nominated success or failure URL enabling the merchant web application to acknowledge the outcome of the transaction. The user could close their browser or otherwise navigate away from the DPS-hosted payment page once they have been informed of the transaction outcome. The merchant's web server may be temporarily unavailable as the transaction is completed and therefore unable to recognise that a transaction has taken place. Using the FPRN service the merchant website is virtually guaranteed to receive notification of the each and every transaction. FPRN is highly recommended by DPS and is enabled on all new accounts by default. The service ensures that the following processes occur for every transaction performed via hosted payment page: As soon as the transaction is completed, a background process at DPS makes an HTTP GET request to the merchant-nominated success or failure URL. If the merchant web site is unreachable or returns any HTTP status code other than 200 or 404 the HTTP GET is retried up to a maximum of six times. It will give up immediately on receiving a 404 HTTP status code (page not found). A 500 HTTP status code, indicating a temporary problem at the client site, will cause a retry. In order to ensure that the web application is in the best position to acknowledge the outcome of each and every transaction certain guidelines should be followed. The merchant web application should not;
The merchant web application should;
N.B. The URL at which the merchant website will process FPRN requests must be exposed via standard internet ports i.e. port 80 or port 443 for SSL/TLS traffic. When specifying UrlSuccess and UrlFail values do not specify a non-standard port number within the URL. Auth-CompletionOverviewPayment Express 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. Operation1) AuthorisationSet TxnType to "Auth" for the amount to be authorised. The Auth response contains a DpsTxnRef. The funds are not transferred from the cardholder account. 2) CompletionAfter a successful Authorisation transaction, but within 7 days maximum, a "completion" (TxnType="Complete") transaction must be sent containing the DpsTxnRef returned by the "Auth" transaction. Token BillingOverviewToken Billing allows for regular billing of a cardholder card, under the control of the merchant, without requiring the merchant to either store sensitive card data securely or to obtain credit card details every time a new payment is requested. This functionality is implemented by proving the ability for a merchant to request payment express to capture and store a credit card number and expiry date and to link these stored details to a merchant supplied "BillingId". The BillingId is a 32 character field that contains a reference that is unique to the merchant's customer, that will be associated with the credit card information stored securely at Payment Express. This is undertaken during the Setup Phase. For subsequent charges to the card (Rebill Phase), the merchant does not need to supply the card number or expiry date, only the BillingId originally associated during the Setup Phase 1) Setup PhaseThe setup phase consists of loading a card into Payment Express with a transaction. The transaction can be an online $1.00 Auth transaction which will determine that the card is valid and not on hot or stolen card lists and that it has the correct expiry date. Customers will typically integrate directly into their call centre or web application for the setup phase. To add a card for future rebilling, send a transaction request (Auth or Purchase) including the following properties: EnableAddBillCard (Set to 1 when adding a
card) You can supply your own billing ID in BillingId or leave it blank and use the ID returned in DpsBillingId determined by Payment Express) 2) Rebill PhaseThe merchant application or Batch processor requests a new transaction and supplies the appropriate BillingId or DpsBillingId, a MerchantReference, and the amount to be charged. Payment Express retrieves the credit card number and expiry date stored in the Setup Phase and a purchase transaction is formatted and processed to the card acquirer. |