RequestHeader

  • The header object is required for all server requests and includes details like request ID, timestamp, protocol version, and payment integrator account ID.

  • The requestId is a unique identifier with a maximum length of 100 characters, comprising only alphanumeric characters, colon, hyphen, and underscore.

  • requestTimestamp is crucial for validation, as the receiver must ensure it's within ± 60 seconds of the current time, rejecting otherwise and acknowledging its non-idempotent nature.

  • Both protocolVersion and paymentIntegratorAccountId are mandatory fields within the header, specifying the request's version and identifying a unique account with contractual limitations, respectively.

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.