Account Boarding API

Create a Sandbox Contact Us Knowledge Base
Search…
Overview
This API enables a partner to create the functionality to board Go Plus Accounts directly from their website. This page outlines all of the configuration, setup, and fields for integrating with the API.
API Endpoints
GetTiers
URL: https://psapi.cardknox.com/boarding/v1/GetTiers​
Description: 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
Headers
Parameter
Type
Description
Required
ApiKey
String
Authentication credentials
True
Response
Parameter
Description
Status
Success
Error
Refnum
 
Error
Error Code
Error Message
Tiers
List of available tiers
 
​
SubmitGoApp
URL: https://psapi.cardknox.com/boarding/v1/SubmitGoApp​
Description:
The SubmitGoApp endpoint will validate the request, and create an App, 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
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 last full year
False
OwnershipType
Enum
Ownership structure
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
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
On how to obtain Token please refer here: https://cardknox.atlassian.net/wiki/spaces/PUB/pages/2366144576​
Example
1
{
2
  "apiKey": "0d48f767f1d34d088ae59a214fe11e25",
3
  "tierName": "Tier1",
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
    }
51
  ],
52
  "signature": {
53
    "token": ""
54
  }
55
}
Copied!
Response
Parameter
Description
Status
Success
Error
Refnum
 
Error
Error Code
Error Messages - List of errors
AppId
 
 
API - Previous
Reporting API
Account Boarding Merchant Agreement
Last modified 5d ago
Copy link
Contents