Mastercard · Schema

BatchStatusItems

Credit CardsDigital IdentityFinancial ServicesFraud DetectionOpen BankingPaymentsFortune 500

Properties

Name Type Description
action string The action to be performed on the Digital Payment Application (DPA). The selected action will be applied to all DPAs provided in the items list. __ADD__ - Add DPA __UPDATE__ - Update DPA __DELETE__ -
serviceId string A unique identifier assigned by Mastercard for which tokens are created uniquely for the entity onboarded.
trid string Token Requestors receive a unique identifier, TRID, which represents the consumer-facing entity name to the Issuer during the tokenization process. This identifier has a one-to-one relationship with t
programName string The Cardholder facing name of the Merchant. Conditional: Must be supplied when adding Merchants to a Payment Facilitator (PF) program."
status string Indicates the status of an individual Digital Payment Application (DPA) item in a batch.
dpaResults array
View JSON Schema on GitHub

JSON Schema

mastercard-checkout-solutions-batch-status-items-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "BatchStatusItems",
  "type": "object",
  "properties": {
    "action": {
      "type": "string",
      "description": "The action to be performed on the Digital Payment Application (DPA). The selected action will be applied to all DPAs provided in the items list.\n\n__ADD__ - Add DPA\n\n__UPDATE__ - Update DPA\n\n__DELETE__ - Delete DPA\n\nNote: A limited number of DPA fields can be changed using the 'UPDATE' action. These are dpaPresentationName, dpaLogoUri, debitTokenRequested,  merchantCategoryCode, and threeDSDefaultData. Please refer to the example for a minimal use case.\n"
    },
    "serviceId": {
      "type": "string",
      "description": "A unique identifier assigned by Mastercard for which tokens are created uniquely for the entity onboarded."
    },
    "trid": {
      "type": "string",
      "description": "Token Requestors receive a unique identifier, TRID, which represents the consumer-facing entity name to the Issuer\nduring the tokenization process. This identifier has a one-to-one relationship with the serviceId.\n<br>\n<br> Note: Reach out to your Mastercard representative to begin receiving trid in API responses.\n"
    },
    "programName": {
      "type": "string",
      "description": "The Cardholder facing name of the Merchant.\n\nConditional: Must be supplied when adding Merchants to a Payment Facilitator (PF) program.\"\n"
    },
    "status": {
      "type": "string",
      "description": "Indicates the status of an individual Digital Payment Application (DPA) item in a batch."
    },
    "dpaResults": {
      "type": "array"
    }
  }
}