POST: Rückerstattung starten · POS API · Legacy

POST: Rückerstattung starten

POS API · Legacy Mobile Payment

Laut Confluence obsolet und ohne Verwendung.

POST/refunds/{pid_pz}?descr={descr}

Ein Refund ist eine Rückerstattungsanfrage für eine über das menio System getätigte mobile Zahlung. Ein Refund ist nur bei bestimmten Zahlungsdienstleistern möglich. Ob eine Rückerstattung für eine erfolgte mobile Zahlung möglich ist, steht in der Zahlungsbestätigung zur jeweiligen Zahlung im Feld "IsRefundable". Speichern Sie daher bitte bei jeder ankommenden Zahlungsbestätigung diese Information und bieten Sie die Rückerstattung auf dem User Interface nur für solche Zahlungen, bei welchen IsRefundable = true ist.

Bei einem Refund wird das Geld vom Empfängerkonto wieder abgebucht und auf das Konto des ursprünglichen Zahlers überwiesen.

Eine Refundanfrage ist immer synchron zu verarbeiten (d.h. die Kasse muss den Response abwarten), um ggf. einen entsprechenden Beleg im Erfolgsfall erzeugen zu können.

Parameter

pid_pzstringErforderlich

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

descrstring

optionaler Hinweis, z.B. Grund für die Erstattungsanfrage

Request-Header

Accept

application/json oder application/xml

DevKey

{Ihr DeveloperKey}

SubmitterId

{transactionSubmitterId} welchen die Kasse bei der Aktivierung zugewiesen bekommen hat

Kontext: Mobile Payment

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

Originaler Blueprint-Ausschnitt

API Blueprint

### POST: Rückerstattung starten [POST]

+ Parameters
    + pid_pz (string, required) ... ein String, der aus dem PID und seiner Prüfsumme besteht (siehe dazu das Kapitel [Prüfsummenberechnung](#checksum).
    + descr (string, optional) ... optionaler Hinweis, z.B. Grund für die Erstattungsanfrage

+ Request
    
    + Headers
    
            Accept: application/json oder application/xml
            DevKey: {Ihr DeveloperKey}
            SubmitterId: {transactionSubmitterId} welchen die Kasse bei der Aktivierung zugewiesen bekommen hat


+ Response 200

        // Alles OK. Beleg über Rückerstattung kann gedruckt werden.

+ 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 des PIDs falsch
        // 2 | PID nicht gefunden
        // 3 | Wurde schon zurückerstattet
        // 4 | Zahlung noch nicht erfolgt
        // 99 | Sonstiges (in diesem Fall wird das Feld reason_text genauere Angaben enthalten.

Request

cURL

curl --request POST \
  'http://pos.dev.qnips.com/api/refunds/{pid_pz}?descr={descr}' \
  --header 'Accept: application/json oder application/xml' \
  --header 'DevKey: {YOUR_DEV_KEY}' \
  --header 'SubmitterId: {transactionSubmitterId} welchen die Kasse bei der Aktivierung zugewiesen bekommen hat'

Dokumentationsbeispiel. Platzhalter vor der Verwendung ersetzen.

Response

Response 200

// Alles OK. Beleg über Rückerstattung kann gedruckt werden.

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 des PIDs falsch
// 2 | PID nicht gefunden
// 3 | Wurde schon zurückerstattet
// 4 | Zahlung noch nicht erfolgt
// 99 | Sonstiges (in diesem Fall wird das Feld reason_text genauere Angaben enthalten.