Method: echo

Esegue l'eco di una stringa inviata dal client.

Se l'endpoint rileva un errore durante l'elaborazione della richiesta, il corpo della risposta da questo endpoint deve essere di tipo ErrorResponse.

Una richiesta di esempio ha il seguente aspetto:


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

Un esempio di risposta positiva è simile al seguente:


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

Richiesta HTTP

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

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON
{
  "requestHeader": {
    object (RequestHeader)
  },
  "clientMessage": string
}
Campi
requestHeader

object (RequestHeader)

REQUIRED: intestazione comune per tutte le richieste.

clientMessage

string

REQUIRED: messaggio da richiamare nella risposta.

Corpo della risposta

Oggetto di risposta per il metodo echo.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "clientMessage": string,
  "serverMessage": string
}
Campi
responseHeader

object (ResponseHeader)

REQUIRED: intestazione comune per tutte le risposte.

clientMessage

string

REQUIRED: messaggio ricevuto nella richiesta.

serverMessage

string

FACOLTATIVO: messaggio del server, indipendentemente dall'eco di clientMessage.

RequestHeader

Oggetto intestazione definito in tutte le richieste inviate al server.

Rappresentazione JSON
{
  "requestId": string,
  "requestTimestamp": {
    object (Timestamp)
  },
  "protocolVersion": {
    object (Version)
  },
  "paymentIntegratorAccountId": string
}
Campi
requestId

string

REQUIRED: identificatore univoco della richiesta.

Si tratta di una stringa con una lunghezza massima di 100 caratteri e contenente solo i caratteri "a-z", "A-Z", "0-9", ":", "-" e "_".

requestTimestamp

object (Timestamp)

REQUIRED: timestamp di questa richiesta. Il destinatario deve verificare che il timestamp sia di ± 60 secondi rispetto alla data "ora" e rifiutare la richiesta in caso contrario. Questo timestamp della richiesta non è idempotente al momento dei nuovi tentativi.

protocolVersion

object (Version)

REQUIRED: la versione della richiesta.

paymentIntegratorAccountId

string

REQUIRED: identifica un account univoco con vincoli contrattuali.