Skip to main content
GET
/
api
/
billing
/
coworkerpaymentmethods
/
{id}
Get one CoworkerPaymentMethod
curl --request GET \
  --url https://spaces.nexudus.com/api/billing/coworkerpaymentmethods/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "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>"
}
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-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
Customer this payment method belongs to.
​
BusinessId
integer
Location that issued or will charge invoices using this payment method.
​
BusinessName
string
Location name.
​
BusinessCurrencyCode
string
Currency code of the location.
​
RegularPaymentProvider
integer
Payment provider for this method. For this entity, valid values are Stripe (2), StripeACH (11), StripeBACS (13), and GoCardless (12)..
​
MethodId
string
Provider payment method ID (e.g. Stripe payment method ID).
​
CustomerId
string
Provider customer ID (e.g. Stripe or GoCardless customer ID).
​
MandateId
string
GoCardless mandate ID. Only populated for GoCardless payment methods..
​
CardNumber
string
Masked card number for display purposes only.
​
Notes
string
Optional notes about this payment method.
​
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
}