> ## 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.

# Get one CoworkerPaymentMethod

> Retrieve a single CoworkerPaymentMethod record by its Id.

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

<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 **`CoworkerPaymentMethod-Read`** role.
</Note>

## Path Parameters

<ParamField path="id" type="integer" required>
  The Id of the CoworkerPaymentMethod record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerpaymentmethods/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerpaymentmethods/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkerpaymentmethods/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="CoworkerId" type="integer">
  Customer this payment method belongs to.
</ResponseField>

<ResponseField name="BusinessId" type="integer">
  Location that issued or will charge invoices using this payment method.
</ResponseField>

<ResponseField name="BusinessName" type="string">
  Location name.
</ResponseField>

<ResponseField name="BusinessCurrencyCode" type="string">
  Currency code of the location.
</ResponseField>

<ResponseField name="RegularPaymentProvider" type="integer">
  Payment provider for this method. For this entity, valid values are Stripe (2), StripeACH (11), StripeBACS (13), and GoCardless (12)..
</ResponseField>

<ResponseField name="MethodId" type="string">
  Provider payment method ID (e.g. Stripe payment method ID).
</ResponseField>

<ResponseField name="CustomerId" type="string">
  Provider customer ID (e.g. Stripe or GoCardless customer ID).
</ResponseField>

<ResponseField name="MandateId" type="string">
  GoCardless mandate ID. Only populated for GoCardless payment methods..
</ResponseField>

<ResponseField name="CardNumber" type="string">
  Masked card number for display purposes only.
</ResponseField>

<ResponseField name="Notes" type="string">
  Optional notes about this payment method.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

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