PosPayment

POS-Zahlungen verwalten

Zahlungsstatus aktualisieren

put

Path parameters

externalPaymentIdstringRequired

Query parameters

statusstring · enumRequiredPossible values:

errorMessagestringOptional

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

put

/erp/pos/payment/orders/{externalPaymentId}/status

HTTPcURLJavaScriptPython

PUT /api/erp/pos/payment/orders/{externalPaymentId}/status?status=PENDING HTTP/1.1
Host: 10.102.25.208:32788
Accept: */*

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-05-14T17:03:31.794Z",
    "createdFrom": "text",
    "updatedAt": "2026-05-14T17:03:31.794Z",
    "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
}

Zahlung anhand der externen Payment-ID abrufen

get

Path parameters

externalPaymentIdstringRequired

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

get

/erp/pos/payment/orders/{externalPaymentId}

HTTPcURLJavaScriptPython

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

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-05-14T17:03:31.794Z",
    "createdFrom": "text",
    "updatedAt": "2026-05-14T17:03:31.794Z",
    "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
}