Method: getDisputeInquiryReport

Sie können einen Bericht abrufen, der Informationen enthält, die ein Kundensupportgespräch mit einem Nutzer bezüglich einer möglichen Anfechtung einer Zahlung erleichtern.

Die Antworten auf diese Abfrage können leer sein, wenn diese Methode keinen HTTP 200-Fehler zurückgibt.

Wenn am Endpunkt bei der Verarbeitung der Anfrage ein Fehler auftritt, hat dieser Endpunkt eine Antwort vom Typ ErrorResponse.

Die Antworten auf diese Abfrage können leer sein, wenn diese Methode keinen HTTP 200-Fehler zurückgibt. Der Antworttext ist leer, wenn ein ErrorResponse mit einer eindeutigen Beschreibung verwendet werden könnte, um einem Angreifer zu helfen, die Konto-ID des Zahlungsintegrators anderer Integratoren zu verstehen. In Fällen, in denen der Signaturschlüssel nicht übereinstimmt, die Zahlungsintegrator-ID nicht gefunden oder der Verschlüsselungsschlüssel unbekannt war, gibt diese Methode einen HTTP 404-Fehler mit leerem Text zurück. Wenn die Anfragesignatur verifiziert werden konnte, werden im Antworttext zusätzliche Informationen zum Fehler zurückgegeben.

Eine Beispielanfrage sieht so aus:


{
  "requestHeader": {
    "protocolVersion": {
      "major": 3
    },
    "requestId": "HsKv5pvtQKTtz7rdcw1YqE",
    "requestTimestamp": {
      "epochMillis": "1519996751331"
    },
    "paymentIntegratorAccountId": "InvisiCashUSA_USD"
  },
  "paymentLookupCriteria": {
    "googleTransactionReferenceNumberCriteria": {
      "googleTransactionReferenceNumber": "714545417102363157911822",
      "authorizationCode": "111111"
    }
  },
  "existingGoogleClaimId": "138431383281",
  "requestOriginator": {
    "organizationId": "ISSUER_256",
    "organizationDescription": "Community Bank of Some City",
    "agentId": "982749"
  }
}

Eine Beispielantwort sieht so aus:


{
  "responseHeader": {
    "responseTimestamp": {
      "epochMillis": "1519996752221"
    }
  },
  "result": {
    "success": {
      "googleClaimId": "138431383281",
      "report": {
        "customerAccount": {
          "customerEmail": "example@gmail.com",
          "customerName" : "Example Customer"
        },
        "order": {
          "timestamp": {
            "epochMillis": "1517992525972"
          },
          "orderId": "SOP.8976-1234-1234-123456..99",
          "subTotalAmount": {
            "amountMicros": "206990000",
            "currencyCode": "USD"
          },
          "totalAmount": {
            "amountMicros": "212990000",
            "currencyCode": "USD"
          },
          "shippingAddress": {
            "addressLine": ["123 Main St"],
            "localityName": "Springfield",
            "administrativeAreaName": "CO",
            "postalCodeNumber": "80309",
            "countryCode": "US"
          },
          "taxes": [
            {
              "description": "Colorado Sales Tax",
              "amount": {
                "amountMicros": "6000000",
                "currencyCode": "USD"
              }
            }
          ],
          "items": [
            {
              "description": "Super cool gizmo",
              "merchant": "HTC",
              "googleProductName": "Google Store",
              "quantity": "2",
              "totalPrice": {
                "amountMicros": "198000000",
                "currencyCode": "USD"
              }
            },
            {
              "description": "Gizmo charger",
              "merchant": "HTC",
              "googleProductName": "Google Store",
              "quantity": "1",
              "totalPrice": {
                "amountMicros": "8990000",
                "currencyCode": "USD"
              }
            }
          ]
        },
        "payment": {
          "billingAddress" : {
            "addressLine": ["123 Main St"],
            "localityName": "Springfield",
            "administrativeAreaName": "CO",
            "postalCodeNumber": "80309",
            "countryCode": "US"
          },
          "amount": {
            "amountMicros": "100000000",
            "currencyCode": "USD"
          },
          "refunds": [
            {
              "amount": {
                "amountMicros": "9250000",
                "currencyCode": "USD"
              },
              "initiatedTimestamp": {
                "epochMillis": "1518811245384"
              }
            }
          ],
          "cardDetails": {
            "authResult": "APPROVED"
          }
        }
      }
    }
  }
}

HTTP-Anfrage

POST https://vgw.googleapis.com/secure-serving/gsp/v3/getDisputeInquiryReport/:PIAID

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung
{
  "requestHeader": {
    object (RequestHeader)
  },
  "paymentLookupCriteria": {
    object (PaymentLookupCriteria)
  },
  "existingGoogleClaimId": string,
  "requestOriginator": {
    object (RequestOriginator)
  }
}
Felder
requestHeader

object (RequestHeader)

ERFORDERLICH: Allgemeiner Header für alle Anfragen.

paymentLookupCriteria

object (PaymentLookupCriteria)

ERFORDERLICH: Kriterien für die Zahlung, die für diese Anfrage zu prüfen ist.

existingGoogleClaimId

string

OPTIONAL: Ein von Google generierter String, der von einem vorherigen Aufruf an getDisputeInquiryReport zurückgegeben wurde und diesen Einspruch des Kunden eindeutig identifiziert.

Ist sie nicht vorhanden, wird eine neue Anspruchs-ID generiert. Der Anrufer kann eine googleClaimId angeben, die bei einem früheren Anruf an getDisputeInquiryReport zurückgegeben wurde, wenn es sich um eine Fortsetzung desselben Kundenstreits handelt.

Die Anspruchs-ID, die hier ausgefüllt oder generiert wurde, wird im Feld googleClaimId der Antwort zurückgegeben.

Ein googleClaimId kann nicht angegeben werden, der bei einem vorherigen Aufruf von getDisputeInquiryReport nicht zurückgegeben wurde. In diesem Fall wird „HTTP 400 Bad Request“ zurückgegeben.

requestOriginator

object (RequestOriginator)

ERFORDERLICH: Informationen zur Organisation oder Untergruppe der Organisation, von der diese Anfrage stammt.

Antworttext

Diese Methode unterstützt mehrere Rückgabetypen. Weitere Informationen dazu, welcher 4XX- oder 5XX-HTTP-Statuscode mit einem ErrorResponse zurückgegeben werden soll, findest du in der Dokumentation zum ErrorResponse-Objekt und in der Dokumentation zu den HTTP-Statuscodes.

Diese Methode unterstützt mehrere Rückgabetypen. Weitere Informationen dazu, welcher 4XX- oder 5XX-HTTP-Statuscode mit einem ErrorResponse zurückgegeben werden soll, findest du in der Dokumentation zum ErrorResponse-Objekt und in der Dokumentation zu den HTTP-Statuscodes.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

Mögliche Antwortnachrichten
HTTP 200-Status

object (GetDisputeInquiryReportResponse)

HTTP 4XX / 5XX-Status

object (ErrorResponse)

RequestHeader

Header-Objekt, das für alle an den Server gesendeten Anfragen definiert wird.

JSON-Darstellung
{
  "requestId": string,
  "requestTimestamp": {
    object (Timestamp)
  },
  "protocolVersion": {
    object (Version)
  },
  "paymentIntegratorAccountId": string
}
Felder
requestId

string

REQUIRED: Die eindeutige ID der Anfrage.

Dies ist ein String mit maximal 100 Zeichen, der nur die Zeichen „a–z“, „A–Z“, „0–9“, ":", „-“ und „_“ enthält.

requestTimestamp

object (Timestamp)

REQUIRED: Zeitstempel dieser Anfrage. Der Empfänger muss überprüfen, ob dieser Zeitstempel ± 60 Sekunden von „jetzt“ ist. Ist dies nicht der Fall, lehnt er die Anfrage ab. Dieser Anfragezeitstempel ist bei Wiederholungen nicht idempotent.

protocolVersion

object (Version)

REQUIRED: Die Version dieser Anfrage.

paymentIntegratorAccountId

string

ERFORDERLICH: Bezeichnet ein eindeutiges Konto mit vertraglichen Einschränkungen.

Zeitstempel

Zeitstempelobjekt, das einen Punkt auf der ISO-Zeitachse in Millisekunden seit der Unix-Epoche darstellt.

JSON-Darstellung
{
  "epochMillis": string
}
Felder
epochMillis

string (Int64Value format)

REQUIRED: Millisekunden seit der Unix-Epoche

Version

Versionsobjekt enthält die Hauptversion der API. Versionen derselben Hauptversion sind garantiert kompatibel. Der Integrator muss alle Anfragen für dieselbe Hauptversion unterstützen.

JSON-Darstellung
{
  "major": integer
}
Felder
major

integer

ERFORDERLICH: Hauptversion. Dies ist für Kompatibilitätsanfragen mit unterschiedlichen Versionen gekennzeichnet, bei denen nicht garantiert wird, dass sie kompatibel sind.

PaymentLookupCriteria

Container für Kriterien, die eine Zahlung eindeutig nachschlagen können. Es muss genau ein Mitgliedsfeld ausgefüllt werden.

JSON-Darstellung
{

  // Union field criteria can be only one of the following:
  "arnCriteria": {
    object (ArnCriteria)
  },
  "googleTransactionReferenceNumberCriteria": {
    object (GoogleTransactionReferenceNumberCriteria)
  },
  "captureRequestCriteria": {
    object (CaptureRequestCriteria)
  }
  // End of list of possible types for union field criteria.
}
Felder

Union-Feld criteria.

Für criteria ist nur einer der folgenden Werte zulässig:

arnCriteria

object (ArnCriteria)

OPTIONAL: Suche basierend auf der Acquirer Reference Number (ARN).

googleTransactionReferenceNumberCriteria

object (GoogleTransactionReferenceNumberCriteria)

OPTIONAL: Suche anhand der Google-Transaktionsreferenznummer.

captureRequestCriteria

object (CaptureRequestCriteria)

OPTIONAL: Ein Lookup basierend auf der ursprünglichen Erfassungsanfrage.

ArnCriteria

Kriterien für die Zahlungssuche basierend auf der Acquirer Reference Number (ARN).

JSON-Darstellung
{
  "acquirerReferenceNumber": string,
  "authorizationCode": string
}
Felder
acquirerReferenceNumber

string

ERFORDERLICH: Die Referenznummer (Aquirer Reference Number, ARN), die die Zahlung eindeutig identifiziert. Muss aus 23 Ziffern bestehen.

authorizationCode

string

ERFORDERLICH: Der Autorisierungscode für die Transaktion.

GoogleTransactionReferenceNumberCriteria

Kriterien für die Zahlungssuche basierend auf der von Google generierten Transaktionsreferenznummer

JSON-Darstellung
{
  "googleTransactionReferenceNumber": string,
  "authorizationCode": string
}
Felder
googleTransactionReferenceNumber

string

ERFORDERLICH: Die von Google generierte Transaktionsreferenznummer, mit der die Zahlung eindeutig identifiziert wird.

authorizationCode

string

ERFORDERLICH: Der Autorisierungscode für die Transaktion.

CaptureRequestCriteria

Kriterien für die Zahlungssuche basierend auf der ursprünglichen Erfassungsanfrage.

JSON-Darstellung
{
  "captureRequestId": string
}
Felder
captureRequestId

string

REQUIRED: Eine eindeutige Kennung für diese Transaktion. Dies ist die requestId, die von Google während des capture-Aufrufs generiert wurde, der nachgeschlagen wird.

RequestOriginator

Informationen zur Organisation oder Untergruppe der Organisation und optional zum Mitarbeiter, von dem diese Anfrage stammt. So kann Google Probleme oder Missbrauch identifizieren und Kontrollen detaillierter als die paymentIntegratorAccountId implementieren. Dies ist besonders nützlich, wenn der Aufruf ein zwischengeschalteter Serviceprovider ist, der Anfragen von mehreren externen Clients bezieht.

JSON-Darstellung
{
  "organizationId": string,
  "organizationDescription": string,
  "agentId": string
}
Felder
organizationId

string

ERFORDERLICH: Eine ID des Unternehmens, der Organisation oder der Organisationsgruppe, von der diese Anfrage stammt. Darf innerhalb dieses paymentIntegratorAccountId nur einmal vorkommen.

organizationDescription

string

ERFORDERLICH: Ein für Menschen lesbarer Name oder eine Beschreibung der Organisation, die zur Vereinfachung der Kommunikation zwischen Mitarbeitern von Google und dem Integrator der Organisation verwendet werden kann.

agentId

string

OPTIONAL: Eine eindeutige Kennung für den spezifischen Agenten (Mitarbeiter) der Organisation, die von organizationId identifiziert wurde, von dem diese Anfrage stammt. Darf innerhalb dieses organizationId nur einmal vorkommen.

GetDisputeInquiryReportResponse

Antwortnutzlast für die Methode getDisputeInquiryReport.

JSON-Darstellung
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "result": {
    object (GetDisputeInquiryReportResult)
  }
}
Felder
responseHeader

object (ResponseHeader)

REQUIRED: Allgemeiner Header für alle Antworten.

result

object (GetDisputeInquiryReportResult)

REQUIRED: Ergebnis dieses Aufrufs.

ResponseHeader

Header-Objekt, das für alle vom Server gesendeten Antworten definiert ist.

JSON-Darstellung
{
  "responseTimestamp": {
    object (Timestamp)
  }
}
Felder
responseTimestamp

object (Timestamp)

REQUIRED: Zeitstempel dieser Antwort. Der Empfänger muss überprüfen, ob dieser Zeitstempel ± 60 Sekunden von „jetzt“ ist. Ist dies nicht der Fall, lehnt er die Antwort ab.

GetDisputeInquiryReportResult

JSON-Darstellung
{

  // Union field result can be only one of the following:
  "success": {
    object (SuccessDetails)
  },
  "paymentNotFound": {
    object (Empty)
  },
  "paymentTooOld": {
    object (Empty)
  },
  "orderCannotBeReturned": {
    object (Empty)
  },
  "noAdditionalDetails": {
    object (Empty)
  }
  // End of list of possible types for union field result.
}
Felder

Union-Feld result.

Für result ist nur einer der folgenden Werte zulässig:

success

object (SuccessDetails)

Die Zahlung wurde gefunden und ein Bericht wird bereitgestellt.

paymentNotFound

object (Empty)

Die angeforderte Zahlung wurde nicht gefunden.

paymentTooOld

object (Empty)

Die angeforderte Zahlung wurde gefunden, aber aufgrund des Alters der Zahlung wurde kein Bericht bereitgestellt.

orderCannotBeReturned

object (Empty)

Die angeforderte Zahlung gehört zu einer bestehenden Bestellung, kann aber nicht zurückgegeben werden. Dies kann beispielsweise der Fall sein, wenn der Auftrag auf Anfrage des Eigentümers entfernt wurde.

noAdditionalDetails

object (Empty)

Die angeforderte Zahlung wurde gefunden, es ist jedoch kein Bericht verfügbar.

SuccessDetails

JSON-Darstellung
{
  "googleClaimId": string,
  "report": {
    object (PurchaseReport)
  }
}
Felder
googleClaimId

string

REQUIRED: Ein von Google generierter String, der diese Kundenanfechtung eindeutig identifiziert.

Wenn existingGoogleClaimId in der Anfrage ausgefüllt war, ist dies derselbe Wert. Andernfalls ist es ein neu generierter Wert. Dieser Wert kann in zukünftigen getDisputeInquiryReport-Anfragen angegeben werden, wenn sie Teil derselben Kundenanfechtung sind.

report

object (PurchaseReport)

ERFORDERLICH: Details, die für die Anfechtung der in der Anfrage angegebenen Zahlung relevant sind.

PurchaseReport

Einen Bericht mit relevanten Details zum Kauf, der mit der angeforderten Zahlung verknüpft ist

JSON-Darstellung
{
  "customerAccount": {
    object (CustomerAccount)
  },
  "order": {
    object (Order)
  },
  "payment": {
    object (Payment)
  }
}
Felder
customerAccount

object (CustomerAccount)

ERFORDERLICH: Informationen zum Kunden und zu seinem Konto.

order

object (Order)

OPTIONAL: Informationen zur Bestellung, in der die Zahlung ausgeführt wurde. Nicht für alle Kaufberichte verfügbar.

payment

object (Payment)

ERFORDERLICH: Informationen zur Zahlung Hinweis: Für eine einzelne Bestellung sind mehrere Zahlungen möglich. Diese enthalten jedoch nur Informationen zu der Zahlung, die in der ursprünglichen Anforderung angegeben wurde.

CustomerAccount

Informationen zum Konto des Kunden.

JSON-Darstellung
{
  "customerEmail": string,
  "customerName": string
}
Felder
customerEmail

string

OPTIONAL: E-Mail-Adresse, die mit dem Google-Konto des Kunden verknüpft ist

customerName

string

ERFORDERLICH: Name des Kunden

Bestellung

Informationen zur Bestellung.

JSON-Darstellung
{
  "timestamp": {
    object (Timestamp)
  },
  "orderId": string,
  "subTotalAmount": {
    object (Amount)
  },
  "totalAmount": {
    object (Amount)
  },
  "shippingAddress": {
    object (Address)
  },
  "items": [
    {
      object (Item)
    }
  ],
  "taxes": [
    {
      object (Tax)
    }
  ]
}
Felder
timestamp

object (Timestamp)

ERFORDERLICH: Zeitstempel der Bestellung.

orderId

string

REQUIRED: Ein String, der diese Bestellung eindeutig identifiziert.

subTotalAmount

object (Amount)

ERFORDERLICH: Gesamtbetrag der Bestellung vor Steuern.

totalAmount

object (Amount)

ERFORDERLICH: Gesamtbetrag dieser Bestellung einschließlich Steuern.

shippingAddress

object (Address)

OPTIONAL: Versandadresse für die physischen Artikel in dieser Bestellung.

items[]

object (Item)

REQUIRED: Liste der Artikel, die zu dieser Bestellung gehören.

taxes[]

object (Tax)

REQUIRED: Liste der Steuern, die Teil dieser Bestellung waren. Diese Liste ist möglicherweise leer.

Menge

Ordnet einen Betrag in Mikroeinheiten einem Währungscode zu.

JSON-Darstellung
{
  "amountMicros": string,
  "currencyCode": string
}
Felder
amountMicros

string (Int64Value format)

ERFORDERLICH: Ein Betrag in micros.

currencyCode

string

ERFORDERLICH: Dreistelliger Währungscode gemäß ISO 4217

Adresse

Gebäude mit Informationen zu einer physischen Adresse.

JSON-Darstellung
{
  "addressLine": [
    string
  ],
  "localityName": string,
  "administrativeAreaName": string,
  "postalCodeNumber": string,
  "countryCode": string
}
Felder
addressLine[]

string

OPTIONAL: Enthält unstrukturierten Adresstext.

localityName

string

OPTIONAL: Dieser Begriff ist nicht ganz einfach, bezieht sich aber im Allgemeinen auf den Ort einer Adresse. Lassen Sie in Regionen der Welt, in denen Ortschaften nicht hinreichend definiert sind oder sich dieser Struktur nicht zuordnet (z. B. Japan und China), leer lassen und stattdessen addressLine verwenden.

Beispiele: Stadt in den USA, italienische Gemeinde, Post Town in Großbritannien.

administrativeAreaName

string

OPTIONAL: Oberste Verwaltungseinheit dieses Landes. Beispiele: US-Bundesstaat, IT-Region, CN-Provinz, JP-Präfektur.

postalCodeNumber

string

OPTIONAL: Trotz des Namens sind postalCodeNumber-Werte häufig alphanumerisch. Beispiele: „94043“, „SW1W“, „SW1W 9TQ“.

countryCode

string

OPTIONAL: Ländercode für die Kundenadresse gemäß ISO-3166-1 Alpha-2

Element

Informationen zu einem Artikel in der Bestellung.

JSON-Darstellung
{
  "description": string,
  "merchant": string,
  "quantity": string,
  "totalPrice": {
    object (Amount)
  },
  "googleProductName": string
}
Felder
description

string

ERFORDERLICH: Eine Beschreibung des gekauften Artikels.

merchant

string

ERFORDERLICH: Verkäufer, Künstler oder Hersteller des Artikels.

quantity

string (Int64Value format)

OPTIONAL: Bestellmenge dieses Artikels.

Dieses Feld wird weggelassen, wenn für das Produkt keine ganzzahligen Mengen gelten (gezählte Produkte können z. B. Bruchmengen enthalten).

totalPrice

object (Amount)

REQUIRED: der Gesamtpreis dieses Artikels.

googleProductName

string

ERFORDERLICH: Name des Google-Produktdienstes für den Artikel.

Steuer

Informationen zu Steuern, die für diese Bestellung gelten.

JSON-Darstellung
{
  "description": string,
  "amount": {
    object (Amount)
  }
}
Felder
description

string

ERFORDERLICH: Eine Beschreibung der Steuer.

amount

object (Amount)

ERFORDERLICH: Der Steuerbetrag.

Zahlung

Informationen zur Zahlung.

JSON-Darstellung
{
  "billingAddress": {
    object (Address)
  },
  "amount": {
    object (Amount)
  },
  "refunds": [
    {
      object (Refund)
    }
  ],

  // Union field fopDetails can be only one of the following:
  "cardDetails": {
    object (PaymentCardDetails)
  }
  // End of list of possible types for union field fopDetails.
}
Felder
billingAddress

object (Address)

ERFORDERLICH: Rechnungsadresse für diese Zahlung.

amount

object (Amount)

ERFORDERLICH: Zahlungsbetrag

refunds[]

object (Refund)

ERFORDERLICH: Liste der Erstattungen für diese Zahlung. Diese Liste ist möglicherweise leer.

Union-Feld fopDetails.

Für fopDetails ist nur einer der folgenden Werte zulässig:

cardDetails

object (PaymentCardDetails)

OPTIONAL: Spezielle Zahlungsdetails für Kredit- und Debitkarten

Erstattung

Informationen zu einer Erstattung, die bei einer Zahlung erfolgt ist.

JSON-Darstellung
{
  "amount": {
    object (Amount)
  },
  "initiatedTimestamp": {
    object (Timestamp)
  }
}
Felder
amount

object (Amount)

ERFORDERLICH: Der erstattete Betrag.

initiatedTimestamp

object (Timestamp)

ERFORDERLICH: Zeitstempel, der angibt, wann die Erstattung veranlasst wurde.

PaymentCardDetails

Zahlungsdetails speziell für Kredit- und Debitkarten

JSON-Darstellung
{
  "authResult": enum (AuthResult)
}
Felder
authResult

enum (AuthResult)

ERFORDERLICH: Ergebnis der Zahlungsautorisierung.

AuthResult

Ergebnisse der Zahlungsautorisierung.

Enums
UNKNOWN_RESULT Legen Sie diesen Standardwert niemals fest.
APPROVED Authentifizierung genehmigt.
DENIED Authentifizierung abgelehnt.
NOT_ATTEMPTED Auth nicht versucht.

Leer

Dieser Typ hat keine Felder.

Dieses Objekt wird für die Erweiterbarkeit verwendet, da boolesche Werte und Aufzählungen häufig mit zusätzlichen Daten erweitert werden müssen. Der Implementierer ermittelt damit die Anwesenheit. Die hier dargestellte Aufzählung kann auf Daten in zukünftigen Versionen erweitert werden.

Die JSON-Darstellung für Empty ist ein leeres JSON-Objekt {}.

ErrorResponse

Fehlerantwortobjekt für alle Methoden.

JSON-Darstellung
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "errorDescription": string,
  "paymentIntegratorErrorIdentifier": string,
  "errorResponseResult": {
    object (ErrorResponseResult)
  }
}
Felder
responseHeader

object (ResponseHeader)

REQUIRED: Allgemeiner Header für alle Antworten.

errorDescription

string

OPTIONAL: Beschreiben Sie diesen Status, damit Mitarbeiter des Supportteams Fehler beheben können. Dieser wird Nutzern nie angezeigt. Er kann beschreibenden, nicht vertraulichen Text zur Fehlerbehebung enthalten. Beachte, dass bei einigen Werten für errorResponseCode zusätzliche Details in diesem Feld angegeben werden sollten. Warnung: Fügen Sie dieser Nachricht keine Tokens hinzu, es sei denn, diese sind als öffentlich definiert.

paymentIntegratorErrorIdentifier

string

OPTIONAL: Diese Kennung ist spezifisch für den Integrator und wird vom Integrator generiert. Sie wird nur zum Zweck der Fehlerbehebung verwendet, um diesen Aufruf zu identifizieren. Dies ist die Kennung, anhand derer der Integrator diesen Aufruf kennt.

errorResponseResult

object (ErrorResponseResult)

OPTIONAL: Ein Code, mit dem die Art des Fehlers erfasst wird.

ErrorResponseResult

Fehlercodes

JSON-Darstellung
{

  // Union field result can be only one of the following:
  "invalidApiVersion": {
    object (InvalidApiVersion)
  },
  "invalidPayloadSignature": {
    object (InvalidPayloadSignature)
  },
  "invalidPayloadEncryption": {
    object (InvalidPayloadEncryption)
  },
  "requestTimestampOutOfRange": {
    object (RequestTimestampOutOfRange)
  },
  "invalidIdentifier": {
    object (InvalidIdentifier)
  },
  "idempotencyViolation": {
    object (IdempotencyViolation)
  },
  "invalidFieldValue": {
    object (InvalidFieldValue)
  },
  "missingRequiredField": {
    object (MissingRequiredField)
  },
  "preconditionViolation": {
    object (PreconditionViolation)
  },
  "userActionInProgress": {
    object (UserActionInProgress)
  },
  "invalidDecryptedRequest": {
    object (InvalidDecryptedRequest)
  },
  "forbidden": {
    object (Forbidden)
  }
  // End of list of possible types for union field result.
}
Felder

Union-Feld result.

Für result ist nur einer der folgenden Werte zulässig:

invalidApiVersion

object (InvalidApiVersion)

Wird verwendet, wenn die API-Version der Anfrage nicht unterstützt wird. Empfohlener HTTP-Code: 400

invalidPayloadSignature

object (InvalidPayloadSignature)

Wird verwendet, wenn die Signatur der Nutzlast für einen unbekannten oder inaktiven Schlüssel ist. Empfohlener HTTP-Code: 401

invalidPayloadEncryption

object (InvalidPayloadEncryption)

Wird verwendet, wenn die Verschlüsselung der Nutzlast für einen unbekannten oder inaktiven Schlüssel ist. Empfohlener HTTP-Code: 400

requestTimestampOutOfRange

object (RequestTimestampOutOfRange)

Wird verwendet, wenn der requestTimestamp nicht auf ± 60 Sek. liegt. Empfohlener HTTP-Code: 400

invalidIdentifier

object (InvalidIdentifier)

Wird verwendet, wenn eine in der Anfrage gesendete Kennung ungültig oder unbekannt war. Dazu können PIAID, recordRequestId, Google Payment Token usw. gehören. Empfohlener HTTP-Code: 404

idempotencyViolation

object (IdempotencyViolation)

Wird verwendet, wenn die Anfrage die Idempotenzanforderungen für die Anfrage verletzt. Empfohlener HTTP-Code: 412

invalidFieldValue

object (InvalidFieldValue)

Wird verwendet, wenn die Anfrage einen Wert für ein Feld enthält, das sich nicht im Satz unterstützter Werte befindet. Empfohlener HTTP-Code: 400

missingRequiredField

object (MissingRequiredField)

Wird verwendet, wenn ein erforderliches Feld in der Anfrage nicht festgelegt ist. Empfohlener HTTP-Code: 400

preconditionViolation

object (PreconditionViolation)

Wird verwendet, wenn gegen eine Einschränkung des Vorgangs verstoßen wird, z.B. wenn eine Anfrage für einen Erstattungsbetrag den bei der Transaktion verbleibenden Betrag überschreitet. Empfohlener HTTP-Code: 400

userActionInProgress

object (UserActionInProgress)

Wird verwendet, wenn die Anfrage zu diesem Zeitpunkt nicht verarbeitet werden kann, weil dadurch eine laufende Nutzeraktion unterbrochen würde, was effektiv als Systemsperre fungiert. Dieser Code darf nicht verwendet werden, um Fehler aufgrund von implementierungsspezifischen internen Gleichzeitigkeitsfehlern anzuzeigen. Empfohlener HTTP-Code: 423

invalidDecryptedRequest

object (InvalidDecryptedRequest)

Wird verwendet, wenn die Nutzlast der Anfrage entschlüsselt, die Nachricht aber nicht geparst werden konnte. Empfohlener HTTP-Code: 400

forbidden

object (Forbidden)

Der Zugriff auf die angeforderte Ressource ist verboten. Empfohlener HTTP-Code: 403

InvalidApiVersion

JSON-Darstellung
{
  "requestVersion": {
    object (Version)
  },
  "expectedVersion": {
    object (Version)
  }
}
Felder
requestVersion

object (Version)

REQUIRED: Die ungültige Version, die in der Anfrage angegeben wurde.

expectedVersion

object (Version)

REQUIRED: Die erwartete Version.

InvalidPayloadSignature

Dieser Typ hat keine Felder.

Diese Nachricht ist momentan absichtlich leer. In Zukunft können möglicherweise neue Felder hinzugefügt werden.

InvalidPayloadEncryption

Dieser Typ hat keine Felder.

Diese Nachricht ist momentan absichtlich leer. In Zukunft können möglicherweise neue Felder hinzugefügt werden.

RequestTimestampOutOfRange

JSON-Darstellung
{
  "requestTimestamp": {
    object (Timestamp)
  },
  "serverTimestampAtReceipt": {
    object (Timestamp)
  }
}
Felder
requestTimestamp

object (Timestamp)

REQUIRED: in der Anfrage angegebener Zeitstempel

serverTimestampAtReceipt

object (Timestamp)

REQUIRED: Die Serverzeit bei Erhalt, die zum Vergleich verwendet wird.

InvalidIdentifier

JSON-Darstellung
{
  "invalidIdentifierType": string
}
Felder
invalidIdentifierType

string

REQUIRED: Der Typ der ungültigen Kennung, z.B. PIAID, recordRequestId usw.

IdempotencyViolation

Dieser Typ hat keine Felder.

Diese Nachricht ist momentan absichtlich leer. In Zukunft können möglicherweise neue Felder hinzugefügt werden.

InvalidFieldValue

JSON-Darstellung
{
  "invalidFieldName": string
}
Felder
invalidFieldName

string

ERFORDERLICH: Der Name des Felds, das als ungültig erachtet wurde.

MissingRequiredField

JSON-Darstellung
{
  "missingFieldNames": [
    string
  ]
}
Felder
missingFieldNames[]

string

ERFORDERLICH: Die Namen der fehlenden Felder.

PreconditionViolation

Dieser Typ hat keine Felder.

Diese Nachricht ist momentan absichtlich leer. In Zukunft können möglicherweise neue Felder hinzugefügt werden.

UserActionInProgress

Dieser Typ hat keine Felder.

Diese Nachricht ist momentan absichtlich leer. In Zukunft können möglicherweise neue Felder hinzugefügt werden.

InvalidDecryptedRequest

Dieser Typ hat keine Felder.

Diese Nachricht ist momentan absichtlich leer. In Zukunft können möglicherweise neue Felder hinzugefügt werden.

Verboten

Dieser Typ hat keine Felder.

Diese Nachricht ist momentan absichtlich leer. In Zukunft können möglicherweise neue Felder hinzugefügt werden.