support@protx.com
 
Step 1 Step 2 Step 3 Step 4 Step 5

VSP Server Custom Integration: Step 5

Notification URL responds back with information to complete the transaction

(N.B: ALL code examples and references to integration kit files within this document are related
to the ASP kit ONLY. To download kits in other languages please visit the Downloads page.)




Your NotificationURL will now reply to the POST made to it in step 4 with three items:
  •   Status=OK
  •   RedirectURL=
  •   StatusDetail=








The response from the NotificationURL and the redirect of the shopper back to the Vendors website







It is absolutely crucial that under all circumstances where Status is received from Protx in the POST that your Notification page responds with 'Status=OK' and a RedirectURL and a StatusDetail. If this does not happen, the VSP system will consider your server unreachable and will abort the transaction.

The reasons for the items you need to POST back from your NotificationURL are below:

  •   Status=OK - Protx must receive this as acknowledgment that you received and handled   the initial POST


  •   RedirectURL - a URL that Protx can use to redirect the Shopper back to your site


  •   StatusDetail - human readable text to offer explanation of the status, if it is needed


A 'Status=OK' response MUST be POSTed back from your Notification page, or the transaction will fail. Protx consider this response to be acknowledgment that the POST to your NotificationURL was received and handled correctly.

A 'RedirectURL' will be constructed and POSTed back and should be a URL supplied depending on the Status. A URL for each status is available within the Protx kit. For example, if Protx have POSTed a 'Status=NOTAUTHED' then you would not wish to supply Protx a RedirectURL that transfers the Shopper to a successful transaction page (such as vps_order_complete) as it would make the Shopper think that a failed transaction was in fact successful. This said, the RedirectURL needs to be POSTed back according to the Status received in the initial POST to the NotificationURL.

'StatusDetail' is simply some additional text for troubleshooting and debugging purposes.

An example of the 3 items above being constructed and POSTed is below (extract from the vps_handle_protx_repsonse.asp page), again, the example is in ASP ONLY and demonstrates the response constructed upon a 'Status=OK' being received by your NotifcationURL only.





It is crucial to ensure that the response is formatted correctly. It has been noticed in the past that Vendors may have replied in the POST with code comments or page declarations, so ensure that the POST sends only the items required.

Status=OKRedirectURL=www.mywebsite.com/completeStatusDetail=

The above is from our perspective as the recipient of the POST, and it would fail, as although each item is received, they are not seperated correctly.

If the POST from Protx is handled correctly and the corresponding Status=OK, RedirectURL and StatusDetail are then returned to Protx, formatted correctly and in the right order - Protx will then use the RedirectURL supplied to pass the Shopper from the authorisation screen to the RedirectURL supplied. This RedirectURL can vary, depending on the Status of the transaction and when using the kit, the RedirectURL will be your website address and path of the kit, plus one of the following:

  •   DefaultCompletionURL
      if the status is OK and MD5 hash matches VPS Signature


  •   DefaultTamperURL
      if the status is OK but the MD5 hash does not match the VSP Signature


  •   DefaultNotAuthedURL
      if the transaction was declined


  •   DefaultRejectedURL
      if your rule base rejected the transaction


  •   DefaultAbortURL
      if the transction timed out or Shopper cancelled on the payment page


  •   DefaultErrorURL
      if a technical/connection or unknown error has occured


So for example, if you have your server address declared in the Protx.ini file as ExternalIPAddress="[www.mywebsite.com]" the kit will use that URL and one of the above defaultURL's.

An example of receiving a REJECTED status

Your DefaultRejectedURL (as well as all the other URLs) is, again, declared in the Protx.ini file as seen below:





So, let's say your 'pathToKit' is /ProtxKit and the status returned by Protx for any given transaction is REJECTED - the RedirectURL would be built up by your NotificationURL as:

www.mywebsite.com/ProtxKit/vps_order_rejected.asp

Protx will then use the RedirectURL to pass the shopper to the final page of the transaction process, which will be specified by yourselves when you POST the RedirectURL to Protx.

The Shopper will then know that their transaction has succeeded or failed and you could consider displaying a message onscreen along with an order number and contact details.

Back to top