Click-To-Pay Initial Setup
Last updated
Was this helpful?
Last updated
Was this helpful?
Our simple iFields integration enables online Click-To-Pay processing through the Cardknox gateway. This document details the steps necessary to integrate Click-To-Pay with your site.
Contents
Register for Click-To-Pay: See [insert link here]
Step 1: Add the iFields.js file after the <head> tag on your payment page:
Step 1: Add the following JS snippet inside the <body> where the Click-To-Pay button is desired.
Step 2: Create JavaScript object that holds all of the properties/methods required to process Click-To-Pay.
Step 3: Implement desired callbacks.
There are two main callbacks that must be implemented (the rest are optional):
onPaymentPrefill - calculates total amount and sets transaction information.
onPaymentSuccess - a callback that will be called after the consumer pays and Click-To-Pay returns a payload with all of the requested consumer information. This is where you need to make an ajax call to your server with the payload. The sample for making an ajax call is below:
Sample Code for Making Ajax Call:
window.ckClickToPay object - controls initialization of Click-To-Pay button
Method
Call Required
Description
enableClickToPay
Yes
Initializes and enables Click-To-Pay Button.
Name
Type
Required
Description
initParameters
Object
Yes
Object that contains initialization parameters for Click-To-Pay
A server endpoint is needed in order to accept the Click-To-Pay Payload from your website.
Step 1: Create an endpoint and method for API Integration on your server side that takes a Click-To-Pay Payload and makes a call to Cardknox.
For full list of Returned Parameters, please refer to Click-To-Pay Response Reference
Below are the steps to integrate Click-To-Pay with the Cardknox API:
Integration Steps:
Set the required fields:
xDigitalWalletType to ClickToPay
xClickToPayTransactionId to clickToPayResponse.payload.transactionId
xClickToPayExternalClientId to clickToPayResponse.payload.externalClientId
xClickToPayEncryptionKey to clickToPayResponse.payload.encryptionKey
xCardNum to clickToPayResponse.payload.token
xAmount to clickToPayResponse.amount
xCommand - Set to one of the values that starts with cc: like cc:sale, cc:auth, etc.
xKey to "Your xKey"
xVersion = "4.5.9"
xSoftwareName to “Your Software Name"
xSoftwareVersion to "Your Software Version"
Sample Request:
For more details, please contact your Cardknox Representative.
Find the latest version of iFields at:
For a full sample code please refer to
For the list of available callbacks, please refer to object.
For full integration code, please refer to
For full list of Init Parameters, please refer to
This section assumes that you already know how to integrate other payments with
Once the consumer confirms the payment, Click-To-Pay API generates a in the form of a JSON string.
Contact