Echos back the clientMessage
that is passed in.
The purpose of this method is to test basic connectivity between the payment integrator and Google.
This method may be called by Google multiple times per minute with valid or invalid parameters in order to test that security constraints are being held properly. Google also calls this method ad-hoc at the integrator's direction as well as at Google's direction. Google will never call this faster than once every 10s, and never more than 30 times in a 15 minute window.
Examples of security constraint tests are (but not limited to):
- Test to ensure payment integrator's endpoint doesn't negotiate to weak cipher suites.
- Test to ensure payment integrator's endpoint doesn't negotiate to anything but TLS 1.2
- Test to ensure payment integrator's endpoint doesn't support HTTP.
- Test to ensure payment integrator's endpoint mandates at least one known PGP signing key.
- Test to ensure payment integrator's endpoint supports multiple PGP key signatures, both known and unknown, both expired and active.
- Test to ensure payment integrator only support strict JSON parsing.
If the endpoint encounters an error while processing the request, the response body from this endpoint should be of type
.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://www.integratorhost.example.com/v1/echo
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
Response object for the echo method.
If successful, the response body contains data with the following structure:
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": string,
"userLocale": string,
"protocolVersion": {
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 represented as milliseconds since epoch. The receiver should verify that this timestamp is ± 60s of 'now'. This request timestamp is not idempotent upon retries. |
userLocale |
DEPRECATED: A two- or three-letter ISO 639-2 Alpha 3 language code optionally followed by a hyphen and an ISO 3166-1 Alpha-2 country code, e.g.'pt', 'pt-BR', 'fil', or 'fil-PH'. Use this to help drive the |
protocolVersion |
REQUIRED: The version of this request. |
Version
Version object which is a structured form of the classic a.b.c
version structure. Major versions of the same number are guaranteed to be compatible. Note that minor and revisions can change frequently and without notice. The integrator must support all requests for the same major version.
JSON representation |
---|
{ "major": integer, "minor": integer, "revision": integer } |
Fields | |
---|---|
major |
REQUIRED: Major version. This is marked for compatibility requests with different versions are not guaranteed to be compatible. |
minor |
REQUIRED: Minor version. This denotes significant bug fixes. |
revision |
REQUIRED: Minor version. This denotes minor bug fixes. |