Account Boarding API
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.Description: The GetTierNames endpoint gives a list of available tiers that can be passed along to the SubmitGoApp request.
Method: POST
Input: JSON
Parameter | Type | Description | Required |
ApiKey | String | Authentication credentials | True |
{
"apiKey": "Your API Key"
}
Parameter | Description |
Status |
|
Refnum | |
Error |
|
Tiers | List of available tiers |
Sample Success Response:
{
"tiers": [
"123_tier1",
"123_tier2"
],
"refnum": "brd258465289",
"status": "Success"
}
Sample Error Response:
{
"refnum": "brd258465289",
"status": "Error",
"error": {
"errorCode": "AccessDenied",
"errorMessages": [
"Access Denied"
]
}
}
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
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:
| 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 |
Sample Request
{
"apiKey": "Your API Key",
"tierName": "Your Tier",
"corporateName": "FR Furniture Source",
"dbaName": "Fall River Furniture",
"annualCreditCardSales": "80000",
"ownershipType": "Other",
"businessStartDate": "2005-08-01",
"agentName": "John Smith",
"agentEmail": "[email protected]",
"website": "www.fallriverfurniture.com/",
"taxId": "225555555",
"businessEmail": "[email protected]",
"businessPhone": "5082025000",
"businessAddress": {
"streetAddress": "4114 South Bath Avenue",
"city": "Fall River",
"state": "MA",
"zip": "02721",
"country": "United States"
},
"mailingAddress": {
"streetAddress": "4114 South Bath Avenue",
"city": "Fall River",
"state": "MA",
"zip": "02721",
"country": "United States"
},
"productSold": "Home Furnishings",
"bankingInformation": {
"bankName": "Chase",
"routingNumber": "021000021",
"accountNumber": "454545454545"
},
"signerInformationList": [
{
"ssn": "115668989",
"dateOfBirth": "1955-07-14",
"firstName": "Irving",
"lastName": "Palomer",
"address": {
"streetAddress": "4114 South Bath Avenue",
"city": "Fall River",
"state": "MA",
"zip": "02721",
"country": "United States"
},
"ownershipPercentage": 100,
"title": "Owner",
"ownerCellPhone": "4445559999"
}
],
"signature": {
"token": ""
}
}
Parameter | Description |
Status |
|
Refnum | |
Error |
|
AppId |
Sample Success Response
{
"appId": 9854,
"refnum": "brd221002160",
"status": "Success"
}
Sample Error Response:
{
"status": "Error",
"error": {
"errorCode": "BadRequest",
"errorMessages": [
"BusinessAddress.State: The State field is required.",
"SignerInformationList[0].SSN: The SSN field is required."
]
}
}
Last modified 9mo ago