Account Boarding API

Overview

The Cardknox Account Boarding API gives ISV partners the ability to board PayFac accounts directly through their system, rather than from the Partner Portal. Using the Account Boarding API, ISVs can build a form within their system for collecting all the necessary merchant data to onboard Cardknox Go accounts. Once the ISV submits the application via the API, it is passed along to Cardknox for instant approval.
This page outlines the configuration process for integrating with Cardknox’s Account Boarding API.
Visualize and interact with the API using Swagger UI. Please note that only sandbox keys may be used when submitting accounts and the Signature.Token field is not required.

API Endpoints

GetTierNames

Description: The GetTierNames endpoint gives a list of available tiers that can be passed along to the SubmitGoApp request.
Method: POST
Input: JSON

Request Headers

Parameter
Type
Description
Required
ApiKey
String
Authentication credentials
True

Sample Request:

1
{
2
"apiKey": "Your API Key"
3
}
Copied!

Response

Parameter
Description
Status
  • Success
  • Error
Refnum
Error
  • Error Code
  • Error Message
Tiers
List of available tiers
Sample Success Response:
1
{
2
"tiers": [
3
"123_tier1",
4
"123_tier2"
5
],
6
"refnum": "brd258465289",
7
"status": "Success"
8
}
Copied!
Sample Error Response:
1
{
2
"refnum": "brd258465289",
3
"status": "Error",
4
"error": {
5
"errorCode": "AccessDenied",
6
"errorMessages": [
7
"Access Denied"
8
]
9
}
10
}
Copied!

SubmitGoApp

Description:
The SubmitGoApp endpoint validates the request and generates an application if the account associated with the API key is authorized to board Cardknox Go accounts. If it is a Sandbox request, the equipment will be created immediately.
Method: POST
Input: JSON

Request

Parameter
Type
Description
Required
ApiKey
String
Authentication key
True
TierName
String
Name of tier
True
CorporateName
String
Business’s legal name
True
DBAName
String
Business’s DBA Name, if no DBA default to CorporateName
True
AnnualCreditCardSales
Number
Credit card sales for the last full year
False
OwnershipType
Enum
Ownership structure
Valid values are:
  • SoleProprietor
  • Partnership
  • Corporation
  • SoleOwnership
  • LLC
  • NonProfit
True
BusinessStartDate
Date
Start date of the business in YYYY-MM-DD format
True
AgentName
String
Full name of primary agent
False
AgentEmail
String
Email address of primary agent
False
Website
String
Business website
False
TaxId
String
Business EIN / Tax Identification Number
True
BusinessEmail
String
Business email address
False
BusinessPhone
String
Business phone number (format: 000-000-0000)
True
BusinessAddress
Object
Object containing business address fields
True
MailingAddress
Object
Object containing business mailing address fields
True
ProductSold
String
Short description of product sold
True
BankingInformation
Object
Object containing banking information including bank name, routing number, and account number
False
SignerInformationList
Object
Object containing signer information
True
Token
String
Token from the terms and conditions confirmation;
for production accounts, it must be set to a valid value
True
Click here for more information on how to obtain tokens.
Sample Request
1
{
2
"apiKey": "Your API Key",
3
"tierName": "Your Tier",
4
"corporateName": "FR Furniture Source",
5
"dbaName": "Fall River Furniture",
6
"annualCreditCardSales": "80000",
7
"ownershipType": "Other",
8
"businessStartDate": "2005-08-01",
9
"agentName": "John Smith",
10
"agentEmail": "[email protected]",
11
"website": "www.fallriverfurniture.com/",
12
"taxId": "225555555",
13
"businessEmail": "[email protected]",
14
"businessPhone": "5082025000",
15
"businessAddress": {
16
"streetAddress": "4114 South Bath Avenue",
17
"city": "Fall River",
18
"state": "MA",
19
"zip": "02721",
20
"country": "United States"
21
},
22
"mailingAddress": {
23
"streetAddress": "4114 South Bath Avenue",
24
"city": "Fall River",
25
"state": "MA",
26
"zip": "02721",
27
"country": "United States"
28
},
29
"productSold": "Home Furnishings",
30
"bankingInformation": {
31
"bankName": "Chase",
32
"routingNumber": "021000021",
33
"accountNumber": "454545454545"
34
},
35
"signerInformationList": [
36
{
37
"ssn": "115668989",
38
"dateOfBirth": "1955-07-14",
39
"firstName": "Irving",
40
"lastName": "Palomer",
41
"address": {
42
"streetAddress": "4114 South Bath Avenue",
43
"city": "Fall River",
44
"state": "MA",
45
"zip": "02721",
46
"country": "United States"
47
},
48
"ownershipPercentage": 100,
49
"title": "Owner",
50
"ownerCellPhone": "4445559999"
51
}
52
],
53
"signature": {
54
"token": ""
55
}
56
}
Copied!

Response

Parameter
Description
Status
  • Success
  • Error
Refnum
Error
  • Error Code
  • Error Messages - List of errors
AppId
Sample Success Response
1
{
2
"appId": 9854,
3
"refnum": "brd221002160",
4
"status": "Success"
5
}
Copied!
Sample Error Response:
1
{
2
"status": "Error",
3
"error": {
4
"errorCode": "BadRequest",
5
"errorMessages": [
6
"BusinessAddress.State: The State field is required.",
7
"SignerInformationList[0].SSN: The SSN field is required."
8
]
9
}
10
}
Copied!
Export as PDF
Copy link