Account Boarding API
Last updated
Last updated
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.
URL: https://psapi.cardknox.com/boarding/v1/GetTierNames
Description: The GetTierNames endpoint gives a list of available tiers that can be passed along to the SubmitGoApp request.
Method: POST
Input: JSON
Sample Success Response:
Sample Error Response:
URL: https://psapi.cardknox.com/boarding/v1/SubmitGoApp
The SubmitGoApp end point will create a GoPlus Application.
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
Click here for more information on how to obtain tokens.
BankingDetails
SignerDetails
Address
Signature
Sample Request
Sample Success Response
Sample Error Response:
ExecuteAction will execute an Action for a given ActionName and Template
URL: https://psapi.cardknox.com/boarding/v1/ExecuteAction
Method: POST
Input: JSON
Sample Request:
Sample Success Response:
Sample Error Response: