RequestHeader

  • The Header object is included in all server requests and contains key identifiers and metadata.

  • requestId, requestTimestamp, protocolVersion, and paymentIntegratorAccountId are required fields within the Header object.

  • requestId is a unique identifier for each request, limited to 100 characters with specific allowed characters.

  • requestTimestamp must be within 60 seconds of the current time and is not idempotent for retries.

  • The receiver should validate the timestamp and reject requests outside the allowed timeframe.

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.