🧰
Cardknox Products
📱
Mobile Wallets
🔌
Plugins
📟
Devices
PaymentSITE
The most popular integration flow is for developers to build their own secure form with ifields for the user to enter their information and then submit the transaction via our Transaction API. By doing that the developer would have full control of the UI and behavior of the integration versus when using a PaymentSite, the developer would give up much of control and would be limited to whatever is supported by the PaymentSite.
The PaymentSite solution below is a great alternative option that can be used if the developer chooses to do so. The advantages are that it is a quicker and easier implementation since the developer would not need to build the secure payment form and API calls directly. In addition to that, the user can utilize all the built in features without the developer needing to do additional work.
Overview
The PaymentSite is a hosted payment page uniquely set up for a specific merchant that can be integrated into their system for payment processing. At the time of payment, the system will direct the user to the PaymentSite so the user can enter their payment details and any other relevant information like their name, address and phone number. By using this solution, the merchants system will be out of scope for PCI purposes.
Getting started
Transaction types
The PaymentSite can be configured to process various different payment types. Sale AuthOnly and Save. For more details on what each of these commands is used for see Transaction API
Implementation
Initiation methods
Redirect
The PaymentSite is implemented so that when the user is ready to pay, they are redirected out of the merchants system, to the PaymentSite to enter their payment information.
iframe
The PaymentSite is implemented so that when the user is ready to pay, the PaymentSite is opened in an iframe on in the merchants system.
Pre -populate fields
Most fields that are on the PaymentSite (besides the sensitive payment details) can be pre-populated by the merchants system before the user is directed to the page. This can be done by specifying the “key” and “values” of those fields separated by the “&” symbol in the URL query string. The “key“ value needs to match exactly the html “name“ element of the field; you can find that by inspecting the page using the developer tools of a browser. You can also look at the Transaction API by transaction type to find most fields.
Example: https://secure.cardknox.com/cardknoxexternaldemodev?xamount=100&xinvoice=232144234
Note: The merchant can log into the Cardknox portal to control what fields are available on the page. If you try to pre populate a field that is not added to the page, the system will just ignore it.
Here is a list of specific settings fields that can be set in the query string in addition to the above.
Settings
Name
Description
xRedirectURL
This is the URL that the page will be redirected after the user submits the payment and the transaction is approved If this is not specified, the user will stay on the PaymentSite page and receive a message that the payment went through successfully
xRedirectURL_NotApproved
This is the URL that the page will be redirected after the user submits the payment and the transaction is not approved. If this is not specified, the user will stay on the PaymentSite page and receive a message that the payment did not go through and they will be able to try again
xPostUrl
This is the URL the webhook will be sent to after the user submits the payment
Response methods
Redirect
Typically, after the transaction is completed by the user, the PaymentSite will automatically redirect the user back to the merchants system. There are two ways how to specify the redirect URL
- 1.Set the Redirect URL in the Cardknox PaymentSite backend settings
- 2.Set the xRedirectURL parameter in the query string when directing the user to the PaymentSite.
The redirect will return the response parameter in the redirect quarry string. For a full list of response fields see Response parameters
Example:
https://www.cardknox.com/?xCurrency=USD&xDate=6%2F29%2F2020%204%3A26%3A47%20PM&xResult=A&xStatus=Approved&xErrorCode=00000&xAuthCode=09379A&xAuthAmount=1.03&xRefNum=341260411&xToken=0p3q5479g1g3h2p34g5763008044gg0p&xBatch=5128197&xMID=xxxxxxxxxx9999&xTID=xxxxx6789&xAvsResult=Address%3A%20No%20Match%20&5_Digit_Zip%3A_No_Match&xAvsResultCode=NNN&xCvvResult=No%20CVV%20data%20available&xMaskedCardNumber=4xxxxxxxxxxx1111&xName=t%20test&xExp=0620&xCardType=Visa&xEntryMethod=Keyed&xCustom10=Payment%20Site
Webhook
The merchants site can be notified of transaction responses via webbook notification. This can be implemented in multiple ways.
- 1.
- 2.Set the webhook URL in the Cardknox PaymentSite backend settings
- 3.Set the xPostUrl parameter in the query string when directing the user to the PaymentSite.
Last modified 6mo ago
Export as PDF
Copy link