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`, `CARDHOLDER_COF` , `CARDHOLDER_RECURRING_VARIABLE_AMOUNT`, `CARDHOLDER_RECURRING_FIXED_AMOUNT`, `CARDHOLDER_WITH_INSTALLMENTS` , `MERCHANT_COF`, `MERCHANT_RECURRING_VARIABLE_AMOUNT`, `MERCHANT_RECURRING_FIXED_AMOUNT`, `MERCHANT_WITH_INSTALLMENTS`	Defines who initiates the transaction and under what agreement, according to Mastercard’s stored credential rules.
`EBTDeliveryIndicator`	`DIRECT_DELIVERY`, `CUSTOMER_PICKUP`, `COMMERCIAL_SHIPPING`, `OTHER`, `NOT_AVAILABLE`	Indicates the delivery method related to the EBT benefit.
`openingDate`	`string` in date format (YYYY-MM-DD)	Account creation date. Required for PSE in merchants with “Financial Services” category.
`beneficiaryId`	`string`	Beneficiary ID linked to the receiving account in a PSE transaction. Required for merchants in the “Financial Services” category.

If a value other than the permitted ones is sent for any of the keys, the API will respond with an error.

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",
      "EBTDeliveryIndicator" : "DIRECT_DELIVERY",
      "openingDate": "2025-02-01",
      "beneficiaryId": "12345",
   },
   ...
}

CollectRequest.metadata

CollectRequest

{
   "auth": {...},
   "payment": {...},
   "metadata" : {
      "initiatorIndicator": "AGENT",
      "EBTDeliveryIndicator" : "DIRECT_DELIVERY",
      "openingDate": "2025-02-01",
      "beneficiaryId": "12345",
   },
    ..
}