java.lang.Object
- com.adyen.model.tapi.MessageHeader

```
public class MessageHeader
extends Object
```
Message header of the Sale to POI protocol message. It conveys Information related to the Sale to POI protocol management.

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`JSON_PROPERTY_DEVICE_I_D`
`static String`	`JSON_PROPERTY_MESSAGE_CATEGORY`
`static String`	`JSON_PROPERTY_MESSAGE_CLASS`
`static String`	`JSON_PROPERTY_MESSAGE_TYPE`
`static String`	`JSON_PROPERTY_P_O_I_I_D`
`static String`	`JSON_PROPERTY_PROTOCOL_VERSION`
`static String`	`JSON_PROPERTY_SALE_I_D`
`static String`	`JSON_PROPERTY_SERVICE_I_D`

Constructor Summary

Constructors
Constructor Description

MessageHeader()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`MessageHeader`	`deviceID(String deviceID)`	Identification of a device message pair.
`boolean`	`equals(Object o)`	Return true if this MessageHeader object is equal to o.
`static MessageHeader`	`fromJson(String jsonString)`	Create an instance of MessageHeader given an JSON string
`String`	`getDeviceID()`	Identification of a device message pair.
`Map<String,Object>`	`getExplicitNulls()`	Returns a map of properties to be merged into the JSON payload as explicit null values.
`MessageCategory`	`getMessageCategory()`	Get messageCategory
`MessageClass`	`getMessageClass()`	Get messageClass
`MessageType`	`getMessageType()`	Get messageType
`String`	`getPOIID()`	Identification of a POI System or a POI Terminal for the Sale to POI protocol.
`String`	`getProtocolVersion()`	If MessageCategory is Login or Diagnosis.
`String`	`getSaleID()`	Identification of a Sale System or a Sale Terminal for the Sale to POI protocol.
`String`	`getServiceID()`	Identification of a message pair, which processes a transaction.
`int`	`hashCode()`
`MessageHeader`	`includeNullValues(boolean includeNullValues)`	Configures whether null values are explicitly serialized in the JSON payload.
`boolean`	`isIncludeNullValues()`	Returns whether null values are explicitly serialized in the JSON payload.
`MessageHeader`	`messageCategory(MessageCategory messageCategory)`	messageCategory
`MessageHeader`	`messageClass(MessageClass messageClass)`	messageClass
`MessageHeader`	`messageType(MessageType messageType)`	messageType
`MessageHeader`	`POIID(String POIID)`	Identification of a POI System or a POI Terminal for the Sale to POI protocol.
`MessageHeader`	`protocolVersion(String protocolVersion)`	If MessageCategory is Login or Diagnosis.
`MessageHeader`	`saleID(String saleID)`	Identification of a Sale System or a Sale Terminal for the Sale to POI protocol.
`MessageHeader`	`serviceID(String serviceID)`	Identification of a message pair, which processes a transaction.
`void`	`setDeviceID(String deviceID)`	Identification of a device message pair.
`void`	`setIncludeNullValues(boolean includeNullValues)`	Sets whether null values should be explicitly serialized in the JSON payload.
`void`	`setMessageCategory(MessageCategory messageCategory)`	messageCategory
`void`	`setMessageClass(MessageClass messageClass)`	messageClass
`void`	`setMessageType(MessageType messageType)`	messageType
`void`	`setPOIID(String POIID)`	Identification of a POI System or a POI Terminal for the Sale to POI protocol.
`void`	`setProtocolVersion(String protocolVersion)`	If MessageCategory is Login or Diagnosis.
`void`	`setSaleID(String saleID)`	Identification of a Sale System or a Sale Terminal for the Sale to POI protocol.
`void`	`setServiceID(String serviceID)`	Identification of a message pair, which processes a transaction.
`String`	`toJson()`	Convert an instance of MessageHeader to an JSON string
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - JSON_PROPERTY_PROTOCOL_VERSION
```
public static final String JSON_PROPERTY_PROTOCOL_VERSION
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_MESSAGE_CLASS
```
public static final String JSON_PROPERTY_MESSAGE_CLASS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_MESSAGE_CATEGORY
```
public static final String JSON_PROPERTY_MESSAGE_CATEGORY
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_MESSAGE_TYPE
```
public static final String JSON_PROPERTY_MESSAGE_TYPE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SERVICE_I_D
```
public static final String JSON_PROPERTY_SERVICE_I_D
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_DEVICE_I_D
```
public static final String JSON_PROPERTY_DEVICE_I_D
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SALE_I_D
```
public static final String JSON_PROPERTY_SALE_I_D
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_P_O_I_I_D
```
public static final String JSON_PROPERTY_P_O_I_I_D
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - MessageHeader
```
public MessageHeader()
```
- Method Detail
  - protocolVersion
```
public MessageHeader protocolVersion(String protocolVersion)
```
    If MessageCategory is Login or Diagnosis.
    
    Parameters:
    
    protocolVersion - If MessageCategory is Login or Diagnosis.
    
    Returns:
    
    the current MessageHeader instance, allowing for method chaining
  - getProtocolVersion
```
public String getProtocolVersion()
```
    If MessageCategory is Login or Diagnosis.
    
    Returns:
    
    protocolVersion If MessageCategory is Login or Diagnosis.
  - setProtocolVersion
```
public void setProtocolVersion(String protocolVersion)
```
    If MessageCategory is Login or Diagnosis.
    
    Parameters:
    
    protocolVersion - If MessageCategory is Login or Diagnosis.
  - messageClass
```
public MessageHeader messageClass(MessageClass messageClass)
```
    messageClass
    
    Parameters:
    
    messageClass -
    
    Returns:
    
    the current MessageHeader instance, allowing for method chaining
  - getMessageClass
```
public MessageClass getMessageClass()
```
    Get messageClass
    
    Returns:
    
    messageClass
  - setMessageClass
```
public void setMessageClass(MessageClass messageClass)
```
    messageClass
    
    Parameters:
    
    messageClass -
  - messageCategory
```
public MessageHeader messageCategory(MessageCategory messageCategory)
```
    messageCategory
    
    Parameters:
    
    messageCategory -
    
    Returns:
    
    the current MessageHeader instance, allowing for method chaining
  - getMessageCategory
```
public MessageCategory getMessageCategory()
```
    Get messageCategory
    
    Returns:
    
    messageCategory
  - setMessageCategory
```
public void setMessageCategory(MessageCategory messageCategory)
```
    messageCategory
    
    Parameters:
    
    messageCategory -
  - messageType
```
public MessageHeader messageType(MessageType messageType)
```
    messageType
    
    Parameters:
    
    messageType -
    
    Returns:
    
    the current MessageHeader instance, allowing for method chaining
  - getMessageType
```
public MessageType getMessageType()
```
    Get messageType
    
    Returns:
    
    messageType
  - setMessageType
```
public void setMessageType(MessageType messageType)
```
    messageType
    
    Parameters:
    
    messageType -
  - serviceID
```
public MessageHeader serviceID(String serviceID)
```
    Identification of a message pair, which processes a transaction. Required if Service or Event MessageClass message or if Device MessageClass and request from POI or response from Sale.
    
    Parameters:
    
    serviceID - Identification of a message pair, which processes a transaction. Required if Service or Event MessageClass message or if Device MessageClass and request from POI or response from Sale.
    
    Returns:
    
    the current MessageHeader instance, allowing for method chaining
  - getServiceID
```
public String getServiceID()
```
    Identification of a message pair, which processes a transaction. Required if Service or Event MessageClass message or if Device MessageClass and request from POI or response from Sale.
    
    Returns:
    
    serviceID Identification of a message pair, which processes a transaction. Required if Service or Event MessageClass message or if Device MessageClass and request from POI or response from Sale.
  - setServiceID
```
public void setServiceID(String serviceID)
```
    Identification of a message pair, which processes a transaction. Required if Service or Event MessageClass message or if Device MessageClass and request from POI or response from Sale.
    
    Parameters:
    
    serviceID - Identification of a message pair, which processes a transaction. Required if Service or Event MessageClass message or if Device MessageClass and request from POI or response from Sale.
  - deviceID
```
public MessageHeader deviceID(String deviceID)
```
    Identification of a device message pair. If Device MessageClass.
    
    Parameters:
    
    deviceID - Identification of a device message pair. If Device MessageClass.
    
    Returns:
    
    the current MessageHeader instance, allowing for method chaining
  - getDeviceID
```
public String getDeviceID()
```
    Identification of a device message pair. If Device MessageClass.
    
    Returns:
    
    deviceID Identification of a device message pair. If Device MessageClass.
  - setDeviceID
```
public void setDeviceID(String deviceID)
```
    Identification of a device message pair. If Device MessageClass.
    
    Parameters:
    
    deviceID - Identification of a device message pair. If Device MessageClass.
  - saleID
```
public MessageHeader saleID(String saleID)
```
    Identification of a Sale System or a Sale Terminal for the Sale to POI protocol.
    
    Parameters:
    
    saleID - Identification of a Sale System or a Sale Terminal for the Sale to POI protocol.
    
    Returns:
    
    the current MessageHeader instance, allowing for method chaining
  - getSaleID
```
public String getSaleID()
```
    Identification of a Sale System or a Sale Terminal for the Sale to POI protocol.
    
    Returns:
    
    saleID Identification of a Sale System or a Sale Terminal for the Sale to POI protocol.
  - setSaleID
```
public void setSaleID(String saleID)
```
    Identification of a Sale System or a Sale Terminal for the Sale to POI protocol.
    
    Parameters:
    
    saleID - Identification of a Sale System or a Sale Terminal for the Sale to POI protocol.
  - POIID
```
public MessageHeader POIID(String POIID)
```
    Identification of a POI System or a POI Terminal for the Sale to POI protocol.
    
    Parameters:
    
    POIID - Identification of a POI System or a POI Terminal for the Sale to POI protocol.
    
    Returns:
    
    the current MessageHeader instance, allowing for method chaining
  - getPOIID
```
public String getPOIID()
```
    Identification of a POI System or a POI Terminal for the Sale to POI protocol.
    
    Returns:
    
    POIID Identification of a POI System or a POI Terminal for the Sale to POI protocol.
  - setPOIID
```
public void setPOIID(String POIID)
```
    Identification of a POI System or a POI Terminal for the Sale to POI protocol.
    
    Parameters:
    
    POIID - Identification of a POI System or a POI Terminal for the Sale to POI protocol.
  - includeNullValues
```
public MessageHeader includeNullValues(boolean includeNullValues)
```
    Configures whether null values are explicitly serialized in the JSON payload. Default is false.
  - isIncludeNullValues
```
public boolean isIncludeNullValues()
```
    Returns whether null values are explicitly serialized in the JSON payload.
  - setIncludeNullValues
```
public void setIncludeNullValues(boolean includeNullValues)
```
    Sets whether null values should be explicitly serialized in the JSON payload. Default is false.
  - equals
```
public boolean equals(Object o)
```
    Return true if this MessageHeader object is equal to o.
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getExplicitNulls
```
public Map<String,Object> getExplicitNulls()
```
    Returns a map of properties to be merged into the JSON payload as explicit null values.
  - fromJson
```
public static MessageHeader fromJson(String jsonString)
                              throws com.fasterxml.jackson.core.JsonProcessingException
```
    Create an instance of MessageHeader given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of MessageHeader
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to MessageHeader
  - toJson
```
public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException
```
    Convert an instance of MessageHeader to an JSON string
    
    Returns:
    
    JSON string
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException

Class MessageHeader

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JSON_PROPERTY_PROTOCOL_VERSION

JSON_PROPERTY_MESSAGE_CLASS

JSON_PROPERTY_MESSAGE_CATEGORY

JSON_PROPERTY_MESSAGE_TYPE

JSON_PROPERTY_SERVICE_I_D

JSON_PROPERTY_DEVICE_I_D

JSON_PROPERTY_SALE_I_D

JSON_PROPERTY_P_O_I_I_D

Constructor Detail

MessageHeader

Method Detail

protocolVersion

getProtocolVersion

setProtocolVersion

messageClass

getMessageClass

setMessageClass

messageCategory

getMessageCategory

setMessageCategory

messageType

getMessageType

setMessageType

serviceID

getServiceID

setServiceID

deviceID

getDeviceID

setDeviceID

saleID

getSaleID

setSaleID

POIID

getPOIID

setPOIID

includeNullValues

isIncludeNullValues

setIncludeNullValues

equals

hashCode

toString

getExplicitNulls

fromJson

toJson