WOworkiz
Payments

Retrieve a list of Payments

Changed on

Beta: Breaking changes may occur without notice.

Retrieves a paginated list of Payments, newest first, optionally filtered by date range, client, status or payment type.

get/v2/payments

Request

Query parameters

pageSizenumber
Example:10

Number of records to return per page.

pagenumber
Example:1

The page index.

field'date'

The field to sort results by. Must be combined with order.

order'ASC' | 'DESC'

The sort direction. Must be combined with field. Defaults to DESC.

clientIdstring
Example:CL-OvmDp2yvv1yqMwRl

Return only the payments collected from this client (prefix CL-).

statusstring[]

Return only the payments in these statuses. Accepts a comma separated list. Pair a rarely used status with a date range on large accounts.

typestring[]

Return only the payments of these types. Accepts a comma separated list. Pair a rarely used type with a date range on large accounts.

dateProperty'date'

The payment date field to apply the date filter to. Must be combined with dateOperator and date.

dateOperator'prev' | 'next' | 'between'

Comparison operator for the date filter. Must be combined with dateProperty and date.

datestring

Date value(s) for the filter. Format depends on dateOperator: prev / next accept a single date (YYYY-MM-DD); between accepts two dates separated by _ (YYYY-MM-DD_YYYY-MM-DD).

Headers

Authorizationstring required
Example:Bearer <token>

Bearer Token

Response

A paginated list of Payments.

pageSizenumber

The maximum number of items returned per page.

pagenumber

The current page number.

totalResultsnumber

The total number of results.

hasMoreboolean

Whether there are more results.

Example response

{
  "pageSize": 10,
  "page": 1,
  "totalResults": 50,
  "hasMore": true,
  "data": [
    {
      "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