Create CoworkerPaymentMethod

Create a new CoworkerPaymentMethod record.

POST /api/billing/coworkerpaymentmethods

Create CoworkerPaymentMethod

cURL

curl --request POST \
  --url https://spaces.nexudus.com/api/billing/coworkerpaymentmethods \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "CoworkerId": 123,
  "BusinessId": 123
}
'

200

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<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-Create role.

Enums

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

Request Body

Required Fields

CoworkerId · integer · required

Customer this payment method belongs to.

BusinessId · integer · required

Location that issued or will charge invoices using this payment method.

Optional Fields

RegularPaymentProvider · integer

Payment provider for this method. For this entity, valid values are Stripe (2), StripeACH (11), StripeBACS (13), and GoCardless (12).. See eRegularPaymentProvider? enum above.

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.

Code Examples

cURL

curl -X POST \
  "https://spaces.nexudus.com/api/billing/coworkerpaymentmethods" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "CoworkerId": 0,
    "BusinessId": 0
}'

Response

200

Status · integer

HTTP status code. 200 on success.

Message · string

A human-readable message confirming the creation.

Value · object

Contains the Id of the newly created record.

WasSuccessful · boolean

true if the coworkerpaymentmethod was created successfully.

Errors · array

null on success.

Example Response

{
  "Status": 200,
  "Message": "CoworkerPaymentMethod was successfully created.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "[e-mail]",
  "Errors": null,
  "WasSuccessful": true
}

400

Message · string

A summary of the validation error(s), in the format PropertyName: error message.

Value · any

null on validation failure.

Errors · object[]

Array of validation errors.

Show child attributes

AttemptedValue · any

The value that was submitted for the field, or null if missing.

Message · string

The validation error message.

PropertyName · string

The name of the property that failed validation.

WasSuccessful · boolean

false when the request fails validation.

Example Response

{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}