Mastercard

Mastercard Guid API

The Guid API from Mastercard — 15 operation(s) for guid.

Documentation GitHub OpenAPI

Operations 12

PUT /merchants/{guid}/logos Mastercard Update a Logo for an Existing Merchant. #

POST /merchants/{guid}/logos Mastercard Create a Logo for an Existing Merchant. #

DELETE /merchants/{guid}/logos Mastercard Delete a Logo for an Existing Merchant. #

GET /merchants/{guid}/logos Mastercard Get the Logo for an Existing Merchant. #

PUT /sub-merchants/{guid} Mastercard Update a Sub-merchant. #

GET /sub-merchants/{guid} Mastercard Get Sub-merchant by Guid. #

PUT /sub-merchants/{guid}/states Mastercard Activate/deactivate a Sub-merchant. #

POST /sub-merchants/{guid}/locations Mastercard Add a Unique Set of Sub-merchant's Locations #

GET /sub-merchants/{guid}/locations Mastercard Get Sub-merchant's Locations #

GET /sub-merchants/{guid}/locations/{location_id} Mastercard Get Location by Id #

PUT /sub-merchants/{guid}/locations/{location_id} Mastercard Update an Existing Location #

DELETE /sub-merchants/{guid}/locations/{location_id} Mastercard Delete an Existing Location #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/mastercard-guid-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Mastercard Ethoca Merchant Self Services Guid API
  description: The Ethoca Merchant Self Services API lets you enter your merchant details for your organization, including for all of your submerchants. Using the Merchant Self Services API helps you onboard and integrate your company and all of your submerchants as quickly as possible.
  contact:
    name: API Support
    email: apisupport@mastercard.com
    url: https://developer.mastercard.com/support
  version: 1.6.0
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)
tags:
- name: Guid
paths:
  /merchants/{guid}/logos:
    parameters:
    - $ref: '#/components/parameters/UserIdParam'
    - $ref: '#/components/parameters/SubmitterFirstNameParam'
    - $ref: '#/components/parameters/SubmitterLastNameParam'
    - $ref: '#/components/parameters/MerchantGuidParam'
    put:
      tags:
      - Guid
      summary: Mastercard Update a Logo for an Existing Merchant.
      description: Returns status and messages (if any validation failures) related to the logo of a sub-merchant.
      operationId: updateMerchantLogoByGuid
      requestBody:
        $ref: '#/components/requestBodies/MerchantLogoBody'
      responses:
        '200':
          $ref: '#/components/responses/LogoSuccess'
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
        default:
          $ref: '#/components/responses/Default'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      tags:
      - Guid
      summary: Mastercard Create a Logo for an Existing Merchant.
      description: Returns status and messages (if any validation failures) related to the logo of a sub-merchant.
      operationId: createMerchantLogo
      requestBody:
        $ref: '#/components/requestBodies/MerchantLogoBody'
      responses:
        '200':
          $ref: '#/components/responses/LogoSuccess'
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
        default:
          $ref: '#/components/responses/Default'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      tags:
      - Guid
      summary: Mastercard Delete a Logo for an Existing Merchant.
      description: Returns 204 status code if logo deleted successfully.
      operationId: deleteLogoByMerchantGuid
      responses:
        '204':
          $ref: '#/components/responses/SuccessWithoutBody'
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
        default:
          $ref: '#/components/responses/Default'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    get:
      tags:
      - Guid
      summary: Mastercard Get the Logo for an Existing Merchant.
      description: Returns base64 encoded image, status and messages (if any validation failures) related to the logo of a sub-merchant.
      operationId: getLogoByMerchantGuid
      responses:
        '200':
          $ref: '#/components/responses/LogoSuccessWithImage'
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
        default:
          $ref: '#/components/responses/Default'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /sub-merchants/{guid}:
    put:
      tags:
      - Guid
      summary: Mastercard Update a Sub-merchant.
      description: Returns sub-merchant object with status.
      operationId: updateSubMerchant
      parameters:
      - $ref: '#/components/parameters/UserIdParam'
      - $ref: '#/components/parameters/SubmitterFirstNameParam'
      - $ref: '#/components/parameters/SubmitterLastNameParam'
      - $ref: '#/components/parameters/IfMatch'
      - $ref: '#/components/parameters/MerchantGuidParam'
      requestBody:
        $ref: '#/components/requestBodies/SubMerchantBody'
      responses:
        '200':
          $ref: '#/components/responses/SubMerchantSuccess'
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
        '412':
          $ref: '#/components/responses/PreconditionFailed'
        '428':
          $ref: '#/components/responses/PreconditionRequired'
        default:
          $ref: '#/components/responses/Default'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    get:
      tags:
      - Guid
      summary: Mastercard Get Sub-merchant by Guid.
      description: Returns sub-merchant object with status.
      operationId: getSubMerchantByGuid
      parameters:
      - $ref: '#/components/parameters/UserIdParam'
      - $ref: '#/components/parameters/SubmitterFirstNameParam'
      - $ref: '#/components/parameters/SubmitterLastNameParam'
      - $ref: '#/components/parameters/MerchantGuidParam'
      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
  /sub-merchants/{guid}/states:
    parameters:
    - $ref: '#/components/parameters/UserIdParam'
    - $ref: '#/components/parameters/SubmitterFirstNameParam'
    - $ref: '#/components/parameters/SubmitterLastNameParam'
    - $ref: '#/components/parameters/MerchantGuidParam'
    put:
      tags:
      - Guid
      summary: Mastercard Activate/deactivate a Sub-merchant.
      description: "Returns 204 if merchant is activated/deactivated successfully. It takes a state attribute with two possible values:\n\n  - INACTIVE\n    - For LIVE and LOCKED_FOR_EDIT merchants, this endpoint changes the merchant to INACTIVE status.\n    - For CONFIGURATION merchants, it physically deletes the merchant, rather than deactivating it.\n\n  - ACTIVE\n    - Reactivates an INACTIVE merchant by placing it in CONFIGURATION status. From there, the flow follows the onboarding process where the merchant is in CONFIGURATION status and its attributes\nare available for editing."
      operationId: changeSubMerchantState
      requestBody:
        $ref: '#/components/requestBodies/ChangeSubMerchantStateBody'
      responses:
        '204':
          $ref: '#/components/responses/SuccessWithoutBody'
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
        default:
          $ref: '#/components/responses/Default'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /sub-merchants/{guid}/locations:
    parameters:
    - $ref: '#/components/parameters/UserIdParam'
    - $ref: '#/components/parameters/SubmitterFirstNameParam'
    - $ref: '#/components/parameters/SubmitterLastNameParam'
    - $ref: '#/components/parameters/MerchantGuidParam'
    post:
      tags:
      - Guid
      summary: Mastercard Add a Unique Set of Sub-merchant's Locations
      description: Creates locations under an existing sub-merchant
      operationId: addLocations
      requestBody:
        $ref: '#/components/requestBodies/LocationsBulkRequestBody'
      responses:
        '200':
          $ref: '#/components/responses/LocationsBulkSuccess'
        '400':
          $ref: '#/components/responses/BadRequest'
        default:
          $ref: '#/components/responses/Default'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    get:
      parameters:
      - $ref: '#/components/parameters/ClarityOffsetParam'
      - $ref: '#/components/parameters/ClarityPageNumberParam'
      - $ref: '#/components/parameters/ClaritySortDirectionParam'
      - $ref: '#/components/parameters/ClaritySortFieldParam'
      - $ref: '#/components/parameters/LocationSearchTextQueryParam'
      summary: Mastercard Get Sub-merchant's Locations
      description: Returns sub-merchant's locations with pagination metadata
      operationId: getAllLocations
      tags:
      - Guid
      responses:
        '200':
          $ref: '#/components/responses/PageableLocationsSuccess'
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
        default:
          $ref: '#/components/responses/Default'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /sub-merchants/{guid}/locations/{location_id}:
    get:
      summary: Mastercard Get Location by Id
      description: Returns location object
      operationId: getLocationById
      parameters:
      - $ref: '#/components/parameters/UserIdParam'
      - $ref: '#/components/parameters/SubmitterFirstNameParam'
      - $ref: '#/components/parameters/SubmitterLastNameParam'
      - $ref: '#/components/parameters/MerchantGuidParam'
      - $ref: '#/components/parameters/LocationIdParam'
      tags:
      - Guid
      responses:
        '200':
          $ref: '#/components/responses/LocationSuccess'
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
        default:
          $ref: '#/components/responses/Default'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      summary: Mastercard Update an Existing Location
      description: Updates a location object
      operationId: updateLocation
      tags:
      - Guid
      parameters:
      - $ref: '#/components/parameters/UserIdParam'
      - $ref: '#/components/parameters/SubmitterFirstNameParam'
      - $ref: '#/components/parameters/SubmitterLastNameParam'
      - $ref: '#/components/parameters/MerchantGuidParam'
      - $ref: '#/components/parameters/LocationIdParam'
      - $ref: '#/components/parameters/IfMatch'
      requestBody:
        $ref: '#/components/requestBodies/LocationBody'
      responses:
        '200':
          $ref: '#/components/responses/LocationSuccess'
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
        default:
          $ref: '#/components/responses/Default'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      summary: Mastercard Delete an Existing Location
      description: Returns 204 status code if Location deleted successfully
      operationId: deleteLocation
      parameters:
      - $ref: '#/components/parameters/UserIdParam'
      - $ref: '#/components/parameters/SubmitterFirstNameParam'
      - $ref: '#/components/parameters/SubmitterLastNameParam'
      - $ref: '#/components/parameters/MerchantGuidParam'
      - $ref: '#/components/parameters/LocationIdParam'
      tags:
      - Guid
      responses:
        '204':
          $ref: '#/components/responses/SuccessWithoutBody'
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
        default:
          $ref: '#/components/responses/Default'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    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
    ResponseHeader:
      type: object
      properties:
        totalRecords:
          type: integer
          format: int64
          description: Total number of records found
          minimum: 0
          maximum: 999999999
          example: 500
        totalPages:
          type: integer
          description: Total number of pages based on limit
          minimum: 0
          maximum: 999999999
          example: 10
        currentPage:
          type: integer
          description: The current page number
          minimum: 1
          maximum: 999999999
          example: 2
        responseTime:
          $ref: '#/components/schemas/ResponseTime'
    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
    ImageBase64Encoded:
      title: Image Base 64 Encoded
      type: string
      description: Base 64 encoded image (JPG or PNG)
      minLength: 0
      maxLength: 999999999
      example: /9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAIBAQIBAQICAgICAgICAwUDAwMDAwYEBAMFBwYHBwcGBwcICQsJCAgKCAcHCg0KCgsMDAwMBwkODw0MDgsMDAz/2wBDAQICAgMDAwYDAwYMCAcIDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAz/wAARCAAQABADASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEAAwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL/8QAtREAAgECBAQDBAcFBAQAAQJ3AAECAxEEBSExBhJBUQdhcRMiMoEIFEKRobHBCSMzUvAVYnLRChYkNOEl8RcYGRomJygpKjU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6goOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK0tPU1dbX2Nna4uPk5ebn6Onq8vP09fb3+Pn6/9oADAMBAAIRAxEAPwD638d/8HA2uah8em0jwP4L0W+8JxXZt459QmlW6vo1PMoKnbGCASAVY4xn0r6L+F//AAUzn8XatY3Op6HZ22h37AFoXYzWoJxkk8NjvgCvmXx1/wAG/wD4s0X4+HU/A3izw7D4RkuzPEuoiUXVjExOYtqqVkwCQDuXPGcV9JfCz/gmbf8AhTVrGz1TWbCbQ7BgWMAbzroA5IwQAue/JxnvX4TxVPjz63R/slO3Nr8HL/29fXltb8etj+puKKfhUsBR/spxvya6z59vtX0579vP7Nj/2Q==
    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
    ClarityResponseHeader:
      allOf:
      - $ref: '#/components/schemas/ResponseHeader'
      - type: object
        properties:
          currentPage:
            type: integer
            description: Current page
            minimum: 0
            maximum: 999999999
            example: 2
    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
    LogoResource:
      type: object
      required:
      - status
      properties:
        status:
          title: Status
          maxLength: 100
          minLength: 1
          type: string
          description: Status of the logo
          example: ACTIVE
        messages:
          title: Messages
          type:
          - array
          - 'null'
          description: List of validation messages for a logo.
          items:
            maxLength: 200
            minLength: 1
            type: string
            example: Logo under review
          example: []
      description: Schema for a sub-merchant logo status
    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'
    MerchantLogo:
      required:
      - imageBase64Encoded
      type: object
      properties:
        imageBase64Encoded:
          $ref: '#/components/schemas/ImageBase64Encoded'
      description: logo request schema for merchants
    MerchantGuid:
      title: Merchant GUID
      maxLength: 16
      minLength: 11
      type: string
      description: Consumer Clarity internal merchant's GUID
      example: jK2dA5aybhQQBq6C
    LocationWithoutCardAcceptorsResource:
      type: object
      allOf:
      - $ref: '#/components/schemas/LocationWithoutCardAcceptors'
      - properties:
          id:
            $ref: '#/components/schemas/ResourceId'
          cardAcceptorLocationType:
            title: Card Acceptor Location Type
            type:
            - string
            - 'null'
            description: Types of card acceptor location - ONLINE, PHONE, CARD_PRESENT
            example: ONLINE
    ShortEmail:
      title: Email Address
      maxLength: 100
      minLength: 1
      type:
      - string
      - 'null'
      description: Email address
      example: john.doe@example.com
      format: email
    ResponseTime:
      type: string
      description: Total response time in ms
      minLength: 0
      maxLength: 10
      example: 300 ms
    LocationsBulk:
      type: object
      required:
      - locations
      properties:
        locations:
          minItems: 1
          maxItems: 25
          type: array
          uniqueItems: true
          description: Set of Merchant Locations
          items:
            $ref: '#/components/schemas/LocationWithoutCardAcceptors'
          example: []
    CardAcceptors:
      title: Merchant Card Acceptors
      maxItems: 1500
      type:
      - array
      - 'null'
      uniqueItems: true
      description: List of merchant card acceptors
      items:
        $ref: '#/components/schemas/CardAcceptor'
    SanctionScreening:
      title: Sanction Screening
      type: object
      required:
      - taxId
      - publiclyTraded
      - doBusinessWithSanctionedGeographies
      properties:
        taxId:
          title: Tax Identification
          description: Known as VAT Number in the US and GST in Canada.
          example: 123456789AB1234
          type: string
          minLength: 1
          maxLength: 30
        formerLegalNames:
          title: List of Former Legal Names
          description: The merchant's former legal names
          uniqueItems: true
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/MerchantName'
          example: []
        doBusinessWithSanctionedGeographies:
          title: Business With Sanctioned Geographies Indicator
          description: 'Indicates whether the merchant does business with sanctioned geographies.

            If it is true, then sanctionedGeographies property can''t be empty.

            '
          type: boolean
          example: false
        sanctionedGeographies:
          title: List of Sanctioned Geograp

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

Mastercard Guid API

Operations 12

Documentation

Specifications

Code Examples

Other Resources