Mastercard Apis API

openapi: 3.2.0
info:
  title: Mastercard Ethoca Consumer Clarity for Merchant Transactions APIS API
  description: Ethoca's Consumer Clarity for Merchant Transactions brokers order information between an organization and an issuer or an organization and their customer. As a result, issuers are connected to merchant order and account history details in real time, which helps reduce disputes and friendly fraud.
  termsOfService: https://www.ethocaweb.com/consumerclarity/assets/static/termsOfUse.html
  contact:
    name: Consumer Clarity Support
    email: productintegration@ethoca.com
  license:
    name: Copyright (c) 2023 Ethoca Limited. All Rights Reserved.
    url: https://www.ethoca.com/terms-of-use
  version: 4.2.0
servers:
- url: https://sandbox.api.ethocaweb.com/
  description: Ethoca Sandbox Test url.
- url: https://mtf.api.ethocaweb.com/
  description: Ethoca Mtf url.
- url: https://api.ethocaweb.com/
  description: Ethoca prod url.
tags:
- name: Apis
paths:
  /api/orders:
    post:
      tags:
      - Apis
      summary: Searches order details based on the search criteria
      description: Search for orders based on transaction fields that you currently support
      operationId: getTransactionDetails
      parameters:
      - $ref: '#/components/parameters/eth_date'
      - $ref: '#/components/parameters/authorization'
      requestBody:
        $ref: '#/components/requestBodies/OrderApi'
      responses:
        '200':
          $ref: '#/components/responses/OrderApiAcknowledgement'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '405':
          $ref: '#/components/responses/MethodNotAllowed'
  /api/orders/healthchecks:
    get:
      tags:
      - Apis
      operationId: getHealthDetails
      description: Health or Echo or Heartbeat endpoint ensuring that the API is running
      summary: Health endpoint to ensure confirm connectivity to transaction API
      responses:
        '200':
          $ref: '#/components/responses/HealthCheckResponse'
components:
  responses:
    HealthCheckResponse:
      description: "The code indicates the response.\n  - OK = The API is up and running\n  - failure = The API is not running"
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/HealthCheckResponse'
    Forbidden:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            ForbiddenExample:
              $ref: '#/components/examples/ForbiddenExample'
    MethodNotAllowed:
      description: Method Not Allowed
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            MethodNotAllowedExample:
              $ref: '#/components/examples/MethodNotAllowedExample'
    OrderApiAcknowledgement:
      description: The response object Merchant API returns
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/OrderApiAcknowledgement'
    BadRequest:
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            BadRequestExample:
              $ref: '#/components/examples/BadRequestExample'
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            UnauthorizedExample:
              $ref: '#/components/examples/UnauthorizedExample'
  schemas:
    Order:
      type: object
      description: Contains items, payments, transaction details, shipping, and other information related to the order (purchase)
      required:
      - merchantOrderId
      - orderDateTime
      - subtotal
      - total
      - currencyCode
      - orderItems
      properties:
        merchantOrderId:
          minLength: 1
          maxLength: 50
          type: string
          description: Merchant's internal order tracking number
          example: 765656JCHJDJ898HYJY90
        orderDateTime:
          type: string
          minLength: 20
          maxLength: 20
          description: The date and time the order was made (String based date/time representation in International Date Time Format (ISO 8601) in UTC - yyyy-mm-ddThh:mm:ssZ)
          format: date-time
          example: '2017-06-19T13:18:18Z'
        orderStatus:
          type: string
          minLength: 5
          maxLength: 18
          description: "Status of the order\n\nAllowed values:\n  - Open_Pending\n  - Open_PendingReturn\n  - Closed_Complete\n  - Closed_Canceled\n  - Other\n"
          example: Closed_Canceled
        orderStatusOther:
          minLength: 1
          maxLength: 50
          type: string
          description: Order status description if -Other- is provided
          example: Unidentified
        orderEmail:
          minLength: 1
          maxLength: 200
          type: string
          description: Customer email address for the order/transaction. This is not the account email.
          example: onetwothree@example.com
        orderPhone:
          minLength: 3
          maxLength: 30
          type: string
          description: Customer phone number for the order, if different from the billing phone number. Include the country code and any applicable separators
          example: +91 99898989800
        relationshipToAccountHolder:
          minLength: 1
          maxLength: 45
          type: string
          description: Customer relationship to account holder (if different)
          example: Spouse
        subtotal:
          type: string
          minLength: 1
          maxLength: 12
          description: Order subtotal. Total amount of all products purchased in this order, not including tax and shipping. The maximum number of fractional digits supported is 2.
          example: '7878.98'
        shippingHandling:
          type: string
          minLength: 1
          maxLength: 12
          description: Total cost of shipping and handling for the order. If several different shipping and handling fees, summarize into one field.
          example: '898.9'
        tax:
          type: string
          minLength: 1
          maxLength: 12
          description: Total amount of tax. Maximum number of fractional digits supported is 2.
          example: '13.78'
        total:
          type: string
          minLength: 1
          maxLength: 12
          description: Total amount of the order, including tax and shipping. Maximum number of fractional digits supported is 2.
          example: '8898.9'
        refundTotal:
          type: string
          minLength: 1
          maxLength: 12
          description: Total amount of all refunds that have been issued for this purchase.
          example: '20.21'
        currencyCode:
          $ref: '#/components/schemas/CurrencyCode'
        specialInstructions:
          minLength: 1
          maxLength: 2000
          type: string
          description: Any special instructions requested at time of order
          example: Handle with care.
        communications:
          minLength: 1
          maxLength: 1000
          type: string
          description: Provide additional communications between consumer and merchant
          example: Any further info needed.
        proofOfConsent:
          minLength: 1
          maxLength: 500
          type: string
          description: Allows merchant to describe when and how the customer agreed to the terms and conditions at checkout
          example: Signed the Terms & Conditions document at office.
        refundEligible:
          type: boolean
          description: Indicates whether the transaction is eligible for a refund
          example: true
        orderRecipientName:
          $ref: '#/components/schemas/NameType'
        storeAddress:
          $ref: '#/components/schemas/AddressType'
        orderItems:
          type: array
          description: List of items (products) included in the order (requires at least one, may repeat)
          items:
            $ref: '#/components/schemas/OrderItem'
        transactionDetails:
          $ref: '#/components/schemas/TransactionDetails'
        payments:
          type: array
          description: List of payments for the order (requires at least one, may repeat)
          items:
            $ref: '#/components/schemas/Payment'
        creditReimbursements:
          type: array
          description: List of credits for the order
          items:
            $ref: '#/components/schemas/CreditReimbursement'
        refunds:
          type: array
          description: List of refunds made for the order
          items:
            $ref: '#/components/schemas/Refund'
        taxItems:
          type: array
          description: List of taxes applied to the order (requires at least one, may repeat)
          items:
            $ref: '#/components/schemas/Tax'
        discounts:
          type: array
          description: List of discounts applied to the order
          items:
            $ref: '#/components/schemas/Discount'
        deliveries:
          type: array
          description: List of deliveries created for the order
          items:
            $ref: '#/components/schemas/Delivery'
        reservations:
          type: array
          description: List of reservations created for the order
          items:
            $ref: '#/components/schemas/Reservation'
        loyalties:
          type: array
          description: List of loyalty membership accounts that relate to the order
          items:
            $ref: '#/components/schemas/Loyalty'
        customData:
          type: array
          description: custom data that can be part of Order
          items:
            $ref: '#/components/schemas/CustomData'
        callToActionLinks:
          type: array
          description: Call to Action Links for merchants
          items:
            $ref: '#/components/schemas/CallToActionLink'
    ErrorResponse:
      required:
      - Errors
      type: object
      properties:
        Errors:
          $ref: '#/components/schemas/Errors'
      description: Error response object
    Lodging:
      type: object
      required:
      - lodgingCompanyName
      - confirmationNumber
      - stayDuration
      - roomsBooked
      - checkInDateTime
      - checkoutDateTime
      properties:
        lodgingCompanyName:
          minLength: 1
          maxLength: 100
          type: string
          description: The name of the property
          example: Mantle Lodging and Hotels
        confirmationNumber:
          minLength: 1
          maxLength: 50
          type: string
          description: The confirmation number at the property
          example: CT67Y01
        roomType:
          minLength: 1
          maxLength: 20
          type: string
          description: The type of room booked
          example: Suite
        stayDuration:
          type: integer
          minimum: 0
          maximum: 99999
          description: The room stay duration (in days)
          format: int32
          example: 15
        roomsBooked:
          type: integer
          minimum: 0
          maximum: 99999
          description: The number of rooms that were booked
          format: int32
          example: 1
        lodgingPrice:
          type: string
          minLength: 1
          maxLength: 12
          example: '199.99'
          description: The cost of a nightly rate for a lodging rental. If there are multiple prices over different nights, you may use an average.
        checkInDateTime:
          type: string
          minLength: 20
          maxLength: 20
          description: The date and time the guest will check in to the property (String based date/time representation in International Date Time Format (ISO 8601) in UTC - yyyy-mm-ddThh:mm:ssZ)
          format: date-time
          example: '2017-06-19T13:18:18Z'
        lodgingTimezone:
          type: string
          minLength: 1
          maxLength: 50
          description: The timezone of the lodging's location. This is not the timezone of the property's corporate office, but rather the specific location of the property that is being booked as it appears in the TZ database.
          example: America/New_York
        actualCheckInDateTime:
          type: string
          minLength: 20
          maxLength: 20
          description: The actual date and time the guest checked in to the property (String based date time representation in International Date Time Format (ISO 8601) in UTC - yyyy-mm-ddThh:mm:ssZ)
          format: date-time
          example: '2017-06-19T13:18:18Z'
        checkoutDateTime:
          type: string
          minLength: 20
          maxLength: 20
          description: The date and time the guest will check out of the property (String based date/time representation in International Date Time Format (ISO 8601) in UTC - yyyy-mm-ddThh:mm:ssZ)
          format: date-time
          example: '2017-06-19T13:18:18Z'
        actualCheckOutDateTime:
          type: string
          minLength: 20
          maxLength: 20
          description: The actual date and time the guest checked out of the property (String based date/time representation in International Date Time Format (ISO 8601) in UTC - yyyy-mm-ddThh:mm:ssZ)
          format: date-time
          example: '2017-06-19T13:18:18Z'
        roomPreferences:
          minLength: 1
          maxLength: 200
          type: string
          description: Request preferences for the room
          example: High speed WiFi required
        loyaltyReferenceId:
          type: string
          minLength: 1
          maxLength: 100
          description: 'Reference to loyalty object (in: /loyalty.id)'
          example: RT6545E01
        relatedPurchases:
          type: array
          description: Additional charges related to the property stay (such as restaurant charges, mini-bar, etc.)
          items:
            $ref: '#/components/schemas/RelatedPurchase'
        lodgingAddress:
          $ref: '#/components/schemas/AddressType'
      description: List of accommodation rentals
    HealthCheckResponse:
      type: string
      maxLength: 7
      minLength: 2
      description: "The code indicates if the API is up or not\n  - OK = The API is up and running\n  - failure = The API is down"
      example: OK
    PhysicalDelivery:
      type: object
      properties:
        trackingNumber:
          minLength: 1
          maxLength: 255
          type: string
          description: Tracking number for delivery - provide 'Not Yet Available' if number has not been issued yet
          example: 6765TYE45F43
        deliveryProvider:
          minLength: 1
          maxLength: 45
          type: string
          description: Name of shipping provider, such as UPS, FedEx, USPS, etc.
          example: UPS
        deliveryService:
          minLength: 1
          maxLength: 50
          type: string
          description: Name of the delivery service (for example, Next Day, Overnight, 3 Day, etc.)
          example: 2 Day Delivery
        deliveryStatus:
          type: string
          minLength: 5
          maxLength: 18
          description: "Status of the delivery. Must provide one of the available, enumerated values.\n\nAllowed values:\n  - Backordered\n  - Cancelled\n  - In_Transit\n  - Not_Shipped\n  - Other\n  - Partial_Shipped\n  - Pickup\n  - Shipped\n  - Shipping_Exception\n"
          example: Backordered
        descriptionOfOtherStatus:
          minLength: 1
          maxLength: 50
          type: string
          description: Delivery status description if 'other' is provided in deliveryStatus
          example: Shipment status is not available from sender.
        dateShipped:
          type: string
          description: Date shipped from warehouse/merchant (String based date/time representation in International Date Time Format (ISO 8601) in UTC - yyyy-mm-ddThh:mm:ssZ)
          format: date-time
          minLength: 20
          maxLength: 20
          example: '2017-06-19T13:18:18Z'
        dateDelivered:
          type: string
          minLength: 20
          maxLength: 20
          description: Date delivered (String based date/time representation in International Date Time Format (ISO 8601) in UTC - yyyy-mm-ddThh:mm:ssZ)
          format: date-time
          example: '2017-06-19T13:18:18Z'
        signatureRequiredForDelivery:
          type: boolean
          description: Indicates whether delivery requires a signature
          example: true
        proofOfDeliverySigned:
          type: boolean
          description: Indicates whether proof of delivery signature was captured
          example: true
        proofOfDeliverySignedBy:
          minLength: 1
          maxLength: 75
          type: string
          description: Indicates the proof of the delivery signature (this is an open text field)
          example: Digital signature captured and send to merchant.
        numberOfItemsDelivered:
          minLength: 1
          maxLength: 100
          type: string
          description: Number or quantity of items delivered
          example: 2 lbs
        specialShippingInstructions:
          minLength: 1
          maxLength: 75
          type: string
          description: Special instructions provided by the customer for shipping (for example, leave on front porch, gate code, etc.)
          example: Buzz Code 999
        packingSlipContents:
          minLength: 1
          maxLength: 2000
          type: string
          description: Packing slip contents
          example: 6 Items and a Manual.
        addressVerificationForShipping:
          type: boolean
          description: Indicates whether the shipping address was verified with a vendor
          example: true
        billingAddressMatchesShippingAddress:
          type: boolean
          description: Indicates whether the shipping address matched the billing address for a payment
          example: true
        customerPickup:
          type: boolean
          description: Indicates whether the customer did/will pick up from the store or shipping center
          example: true
        reasonForPickup:
          minLength: 1
          maxLength: 30
          type: string
          description: The reason for the customer pick up, such as Customer Requested (online option for some merchants) or Delivery Missed (customer was not present to sih for delivery)
          example: Delivery missed.
        pickupDateTime:
          type: string
          minLength: 20
          maxLength: 20
          description: The date on which the item or the ordered good was picked up (String based date/time representation in International Date Time Format (ISO 8601) in UTC - yyyy-mm-ddThh:mm:ssZ)
          format: date-time
          example: '2017-06-19T13:18:18Z'
        idVerifiedAtPickupLocation:
          type: boolean
          description: Indicates whether an ID was verified at the pickup location
          example: true
        idVerificationAtPickupLocation:
          minLength: 1
          maxLength: 25
          type: string
          description: Identification used for verification (Driver's license, credit card, etc.)
          example: GREEN CARD
        shippingName:
          $ref: '#/components/schemas/NameType'
        shippingAddress:
          $ref: '#/components/schemas/AddressType'
        pickupAddressLocation:
          $ref: '#/components/schemas/AddressType'
        nameOfSigner:
          $ref: '#/components/schemas/NameType'
    SearchCriteria:
      title: Search Criteria for order lookup
      description: Parameters used to look up order
      type: object
      properties:
        paymentType:
          title: Transaction Card Type
          type: string
          minLength: 2
          maxLength: 8
          description: "The card brand or network as provided by the issuer\n\nAllowed values:\n  - AMEX\n  - DISCOVER\n  - MC\n  - VISA\n\nDefinition of allowed values:\n  - AMEX: American Express\n  - DISCOVER: Discover\n  - MC: Mastercard\n  - VISA: Visa\n"
          example: MC
        transactionIdentifierType:
          type: string
          minLength: 1
          maxLength: 20
          description: "Payment type-specific transaction identifier type associated with the value specified in transactionIdentifierValue.\n\nCurrent values:\n  - BANKNET_REF_NUM\n  - INVOICE_REF_NUM\n\nDefinition of current values:\n- Mastercard: DE 63, Subfield 2: Banknet Reference Number\n- American Express: TAB Field 26: Invoice/Reference Number\n"
          example: BANKNET_REF_NUM
        transactionIdentifierValue:
          title: Transaction Identifier Value
          type: string
          minLength: 1
          maxLength: 30
          description: Transaction identifier value associated with the type specified in transactionIdentifierType
          example: T123456
        acquirerReferenceNumber:
          title: Acquirer Reference Number (ARN)
          minLength: 23
          maxLength: 23
          type: string
          description: Acquirer Reference Number of the transaction
          example: '12345678901234567890123'
        transactionDateTime:
          title: Transaction Date and/or Time
          minLength: 10
          maxLength: 25
          type: string
          description: "Date, time, and time zone of the authorization of the transaction \n(for example, \"2020-06-18T17:11:05-05:00\"), OR Date and time of the \ntransaction in Coordinated Universal Time (UTC) (for example, \n\"2020-06-18T17:11:05+00:00\"), OR If time or time zone is unknown, \nthen date of the transaction (for example, \"2020-06-18\"). ISO 8601 \nformat. This is the date and time of the authorization of the \ntransaction, not the date and time of the settlement of the transaction.\n"
          example: '2020-06-18T17:11:05-05:00'
        cardFirstSix:
          title: Card First Six
          minLength: 6
          maxLength: 6
          type: string
          pattern: ^\d{6}$
          description: First six characters of the card used in the transaction
          example: '123456'
        cardLastFour:
          title: Card Last Four
          minLength: 4
          maxLength: 4
          type: string
          pattern: ^\d{4}$
          description: Last four characters of the card used in the transaction
          example: '1234'
        issuerAuthorizationCode:
          title: Issuer Authorization Code
          maxLength: 6
          minLength: 6
          type: string
          description: Issuer authorization code for the transaction
          example: '123456'
        transactionAmount:
          title: Transaction Value
          minLength: 1
          maxLength: 12
          type: string
          description: 'Total amount value associated with the transaction.

            <br/><br/>Decimal point period is expected to denote separation of the fractional suffix

            from the rest of the amount, if applicable for the currency. Decimal

            point period must not be the first character. Examples:<br>- USD exponent

            is 2, so $250 USD value should be represented as 250.00, 34&cent; USD

            value should be represented as 0.34<br>- JPY exponent is 0, so &yen;250

            JPY value should be represented as 250

            '
          example: '250.35'
        transactionCurrencyCode:
          title: Transaction Currency Code
          maxLength: 3
          minLength: 3
          type: string
          description: Alphabetic currency code associated with the value in ISO 4217 format
          example: USD
        merchantId:
          title: Merchant Identifier
          description: The alphanumeric ID of the sub-merchant associated with the purchase details. Required for channel partner
          type: string
          minLength: 1
          maxLength: 100
          example: GHF5F67DFSD468GJJXH78
        cardAcceptorId:
          title: Card Acceptor Id
          description: An identifier for the store location or transaction point. Also known as  Card Acceptor ID and it is assigned by the merchant acquirer.
          type: string
          minLength: 1
          maxLength: 15
          example: 12345671234567
        cardAcceptorName:
          title: Card Acceptor Name
          description: 'Merchant ''doing business as'' name, or website name<br>- Mastercard: DE 43, Subfield 1; Card Acceptor Name<br>- Visa: TC 05, positions 92-116; Merchant Name'
          type: string
          minLength: 1
          maxLength: 50
          example: MicrosoftXBox
        cardAcceptorLocation:
          title: Card Acceptor Location
          description: 'Merchant city, telephone number, email address, or URL<br>- Mastercard: DE 43, Subfield 3: Card Acceptor City<br>- Visa: TC 05, positions 117-129: Merchant City'
          type: string
          minLength: 1
          maxLength: 50
          example: Austin
        cardAcceptorRegionCode:
          title: CardAcceptor Region Code
          description: The abbreviation for a subdivision (State, Province, Parish, Territory, etc.) provided in the ISO 639-1 and ISO-3166-2 format
          type: string
          minLength: 1
          maxLength: 3
          pattern: ^[A-Za-z0-9]*$
          example: TX
        cardAcceptorCountryCode:
          title: CardAcceptor Country Code
          description: The Country Code associated with the cardAcceptorNames location data.
          type: string
          minLength: 2
          maxLength: 3
          example: US
    Discount:
      type: object
      description: List of discounts applied to the order
      required:
      - id
      - description
      - amount
      properties:
        id:
          minLength: 1
          maxLength: 100
          type: string
          description: Unique identifier for each discount record (merchant generated sequence-based ID for each discount, for example 1, 2, 3, 4...)
          example: '54'
        description:
          minLength: 1
          maxLength: 50
          type: string
          description: Description/Name of the discount
          example: summer sale- code 1234
        amount:
          type: string
          minLength: 1
          maxLength: 12
          description: Amount of this specific discount given (maximum number of fractional digits supported is 2)
          example: '250.35'
    NameType:
      type: object
      properties:
        prefix:
          minLength: 1
          maxLength: 10
          type: string
          description: Prefix of the person
          example: Mr.
        givenName:
          minLength: 1
          maxLength: 40
          type: string
          description: Given name of the person
          example: Raymond
        additionalName:
          minLength: 1
          maxLength: 40
          type: string
          description: Middle name or initial of the person
          example: Jacob
        familyName:
          minLength: 1
          maxLength: 80
          type: string
          description: Family name of the person
          example: Holt
        suffix:
          minLength: 1
          maxLength: 10
          type: string
          description: Suffix of the person
          example: Sr.
    HistoricOrder:
      type: object
      description: List of historic orders for this account.
      properties:
        orderId:
          minLength: 1
          maxLength: 65
          type: string
          description: Merchant internal Order ID
          example: '7768576'
        orderDateTime:
          type: string
          minLength: 20
          maxLength: 20
          description: Date of historical order (String based date/time representation in International Date Time Format (ISO 8601) in UTC - yyyy-mm-ddThh:mm:ssZ)
          format: date-time
          example: '2017-06-19T13:18:18Z'
        orderTotal:
          description: Total amount of order
          type: string
          minLength: 1
          maxLength: 12
          example: '878.96'
        primaryDeviceId:
          minLength: 1
          maxLength: 40
          type: string
          description: Primary device ID
          example: 98JYI77
        primaryDeviceName:
          minLength: 1
          maxLength: 20
          type: string
          description: Primary device name
          example: Mark's iPad
        deviceIpAddress:
          minLength: 1
          maxLength: 45
          type: string
          description: Device IP address that was used at the time of the historical/previous transaction
          example: 127.0.0.1
        paymentType:
          $ref: '#/components/schemas/PaymentType'
        userIdName:
          minLength: 1
          maxLength: 65
          type: string
          description: Merchant unique identifier for cardholder
          example: testuser1234
        matchCreditCard:
          type: boolean
          description: Indicates whether this card matches orders that have been previously placed with this merchant
          example: true
        matchDeviceId:
          type: boolean
          description: Indicates whether this device ID matches orders that have been previously placed with this merchant
          example: true
        matchDeviceName:
          type: boolean
          description: Indicates whether this device name matches orders that have been previously placed with this merchant
          example: true
        matchIpAddress:
          type: boolean
          description: Indicates whether this IP Address matches orders that have been previously placed with this merchant
          example: true
        matchGeoLocation:
          type: boolean
          description: Indicates whether this Geo Location matches orders that have been previously placed with this merchant
          example: true
        currencyCode:
          $ref: '#/components/schemas/CurrencyCode'
    MerchantCustomerServiceContact:
      type: object
      properties:
        phoneNumber:
          minLength: 3
          maxLength: 30
          type: string
          description: Merchant's customer service phone number including the country code and any applicable separators
          example: +1-234-567-8901
        email:
          minLength: 1
          maxLength: 200
          type: string
          description: Merchant's customer service email address
          example: customerservice.merchant@example.com
        website:
          minLength: 1
          maxLength: 100
          type: string
          description: URL for merchant's customer service focused information
          example: http://merchantwebsite.example.com/customerservice.html
        customerServiceInstructions:
          minLength: 1
          maxLength: 250
          type: string
          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.
        address:
          $ref: '#/components/schemas/AddressType'
    Consequence:
      type: object
      properties:
        consequenceStatus:
          type: boolean
          description: Indicates whether there is a consequence/merchant action for this account/transaction if it is disputed
          example: true
        consequence:
          minLength: 1
          maxLength: 500
          type: string
          description: Free form text displayed to issuer that can be shared verbatim with the cardholder. Can be specific to customer or generated in real time based on other aspects of order
          example: No Change/Cancellation is Allowed.
    OrderItem:
      description: List of items (products) included in the order (requires at least one, may repeat). This item identified one product of the list.
      type: object
      required:
      - id
      - productName
      - unitOfMeasurement
      properties:
        id:
          minLength: 1
          maxLength: 100
          type: string
          description: Order item unique identifier (merchant generated sequence-based ID for each order item, for example 1, 2, 3, 4...)
          example: '898989'
        productId:
          minLength: 1
          maxLength: 100
          type: string
          description: Item ID/Product ID. Internal ID created to track an individual product in the system.
 

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