Skip to main content
GET
/
api
/
billing
/
coworkerpaymentmethods
/
{id}
{
  "CoworkerId": 123,
  "BusinessId": 123,
  "BusinessName": "<string>",
  "BusinessCurrencyCode": "<string>",
  "RegularPaymentProvider": 123,
  "MethodId": "<string>",
  "CustomerId": "<string>",
  "MandateId": "<string>",
  "CardNumber": "<string>",
  "Notes": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

​
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-Read role.

​
Path Parameters

​
id
integer
required
The Id of the CoworkerPaymentMethod record to retrieve.

​
Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/billing/coworkerpaymentmethods/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Response

​
200

​
CoworkerId
integer
Coworker Id.
​
BusinessId
integer
Business Id.
​
BusinessName
string
Business Name.
​
BusinessCurrencyCode
string
Business Currency Code.
​
RegularPaymentProvider
integer
Regular Payment Provider.
​
MethodId
string
Method Id.
​
CustomerId
string
Customer Id.
​
MandateId
string
Mandate Id.
​
CardNumber
string
Card Number.
​
Notes
string
Notes.
​
Id
integer
Unique record identifier.
​
UniqueId
string
UUID of the record.
​
CreatedOn
string
Date and time the record was created (ISO 8601).
​
UpdatedOn
string
Date and time the record was last updated (ISO 8601).
​
UpdatedBy
string
Email of the user who last updated this record.
​
IsNew
boolean
Whether the record was recently created.
​
SystemId
string
External system identifier.
Example Response
{
  "CoworkerId": 0,
  "BusinessId": 0,
  "BusinessName": null,
  "BusinessCurrencyCode": null,
  "RegularPaymentProvider": 0,
  "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
}