Method: echo

Gibt einen vom Client gesendeten String zurück.

Wenn am Endpunkt bei der Verarbeitung der Anfrage ein Fehler auftritt, sollte der Antworttext dieses Endpunkts vom Typ ErrorResponse sein.

Eine Beispielanfrage sieht so aus:


{
  "requestHeader": {
    "protocolVersion": {
      "major": 2
    },
    "requestId": "G1MQ0YERJ0Q7LPM",
    "requestTimestamp": {
      "epochMillis": "1481899949606"
    },
    "paymentIntegratorAccountId": "InvisiCashUSA_USD"
  },
  "clientMessage": "Client echo message"
}

Ein Beispiel für eine erfolgreiche Antwort sieht so aus:


{
  "responseHeader": {
    "responseTimestamp": {
      "epochMillis":"1481899950236"
    }
  },
  "clientMessage": "Client echo message",
  "serverMessage": "Debug ID 12345"
}

HTTP-Anfrage

POST https://www.integratorhost.example.com/v2/echo

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "requestHeader": {
    object (RequestHeader)
  },
  "clientMessage": string
}
Felder
requestHeader

object (RequestHeader)

ERFORDERLICH: Allgemeiner Header für alle Anfragen.
clientMessage

string

REQUIRED: Nachricht, die in der Antwort wiederholt werden soll.

Antworttext

Antwortobjekt für die echo-Methode.

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

JSON-Darstellung 
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "clientMessage": string,
  "serverMessage": string
}
Felder
responseHeader

object (ResponseHeader)

REQUIRED: Allgemeiner Header für alle Antworten.
clientMessage

string

REQUIRED: In der Anfrage erhaltene Nachricht.
serverMessage

string

OPTIONAL: Servernachricht, unabhängig vom clientMessage, das wiedergegeben wird.

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.