WOworkiz
Payments

Retrieve a single Payment

Changed on

Beta: Breaking changes may occur without notice.

Retrieves a single Payment by its ID.

get/v2/payments/{id}

Request

Path parameters

idstring required
Example:PAY-BA5r7o4bqzR9MONa

The payment ID (prefix PAY-).

Headers

Authorizationstring required
Example:Bearer <token>

Bearer Token

Response

The requested Payment.

idstring

The ID of the payment (prefix PAY-).

datestring date-time

The date and time the payment was collected.

amountnumber

The amount the client was charged. Reported for a failed payment too, so check status before counting it as money collected.

tipAmountnumber

The tip amount included in the payment.

type'charge' | 'cash' | 'credit' | 'check' | 'refund' | 'refund_offline' | 'bank_transfer' | 'bank_transfer_offline' | 'cash_app' | 'consumer_financing' | 'venmo' | 'zelle' | 'debit_offline' | 'installments' | 'interac' | 'check_deposit'

The type of the payment.

status'pending' | 'failed' | 'succeeded'

The status of the payment.

estimateIdstring nullable

The ID of the estimate the payment was collected against (prefix ES-), or null when the payment is not tied to an estimate.

confirmationCodestring

The confirmation code of the payment.

collectedByIdstring nullable

The ID of the user who collected the payment (prefix USR-), or null when the payment was not collected by a user.

invoiceIdstring nullable

The ID of the invoice the payment was collected against (prefix IV-), or null when the paid document is not invoiced.

jobIdstring nullable

The ID of the job the payment was collected against (prefix JOB-, or LD- for a lead), or null when the payment belongs to a standalone invoice or estimate.

netAmountnumber

The amount collected before tax, less the processing fee. A failed payment collects nothing but still costs its processing fee, so it reports a negative amount - it is not simply amount minus processingFee.

processingFeenumber

The fee the payment gateway charged for processing the payment.

creditCardServiceFeenumber

The service fee the client was surcharged for paying by credit card. Refunds never carry one.

clientIdstring nullable

The ID of the client the payment was collected from (prefix CL-).

Example response

{
  "id": "PAY-BA5r7o4bqzR9MONa",
  "date": "2026-01-01 10:00:00",
  "amount": 250.5,
  "tipAmount": 10,
  "type": "charge",
  "status": "succeeded",
  "estimateId": "ES-LwqGJnRwvZPaNe5E",
  "confirmationCode": "ch_3QwErTyUiOp12345",
  "collectedById": "USR-38c1ee5c4efa38a4",
  "invoiceId": "IV-bK9r2XyZL54aWDR0",
  "jobId": "JOB-BA5r7o4bqzR9MONa",
  "netAmount": 243.24,
  "processingFee": 7.26,
  "creditCardServiceFee": 8.5,
  "clientId": "CL-OvmDp2yvv1yqMwRl"
}

Changes