Method: echo

可回應用戶端傳送的字串。

如果端點在處理要求時發生錯誤,來自這個端點的回應主體應為 ErrorResponse 類型。

以下是要求範例:


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

成功回應的範例如下:


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

HTTP 要求

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

要求主體

要求主體的資料會採用以下結構:

JSON 表示法
{
  "requestHeader": {
    object (RequestHeader)
  },
  "clientMessage": string
}
欄位
requestHeader

object (RequestHeader)

必要項目:所有要求的通用標頭。

clientMessage

string

必要項目:回應中的 echo 訊息。

回應主體

echo 方法的回應物件。

如果成功,回應主體即會包含具有以下結構的資料:

JSON 表示法
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "clientMessage": string,
  "serverMessage": string
}
欄位
responseHeader

object (ResponseHeader)

必要項目:所有回應的通用標頭。

clientMessage

string

必要項目:要求中收到的訊息。

serverMessage

string

選用:伺服器訊息,與被回應的 clientMessage 無關。

RequestHeader

針對傳送至伺服器的所有要求所定義的標頭物件。

JSON 表示法
{
  "requestId": string,
  "requestTimestamp": {
    object (Timestamp)
  },
  "protocolVersion": {
    object (Version)
  },
  "paymentIntegratorAccountId": string
}
欄位
requestId

string

必要項目:這項要求的專屬 ID。

這是一個長度上限為 100 個字元的字串,並且只包含「a-z」、「A-Z」、「0-9」、「:」、「-」和「_」等字元。

requestTimestamp

object (Timestamp)

必要項目:這項要求的時間戳記。接收端必須驗證這個時間戳記是「現在」的 ±60 號,如果並非「現在」,請拒絕要求。重試時,此要求時間戳記並不是冪等的。

protocolVersion

object (Version)

必要項目:這項要求的版本。

paymentIntegratorAccountId

string

必要項目:識別具有合約限制的專屬帳戶。