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

Configuration	UAT `processor_config_id`	Production `processor_config_id`
Elavon	`4e4e07cb-a017-41ec-b718-c7c072a5b4a2`	`33dfde06-4c35-4416-a6ee-28ba31d434da`

For production access to Elavon, contact support@koard.com.

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

Select the Elavon configuration assigned to your merchant from GET /v1/processor-configs. Create the terminal with POST /v2/terminals.

Field	What to send
`account_id`	Merchant's Koard account ID
`processor_config_id`	Elavon configuration ID
`name`	Optional terminal display name
`mcc`	Four-digit merchant category code
`tid`	Full 22-digit terminal identifier, if supplying it directly
`var_sheet.bank_number`	Six-digit bank number, when supplying the identifier in parts
`var_sheet.terminal_number`	Assigned terminal number of 1–16 digits, when supplying the identifier in parts; shorter values are left-padded with zeros to 16 digits
`var_sheet`	Required object; use `{}` when supplying the full `tid` without other details

Supply the full tid, or supply both bank and terminal numbers. Use the assigned terminal number from your VAR sheet, including leading zeros. A lane number alone does not replace the terminal number. mid is optional.

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.

Elavon

UAT example. Supply the six-digit bank number and the assigned terminal number from your VAR sheet. Terminal numbers accept 1–16 digits; shorter values are left-padded with zeros to 16 digits. You can instead supply the full 22-digit tid with an empty var_sheet object.

{
  "account_id": "00000000-0000-4000-8000-000000000001",
  "processor_config_id": "4e4e07cb-a017-41ec-b718-c7c072a5b4a2",
  "name": "Example Coffee",
  "mcc": "5812",
  "var_sheet": {
    "bank_number": "123456",
    "terminal_number": "0000000012345678",
    "country_code": "USA",
    "currency_code": "840"
  }
}

Optional merchant details

The VAR sheet accepts merchant_name, merchant_street_address, merchant_street_address2, merchant_city, merchant_state, and merchant_postal_code.

Use country_code: "USA" and currency_code: "840" for US dollar processing. US, 840, and 0840 are also accepted as US country values. An omitted or null country defaults to USA on create.

acceptor_phone and acceptor_customer_service_phone accept formatted US numbers, including a leading +1, and normalize to ten digits.

Updates

Use PUT /v2/terminals/{terminal_id} with only the changed fields. An omitted country keeps its current value; a null country becomes USA. See shared address rules.

Omaha

Worldpay