Introduction to Koard
Koard lets your app accept contactless card payments on an iPhone or Android phone, with no separate card reader. Each payment goes to the processor the merchant already uses.
What Koard Does
A merchant opens your app and enters an amount. The customer taps a contactless card or digital wallet on the merchant's phone. The Koard SDK reads the tap through Tap to Pay on iPhone or Tap to Pay on Android, and Koard sends the payment to the merchant's configured processor for authorization. Your app receives the result and decides what to show.
You keep your customers, your payment screens, and your processor relationships. Koard provides the pieces in between.
| Koard provides | You use it to |
|---|---|
| iOS and Android SDKs | Sign the merchant in, prepare the phone as a reader, and take the payment. |
| Dashboard and REST API | Create merchants, board terminals, manage locations, and read transactions. |
| Webhooks | Receive transaction and batch events on your backend. |
| Batches and reports | Reconcile payments against the processor's settlement. |
How an Integration Fits Together
Every payment depends on the same kinds of record, created in this order. A merchant needs at least one terminal and one location, and can have more of each.
| Record | What it is |
|---|---|
| Backend API key | Lets your server create and manage the records below. You need it first if you provision through the API. Dashboard setup does not use one. |
| Merchant account | The business that accepts the payment. A partner or software platform holds many merchants under its own account. |
| Processor configuration | The processor setup the merchant's payments go through. You pick one that is available to your account. |
| Terminal | The merchant's processor credentials, boarded against that processor configuration. |
| Location | Where the device takes payments. A location links to a terminal, and that terminal decides how the payment is routed. |
| Merchant code and PIN | What the merchant uses to sign in to the SDK. |
| App key | A separate API key that your app initializes the SDK with. You need it before the first test payment. |
In the app, the merchant signs in and chooses the active location, then the SDK prepares the device. A payment returns a transaction with a status and amounts. Your app must read both before it shows a receipt, because a completed SDK call or an HTTP 2xx response alone does not prove a successful charge. Payment Lifecycle explains each status, and Account Hierarchy and Credentials explains the three credentials.
Environments
| Environment | Dashboard | API |
|---|---|---|
| UAT | app.uat.koard.com | https://api.uat.koard.com |
| Production | app.koard.com | https://api.koard.com |
Build and test in UAT, where transactions do not move money. Production is separate: nothing you create in UAT exists there. Keep API keys, account IDs, processor configuration IDs, and processor credentials together by environment.
What You Need
| You need | Details |
|---|---|
| UAT access | A login to Koard UAT. Contact support@koard.com if you do not have one. |
| A processor configuration | One that is available to your account in UAT, with that processor's test credentials and its assigned test cards or wallet tokens. See Available Processor Configurations. |
| A US business address | Merchant boarding currently supports US business addresses. |
| A physical test device | A simulator or a keyed card number cannot replace a contactless tap. |
| Platform | Test device and setup |
|---|---|
| iOS SDK 1.0.21 | A supported physical iPhone with iOS 17.4 or later, the Tap to Pay entitlement, and a dedicated Sandbox Apple Account. Install with Swift Package Manager or CocoaPods. |
| Android SDK 1.0.7 | A supported NFC device with Android 13 or later, Visa Tap to Pay Ready, and developer mode disabled before enrollment or payments. Install from Maven Central. |
Get Started
Follow these steps in order. Each guide ends by sending you to the next one.
| Step | What you do | Guide |
|---|---|---|
| 1 | Set up one merchant in UAT: create the merchant, identify its processor configuration, board a terminal, link a location, then create sign-in credentials and the app key. Use the dashboard or the API, not both. | Dashboard setup or API setup |
| 2 | Take a first test payment with the demo app on a physical device. | iOS Quickstart or Android Quickstart |
| 3 | Build payments into your own app. | Installing the SDK on iOS or Installing the SDK on Android |
| 4 | Verify recovery, webhooks, and settlement, pass the platform's reviews, and go live. | Launch Checklist, then iOS or Android |
If your merchant, terminal, location, and credentials already exist, start at step 2. If you are building a platform that onboards many merchants, read Software Platform Integration first to see how the work divides between your backend and your app.
For integration support, contact support@koard.com. For business inquiries, contact b@koard.com.

