Method: echo

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

Echos back the clientMessage passed in.

The purpose of this method is to test basic connectivity between the payment integrator and Google.

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

Responses to this query may be empty if this method does not return an HTTP 200. The response body is empty in situations where an ErrorResponse with a clear description could be used to help an attacker understand the payment integrator account identifier of other integrators. In these situations, where either the signing key doesn't match, the payment integrator identifier was not found, or the encryption key was unknown, this method will return an HTTP 404 with an empty body. If the request signature could be verified, additional information regarding the error will be returned in the response body.

An example request looks like:

{
  "requestHeader": {
    "protocolVersion": {
      "major": 1,
      "minor": 0,
      "revision": 0
    },
    "requestId": "ZWNobyB0cmFuc2FjdGlvbg",
    "requestTimestamp": "1481899949606"
  },
  "clientMessage": "client message"
}

An example response looks like:

{
  "responseHeader": {
    "responseTimestamp": "1481900013178"
  },
  "clientMessage": "client message",
  "serverMessage": "server message"
}

HTTP request

POST https://vgw.googleapis.com/gsp/chargeback-alert-v1/echo/:PIAID

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.