Skip to main content

List Payment Methods (v1)

Method & Path​

GET /api/v1/client/workspace/:workspaceId/payment-methods

Description​

List workspace-defined payment methods (e.g. cash, bank transfer, card). Each workspace owner can define custom methods. Used in the Add Income form and filters.

Authentication​

Required: Workspace authentication (Workspace Owner or Staff).

Path Parameters​

ParameterTypeRequiredDescription
workspaceIdstringYesWorkspace identifier

Response 200 OK​

[
  {
    "id": "507f1f77bcf86cd799439014",
    "workspaceId": "507f1f77bcf86cd799439012",
    "name": "cash",
    "labelAr": "نقد",
    "order": 0,
    "createdAt": "2025-01-01T00:00:00.000Z",
    "updatedAt": "2025-01-01T00:00:00.000Z"
  }
]

Common Errors​

401 Unauthorized: Missing or invalid token
404 Not Found: Workspace not found