DELETE: Zahlungswunsch zurückziehen · POS API · Legacy

API-ReferenzPOS API · LegacyMobile Payment

DELETE: Zahlungswunsch zurückziehen

POS API · Legacy Mobile Payment

Laut Confluence obsolet und ohne Verwendung.

DELETE/payments/{pid_pz}

Ein Payment ist ein Zahlungswunsch und besteht aus folgenden Angaben:

Name	Typ	Bedeutung
payment_terminal_id	string	Sind in einer Filiale mehrere Plätze installiert, die mit dem selben QnipsPOSIdentifier arbeiten und über die eine Zahlung veranlasst werden kann (z.B. in einem Client-Server-Verbund), so muss für einen Zahlungswunsch ein Identifier des genauen Platzes angegeben werden, der den Zahlungswunsch angelegt hat. Dadurch kann sichergestellt werden, dass jede Zustandsmeldung zum Zahlungswunsch genau dem Platz zugeordnet werden kann, an dem der Zahlungswunsch erzeugt wurde
currency	string	Währungskennung laut ISO 4217-Spezifikation (z.B. "EUR")
total_value	decimal	Gesamtbetrag, der vom menio-Nutzer einzuziehen ist inkl. eventueller Trinkgelder und aller Steuer
included_vat	decimal	Mehrwertsteuer-Anteil im Gesamtbetrag
included_tip	decimal, optional	Eventuell in der Kasse eingegebenes Trinkgeldanteil im Gesamtbetrag
qtid	string	Der Identifier der Transaktion auf welche sich dieser Zahlungswunsch bezieht
allowed_payment_providers	string, optional	Die menio App listet in der Bezahlansicht standardmäßig alle in der aktuellen Filiale eingerichteten Zahlungswege auf. Möchte die Kasse bei bestimmten Nutzern bestimmte Zahlungswege sperren, so isthier eine kommaseparierte Liste der IDs der Zahlungsproviders anzugeben, die für diesen einen Zahlungswunsch erlaubt sein sollen

Folgende Aktionen stehen für diese Resource zur Verfügung:

• Ein Zahlungswunsch kann ausschließlich dann zurückgezogen werden, wenn sein Zustand im menio System den Wert 'Submitted' hat.

• Wenn Sie mit dem menio-Websocket als Rückkanal arbeiten, über welchen die Kasse jede Zustandsänderung nahezu in Echtzeit mitbekommt, empfiehlt es sich, vor dem Zurückziehen des Zahlungswunsches, seinen Zustand aus dem lokalen Datenbestand abzufragen und die Zurückziehung nur dann zu veranlassen, wenn der State = Submitted ist

• Wenn Sie die Zustände der Zahlungswünsche über einen Polling-Mechanismus abfragen, empfiehlt es sich vor dem Zurückziehen des Zahlungswunsches zunächst seinen aktuellen Zustand einzuholen und nur wenn auch dann der Zustand = Submitted ist, einen Rückzug des Zahlungswunsches zu veranlassen.

Parameter

pid_pzstringErforderlich

ein String, der aus dem PID und seiner Prüfsumme besteht (siehe dazu das Kapitel Prüfsummenberechnung.

Kontext: Mobile Payment

Nachfolgend sind alle relevanten Resourcen rund um das Thema 'Mobile Payment mit menio' zusammengetragen

Originaler Blueprint-Ausschnitt

API BlueprintKopieren

### DELETE: Zahlungswunsch zurückziehen [DELETE]
* Ein Zahlungswunsch kann ausschließlich dann zurückgezogen werden, wenn sein Zustand im Qnips System den Wert 'Submitted' hat.
* Wenn Sie mit dem Qnips-Websocket als Rückkanal arbeiten, über welchen die Kasse jede Zustandsänderung nahezu in Echtzeit mitbekommt, empfiehlt es sich, vor dem Zurückziehen des Zahlungswunsches, seinen Zustand aus dem lokalen Datenbestand abzufragen und die Zurückziehung nur dann zu veranlassen, wenn der State = Submitted ist
* Wenn Sie die Zustände der Zahlungswünsche über einen Polling-Mechanismus abfragen, empfiehlt es sich vor dem Zurückziehen des Zahlungswunsches zunächst seinen aktuellen Zustand einzuholen und nur wenn auch dann der Zustand = Submitted ist, einen Rückzug des Zahlungswunsches zu veranlassen.

+ Parameters
    + pid_pz (string) ... ein String, der aus dem PID und seiner Prüfsumme besteht (siehe dazu das Kapitel [Prüfsummenberechnung](#checksum).

+ Response 200

        // In diesem Fall ist der Zahlungswunsch korrekt zurückgezogen. 
        // Die damit verlinkte PID verliert ihre Funktion als Trigger der Bezahlfunktion 
        // in der Qnips-App. Der Responsebody bleibt leer.

+ Response 412

        // HTTP-Error 412 = PreconditionFailed
        {
            "reason_id":2,
            "reason_text":"further error details as text"
        }
        
        // Hier die möglichen Gründe:
        // 1 | Prüfsumme ist falsch
        // 2 | PID nicht gefunden
        // 3 | externer Zahlungsdienstleister wurde mit der Zahlung beauftragt
        // 4 | Geldtransfer hat schon stattgefunden
        // 99 | Sonstiges (in diesem Fall wird das Feld reason_text genauere Angaben enthalten. 

Request

cURLKopieren

curl --request DELETE \
  'http://pos.dev.qnips.com/api/payments/{pid_pz}'

Dokumentationsbeispiel. Platzhalter vor der Verwendung ersetzen.

Response

200412

Response 200Kopieren

// In diesem Fall ist der Zahlungswunsch korrekt zurückgezogen. 
// Die damit verlinkte PID verliert ihre Funktion als Trigger der Bezahlfunktion 
// in der Qnips-App. Der Responsebody bleibt leer.

Response 412Kopieren

// HTTP-Error 412 = PreconditionFailed
{
    "reason_id":2,
    "reason_text":"further error details as text"
}

// Hier die möglichen Gründe:
// 1 | Prüfsumme ist falsch
// 2 | PID nicht gefunden
// 3 | externer Zahlungsdienstleister wurde mit der Zahlung beauftragt
// 4 | Geldtransfer hat schon stattgefunden
// 99 | Sonstiges (in diesem Fall wird das Feld reason_text genauere Angaben enthalten.