Skip to main content
GET
/
payment-methods
List Payment Methods
curl --request GET \
  --url https://integrations.clopos.com/open-api/payment-methods \
  --header 'x-brand: <api-key>' \
  --header 'x-token: <api-key>' \
  --header 'x-venue: <api-key>'
[
    {
        "id": 1,
        "name": "Cash",
        "balance_id": 1,
        "customer_required": 0,
        "status": {
            "1": 1,
            "2": 1,
            "3": 1,
            "4": 1,
            "5": 0,
            "6": 1
        },
        "split": 1,
        "position": 0,
        "is_system": 1,
        "created_at": "2022-10-18T10:09:38.000000Z",
        "updated_at": "2024-09-19T10:24:17.000000Z",
        "deleted_at": null,
        "balance": {
            "id": 1,
            "system_type": "CASH",
            "venue_id": 1,
            "name": "Cash",
            "description": null,
            "type": "CASH",
            "amount": 94307.49,
            "position": 0,
            "created_at": "2022-10-18T10:09:38.000000Z",
            "updated_at": "2025-09-25T14:00:50.000000Z",
            "deleted_at": null,
            "pivot": {
                "payment_method_id": 1,
                "balance_id": 1
            }
        },
        "service": null
    }
]
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 
[
    {
        "id": 1,
        "name": "Cash",
        "balance_id": 1,
        "customer_required": 0,
        "status": {
            "1": 1,
            "2": 1,
            "3": 1,
            "4": 1,
            "5": 0,
            "6": 1
        },
        "split": 1,
        "position": 0,
        "is_system": 1,
        "created_at": "2022-10-18T10:09:38.000000Z",
        "updated_at": "2024-09-19T10:24:17.000000Z",
        "deleted_at": null,
        "balance": {
            "id": 1,
            "system_type": "CASH",
            "venue_id": 1,
            "name": "Cash",
            "description": null,
            "type": "CASH",
            "amount": 94307.49,
            "position": 0,
            "created_at": "2022-10-18T10:09:38.000000Z",
            "updated_at": "2025-09-25T14:00:50.000000Z",
            "deleted_at": null,
            "pivot": {
                "payment_method_id": 1,
                "balance_id": 1
            }
        },
        "service": null
    }
]

​
Payment Method Object

FieldTypeDescription
idintegerThe unique identifier for the payment method.
namestringThe name of the payment method (e.g., “Cash”, “Card”).
customer_requiredintegerWhether a customer must be attached to the transaction (1 for yes, 0 for no).
is_systemintegerIndicates if it’s a system-default payment method.
balance_idinteger | nullThe ID of the associated balance account.
balanceobject | nullAn object containing details of the associated balance account.
serviceobject | nullDetails of any external service integrated with this payment method.
splitintegerIndicates if this payment method can be used for split payments.
statusobjectMap of venue_id -> 0/1 availability for this method.

Authorizations

​
x-token
string
header
required

Access token obtained from /auth endpoint

​
x-brand
string
header
required

Brand identifier

​
x-venue
string
header
required

Venue identifier

Response

200 - application/json

Payment methods retrieved successfully.

​
id
integer
​
name
string
​
customer_required
integer
​
is_system
integer
​
balance
object