Mastercard · Schema

Dpas

Credit CardsDigital IdentityFinancial ServicesFraud DetectionOpen BankingPaymentsFortune 500

Properties

Name Type Description
srcDpaId string The registered identifier for the Digital Payment Application (DPA) accessing the service. At least one DPA needs to be registered for each Merchant/Merchant OBO/Sub-Merchant (PF) needed, with additio
hasAcquirerRelationship string Indicates if the Digital Payment Application (DPA) has an Acquirer relationship. This field may be used to improve acceptance rates.
subMerchantId string Identifier assigned to a Sub-Merchant by the Payment Facilitator (PF). This field may be used to improve transaction security and acceptance rates.
paymentFacilitatorId string Payment Facilitator (PF) identifier that may be used to improve transaction security and acceptance rates.
debitTokenRequested boolean Conditional: Must be set to true when the Digital Payment Application (DPA) processes in the United States (US) under the Click to Pay (C2P) program.
merchantCategoryCodes array Object for the array of Merchant Category Codes (MCC) that the Merchant processes transactions under, and is used for risk-scoring transactions by the issuer. All MCC codes that will be processed by a
acquirerData array
View JSON Schema on GitHub

JSON Schema

mastercard-checkout-solutions-dpas-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Dpas",
  "type": "object",
  "properties": {
    "srcDpaId": {
      "type": "string",
      "description": "\nThe registered identifier for the Digital Payment Application (DPA) accessing the service. At least one DPA needs to be registered for each Merchant/Merchant OBO/Sub-Merchant (PF) needed, with additional DPAs being added as required.\n\nConditional: Required if you are a Merchant directly integrating with Mastercard Checkout Solutions (MCS) APIs, a Payment Service Provider (PSP) integrating On-Behalf-Of (OBO) a Merchant, a Payment Facilitator, or if you are enrolling in the Secure Card on File (SCOF) QR program.\n"
    },
    "hasAcquirerRelationship": {
      "type": "string",
      "description": "Indicates if the Digital Payment Application (DPA) has an Acquirer relationship. This field may be used to improve acceptance rates."
    },
    "subMerchantId": {
      "type": "string",
      "description": "Identifier assigned to a Sub-Merchant by the Payment Facilitator (PF). This field may be used to improve transaction security and acceptance rates."
    },
    "paymentFacilitatorId": {
      "type": "string",
      "description": "Payment Facilitator (PF) identifier that may be used to improve transaction security and acceptance rates."
    },
    "debitTokenRequested": {
      "type": "boolean",
      "description": "Conditional: Must be set to true when the Digital Payment Application (DPA) processes in the United States (US) under the Click to Pay (C2P) program.\n"
    },
    "merchantCategoryCodes": {
      "type": "array",
      "description": "Object for the array of Merchant Category Codes (MCC) that the Merchant processes transactions under, and is used for risk-scoring transactions by the issuer. All MCC codes that will be processed by a DPA should be provided here (typically, this will be a single item).\n\nAn MCC is a four-character code assigned by Mastercard to the Merchant that indicates the type of business, service, or product provided by the Merchant.\n\nNote: MCC's may be assigned differently across payment networks. To avoid errors, be sure to use your assigned Mastercard MCC. This code is required for 3-D Secure (3DS) and risk profiling. If the Merchant has more than one MCC, the code most relevant to their business should be used.\n"
    },
    "acquirerData": {
      "type": "array"
    }
  }
}