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	Applies to	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`	`CreateSessionRequest` and `CollectRequest`	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`	`CreateSessionRequest` and `CollectRequest`	Indicates the delivery method related to the EBT benefit.
`openingDate`	`string` in date format (`YYYY-MM-DD`)	`CreateSessionRequest` and `CollectRequest`	Account creation date. Required for PSE in merchants with the “Financial Services” category.
`beneficiaryId`	`string`	`CreateSessionRequest` and `CollectRequest`	Beneficiary ID linked to the receiving account in a PSE transaction. Required for merchants in the “Financial Services” category.
`requiresConfirmation`	`true`, `false`	`CreateSessionRequest` and `CollectRequest`	When set to `true`, the transaction will require confirmation by the merchant before final authorization. Requires the `allowConfirmationFlow` setting to be enabled for the merchant.
`athMovilConfirmationTimeOut`	Integer from `1` through `60`, or `null`	`CreateSessionRequest`, ATH Móvil only	Defines how many minutes the payer has to confirm the payment in ATH Móvil. If omitted or sent as `null`, the prioritization rules defined at the payment method or tenant level are used.

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",
      "requiresConfirmation": true,
      "athMovilConfirmationTimeOut": 20
   },
   ...
}

CollectRequest.metadata

CollectRequest

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