RequestHeader

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

  • requestId is a unique identifier for each request with specific character limitations, while requestTimestamp indicates the request time and needs to be within a specific timeframe for acceptance.

  • protocolVersion specifies the request version, and paymentIntegratorAccountId identifies the specific account associated with the request, subject to contractual terms.

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.