PosPaymentConsumer

POS-Payment-Consumer verwalten

put

Path parameters

idinteger · int64Required

ID des Payment-Consumers

Body

application/json

stringOptional

Responses

200

OK

No content

put

/erp/pos/payment/consumer/{id}/rule-value

HTTPcURLJavaScriptPython

PUT /api/erp/pos/payment/consumer/{id}/rule-value HTTP/1.1
Host: 10.102.25.208:32788
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"

200

OK

No content

put

Path parameters

idinteger · int64Required

ID des Payment-Consumers

Responses

200

OK

No content

put

/erp/pos/payment/consumer/{id}/request-refresh

HTTPcURLJavaScriptPython

PUT /api/erp/pos/payment/consumer/{id}/request-refresh HTTP/1.1
Host: 10.102.25.208:32788
Accept: */*

200

OK

No content

put

Path parameters

idinteger · int64Required

ID des Payment-Consumers

Responses

200

OK

No content

put

/erp/pos/payment/consumer/{id}/heart-beat

HTTPcURLJavaScriptPython

PUT /api/erp/pos/payment/consumer/{id}/heart-beat HTTP/1.1
Host: 10.102.25.208:32788
Accept: */*

200

OK

No content

deaktiviert eine bestehende Resource

put

Path parameters

idinteger · int64Required

identifier

Responses

200

successful operation

application/json

POS-Payment-Consumer

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

labelstring · max: 255Required

Bezeichnung

descriptionstring · max: 1000Optional

Beschreibung

pushModestring · enumRequired

Push-Modus für POS-Payment-Consumer

Possible values:

activebooleanRead-onlyOptional

Aktiv?

Default: true

ruleValueanyOptional

Search-Dialog

lastSeenAtstring · date-timeRead-onlyOptional

Zeitpunkt des letzten Heartbeats

404

Resource was not found

application/json

422

Resource was not valid to process

application/json

put

/erp/pos/payment/consumer/{id}/deactivate

HTTPcURLJavaScriptPython

PUT /api/erp/pos/payment/consumer/{id}/deactivate HTTP/1.1
Host: 10.102.25.208:32788
Accept: */*

{
  "version": "text",
  "info": {
    "createdAt": "2026-05-15T04:02:22.696Z",
    "createdFrom": "text",
    "updatedAt": "2026-05-15T04:02:22.696Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "label": "text",
  "description": "text",
  "pushMode": "NONE",
  "active": true,
  "ruleValue": null,
  "lastSeenAt": "2026-05-15T04:02:22.696Z"
}

aktiviert eine bestehende Resource

put

Path parameters

idinteger · int64Required

identifier

Responses

200

successful operation

application/json

POS-Payment-Consumer

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

labelstring · max: 255Required

Bezeichnung

descriptionstring · max: 1000Optional

Beschreibung

pushModestring · enumRequired

Push-Modus für POS-Payment-Consumer

Possible values:

activebooleanRead-onlyOptional

Aktiv?

Default: true

ruleValueanyOptional

Search-Dialog

lastSeenAtstring · date-timeRead-onlyOptional

Zeitpunkt des letzten Heartbeats

404

Resource was not found

application/json

422

Resource was not valid to process

application/json

put

/erp/pos/payment/consumer/{id}/activate

HTTPcURLJavaScriptPython

PUT /api/erp/pos/payment/consumer/{id}/activate HTTP/1.1
Host: 10.102.25.208:32788
Accept: */*

{
  "version": "text",
  "info": {
    "createdAt": "2026-05-15T04:02:22.696Z",
    "createdFrom": "text",
    "updatedAt": "2026-05-15T04:02:22.696Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "label": "text",
  "description": "text",
  "pushMode": "NONE",
  "active": true,
  "ruleValue": null,
  "lastSeenAt": "2026-05-15T04:02:22.696Z"
}

Find an existing Resource by identifier

get

Path parameters

idinteger · int64Required

an identifier

Responses

200

successful operation

application/json

POS-Payment-Consumer

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

labelstring · max: 255Required

Bezeichnung

descriptionstring · max: 1000Optional

Beschreibung

pushModestring · enumRequired

Push-Modus für POS-Payment-Consumer

Possible values:

activebooleanRead-onlyOptional

Aktiv?

Default: true

ruleValueanyOptional

Search-Dialog

lastSeenAtstring · date-timeRead-onlyOptional

Zeitpunkt des letzten Heartbeats

404

Resource with given ID was not found

application/json

get

/erp/pos/payment/consumer/{id}

HTTPcURLJavaScriptPython

GET /api/erp/pos/payment/consumer/{id} HTTP/1.1
Host: 10.102.25.208:32788
Accept: */*

{
  "version": "text",
  "info": {
    "createdAt": "2026-05-15T04:02:22.696Z",
    "createdFrom": "text",
    "updatedAt": "2026-05-15T04:02:22.696Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "label": "text",
  "description": "text",
  "pushMode": "NONE",
  "active": true,
  "ruleValue": null,
  "lastSeenAt": "2026-05-15T04:02:22.696Z"
}

Update existing Resource

put

Path parameters

idinteger · int64Required

an identifier

Body

application/json

POS-Payment-Consumer

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

labelstring · max: 255Required

Bezeichnung

descriptionstring · max: 1000Optional

Beschreibung

pushModestring · enumRequired

Push-Modus für POS-Payment-Consumer

Possible values:

activebooleanRead-onlyOptional

Aktiv?

Default: true

ruleValueanyOptional

Search-Dialog

lastSeenAtstring · date-timeRead-onlyOptional

Zeitpunkt des letzten Heartbeats

Responses

200

successful operation

application/json

POS-Payment-Consumer

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

labelstring · max: 255Required

Bezeichnung

descriptionstring · max: 1000Optional

Beschreibung

pushModestring · enumRequired

Push-Modus für POS-Payment-Consumer

Possible values:

activebooleanRead-onlyOptional

Aktiv?

Default: true

ruleValueanyOptional

Search-Dialog

lastSeenAtstring · date-timeRead-onlyOptional

Zeitpunkt des letzten Heartbeats

404

Resource was not found

application/json

422

Resource was not valid to process

application/json

put

/erp/pos/payment/consumer/{id}

HTTPcURLJavaScriptPython

PUT /api/erp/pos/payment/consumer/{id} HTTP/1.1
Host: 10.102.25.208:32788
Content-Type: application/json
Accept: */*
Content-Length: 111

{
  "version": "text",
  "info": {},
  "id": "text",
  "label": "text",
  "description": "text",
  "pushMode": "NONE",
  "ruleValue": null
}

{
  "version": "text",
  "info": {
    "createdAt": "2026-05-15T04:02:22.696Z",
    "createdFrom": "text",
    "updatedAt": "2026-05-15T04:02:22.696Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "label": "text",
  "description": "text",
  "pushMode": "NONE",
  "active": true,
  "ruleValue": null,
  "lastSeenAt": "2026-05-15T04:02:22.696Z"
}

Delete an existing Resource

delete

Path parameters

idinteger · int64Required

an identifier

Responses

200

successful operation

application/json

contextstringOptional

message context

messageValuestringOptional

message

404

Resource was not found

application/json

409

unable to delete Resource, due to constraints, existing references or internal state

application/json

delete

/erp/pos/payment/consumer/{id}

HTTPcURLJavaScriptPython

DELETE /api/erp/pos/payment/consumer/{id} HTTP/1.1
Host: 10.102.25.208:32788
Accept: */*

{
  "context": "text",
  "messageValue": "text"
}

post

Path parameters

idinteger · int64Required

ID des Payment-Consumers

Responses

200

OK

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

amountnumberRequired

Betrag der Zahlung

currencystringOptional

Währung (ISO Alpha-3)

externalPaymentIdstring · max: 255Optional

Externe Payment-ID vom Backend

externalPaymentStatusstring · enumOptional

Status der externen Zahlung

Possible values:

externalPaymentErrorMessagestring · max: 1000Optional

Fehlermeldung vom Payment-Backend

paymentOperationstring · enumOptional

Art der Zahlungsoperation

Possible values:

cancelledExternalPaymentIdstring · max: 255Optional

Externe Payment-ID der zu stornierenden Zahlung

ruleResultanyOptional

Search-Dialog

post

/erp/pos/payment/consumer/{id}/request-next

HTTPcURLJavaScriptPython

POST /api/erp/pos/payment/consumer/{id}/request-next HTTP/1.1
Host: 10.102.25.208:32788
Accept: */*

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-05-15T04:02:22.696Z",
    "createdFrom": "text",
    "updatedAt": "2026-05-15T04:02:22.696Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "documentLineRef": {
    "id": 1,
    "documentId": 1,
    "category": "CUSTOMER_OFFER",
    "documentType": "text",
    "documentState": "text",
    "number": "text",
    "articleNumber": "text",
    "position": 1,
    "name": "text",
    "quantity": 1,
    "price": 1,
    "displayName": "text"
  },
  "amount": 1,
  "currency": "text",
  "paymentMethodRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "paymentBackendRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "externalPaymentId": "text",
  "externalPaymentStatus": "PENDING",
  "externalPaymentErrorMessage": "text",
  "paymentOperation": "PAYMENT",
  "cancelledExternalPaymentId": "text",
  "posRegisterRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "salesChannelRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "paymentConsumerRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "ruleResult": null
}

Create new Resource

post

Body

application/json

POS-Payment-Consumer

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

labelstring · max: 255Required

Bezeichnung

descriptionstring · max: 1000Optional

Beschreibung

pushModestring · enumRequired

Push-Modus für POS-Payment-Consumer

Possible values:

activebooleanRead-onlyOptional

Aktiv?

Default: true

ruleValueanyOptional

Search-Dialog

lastSeenAtstring · date-timeRead-onlyOptional

Zeitpunkt des letzten Heartbeats

Responses

200

successful operation

application/json

POS-Payment-Consumer

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

labelstring · max: 255Required

Bezeichnung

descriptionstring · max: 1000Optional

Beschreibung

pushModestring · enumRequired

Push-Modus für POS-Payment-Consumer

Possible values:

activebooleanRead-onlyOptional

Aktiv?

Default: true

ruleValueanyOptional

Search-Dialog

lastSeenAtstring · date-timeRead-onlyOptional

Zeitpunkt des letzten Heartbeats

422

Resource was not valid to process

application/json

post

/erp/pos/payment/consumer

HTTPcURLJavaScriptPython

POST /api/erp/pos/payment/consumer HTTP/1.1
Host: 10.102.25.208:32788
Content-Type: application/json
Accept: */*
Content-Length: 111

{
  "version": "text",
  "info": {},
  "id": "text",
  "label": "text",
  "description": "text",
  "pushMode": "NONE",
  "ruleValue": null
}

{
  "version": "text",
  "info": {
    "createdAt": "2026-05-15T04:02:22.696Z",
    "createdFrom": "text",
    "updatedAt": "2026-05-15T04:02:22.696Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "label": "text",
  "description": "text",
  "pushMode": "NONE",
  "active": true,
  "ruleValue": null,
  "lastSeenAt": "2026-05-15T04:02:22.696Z"
}