Method: echo

Reproduz uma string enviada do cliente.

Se o endpoint encontrar um erro ao processar a solicitação, o corpo da resposta desse endpoint precisará ser do tipo ErrorResponse.

Este é um exemplo de solicitação:


{
  "requestHeader": {
    "protocolVersion": {
      "major": 2
    },
    "requestId": "G1MQ0YERJ0Q7LPM",
    "requestTimestamp": {
      "epochMillis": "1481899949606"
    },
    "paymentIntegratorAccountId": "InvisiCashUSA_USD"
  },
  "clientMessage": "Client echo message"
}

Este é um exemplo de resposta de sucesso:


{
  "responseHeader": {
    "responseTimestamp": {
      "epochMillis":"1481899950236"
    }
  },
  "clientMessage": "Client echo message",
  "serverMessage": "Debug ID 12345"
}

Solicitação HTTP

POST https://www.integratorhost.example.com/v2/echo

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "requestHeader": {
    object (RequestHeader)
  },
  "clientMessage": string
}
Campos
requestHeader

object (RequestHeader)

OBRIGATÓRIO: cabeçalho comum para todas as solicitações.
clientMessage

string

OBRIGATÓRIO: mensagem a ser transmitida na resposta.

Corpo da resposta

Objeto de resposta para o método echo.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "clientMessage": string,
  "serverMessage": string
}
Campos
responseHeader

object (ResponseHeader)

OBRIGATÓRIO: cabeçalho comum para todas as respostas.
clientMessage

string

OBRIGATÓRIO: mensagem recebida na solicitação.
serverMessage

string

OPTIONAL: mensagem do servidor, independente do clientMessage que está sendo ecoado.

RequestHeader

Objeto "Header" definido em todas as solicitações enviadas ao servidor.

Representação JSON 
{
  "requestId": string,
  "requestTimestamp": {
    object (Timestamp)
  },
  "protocolVersion": {
    object (Version)
  },
  "paymentIntegratorAccountId": string
}
Campos
requestId

string

OBRIGATÓRIO: identificador exclusivo da solicitação.

Essa é uma string com tamanho máximo de 100 caracteres e apenas os caracteres "a-z", "A-Z", "0-9", ":", "-" e "_".
requestTimestamp

object (Timestamp)

OBRIGATÓRIO: carimbo de data/hora da solicitação. O destinatário precisa verificar se esse carimbo de data/hora está ± 60 segundos de "agora" e rejeitar a solicitação se não estiver. Esse carimbo de data/hora da solicitação não é idempotente em novas tentativas.
protocolVersion

object (Version)

OBRIGATÓRIO: a versão da solicitação.
paymentIntegratorAccountId

string

OBRIGATÓRIO: identifica uma conta exclusiva com restrições contratuais.