W/O Payments

POSThttps://staging.x1.temprapp.com/api/v3/work-orders/{workOrder}/payments

Accepts payment against the work order's project balance due. Supports charging a saved Stripe card on file or creating a Stripe Tap to Pay payment intent.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workOrderintegerrequired

Body

amountstringrequired

payment_type"card_on_file" | "tap_to_pay"required

Allowed values: "card_on_file" | "tap_to_pay"

payment_method_idstring

Required when `payment_type` is `card_on_file`.

descriptionstring

metaobject

Response

application/json

Payment processed or Tap to Pay intent created.

messagestringrequired

paymentobjectrequired

payment.idintegerrequired

payment.amountnumber<float>required

payment.providerstringrequired

payment.statestringrequired

payment.descriptionstring

payment.payment_intent_idstring

payment.payment_method_idstring

tap_to_payobject

tap_to_pay.payment_intent_idstringrequired

tap_to_pay.client_secretstring

tap_to_pay.statusstringrequired

project_balance_duenumber<float>required