Method: echo

AI-generated Key Takeaways

• The Echo API tests connectivity between the payment integrator and Google, echoing back a client message for verification.

• Successful requests return an HTTP 200 status with an EchoResponse object containing the original clientMessage and an optional serverMessage.

• Errors result in HTTP 4xx or 5xx statuses, with responses typically containing an ErrorResponse object, except when security concerns dictate a generic error message.

• Request bodies require a requestHeader for identification and a clientMessage string for echoing.

• The API is accessed via a POST request to a specific URL, including the payment integrator's account ID.

• 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 echo is successful, the endpoint will return an HTTP 200 and the response will be of type EchoResponse.

If the endpoint encounters an error while processing the request, the endpoint will return HTTP 4xx or 5xx and the HTTP body will either be of type ErrorResponse or contain a generic error (e.g. a message similar to "There was an error. Please try again later.").

The generic error is used 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 a generic error. If the request signature could be verified, additional information regarding the error will be returned in an ErrorResponse.

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.