Payment method

INFO

Every response arrives in the shared envelope — code, message, messages, status_code, time — with the payload in data. The tables below describe what is inside data.

POST /payment-method/create

This method allows adding payment-method into the account.

Request body

Field	Type	Required	Description
name	string	Yes
shortcut	string	No	Keyboard shortcut on the POS, F1–F12.
type	string	No	Only cashless can be created. Every account has exactly one cash method, created by the system; sending cash returns a validation error.. One of: cashless. Default: "cashless"
subtype	string	No	Finer classification of a cashless method: terminal, online, bank or bnpl. cash takes no subtype. Omit or send null to leave the method unclassified.. One of: terminal, online, bank, bnpl

{
  "name": "string",
  "shortcut": "F8",
  "type": "cashless",
  "subtype": "terminal"
}

Response

Field	Type	Description
_id	string
name	string
shortcut	string
type	string	cash (exactly one per account, created by the system) or cashless. Earlier versions of the API also returned card, terminal, transfer, gift, integration — these are now cashless, described by subtype and is_integration.. One of: cash, cashless
subtype	string	Classification of a cashless method. null when the method is cash or has not been classified yet.. One of: terminal, online, bank, bnpl
is_integration	boolean	The method was created by a payment integration (Payme, Click, …) rather than by a person. Replaces the old integration type.. Default: false
is_enabled	boolean	Default: true
is_default	boolean	Default: false
is_visible	boolean	Default: false
created_at	string (date-time)
updated_at	string (date-time)

{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": {
    "_id": "string",
    "name": "string",
    "shortcut": "string",
    "type": "cash",
    "subtype": "terminal",
    "is_integration": false,
    "is_enabled": true,
    "is_default": false,
    "is_visible": false,
    "created_at": "2025-05-01T12:00:00Z",
    "updated_at": "2025-05-01T12:00:00Z"
  },
  "time": "2025-05-01T12:00:00Z"
}

PUT /payment-method/update

This method allows updating payment-method in the account.

Request body

Field	Type	Required	Description
name	string	Yes
shortcut	string	No	Keyboard shortcut on the POS, F1–F12.
type	string	No	Optional; omit it to keep the current type. A method cannot be changed to or from cash: a type that would do so is ignored and the rest of the update is applied.. One of: cash, cashless
subtype	string	No	Finer classification of a cashless method: terminal, online, bank or bnpl. cash takes no subtype. Omit or send null to leave the method unclassified.. One of: terminal, online, bank, bnpl
_id	string	Yes

{
  "name": "string",
  "shortcut": "F8",
  "type": "cash",
  "subtype": "terminal",
  "_id": "67b486d242ed76693cd2cc59"
}

Response

Same response shape as POST /payment-method/create.

DELETE /payment-method/delete/{id}

Delete a payment-method

Path parameters

Parameter	Type	Required	Description
id	string	Yes

Request body

No request body.

Response

{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": "ok",
  "time": "2025-05-01T12:00:00Z"
}

GET /payment-method/get-all

Get all payment-methods

Query parameters

Parameter	Type	Required	Description
is_enabled	boolean	No	Filter payment-methods by enabled status

Request body

No request body.

Response

{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": [
    {
      "_id": "string",
      "name": "string",
      "shortcut": "string",
      "type": "cash",
      "subtype": "terminal",
      "is_integration": false,
      "is_enabled": true,
      "is_default": false,
      "is_visible": false,
      "created_at": "2025-05-01T12:00:00Z",
      "updated_at": "2025-05-01T12:00:00Z"
    }
  ],
  "time": "2025-05-01T12:00:00Z"
}

GET /payment-method/get-by-id/{id}

Get payment-method using its _id

Path parameters

Parameter	Type	Required	Description
id	string	Yes

Request body

No request body.

Response

Same response shape as POST /payment-method/create.

GET /payment-method/get-deleted

Get deleted payment-method ids

Query parameters

Parameter	Type	Required	Description
deleted_at	string	Yes

Request body

No request body.

Response

{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": [
    "string"
  ],
  "time": "2025-05-01T12:00:00Z"
}

PUT /payment-method/set-active

This method allows setActive payment-method in the account.

Request body

Field	Type	Required	Description
is_enabled	boolean	Yes	Default: true
_id	string	Yes

{
  "is_enabled": true,
  "_id": "67b486d242ed76693cd2cc59"
}

Response

Same response shape as POST /payment-method/create.

---

This page is generated from the OpenAPI spec.