Records a payment against a work order. Only valid for orders in pending_payment status. Moves the order to payment_submitted regardless of whether the payment is full or partial — admin reviews all payments and resets to pending_payment if a balance remains.
Authentication
Two auth modes are accepted — provide one:
Field
Type
Required
Description
confirmation_token
string
Optional*
Token returned by create_work_order
reference_code
string
Optional*
Work order reference code
customer_email
string
Optional*
Required when using reference_code auth
Request Parameters
Field
Type
Required
Description
payment_transaction_id
string
Optional
Your transaction or order ID
customer_note
string
Optional
Note from the customer
amount
float
Optional
Amount being paid. When omitted, the order is moved to payment_submitted with no amount recorded. When provided, the amount is added to any previous payments and a payment history entry is created.
Response Fields
Field
Type
Description
work_order_id
integer
Work order ID
reference_code
string
Work order reference code
status
string
Always payment_submitted
fully_paid
boolean
Whether total received meets or exceeds the order total
amount_paid
float
Cumulative total paid — only present when amount was provided
balance_due
float
Remaining balance — only present when amount was provided