Cybersource terminal boarding

Processor configurations

Boarding requires a processor_config_id available to your account in the same environment. List available configurations before choosing an ID.

Examples with listed IDs use UAT. For production, use the production API URL, API key and configuration ID.

Connect a terminal using your merchant's existing Cybersource credentials. Select the configuration assigned to your merchant from GET /v1/processor-configs, then create the terminal with POST /v2/terminals.

Request fields

The three credential fields are required and cannot be blank. Supply the merchant ID in var_sheet.merchant_id.

Your Koard API key authenticates the request in the X-Koard-apikey header. The Cybersource credentials belong in var_sheet.

Request examples

Send these request bodies to POST /v2/terminals with your Koard API key in the X-Koard-apikey header.

Processor configuration IDs are listed by environment above. Merchant account IDs, credentials and merchant details below are fictional placeholders; replace them with your merchant's values. Preserve leading zeros.

Cybersource: existing merchant credentials

UAT example. Supply the assigned terminal identifier and the merchant's existing Cybersource merchant ID, API key ID and secret key.

{
  "account_id": "00000000-0000-4000-8000-000000000001",
  "processor_config_id": "18083156-5ce9-4147-bf7c-3f792d010dc7",
  "name": "Example Coffee",
  "tid": "YOUR_ASSIGNED_TID",
  "var_sheet": {
    "merchant_id": "YOUR_MERCHANT_ID",
    "api_key_id": "YOUR_API_KEY_ID",
    "secret_key": "YOUR_SECRET_KEY"
  }
}

See Terminal boarding for common fields and the terminal response.