Public
This API enables a partner to create the functionality to board Go Plus Accounts directly from their website.

Setting Up Credentials:

In order to set up a partner to use the Boarding API, the partner would first need to have a Cardknox Account. The partner’s ID (found in the partner record under Sales Port → Agents → Select the agent → Manage Partner) must be set in ‘Account Boarding Agent Id’ in Cardknox Dynamo Settings.
Note: To indicate that a specific Cardknox will be used for testing, enable the ‘Account Boarding Is Sandbox’ setting.
Could not load image
For setting up a tier to test with, ‘Is Sandbox’ should be enabled on the tier so it will be returned as a sandbox tier when using the sandbox Cardknox key. Additionally, when 'Is Sandbox' is selected, the co-brand credentials will automatically be updated to the Cardknox test co-brand. This ensures test submissions won’t go to a live co-brand.
Could not load image

API Endpoints

GetTiers

The GetTiers end point will give a list of available tiers for the given API key if the API key is authorized to board Cardknox Go accounts.
Method: POST
Input: JSON

Request

Parameter
Description
ApiKey
Credential, Required

Response

Parameter
Description
Status
  • Success
  • Error
Refnum
Error
  • Error Code
  • Error Message
Tiers
List of available tiers

SubmitGoApp

The SubmitGoApp end point will validate the request, create an App and submit it to Infinicept, if the API key is authorized to board Cardknox Go accounts.
In case of Sandbox request the equipment (Cardknox and Engine24) will be created immediately.
Method: POST
Input: JSON

Request

Parameter
Description
ApiKey
String, Required
TierName
String, Required
CorporateName
String, Required
DBAName
String, Required
AnnualCreditCardSales
Number, Optional
OwnershipType
Enum, Required
BusinessStartDate
Date, Required
AgentName
String, Optional
AgentEmail
String, Optional
Website
String, Optional
TaxId
String, Required
BusinessEmail
String, Optional
BusinessPhone
String, Required
BusinessAddress
Address, Required
MailingAddress
Address, Required
ProductSold
String, Required
BankingInformation
BankingDetails, Optional
SignerInformationList
List of SignerDetails, At least 1 detail required
Token
Token from the terms and conditions confirmation, Required
For production accounts, it must be set to a valid value

Response

Parameter
Description
Status
  • Success
  • Error
Refnum
Error
  • Error Code
  • Error Messages - List of errors
AppId
Last modified 25d ago