Method: echo
Stay organized with collections
Save and categorize content based on your preferences.
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 |
clientMessage |
string
REQUIRED: Message received in the request.
|
serverMessage |
string
OPTIONAL: Server message, independent of the clientMessage being echoed.
|
All rights reserved. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-02-28 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-28 UTC."],[[["\u003cp\u003eThe Echo API tests connectivity between the payment integrator and Google, echoing back a client message for verification.\u003c/p\u003e\n"],["\u003cp\u003eSuccessful requests return an HTTP 200 status with an \u003ccode\u003eEchoResponse\u003c/code\u003e object containing the original \u003ccode\u003eclientMessage\u003c/code\u003e and an optional \u003ccode\u003eserverMessage\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eErrors result in HTTP 4xx or 5xx statuses, with responses typically containing an \u003ccode\u003eErrorResponse\u003c/code\u003e object, except when security concerns dictate a generic error message.\u003c/p\u003e\n"],["\u003cp\u003eRequest bodies require a \u003ccode\u003erequestHeader\u003c/code\u003e for identification and a \u003ccode\u003eclientMessage\u003c/code\u003e string for echoing.\u003c/p\u003e\n"],["\u003cp\u003eThe API is accessed via a POST request to a specific URL, including the payment integrator's account ID.\u003c/p\u003e\n"]]],["This content describes a test method (`echo`) for verifying connectivity between a payment integrator and Google. It requires a POST request to a specified URL with a JSON request body containing a `requestHeader` and a `clientMessage`. The server echoes back the `clientMessage` in an `EchoResponse` if successful (HTTP 200), which also includes a `responseHeader` and an optional `serverMessage`. Errors result in HTTP 4xx/5xx with either an `ErrorResponse` or a generic error message.\n"],null,["# Method: echo\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n- [EchoResponse](#EchoResponse)\n - [JSON representation](#EchoResponse.SCHEMA_REPRESENTATION)\n\nEchos back the `clientMessage` passed in.\n\nThe purpose of this method is to test basic connectivity between the payment integrator and Google.\n\nIf the echo is successful, the endpoint will return an HTTP 200 and the response will be of type [`EchoResponse`](/pay/chargeback-alert-v1/google-chargeback-alert-api/echo#EchoResponse).\n\nIf 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`](/pay/chargeback-alert-v1/google-chargeback-alert-api/ErrorResponse) or contain a generic error (e.g. a message similar to \"There was an error. Please try again later.\").\n\nThe generic error is used in situations where an [`ErrorResponse`](/pay/chargeback-alert-v1/google-chargeback-alert-api/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`](/pay/chargeback-alert-v1/google-chargeback-alert-api/ErrorResponse).\n\nAn example request looks like: \n\n\n {\n \"requestHeader\": {\n \"protocolVersion\": {\n \"major\": 1,\n \"minor\": 0,\n \"revision\": 0\n },\n \"requestId\": \"ZWNobyB0cmFuc2FjdGlvbg\",\n \"requestTimestamp\": \"1481899949606\"\n },\n \"clientMessage\": \"client message\"\n }\n\nAn example response looks like: \n\n\n {\n \"responseHeader\": {\n \"responseTimestamp\": \"1481900013178\"\n },\n \"clientMessage\": \"client message\",\n \"serverMessage\": \"server message\"\n }\n\n### HTTP request\n\n`POST https://vgw.googleapis.com/gsp/chargeback-alert-v1/echo/`[:PIAID](/pay/chargeback-alert-v1/reference/glossary#payment_integrator_account_id)\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"requestHeader\": { object (/pay/chargeback-alert-v1/google-chargeback-alert-api/RequestHeader) }, \"clientMessage\": string } ``` |\n\n| Fields ||\n|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------|\n| `requestHeader` | `object (`[RequestHeader](/pay/chargeback-alert-v1/google-chargeback-alert-api/RequestHeader)`)` **REQUIRED**: Common header for all requests. |\n| `clientMessage` | `string` **REQUIRED**: Message to echo in the response. |\n\n### Response body\n\nThis 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](/pay/chargeback-alert-v1/guides/connectivity/protocol-standards#http_status_codes).\n\n| Possible response messages ||\n|-----------------------|-----------------------------------------------------------------------------------------------------|\n| HTTP 200 Status | `object (`[EchoResponse](/pay/chargeback-alert-v1/google-chargeback-alert-api/echo#EchoResponse)`)` |\n| HTTP 4XX / 5XX Status | `object (`[ErrorResponse](/pay/chargeback-alert-v1/google-chargeback-alert-api/ErrorResponse)`)` |\n\nEchoResponse\n------------\n\nResponse object for the echo method.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"responseHeader\": { object (/pay/chargeback-alert-v1/google-chargeback-alert-api/ResponseHeader) }, \"clientMessage\": string, \"serverMessage\": string } ``` |\n\n| Fields ||\n|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------|\n| `responseHeader` | `object (`[ResponseHeader](/pay/chargeback-alert-v1/google-chargeback-alert-api/ResponseHeader)`)` **REQUIRED**: Common header for all responses. |\n| `clientMessage` | `string` **REQUIRED**: Message received in the request. |\n| `serverMessage` | `string` **OPTIONAL** : Server message, independent of the `clientMessage` being echoed. |"]]