Payroc 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 |
|---|---|---|
| Payroc | 5c522102-dcc5-45b8-a57c-95792ea1ae9c |
e3cc6c01-5532-48f7-8cd3-639e3c3f10b0 |
For production access to Payroc, contact support@koard.com.
Examples with listed IDs use UAT. For production, use the production API URL, API key and configuration ID.
Use the Processing MID and Processing Terminal ID assigned by Payroc. Select your Payroc configuration 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 |
Payroc configuration ID |
name |
Optional terminal display name |
description |
Optional description |
mid |
Payroc Processing MID |
tid |
Payroc Processing Terminal ID |
mcc |
Optional four-digit merchant category code |
Send mid and tid at the top level. Omit var_sheet; a non-empty VAR sheet is rejected.
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.
Payroc
UAT example. Send the assigned merchant and terminal identifiers at the top level. No VAR sheet is needed.
{
"account_id": "00000000-0000-4000-8000-000000000001",
"processor_config_id": "5c522102-dcc5-45b8-a57c-95792ea1ae9c",
"name": "Example Coffee",
"mid": "1234567",
"tid": "7654321",
"mcc": "5812"
}
Updates
Use PUT /v2/terminals/{terminal_id} to update the terminal.
