PayKings Gateway
Support avatar
Written by Support
Updated over a week ago

October 7, 2015

UPDATED March 1, 2020

To configure  PayKings Gateway into your CRM, you will go to Payments>Gateways, under ACTIONS select Add New Provider Profile.Select the type = Payment/Gateway and select PayKings from the drop down.Fill out the gateway parameters which are outlined below and click “Save”.

For more information on this Gateway click here

These parameters are briefly described here for your reference:

Username: This will be provided to you by PayKings.

Password: Password that you set for your PayKings user account.

Enable Customer Vault: Select "Yes" if you are using the Customer Vault with PayKings.The Customer Vault also needs to be enabled on the gateway's end as well.

Currency: The PayKings Gateway currently supports USD, EUR, GBP, CAD, AUD, ZAR, JPY, DKK, NOK, MXN, NZD, SGD, HKD, and CHF currencies.

MDF1-MDF20: Merchant Defined Fields* are described below. These are optional fields.

Gateway Alias: Name that you will assign to the gateway. This is for internal purposes only; it helps you identify a specific gateway account among several of them in your CRM.

There are 2 Required Fields on the Merchant Account Details tab. *Descriptor - This will be the MID Descriptor *Customer Service Number - The customer service number assigned to the MID

There is 1 Required Field on the Limits and Fees tab *Global Monthly Cap - This will be the sales amount allowed monthly on this MID 

To maximize the efficiency of Reporting Analytics we suggest you take a moment and fill out the rest of the fields. These will all be used in’s profitability reports.

For field definitions on all of the fields on the Merchant Account Details Tab and the Limits & Fees Tab - click here- overview of gateway providers

Once your gateway profile has been created, then you will go through your campaigns and assign the gateway to the corresponding campaign(s).

*Optional Services:

Merchant Defined Fields:

PayKings Gateway supports several Merchant Defined Fields (MDF1-MDF20) that allow you to customize the transactions that you will be processing through this gateway. These MDFs will dynamically append data to the transactions based on the order details. Please be aware that these fields are optional.

To ease the process of using the MDFs we have created various tokens that you can use to dynamically insert the data into the Merchant Defined Fields.

These are the supported tokens, and a brief description of the values that each one will insert in your MDF:

{ACQUISITIONDATE} - Passes to the gateway the date of the original parent order on rebills in MM/DD/YYYY format.

 {AFFILIATEID}- Inserts the affiliate id from the order. It will obtain this value from the AFFID, AFID or AID field, whichever is populated; if none of them have data, it will not include it on the post.

 {CAMPAIGNDESCRIP}- Inserts the campaign description of the campaign from where the order is generated.

 {CAMPAIGNID} - Inserts the campaign id from where the order is generated.

 {CATEGORYNAME} - Inserts the category name that the main product sold belongs to.

 {COUPONDISCOUNTAMOUNT} - This is populated with the coupon discount on the order, i.e. `1.00.

 {CUSTOMERID} - Provides the customer id of the order being billed.Please be aware that this is only valid on rebills; on new initial orders, the customer id will be 0 because a new customer will not have a customer id until after he has a successful order in your system.

 {INITIALTRANSID} - This will return the transaction id for the initial order.

 {PRODUCTID} - Inserts the product id of the main product sold.

 {PRODUCTNAME} - Inserts the product name of the main product sold.

 {PRODUCTSKU} - Inserts the product SKU number of the main product sold.

 {REBILLDEPTH} - This will insert the current rebill depth of the order. For example, if the order is the first rebill for a customer, this would be 1, if it was the second rebill, it would be 2, and so on. For initial new orders, this will be 0. 

 {REPROCESSINGATTEMPTS} - This is populated with the current reprocessing attempt for the order, which will be populated with 0 if the order is not being reprocessed.

 {RETRYCOUNT} - Inserts what retry count the order is at. For example, if a rebill has declined two times, then this would be 3, meaning it is the third attempt to get an approval.

 {SHIPPINGID} - Inserts the shipping id of the order.

 {SHIPPINGMETHOD} - Inserts the shipping method of the order.

 {SUBAFFILIATEID} - Inserts the sub affiliate id. It will post all the sub id's based on the affiliate id of that order. For example, for AFFID, it will post the value of C1, C2 and C3 as a concatenated string separated by commas: C1value,C2value,C3valueFor AFID and AID it will just be the value of SID or OPT respectively.

 {THM_SESSION_ID}- Passes a session Id to the gateway.In order to set the value received from Threat Matrix after they give you a session ID on the webforms,use a javascript to set the value of a hidden field that is in the HTML form on your credit card payment page.  Example: document.getElementById("thm_session_id").value = threatMatrixID;

To use with our API, submit the value that Threat Matrix responds back in an example like this where the threat matrix session id is 12345:  &thm_session_id=12345

The {THM_SESSION_ID}tokencan only be used in the MDF17 field.

Did this answer your question?