RequestHeader

  • This document outlines the header object structure required for all requests sent to the server.

  • The header object includes requestId, requestTimestamp, protocolVersion, and paymentIntegratorAccountId fields, all of which are mandatory.

  • requestId is a unique identifier, requestTimestamp helps in verifying the request's timeliness, protocolVersion specifies the request's version, and paymentIntegratorAccountId identifies the specific account.

  • Each field has specific requirements, such as allowed characters and data types, that must be adhered to for successful communication.

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.