In-person payments
Take card payments in store on a phone or a Kustom terminal. How enrollments, devices and sessions fit, what your backend builds and how to get /ipp/v1 enabled.
Take card payments in your store on an iPhone, an Android phone or a Kustom terminal. Your backend sends a cart to the device, the clerk collects the payment, and you get the same order in Order Management that an online checkout creates.
Enroll a device
Pair a phone or terminal with your account through a one-time code.
Take a payment
Send a cart to the device and handle the callbacks.
Test without hardware
Check the whole flow in Playground with a simulated device and card tap.
Devices managed by an MDM? Enroll a managed fleet instead. Writing the callback handler? Session states and callbacks is the reference.
How it fits together
Section titled “How it fits together”| Concept | What it is |
|---|---|
| Enrollment | A single-use code that pairs a device with your account |
| Device | An enrolled phone or terminal, addressed by its device_id |
| Session | One payment: a cart sent to a device_id |
It’s its own API under /ipp/v1, separate from Checkout. There’s no order to create first:
Kustom creates it when the session is finalized.
Phones and terminals
Section titled “Phones and terminals”Both run the Kustom POS app, enroll the same way and take the same sessions. They differ in how the customer can pay:
| Device | The customer can |
|---|---|
| iPhone or Android phone | Tap |
| Kustom terminal: S700, S710 or V660p | Insert, swipe or tap |
The API doesn’t say which kind a device is, so give each one a name when you
update it.
Getting set up
Section titled “Getting set up”Ask your Kustom representative to enable in-person payments. The /ipp/v1 endpoints
don’t answer until they have. After that, the API takes your usual API username and API password.
On a phone, install the Kustom POS app from the App Store or Google Play. Your Kustom representative can supply a Playground build of either.
Settings Kustom configures for you
Section titled “Settings Kustom configures for you”Your Kustom representative sets these, not the API:
- Capture method, per account:
- Automatic. The payment is captured as soon as it’s authorized.
- Manual. It stays authorized until you capture it, later or in part.
- Fiscalization, per location, in some countries only:
- Enabled. Kustom’s certified cash registers issue compliant fiscal receipts.
- Disabled. No fiscal receipts.
Related
Section titled “Related”- Order management — capturing, refunding and cancelling the order a finalized session creates
- In-Person Payments API — every endpoint
This page is also available as Markdown — append .md to its URL — and is indexed in llms.txt.