Boarding a Merchant with Payroc
Payroc merchants require two values from Payroc to board a terminal: a Processing Terminal ID and a Processing MID. These are provided by Payroc and entered when configuring the terminal in the Koard MMS.
Via the MMS
After creating the merchant account, click New Terminal and select Payroc as the processor. Enter the Processing Terminal ID and Processing MID provided by Payroc.
Once saved, assign the terminal to a location and generate merchant credentials. The merchant can then use those credentials to log into the SDK and run payments.
Surcharging is not supported for Payroc processor configurations.
Via the API
Send Authorization: Bearer {API_KEY} with every request. Use https://api.uat.koard.com for sandbox and https://api.koard.com for production.
Create Terminal — POST /v2/terminals
| Field | Required | Description |
|---|---|---|
account_id |
Yes | Merchant account ID |
processor_config_id |
Yes | Payroc processor configuration ID |
terminal_name |
Yes | Display name for the terminal |
terminal_description |
No | Optional description |
var_sheet.processing_terminal_id |
Yes | Processing Terminal ID provided by Payroc |
var_sheet.processing_merchant_id |
Yes | Processing MID provided by Payroc |
Example
curl https://api.uat.koard.com/v2/terminals \
-X POST \
-H "Authorization: Bearer $KOARD_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"account_id": "100200300001",
"processor_config_id": "prc_live_payroc_us",
"terminal_name": "Front Counter iPhone",
"var_sheet": {
"processing_terminal_id": "YOUR_PROCESSING_TERMINAL_ID",
"processing_merchant_id": "YOUR_PROCESSING_MID"
}
}'
