API Reference

Koard API Reference

Koard API provides unified access to account onboarding, terminal management, payment processing, and reporting across all Koard environments.

Base URLs

Environment URL
UAT https://api.uat.koard.com
Production https://api.koard.com

UAT is an isolated sandbox environment — transactions processed there will not appear in card or merchant histories and no money moves.

API Versioning

All Koard API endpoints are versioned with a path prefix (/v1, /v2, /v3, etc.). The version is part of the URL path and is required for every request.

# Example: v1 endpoint
curl https://api.koard.com/v1/accounts/{account_id} \
  -H "x-koard-apikey: YOUR_API_KEY"

# Example: v2 endpoint
curl https://api.koard.com/v2/terminals \
  -H "x-koard-apikey: YOUR_API_KEY"

# Example: v3 endpoint
curl https://api.koard.com/v3/payments/{transaction_id}/capture \
  -H "x-koard-apikey: YOUR_API_KEY"

Current Versions by Resource

Resource Version(s) Path Prefix Notes
Accounts v1, v2 /v1/accounts, /v2/accounts v2 provisions MMS (Clerk org, SVIX app, API key) on creation
Terminals v2 /v2/terminals Paginated listing, search, and full CRUD
Locations v1 /v1/locations Create, update, and retrieve locations
Transactions v1 /v1/transactions List, search, retrieve, and passthrough-only edit transactions
Payments v3 /v3/payment, /v3/preauth Card-present payment initiation via Tap to Pay
Payment Actions v1, v3 /v1/payments/{id}/…, /v3/payments/{id}/… Capture, auth increment, refund, reverse, adjust, confirm
Refunds v3 /v3/refund Standalone refund on completed transactions
Batches v1 /v1/batches Open, close, and edit settlement batches

Version Lifecycle

  • Newer versions may change request/response schemas, add required fields, or alter default behavior. Always use the version shown in the endpoint path.
  • Older versions remain functional but may not include the latest features. We recommend migrating to the latest available version for each resource.
  • Breaking changes are only introduced in new major versions — existing versioned paths remain backward-compatible.

Note: The version prefix (e.g. /v1/, /v2/, /v3/) is required in all request paths. Requests without a version prefix will return a 404.

Passthrough-only transaction edits: PUT /v1/transactions/{transaction_id} is reserved for PSP passthrough EMV flows where Koard is only forwarding EMV data and later receiving the final transaction outcome back from the PSP. It is not available for TSYS, Elavon, Fiserv, Worldpay, or other directly managed processor flows. Unsupported processor edits return 401, while both missing and inaccessible transactions return 404.

Next
Authentication