Available processor configurations

Every terminal boarding request needs a processor_config_id. This identifies the processor configuration your merchant will use. Choose an ID returned for your account in the environment where you are boarding the terminal.

List available configurations

Call GET /v1/processor-configs with your Koard API key. The response is a list of active configurations available to your account.

Environment API URL
UAT https://api.uat.koard.com
Production https://api.koard.com

UAT request:

curl "https://api.uat.koard.com/v1/processor-configs" \
  --header "X-Koard-apikey: YOUR_UAT_API_KEY"

For production, use the production URL and your production API key.

The fields you need to choose a configuration are:

Field How to use it
id Send this value as processor_config_id in your terminal boarding request.
name Identify the configuration you intend to use.

For example, one UAT TSYS result contains these fields; other response fields are omitted here:

{
  "id": "dcc6d302-2406-4973-b555-d070e66e6adb",
  "name": "TSYS"
}

Use the configuration when boarding

  1. List the configurations available to your account.
  2. Choose the configuration for your processor and environment.
  3. Send its id as processor_config_id in POST /v2/terminals, together with your merchant's account_id and the fields in the processor's boarding guide.

The top of each processor boarding guide lists its UAT and production IDs. The request examples use UAT IDs where available. Use a production ID for production requests.

TSYS without PIN and TSYS with PIN are separate configurations with different IDs. Select the configuration for the service you need.

Configuration access

Contact support@koard.com for access to TSYS with PIN or Silverflow. For production access to processors other than Fiserv Nashville/Cybersource, contact the same address.

An ID shown in a guide must also appear in the configurations available to your account. If the configuration you need is missing from the response, contact support to request access.