RequestHeader

  • The Header object is included in all server requests and contains key identifiers like requestId, requestTimestamp, protocolVersion, and paymentIntegratorAccountId.

  • requestId is a unique identifier for each request with specific character limitations, while requestTimestamp helps verify request timing within a 60-second window.

  • The protocolVersion indicates the request version, and paymentIntegratorAccountId identifies the specific account subject to contractual agreements.

  • The requestTimestamp is crucial for security as the receiver should reject requests with timestamps outside the acceptable timeframe, and it's not idempotent upon retries, meaning its value changes with each attempt.

Header object that is defined on all requests sent to the server.

JSON representation
{
  "requestId": string,
  "requestTimestamp": {
    object (Timestamp)
  },
  "protocolVersion": {
    object (Version)
  },
  "paymentIntegratorAccountId": string
}
Fields
requestId

string

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

object (Timestamp)

REQUIRED: Timestamp of this request. The receiver must verify that this timestamp is ± 60s of 'now', and reject the request if it is not. This request timestamp is not idempotent upon retries.

protocolVersion

object (Version)

REQUIRED: The version of this request.

paymentIntegratorAccountId

string

REQUIRED: Identifies a unique account with contractual constraints.