Accept in-store card payments through your existing Kustom integration. Your backend creates a payment session, which is dispatched to a store clerk's device. The clerk collects the payment, and Kustom delivers lifecycle callbacks back to you.
| Reading time | ~15 minutes |
| Time to first test payment | ~30 minutes |
| Prerequisites | In-Person Payments enabled on your account, a Kustom API key, and a device running the Kustom POS app |
In-Person Payments is enabled per account. To get started, please reach out to your Kustom representative and request that the product be enabled. Once it’s enabled, your API key gains access to the /ipp/v1 endpoints, and you can begin enrolling devices.
The In-Person Payments API is separate from the Checkout API. It lives at /ipp/v1 and uses the same API key authentication.
Before you can process in-person payments, you need the Kustom POS app on your terminal device. Follow the steps below to authenticate and begin using the API.
A store clerk collects payments using the Kustom POS app, which runs on the terminal device. Download it from the App Store (iOS) or Google Play (Android):
A Playground (sandbox) version of the app is available for both iOS and Android, allowing you to test against the playground without affecting live payments. Ask your Kustom representative to provide it to you.
| Concept | What it is |
|---|---|
| Enrollment | A one-time pairing code that links a physical device to your merchant account. A clerk enters the 8-character code in the Kustom POS app to register the device. |
| Device | A registered terminal — your own smartphone (iPhone or Android) running the Kustom POS app. Once enrolled, a device has a stable device_id you use to dispatch sessions to it. |
| Session | A single payment request. Your backend creates a session with the cart and a target device_id. Kustom pushes it to the device instantly. |
- Enroll a Device — Create enrollment codes, register devices
- Create a Session — Dispatch payment requests to devices
- Receive Callbacks — Session lifecycle events and order creation
- Testing — Simulate devices and card taps without real hardware
- API Reference — Full endpoint reference