# Replace paymentmethod

Fully replaces an existing Paymentmethod. All fields must be provided.

Endpoint: PUT /site/{siteId}/ahds/v1/paymentmethod/{paymentmethodId}
Version: 1.0
Security: bearer

## Path parameters:

  - `siteId` (number, required)
    Site identifier

  - `paymentmethodId` (string, required)
    Paymentmethod unique identifier (UUID)

## Request fields (application/json):

  - `commissionRate` (string, required)
    Commission rate as a decimal fraction (e.g., '0.025' for 2.5%).

  - `extensions` (object, required)
    Vendor- or practice-specific extensions. Keys SHOULD be URIs or namespaced identifiers to avoid collisions.

  - `isActive` (boolean, required)
    Whether this payment method is active and can be used.

  - `name` (string, required)
    Human-readable name of the payment method (e.g., Cash, Visa).

  - `paymentMethodType` (string, required)
    High-level category of the payment method.
    Enum: "cash", "card", "bankTransfer", "check", "online", "other"

  - `surcharge` (object, required)
    Configuration for any surcharge applied when using this payment method.

  - `isUsingEftposTerminal` (boolean, required)
    Indicates if this payment method uses an EFTPOS/credit card terminal.

## Response 200 fields (application/json):

  - `commissionRate` (string, required)
    Commission rate as a decimal fraction (e.g., '0.025' for 2.5%).

  - `createdAt` (string, required)
    Timestamp when the payment method was created, in RFC 3339 format with timezone offset.
    Example: "2025-01-01T00:00:00.000Z"

  - `extensions` (object, required)
    Vendor- or practice-specific extensions. Keys SHOULD be URIs or namespaced identifiers to avoid collisions.

  - `isActive` (boolean, required)
    Whether this payment method is active and can be used.

  - `name` (string, required)
    Human-readable name of the payment method (e.g., Cash, Visa).

  - `paymentMethodType` (string, required)
    High-level category of the payment method.
    Enum: "cash", "card", "bankTransfer", "check", "online", "other"

  - `paymentmethodId` (string, required)
    Canonical identifier for the payment method.
    Example: "123e4567-e89b-12d3-a456-426614174000"

  - `surcharge` (object, required)
    Configuration for any surcharge applied when using this payment method.

  - `updatedAt` (string, required)
    Timestamp when the payment method was last updated.
    Example: "2025-01-01T00:00:00.000Z"

  - `isUsingEftposTerminal` (boolean, required)
    Indicates if this payment method uses an EFTPOS/credit card terminal.


## Response 400 fields

## Response 401 fields

## Response 404 fields