Worldpay 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 |
|---|---|---|
| Worldpay | 02eb8a39-b992-423b-ba41-2a0e28958519 |
08080f44-f181-4d46-9be4-82d56ae8ccfa |
For production access to Worldpay, contact support@koard.com.
Examples with listed IDs use UAT. For production, use the production API URL, API key and configuration ID.
Select the Worldpay 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 |
Worldpay configuration ID |
mid |
Twelve-digit merchant ID |
tid |
Three-digit terminal ID |
mcc |
Four-digit merchant category code |
var_sheet.bank_id |
Four-digit bank ID; required |
var_sheet.lane_number |
Optional lane number; defaults to 001 |
name |
Optional terminal display name |
Keep identifiers as strings and preserve leading zeros.
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.
Worldpay
UAT example. Supply the twelve-digit mid, three-digit tid and four-digit bank_id assigned to your merchant.
{
"account_id": "00000000-0000-4000-8000-000000000001",
"processor_config_id": "02eb8a39-b992-423b-ba41-2a0e28958519",
"name": "Example Coffee",
"mid": "123456789012",
"tid": "001",
"mcc": "5812",
"var_sheet": {
"bank_id": "1234",
"lane_number": "001",
"country_code": "USA"
}
}
Address and updates
Optional VAR-sheet fields include merchant_name, merchant_street_address, merchant_street_address2, merchant_city, merchant_state, merchant_postal_code, and country_code.
Country defaults to USA on create. US and 840 are also accepted as US country values. Use PUT /v2/terminals/{terminal_id} with only the changed fields. Omit country to keep its current value, or send null to set it to USA.
