|
Integrating The Checkout
The NOCHEX Checkout is a secure (128 bit SSL) web page. To link your shopping basket to the NOCHEX Checkout use the following syntax: -
https://www.nochex.com/nochex.dll/checkout?parameter=value¶meter=value
The following parameters are required (mandatory) :
email
amount
The following parameters are optional :
ordernumber
description
logo
returnurl
cancelurl
firstname
lastname
firstline
town
county
postcode
email_address_sender
responderurl
Email parameter
This parameter is used to specify the email address that the NOCHEX payment is sent to. This must be an existing NOCHEX account.
Example:
email=sales@yalgo.com
Amount parameter
This parameter is used to decide the amount of money to be sent with the NOCHEX payment. This must be in the format xx.xx e.g. 10.00 is a valid format, while 10 is not a valid format.
Example:
amount=1.99
Order Number parameter
This is an optional parameter that can be used to link an order at your web site to a NOCHEX payment.
Example:
ordernumber=abc123
Description parameter
This is an optional parameter that can be used to display information about the NOCHEX payment being requested.
Example:
description=test transaction
You can format the description by using the following ASCII control characters: -
[TAB] %09
[CR] %0D
Example:
description=Line Item1%09£9.99%0DLine Item2%09£9.99
Logo parameter
This is an optional parameter that can be used to customize the NOCHEX checkout page to include your companies logo.
Example:
logo=https://www.nochex.com/web/images/test_logo.gif
Return URL parameter
This is an optional parameter that can be used to specify a hyperlink that will be displayed at the NOCHEX payment confirmation page. You can use this to take your customers back to your own order confirmation page.
Example:
returnurl=http://www.nochex.com
Cancel URL
If a user clicks on the 'To cancel this payment click here.' link then they will be taken to the page specified
Example:
cancelurl=http://your.url.here
Customer
Firstname
first name of your customer
Example:
firstname=Joe
Customer
Lastname
last name of your customer
Example:
lastname=Bloggs
First Line of Customer Address
1st line of your customers address
Example:
firstline=1 Street Lane
Town
customers town
Example:
town=Leeds
County
customers county
Example:
county=Yorkshire
Postcode
customers postcode
Example:
postcode=LS2 7EE
Customers Email address
customers email address
Example:
&email_address_sender=joe@bloggs.com
Responder URL
APC responder page
Example:
responderurl=http://your.url.here/responder.asp [APC responder address]
Syntax examples
Here is a simple example of the URL required to link to the NOCHEX Checkout :
https://www.nochex.com/nochex.dll/checkout?email=sales@yalgo.com&amount=1.99
And here is a more complete example of the URL required to link to the NOCHEX Checkout: -
https://www.nochex.com/nochex.dll/checkout?
email=sales@yalgo.com
&amount=1.99
&ordernumber=abc123
&description=test transaction
&logo=https://www.nochex.com/web/images/test_logo.gif
&returnurl=http://www.nochex.com
Integrating the Checkout with a HTML form POST
If you want to integrate the NOCHEX Checkout with a https post from your web site, then you should use the following syntax :
<form action="https://www.nochex.com/nochex.dll/checkout" method=post>
In order to pass the required parameters you will need to use form fields that have their name set to the name of the required parameter : -
<input type="text" name="email">
<input type="text" name="amount">
Here is a sample form to help you understand how to use the NOCHEX Checkout from your web page: -
<html>
<head>
<title>NOCHEX CHECKOUT Example</title>
</head>
<body>
<form action="https://www.nochex.com/nochex.dll/checkout" method=post>
Email address:<br>
<input type="text" name="email" size="64"><br>
<br>Amount:<br>
<input type="text" name="amount" size="8"><br>
<br>Order number:<br>
<input type="text" name="ordernumber" size="64"><br>
<br>Comments:<br>
<textarea rows="6" name="description" cols="50"></textarea><br>
<br>Logo:<br>
<input type="text" name="logo" size="64"><br>
<br>Return URL:<br>
<input type="text" name="returnurl" size="64"><br>
<br><br>
<input type="submit" value="Pay by NOCHEX">
</form>
</body>
</html>
|
|
