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 メソッドに対するレスポンス オブジェクト。

成功すると、レスポンスの本文に次の構造のデータが含まれます。

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

必須: このリクエストの一意の識別子。

これは、最大長が 100 文字で、「a ～ z」、「A ～ Z」、「0 ～ 9」、「:」、「-」、「_」のみを含む文字列です。
requestTimestamp

object (Timestamp)

必須: このリクエストのタイムスタンプ。受信者は、このタイムスタンプが「現在」の ± 60 秒であることを確認し、そうでない場合はリクエストを拒否する必要があります。このリクエストのタイムスタンプは、再試行時にべき等ではありません。
protocolVersion

object (Version)

必須: このリクエストのバージョン。
paymentIntegratorAccountId

string

必須: 契約上の制約がある一意のアカウントを識別します。