> ## Documentation Index
> Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create CoworkerInvoicePaymentToken

> Create a new CoworkerInvoicePaymentToken record.

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

<Note>
  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.
</Note>

## Enums

<Accordion title="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                      |
</Accordion>

## Request Body

### Required Fields

<ParamField body="CoworkerInvoiceId" type="integer" required>
  Coworker Invoice Id.
</ParamField>

### Optional Fields

<ParamField body="RegularPaymentProvider" type="integer">
  Payment provider used to process the invoice. See `eRegularPaymentProvider?` enum above.
</ParamField>

<ParamField body="Token" type="string">
  Provider-specific token used to authorise or capture the payment.
</ParamField>

<ParamField body="Notes" type="string">
  Additional notes about the payment token.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/billing/coworkerinvoicepaymenttokens" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "CoworkerInvoiceId": 0
  }'
  ```

  ```javascript JavaScript theme={null}
  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();
  ```

  ```python Python theme={null}
  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()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the coworkerinvoicepaymenttoken was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```