Create CoworkerPaymentMethod

POST

api

billing

coworkerpaymentmethods

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
}
'

import requests

url = "https://spaces.nexudus.com/api/billing/coworkerpaymentmethods"

payload = {
    "CoworkerId": 123,
    "BusinessId": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({CoworkerId: 123, BusinessId: 123})
};

fetch('https://spaces.nexudus.com/api/billing/coworkerpaymentmethods', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

A customer payment method (CoworkerPaymentMethod) records the provider credentials used to charge a specific customer at a specific location; only one record is allowed for each customer, location, and provider.

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

integer

required

ID of the customer whose payment method is stored; the customer must belong to a location the operator can access.

integer

required

ID of the location that uses this payment method when charging the customer.

Optional Fields

integer

Regular-payment provider for this method; only one method may exist for the same customer, location, and provider, and the Admin UI supports Stripe, StripeACH, StripeBACS, and GoCardless. See eRegularPaymentProvider? enum above.

string

Payment-provider method ID supplied by the provider, such as a Stripe payment method token; set it only for the matching provider flow.

string

Payment-provider customer ID supplied by the provider, such as a Stripe customer ID; set it only for the matching provider flow.

string

Payment-provider mandate or bank-account identifier supplied by a direct-debit provider; GoCardless and StripeBACS use this field.

string

Optional internal notes about this customer payment method.

Code Examples

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
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/coworkerpaymentmethods',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      CoworkerId: 0,
      BusinessId: 0
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/billing/coworkerpaymentmethods',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'CoworkerId': 0,
        'BusinessId': 0
    }
)

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the creation.

object

Contains the Id of the newly created record.

boolean

true if the coworkerpaymentmethod was created successfully.

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": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}

400

string

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

any

null on validation failure.

object[]

Array of validation errors.

Show child attributes

any

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

string

The validation error message.

string

The name of the property that failed validation.

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
}

Create CoworkerPaymentMethod

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
}
'

import requests

url = "https://spaces.nexudus.com/api/billing/coworkerpaymentmethods"

payload = {
    "CoworkerId": 123,
    "BusinessId": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({CoworkerId: 123, BusinessId: 123})
};

fetch('https://spaces.nexudus.com/api/billing/coworkerpaymentmethods', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400

​Authentication

​Enums

​Request Body

​Required Fields

​Optional Fields

​Code Examples

​Response

​200

​400

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400