Method: echo

• HTTP request
• Request body
  • JSON representation
• Response body
• EchoResponse
  • JSON representation

Echos back a string sent from the client.

If the endpoint encounters an error while processing the request, the response body from this endpoint should be of type ErrorResponse.

An example request looks like:

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

An example success response looks like:

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

HTTP request

POST https://www.integratorhost.example.com/integrator-base-path/v1/echo

Request body

The request body contains data with the following structure:

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

Fields
requestHeader	object (RequestHeader) REQUIRED: Common header for all requests.
clientMessage	string REQUIRED: Message to echo in the response.

Response body

This method supports multiple return types. For additional information about what 4XX or 5XX HTTP status code to return with an ErrorResponse, consult the ErrorResponse object and HTTP status codes documentation.

Possible response messages
HTTP 200 Status	object (EchoResponse)
HTTP 4XX / 5XX Status	object (ErrorResponse)

EchoResponse

Response object for the echo method.

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

Fields
responseHeader	object (ResponseHeader) REQUIRED: Common header for all responses.
clientMessage	string REQUIRED: Message received in the request.
serverMessage	string OPTIONAL: Server message, independent of the clientMessage being echoed.