Skip to main content
Use the Payments API when the customer pays in person. You register a terminal, start a contactless payment on an appointment, then capture it when the charge succeeds.

​
What you do first

  1. Register a terminal for the device that will take the card.
  2. Create a terminal connection token so the device SDK can talk to the processor.
  3. Create a contactless payment on the appointment you are collecting for.
  4. Capture the contactless payment after the device confirms the charge.
Every write that moves money needs an idempotency key.

​
States that matter

Read the payment when the device finishes so you know which state you got, not which one you hoped for.

​
When a call fails

Failures come back as problem documents. Open the type link for the cause, the fix, and whether retrying is safe. Common ones on this path include contactless declines, canceled sessions, and a payment processor that is not set up yet.
  • Appointment card holds and captures live under Appointments.
  • Fee quotes before you show a total live under Fees.
  • Refunds after a capture live under Refunds.