Page Summary
-
This endpoint echoes back a string sent from the client in the request body.
-
The request body must contain a
requestHeaderandclientMessage. -
The response body will contain a
responseHeader, the echoedclientMessage, and an optionalserverMessage. -
In case of errors, the response will be of type
ErrorResponse. -
The endpoint can be accessed via a POST request to
https://www.integratorhost.example.com/integrator-base-path/v2/echo.
Echos back a string sent from the client.
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
},
"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://www.integratorhost.example.com/integrator-base-path/v2/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
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 | |
| HTTP 4XX / 5XX Status | |
EchoResponse
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 |
