Metadata

The metadata property is a key-value structure that allows integrated merchants to send additional information to modify certain behaviors during session processing.

Compatibility and Endpoint Usage

Currently, the key-value structure can be included in requests to the following endpoints:

Supported Keys

Key
Allowed Values
Description
InitiatorIndicator
"AGENT"
Indicates that the session processing will be carried out by an agent on behalf of the cardholder. If a different value is sent, the API will respond with the error: The property InitiatorIndicator is not valid.

Request Implementation

The metadata property can be included in the main structure of the request in the following fields:

  • CreateSessionRequest.metadata

CreateSessionRequest

{
   "auth": {...},
   "payment": {...},
   "metadata" : {
      "InitiatorIndicator": "AGENT"
   },
   ...
}
  • CollectRequest.metadata

CollectRequest

{
   "auth": {...},
   "payment": {...},
   "metadata" : {
      "InitiatorIndicator": "AGENT"
   },
    ..
}