Echos back a string sent from the client.
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
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.ErrorResponse
An example request looks like:
{
"requestHeader": {
"protocolVersion": {
"major": 2
},
"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 ( |
Fields | |
---|---|
requestHeader |
REQUIRED: Common header for all requests. |
clientMessage |
REQUIRED: Message to echo in the response. |
Response body
If successful, the response body contains data with the following structure:
Response object for the echo method.
JSON representation |
---|
{
"responseHeader": {
object ( |
Fields | |
---|---|
responseHeader |
REQUIRED: Common header for all responses. |
clientMessage |
REQUIRED: Message received in the request. |
serverMessage |
OPTIONAL: Server message, independent of the |
RequestHeader
Header object that is defined on all requests sent to the server.
JSON representation |
---|
{ "requestId": string, "requestTimestamp": { object ( |
Fields | |
---|---|
requestId |
REQUIRED: Unique identifier of this request. This is a string that has a max length of 100 characters, and contains only the characters "a-z", "A-Z", "0-9", ":", "-", and "_". |
requestTimestamp |
REQUIRED: Timestamp of this request. The receiver must verify that this timestamp is ± 60s of 'now', and reject the request if it is not. This request timestamp is not idempotent upon retries. |
protocolVersion |
REQUIRED: The version of this request. |
paymentIntegratorAccountId |
REQUIRED: Identifies a unique account with contractual constraints. |