Skip to main content
GET
/
api
/
billing
/
coworkerpaymentmethods
Search CoworkerPaymentMethods
curl --request GET \
  --url https://spaces.nexudus.com/api/billing/coworkerpaymentmethods \
  --header 'Authorization: Basic <encoded-value>'
{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}
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

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.

​
Enums

ValueName
1MultiGateway
2Stripe
3Forte
4AuthorizeNetSubscription
5PaypalStandardSubscription
6PayPalAdaptive
7EPay
8Braintree
9EziDebit
10LiqPay
11StripeACH
12GoCardless
13StripeBACS
94CreditNote
95GiftCard
96BankTransfer
97Cash
98Check
99Other

​
Query Parameters

​
Pagination & Sorting

​
page
integer
default:"1"
The page number to retrieve.
​
size
integer
default:"25"
The number of records per page.
​
orderBy
string
The property name to sort results by (e.g. Name, CreatedOn).
​
dir
integer
Sort direction. 1 for ascending, -1 for descending.

​
Filters

​
CoworkerPaymentMethod_Coworker
integer
Filter by customer this payment method belongs to.
​
CoworkerPaymentMethod_Business
integer
Filter by location that issued or will charge invoices using this payment method.
​
CoworkerPaymentMethod_Business_Name
string
Filter by location name.
​
CoworkerPaymentMethod_Business_Currency_Code
string
Filter by currency code of the location.
​
CoworkerPaymentMethod_RegularPaymentProvider
integer
Filter by payment provider for this method. For this entity, valid values are Stripe (2), StripeACH (11), StripeBACS (13), and GoCardless (12)..
​
CoworkerPaymentMethod_MethodId
string
Filter by provider payment method ID (e.g. Stripe payment method ID).
​
CoworkerPaymentMethod_CustomerId
string
Filter by provider customer ID (e.g. Stripe or GoCardless customer ID).
​
CoworkerPaymentMethod_MandateId
string
Filter by goCardless mandate ID. Only populated for GoCardless payment methods..
​
CoworkerPaymentMethod_CardNumber
string
Filter by masked card number for display purposes only.
​
CoworkerPaymentMethod_Notes
string
Filter by optional notes about this payment method.

​
Range Filters

​
from_CoworkerPaymentMethod_CreatedOn
string
Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.
​
to_CoworkerPaymentMethod_CreatedOn
string
Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.
​
from_CoworkerPaymentMethod_UpdatedOn
string
Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.
​
to_CoworkerPaymentMethod_UpdatedOn
string
Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

​
Code Examples

​
Simple listing

curl -X GET \
  "https://spaces.nexudus.com/api/billing/coworkerpaymentmethods?page=1&size=15&orderBy=CreatedOn&dir=1" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Filtering by CreatedOn

curl -X GET \
  "https://spaces.nexudus.com/api/billing/coworkerpaymentmethods?CoworkerPaymentMethod_CreatedOn=example-value&orderBy=CreatedOn&dir=1" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Range filters

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=-1" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Response

​
200

​
Records
CoworkerPaymentMethod[]
The list of CoworkerPaymentMethod records matching the query. See the Get one CoworkerPaymentMethod endpoint for the full list of properties returned for each record.
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 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.
​
CurrentPage
integer
Current page number.
​
CurrentPageSize
integer
Number of records per page.
​
CurrentOrderField
string
The field used for sorting.
​
CurrentSortDirection
integer
The sort direction (1 = ascending, -1 = descending).
​
FirstItem
integer
Index of the first item on the current page.
​
LastItem
integer
Index of the last item on the current page.
​
TotalItems
integer
Total number of matching records across all pages.
​
TotalPages
integer
Total number of pages.
​
HasNextPage
boolean
Whether there is a next page of results.
​
HasPreviousPage
boolean
Whether there is a previous page of results.
Example Response
{
  "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
}