Mastercard Merchants API

openapi: 3.2.0
info:
  title: Mastercard Merchants API
  contact:
    name: API Support
    email: apisupport@mastercard.com
    url: https://developer.mastercard.com/support
  version: '1.0'
  description: 'Operations tagged Merchants across 4 of this provider''s published API definitions: mastercard-carbon-calculator-api-openapi.yml, mastercard-ethoca-merchant-self-services-openapi.yml, mastercard-installments-openapi.yml, mastercard-merchant-locations-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://sandbox.api.mastercard.com/carbon
  description: Sandbox
- url: https://api.mastercard.com/carbon
  description: Production
- url: https://api.ethocaweb.com/ethoca/merchant-self-services
  description: Production server (uses live data)
- url: https://sandbox.api.ethocaweb.com/ethoca/merchant-self-services
  description: Sandbox server (testing environment)
- url: https://sandbox.api.mastercard.com/installments
  description: Sandbox
- url: https://api.mastercard.com/installments
  description: Production
- url: https://api.mastercard.com/locations/merchants
  description: Production server
- url: https://sandbox.api.mastercard.com/locations/merchants
  description: Sandbox server
tags:
- name: Merchants
paths:
  /supported-merchant-categories:
    get:
      tags:
      - Merchants
      summary: Provide Supported MCCs
      description: Provides a list of merchant category codes supported by the application. While sending transaction data in the Transaction object, 'mcc' should be from one of the supported merchant categories. It is recommended to cache this list and use it for checking before sending transactions for footprint calculation. Generally this list doesn't change that often, but it is recommended to refresh this data every 24-hours.
      operationId: GetSupportedMerchantCategories
      responses:
        '200':
          $ref: '#/components/responses/SupportedMerchantCategories'
    servers:
    - url: https://sandbox.api.mastercard.com/carbon
      description: Sandbox
    - url: https://api.mastercard.com/carbon
      description: Production
  /sub-merchants:
    parameters:
    - $ref: '#/components/parameters/UserIdParam'
    - $ref: '#/components/parameters/SubmitterFirstNameParam'
    - $ref: '#/components/parameters/SubmitterLastNameParam'
    post:
      tags:
      - Merchants
      summary: Mastercard Create a Sub-merchant.
      description: Returns sub-merchant object with status.
      operationId: createSubMerchant
      requestBody:
        $ref: '#/components/requestBodies/SubMerchantBody'
      responses:
        '200':
          $ref: '#/components/responses/SubMerchantSuccess'
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
        default:
          $ref: '#/components/responses/Default'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://api.ethocaweb.com/ethoca/merchant-self-services
      description: Production server (uses live data)
    - url: https://sandbox.api.ethocaweb.com/ethoca/merchant-self-services
      description: Sandbox server (testing environment)
  /alerts/merchants/org-profiles:
    get:
      tags:
      - Merchants
      summary: Mastercard Get Details of Organization Profiles.
      description: Returns organization profile details containing member name, id and type.
      operationId: getAlertsOrgProfiles
      parameters:
      - $ref: '#/components/parameters/UserIdParam'
      - $ref: '#/components/parameters/SubmitterFirstNameParam'
      - $ref: '#/components/parameters/SubmitterLastNameParam'
      responses:
        '200':
          $ref: '#/components/responses/AlertsOrgProfilesSuccess'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/PermissionDenied'
        '404':
          $ref: '#/components/responses/NotFound'
        default:
          $ref: '#/components/responses/Default'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://api.ethocaweb.com/ethoca/merchant-self-services
      description: Production server (uses live data)
    - url: https://sandbox.api.ethocaweb.com/ethoca/merchant-self-services
      description: Sandbox server (testing environment)
  /merchants/participations:
    post:
      tags:
      - Merchants
      summary: Allows a registered partner to create or update merchant participation details
      description: 'This endpoint enables registered partners to manage merchant participation details, indicating whether a merchant has opted into or out of Buy Now Pay Later. A unique MAID-based merchant is identified by a combination of acquirerICA, merchantLegalName, and countryCode. <br><br> It facilitates the creation of a merchant with participation and allows updates to existing participation information, such as adding more MIDs, toggling opt-in flags, modifying address fields, and updating wallet information. <br><br> Additionally, this API supports the submission of MAID-based merchant participation,Identification of existing MID based merchants relies on acquirerICA, merchantLegalName, and countryCode and MAID based merchants relies merchantLegalName, and countryCode <br><br> If a merchant already exists, the provided MIDs will be appended to the current set.Once a MAID is entered into the system, it becomes immutable. Certain fields, namely duns cannot be modified; they must either be null, empty, or match existing values, or a 400 bad request error will be thrown. This API also allows for updating MAID base participation submitted by other acquirers. <br><br> Various markets can utilize this API to submit MAID or MID participation. For further information, please contact the Product team. <br><br> Upon successful validation and acceptance of a request, the API returns the request ID in the ''request_id'' response header, and processing occurs asynchronously. Use the GET /merchants/participation endpoint to monitor request status via the request ID. When initiating participation requests, ensure that the total payload size remains under 700 KB to avoid errors. <br><br> The field `nonMerchantNegotiatedParticipation` will be deprecated. It is recommended to utilize the `optIn` flag instead. In cases where both fields are provided, the `optIn` field will take precedence over `nonMerchantNegotiatedParticipation`. <br><br> We have introduced a new field called `merchantGroup` which is optional for other market but mandatory for markets like Australia. <br><br> Please see the table below for market/operation wise field validation: <table> <tr> <td>Market</td> <td>Mandatory In Add Operation</td> <td>Mandatory In Update Operation</td> </tr> <tr> <td>MID Market</td> <td><b>merchantLegalName</b>, <b>countryCode</b>, <b>acquirerICA</b>, <b>dbaNames</b>, <b>mids</b>, <b>optIn(or nonMerchantNegotiatedParticipation for previously onboarded customers to API)</b>  </td> <td><b>merchantLegalName</b>, <b>countryCode</b>, <b>acquirerICA</b>, <b>optIn(or nonMerchantNegotiatedParticipation for previously onboarded customers to API)</b></td> </tr> <tr> <td>Australia MID Market</td> <td><b>merchantLegalName</b>, <b>merchantGroup</b>, <b>countryCode</b>, <b>acquirerICA</b>, <b>dbaNames</b>, <b>mids</b>, <b>optIn</b>  </td> <td><b>merchantLegalName</b>, <b>countryCode</b>, <b>acquirerICA</b>, <b>optIn</b></td> </tr> <tr> <td>MAID Market</td> <td><b>merchantLegalName</b>, <b>countryCode</b>, <b>acquirerICA</b>, <b>dbaNames</b>, <b>maid</b>, <b>maidType</b>, <b>optIn</b>  </td> <td><b>merchantLegalName</b>, <b>countryCode</b>, <b>acquirerICA</b>, <b>maid</b>, <b>maidType</b>, <b>optIn</b> </td> </tr> </table>

        '
      operationId: postMerchantParticipations
      requestBody:
        $ref: '#/components/requestBodies/MerchantParticipations'
      responses:
        '202':
          $ref: '#/components/responses/MerchantParticipationReference'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/AccountNotRegisteredError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '406':
          $ref: '#/components/responses/NotAcceptableHeader'
    get:
      tags:
      - Merchants
      summary: Provides status of merchant participation updates
      description: 'Allows registered partners to fetch a list of merchants with participation details whose participation request is completed successfully. If query parameter ''request_id'' is supplied then the response will be limited to only those merchant objects with any status (PENDING, COMPLETED) that were part of that particular request. <br><br> For details on mandatory fields in response, please consult the description section of the POST: /merchants/participations endpoint. <br><br> In case of request failed error response contain `requestEndpoint`, `requestId`, `httpErrorStatusCode`, `errors.source`, `errors.reasonCode`, `errors.description` and `errors.recoverable` mandatory fields. <br><br> For previously onboarded customers to API both `nonMerchantNegotiatedParticipation` and  `optIn` will be visible. The field `nonMerchantNegotiatedParticipation` will be deprecated. <br><br> For previously onboarded customers to API both `acceptorIds` and  `maids` will be visible. The field `acceptorIds` will be deprecated.

        '
      operationId: getMerchantParticipations
      parameters:
      - $ref: '#/components/parameters/request_id'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/limit'
      responses:
        '200':
          $ref: '#/components/responses/Merchants'
        '400':
          $ref: '#/components/responses/InvalidRequestIdError'
        '401':
          $ref: '#/components/responses/AccountNotRegisteredError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/ResourceNotFoundError'
        '406':
          $ref: '#/components/responses/NotAcceptableHeader'
    servers:
    - url: https://sandbox.api.mastercard.com/installments
      description: Sandbox
    - url: https://api.mastercard.com/installments
      description: Production
  /merchants/searches:
    post:
      tags:
      - Merchants
      summary: Allows registered partners to search merchant participation information.
      description: 'Allows registered partners to search merchant objects, enabled for Acquirers and Installment Payment Providers (IPP). <br><br> Additionally, customers can search MAID merchant based on maid. <br><br> At least one parameter is required in the request. <br><br> For previously onboarded customers to API both `nonMerchantNegotiatedParticipation` and  `optIn` will be visible. The field `nonMerchantNegotiatedParticipation` will be deprecated. <br><br> For previously onboarded customers to API both `acceptorIds` and  `maids` will be visible. The field `acceptorIds` will be deprecated.

        '
      operationId: postMerchantSearches
      parameters:
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/limit'
      requestBody:
        $ref: '#/components/requestBodies/MerchantSearchParameters'
      responses:
        '200':
          $ref: '#/components/responses/MerchantSearches'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/AccountNotRegisteredError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '406':
          $ref: '#/components/responses/NotAcceptableHeader'
    servers:
    - url: https://sandbox.api.mastercard.com/installments
      description: Sandbox
    - url: https://api.mastercard.com/installments
      description: Production
  /merchants/mids/searches:
    post:
      tags:
      - Merchants
      summary: Allows registered partners (Acquirers only) to search only specific merchant participation information.
      description: 'Allows registered partners to search mids for a given merchant. A combination of `merchantLegalName`, `countryCode`, and `acquirerICA` is required in the request. <br><br> For previously onboarded customers to API both `nonMerchantNegotiatedParticipation` and  `optIn` will be visible. The field `nonMerchantNegotiatedParticipation` will be deprecated.

        '
      operationId: postMerchantMidSearches
      parameters:
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/limit'
      requestBody:
        $ref: '#/components/requestBodies/MerchantMidSearchParameters'
      responses:
        '200':
          $ref: '#/components/responses/MidDetailsPage'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/AccountNotRegisteredError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '406':
          $ref: '#/components/responses/NotAcceptableHeader'
    servers:
    - url: https://sandbox.api.mastercard.com/installments
      description: Sandbox
    - url: https://api.mastercard.com/installments
      description: Production
  /searches:
    post:
      tags:
      - Merchants
      summary: Mastercard Get a List of Merchant Details
      description: Returns detailed information on merchants based on the provided query parameters
      operationId: getMerchants
      parameters:
      - $ref: '#/components/parameters/LimitParam'
      - $ref: '#/components/parameters/OffsetParam'
      - $ref: '#/components/parameters/DistanceParam'
      - $ref: '#/components/parameters/DistanceUnitParam'
      requestBody:
        $ref: '#/components/requestBodies/MerchantSearch'
      responses:
        '200':
          $ref: '#/components/responses/Merchants_2'
        '400':
          $ref: '#/components/responses/BadRequestError_2'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError_2'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://api.mastercard.com/locations/merchants
      description: Production server
    - url: https://sandbox.api.mastercard.com/locations/merchants
      description: Sandbox server
components:
  schemas:
    SupportedMerchantCategories:
      title: SupportedMerchantCategories
      type: array
      description: List of supported merchant categories.
      minItems: 1
      maxItems: 5000
      items:
        $ref: '#/components/schemas/MerchantCategory'
    MerchantCategory:
      title: MerchantCategory
      type: object
      description: Information for a supported merchant category.
      required:
      - mcc
      - category
      properties:
        mcc:
          type: string
          maxLength: 4
          minLength: 1
          pattern: ^\d{1,4}
          description: Merchant category code of a payment transaction that uniquely defines a merchant business.
          example: '3862'
        category:
          $ref: '#/components/schemas/Category'
    X-MC-Correlation-ID:
      type: string
      example: X-MC-Correlation-ID:5e4b7f904d2820f688c67ef9fc0035
    Category:
      title: Category
      type: object
      description: User understandable information about an MCC categorization.
      properties:
        mainCategory:
          title: mainCategory
          type: string
          description: Main category to which an MCC belongs.
          minLength: 5
          maxLength: 100
          pattern: ^[\w\-\_\&\,]+[\w\-\_\&\,\ ]{5,100}
          example: Shopping
        subCategory:
          title: subCategory
          type: string
          description: Sub-category of a category to which an MCC belongs.
          minLength: 5
          maxLength: 100
          pattern: ^[\w\-\_\&\,]+[\w\-\_\&\,\ ]{5,100}
          example: Department Store
        sector:
          title: sector
          type: string
          description: Sector of a category to which an MCC belongs.
          minLength: 5
          maxLength: 100
          pattern: ^[\w\-\_\&\,]+[\w\-\_\&\,\ ]{5,100}
          example: Specialty Retail & Services
        sectorCode:
          title: sectorCode
          type: string
          description: Unique code assigned to each sector.
          minLength: 3
          maxLength: 3
          pattern: ^\d{3}
          example: '302'
    ErrorResponse:
      required:
      - Errors
      type: object
      properties:
        Errors:
          $ref: '#/components/schemas/Errors'
      description: Error Response object
    CountryCode:
      title: Country Code
      maxLength: 3
      minLength: 3
      type:
      - string
      - 'null'
      description: The [ISO 3166-1](https://www.iso.org/obp/ui/#search) alpha-3 compliant country code.
      example: CAN
    LocationCount:
      title: Merchant Location count
      type: integer
      default: 0
      example: 15
      minimum: 0
      maximum: 9999999
    CardAcceptor:
      title: Merchant Card Acceptor
      maxLength: 50
      minLength: 1
      type: string
      description: Merchant Card Acceptor
      example: ETHOCA NINJA GAMES
    CardTypes:
      title: Card Types
      type: array
      minItems: 1
      maxItems: 4
      uniqueItems: true
      description: A list of all of the card types that are accepted as a form of payment.
      items:
        type: string
        description: Type of card used for a transaction
        example: AMEX
        enum:
        - AMEX
        - DISCOVER
        - MC
        - VISA
    Locale:
      required:
      - merchantDescription
      - code
      - defaultLocale
      type: object
      properties:
        code:
          title: Code
          type: string
          description: The locale where the merchant anticipates their business to be located; often referred to as the Accept-Language in HTTP headers.
          example: EN_CA
          enum:
          - EN_US
          - EN_CA
          - EN_GB
          - ES_MX
          - ES_ES
          - ES_US
          - FR_CA
          - FR_FR
          - PT_BR
          - PT_PT
          - HE_IL
        merchantDescription:
          title: Merchant Description
          maxLength: 4000
          minLength: 1
          type: string
          description: Description of the primary merchant tied to the transaction and responsible for providing the products or services (description of the business, what they do, markets, etc.). Used to help cardholder understand business responsible for the charge.
          example: An airline that no longer exists.
        defaultLocale:
          title: Default Locale
          type: boolean
          description: This indicates whether or not this locale will be used as the default locale for displaying information to the customer.
          example: true
      description: Merchant Locale details
    TermsConditionsConsent:
      title: Terms & conditions consent
      type: object
      required:
      - date
      - firstName
      - lastName
      - jobTitle
      - email
      - countryCode
      - consentUuid
      - consentVersion
      properties:
        date:
          type: string
          description: Date stamp in which the sub-merchant provided his consent on the terms and conditions. Date must be in [ISO 8601 format](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6)
          format: date-time
          example: '2021-10-18T13:56:47.123+00:00'
        firstName:
          type: string
          minLength: 1
          maxLength: 50
          description: First name of person that gave consent
          example: John
        lastName:
          type: string
          minLength: 1
          maxLength: 50
          description: Last name of person that gave consent
          example: Doe
        jobTitle:
          type: string
          minLength: 1
          maxLength: 100
          description: Job title of person that gave consent
          example: Manager
        email:
          $ref: '#/components/schemas/Email'
        countryCode:
          $ref: '#/components/schemas/CountryCode'
        consentUuid:
          type: string
          minLength: 1
          maxLength: 50
          description: Universally Unique Identifier (UUID) of the consent that the user consented to
          example: 3d94ab7b-fe1c-4f7d-ad4c-93c1eb6d29c3
        consentVersion:
          type: string
          minLength: 1
          maxLength: 8
          description: Version of the consent that the user consented to
          example: '1.0'
    UserId:
      title: User Id
      maxLength: 300
      minLength: 1
      type: string
      description: The user id of the submitter/technical contact.
      example: princess.diana
    FirstPartyTrustEnrollmentResource:
      title: First Party Trust Enrollment Resource
      type: object
      required:
      - enrollmentType
      properties:
        enrollmentType:
          minLength: 1
          maxLength: 50
          type: string
          description: Type of First Party Trust Enrollment
          example: CLARITY
    FirstPartyTrustEnrollmentType:
      title: First Party Trust Enrollment Types
      type: string
      description: Type of First Party Trust Enrollment
      example: CLARITY
      enum:
      - CLARITY
      - ISSM
    Address:
      title: Address
      description: Address entity associated to merchant's location and legal address.
      required:
      - countryCode
      allOf:
      - $ref: '#/components/schemas/ShortAddress'
      - properties:
          website:
            title: Website
            maxLength: 500
            minLength: 1
            type:
            - string
            - 'null'
            description: URL for merchant's website
            example: https://merchantwebsite.example.com
          email:
            $ref: '#/components/schemas/Email'
          phone:
            title: Phone
            maxLength: 30
            minLength: 3
            type:
            - string
            - 'null'
            description: Phone number of the merchant's office
            example: 1-234-567-9999
    MerchantName:
      title: Merchant's Name
      maxLength: 200
      minLength: 3
      type: string
      description: Merchant's partial or full name.
      example: Merchant 1
    LocationWithoutCardAcceptors:
      type: object
      required:
      - countryCode
      allOf:
      - $ref: '#/components/schemas/Address'
      - properties:
          website:
            title: Website
            maxLength: 100
            minLength: 1
            type:
            - string
            - 'null'
            description: URL for merchant's customer service focused information.
            example: https://merchantwebsite.example.com/customerservice.html
          email:
            $ref: '#/components/schemas/ShortEmail'
          contactWebsite:
            title: Contact Website
            maxLength: 100
            minLength: 1
            type:
            - string
            - 'null'
            description: Merchant's contact website.
            example: https://merchantwebsite.example.com/contactus.html
          displayAddressToCardHolder:
            title: Display Address To Card Holder
            type:
            - boolean
            - 'null'
            description: Set true to display this location's address to card holder
            example: true
          displayPhoneToCardHolder:
            title: Display Phone To Card Holder
            type:
            - boolean
            - 'null'
            description: Set true to display this location's phone number to card holder
            example: true
          refundPolicy:
            title: Refund Policy
            maxLength: 1500
            minLength: 1
            type:
            - string
            - 'null'
            description: Entire merchant refund policy, formatted for text display
            example: Complete merchant refund policy
          terms:
            title: Terms and Conditions
            maxLength: 2000
            minLength: 1
            type:
            - string
            - 'null'
            description: Entire merchant Terms & Conditions, formatted for text display
            example: Entire merchant Terms & Conditions
          customerServiceInstructions:
            title: Customer Service Information
            maxLength: 500
            minLength: 1
            type:
            - string
            - 'null'
            description: Free form text displayed to issuer that can be sent to the cardholder. Can be specific to transaction.
            example: Include Transaction ID in all communications.
          additionalInfo:
            title: Additional Info
            maxLength: 1500
            minLength: 1
            type:
            - string
            - 'null'
            description: Additional information that a merchant would want a customer or Issuer to know in regards to a transaction.
            example: Customers can contact merchants for a refund 24 hours a day.
          termsWebsite:
            title: Merchant Terms Website
            maxLength: 255
            minLength: 1
            type:
            - string
            - 'null'
            description: Merchant terms website URL
            example: https://merchantwebsite.example.com/terms.html
          refundPolicyWebsite:
            title: Merchant Refund Policy Website
            maxLength: 255
            minLength: 1
            type:
            - string
            - 'null'
            description: Merchant refund policy website URL
            example: https://merchantwebsite.example.com/refunds.html
          defaultLocation:
            title: Default Location
            type: boolean
            description: true if this is a default location of a merchant
            example: true
          cardAcceptorLocation:
            title: Card Acceptor Location
            maxLength: 150
            minLength: 1
            type:
            - string
            - 'null'
            description: Card Acceptor Location
            example: Pan American Airlines Canada
          cardAcceptorLocationType:
            title: Card Acceptor Location Type
            type:
            - string
            - 'null'
            description: Types of card acceptor location - ONLINE, PHONE, CARD_PRESENT
            example: CARD_PRESENT
            enum:
            - ONLINE
            - PHONE
            - CARD_PRESENT
        description: Merchant location details
    SubMerchant:
      description: Schema for a sub-merchant
      allOf:
      - $ref: '#/components/schemas/Merchant'
      - type: object
        required:
        - subMerchantIdentifier
        properties:
          subMerchantIdentifier:
            $ref: '#/components/schemas/SubMerchantIdentifier'
          searchFields:
            $ref: '#/components/schemas/SearchFields'
    SearchFieldsResource:
      title: Search Fields Response
      type:
      - array
      - 'null'
      description: Search Field
      items:
        $ref: '#/components/schemas/SearchFieldResource'
    Error:
      type: object
      properties:
        Source:
          maxLength: 100
          minLength: 0
          type:
          - string
          - 'null'
          description: Source of the error
          example: Service
        ReasonCode:
          maxLength: 100
          minLength: 0
          type:
          - string
          - 'null'
          description: A unique constant identifying the error
          example: format.invalid
        Description:
          maxLength: 1000
          minLength: 0
          type:
          - string
          - 'null'
          description: Short description of the error
          example: Short description of the error
        Recoverable:
          type:
          - boolean
          - 'null'
          description: Indicates whether this error will always be returned for this request, or retrying could change the outcome
          example: false
          default: false
        Details:
          maxLength: 1000
          minLength: 0
          type:
          - string
          - 'null'
          description: Optional detailed description of the issue
          example: Detailed description of the error
      description: Error object
    Errors:
      required:
      - Error
      type: object
      properties:
        Error:
          type: array
          description: List of error objects
          items:
            $ref: '#/components/schemas/Error'
          example: []
      description: Errors object
    CardTypesResource:
      title: Card Types Response
      type: array
      uniqueItems: true
      description: A list of all of the card types that are accepted as a form of payment.
      items:
        type: string
        description: Type of card used for a transaction
        example: AMEX
    ResourceId:
      type:
      - string
      - 'null'
      minLength: 1
      maxLength: 40
      description: Unique identifier of resource
      example: Mxyz123
    Merchant:
      description: Base merchant request schema
      required:
      - merchantType
      - locales
      - businessType
      allOf:
      - $ref: '#/components/schemas/BaseMerchant'
      - type: object
        properties:
          merchantType:
            title: Merchant Type
            type: string
            description: 'Type of a merchant. Allowed Values -

              + SUB_MERCHANT -

              + DIRECT -

              + GATEWAY - '
            example: SUB_MERCHANT
            enum:
            - SUB_MERCHANT
            - DIRECT
            - GATEWAY
          locales:
            title: Merchant Locales
            minItems: 1
            maxItems: 10
            uniqueItems: true
            type: array
            description: Merchant Locales
            items:
              $ref: '#/components/schemas/Locale'
          locations:
            title: Merchant Locations
            minItems: 0
            maxItems: 50
            uniqueItems: true
            type:
            - array
            - 'null'
            description: Merchant Locations
            deprecated: true
            items:
              $ref: '#/components/schemas/Location'
          contentTypes:
            title: Content Types
            uniqueItems: true
            type:
            - array
            - 'null'
            description: An indicator as to the type of products and services you offer.
            example:
            - ADULT_LANGUAGE
            items:
              type: string
              enum:
              - ADULT_LANGUAGE
              - ADULT_PRODUCTS
              - ADULT_SERVICES
              - GAMBLING
              - ONLINE_DATING
              - OTHER
          crm:
            $ref: '#/components/schemas/Crm'
          businessType:
            title: Merchant Business Type
            type: string
            description: Business type describes the legal structure under which the business operates
            example: BUSINESS_CORPORATION
            enum:
            - SOLE_PROPRIETORSHIP
            - BUSINESS_CORPORATION
            - OTHER
          firstPartyTrustEnrollments:
            title: First Party Trust Enrollments
            description: A list of First Party Trust Enrollments
            type:
            - array
            - 'null'
            minLength: 0
            maxLength: 2
            uniqueItems: true
            items:
              $ref: '#/components/schemas/FirstPartyTrustEnrollment'
    AlertsMerchantMemberId:
      title: Unique identifier for merchants
      description: Internal Universally Unique Identifier (UUID) which uniquely identifies the merchants
      type: string
      format: uuid
      example: 99ca4b15-72a6-41dd-8127-573d4b07669c
    MerchantGuid:
      title: Merchant GUID
      maxLength: 16
      minLength: 11
      type: string
      description: Consumer Clarity internal merchant's GUID
      example: jK2dA5aybhQQBq6C
    ShortEmail:
      title: Email Address
      maxLength: 100
      minLength: 1
      type:
      - string
      - 'null'
      description: Email address
      example: john.doe@example.com
      format: email
    CardAcceptors:
      title: Merchant Card Acceptors
      maxItems: 1500
      type:
      - array
      - 'null'
      uniqueItems: true
      description: List of merchant card acceptors

# --- truncated at 32 KB (125 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mastercard/refs/heads/main/openapi/mastercard-merchants-api-openapi.yml