List Payment Methods - Clopos Open API

This endpoint retrieves a list of all configured payment methods. Payment methods represent tender types (e.g., cash, card, wallet). They are used when closing receipts and reconciling totals.

The status object is a venue map. Its keys are venue_id strings and the values indicate enablement at that venue: 1 = enabled, 0 = disabled. For example, status["1"] = 1 means this payment method is enabled for venue 1.

Used by

Close Receipt: map each tender to payment_methods[]

Response Example

{
  "success": true,
  "data": [
    {
      "id": 1,
      "name": "Cash",
      "status": {
        "1": 1,
        "2": 1,
        "3": 1
      },
      "split": 1,
      "position": 0,
      "customer_required": 0,
      "is_system": 0,
      "created_at": "2026-01-13T14:08:49.000000Z",
      "updated_at": "2026-01-13T10:22:12.000000Z",
      "balance": {
        "id": 1,
        "system_type": "CASH",
        "name": "Kassa",
        "type": "CASH"
      },
      "service": null
    },
    {
      "id": 2,
      "name": "Card",
      "status": {
        "1": 1,
        "2": 1,
        "3": 1
      },
      "split": 1,
      "position": 0,
      "customer_required": 0,
      "is_system": 0,
      "created_at": "2026-01-13T14:08:49.000000Z",
      "updated_at": "2026-01-13T10:22:12.000000Z",
      "balance": {
        "id": 2,
        "system_type": "CARD",
        "name": "Kart",
        "type": "CARD"
      },
      "service": null
    },
    {
      "id": 3,
      "name": "Customer Balance",
      "status": {
        "1": 0,
        "2": 1,
        "3": 1
      },
      "split": 1,
      "position": 0,
      "customer_required": 1,
      "is_system": 0,
      "created_at": "2026-01-13T14:08:49.000000Z",
      "updated_at": "2026-01-13T10:22:12.000000Z",
      "balance": null,
      "service": null
    },
    {
      "id": 4,
      "name": "Cashback",
      "status": {
        "1": 0,
        "2": 0,
        "3": 0
      },
      "split": 1,
      "position": 0,
      "customer_required": 1,
      "is_system": 0,
      "created_at": "2026-01-13T14:08:49.000000Z",
      "updated_at": "2026-01-13T10:22:12.000000Z",
      "balance": null,
      "service": {
        "name": "loyalty",
        "check": [],
        "payload": []
      }
    }
  ],
  "total": 4
}

Field Reference

Payment Method Object

Field	Type	Description
`id`	integer	Unique identifier for the payment method.
`name`	string	Display name of the payment method (e.g., “Cash”, “Card”).
`status`	object	Map of `venue_id` (string) to `0`/`1` indicating whether this method is enabled at each venue.
`split`	integer	`1` if this payment method can be used for split payments, `0` otherwise.
`position`	integer	Display order position.
`customer_required`	integer	`1` if a customer must be attached to the transaction, `0` otherwise.
`is_system`	integer	`1` if this is a system-default payment method, `0` otherwise.
`created_at`	string	Creation timestamp (ISO 8601).
`updated_at`	string	Last update timestamp (ISO 8601).
`balance`	object (nullable)	Associated balance account, or `null` if none. See Balance object.
`service`	object (nullable)	External service integrated with this payment method (e.g., loyalty), or `null`.

Balance Object (nested in `balance`)

Field	Type	Description
`id`	integer	Balance account identifier.
`system_type`	string	System type of the balance (e.g., `CASH`, `CARD`).
`name`	string	Display name of the balance account.
`type`	string	Balance type (e.g., `CASH`, `CARD`).