Silverflow 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.

For access to Silverflow, contact support@koard.com.

If an ID is not listed, contact support@koard.com for the appropriate configuration.

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

Select your Silverflow configuration from GET /v1/processor-configs. Use POST /v2/terminals to create a terminal with a new acceptor or connect one belonging to the merchant.

Create an acceptor

Send top-level account_id, processor_config_id, mid, and mcc. In var_sheet, provide merchant_name and a bin_key available from GET /v1/silverflow/bins.

The merchant account must already contain its business name, address and tax details. The merchant name defaults to the top-level merchant_name, then name, then the account name if var_sheet.merchant_name is omitted.

Use point_of_sale_address for the physical payment location when it differs from the merchant account, as shown in the create-acceptor example below.

The flat merchant_* address fields described in Terminal boarding are also accepted.

Use an existing acceptor

Supply var_sheet.acceptor_key for an acceptor belonging to this merchant. You do not need to repeat its MID, MCC or BIN key.

Omit var_sheet.merchant_name and the address to keep the acceptor's existing values. If it has no address, the merchant account address is used.

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.

Silverflow: create an acceptor

UAT example. Select an available bin_key from GET /v1/silverflow/bins. Supply the merchant name, mid and mcc. The merchant account must contain its business, address and tax details.

{
  "account_id": "00000000-0000-4000-8000-000000000001",
  "processor_config_id": "0273faf8-8ce5-454e-b7ac-9e29732fffff",
  "name": "Example Coffee",
  "mid": "YOUR_ASSIGNED_MID",
  "mcc": "5812",
  "var_sheet": {
    "bin_key": "bin-YOUR_ASSIGNED_BIN",
    "merchant_name": "Example Coffee",
    "point_of_sale_address": {
      "line1": "123 Main Street",
      "line2": "Suite 200",
      "city": "New York",
      "stateOrProvince": "NY",
      "postalCode": "10016",
      "countryCode": {
        "alpha3": "USA"
      }
    }
  }
}

Silverflow: use an existing acceptor

UAT example. Supply an acceptor_key belonging to this merchant. Omit the merchant name and address to keep the existing values.

{
  "account_id": "00000000-0000-4000-8000-000000000001",
  "processor_config_id": "0273faf8-8ce5-454e-b7ac-9e29732fffff",
  "name": "Example Coffee",
  "var_sheet": {
    "acceptor_key": "mac-YOUR_ACCEPTOR_KEY"
  }
}

Update the terminal

Use PUT /v2/terminals/{terminal_id} with only the changed fields. For example:

{
  "var_sheet": {
    "merchant_name": "Example Coffee Downtown"
  }
}

var_sheet.name is also accepted for the merchant name. If both are supplied, merchant_name takes precedence. A blank or null merchant name is rejected. A top-level name changes the terminal's display name.