Echos back a string sent from the client.
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
},
"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://vgw.googleapis.com/secure-serving/gsp/v2/echo/:PIAID
Request body
The request body contains data with the following structure:
| JSON representation |
|---|
{ "requestHeader": { object (RequestHeader) }, "clientMessage": string } |
| Fields | |
|---|---|
requestHeader |
REQUIRED: Common header for all requests. |
clientMessage |
REQUIRED: Message to echo in the response. |
Response body
If successful, the response body contains an instance of ComplexEchoResponse.