Create CoworkerInvoicePaymentToken

POST

api

billing

coworkerinvoicepaymenttokens

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

import requests

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

payload = { "CoworkerInvoiceId": 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({CoworkerInvoiceId: 123})
};

fetch('https://spaces.nexudus.com/api/billing/coworkerinvoicepaymenttokens', 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 CoworkerInvoicePaymentToken is an internal record of the token used to process the payment for a customer invoice. Each token links a CoworkerInvoice to the payment provider and the provider-specific token string used to authorise or capture the payment. Use the Notes field to store any additional context about the token.

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 CoworkerInvoicePaymentToken-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 coworker invoice linked to this record.

Optional Fields

integer

Payment provider used to process the invoice. See eRegularPaymentProvider? enum above.

string

Provider-specific token used to authorise or capture the payment.

string

Additional notes about the payment token.

Code Examples

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

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

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/billing/coworkerinvoicepaymenttokens',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'CoworkerInvoiceId': 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 coworkerinvoicepaymenttoken was created successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "CoworkerInvoicePaymentToken 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
}

Update CoworkerInvoicePaymentTokenUpdate an existing CoworkerInvoicePaymentToken record.

Create CoworkerInvoicePaymentToken

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

import requests

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

payload = { "CoworkerInvoiceId": 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({CoworkerInvoiceId: 123})
};

fetch('https://spaces.nexudus.com/api/billing/coworkerinvoicepaymenttokens', 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

Create CoworkerInvoicePaymentToken

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