> ## Documentation Index
> Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Search CoworkerPaymentMethods

> Search and list CoworkerPaymentMethod records with filtering, sorting, and pagination.

A **CoworkerPaymentMethod** is a tokenised payment method stored against a customer and a location, used when charging invoices issued to that customer by that location.

Currently supported providers are **Stripe** (card and ACH/BACS) and **GoCardless** (direct debit mandates). The `RegularPaymentProvider` field identifies the provider; valid values for this entity are `Stripe` (2), `StripeACH` (11), `StripeBACS` (13), and `GoCardless` (12).

* For Stripe methods, `MethodId` holds the Stripe payment method ID and `CustomerId` holds the Stripe customer ID.
* For GoCardless mandates, `MandateId` holds the GoCardless mandate ID and `CustomerId` holds the GoCardless customer ID.
* `CardNumber` stores a masked card number for display purposes only.

## Authentication

<Note>
  This endpoint requires OAuth2 authentication. Include a valid bearer token in the `Authorization` header.
  The authenticated user must be a full unrestricted administrator or have the **`CoworkerPaymentMethod-List`** role.
</Note>

## Enums

<Accordion title="eRegularPaymentProvider">
  | Value | Name                       |
  | ----- | -------------------------- |
  | 1     | MultiGateway               |
  | 2     | Stripe                     |
  | 3     | Forte                      |
  | 4     | AuthorizeNetSubscription   |
  | 5     | PaypalStandardSubscription |
  | 6     | PayPalAdaptive             |
  | 7     | EPay                       |
  | 8     | Braintree                  |
  | 9     | EziDebit                   |
  | 10    | LiqPay                     |
  | 11    | StripeACH                  |
  | 12    | GoCardless                 |
  | 13    | StripeBACS                 |
  | 94    | CreditNote                 |
  | 95    | GiftCard                   |
  | 96    | BankTransfer               |
  | 97    | Cash                       |
  | 98    | Check                      |
  | 99    | Other                      |
</Accordion>

## Query Parameters

### Pagination & Sorting

<ParamField query="page" type="integer" default="1">
  The page number to retrieve.
</ParamField>

<ParamField query="size" type="integer" default="25">
  The number of records per page.
</ParamField>

<ParamField query="orderBy" type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField query="dir" type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField query="CoworkerPaymentMethod_Coworker" type="integer">
  Filter by customer this payment method belongs to.
</ParamField>

<ParamField query="CoworkerPaymentMethod_Business" type="integer">
  Filter by location that issued or will charge invoices using this payment method.
</ParamField>

<ParamField query="CoworkerPaymentMethod_Business_Name" type="string">
  Filter by location name.
</ParamField>

<ParamField query="CoworkerPaymentMethod_Business_Currency_Code" type="string">
  Filter by currency code of the location.
</ParamField>

<ParamField query="CoworkerPaymentMethod_RegularPaymentProvider" type="integer">
  Filter by payment provider for this method. For this entity, valid values are Stripe (2), StripeACH (11), StripeBACS (13), and GoCardless (12)..
</ParamField>

<ParamField query="CoworkerPaymentMethod_MethodId" type="string">
  Filter by provider payment method ID (e.g. Stripe payment method ID).
</ParamField>

<ParamField query="CoworkerPaymentMethod_CustomerId" type="string">
  Filter by provider customer ID (e.g. Stripe or GoCardless customer ID).
</ParamField>

<ParamField query="CoworkerPaymentMethod_MandateId" type="string">
  Filter by goCardless mandate ID. Only populated for GoCardless payment methods..
</ParamField>

<ParamField query="CoworkerPaymentMethod_CardNumber" type="string">
  Filter by masked card number for display purposes only.
</ParamField>

<ParamField query="CoworkerPaymentMethod_Notes" type="string">
  Filter by optional notes about this payment method.
</ParamField>

### Range Filters

<ParamField query="from_CoworkerPaymentMethod_CreatedOn" type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_CoworkerPaymentMethod_CreatedOn" type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="from_CoworkerPaymentMethod_UpdatedOn" type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_CoworkerPaymentMethod_UpdatedOn" type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerpaymentmethods?page=1&size=15&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerpaymentmethods?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'CreatedOn',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkerpaymentmethods',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by CreatedOn

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerpaymentmethods?CoworkerPaymentMethod_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerpaymentmethods?' + new URLSearchParams({
      CoworkerPaymentMethod_CreatedOn: 'example-value',
      orderBy: 'CreatedOn',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkerpaymentmethods',
      params={
          'CoworkerPaymentMethod_CreatedOn': 'example-value',
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerpaymentmethods?from_CoworkerPaymentMethod_UpdatedOn=2025-01-01T00:00&to_CoworkerPaymentMethod_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerpaymentmethods?' + new URLSearchParams({
      from_CoworkerPaymentMethod_UpdatedOn: '2025-01-01T00:00',
      to_CoworkerPaymentMethod_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkerpaymentmethods',
      params={
          'from_CoworkerPaymentMethod_UpdatedOn': '2025-01-01T00:00',
          'to_CoworkerPaymentMethod_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="CoworkerPaymentMethod[]">
  The list of CoworkerPaymentMethod records matching the query. See the [Get one CoworkerPaymentMethod](/rest-api/billing/get-coworkerpaymentmethods-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **Partial records** — The listing endpoint returns a summary representation of each CoworkerPaymentMethod. The following fields are **not populated** in the `Records[]` response: `RegularPaymentProvider`.

  To get all fields, fetch the full record using the [Get one CoworkerPaymentMethod](/rest-api/billing/get-coworkerpaymentmethods-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "CoworkerId": 0,
      "BusinessId": 0,
      "BusinessName": null,
      "BusinessCurrencyCode": null,
      "MethodId": null,
      "CustomerId": null,
      "MandateId": null,
      "CardNumber": null,
      "Notes": null,
      "Id": 87654321,
      "UpdatedOn": "2025-01-15T10:30:00Z",
      "CreatedOn": "2025-01-10T08:00:00Z",
      "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "UpdatedBy": "admin@example.com",
      "IsNew": false,
      "SystemId": null,
      "ToStringText": "CoworkerPaymentMethod Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```