openapi: 3.2.0
info:
  version: 2.6.1
  title: Moneris Terminal & Service Orders API
  description: 'Moneris API Platform



    [<img src="https://run.pstmn.io/button.svg" alt="Run In Postman" style="width: 128px; height:32px;">](https://god.gw.postman.com/run-collection/25575461-f04750a0-88e9-4c83-8b58-a3aff15eeea8?action=collection%2Ffork&collection-url=entityId%3D25575461-f04750a0-88e9-4c83-8b58-a3aff15eeea8%26entityType%3Dcollection%26workspaceId%3D5d2a9a0f-57a7-441c-b2af-fe6315e80a08)'
  termsOfService: https://www.moneris.com/en/legal/terms-of-use
  contact:
    url: https://api-developer.moneris.com
    email: UnifiedAPI@moneris.com
  license:
    name: Moneris
    url: https://developer.moneris.com/Agreements/Terms%20of%20Use
  x-audience: external-public
servers:
- url: https://api.sb.moneris.io
  description: Sandbox server (uses test data)
  x-internal: false
- url: https://api.moneris.io
  description: Production server (uses live data)
  x-internal: false
tags:
- name: Terminal & Service Orders
  description: Manage Moneris Terminal & Service Orders
paths:
  /onboarding/merchants/{merchant-id}/orders:
    parameters:
    - $ref: '#/components/parameters/apiVersion'
    - $ref: '#/components/parameters/correlationId'
    - $ref: '#/components/parameters/prm-merchants_merchantId'
    post:
      summary: Create Order
      description: Submit an order payload to create an order for the merchant
      operationId: createOrder
      security:
      - OAuth2:
        - onboarding.order.write
      - ApiKeyAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createOrderRequest'
            examples:
              OrderPayload:
                $ref: '#/components/examples/CreateStandardOrderPayload'
              OrderPayloadPartnerBank:
                $ref: '#/components/examples/CreatePartnerBankOrderPayload'
      tags:
      - Terminal & Service Orders
      responses:
        '201':
          description: Successful response corresponding to the provided payload
          headers:
            Api-Version:
              $ref: '#/components/headers/apiVersion'
            X-Correlation-Id:
              $ref: '#/components/headers/correlationId'
            Sunset:
              $ref: '#/components/headers/sunset'
            X-RateLimit-Limit:
              $ref: '#/components/headers/rateLimitCount'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/rateLimitRemaining'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/order'
              example:
                merchantOrderId: 1471632
                merchantId: 0030211900586
                userIdentifier: '001'
                representativeCode: 0A
                adjudicationRequired: true
                orderStatus: APPLICATION_SUBMITTED
                orderType: NET_NEW_MERCHANT
                orderOpenedAt: '2025-06-17T21:39:01.85+00:00'
                orderChangedAt: '2025-06-17T22:40:55.577+00:00'
                feeDetails:
                  minimumMerchantDiscountRateFee:
                    unitPrice:
                      amount: 699
                      currency: CAD
                    taxes: []
                  paperStatementFee:
                    unitPrice:
                      amount: 795
                      currency: CAD
                    taxes: []
                  pciSecurityFee:
                    unitPrice:
                      amount: 895
                      currency: CAD
                    taxes: []
                  totalAdminFee:
                    unitPrice:
                      amount: 200
                      currency: CAD
                    taxes: []
                  agedCloseBatchFee:
                    unitPrice:
                      amount: 250
                      currency: CAD
                    taxes: []
                  mastercardComplianceFee:
                    unitPrice:
                      amount: 8000
                      currency: CAD
                    taxes: []
                  dialCommunicationFee:
                    unitPrice:
                      amount: 8
                      currency: CAD
                    taxes: []
                promotionInformation:
                  promotionCode: 1MONTHOFF
                  promotionName: 1MONTHOFF
                  promotionExpirationDate: '2024-06-27T05:00:00+00:00'
                supplies:
                - supplyName: 2-PLY Sales Draft Slips (25)
                  unitPrice:
                    amount: 2
                    currency: CAD
                  quantity: 1
                - supplyName: Physical Distancing Arrow Decal
                  unitPrice:
                    amount: 6
                    currency: CAD
                  quantity: 3
                productDetails:
                  wireless:
                    feeDetails:
                      goSoftwareFee:
                        feeType: GoSoftwareFee
                        unitPrice:
                          amount: 5
                          currency: CAD
                        waivePeriod: null
                  monerisGateway:
                    feeDetails:
                      monthlyFee:
                        feeType: MonthlyFee
                        unitPrice:
                          amount: 0
                          currency: CAD
                        waivePeriod: null
                      visa3dSecureAuthenticationTransactionFee:
                        feeType: Visa3DSecureAuthTxn
                        unitPrice:
                          amount: 25
                          currency: CAD
                        waivePeriod: null
                      mastercard3dSecureAuthenticationTransactionFee:
                        feeType: Mastercard3DSecureAuthTxn
                        unitPrice:
                          amount: 11
                          currency: CAD
                        waivePeriod: null
                      visa3dSecureAuthenticationMerchantDiscountRateFee:
                        feeType: Visa3DSecureAuthMdr
                        unitPrice:
                          amount: 13
                          currency: CAD
                        waivePeriod: null
                      mastercard3dSecureAuthenticationMerchantDiscountRateFee:
                        feeType: Mastercard3DSecureAuthMdr
                        unitPrice:
                          amount: 10
                          currency: CAD
                        waivePeriod: null
                  monerisGoPointOfSaleRetail:
                    feeDetails:
                      goRetailFee:
                        feeType: GoRetailFee
                        unitPrice:
                          amount: 10
                          currency: CAD
                        waivePeriod: null
                bankerInformation:
                  bankerPhoneNumber: '+19024333434'
                  bankerBranchIdentifier: '2679'
                cardPlanDetails:
                  selectedPlans:
                  - VISA
                  - MASTERCARD
                  mastercard:
                    transactionPlans:
                    - merchantDiscountRate: 0.111
                      transactionRate: 0.131
                    - merchantDiscountRate: 0.111
                      transactionRate: 0.131
                    cardBrandPlans: []
                    assessmentPlans: []
                    serviceFeeDetails:
                      maintenanceFee:
                        feeType: maintenance
                        unitPrice:
                          amount: 301
                          currency: CAD
                  mastercardDebit:
                    cardBrandPlans: []
                    assessmentPlans: []
                  visa:
                    transactionPlans:
                    - merchantDiscountRate: 0
                      transactionRate: 0
                    cardBrandPlans: []
                    assessmentPlans: []
                    serviceFeeDetails:
                      maintenanceFee:
                        feeType: maintenance
                        unitPrice:
                          amount: 301
                          currency: CAD
                  visaDebit:
                    cardBrandPlans: []
                    assessmentPlans: []
                  discover:
                    cardBrandPlans: []
                    assessmentPlans: []
                  unionPay:
                    cardBrandPlans: []
                    assessmentPlans: []
                  amex:
                    cardBrandPlans: []
                    assessmentPlans: []
                  otherFinancialInstitutionCards: []
                  programs: []
                pointOfSaleSolutionType: MONERIS_POINT_OF_SALE
                isAcceptedByConduct: false
                contractSignatureRequired: false
                faxRequired: true
                additionalInformation: ''
                businessEntityName: Intuit
                referralInformation:
                  description: Other
                  additionalInformation: NOT USED
                hostType: ESSENTIS
                autoApprovalStatus: MANUAL_ADJUDICATION
                adjudicationApprovalStatus: MANUAL
                hasImprinter: true
                isMarketSubSegmentationPreApprovalRequired: false
                optOutAmexCommunication: true
                multiCurrencyPricingPackageId: 1234
        '400':
          $ref: '#/components/responses/badRequest'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/notFound'
        '409':
          $ref: '#/components/responses/conflict'
        '422':
          $ref: '#/components/responses/unprocessableContent'
        '429':
          $ref: '#/components/responses/tooManyRequests'
        '500':
          $ref: '#/components/responses/internalServer'
        '503':
          $ref: '#/components/responses/serviceUnavailable'
  /onboarding/merchants/{merchant-id}/orders/{merchant-order-id}:
    parameters:
    - $ref: '#/components/parameters/apiVersion'
    - $ref: '#/components/parameters/correlationId'
    - $ref: '#/components/parameters/prm-merchants_merchantId'
    - $ref: '#/components/parameters/merchantOrderId'
    get:
      summary: Retrieve order by Id
      operationId: getOrderDetailsByOrderId
      security:
      - OAuth2:
        - onboarding.order.read
      - OAuth2:
        - onboarding.order.write
      - ApiKeyAuth: []
      tags:
      - Terminal & Service Orders
      description: 'Get order details by ID

        '
      responses:
        '200':
          description: Successful response corresponding to the provided order id parameter
          headers:
            Api-Version:
              $ref: '#/components/headers/apiVersion'
            X-Correlation-Id:
              $ref: '#/components/headers/correlationId'
            Sunset:
              $ref: '#/components/headers/sunset'
            X-RateLimit-Limit:
              $ref: '#/components/headers/rateLimitCount'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/rateLimitRemaining'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/order'
              example:
                merchantOrderId: 1471632
                merchantId: 0030211900586
                userIdentifier: '001'
                representativeCode: 0A
                adjudicationRequired: true
                orderStatus: APPLICATION_SUBMITTED
                orderType: NET_NEW_MERCHANT
                orderOpenedAt: '2025-06-17T21:39:01.85+00:00'
                orderChangedAt: '2025-06-17T22:40:55.577+00:00'
                feeDetails:
                  minimumMerchantDiscountRateFee:
                    unitPrice:
                      amount: 699
                      currency: CAD
                    taxes: []
                  paperStatementFee:
                    unitPrice:
                      amount: 795
                      currency: CAD
                    taxes: []
                  pciSecurityFee:
                    unitPrice:
                      amount: 895
                      currency: CAD
                    taxes: []
                  totalAdminFee:
                    unitPrice:
                      amount: 200
                      currency: CAD
                    taxes: []
                  agedCloseBatchFee:
                    unitPrice:
                      amount: 250
                      currency: CAD
                    taxes: []
                  mastercardComplianceFee:
                    unitPrice:
                      amount: 8000
                      currency: CAD
                    taxes: []
                  dialCommunicationFee:
                    unitPrice:
                      amount: 8
                      currency: CAD
                    taxes: []
                promotionInformation:
                  promotionCode: 1MONTHOFF
                  promotionName: 1MONTHOFF
                  promotionExpirationDate: '2024-06-27T05:00:00+00:00'
                supplies:
                - supplyName: 2-PLY Sales Draft Slips (25)
                  unitPrice:
                    amount: 2
                    currency: CAD
                  quantity: 1
                - supplyName: Physical Distancing Arrow Decal
                  unitPrice:
                    amount: 6
                    currency: CAD
                  quantity: 3
                productDetails:
                  wireless:
                    feeDetails:
                      goSoftwareFee:
                        feeType: GoSoftwareFee
                        unitPrice:
                          amount: 5
                          currency: CAD
                        waivePeriod: null
                  monerisGateway:
                    feeDetails:
                      monthlyFee:
                        feeType: MonthlyFee
                        unitPrice:
                          amount: 0
                          currency: CAD
                        waivePeriod: null
                      visa3dSecureAuthenticationTransactionFee:
                        feeType: Visa3DSecureAuthTxn
                        unitPrice:
                          amount: 25
                          currency: CAD
                        waivePeriod: null
                      mastercard3dSecureAuthenticationTransactionFee:
                        feeType: Mastercard3DSecureAuthTxn
                        unitPrice:
                          amount: 11
                          currency: CAD
                        waivePeriod: null
                      visa3dSecureAuthenticationMerchantDiscountRateFee:
                        feeType: Visa3DSecureAuthMdr
                        unitPrice:
                          amount: 13
                          currency: CAD
                        waivePeriod: null
                      mastercard3dSecureAuthenticationMerchantDiscountRateFee:
                        feeType: Mastercard3DSecureAuthMdr
                        unitPrice:
                          amount: 10
                          currency: CAD
                        waivePeriod: null
                  monerisGoPointOfSaleRetail:
                    feeDetails:
                      goRetailFee:
                        feeType: GoRetailFee
                        unitPrice:
                          amount: 10
                          currency: CAD
                        waivePeriod: null
                bankerInformation:
                  bankerPhoneNumber: '+19024333434'
                  bankerBranchIdentifier: '2679'
                cardPlanDetails:
                  selectedPlans:
                  - VISA
                  - MASTERCARD
                  mastercard:
                    transactionPlans:
                    - merchantDiscountRate: 0.111
                      transactionRate: 0.131
                    - merchantDiscountRate: 0.111
                      transactionRate: 0.131
                    cardBrandPlans: []
                    assessmentPlans: []
                    serviceFeeDetails:
                      maintenanceFee:
                        feeType: maintenance
                        unitPrice:
                          amount: 301
                          currency: CAD
                  mastercardDebit:
                    cardBrandPlans: []
                    assessmentPlans: []
                  visa:
                    transactionPlans:
                    - merchantDiscountRate: 0
                      transactionRate: 0
                    cardBrandPlans: []
                    assessmentPlans: []
                    serviceFeeDetails:
                      maintenanceFee:
                        feeType: maintenance
                        unitPrice:
                          amount: 301
                          currency: CAD
                  visaDebit:
                    cardBrandPlans: []
                    assessmentPlans: []
                  discover:
                    cardBrandPlans: []
                    assessmentPlans: []
                  unionPay:
                    cardBrandPlans: []
                    assessmentPlans: []
                  amex:
                    cardBrandPlans: []
                    assessmentPlans: []
                  otherFinancialInstitutionCards: []
                  programs: []
                pointOfSaleSolutionType: MONERIS_POINT_OF_SALE
                isAcceptedByConduct: false
                contractSignatureRequired: false
                faxRequired: true
                additionalInformation: ''
                businessEntityName: Intuit
                referralInformation:
                  description: Other
                  additionalInformation: NOT USED
                hostType: ESSENTIS
                autoApprovalStatus: MANUAL_ADJUDICATION
                adjudicationApprovalStatus: MANUAL
                hasImprinter: true
                isMarketSubSegmentationPreApprovalRequired: false
                optOutAmexCommunication: true
                multiCurrencyPricingPackageId: 1234
        '400':
          $ref: '#/components/responses/badRequest'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/notFound'
        '429':
          $ref: '#/components/responses/tooManyRequests'
        '500':
          $ref: '#/components/responses/internalServer'
        '503':
          $ref: '#/components/responses/serviceUnavailable'
    put:
      summary: Update an order by ID
      operationId: updateOrder
      security:
      - OAuth2:
        - onboarding.order.write
      - ApiKeyAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateOrderRequest'
            examples:
              OrderPayload:
                $ref: '#/components/examples/UpdateStandardOrderPayload'
              OrderPayloadPartnerBank:
                $ref: '#/components/examples/UpdatePartnerBankOrderPayload'
      tags:
      - Terminal & Service Orders
      responses:
        '200':
          description: Successful response corresponding to the provided payload
          headers:
            Api-Version:
              $ref: '#/components/headers/apiVersion'
            X-Correlation-Id:
              $ref: '#/components/headers/correlationId'
            Sunset:
              $ref: '#/components/headers/sunset'
            X-RateLimit-Limit:
              $ref: '#/components/headers/rateLimitCount'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/rateLimitRemaining'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/order'
              example:
                merchantOrderId: 1471632
                merchantId: 0030211900586
                userIdentifier: '001'
                representativeCode: 0A
                adjudicationRequired: true
                orderStatus: APPLICATION_SUBMITTED
                orderType: NET_NEW_MERCHANT
                orderOpenedAt: '2025-06-17T21:39:01.85+00:00'
                orderChangedAt: '2025-06-17T22:40:55.577+00:00'
                feeDetails:
                  minimumMerchantDiscountRateFee:
                    unitPrice:
                      amount: 699
                      currency: CAD
                    taxes: []
                  paperStatementFee:
                    unitPrice:
                      amount: 795
                      currency: CAD
                    taxes: []
                  pciSecurityFee:
                    unitPrice:
                      amount: 895
                      currency: CAD
                    taxes: []
                  totalAdminFee:
                    unitPrice:
                      amount: 200
                      currency: CAD
                    taxes: []
                  agedCloseBatchFee:
                    unitPrice:
                      amount: 250
                      currency: CAD
                    taxes: []
                  mastercardComplianceFee:
                    unitPrice:
                      amount: 8000
                      currency: CAD
                    taxes: []
                  dialCommunicationFee:
                    unitPrice:
                      amount: 8
                      currency: CAD
                    taxes: []
                promotionInformation:
                  promotionCode: 1MONTHOFF
                  promotionName: 1MONTHOFF
                  promotionExpirationDate: '2024-06-27T05:00:00+00:00'
                supplies:
                - supplyName: 2-PLY Sales Draft Slips (25)
                  unitPrice:
                    amount: 2
                    currency: CAD
                  quantity: 1
                - supplyName: Physical Distancing Arrow Decal
                  unitPrice:
                    amount: 6
                    currency: CAD
                  quantity: 3
                productDetails:
                  wireless:
                    feeDetails:
                      goSoftwareFee:
                        feeType: GoSoftwareFee
                        unitPrice:
                          amount: 5
                          currency: CAD
                        waivePeriod: null
                  monerisGateway:
                    feeDetails:
                      monthlyFee:
                        feeType: MonthlyFee
                        unitPrice:
                          amount: 0
                          currency: CAD
                        waivePeriod: null
                      visa3dSecureAuthenticationTransactionFee:
                        feeType: Visa3DSecureAuthTxn
                        unitPrice:
                          amount: 25
                          currency: CAD
                        waivePeriod: null
                      mastercard3dSecureAuthenticationTransactionFee:
                        feeType: Mastercard3DSecureAuthTxn
                        unitPrice:
                          amount: 11
                          currency: CAD
                        waivePeriod: null
                      visa3dSecureAuthenticationMerchantDiscountRateFee:
                        feeType: Visa3DSecureAuthMdr
                        unitPrice:
                          amount: 13
                          currency: CAD
                        waivePeriod: null
                      mastercard3dSecureAuthenticationMerchantDiscountRateFee:
                        feeType: Mastercard3DSecureAuthMdr
                        unitPrice:
                          amount: 10
                          currency: CAD
                        waivePeriod: null
                  monerisGoPointOfSaleRetail:
                    feeDetails:
                      goRetailFee:
                        feeType: GoRetailFee
                        unitPrice:
                          amount: 10
                          currency: CAD
                        waivePeriod: null
                bankerInformation:
                  bankerPhoneNumber: '+19024333434'
                  bankerBranchIdentifier: '2679'
                cardPlanDetails:
                  selectedPlans:
                  - VISA
                  - MASTERCARD
                  mastercard:
                    transactionPlans:
                    - merchantDiscountRate: 0.111
                      transactionRate: 0.131
                    - merchantDiscountRate: 0.111
                      transactionRate: 0.131
                    cardBrandPlans: []
                    assessmentPlans: []
                    serviceFeeDetails:
                      maintenanceFee:
                        feeType: maintenance
                        unitPrice:
                          amount: 301
                          currency: CAD
                  mastercardDebit:
                    cardBrandPlans: []
                    assessmentPlans: []
                  visa:
                    transactionPlans:
                    - merchantDiscountRate: 0
                      transactionRate: 0
                    cardBrandPlans: []
                    assessmentPlans: []
                    serviceFeeDetails:
                      maintenanceFee:
                        feeType: maintenance
                        unitPrice:
                          amount: 301
                          currency: CAD
                  visaDebit:
                    cardBrandPlans: []
                    assessmentPlans: []
                  discover:
                    cardBrandPlans: []
                    assessmentPlans: []
                  unionPay:
                    cardBrandPlans: []
                    assessmentPlans: []
                  amex:
                    cardBrandPlans: []
                    assessmentPlans: []
                  otherFinancialInstitutionCards: []
                  programs: []
                pointOfSaleSolutionType: MONERIS_POINT_OF_SALE
                isAcceptedByConduct: false
                contractSignatureRequired: false
                faxRequired: true
                additionalInformation: ''
                businessEntityName: Intuit
                referralInformation:
                  description: Other
                  additionalInformation: NOT USED
                hostType: ESSENTIS
                autoApprovalStatus: MANUAL_ADJUDICATION
                adjudicationApprovalStatus: MANUAL
                hasImprinter: true
                isMarketSubSegmentationPreApprovalRequired: false
                optOutAmexCommunication: true
                multiCurrencyPricingPackageId: 1234
        '400':
          $ref: '#/components/responses/badRequest'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/notFound'
        '409':
          $ref: '#/components/responses/conflict'
        '422':
          $ref: '#/components/responses/unprocessableContent'
        '429':
          $ref: '#/components/responses/tooManyRequests'
        '500':
          $ref: '#/components/responses/internalServer'
        '503':
          $ref: '#/components/responses/serviceUnavailable'
components:
  schemas:
    monerisGoPortalFeeDetails:
      type:
      - object
      - 'null'
      description: A list of fees associated with Moneris Go Portal.
      properties:
        setupFee:
          description: A one-time fee charged for the initial configuration and onboarding of the product.
          type:
          - object
          - 'null'
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
        accessFee:
          description: A fee charged for gaining access to the service.
          type:
          - object
          - 'null'
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
    isExpeditedOrder:
      type: boolean
      description: A boolean flag indicating whether an order is being processed as a rush or expedited order.
    depositType:
      type:
      - string
      - 'null'
      description: Indicates the type of deposit arrangement for the merchant account.
      maxLength: 10
    companyName:
      type:
      - string
      - 'null'
      description: Identifies the associated company name
      minLength: 1
      maxLength: 50
      example: SP Ltd
    otherFinancialInstitutionCards:
      type: array
      description: A list of other financial institution cards.
      items:
        $ref: '#/components/schemas/ofiCardPlan'
      maxItems: 20
    monerisGatewayFeeDetails:
      type:
      - object
      - 'null'
      description: A list of fees associated to Moneris Gateway.
      properties:
        baseFee:
          description: The standard fee charged for a product.
          type:
          - object
          - 'null'
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
        recurringFee:
          description: A fee that is charged on a regular basis.
          type:
          - object
          - 'null'
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
        batchProcessingFee:
          description: Indicates whether fees apply to batch processing services.
          type:
          - object
          - 'null'
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
        cardPresentDebitFee:
          description: Represents the fee applied to debit card transactions.
          type:
          - object
          - 'null'
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
        levelTwoThreeFee:
          description: A fee associated with level 2 or level 3 processing.
          type:
          - object
          - 'null'
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
        setupFee:
          description: A one-time fee charged for the initial configuration and onboarding of the product.
          type:
          - object
          - 'null'
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
        vaultFee:
          description: A fee charged for using a secure card vault service.
          type:
          - object
          - 'null'
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
        riskToolFee:
          description: A fee associated with the use of fraud prevention and risk managements tools.
          type:
          - object
          - 'null'
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
        addressVerificationServiceFee:
          description: A fee charged for using the address verification service.
          type:
          - object
          - 'null'
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
        verifiedByVisaFee:
          description: A fee associated with verified by visa.
          type:
          - object
          - 'null'
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
        vaultOneTimeFee:
          description: A one-time fee charged for the initial setup or activation or a card vault service.
          type:
          - object
          - 'null'
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
        vaultPerTransactionFee:
          description: A fee charged for each transaction that utilizes the stored payment credentials.
          type:
          - object
          - 'null'
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
        vaultPerClickPerTransactionFee:
          description: A fee charged for each transaction processed using a tokenized payment method from the vault, initiated by a single click or action.
          type:
          - object
          - 'null'
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
        interacRegistrationFee:
          description: A fee associated with registering a merchant or account for Interac services.
          type:
          - object
          - 'null'
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
        interacFlatFee:
          description: A flat fee applied to each transaction processed through the Interac network.
          type:
          - object
          - 'null'
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
        interacRateFee:
          description: A percentage-based fee applied to transactions processed through the Interac network.
          type:
          - object
          - 'null'
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
        transactionFee:
          description: A fee applied per individual transaction processed.
          type:
          - object
          - 'null'
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
        monthlyFee:
          description: A recurring fee charged on a monthly basis for continued access.
          type:
          - object
          - 'null'
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
        boostMonthlyFee:
          description: An additional recurring fee charged on a monthly basis for enhanced services or features.
          type:
          - object
          - 'null'
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
        netSuiteMonthlyFee:
          description: A recurring montly fee for the integration or use of the NetSuite platform.
          type:
          - object
          - 'null'
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
        tokenSharingSetupFee:
          description: A one-time fee charged for setting up token sharing services.
          type:
          - object
          - 'null'
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
        eCommerceAssessmentTransactionFee:
          description: A fee applied to transaction assessed for e-commerce risk.
          type:
          - object
          - 'null'
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
        eCommerceCardBrandTransactionFee:
          description: A fee applied to e-commerce transactions based on the card brand.
          type:
          - object
          - 'null'
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
        eCommerceMerchantDiscountRateFee:
          description: The Merchant Discount Rate for e-commerce transactions.
          type:
          - object
          - 'null'
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
        eCommerceTransactionFee:
          description: A fee applied to each e-commerce transaction processed.
          type:
          - object
          - 'null'
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
        kountFee:
          description: A fee associated with the use of Kount tool.
          type:
          - object
          - 'null'
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
        kountOneTimeFee:
          description: A one-time fee charged for the initial setup or activation of Kount.
          type:
          - object
          - 'null'
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
        kountPerTransactionFee:
          description: A fee applied to each transaction processed using Kount.
          type:
          - object
          - 'null'
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
        visa3dSecureAuthenticationTransactionFee:
          description: A fee applied to transaction processed using Visa's 3D secure authentication protocol.
          type:
          - object
          - 'null'
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
        amex3dSecureAuthenticationTransactionFee:
          description: A fee applied to transaction processed using Amex's 3D secure authentication protocol.
          type:
          - object
          - 'null'
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
        mastercard3dSecureAuthenticationTransactionFee:
          description: A fee applied to transaction processed using Mastercard's 3D secure authentication protocol.
          type:
          - object
          - 'null'
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
        visa3dSecureAuthenticationMerchantDiscountRateFee:
          description: The Merchant Discount Rate applied to transactions processed through Visa's 3D secure authentication protocol.
          type:
          - object
          - 'null'
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
        amex3dSecureAuthenticationMerchantDiscountRateFee:
          description: The Merchant Discount Rate applied to transactions processed through Amex's 3D secure authentication protocol.
          type:
          - object
          - 'null'
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
        mastercard3dSecureAuthenticationMerchantDiscountRateFee:
          description: The Merchant Discount Rate applied to transactions processed through Mastercard's 3D secure authentication protocol.
          type:
          - object
          - 'null'
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
    foreignCardOriginCode:
      type:
      - string
      - 'null'
      description: A code used to identify the origin of a foreign card in a transaction under the card brand plan.
      maxLength: 10
    merchantDiscountRate:
      type: number
      description: The merchant discount rate applied to transactions under transaction plan.
      format: double
      default: 0
      minimum: 0
      maximum: 1
    cardNotPresentConfigurationCode:
      type:
      - string
      - 'null'
      description: A configuration code used to identify variable settings for transactions.
      maxLength: 50
    isApproved:
      type: boolean
      description: A boolean flag to indicate whether the fee has been approved for inclusion in the transaction.
      example: true
    software:
      type:
      - string
      - 'null'
      description: Indicates the software version or platform running on the terminal device.
      maxLength: 255
    representativeCode:
      type:
      - string
      - 'null'
      description: A code that identifies the representative agent associated with the order.
      maxLength: 10
      example: A0
    updateOrderRequest:
      description: Represents the payload for updating an order.
      oneOf:
      - $ref: '#/components/schemas/updateStandardOrderRequest'
      - $ref: '#/components/schemas/updatePartnerBankOrderRequest'
    confirmation:
      type:
      - object
      - 'null'
      description: An object containing the confirmation details.
      properties:
        hasManualImprinter:
          type: boolean
          description: A boolean flag indicating whether the order requires a manual imprinter.
        hasConsentedToCollectPersonalInformation:
          type: boolean
          description: A boolean flag indicating whether the user has consented to the use of their personal information.
        isSignatureRequired:
          type: boolean
          description: A boolean flag indicating whether a signature is required for the order.
          default: true
        additionalNote:
          type:
          - string
          - 'null'
          description: Additional note or comments related to the order.
          maxLength: 500
    partnerName:
      type:
      - string
      - 'null'
      description: The name of the partner that referred the lead to the business.
      maxLength: 30
    merchantNumber:
      type:
      - string
      - 'null'
      description: Identifies the merchant within he acquirer's system.
      maxLength: 10
    transactionFeeParameterCode:
      type:
      - string
      - 'null'
      description: The code that identifies the parameters associated with transaction fees for a specific card plan.
      maxLength: 20
      enum:
      - ATIP
      - INDI
      - KATZ
      - INTP
      - MCR3
      - PLQ2
      - SHOP
      - CF02
      - INGB
      - Q200
      - PLQ1
      - VISA
      - GNDS
      - TXLP
      - FLAT
      - INDG
      - CFIB
      - SER4
      - SER3
      - TIRR
      - TR00
      - DIEN
      - AMZN
      - CF01
      - TR02
      - MCR1
      - ID58
      - INDN
      - SDMI
      - SEAR
      - CRAV
      - CITI
      - CDMV
      - CTP2
      - SIMS
      - DOLA
      - PAYM
      - ROGE
      - CTP1
      - GOVC
      - PREC
      - CITB
      - ID53
      - SIMP
      - COST
      - TTMK
      - SER1
    updateStandardOrderRequest:
      type: object
      description: Represents the payload for updating an order.
      properties:
        marketSegment:
          $ref: '#/components/schemas/marketSegment'
        representativeCode:
          $ref: '#/components/schemas/representativeCode'
        userDetails:
          $ref: '#/components/schemas/userDetails'
        applicablePromotions:
          $ref: '#/components/schemas/applicablePromotions'
        feeDetails:
          $ref: '#/components/schemas/feeDetails'
        applicationDetails:
          $ref: '#/components/schemas/applicationDetails'
        agreementModelInformation:
          $ref: '#/components/schemas/agreementModelInformation'
        valueAddedServices:
          $ref: '#/components/schemas/valueAddedServices'
        documentsStatus:
          $ref: '#/components/schemas/documentsStatus'
        confirmation:
          $ref: '#/components/schemas/confirmation'
        supplies:
          $ref: '#/components/schemas/supplies'
        productDetails:
          $ref: '#/components/schemas/productDetails'
        isAutoAdjudicationRequired:
          $ref: '#/components/schemas/isAutoAdjudicationRequired'
        isExpeditedOrder:
          $ref: '#/components/schemas/isExpeditedOrder'
        cardPlanDetails:
          type:
          - object
          - 'null'
          description: An object containing all the card plans details.
          properties:
            merchantDiscountRateType:
              $ref: '#/components/schemas/merchantDiscountRateType'
            currency:
              type:
              - string
              - 'null'
              description: "Provides the three letter currency code according the ISO 4217 standard. \n\nFor a complete list of currency codes, visit: https://en.wikipedia.org/wiki/ISO_4217\n"
              minLength: 3
              maxLength: 4
              example: CAD
              format: iso-4217
            transactionFeeParameterCode:
              $ref: '#/components/schemas/transactionFeeParameterCode'
            cardBrandTemplateIdentifier:
              $ref: '#/components/schemas/cardBrandTemplateIdentifier'
            selectedPlans:
              $ref: '#/components/schemas/selectedPlans'
            mastercard:
              type:
              - object
              - 'null'
              description: An object containing the franchise plan details.
              properties:
                isCommunicationsOptOut:
                  $ref: '#/components/schemas/isCommunicationsOptOut'
                cardFeeDetails:
                  $ref: '#/components/schemas/cardFeeDetails'
                transactionPlans:
                  $ref: '#/components/schemas/transactionPlans'
                cardBrandPlans:
                  $ref: '#/components/schemas/cardBrandPlans'
                assessmentPlans:
                  $ref: '#/components/schemas/assessmentPlans'
                serviceFeeDetails:
                  $ref: '#/components/schemas/serviceFeeDetails'
            mastercardDebit:
              type:
              - object
              - 'null'
              description: An object containing the franchise plan details.
              properties:
                isCommunicationsOptOut:
                  $ref: '#/components/schemas/isCommunicationsOptOut'
                cardFeeDetails:
                  $ref: '#/components/schemas/cardFeeDetails'
                transactionPlans:
                  $ref: '#/components/schemas/transactionPlans'
                cardBrandPlans:
                  $ref: '#/components/schemas/cardBrandPlans'
                assessmentPlans:
                  $ref: '#/components/schemas/assessmentPlans'
                serviceFeeDetails:
                  $ref: '#/components/schemas/serviceFeeDetails'
            visa:
              type:
              - object
              - 'null'
              description: An object containing the franchise plan details.
              properties:
                isCommunicationsOptOut:
                  $ref: '#/components/schemas/isCommunicationsOptOut'
                cardFeeDetails:
                  $ref: '#/components/schemas/cardFeeDetails'
                transactionPlans:
                  $ref: '#/components/schemas/transactionPlans'
                cardBrandPlans:
                  $ref: '#/components/schemas/cardBrandPlans'
                assessmentPlans:
                  $ref: '#/components/schemas/assessmentPlans'
                serviceFeeDetails:
                  $ref: '#/components/schemas/serviceFeeDetails'
            visaDebit:
              type:
              - object
              - 'null'
              description: An object containing the franchise plan details.
              properties:
                isCommunicationsOptOut:
                  $ref: '#/components/schemas/isCommunicationsOptOut'
                cardFeeDetails:
                  $ref: '#/components/schemas/cardFeeDetails'
                transactionPlans:
                  $ref: '#/components/schemas/transactionPlans'
                cardBrandPlans:
                  $ref: '#/components/schemas/cardBrandPlans'
                assessmentPlans:
                  $ref: '#/components/schemas/assessmentPlans'
                serviceFeeDetails:
                  $ref: '#/components/schemas/serviceFeeDetails'
            discover:
              type:
              - object
              - 'null'
              description: An object containing the franchise plan details.
              properties:
                isCommunicationsOptOut:
                  $ref: '#/components/schemas/isCommunicationsOptOut'
                cardFeeDetails:
                  $ref: '#/components/schemas/cardFeeDetails'
                transactionPlans:
                  $ref: '#/components/schemas/transactionPlans'
                cardBrandPlans:
                  $ref: '#/components/schemas/cardBrandPlans'
                assessmentPlans:
                  $ref: '#/components/schemas/assessmentPlans'
                serviceFeeDetails:
                  $ref: '#/components/schemas/serviceFeeDetails'
            unionPay:
              type:
              - object
              - 'null'
              description: An object containing the franchise plan details.
              properties:
                isCommunicationsOptOut:
                  $ref: '#/components/schemas/isCommunicationsOptOut'
                cardFeeDetails:
                  $ref: '#/components/schemas/cardFeeDetails'
                transactionPlans:
                  $ref: '#/components/schemas/transactionPlans'
                cardBrandPlans:
                  $ref: '#/components/schemas/cardBrandPlans'
                assessmentPlans:
                  $ref: '#/components/schemas/assessmentPlans'
                serviceFeeDetails:
                  $ref: '#/components/schemas/serviceFeeDetails'
            interac:
              type:
              - object
              - 'null'
              description: An object containing the franchise plan details.
              properties:
                isCommunicationsOptOut:
                  $ref: '#/components/schemas/isCommunicationsOptOut'
                cardFeeDetails:
                  $ref: '#/components/schemas/cardFeeDetails'
                transactionPlans:
                  $ref: '#/components/schemas/transactionPlans'
                cardBrandPlans:
                  $ref: '#/components/schemas/cardBrandPlans'
                assessmentPlans:
                  $ref: '#/components/schemas/assessmentPlans'
                serviceFeeDetails:
                  $ref: '#/components/schemas/serviceFeeDetails'
            amex:
              type:
              - object
              - 'null'
              description: An object containing the franchise plan details.
              properties:
                isCommunicationsOptOut:
                  $ref: '#/components/schemas/isCommunicationsOptOut'
                cardFeeDetails:
                  $ref: '#/components/schemas/cardFeeDetails'
                transactionPlans:
                  $ref: '#/components/schemas/transactionPlans'
                cardBrandPlans:
                  $ref: '#/components/schemas/cardBrandPlans'
                assessmentPlans:
                  $ref: '#/components/schemas/assessmentPlans'
                serviceFeeDetails:
                  $ref: '#/components/schemas/serviceFeeDetails'
            otherFinancialInstitutionCards:
              $ref: '#/components/schemas/otherFinancialInstitutionCards'
            programs:
              $ref: '#/components/schemas/programs'
        solutions:
          $ref: '#/components/schemas/solutions'
        deliveryAddress:
          type:
          - object
          - 'null'
          description: An object containing the delivery address details.
          allOf:
          - $ref: '#/components/schemas/address'
          - $ref: '#/components/schemas/addressee'
        orderCreatedBy:
          $ref: '#/components/schemas/orderCreatedBy'
      required:
      - userDetails
      - productDetails
    ueat:
      type:
      - object
      - 'null'
      description: An object containing details about the Ueat product.
      properties:
        plannedGoLiveDate:
          type:
          - string
          - 'null'
          description: The planned go-live date for the Ueat product.
          format: date
          example: '2010-02-21'
        numberOfMenuItems:
          type: integer
          description: The number of menu items available in the Ueat product.
          format: int32
          minimum: 1
          maximum: 10000
        isMemberOfArq:
          type: boolean
          description: A boolean flag indicating whether the Ueat product is a member of the ARQ program.
        averageAmountSpent:
          type:
          - object
          - 'null'
          description: "Monetary amount. \nNote: The value must be in cents. Therefore $10.59 must be sent as 1059.\n"
          properties:
            amount:
              $ref: '#/components/schemas/amount'
            currency:
              $ref: '#/components/schemas/currency'
          required:
          - amount
          - currency
          example:
            amount: 16000
            currency: CAD
        pointOfSaleSystemName:
          type:
          - string
          - 'null'
          description: The name of the point of sale system used with the Ueat product.
          maxLength: 100
        feeDetails:
          type:
          - object
          - 'null'
          description: An object representing the fees associated with the Ueat product.
          properties:
            implementationFee:
              type:
              - object
              - 'null'
              description: Represents a monetary charge applied to a transaction or service.
              properties:
                feeType:
                  $ref: '#/components/schemas/feeType'
                unitPrice:
                  $ref: '#/components/schemas/money'
                taxes:
                  type: array
                  description: A list of tax items associated with the fee.
                  items:
                    $ref: '#/components/schemas/tax'
                  maxItems: 10
                frequency:
                  description: The frequency at which the fee is charged, such as monthly or annually.
                  type:
                  - string
                  - 'null'
                  maxLength: 20
                  enum:
                  - DAILY
                  - MONTHLY
                  - QUARTERLY
                  - ONE_OFF
                  - ANNUALLY
                quantity:
                  type: integer
                  description: Represent the number of times a fee is applied based on its frequency.
                  format: int32
                  minimum: 1
                  maximum: 30
                  example: 3
                isApproved:
                  $ref: '#/components/schemas/isApproved'
                waivePeriod:
                  $ref: '#/components/schemas/waivePeriod'
              required:
              - unitPrice
            additionalBoutiqueFee:
              type:
              - object
              - 'null'
              description: Represents a monetary charge applied to a transaction or service.
              properties:
                feeType:
                  $ref: '#/components/schemas/feeType'
                unitPrice:
                  $ref: '#/components/schemas/money'
                taxes:
                  type: array
                  description: A list of tax items associated with the fee.
                  items:
                    $ref: '#/components/schemas/tax'
                  maxItems: 10
                frequency:
                  description: The frequency at which the fee is charged, such as monthly or annually.
                  type:
                  - string
                  - 'null'
                  maxLength: 20
                  enum:
                  - DAILY
                  - MONTHLY
                  - QUARTERLY
                  - ONE_OFF
                  - ANNUALLY
                quantity:
                  type: integer
                  description: Represent the number of times a fee is applied based on its frequency.
                  format: int32
                  minimum: 1
                  maximum: 30
                  example: 3
                isApproved:
                  $ref: '#/components/schemas/isApproved'
                waivePeriod:
                  $ref: '#/components/schemas/waivePeriod'
              required:
              - unitPrice
            additionalBoutiqueOneTimeFee:
              type:
              - object
              - 'null'
              description: Represents a monetary charge applied to a transaction or service.
              properties:
                feeType:
                  $ref: '#/components/schemas/feeType'
                unitPrice:
                  $ref: '#/components/schemas/money'
                taxes:
                  type: array
                  description: A list of tax items associated with the fee.
                  items:
                    $ref: '#/components/schemas/tax'
                  maxItems: 10
                frequency:
                  description: The frequency at which the fee is charged, such as monthly or annually.
                  type:
                  - string
                  - 'null'
                  maxLength: 20
                  enum:
                  - DAILY
                  - MONTHLY
                  - QUARTERLY
                  - ONE_OFF
                  - ANNUALLY
                quantity:
                  type: integer
                  description: Represent the number of times a fee is applied based on its frequency.
                  format: int32
                  minimum: 1
                  maximum: 30
                  example: 3
                isApproved:
                  $ref: '#/components/schemas/isApproved'
                waivePeriod:
                  $ref: '#/components/schemas/waivePeriod'
              required:
              - unitPrice
            mobileAppFee:
              type:
              - object
              - 'null'
              description: Represents a monetary charge applied to a transaction or service.
              properties:
                feeType:
                  $ref: '#/components/schemas/feeType'
                unitPrice:
                  $ref: '#/components/schemas/money'
                taxes:
                  type: array
                  description: A list of tax items associated with the fee.
                  items:
                    $ref: '#/components/schemas/tax'
                  maxItems: 10
                frequency:
                  description: The frequency at which the fee is charged, such as monthly or annually.
                  type:
                  - string
                  - 'null'
                  maxLength: 20
                  enum:
                  - DAILY
                  - MONTHLY
                  - QUARTERLY
                  - ONE_OFF
                  - ANNUALLY
                quantity:
                  type: integer
                  description: Represent the number of times a fee is applied based on its frequency.
                  format: int32
                  minimum: 1
                  maximum: 30
                  example: 3
                isApproved:
                  $ref: '#/components/schemas/isApproved'
                waivePeriod:
                  $ref: '#/components/schemas/waivePeriod'
              required:
              - unitPrice
            mobileAppOneTimeFee:
              type:
              - object
              - 'null'
              description: Represents a monetary charge applied to a transaction or service.
              properties:
                feeType:
                  $ref: '#/components/schemas/feeType'
                unitPrice:
                  $ref: '#/components/schemas/money'
                taxes:
                  type: array
                  description: A list of tax items associated with the fee.
                  items:
                    $ref: '#/components/schemas/tax'
                  maxItems: 10
                frequency:
                  description: The frequency at which the fee is charged, such as monthly or annually.
                  type:
                  - string
                  - 'null'
                  maxLength: 20
                  enum:
                  - DAILY
                  - MONTHLY
                  - QUARTERLY
                  - ONE_OFF
                  - ANNUALLY
                quantity:
                  type: integer
                  description: Represent the number of times a fee is applied based on its frequency.
                  format: int32
                  minimum: 1
                  maximum: 30
                  example: 3
                isApproved:
                  $ref: '#/components/schemas/isApproved'
                waivePeriod:
                  $ref: '#/components/schemas/waivePeriod'
              required:
              - unitPrice
            webCreationAndHostingFee:
              type:
              - object
              - 'null'
              description: Represents a monetary charge applied to a transaction or service.
              properties:
                feeType:
                  $ref: '#/components/schemas/feeType'
                unitPrice:
                  $ref: '#/components/schemas/money'
                taxes:
                  type: array
                  description: A list of tax items associated with the fee.
                  items:
                    $ref: '#/components/schemas/tax'
                  maxItems: 10
                frequency:
                  description: The frequency at which the fee is charged, such as monthly or annually.
                  type:
                  - string
                  - 'null'
                  maxLength: 20
                  enum:
                  - DAILY
                  - MONTHLY
                  - QUARTERLY
                  - ONE_OFF
                  - ANNUALLY
                quantity:
                  type: integer
                  description: Represent the number of times a fee is applied based on its frequency.
                  format: int32
                  minimum: 1
                  maximum: 30
                  example: 3
                isApproved:
                  $ref: '#/components/schemas/isApproved'
                waivePeriod:
                  $ref: '#/components/schemas/waivePeriod'
              required:
              - unitPrice
            webCreationAndHostingOneTimeFee:
              type:
              - object
              - 'null'
              description: Represents a monetary charge applied to a transaction or service.
              properties:
                feeType:
                  $ref: '#/components/schemas/feeType'
                unitPrice:
                  $ref: '#/components/schemas/money'
                taxes:
                  type: array
                  description: A list of tax items associated with the fee.
                  items:
                    $ref: '#/components/schemas/tax'
                  maxItems: 10
                frequency:
                  description: The frequency at which the fee is charged, such as monthly or annually.
                  type:
                  - string
                  - 'null'
                  maxLength: 20
                  enum:
                  - DAILY
                  - MONTHLY
                  - QUARTERLY
                  - ONE_OFF
                  - ANNUALLY
                quantity:
                  type: integer
                  description: Represent the number of times a fee is applied based on its frequency.
                  format: int32
                  minimum: 1
                  maximum: 30
                  example: 3
                isApproved:
                  $ref: '#/components/schemas/isApproved'
                waivePeriod:
                  $ref: '#/components/schemas/waivePeriod'
              required:
              - unitPrice
            payAtRestaurantPerTransactionFee:
              type:
              - object
              - 'null'
              description: Represents a monetary charge applied to a transaction or service.
              properties:
                feeType:
                  $ref: '#/components/schemas/feeType'
                unitPrice:
                  $ref: '#/components/schemas/money'
                taxes:
                  type: array
                  description: A list of tax items associated with the fee.
                  items:
                    $ref: '#/components/schemas/tax'
                  maxItems: 10
                frequency:
                  description: The frequency at which the fee is charged, such as monthly or annually.
                  type:
                  - string
                  - 'null'
                  maxLength: 20
                  enum:
                  - DAILY
                  - MONTHLY
                  - QUARTERLY
                  - ONE_OFF
                  - ANNUALLY
                quantity:
                  type: integer
                  description: Represent the number of times a fee is applied based on its frequency.
                  format: int32
                  minimum: 1
                  maximum: 30
                  example: 3
                isApproved:
                  $ref: '#/components/schemas/isApproved'
                waivePeriod:
                  $ref: '#/components/schemas/waivePeriod'
              required:
              - unitPrice
            payAtRestaurantFee:
              type:
              - object
              - 'null'
              description: Represents a monetary charge applied to a transaction or service.
              properties:
                feeType:
                  $ref: '#/components/schemas/feeType'
                unitPrice:
                  $ref: '#/components/schemas/money'
                taxes:
                  type: array
                  description: A list of tax items associated with the fee.
                  items:
                    $ref: '#/components/schemas/tax'
                  maxItems: 10
                frequency:
                  description: The frequency at which the fee is charged, such as monthly or annually.
                  type:
                  - string
                  - 'null'
                  maxLength: 20
                  enum:
                  - DAILY
                  - MONTHLY
                  - QUARTERLY
                  - ONE_OFF
                  - ANNUALLY
                quantity:
                  type: integer
                  description: Represent the number of times a fee is applied based on its frequency.
                  format: int32
                  minimum: 1
                  maximum: 30
                  example: 3
                isApproved:
                  $ref: '#/components/schemas/isApproved'
                waivePeriod:
                  $ref: '#/components/schemas/waivePeriod'
              required:
              - unitPrice
            oneTimeTaxFee:
              type:
              - object
              - 'null'
              description: Represents a monetary charge applied to a transaction or service.
              properties:
                feeType:
                  $ref: '#/components/schemas/feeType'
                unitPrice:
                  $ref: '#/components/schemas/money'
                taxes:
                  type: array
                  description: A list of tax items associated with the fee.
                  items:
                    $ref: '#/components/schemas/tax'
                  maxItems: 10
                frequency:
                  description: The frequency at which the fee is charged, such as monthly or annually.
                  type:
                  - string
                  - 'null'
                  maxLength: 20
                  enum:
                  - DAILY
                  - MONTHLY
                  - QUARTERLY
                  - ONE_OFF
                  - ANNUALLY
                quantity:
                  type: integer
                  description: Represent the number of times a fee is applied based on its frequency.
                  format: int32
                  minimum: 1
                  maximum: 30
                  example: 3
                isApproved:
                  $ref: '#/components/schemas/isApproved'
                waivePeriod:
                  $ref: '#/components/schemas/waivePeriod'
              required:
              - unitPrice
        isLiveIn30:
          type: boolean
          description: A boolean flag indicating whether the Ueat product is live in 30 days.
        additionalNote:
          type:
          - string
          - 'null'
          description: Additional note or comments related to the Ueat product.
          maxLength: 500
        additionalLocations:
          type: array
          maxItems: 10
          description: A list of additional locations associated with the Ueat product.
          items:
            $ref: '#/components/schemas/address'
    tax:
      type: object
      description: An object that contains information about the tax applied to an order fee.
      properties:
        taxName:
          type: string
          description: The name of the tax applied to the fee.
          enum:
          - GOODS_SERVICES_TAX
          - PROVINCIAL_SALES_TAX
          - HARMONIZED_SALES_TAX
        taxAmount:
          $ref: '#/components/schemas/money'
      required:
      - taxName
      - taxAmount
    lastName:
      type:
      - string
      - 'null'
      description: Last name.
      minLength: 1
      maxLength: 30
      example: Doe
    maximumDisqualifiedTransactionMerchantDiscountRate:
      type: number
      description: The maximum merchant discount rate value applied to transactions that do not meet certain qualifying criteria under the transaction plan.
      default: 0
      format: double
      minimum: 0
      maximum: 1
    programs:
      type: array
      description: A list of programs associated with the card plan.
      maxItems: 6
      uniqueItems: true
      items:
        type: string
        enum:
        - AMEX_EXPRESS
        - DISCOVER_ZIP
        - INTERAC_FLASH
        - MASTERCARD_PAY_PASS
        - UNION_PAY_QUICK_PASS
        - VISA_VEPS
    bookmark:
      type:
      - object
      - 'null'
      description: An object containing details about the Bookmark product.
      properties:
        packageFee:
          type:
          - object
          - 'null'
          description: Represents a monetary charge applied to a transaction or service.
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
        packageName:
          type:
          - string
          - 'null'
          description: The package associated with the Bookmark product.
          maxLength: 50
        licenseName:
          type:
          - string
          - 'null'
          description: The name of the license associated with the Bookmark product.
          maxLength: 50
        referringSalesRepresentativeCode:
          type:
          - string
          - 'null'
          description: The code of the sales representative referring the Bookmark product.
          maxLength: 50
        bundleName:
          type:
          - string
          - 'null'
          description: The name of the bundle associated with the Bookmark product.
          maxLength: 50
        hasShoppingCard:
          type: boolean
          description: A boolean flag indicating whether the Bookmark product has a shopping card option.
        shoppingCardOptionName:
          type:
          - string
          - 'null'
          description: The name of the shopping card option associated with the Bookmark product.
          maxLength: 50
    payDropPlusFeeDetails:
      type:
      - object
      - 'null'
      description: A list of fees associated with PayD Pro Plus.
      properties:
        subTotalFee:
          description: The sum of all applicable fees before any additional charges.
          type:
          - object
          - 'null'
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
    assessmentPlan:
      type: object
      description: An object containing all details related to assessment plan.
      properties:
        merchantDiscountRate:
          description: The merchant discount rate applied to transactions under the assessment plan.
          type: number
          format: double
          default: 0
          minimum: 0
          maximum: 1
        transactionRate:
          description: The single payment processing event under the assessment plan.
          type: number
          default: 0
          format: double
          minimum: 0
          maximum: 1
        feeTypeCode:
          $ref: '#/components/schemas/feeTypeCode'
        cardOriginCode:
          $ref: '#/components/schemas/cardOriginCode'
    address:
      type: object
      description: 'The postal address including street, town/city, province, and postal code.

        Optionally an unit number can be provided.

        '
      properties:
        unitNumber:
          type:
          - string
          - 'null'
          description: Unit number
          minLength: 1
          maxLength: 19
          example: 123A
        streetNumber:
          type:
          - string
          - 'null'
          description: Street number
          minLength: 1
          maxLength: 19
          example: '3300'
        streetName:
          type:
          - string
          - 'null'
          description: Street name
          minLength: 1
          maxLength: 100
          example: Bloor
        city:
          type:
          - string
          - 'null'
          description: 'Identifies the city.

            '
          minLength: 1
          maxLength: 50
          example: Toronto
        province:
          type:
          - string
          - 'null'
          description: 'Province or state ISO 3166-2 code '
          minLength: 1
          maxLength: 3
          format: iso-3166-2
          example: 'ON'
        postalCode:
          type:
          - string
          - 'null'
          description: Postal or zip code
          minLength: 1
          maxLength: 30
          example: M8X 2X2
        country:
          type:
          - string
          - 'null'
          description: "Provides the two letter country code according the ISO 3166-1 alpha-2 standard. \nFor a complete list of country codes, visit: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2.\n"
          minLength: 2
          maxLength: 2
          example: CA
          format: iso-3166
      example:
        unitNumber: 123A
        streetNumber: '3300'
        streetName: Bloor Street West
        city: Toronto
        province: 'ON'
        postalCode: M8X 2X2
        country: CA
    money:
      type: object
      description: "Monetary amount. \nNote: The value must be in cents. Therefore $10.59 must be sent as 1059.\n"
      properties:
        amount:
          $ref: '#/components/schemas/amount'
        currency:
          $ref: '#/components/schemas/currency'
      required:
      - amount
      - currency
      example:
        amount: 16000
        currency: CAD
    selectedPlans:
      type: array
      description: A list of selected plans associated with the card plan.
      maxItems: 8
      uniqueItems: true
      items:
        type: string
        enum:
        - AMEX
        - DISCOVER
        - INTERAC
        - MASTERCARD
        - MASTERCARD_DEBIT
        - UNION_PAY
        - VISA
        - VISA_DEBIT
    pointOfSaleType:
      type:
      - string
      - 'null'
      description: Specifies the type of point of sale terminal being used.
      maxLength: 50
    otherFinancialInstitutionCardType:
      type:
      - string
      - 'null'
      description: Represents the specific type of card used within the OFI institution card plan.
      enum:
      - AMEX
      - CHEQUE_AUTHORIZATION
      - DINERS
      - DISCOVER
      - MASTERCARD
      - VISA
    terminalName:
      type: string
      description: The name of the terminal.
      example: Moneris Go
      maxLength: 255
    waivePeriod:
      type:
      - string
      - 'null'
      description: Specifies the period which the fee is waived and not charged to the user.
      format: period
      example: 2022-06-30T14:52:44.276/PT48H
      maxLength: 34
    orderCreatedBy:
      type:
      - string
      - 'null'
      description: The individual responsible for creating the order.
      maxLength: 100
      example: pcote03@PERCOM-> PERCOMpcote03
    firstName:
      type:
      - string
      - 'null'
      description: First name.
      minLength: 1
      maxLength: 30
      example: John
    solutionId:
      description: A unique identifier for the solutions object.
      type: integer
      format: int32
      example: 1
    counterTopTerminals:
      type: array
      description: A list of payment terminals available at the counter.
      items:
        $ref: '#/components/schemas/terminal'
      maxItems: 5
    pinpadCableType:
      type:
      - string
      - 'null'
      description: Specifies the type of the cable used to connect the PIN pad to the terminal.
      maxLength: 50
    monerisAdvanceFeeDetails:
      type:
      - object
      - 'null'
      description: A list of fees associated with Moneris Advance.
      properties:
        preferredAmountFee:
          description: The preferred amount charged for the Moneris Advance service.
          type:
          - object
          - 'null'
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
        chargeableAmountFee:
          description: The amount that is charged for the Moneris Advance service.
          type:
          - object
          - 'null'
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
    addressee:
      description: a (natural or legal) person that gets addressed
      type: object
      properties:
        firstName:
          $ref: '#/components/schemas/firstName'
        middleName:
          $ref: '#/components/schemas/middleName'
        lastName:
          $ref: '#/components/schemas/lastName'
        companyName:
          $ref: '#/components/schemas/companyName'
      required:
      - firstName
      - lastName
    monerisGoPortal:
      type:
      - object
      - 'null'
      description: An object containing the Moneris Go Portal details.
      properties:
        pricingModel:
          $ref: '#/components/schemas/pricingModel'
        feeDetails:
          $ref: '#/components/schemas/monerisGoPortalFeeDetails'
    domesticCardOriginCode:
      type:
      - string
      - 'null'
      description: A code used to identify the origin of a domestic card in a transaction under the card brand plan.
      maxLength: 10
    p2pe:
      type:
      - object
      - 'null'
      description: An object containing details about the P2PE product.
      properties:
        transactionVolume:
          type: integer
          description: The transaction volume for the P2PE product.
          format: int32
          minimum: 1
          maximum: 1000000
        quantity:
          type: integer
          description: The quantity of P2PE devices.
          format: int32
          minimum: 1
          maximum: 100
        feeDetails:
          type:
          - object
          - 'null'
          description: An object representing the fees associated with the P2PE product.
          properties:
            indoorFee:
              type:
              - object
              - 'null'
              description: Represents a monetary charge applied to a transaction or service.
              properties:
                feeType:
                  $ref: '#/components/schemas/feeType'
                unitPrice:
                  $ref: '#/components/schemas/money'
                taxes:
                  type: array
                  description: A list of tax items associated with the fee.
                  items:
                    $ref: '#/components/schemas/tax'
                  maxItems: 10
                frequency:
                  description: The frequency at which the fee is charged, such as monthly or annually.
                  type:
                  - string
                  - 'null'
                  maxLength: 20
                  enum:
                  - DAILY
                  - MONTHLY
                  - QUARTERLY
                  - ONE_OFF
                  - ANNUALLY
                quantity:
                  type: integer
                  description: Represent the number of times a fee is applied based on its frequency.
                  format: int32
                  minimum: 1
                  maximum: 30
                  example: 3
                isApproved:
                  $ref: '#/components/schemas/isApproved'
                waivePeriod:
                  $ref: '#/components/schemas/waivePeriod'
              required:
              - unitPrice
            outdoorFee:
              type:
              - object
              - 'null'
              description: Represents a monetary charge applied to a transaction or service.
              properties:
                feeType:
                  $ref: '#/components/schemas/feeType'
                unitPrice:
                  $ref: '#/components/schemas/money'
                taxes:
                  type: array
                  description: A list of tax items associated with the fee.
                  items:
                    $ref: '#/components/schemas/tax'
                  maxItems: 10
                frequency:
                  description: The frequency at which the fee is charged, such as monthly or annually.
                  type:
                  - string
                  - 'null'
                  maxLength: 20
                  enum:
                  - DAILY
                  - MONTHLY
                  - QUARTERLY
                  - ONE_OFF
                  - ANNUALLY
                quantity:
                  type: integer
                  description: Represent the number of times a fee is applied based on its frequency.
                  format: int32
                  minimum: 1
                  maximum: 30
                  example: 3
                isApproved:
                  $ref: '#/components/schemas/isApproved'
                waivePeriod:
                  $ref: '#/components/schemas/waivePeriod'
              required:
              - unitPrice
            transactionFee:
              type:
              - object
              - 'null'
              description: Represents a monetary charge applied to a transaction or service.
              properties:
                feeType:
                  $ref: '#/components/schemas/feeType'
                unitPrice:
                  $ref: '#/components/schemas/money'
                taxes:
                  type: array
                  description: A list of tax items associated with the fee.
                  items:
                    $ref: '#/components/schemas/tax'
                  maxItems: 10
                frequency:
                  description: The frequency at which the fee is charged, such as monthly or annually.
                  type:
                  - string
                  - 'null'
                  maxLength: 20
                  enum:
                  - DAILY
                  - MONTHLY
                  - QUARTERLY
                  - ONE_OFF
                  - ANNUALLY
                quantity:
                  type: integer
                  description: Represent the number of times a fee is applied based on its frequency.
                  format: int32
                  minimum: 1
                  maximum: 30
                  example: 3
                isApproved:
                  $ref: '#/components/schemas/isApproved'
                waivePeriod:
                  $ref: '#/components/schemas/waivePeriod'
              required:
              - unitPrice
            solutionFee:
              type:
              - object
              - 'null'
              description: Represents a monetary charge applied to a transaction or service.
              properties:
                feeType:
                  $ref: '#/components/schemas/feeType'
                unitPrice:
                  $ref: '#/components/schemas/money'
                taxes:
                  type: array
                  description: A list of tax items associated with the fee.
                  items:
                    $ref: '#/components/schemas/tax'
                  maxItems: 10
                frequency:
                  description: The frequency at which the fee is charged, such as monthly or annually.
                  type:
                  - string
                  - 'null'
                  maxLength: 20
                  enum:
                  - DAILY
                  - MONTHLY
                  - QUARTERLY
                  - ONE_OFF
                  - ANNUALLY
                quantity:
                  type: integer
                  description: Represent the number of times a fee is applied based on its frequency.
                  format: int32
                  minimum: 1
                  maximum: 30
                  example: 3
                isApproved:
                  $ref: '#/components/schemas/isApproved'
                waivePeriod:
                  $ref: '#/components/schemas/waivePeriod'
              required:
              - unitPrice
    cardBrandPlans:
      type: array
      description: A list of card brand items.
      items:
        $ref: '#/components/schemas/cardBrandPlan'
      maxItems: 20
    payDropPlus:
      type:
      - object
      - 'null'
      description: An object containing the PayD Pro Plus details.
      properties:
        feeDetails:
          $ref: '#/components/schemas/payDropPlusFeeDetails'
    ofiCardPlan:
      type: object
      description: An object containing all details about the Ofi Card Plan.
      properties:
        otherFinancialInstitutionCardType:
          $ref: '#/components/schemas/otherFinancialInstitutionCardType'
        cardAcquirer:
          $ref: '#/components/schemas/cardAcquirer'
        merchantNumber:
          $ref: '#/components/schemas/merchantNumber'
        region:
          $ref: '#/components/schemas/region'
        transitNumber:
          $ref: '#/components/schemas/transitNumber'
        accountNumber:
          $ref: '#/components/schemas/accountNumber'
        transactionFee:
          type:
          - object
          - 'null'
          description: Represents a monetary charge applied to a transaction or service.
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
        depositType:
          $ref: '#/components/schemas/depositType'
        authorizationDescription:
          $ref: '#/components/schemas/authorizationDescription'
        cardOption:
          $ref: '#/components/schemas/cardOption'
    bookmarkPro:
      type:
      - object
      - 'null'
      description: An object containing details about the Bookmark Pro product.
      properties:
        professionalFee:
          type:
          - object
          - 'null'
          description: Represents a monetary charge applied to a transaction or service.
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
        referringSalesRepresentativeCode:
          type:
          - string
          - 'null'
          description: The code of the sales representative referring the Bookmark Pro product.
          maxLength: 50
    thirdPartyGiftCardFeeDetails:
      type:
      - object
      - 'null'
      description: An object representing the fees associated with third-party gift cards.
      properties:
        programMonthlyFee:
          type:
          - object
          - 'null'
          description: Represents a monetary charge applied to a transaction or service.
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
        perTransactionFee:
          type:
          - object
          - 'null'
          description: Represents a monetary charge applied to a transaction or service.
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
    monerisGoPointOfSaleRetailFeeDetails:
      type:
      - object
      - 'null'
      description: A list of fees associated with Moneris Go POS Retail.
      properties:
        goRetailFee:
          description: A fee associated with retail operations.
          type:
          - object
          - 'null'
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
    productDetails:
      type: object
      description: An object containing all details related to a product.
      properties:
        isPointOfSaleSoftware:
          type: boolean
          description: A boolean flag indicating whether the transaction or device is using a Software Point of Sale solution.
        monerisAdvance:
          $ref: '#/components/schemas/monerisAdvance'
        counterTopTerminals:
          $ref: '#/components/schemas/counterTopTerminals'
        integratedProduct:
          $ref: '#/components/schemas/integratedProduct'
        storeAndForward:
          $ref: '#/components/schemas/storeAndForward'
        petroTrak:
          $ref: '#/components/schemas/petroTrak'
        multiCurrency:
          $ref: '#/components/schemas/multiCurrencyProduct'
        dynamicCurrencyConversion:
          $ref: '#/components/schemas/multiCurrencyProduct'
        bookmark:
          $ref: '#/components/schemas/bookmark'
        bookmarkPro:
          $ref: '#/components/schemas/bookmarkPro'
        thirdPartyGiftCardFeeDetails:
          $ref: '#/components/schemas/thirdPartyGiftCardFeeDetails'
        ueat:
          $ref: '#/components/schemas/ueat'
        monerisGoAppetit:
          $ref: '#/components/schemas/monerisGoAppetit'
        webCreationPackagesFeeDetails:
          $ref: '#/components/schemas/webCreationPackagesFeeDetails'
        installmentsFeeDetails:
          $ref: '#/components/schemas/installmentsFeeDetails'
        wixPointOfSale:
          $ref: '#/components/schemas/wixPointOfSale'
        p2pe:
          $ref: '#/components/schemas/p2pe'
        wireless:
          $ref: '#/components/schemas/wireless'
        monerisGateway:
          $ref: '#/components/schemas/monerisGateway'
        monerisGoPointOfSaleRetail:
          $ref: '#/components/schemas/monerisGoPointOfSaleRetail'
        monerisGoPortal:
          $ref: '#/components/schemas/monerisGoPortal'
        payDropPlus:
          $ref: '#/components/schemas/payDropPlus'
    parameterError:
      title: Parameter error
      description: Request property or header related error.
      type: object
      properties:
        parameterName:
          type: string
          description: Property or header name. Can contain nested path separated by '.'
          example: address.postalCode
        parameterValue:
          type:
          - string
          - 'null'
          description: Property or header value string representation.
          example: MAP3J8
        reasonCode:
          type: string
          description: Reason that triggered the error.
          enum:
          - INVALID_FORMAT
          - REQUIRED_FIELD
          - INVALID_VALUE
          example: INVALID_FORMAT
        errorMessage:
          type:
          - string
          - 'null'
          description: Human readable description of the error.
          example: String 'MAP3J8' does not match the postal code pattern.
      required:
      - parameterName
      - reasonCode
    monerisGoAppetit:
      type:
      - object
      - 'null'
      description: An object containing details about the Moneris Go Appetit product.
      properties:
        softwarePackageName:
          type:
          - string
          - 'null'
          description: The name of the software package associated with the Moneris Go Appetit product.
          maxLength: 100
        referringSalesRepresentativeCode:
          type:
          - string
          - 'null'
          description: The code of the sales representative referring the Moneris Go Appetit product.
          maxLength: 50
        hasDevice:
          type: boolean
          description: A boolean flag indicating whether the Moneris Go Appetit product includes a device.
        timeZoneName:
          type:
          - string
          - 'null'
          description: The time zone associated with the Moneris Go Appetit product.
          maxLength: 50
        feeDetails:
          type:
          - object
          - 'null'
          description: An object representing the fees associated with the Moneris Go Appetit product.
          properties:
            softwarePackageFee:
              type:
              - object
              - 'null'
              description: Represents a monetary charge applied to a transaction or service.
              properties:
                feeType:
                  $ref: '#/components/schemas/feeType'
                unitPrice:
                  $ref: '#/components/schemas/money'
                taxes:
                  type: array
                  description: A list of tax items associated with the fee.
                  items:
                    $ref: '#/components/schemas/tax'
                  maxItems: 10
                frequency:
                  description: The frequency at which the fee is charged, such as monthly or annually.
                  type:
                  - string
                  - 'null'
                  maxLength: 20
                  enum:
                  - DAILY
                  - MONTHLY
                  - QUARTERLY
                  - ONE_OFF
                  - ANNUALLY
                quantity:
                  type: integer
                  description: Represent the number of times a fee is applied based on its frequency.
                  format: int32
                  minimum: 1
                  maximum: 30
                  example: 3
                isApproved:
                  $ref: '#/components/schemas/isApproved'
                waivePeriod:
                  $ref: '#/components/schemas/waivePeriod'
              required:
              - unitPrice
            tabletLicenseFee:
              type:
              - object
              - 'null'
              description: Represents a monetary charge applied to a transaction or service.
              properties:
                feeType:
                  $ref: '#/components/schemas/feeType'
                unitPrice:
                  $ref: '#/components/schemas/money'
                taxes:
                  type: array
                  description: A list of tax items associated with the fee.
                  items:
                    $ref: '#/components/schemas/tax'
                  maxItems: 10
                frequency:
                  description: The frequency at which the fee is charged, such as monthly or annually.
                  type:
                  - string
                  - 'null'
                  maxLength: 20
                  enum:
                  - DAILY
                  - MONTHLY
                  - QUARTERLY
                  - ONE_OFF
                  - ANNUALLY
                quantity:
                  type: integer
                  description: Represent the number of times a fee is applied based on its frequency.
                  format: int32
                  minimum: 1
                  maximum: 30
                  example: 3
                isApproved:
                  $ref: '#/components/schemas/isApproved'
                waivePeriod:
                  $ref: '#/components/schemas/waivePeriod'
              required:
              - unitPrice
            reservationFee:
              type:
              - object
              - 'null'
              description: Represents a monetary charge applied to a transaction or service.
              properties:
                feeType:
                  $ref: '#/components/schemas/feeType'
                unitPrice:
                  $ref: '#/components/schemas/money'
                taxes:
                  type: array
                  description: A list of tax items associated with the fee.
                  items:
                    $ref: '#/components/schemas/tax'
                  maxItems: 10
                frequency:
                  description: The frequency at which the fee is charged, such as monthly or annually.
                  type:
                  - string
                  - 'null'
                  maxLength: 20
                  enum:
                  - DAILY
                  - MONTHLY
                  - QUARTERLY
                  - ONE_OFF
                  - ANNUALLY
                quantity:
                  type: integer
                  description: Represent the number of times a fee is applied based on its frequency.
                  format: int32
                  minimum: 1
                  maximum: 30
                  example: 3
                isApproved:
                  $ref: '#/components/schemas/isApproved'
                waivePeriod:
                  $ref: '#/components/schemas/waivePeriod'
              required:
              - unitPrice
            onlineOrderingFee:
              type:
              - object
              - 'null'
              description: Represents a monetary charge applied to a transaction or service.
              properties:
                feeType:
                  $ref: '#/components/schemas/feeType'
                unitPrice:
                  $ref: '#/components/schemas/money'
                taxes:
                  type: array
                  description: A list of tax items associated with the fee.
                  items:
                    $ref: '#/components/schemas/tax'
                  maxItems: 10
                frequency:
                  description: The frequency at which the fee is charged, such as monthly or annually.
                  type:
                  - string
                  - 'null'
                  maxLength: 20
                  enum:
                  - DAILY
                  - MONTHLY
                  - QUARTERLY
                  - ONE_OFF
                  - ANNUALLY
                quantity:
                  type: integer
                  description: Represent the number of times a fee is applied based on its frequency.
                  format: int32
                  minimum: 1
                  maximum: 30
                  example: 3
                isApproved:
                  $ref: '#/components/schemas/isApproved'
                waivePeriod:
                  $ref: '#/components/schemas/waivePeriod'
              required:
              - unitPrice
    error:
      description: Error response details.
      properties:
        type:
          description: 'A URI reference that identifies the problem type.  Ideally it should be a stable URL to the documentation of the details about this type of error but it also can be a URN.  If nothing can be provided, a "about:blank" value is returned.

            '
          type: string
          format: uri
          example: https://api-developer.moneris.com/responsehandling
        title:
          description: 'A short, human-readable summary of the problem type.   It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization

            '
          type:
          - string
          - 'null'
          example: INSUFFICIENT_FUNDS
        status:
          description: 'it conveys the HTTP status code used for the convenience of the consumer.

            '
          type:
          - integer
          - 'null'
          format: int32
          minimum: 100
          maximum: 505
        detail:
          description: 'A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.

            '
          type:
          - string
          - 'null'
          example: Funds are insufficient to execute the operation.
        instance:
          description: 'A URI reference that identifies the specific occurrence of the problem. Typically, this resolves to a resource that might include more details about the problem.

            '
          type:
          - string
          - 'null'
          example: /payments/12f3e0a8-1d68-2b86-dd30-4ca51bb66e10
          format: uri-reference
        category:
          description: "The type of error returned. \n - `API_ERROR`: This occurs due to an intermittent issue.  \n - `IDEMPOTENCY_ERROR`: The idempotency key has already been used.\n - `INVALID_REQUEST_ERROR`: The data provided in the request is invalid.\n - `DECLINED_ERROR`: Transaction was declined by the issuer.\n - `UNAUTHORIZED_ERROR`: Caller not authenticated, or not allowed to execute the current operation.\n - `INTERNAL_SERVER_ERROR`: An internal issue with our servers has occured.\n"
          enum:
          - API_ERROR
          - IDEMPOTENCY_ERROR
          - INVALID_REQUEST_ERROR
          - DECLINED_ERROR
          - UNAUTHORIZED_ERROR
          - INTERNAL_SERVER_ERROR
          - null
          type:
          - string
          - 'null'
          example: DECLINED_ERROR
        errors:
          type: array
          description: List of validation errors when error category is INVALID_REQUEST_ERROR.
          items:
            type: object
            $ref: '#/components/schemas/parameterError'
          example:
          - parameterName: address.postalCode
            parameterValue: MAP3J8
            errorMessage: address.Postal code does not match regular expression
            reasonCode: INVALID_FORMAT
      title: API Error
      type: object
      required:
      - type
    order:
      type: object
      description: An object containing all the details related to the order details response.
      required:
      - merchantOrderId
      - merchantId
      properties:
        merchantOrderId:
          $ref: '#/components/schemas/merchantOrderId'
        merchantId:
          $ref: '#/components/schemas/merchantId'
        userIdentifier:
          type:
          - string
          - 'null'
          description: Identifies the user associated with the order.
        representativeCode:
          type:
          - string
          - 'null'
          description: Represents the identifies for the sales representative associated to the order.
        adjudicationRequired:
          type: boolean
          description: A boolean flag that indicates whether the order requires an adjudication process.
        orderStatus:
          $ref: '#/components/schemas/orderStatus'
        orderType:
          type:
          - string
          - 'null'
          description: The classification or category of the order.
          enum:
          - CHIP
          - EXISTING_MERCHANT
          - EXISTING_MERCHANT_ADD_POS
          - EXISTING_MERCHANT_NEW_POS
          - EXISTING_MERCHANT_UPGRADE_POS
          - EXISTING_POS
          - M9000
          - MERCHANT_UPDATE
          - NET_NEW_MERCHANT
          - PRICING_UPDATE
          - READJUDICATION
          - SC220
          - SC220CAN
        orderOpenedAt:
          type:
          - string
          - 'null'
          description: A datetime attribute that records the exact date and time when the order was initiated in ISO 8601 format.
          format: date-time
          example: '2025-03-21T18:10:00Z'
        orderChangedAt:
          type:
          - string
          - 'null'
          description: A datetime attribute that records the exact date and time when the order was modified in ISO 8601 format.
          format: date-time
          example: '2025-03-21T18:10:00Z'
        orderApprovedAt:
          type:
          - string
          - 'null'
          description: A datetime attribute that records the exact date and time when the order was approved in ISO 8601 format.
          format: date-time
          example: '2025-03-21T18:10:00Z'
        orderDeclinedAt:
          type:
          - string
          - 'null'
          description: A datetime attribute that records the exact date and time when the order was declined in ISO 8601 format.
          format: date-time
          example: '2025-03-21T18:10:00Z'
        orderClosedAt:
          type:
          - string
          - 'null'
          description: A datetime attribute that records the exact date and time when the order was closed in ISO 8601 format.
          format: date-time
          example: '2025-03-21T18:10:00Z'
        contractSent:
          type: boolean
          description: A boolean flag indicating whether the date the contract was sent.
        feeDetails:
          $ref: '#/components/schemas/feeDetails'
        promotionInformation:
          type:
          - object
          - 'null'
          description: An object containing information related to the promotion associated with the order.
          properties:
            promotionCode:
              type:
              - string
              - 'null'
              description: A string attribute used to store a promotional or discount code that maybe applied to the order.
            promotionName:
              type:
              - string
              - 'null'
              description: The name or title of the promotional offer associated with the promoCode.
            promotionExpirationDate:
              type:
              - string
              - 'null'
              description: A datetime attribute that indicates the expiration date of the promotional offer in ISO 8601 format.
              format: date-time
              example: '2025-10-21T18:10:00Z'
            promotionDescription:
              type:
              - string
              - 'null'
              description: A string attribute that provides additional information about the promotion.
        supplies:
          $ref: '#/components/schemas/supplies'
        productDetails:
          type:
          - object
          - 'null'
          description: An object containing all details related to a product.
          properties:
            isPointOfSaleSoftware:
              type: boolean
              description: A boolean flag indicating whether the transaction or device is using a Software Point of Sale solution.
            monerisAdvance:
              $ref: '#/components/schemas/monerisAdvance'
            counterTopTerminals:
              $ref: '#/components/schemas/counterTopTerminals'
            integratedProduct:
              $ref: '#/components/schemas/integratedProduct'
            storeAndForward:
              $ref: '#/components/schemas/storeAndForward'
            petroTrak:
              $ref: '#/components/schemas/petroTrak'
            multiCurrency:
              $ref: '#/components/schemas/multiCurrencyProduct'
            dynamicCurrencyConversion:
              $ref: '#/components/schemas/multiCurrencyProduct'
            bookmark:
              $ref: '#/components/schemas/bookmark'
            bookmarkPro:
              $ref: '#/components/schemas/bookmarkPro'
            thirdPartyGiftCardFeeDetails:
              $ref: '#/components/schemas/thirdPartyGiftCardFeeDetails'
            ueat:
              $ref: '#/components/schemas/ueat'
            monerisGoAppetit:
              $ref: '#/components/schemas/monerisGoAppetit'
            webCreationPackagesFeeDetails:
              $ref: '#/components/schemas/webCreationPackagesFeeDetails'
            installmentsFeeDetails:
              $ref: '#/components/schemas/installmentsFeeDetails'
            wixPointOfSale:
              $ref: '#/components/schemas/wixPointOfSale'
            p2pe:
              $ref: '#/components/schemas/p2pe'
            wireless:
              $ref: '#/components/schemas/wireless'
            monerisGateway:
              $ref: '#/components/schemas/monerisGateway'
            monerisGoPointOfSaleRetail:
              $ref: '#/components/schemas/monerisGoPointOfSaleRetail'
            monerisGoPortal:
              $ref: '#/components/schemas/monerisGoPortal'
            payDropPlus:
              $ref: '#/components/schemas/payDropPlus'
        bankerInformation:
          type:
          - object
          - 'null'
          description: An object containing all details related to banker information.
          properties:
            bankerEmail:
              type:
              - string
              - 'null'
              format: email
              description: 'Contains the customer''s email address.


                For standard email protocols, visit: https://www.rfc-editor.org/rfc/rfc5322

                '
              minLength: 1
              maxLength: 320
              example: moneris@moneris.com
            bankerEmployeeNumber:
              type:
              - string
              - 'null'
              description: A string attribute that uniquely identifies the employee of the bank responsible.
              maxLength: 20
              example: '242200024'
            bankerName:
              type:
              - string
              - 'null'
              description: The full name of the banker representative.
              maxLength: 50
              example: MONIKA  CARNOKA
            bankerPhoneNumber:
              type:
              - string
              - 'null'
              description: Phone number.
              pattern: ^\+[1-9]\d{1,14}$
              minLength: 3
              maxLength: 16
              example: '+18663197450'
            bankerPhoneNumberExtension:
              type:
              - string
              - 'null'
              description: The phone number extension of the banker representative.
              maxLength: 50
              pattern: ^[0-9]{1,6}$
              example: '1068'
            bankerTransitNumber:
              type:
              - string
              - 'null'
              description: The identifier of the transit bank associated.
              maxLength: 5
              example: '00160'
              pattern: ^\d{5}
            bankerBranchIdentifier:
              type:
              - string
              - 'null'
              description: The branch identifier of the bank where the banker is located.
              maxLength: 5
              example: '2679'
        cardPlanDetails:
          type:
          - object
          - 'null'
          description: An object containing all the card plans details.
          properties:
            merchantDiscountRateType:
              $ref: '#/components/schemas/merchantDiscountRateType'
            currency:
              type:
              - string
              - 'null'
              description: "Provides the three letter currency code according the ISO 4217 standard. \n\nFor a complete list of currency codes, visit: https://en.wikipedia.org/wiki/ISO_4217\n"
              minLength: 3
              maxLength: 4
              example: CAD
              format: iso-4217
            transactionFeeParameterCode:
              $ref: '#/components/schemas/transactionFeeParameterCode'
            cardBrandTemplateIdentifier:
              $ref: '#/components/schemas/cardBrandTemplateIdentifier'
            selectedPlans:
              $ref: '#/components/schemas/selectedPlans'
            mastercard:
              type:
              - object
              - 'null'
              description: An object containing the franchise plan details.
              properties:
                isCommunicationsOptOut:
                  $ref: '#/components/schemas/isCommunicationsOptOut'
                cardFeeDetails:
                  $ref: '#/components/schemas/cardFeeDetails'
                transactionPlans:
                  $ref: '#/components/schemas/transactionPlans'
                cardBrandPlans:
                  $ref: '#/components/schemas/cardBrandPlans'
                assessmentPlans:
                  $ref: '#/components/schemas/assessmentPlans'
                serviceFeeDetails:
                  $ref: '#/components/schemas/serviceFeeDetails'
            mastercardDebit:
              type:
              - object
              - 'null'
              description: An object containing the franchise plan details.
              properties:
                isCommunicationsOptOut:
                  $ref: '#/components/schemas/isCommunicationsOptOut'
                cardFeeDetails:
                  $ref: '#/components/schemas/cardFeeDetails'
                transactionPlans:
                  $ref: '#/components/schemas/transactionPlans'
                cardBrandPlans:
                  $ref: '#/components/schemas/cardBrandPlans'
                assessmentPlans:
                  $ref: '#/components/schemas/assessmentPlans'
                serviceFeeDetails:
                  $ref: '#/components/schemas/serviceFeeDetails'
            visa:
              type:
              - object
              - 'null'
              description: An object containing the franchise plan details.
              properties:
                isCommunicationsOptOut:
                  $ref: '#/components/schemas/isCommunicationsOptOut'
                cardFeeDetails:
                  $ref: '#/components/schemas/cardFeeDetails'
                transactionPlans:
                  $ref: '#/components/schemas/transactionPlans'
                cardBrandPlans:
                  $ref: '#/components/schemas/cardBrandPlans'
                assessmentPlans:
                  $ref: '#/components/schemas/assessmentPlans'
                serviceFeeDetails:
                  $ref: '#/components/schemas/serviceFeeDetails'
            visaDebit:
              type:
              - object
              - 'null'
              description: An object containing the franchise plan details.
              properties:
                isCommunicationsOptOut:
                  $ref: '#/components/schemas/isCommunicationsOptOut'
                cardFeeDetails:
                  $ref: '#/components/schemas/cardFeeDetails'
                transactionPlans:
                  $ref: '#/components/schemas/transactionPlans'
                cardBrandPlans:
                  $ref: '#/components/schemas/cardBrandPlans'
                assessmentPlans:
                  $ref: '#/components/schemas/assessmentPlans'
                serviceFeeDetails:
                  $ref: '#/components/schemas/serviceFeeDetails'
            discover:
              type:
              - object
              - 'null'
              description: An object containing the franchise plan details.
              properties:
                isCommunicationsOptOut:
                  $ref: '#/components/schemas/isCommunicationsOptOut'
                cardFeeDetails:
                  $ref: '#/components/schemas/cardFeeDetails'
                transactionPlans:
                  $ref: '#/components/schemas/transactionPlans'
                cardBrandPlans:
                  $ref: '#/components/schemas/cardBrandPlans'
                assessmentPlans:
                  $ref: '#/components/schemas/assessmentPlans'
                serviceFeeDetails:
                  $ref: '#/components/schemas/serviceFeeDetails'
            unionPay:
              type:
              - object
              - 'null'
              description: An object containing the franchise plan details.
              properties:
                isCommunicationsOptOut:
                  $ref: '#/components/schemas/isCommunicationsOptOut'
                cardFeeDetails:
                  $ref: '#/components/schemas/cardFeeDetails'
                transactionPlans:
                  $ref: '#/components/schemas/transactionPlans'
                cardBrandPlans:
                  $ref: '#/components/schemas/cardBrandPlans'
                assessmentPlans:
                  $ref: '#/components/schemas/assessmentPlans'
                serviceFeeDetails:
                  $ref: '#/components/schemas/serviceFeeDetails'
            interac:
              type:
              - object
              - 'null'
              description: An object containing the franchise plan details.
              properties:
                isCommunicationsOptOut:
                  $ref: '#/components/schemas/isCommunicationsOptOut'
                cardFeeDetails:
                  $ref: '#/components/schemas/cardFeeDetails'
                transactionPlans:
                  $ref: '#/components/schemas/transactionPlans'
                cardBrandPlans:
                  $ref: '#/components/schemas/cardBrandPlans'
                assessmentPlans:
                  $ref: '#/components/schemas/assessmentPlans'
                serviceFeeDetails:
                  $ref: '#/components/schemas/serviceFeeDetails'
            amex:
              type:
              - object
              - 'null'
              description: An object containing the franchise plan details.
              properties:
                isCommunicationsOptOut:
                  $ref: '#/components/schemas/isCommunicationsOptOut'
                cardFeeDetails:
                  $ref: '#/components/schemas/cardFeeDetails'
                transactionPlans:
                  $ref: '#/components/schemas/transactionPlans'
                cardBrandPlans:
                  $ref: '#/components/schemas/cardBrandPlans'
                assessmentPlans:
                  $ref: '#/components/schemas/assessmentPlans'
                serviceFeeDetails:
                  $ref: '#/components/schemas/serviceFeeDetails'
            otherFinancialInstitutionCards:
              $ref: '#/components/schemas/otherFinancialInstitutionCards'
            programs:
              $ref: '#/components/schemas/programs'
        pointOfSaleSolutionType:
          type:
          - string
          - 'null'
          description: Indicates the type of Point of Sale solution being used or requested.
          enum:
          - POINT_OF_SALE_WITH_OFI
          - MONERIS_POINT_OF_SALE
          - PAPER_DEPOSIT
        deploymentTransactionNumber:
          type:
          - string
          - 'null'
          description: The transaction number associated with the deployment process.
        deploymentWorkOrderReference:
          type:
          - string
          - 'null'
          description: The work order number associated with the deployment process.
        deploymentWorkOrderStatus:
          type:
          - string
          - 'null'
          description: The work order status associated with the deployment process.
          enum:
          - SHIPPED
          - COMPLETE
          - MAX_RETRIES_EXCEEDED
          - CANCELLED
          - ACCEPTED
          - REJECTED
          - SYSTEM_ERROR
          - ON_HOLD
        shippedAt:
          type:
          - string
          - 'null'
          description: A datetime attribute that indicates the shipping date of the product or service in ISO 8601 format .
          format: date-time
          example: '2025-10-21T18:10:00Z'
        shippingType:
          type:
          - string
          - 'null'
          description: A string attribute representing the type of shipping method used for delivering the product.
          enum:
          - POINT_OF_SALE_AND_SUPPLIES
          - SUPPLIES_ONLY
        shippingWayBillNumber:
          type:
          - string
          - 'null'
          description: The tracking number or waybill number assigned to the shipment.
        shippingCourierName:
          type:
          - string
          - 'null'
          description: The name of the shipping or courier company responsible for delivering the product or service.
        installedAt:
          type:
          - string
          - 'null'
          description: A date attribute representing the scheduled or actual date when the installation of a product or service is completed in ISO 8601 format.
          format: date
          example: '2025-10-21'
        installationType:
          type:
          - string
          - 'null'
          description: The category of the installation process.
          enum:
          - TRAIN_ONLY
          - INSTALL
          - INSTALL_AND_TRAIN
        installationMethod:
          type:
          - string
          - 'null'
          description: The method of the installation process.
          enum:
          - PRO
          - STANDARD
          - ONSITE
          - MERCHANT_INSTALL
          - ONSITE_STANDARD_INSTALLATION
          - ONSITE_PRO_INSTALLATION
          - VIRTUAL_TRAINING_AND_SETUP_ASSISTANCE
          - ONSITE_PREMIUM_INSTALLATION
          - PREMIUM
          - PHONE
        installationWorkOrderReference:
          type:
          - string
          - 'null'
          description: The work order of the installation process.
        isAcceptedByConduct:
          type: boolean
          description: Represents the acceptance of terms, conditions or agreement based on the actions of conduct of the parties involved.
        contractSignatureRequired:
          type: boolean
          description: A boolean flag indicating whether a formal signature is required to validate or complete a contract.
        faxRequired:
          type: boolean
          description: A boolean flag indicating whether faxing a document is necessary.
        additionalInformation:
          type:
          - string
          - 'null'
          description: A general purpose attribute used to represent additional information.
        businessEntityName:
          type:
          - string
          - 'null'
          description: The name of the business entity.
        readyAt:
          type:
          - string
          - 'null'
          description: Refers to the date when a product, service, or order is expected to be ready in ISO 8601 format.
          format: date-time
          example: '2025-10-21T18:10:00Z'
        isMerchantReadyToAccept:
          type: boolean
          description: Indicates whether the merchant is prepared to accept the order.
        applicationScore:
          type: integer
          description: The categorical score assigned to an application.
          format: int64
        marginValue:
          type:
          - string
          - 'null'
          description: The specific metric related to the margin value.
        priorityTier:
          type:
          - string
          - 'null'
          description: The priority level assigned to an order.
          enum:
          - ONE
          - TWO
          - THREE
          - FOUR
        referralInformation:
          type:
          - object
          - 'null'
          description: An object containing information related to the referral process.
          properties:
            partnerName:
              $ref: '#/components/schemas/partnerName'
            transitNumber:
              type:
              - string
              - 'null'
              description: The transit number of the partner that referred the lead to the business.
            employeeFirstName:
              type:
              - string
              - 'null'
              description: The first name of the partner that referred the lead to the business.
            employeeLastName:
              type:
              - string
              - 'null'
              description: The last name of the partner that referred the lead to the business.
            description:
              type:
              - string
              - 'null'
              description: The details of the partner that referred the lead to the business.
            additionalInformation:
              type:
              - string
              - 'null'
              description: The additional information of the partner that referred the lead to the business.
        hostType:
          type:
          - string
          - 'null'
          description: The category of host that the service is running on.
          enum:
          - ESSENTIS
          - OTHER
        isExpeditedOrder:
          type: boolean
          description: A boolean flag indicting whether an order is being processed with an expedited status.
        autoApprovalStatus:
          type:
          - string
          - 'null'
          description: The status of an automatic approval process of an order.
          enum:
          - CONDITIONALLY_APPROVED
          - MANUAL
          - MANUAL_ADJUDICATION
          - NOT_APPLICABLE
          - PENDING_ADJUDICATION
          - PROCESSING
        adjudicationApprovalStatus:
          type:
          - string
          - 'null'
          description: The status that indicates whether an order has been approved or rejected during adjudication process.
          example: MANUAL
          enum:
          - AUTOMATIC
          - MANUAL
          - PENDING_ADJUDICATION
        hasImprinter:
          type: boolean
          description: A boolean flag indicating whether an imprinter is available in the transaction process.
        isMarketSubSegmentationPreApprovalRequired:
          type: boolean
          description: The attribute related to pre-approval of market segmentation.
        optOutAmexCommunication:
          type: boolean
          description: A boolean flag indicating whether a customer has opted out of receiving communications from American Express.
        multiCurrencyPricingPackageId:
          type: integer
          description: The identifier associated with a package.
          format: int64
        deliveryAddressConfirmed:
          type: boolean
          description: A boolean flag indicating whether the delivery address has been confirmed.
        isManualDeploymentRequired:
          type: boolean
          description: Indicates whether a process deployment needs to be performed manually.
        isDeficient:
          type: boolean
          description: Indicates whether something is lacking or deficient related to the order.
        preDeficientOrderStatus:
          type:
          - string
          - 'null'
          description: The status of an order before it is flagged as deficient.
          enum:
          - ADJUDICATION
          - COLLATERAL_REQUIRED
          - COMPLIANCE
          - COMPLETE
          - DEPLOYMENT
          - FINAL_ACI_MERCHANT_UPDATE
          - IN_PROGRESS
          - MANUAL_ADJUDICATION
          - MANUAL_ADJUDICATION_REVIEW
          - ONE_TIME_FEE
          - POST_BOARDING_DP_FLOW
          - READJUDICATION
          - READJUDICATION_FLOW
          - SCHEDULE_INSTALL
          - SALES_ACTIVATION_BASE24
          - SALES_ACTIVATION_POST_DEPLOYMENT
          - SALES_APPROVAL
          - START_ORDER
          - UPDATE_ORDER
    transferDeviceReference:
      type:
      - string
      - 'null'
      description: Indicates the identifier of the device being transferred as part of the current terminal request.
      maxLength: 50
    merchantDiscountRateType:
      type:
      - string
      - 'null'
      description: The type of Merchant Discount Rate applied to a card plan.
      enum:
      - NET
      - GROSS
      - GROSS_GROSS
    serviceFeeDetails:
      type:
      - object
      - 'null'
      description: An object containing the service fees details.
      properties:
        authorizationFee:
          type:
          - object
          - 'null'
          description: Represents a monetary charge applied to a transaction or service.
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
        maintenanceFee:
          type:
          - object
          - 'null'
          description: Represents a monetary charge applied to a transaction or service.
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
    marketSegment:
      type:
      - string
      - 'null'
      description: Identifies the specific customer or business segment targeted by a product or service.
      enum:
      - PAYROC
      - ADVANCE_IT
      - ATB
      - ATB_8760
      - ADYEN
      - BRAINTREE
      - CYDCOR
      - DIRECT_CASH
      - INTUIT
      - MCA
      - OPTIMAL
      - PAYSAFE_RETAIL_RESELLER
      - PROTOCOL
      - SAGE
      - SONA
      - SOFT_TECH
      - TILL_PAYMENTS
      - UEAT
      - CLEVERPAYS
      - PAYLITE
      - ILIXIUM
      - LOYALTY_SENSE
      - POWER_PAYMENTS
      - PAYMENT_EXPERTS
      - INTERNATIONAL_PAYMENT_SOLUTIONS
      - PAYOLOGY
      - NATIONAL_PAYMENTS
    feeTypeCode:
      type:
      - string
      - 'null'
      description: A code that identifies the type of fee associated with a transaction.
      enum:
      - ACCESS_POINT_CHARGE_FOR_VISA
      - AFD_PRE_AUTHORIZATION_TEST_FEE
      - AMEX_INBOUND_FEE
      - AMEX_JCB_PARTICIPATION_FEE
      - CARD_BRAND_FEES
      - CARD_BRAND_MAINTENANCE_FEE
      - CNP_MANUAL_ENTRY_FEE
      - CONSUMER_BILL_PAYMENT_SERVICE
      - DISCOVER_ASSESSMENT_FEE
      - DISCOVER_INTERNATIONAL_PROCESS
      - DISPUTE_ADJUSTMENT
      - DO_NOT_USE
      - DO_NOT_USE_ERROR_SET_UP
      - DO_NOT_USE_REDUNDANT
      - ELECTRONIC_COMMERCE_FEE
      - FACILITY_USE_FEE
      - GATEWAY_TRANSACTION_FEE
      - HAULAGE_FEE
      - HIGH_RISK_TRANSACTION_FEE
      - INSTALLMENT_ELIGIBILITY
      - INSTALLMENT_FUNDING
      - INSTALLMENT_TRANSACTION
      - INTERAC_ASSESSMENT_FEE
      - INTERAC_DIRECT_ASSESSMENT
      - INTERAC_ONLINE_FEE
      - IVR_TRANSACTION_FEE
      - KIOSK_TRANSACTION_FEE
      - MASTERCARD_ACQUIRER_LICENSE_FEE
      - MASTERCARD_ASSESSMENT_FEE
      - MASTERCARD_ASSESSMENT_FEE_FOREIGN
      - MASTERCARD_ASSESSMENT_TRANSACTION_FEE_CREDIT
      - MASTERCARD_FLEX_PROGRAM_FEE
      - MASTERCARD_FREIGHT_ASSESSMENT
      - MASTERCARD_GL_WH_TRAVEL_TRANSACTION_PROGRAM_B2B_FEE
      - MASTERCARD_HUMANITARIAN_ASSESSMENT
      - MASTERCARD_INTERNATIONAL_TRANSACTION_PROCESSING_FEE
      - MASTERCARD_MAIL_PHONE_ORDER
      - MASTERCARD_PRE_AUTHORIZATION_AFD
      - MASTERCARD_PRE_AUTHORIZATION_AFD_MINIMUM
      - MASTERCARD_SAFETY_NET_ACQUIRER_FEE
      - MDR_PROCESSING_FEE
      - MONERIS_MARKETPLACE_SERVICE
      - NETWORK_CONNECTIVITY_FEE
      - NON_QUALIFIED_FEE
      - OPERATOR_ADMINISTRATION
      - P2PE_BLUEFIN_SOLUTION
      - P2PE_COSTCO_BLUEFIN_SOLUTION
      - P2PE_MONERIS_SOLUTION
      - P2PE_TRANSACTION_FEE
      - PARTNER_TRANSACTION_FEE
      - REFUND_TRANSACTION_FEE
      - RETURN_ADJUSTMENT
      - ROYALTY_FEE
      - SETTLEMENT_FEE
      - SOFTPOS_TAP_TO_PAY
      - STERLING_INTERAC_REMUNERATION
      - SURCHARGE_ENABLEMENT_FEE
      - SURCHARGE_FEE
      - TEST_FEE
      - THREE_DS_AUTHENTICATION_FEE
      - UNIONPAY_SERVICE_FEE
      - VAR_TRANSACTION_FEE
      - VISA_ASSESSMENT_FEE
      - VISA_B2B_VIRTUAL_SERVICE_FEE
      - VISA_COMMERCIAL_SOLUTIONS_ASSISTANCE
      - VISA_DIRECT_ASSESSMENT_FEE
      - VISA_FOREIGN_ASSESSMENT
      - VISA_FOREIGN_FEE
      - VISA_MCP_NON_DOMESTIC_CHARGE
      - VISA_NON_DOMESTIC_SETTLEMENT
      - VISA_SYSTEM_ACCESS_FEE
    minimumMerchantDiscountRate:
      type: number
      description: The minimum merchant discount rate that applies under the transaction plan.
      format: double
      default: 0
      minimum: 0
      maximum: 1
    accountNumber:
      type:
      - string
      - 'null'
      description: Attribute that represent the unique identifier for a bank account.
      maxLength: 10
    monerisGateway:
      type:
      - object
      - 'null'
      description: An object containing details about the Moneris Gateway product.
      properties:
        isPaymentRequestForMonerisGateway:
          type: boolean
          description: A boolean flag indicating whether the payment request is specifically for the Moneris Gateway product.
        isEcommerce:
          type: boolean
          description: A boolean flag indicating whether the product is intended for online environments.
        cardNotPresentConfigurationCode:
          $ref: '#/components/schemas/cardNotPresentConfigurationCode'
        feeDetails:
          $ref: '#/components/schemas/monerisGatewayFeeDetails'
    cardOriginCode:
      type:
      - string
      - 'null'
      description: A code that indicates the origin of the card.
      enum:
      - IRAC
      - IRAR
      - FRGN
      - FRGX
      - ALL
      - IERR
      - ONUS
      - IERX
    pricingModel:
      type:
      - string
      - 'null'
      description: Defines the pricing structure for the services provided.
      maxLength: 30
    isAutoAdjudicationRequired:
      type: boolean
      description: A boolean flag indicating whether the auto adjudication process is required.
    wirelessFeeDetails:
      type:
      - object
      - 'null'
      description: A list of fees associated with the wireless product.
      properties:
        activationFee:
          description: A one-time fee charged for activating the wireless service.
          type:
          - object
          - 'null'
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
        goSoftwareFee:
          description: A fee associated with the Moneris Go software for wireless devices.
          type:
          - object
          - 'null'
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
    valueAddedServices:
      type: array
      description: A list of value-added services associated with the order.
      maxItems: 18
      items:
        type: string
        enum:
        - ABU
        - BOOKMARK
        - BOOKMARK_PRO
        - DCC
        - GIFT_CARD
        - INSTALLMENTS
        - INTERAC_ECOM
        - INTERAC_ONLINE
        - LOYALTY
        - MCP
        - MONERIS_ADVANCE
        - P2PE
        - PAYMENT_REQUEST
        - SAF
        - THIRD_PARTY_GIFT_CARD
        - VAU
        - WEB_CREATION_PACKAGES
        - WIX
      uniqueItems: true
    transactionPlan:
      type: object
      description: An object containing the transaction plan details.
      properties:
        merchantDiscountRate:
          $ref: '#/components/schemas/merchantDiscountRate'
        minimumMerchantDiscountRate:
          $ref: '#/components/schemas/minimumMerchantDiscountRate'
        maximumMerchantDiscountRate:
          $ref: '#/components/schemas/maximumMerchantDiscountRate'
        transactionRate:
          $ref: '#/components/schemas/transactionRate'
        minimumTransactionValue:
          description: The minimum transaction value that applies under the transaction plan.
          type:
          - object
          - 'null'
          properties:
            amount:
              $ref: '#/components/schemas/amount'
            currency:
              $ref: '#/components/schemas/currency'
          required:
          - amount
          - currency
          example:
            amount: 16000
            currency: CAD
        maximumTransactionValue:
          description: The maximum transaction value that applies under the transaction plan.
          type:
          - object
          - 'null'
          properties:
            amount:
              $ref: '#/components/schemas/amount'
            currency:
              $ref: '#/components/schemas/currency'
          required:
          - amount
          - currency
          example:
            amount: 16000
            currency: CAD
        disqualifiedTransactionMerchantDiscountRate:
          $ref: '#/components/schemas/disqualifiedTransactionMerchantDiscountRate'
        transactionPlanTier:
          $ref: '#/components/schemas/transactionPlanTier'
        feeTypeCode:
          $ref: '#/components/schemas/feeTypeCode'
        paymentModeCode:
          $ref: '#/components/schemas/paymentModeCode'
        minimumDisqualifiedTransactionMerchantDiscountRate:
          $ref: '#/components/schemas/minimumDisqualifiedTransactionMerchantDiscountRate'
        maximumDisqualifiedTransactionMerchantDiscountRate:
          $ref: '#/components/schemas/maximumDisqualifiedTransactionMerchantDiscountRate'
    userIdentifier:
      type:
      - string
      - 'null'
      description: A unique identifier assigned to a user within the system.
      maxLength: 30
    storeAndForward:
      type:
      - object
      - 'null'
      description: An object containing details about the Store and Forward product.
      properties:
        isEnabled:
          type: boolean
          description: A boolean flag indicating whether the Store and Forward product is enabled.
        storedCumulativeTransactionVolume:
          type: integer
          description: A string representing the cumulative transaction volume stored in the Store and Forward product.
          format: int32
        maximumStoredTransactionAmount:
          description: The maximum amount that can be stored in the Store and Forward product.
          type:
          - object
          - 'null'
          properties:
            amount:
              $ref: '#/components/schemas/amount'
            currency:
              $ref: '#/components/schemas/currency'
          required:
          - amount
          - currency
          example:
            amount: 16000
            currency: CAD
    collectionRate:
      type: integer
      description: The rate at which payments are collected or deducted.
      format: int32
      example: 10
    wixPointOfSale:
      type:
      - object
      - 'null'
      description: An object containing details about the Wix Point of Sale product.
      properties:
        hasDevice:
          type: boolean
          description: A boolean flag indicating whether the Wix Point of Sale product includes a device.
        lanesNumber:
          type: integer
          description: The number of lanes available for the Wix Point of Sale product.
          format: int32
          minimum: 1
          maximum: 100
        wixJson:
          type:
          - string
          - 'null'
          description: A JSON string containing additional details about the Wix Point of Sale product.
          maxLength: 1000
        softwareAccessFee:
          type:
          - object
          - 'null'
          description: Represents a monetary charge applied to a transaction or service.
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
    terminalCarrier:
      type:
      - string
      - 'null'
      description: The name of the mobile network operator or service provider.
      example: Telus
      maxLength: 255
    solutions:
      type: array
      description: A list of solution items.
      items:
        $ref: '#/components/schemas/solutionDetails'
      maxItems: 5
    agreementModelInformation:
      type:
      - object
      - 'null'
      description: An object containing the agreement model info details.
      properties:
        agreementModelCode:
          $ref: '#/components/schemas/agreementModelCode'
    cardBrandTemplateIdentifier:
      type:
      - string
      - 'null'
      description: Unique identifier that links to a predefined template associated with a specific card brand.
      maxLength: 10
    foreignTransactionPercentageFee:
      type: number
      description: The percentage fee applied to transactions involving foreign cards.
      default: 0
      format: float
      minimum: 0
      maximum: 100
    createPartnerBankOrderRequest:
      type: object
      description: An object containing all the Order payload partner bank details.
      properties:
        idempotencyKey:
          $ref: '#/components/schemas/idempotencyKey'
        solutions:
          $ref: '#/components/schemas/solutions'
        deliveryAddress:
          type:
          - object
          - 'null'
          description: An object containing the delivery address details.
          allOf:
          - $ref: '#/components/schemas/address'
          - $ref: '#/components/schemas/addressee'
        bankerInformation:
          $ref: '#/components/schemas/bankerInformation'
        orderCreatedBy:
          $ref: '#/components/schemas/orderCreatedBy'
      required:
      - idempotencyKey
      - solutions
      - deliveryAddress
      - bankerInformation
    idempotencyKey:
      type: string
      description: "A Unique Identifier that is required for handling idempotent requests. \n\nNote: Moneris encourages the use of UUID Version 4 in APIs as an idempotency key.\"    \n"
      minLength: 1
      maxLength: 36
      example: 6q5w4e7r8t9y
    cardBrandPlan:
      type: object
      description: An object containing the card brand plan details.
      properties:
        foreignTransactionPercentageFee:
          $ref: '#/components/schemas/foreignTransactionPercentageFee'
        domesticTransactionPercentageFee:
          $ref: '#/components/schemas/domesticTransactionPercentageFee'
        domesticFlatFee:
          type:
          - object
          - 'null'
          description: Represents a monetary charge applied to a transaction or service.
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
        foreignCardOriginCode:
          $ref: '#/components/schemas/foreignCardOriginCode'
        domesticCardOriginCode:
          $ref: '#/components/schemas/domesticCardOriginCode'
    middleName:
      type:
      - string
      - 'null'
      description: Customer's middle name.
      minLength: 1
      maxLength: 30
      example: J.
    webCreationPackagesFeeDetails:
      type:
      - object
      - 'null'
      description: An object representing the fees associated with web creation packages.
      properties:
        standardPlusFee:
          type:
          - object
          - 'null'
          description: Represents a monetary charge applied to a transaction or service.
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
        optionalServicesFee:
          type:
          - object
          - 'null'
          description: Represents a monetary charge applied to a transaction or service.
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
    petroTrak:
      type:
      - object
      - 'null'
      description: An object containing details about the PetroTrak product.
      properties:
        feeDetails:
          type:
          - object
          - 'null'
          description: An object representing the fees associated with the PetroTrak product.
          properties:
            receivableAccountsTransactionFee:
              description: A fee applied to accounts receivable transactions.
              type:
              - object
              - 'null'
              properties:
                feeType:
                  $ref: '#/components/schemas/feeType'
                unitPrice:
                  $ref: '#/components/schemas/money'
                taxes:
                  type: array
                  description: A list of tax items associated with the fee.
                  items:
                    $ref: '#/components/schemas/tax'
                  maxItems: 10
                frequency:
                  description: The frequency at which the fee is charged, such as monthly or annually.
                  type:
                  - string
                  - 'null'
                  maxLength: 20
                  enum:
                  - DAILY
                  - MONTHLY
                  - QUARTERLY
                  - ONE_OFF
                  - ANNUALLY
                quantity:
                  type: integer
                  description: Represent the number of times a fee is applied based on its frequency.
                  format: int32
                  minimum: 1
                  maximum: 30
                  example: 3
                isApproved:
                  $ref: '#/components/schemas/isApproved'
                waivePeriod:
                  $ref: '#/components/schemas/waivePeriod'
              required:
              - unitPrice
            softwareFee:
              description: A fee applied for the use of software related to the PetroTrak product.
              type:
              - object
              - 'null'
              properties:
                feeType:
                  $ref: '#/components/schemas/feeType'
                unitPrice:
                  $ref: '#/components/schemas/money'
                taxes:
                  type: array
                  description: A list of tax items associated with the fee.
                  items:
                    $ref: '#/components/schemas/tax'
                  maxItems: 10
                frequency:
                  description: The frequency at which the fee is charged, such as monthly or annually.
                  type:
                  - string
                  - 'null'
                  maxLength: 20
                  enum:
                  - DAILY
                  - MONTHLY
                  - QUARTERLY
                  - ONE_OFF
                  - ANNUALLY
                quantity:
                  type: integer
                  description: Represent the number of times a fee is applied based on its frequency.
                  format: int32
                  minimum: 1
                  maximum: 30
                  example: 3
                isApproved:
                  $ref: '#/components/schemas/isApproved'
                waivePeriod:
                  $ref: '#/components/schemas/waivePeriod'
              required:
              - unitPrice
        deviceOwnershipName:
          type:
          - string
          - 'null'
          description: The name of the device ownership for the PetroTrak product.
          maxLength: 100
        siteNumber:
          type:
          - string
          - 'null'
          description: The site number associated with the PetroTrak product.
          maxLength: 50
        corporateBrand:
          type:
          - string
          - 'null'
          description: The corporate brand associated with the PetroTrak product.
          maxLength: 50
        profileIdentifier:
          type:
          - string
          - 'null'
          description: A unique identifier for the PetroTrak profile.
          maxLength: 50
        profileName:
          type:
          - string
          - 'null'
          description: The name of the PetroTrak profile.
          maxLength: 100
        lines:
          type: array
          description: A list of lines associated with the PetroTrak product.
          maxItems: 50
          items:
            type: object
            properties:
              binRange:
                type:
                - string
                - 'null'
                maxLength: 255
                description: The range of BINs (Bank Identification Numbers) associated with the PetroTrak product.
              lowPrefix:
                type:
                - string
                - 'null'
                description: The low prefix associated with the PetroTrak product.
                maxLength: 50
              highPrefix:
                type:
                - string
                - 'null'
                description: The high prefix associated with the PetroTrak product.
                maxLength: 50
              service:
                type:
                - string
                - 'null'
                description: The service type associated with the PetroTrak product.
                maxLength: 50
              discountRate:
                type:
                - string
                - 'null'
                description: The discount rate type associated with the PetroTrak product.
                maxLength: 50
              discountRateValue:
                description: The discount rate value associated with the PetroTrak product.
                type:
                - object
                - 'null'
                properties:
                  amount:
                    $ref: '#/components/schemas/amount'
                  currency:
                    $ref: '#/components/schemas/currency'
                required:
                - amount
                - currency
                example:
                  amount: 16000
                  currency: CAD
        terminals:
          type: array
          description: A list of payment terminals available for the PetroTrak product.
          items:
            $ref: '#/components/schemas/terminal'
          maxItems: 21
    multiCurrencyProduct:
      type:
      - object
      - 'null'
      description: An object containing details about the multi currency product.
      properties:
        feeDetails:
          type:
          - object
          - 'null'
          description: An object representing the fees associated with the multi-currency product.
          properties:
            setupFee:
              type:
              - object
              - 'null'
              description: Represents a monetary charge applied to a transaction or service.
              properties:
                feeType:
                  $ref: '#/components/schemas/feeType'
                unitPrice:
                  $ref: '#/components/schemas/money'
                taxes:
                  type: array
                  description: A list of tax items associated with the fee.
                  items:
                    $ref: '#/components/schemas/tax'
                  maxItems: 10
                frequency:
                  description: The frequency at which the fee is charged, such as monthly or annually.
                  type:
                  - string
                  - 'null'
                  maxLength: 20
                  enum:
                  - DAILY
                  - MONTHLY
                  - QUARTERLY
                  - ONE_OFF
                  - ANNUALLY
                quantity:
                  type: integer
                  description: Represent the number of times a fee is applied based on its frequency.
                  format: int32
                  minimum: 1
                  maximum: 30
                  example: 3
                isApproved:
                  $ref: '#/components/schemas/isApproved'
                waivePeriod:
                  $ref: '#/components/schemas/waivePeriod'
              required:
              - unitPrice
            nonDomesticSettlementFee:
              type:
              - object
              - 'null'
              description: Represents a monetary charge applied to a transaction or service.
              properties:
                feeType:
                  $ref: '#/components/schemas/feeType'
                unitPrice:
                  $ref: '#/components/schemas/money'
                taxes:
                  type: array
                  description: A list of tax items associated with the fee.
                  items:
                    $ref: '#/components/schemas/tax'
                  maxItems: 10
                frequency:
                  description: The frequency at which the fee is charged, such as monthly or annually.
                  type:
                  - string
                  - 'null'
                  maxLength: 20
                  enum:
                  - DAILY
                  - MONTHLY
                  - QUARTERLY
                  - ONE_OFF
                  - ANNUALLY
                quantity:
                  type: integer
                  description: Represent the number of times a fee is applied based on its frequency.
                  format: int32
                  minimum: 1
                  maximum: 30
                  example: 3
                isApproved:
                  $ref: '#/components/schemas/isApproved'
                waivePeriod:
                  $ref: '#/components/schemas/waivePeriod'
              required:
              - unitPrice
            visaBusinessToBusinessVirtualForeignFee:
              type:
              - object
              - 'null'
              description: Represents a monetary charge applied to a transaction or service.
              properties:
                feeType:
                  $ref: '#/components/schemas/feeType'
                unitPrice:
                  $ref: '#/components/schemas/money'
                taxes:
                  type: array
                  description: A list of tax items associated with the fee.
                  items:
                    $ref: '#/components/schemas/tax'
                  maxItems: 10
                frequency:
                  description: The frequency at which the fee is charged, such as monthly or annually.
                  type:
                  - string
                  - 'null'
                  maxLength: 20
                  enum:
                  - DAILY
                  - MONTHLY
                  - QUARTERLY
                  - ONE_OFF
                  - ANNUALLY
                quantity:
                  type: integer
                  description: Represent the number of times a fee is applied based on its frequency.
                  format: int32
                  minimum: 1
                  maximum: 30
                  example: 3
                isApproved:
                  $ref: '#/components/schemas/isApproved'
                waivePeriod:
                  $ref: '#/components/schemas/waivePeriod'
              required:
              - unitPrice
            visaBusinessToBusinessVirtualForeignSingleCurrencyFee:
              type:
              - object
              - 'null'
              description: Represents a monetary charge applied to a transaction or service.
              properties:
                feeType:
                  $ref: '#/components/schemas/feeType'
                unitPrice:
                  $ref: '#/components/schemas/money'
                taxes:
                  type: array
                  description: A list of tax items associated with the fee.
                  items:
                    $ref: '#/components/schemas/tax'
                  maxItems: 10
                frequency:
                  description: The frequency at which the fee is charged, such as monthly or annually.
                  type:
                  - string
                  - 'null'
                  maxLength: 20
                  enum:
                  - DAILY
                  - MONTHLY
                  - QUARTERLY
                  - ONE_OFF
                  - ANNUALLY
                quantity:
                  type: integer
                  description: Represent the number of times a fee is applied based on its frequency.
                  format: int32
                  minimum: 1
                  maximum: 30
                  example: 3
                isApproved:
                  $ref: '#/components/schemas/isApproved'
                waivePeriod:
                  $ref: '#/components/schemas/waivePeriod'
              required:
              - unitPrice
            visaBusinessToBusinessAssessmentForeignSingleCurrencyFee:
              type:
              - object
              - 'null'
              description: Represents a monetary charge applied to a transaction or service.
              properties:
                feeType:
                  $ref: '#/components/schemas/feeType'
                unitPrice:
                  $ref: '#/components/schemas/money'
                taxes:
                  type: array
                  description: A list of tax items associated with the fee.
                  items:
                    $ref: '#/components/schemas/tax'
                  maxItems: 10
                frequency:
                  description: The frequency at which the fee is charged, such as monthly or annually.
                  type:
                  - string
                  - 'null'
                  maxLength: 20
                  enum:
                  - DAILY
                  - MONTHLY
                  - QUARTERLY
                  - ONE_OFF
                  - ANNUALLY
                quantity:
                  type: integer
                  description: Represent the number of times a fee is applied based on its frequency.
                  format: int32
                  minimum: 1
                  maximum: 30
                  example: 3
                isApproved:
                  $ref: '#/components/schemas/isApproved'
                waivePeriod:
                  $ref: '#/components/schemas/waivePeriod'
              required:
              - unitPrice
            visaBusinessToBusinessAssessmentForeignFee:
              type:
              - object
              - 'null'
              description: Represents a monetary charge applied to a transaction or service.
              properties:
                feeType:
                  $ref: '#/components/schemas/feeType'
                unitPrice:
                  $ref: '#/components/schemas/money'
                taxes:
                  type: array
                  description: A list of tax items associated with the fee.
                  items:
                    $ref: '#/components/schemas/tax'
                  maxItems: 10
                frequency:
                  description: The frequency at which the fee is charged, such as monthly or annually.
                  type:
                  - string
                  - 'null'
                  maxLength: 20
                  enum:
                  - DAILY
                  - MONTHLY
                  - QUARTERLY
                  - ONE_OFF
                  - ANNUALLY
                quantity:
                  type: integer
                  description: Represent the number of times a fee is applied based on its frequency.
                  format: int32
                  minimum: 1
                  maximum: 30
                  example: 3
                isApproved:
                  $ref: '#/components/schemas/isApproved'
                waivePeriod:
                  $ref: '#/components/schemas/waivePeriod'
              required:
              - unitPrice
            visaAssessmentSingleCurrencyFee:
              type:
              - object
              - 'null'
              description: Represents a monetary charge applied to a transaction or service.
              properties:
                feeType:
                  $ref: '#/components/schemas/feeType'
                unitPrice:
                  $ref: '#/components/schemas/money'
                taxes:
                  type: array
                  description: A list of tax items associated with the fee.
                  items:
                    $ref: '#/components/schemas/tax'
                  maxItems: 10
                frequency:
                  description: The frequency at which the fee is charged, such as monthly or annually.
                  type:
                  - string
                  - 'null'
                  maxLength: 20
                  enum:
                  - DAILY
                  - MONTHLY
                  - QUARTERLY
                  - ONE_OFF
                  - ANNUALLY
                quantity:
                  type: integer
                  description: Represent the number of times a fee is applied based on its frequency.
                  format: int32
                  minimum: 1
                  maximum: 30
                  example: 3
                isApproved:
                  $ref: '#/components/schemas/isApproved'
                waivePeriod:
                  $ref: '#/components/schemas/waivePeriod'
              required:
              - unitPrice
            visaAssessmentForeignFee:
              type:
              - object
              - 'null'
              description: Represents a monetary charge applied to a transaction or service.
              properties:
                feeType:
                  $ref: '#/components/schemas/feeType'
                unitPrice:
                  $ref: '#/components/schemas/money'
                taxes:
                  type: array
                  description: A list of tax items associated with the fee.
                  items:
                    $ref: '#/components/schemas/tax'
                  maxItems: 10
                frequency:
                  description: The frequency at which the fee is charged, such as monthly or annually.
                  type:
                  - string
                  - 'null'
                  maxLength: 20
                  enum:
                  - DAILY
                  - MONTHLY
                  - QUARTERLY
                  - ONE_OFF
                  - ANNUALLY
                quantity:
                  type: integer
                  description: Represent the number of times a fee is applied based on its frequency.
                  format: int32
                  minimum: 1
                  maximum: 30
                  example: 3
                isApproved:
                  $ref: '#/components/schemas/isApproved'
                waivePeriod:
                  $ref: '#/components/schemas/waivePeriod'
              required:
              - unitPrice
        packageIdentifier:
          type:
          - string
          - 'null'
          description: A unique identifier for the multi-currency pricing package.
          maxLength: 50
        packageDescription:
          type:
          - string
          - 'null'
          description: A description of the multi-currency pricing package.
          maxLength: 100
        markUpPercentage:
          type: number
          description: The mark up percentage charged for multi currency transactions.
          format: float
          minimum: 0
          maximum: 100
        revenueSharePercentage:
          type: number
          description: The percentage of revenue shared with the merchant.
          format: float
          minimum: 0
          maximum: 100
    feeType:
      type:
      - string
      - 'null'
      description: Specifies the category or purpose of the fee applied to a transaction or service.
      maxLength: 30
    cardFeeDetails:
      type:
      - object
      - 'null'
      description: An object containing the card fees plan details.
      properties:
        authorizationFee:
          type:
          - object
          - 'null'
          description: Represents a monetary charge applied to a transaction or service.
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
        refundAmount:
          description: A numeric value representing the amount of money refunded to a customer under the franchise plan.
          type:
          - object
          - 'null'
          properties:
            amount:
              $ref: '#/components/schemas/amount'
            currency:
              $ref: '#/components/schemas/currency'
          required:
          - amount
          - currency
          example:
            amount: 16000
            currency: CAD
        settlementAmount:
          type:
          - object
          - 'null'
          description: "Monetary amount. \nNote: The value must be in cents. Therefore $10.59 must be sent as 1059.\n"
          properties:
            amount:
              $ref: '#/components/schemas/amount'
            currency:
              $ref: '#/components/schemas/currency'
          required:
          - amount
          - currency
          example:
            amount: 16000
            currency: CAD
    applicablePromotions:
      type: array
      description: A list of promotion codes applicable to the order.
      maxItems: 10
      items:
        type: string
        maxLength: 100
    supplyName:
      type: string
      description: Indicates the name of the good available for fulfillment or distribution.
      maxLength: 100
      example: 2-PLY Sales Draft Slips (25)
    createStandardOrderRequest:
      type: object
      description: Represents the payload for submitting an order.
      properties:
        idempotencyKey:
          $ref: '#/components/schemas/idempotencyKey'
        marketSegment:
          $ref: '#/components/schemas/marketSegment'
        representativeCode:
          $ref: '#/components/schemas/representativeCode'
        userDetails:
          $ref: '#/components/schemas/userDetails'
        applicablePromotions:
          $ref: '#/components/schemas/applicablePromotions'
        feeDetails:
          $ref: '#/components/schemas/feeDetails'
        applicationDetails:
          $ref: '#/components/schemas/applicationDetails'
        agreementModelInformation:
          $ref: '#/components/schemas/agreementModelInformation'
        valueAddedServices:
          $ref: '#/components/schemas/valueAddedServices'
        documentsStatus:
          $ref: '#/components/schemas/documentsStatus'
        confirmation:
          $ref: '#/components/schemas/confirmation'
        supplies:
          $ref: '#/components/schemas/supplies'
        productDetails:
          $ref: '#/components/schemas/productDetails'
        isAutoAdjudicationRequired:
          $ref: '#/components/schemas/isAutoAdjudicationRequired'
        isExpeditedOrder:
          $ref: '#/components/schemas/isExpeditedOrder'
        cardPlanDetails:
          type:
          - object
          - 'null'
          description: An object containing all the card plans details.
          properties:
            merchantDiscountRateType:
              $ref: '#/components/schemas/merchantDiscountRateType'
            currency:
              type:
              - string
              - 'null'
              description: "Provides the three letter currency code according the ISO 4217 standard. \n\nFor a complete list of currency codes, visit: https://en.wikipedia.org/wiki/ISO_4217\n"
              minLength: 3
              maxLength: 4
              example: CAD
              format: iso-4217
            transactionFeeParameterCode:
              $ref: '#/components/schemas/transactionFeeParameterCode'
            cardBrandTemplateIdentifier:
              $ref: '#/components/schemas/cardBrandTemplateIdentifier'
            selectedPlans:
              $ref: '#/components/schemas/selectedPlans'
            mastercard:
              type:
              - object
              - 'null'
              description: An object containing the franchise plan details.
              properties:
                isCommunicationsOptOut:
                  $ref: '#/components/schemas/isCommunicationsOptOut'
                cardFeeDetails:
                  $ref: '#/components/schemas/cardFeeDetails'
                transactionPlans:
                  $ref: '#/components/schemas/transactionPlans'
                cardBrandPlans:
                  $ref: '#/components/schemas/cardBrandPlans'
                assessmentPlans:
                  $ref: '#/components/schemas/assessmentPlans'
                serviceFeeDetails:
                  $ref: '#/components/schemas/serviceFeeDetails'
            mastercardDebit:
              type:
              - object
              - 'null'
              description: An object containing the franchise plan details.
              properties:
                isCommunicationsOptOut:
                  $ref: '#/components/schemas/isCommunicationsOptOut'
                cardFeeDetails:
                  $ref: '#/components/schemas/cardFeeDetails'
                transactionPlans:
                  $ref: '#/components/schemas/transactionPlans'
                cardBrandPlans:
                  $ref: '#/components/schemas/cardBrandPlans'
                assessmentPlans:
                  $ref: '#/components/schemas/assessmentPlans'
                serviceFeeDetails:
                  $ref: '#/components/schemas/serviceFeeDetails'
            visa:
              type:
              - object
              - 'null'
              description: An object containing the franchise plan details.
              properties:
                isCommunicationsOptOut:
                  $ref: '#/components/schemas/isCommunicationsOptOut'
                cardFeeDetails:
                  $ref: '#/components/schemas/cardFeeDetails'
                transactionPlans:
                  $ref: '#/components/schemas/transactionPlans'
                cardBrandPlans:
                  $ref: '#/components/schemas/cardBrandPlans'
                assessmentPlans:
                  $ref: '#/components/schemas/assessmentPlans'
                serviceFeeDetails:
                  $ref: '#/components/schemas/serviceFeeDetails'
            visaDebit:
              type:
              - object
              - 'null'
              description: An object containing the franchise plan details.
              properties:
                isCommunicationsOptOut:
                  $ref: '#/components/schemas/isCommunicationsOptOut'
                cardFeeDetails:
                  $ref: '#/components/schemas/cardFeeDetails'
                transactionPlans:
                  $ref: '#/components/schemas/transactionPlans'
                cardBrandPlans:
                  $ref: '#/components/schemas/cardBrandPlans'
                assessmentPlans:
                  $ref: '#/components/schemas/assessmentPlans'
                serviceFeeDetails:
                  $ref: '#/components/schemas/serviceFeeDetails'
            discover:
              type:
              - object
              - 'null'
              description: An object containing the franchise plan details.
              properties:
                isCommunicationsOptOut:
                  $ref: '#/components/schemas/isCommunicationsOptOut'
                cardFeeDetails:
                  $ref: '#/components/schemas/cardFeeDetails'
                transactionPlans:
                  $ref: '#/components/schemas/transactionPlans'
                cardBrandPlans:
                  $ref: '#/components/schemas/cardBrandPlans'
                assessmentPlans:
                  $ref: '#/components/schemas/assessmentPlans'
                serviceFeeDetails:
                  $ref: '#/components/schemas/serviceFeeDetails'
            unionPay:
              type:
              - object
              - 'null'
              description: An object containing the franchise plan details.
              properties:
                isCommunicationsOptOut:
                  $ref: '#/components/schemas/isCommunicationsOptOut'
                cardFeeDetails:
                  $ref: '#/components/schemas/cardFeeDetails'
                transactionPlans:
                  $ref: '#/components/schemas/transactionPlans'
                cardBrandPlans:
                  $ref: '#/components/schemas/cardBrandPlans'
                assessmentPlans:
                  $ref: '#/components/schemas/assessmentPlans'
                serviceFeeDetails:
                  $ref: '#/components/schemas/serviceFeeDetails'
            interac:
              type:
              - object
              - 'null'
              description: An object containing the franchise plan details.
              properties:
                isCommunicationsOptOut:
                  $ref: '#/components/schemas/isCommunicationsOptOut'
                cardFeeDetails:
                  $ref: '#/components/schemas/cardFeeDetails'
                transactionPlans:
                  $ref: '#/components/schemas/transactionPlans'
                cardBrandPlans:
                  $ref: '#/components/schemas/cardBrandPlans'
                assessmentPlans:
                  $ref: '#/components/schemas/assessmentPlans'
                serviceFeeDetails:
                  $ref: '#/components/schemas/serviceFeeDetails'
            amex:
              type:
              - object
              - 'null'
              description: An object containing the franchise plan details.
              properties:
                isCommunicationsOptOut:
                  $ref: '#/components/schemas/isCommunicationsOptOut'
                cardFeeDetails:
                  $ref: '#/components/schemas/cardFeeDetails'
                transactionPlans:
                  $ref: '#/components/schemas/transactionPlans'
                cardBrandPlans:
                  $ref: '#/components/schemas/cardBrandPlans'
                assessmentPlans:
                  $ref: '#/components/schemas/assessmentPlans'
                serviceFeeDetails:
                  $ref: '#/components/schemas/serviceFeeDetails'
            otherFinancialInstitutionCards:
              $ref: '#/components/schemas/otherFinancialInstitutionCards'
            programs:
              $ref: '#/components/schemas/programs'
        solutions:
          $ref: '#/components/schemas/solutions'
        deliveryAddress:
          type:
          - object
          - 'null'
          description: An object containing the delivery address details.
          allOf:
          - $ref: '#/components/schemas/address'
          - $ref: '#/components/schemas/addressee'
        orderCreatedBy:
          $ref: '#/components/schemas/orderCreatedBy'
      required:
      - idempotencyKey
      - userDetails
      - productDetails
      - applicationDetails
    transactionPlans:
      type: array
      description: A list of transaction items.
      items:
        $ref: '#/components/schemas/transactionPlan'
      maxItems: 20
    installmentsFeeDetails:
      type:
      - object
      - 'null'
      description: An object representing the fees associated with installment payments.
      properties:
        monerisVisaInstallmentsFee:
          type:
          - object
          - 'null'
          description: Represents a monetary charge applied to a transaction or service.
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
        visaInstallmentsAccessFee:
          type:
          - object
          - 'null'
          description: Represents a monetary charge applied to a transaction or service.
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
    isCommunicationsOptOut:
      type: boolean
      description: A boolean flag indicating whether the customer has opted out of receiving communications related to a franchise plan.
    authorizationDescription:
      type:
      - string
      - 'null'
      description: A description of the authorization process or requirements for the transaction.
      maxLength: 10
    domesticTransactionPercentageFee:
      type: number
      description: The percentage fee applied to transactions involving domestic cards or payments within the same country.
      default: 0
      format: float
      minimum: 0
      maximum: 100
    orderStatus:
      type:
      - string
      - 'null'
      description: Represents the current status of the order in the system.
      enum:
      - COMPLETED
      - DECLINED
      - DEPLOYMENT
      - APPLICATION_SUBMITTED
      - CREDIT_ADJUDICATION
      - DECLINED_APPLICATION
      - CREDIT_ADJUDICATION_REVIEW
      - SCHEDULE_POS_INSTALL
    apiVersion:
      description: 'The endpoint''s API Version.  Must be provided through headers.

        '
      type: string
      example: '2025-08-14'
      default: '2025-08-14'
    createOrderRequest:
      description: Represents the payload for creating an order.
      oneOf:
      - $ref: '#/components/schemas/createStandardOrderRequest'
      - $ref: '#/components/schemas/createPartnerBankOrderRequest'
    cardOption:
      type:
      - string
      - 'null'
      description: Specifies the type of card used or service option for a transaction plan.
      maxLength: 10
    disqualifiedTransactionMerchantDiscountRate:
      type: number
      description: The merchant discount rate applied to transactions that do not meet certain qualifying criteria under the transaction plan.
      default: 0
      format: double
      minimum: 0
      maximum: 1
    transactionRate:
      type: number
      description: The single payment processing event under the transaction plan.
      default: 0
      format: double
      minimum: 0
      maximum: 1
    bankerInformation:
      type: object
      description: An object containing all details related to banker information.
      properties:
        bankerEmail:
          type:
          - string
          - 'null'
          format: email
          description: 'Contains the customer''s email address.


            For standard email protocols, visit: https://www.rfc-editor.org/rfc/rfc5322

            '
          minLength: 1
          maxLength: 320
          example: moneris@moneris.com
        bankerEmployeeNumber:
          type:
          - string
          - 'null'
          description: A string attribute that uniquely identifies the employee of the bank responsible.
          maxLength: 20
          example: '242200024'
        bankerName:
          type:
          - string
          - 'null'
          description: The full name of the banker representative.
          maxLength: 50
          example: MONIKA  CARNOKA
        bankerPhoneNumber:
          type:
          - string
          - 'null'
          description: Phone number.
          pattern: ^\+[1-9]\d{1,14}$
          minLength: 3
          maxLength: 16
          example: '+18663197450'
        bankerPhoneNumberExtension:
          type:
          - string
          - 'null'
          description: The phone number extension of the banker representative.
          maxLength: 50
          pattern: ^[0-9]{1,6}$
          example: '1068'
        bankerTransitNumber:
          type:
          - string
          - 'null'
          description: The identifier of the transit bank associated.
          maxLength: 5
          example: '00160'
          pattern: ^\d{5}
        bankerBranchIdentifier:
          type:
          - string
          - 'null'
          description: The branch identifier of the bank where the banker is located.
          maxLength: 5
          example: '2679'
    paymentModeCode:
      type:
      - string
      - 'null'
      description: The type of payment mode associated with a transaction under the transaction plan.
      maxLength: 10
    currency:
      type: string
      description: "Provides the three letter currency code according the ISO 4217 standard. \n\nFor a complete list of currency codes, visit: https://en.wikipedia.org/wiki/ISO_4217\n"
      minLength: 3
      maxLength: 4
      example: CAD
      format: iso-4217
    monerisGoPointOfSaleRetail:
      type:
      - object
      - 'null'
      description: An object containing the Moneris Go point of sale retail details.
      properties:
        feeDetails:
          $ref: '#/components/schemas/monerisGoPointOfSaleRetailFeeDetails'
    agreementModelCode:
      type:
      - string
      - 'null'
      description: A code that identifies the specific type or model of agreement associated with the order or account.
      maxLength: 15
    minimumDisqualifiedTransactionMerchantDiscountRate:
      type: number
      description: The minimum merchant discount rate value applied to transactions that do not meet certain qualifying criteria under the transaction plan.
      default: 0
      format: double
      minimum: 0
      maximum: 1
    manufacturer:
      type:
      - string
      - 'null'
      description: The name of the company that produces the terminal.
      maxLength: 50
    terminal:
      type: object
      description: An object representing a payment terminal device to process transactions.
      required:
      - terminalName
      properties:
        carrier:
          $ref: '#/components/schemas/terminalCarrier'
        terminalName:
          $ref: '#/components/schemas/terminalName'
        software:
          $ref: '#/components/schemas/software'
        pinpadModel:
          $ref: '#/components/schemas/pinpadModel'
        unitPrice:
          description: The cost of a single unit of the terminal device.
          type:
          - object
          - 'null'
          properties:
            amount:
              $ref: '#/components/schemas/amount'
            currency:
              $ref: '#/components/schemas/currency'
          required:
          - amount
          - currency
          example:
            amount: 16000
            currency: CAD
        quantity:
          type: integer
          description: The number of terminal units being purchased or assigned.
          format: int32
          example: 4
        cableType:
          $ref: '#/components/schemas/cableType'
        pinpadCableType:
          $ref: '#/components/schemas/pinpadCableType'
        waivePeriod:
          $ref: '#/components/schemas/waivePeriod'
        pointOfSaleType:
          $ref: '#/components/schemas/pointOfSaleType'
        transferDeviceReference:
          $ref: '#/components/schemas/transferDeviceReference'
        kioskReference:
          $ref: '#/components/schemas/kioskReference'
        kioskUnitPrice:
          description: The cost of a single kiosk unit.
          type:
          - object
          - 'null'
          properties:
            amount:
              $ref: '#/components/schemas/amount'
            currency:
              $ref: '#/components/schemas/currency'
          required:
          - amount
          - currency
          example:
            amount: 16000
            currency: CAD
        manufacturer:
          $ref: '#/components/schemas/manufacturer'
        installationType:
          $ref: '#/components/schemas/installationType'
    merchantOrderId:
      type: integer
      description: A unique identifier assigned by the merchant to track a specific customer order.
      format: int64
      example: 2341123
    cableType:
      type:
      - string
      - 'null'
      description: Indicates the type of the cable included with the terminal device.
      maxLength: 50
    supplies:
      type: array
      description: A list of supply items.
      items:
        $ref: '#/components/schemas/supply'
      maxItems: 116
    solutionDetails:
      type: object
      description: An object containing the solutions details.
      properties:
        solutionId:
          $ref: '#/components/schemas/solutionId'
        quantity:
          description: The number of items provided within the solution.
          type: integer
          format: int32
          minimum: 1
          maximum: 99
          example: 21
        carrier:
          description: A string that identifies the provider responsible for delivering the solution.
          type:
          - string
          - 'null'
          enum:
          - ROGERS
          - TELUS
      required:
      - solutionId
      - quantity
    monerisAdvance:
      type:
      - object
      - 'null'
      description: An object containing details related to Moneris Advance.
      properties:
        approvedAmount:
          type:
          - object
          - 'null'
          description: "Monetary amount. \nNote: The value must be in cents. Therefore $10.59 must be sent as 1059.\n"
          properties:
            amount:
              $ref: '#/components/schemas/amount'
            currency:
              $ref: '#/components/schemas/currency'
          required:
          - amount
          - currency
          example:
            amount: 16000
            currency: CAD
        collectionRate:
          $ref: '#/components/schemas/collectionRate'
        premiumAmount:
          type:
          - object
          - 'null'
          description: "Monetary amount. \nNote: The value must be in cents. Therefore $10.59 must be sent as 1059.\n"
          properties:
            amount:
              $ref: '#/components/schemas/amount'
            currency:
              $ref: '#/components/schemas/currency'
          required:
          - amount
          - currency
          example:
            amount: 16000
            currency: CAD
        isEligible:
          type: boolean
          description: A boolean flag indicating whether the product is eligible for a specific service or feature.
        feeDetails:
          $ref: '#/components/schemas/monerisAdvanceFeeDetails'
    cardAcquirer:
      type:
      - string
      - 'null'
      description: A string attribute representing the acquiring bank or institution.
      maxLength: 10
    installationType:
      type:
      - string
      - 'null'
      description: Specifies the method or environment of terminal installation.
      maxLength: 50
      enum:
      - ONSITE_PREMIUM_INSTALLATION
      - ONSITE_PRO_INSTALLATION
      - ONSITE_STANDARD_INSTALLATION
      - ONSITE
      - MERCHANT_INSTALL
      - PHONE
    kioskReference:
      type:
      - string
      - 'null'
      description: Identifies the specific kiosk associated with the terminal.
      maxLength: 50
    supply:
      type: object
      description: An object containing all details related to a supply.
      required:
      - supplyName
      - unitPrice
      properties:
        supplyName:
          $ref: '#/components/schemas/supplyName'
        unitPrice:
          $ref: '#/components/schemas/money'
        quantity:
          $ref: '#/components/schemas/quantity'
    maximumMerchantDiscountRate:
      type: number
      description: The maximum merchant discount rate that applies under the transaction plan.
      default: 0
      format: double
      minimum: 0
      maximum: 1
    pinpadModel:
      type:
      - string
      - 'null'
      description: Specifies the model or type of the PIN pad component integrated with the terminal.
      maxLength: 50
    region:
      type:
      - string
      - 'null'
      description: Specify the geographical area, province or territory relevant to the operation.
      maxLength: 10
    userDetails:
      type: object
      description: An object containing personal information about the user involved in the transaction.
      properties:
        userIdentifier:
          $ref: '#/components/schemas/userIdentifier'
        firstName:
          $ref: '#/components/schemas/firstName'
        lastName:
          $ref: '#/components/schemas/lastName'
    documentsStatus:
      type:
      - object
      - 'null'
      description: An object containing the documents status details.
      properties:
        creditDocumentsStatus:
          type: array
          description: A list of document statuses for the order.
          items:
            type: object
            properties:
              documentName:
                type:
                - string
                - 'null'
                description: The type of the document status.
                maxLength: 100
                enum:
                - ADVERTISING
                - ALCOHOL_CARD_NOT_PRESENT_OFFICER_CERTIFICATE
                - ALCOHOL_CARD_NOT_PRESENT_OFFICER_CERTIFICATE_SOLE_PROPRIETOR
                - APPLICABLE_LICENCE
                - BUSINESS_REGISTRATION_DOCUMENTS
                - CAF
                - CANNABIS_ATTESTATION
                - FIREARMS_CARD_NOT_PRESENT_OFFICER_CERTIFICATE
                - FIREARMS_CARD_NOT_PRESENT_OFFICER_CERTIFICATE_SOLE_PROPRIETOR
                - FINANCIAL_STATEMENTS
                - LEGAL_OPINION_LETTER
                - MASTER_CARD_MRP_REGISTRATION
                - MEDICAL_DENTAL_EQUIPMENT_CARD_NOT_PRESENT_OFFICER_CERTIFICATE
                - MEDICAL_DENTAL_EQUIPMENT_CARD_NOT_PRESENT_OFFICER_CERTIFICATE_SOLE_PROPRIETOR
                - OFFICER_CERTIFICATE
                - OFFICER_CERTIFICATE_SOLE_PROPRIETOR
                - ORGANIZATION_CHART
                - PG
                - PHARMACY_CARD_NOT_PRESENT_OFFICER_CERTIFICATE
                - PHARMACY_CARD_NOT_PRESENT_OFFICER_CERTIFICATE_SOLE_PROPRIETOR
                - POLITICAL_ORGANIZATION_REGISTRATION
                - PREVIOUS_PROCESSING_STATEMENTS
                - PSNW
                - SMOKING_SUPPLIES_CARD_NOT_PRESENT_OFFICER_CERTIFICATE
                - SMOKING_SUPPLIES_CARD_NOT_PRESENT_OFFICER_CERTIFICATE_SOLE_PROPRIETOR
                - VISA_HBR_REGISTRATION
              documentStatus:
                type:
                - string
                - 'null'
                description: The name of the selection associated with the document.
                maxLength: 100
          maxItems: 40
        additionalDocumentsStatus:
          type: array
          description: A list of additional document status associated with the order.
          maxItems: 50
          items:
            type: object
            properties:
              documentName:
                type:
                - string
                - 'null'
                description: The type of the additional document status.
                maxLength: 6
                enum:
                - AMEX_ELIGIBILITY_VERIFICATION
                - CONTROL_VERIFICATION
                - MASSAGE_LICENSE_NUMBER
                - MERCHANT_CONFIRMATION
                - REGISTRATION_NUMBER
                - TICO_IATA_NUMBER
              documentStatus:
                type:
                - string
                - 'null'
                description: The status of the selection associated with the document input.
                maxLength: 100
              additionalComment:
                type:
                - string
                - 'null'
                description: Comment associated with the additional document.
                maxLength: 100
    quantity:
      type: integer
      description: Specifies the amount of goods currently available for a particular product.
      format: int32
      minimum: 1
      maximum: 100
      example: 1
    integratedProduct:
      type:
      - object
      - 'null'
      description: An object containing details about the integrated product.
      properties:
        variableConfigurationCode:
          type:
          - string
          - 'null'
          description: A configuration code used to identify variable settings for transactions.
          maxLength: 50
        cardPresentVariableConfigurationCode:
          type:
          - string
          - 'null'
          description: A configuration code used to identify card present settings for transactions.
          maxLength: 50
        cardNotPresentVariableConfigurationCode:
          type:
          - string
          - 'null'
          description: A configuration code used to identify card not present settings for transactions.
          maxLength: 50
        cardPresentVariableConfigurationCodeSelectionName:
          type:
          - string
          - 'null'
          description: A string representing the variable code selection for the integrated product.
          maxLength: 50
        cardNotPresentVariableConfigurationCodeSelectionName:
          type:
          - string
          - 'null'
          description: A string representing the variable code selection for the integrated product.
          maxLength: 50
        integrationFeesDetails:
          type:
          - object
          - 'null'
          description: An object representing the fees associated with the integrated product.
          properties:
            creditFee:
              type:
              - object
              - 'null'
              description: Represents a monetary charge applied to a transaction or service.
              properties:
                feeType:
                  $ref: '#/components/schemas/feeType'
                unitPrice:
                  $ref: '#/components/schemas/money'
                taxes:
                  type: array
                  description: A list of tax items associated with the fee.
                  items:
                    $ref: '#/components/schemas/tax'
                  maxItems: 10
                frequency:
                  description: The frequency at which the fee is charged, such as monthly or annually.
                  type:
                  - string
                  - 'null'
                  maxLength: 20
                  enum:
                  - DAILY
                  - MONTHLY
                  - QUARTERLY
                  - ONE_OFF
                  - ANNUALLY
                quantity:
                  type: integer
                  description: Represent the number of times a fee is applied based on its frequency.
                  format: int32
                  minimum: 1
                  maximum: 30
                  example: 3
                isApproved:
                  $ref: '#/components/schemas/isApproved'
                waivePeriod:
                  $ref: '#/components/schemas/waivePeriod'
              required:
              - unitPrice
            integrationFee:
              type:
              - object
              - 'null'
              description: Represents a monetary charge applied to a transaction or service.
              properties:
                feeType:
                  $ref: '#/components/schemas/feeType'
                unitPrice:
                  $ref: '#/components/schemas/money'
                taxes:
                  type: array
                  description: A list of tax items associated with the fee.
                  items:
                    $ref: '#/components/schemas/tax'
                  maxItems: 10
                frequency:
                  description: The frequency at which the fee is charged, such as monthly or annually.
                  type:
                  - string
                  - 'null'
                  maxLength: 20
                  enum:
                  - DAILY
                  - MONTHLY
                  - QUARTERLY
                  - ONE_OFF
                  - ANNUALLY
                quantity:
                  type: integer
                  description: Represent the number of times a fee is applied based on its frequency.
                  format: int32
                  minimum: 1
                  maximum: 30
                  example: 3
                isApproved:
                  $ref: '#/components/schemas/isApproved'
                waivePeriod:
                  $ref: '#/components/schemas/waivePeriod'
              required:
              - unitPrice
            pointOfSalePadsFee:
              type:
              - object
              - 'null'
              description: Represents a monetary charge applied to a transaction or service.
              properties:
                feeType:
                  $ref: '#/components/schemas/feeType'
                unitPrice:
                  $ref: '#/components/schemas/money'
                taxes:
                  type: array
                  description: A list of tax items associated with the fee.
                  items:
                    $ref: '#/components/schemas/tax'
                  maxItems: 10
                frequency:
                  description: The frequency at which the fee is charged, such as monthly or annually.
                  type:
                  - string
                  - 'null'
                  maxLength: 20
                  enum:
                  - DAILY
                  - MONTHLY
                  - QUARTERLY
                  - ONE_OFF
                  - ANNUALLY
                quantity:
                  type: integer
                  description: Represent the number of times a fee is applied based on its frequency.
                  format: int32
                  minimum: 1
                  maximum: 30
                  example: 3
                isApproved:
                  $ref: '#/components/schemas/isApproved'
                waivePeriod:
                  $ref: '#/components/schemas/waivePeriod'
              required:
              - unitPrice
            visaBypassVerificationFee:
              type:
              - object
              - 'null'
              description: Represents a monetary charge applied to a transaction or service.
              properties:
                feeType:
                  $ref: '#/components/schemas/feeType'
                unitPrice:
                  $ref: '#/components/schemas/money'
                taxes:
                  type: array
                  description: A list of tax items associated with the fee.
                  items:
                    $ref: '#/components/schemas/tax'
                  maxItems: 10
                frequency:
                  description: The frequency at which the fee is charged, such as monthly or annually.
                  type:
                  - string
                  - 'null'
                  maxLength: 20
                  enum:
                  - DAILY
                  - MONTHLY
                  - QUARTERLY
                  - ONE_OFF
                  - ANNUALLY
                quantity:
                  type: integer
                  description: Represent the number of times a fee is applied based on its frequency.
                  format: int32
                  minimum: 1
                  maximum: 30
                  example: 3
                isApproved:
                  $ref: '#/components/schemas/isApproved'
                waivePeriod:
                  $ref: '#/components/schemas/waivePeriod'
              required:
              - unitPrice
            vaultFee:
              type:
              - object
              - 'null'
              description: Represents a monetary charge applied to a transaction or service.
              properties:
                feeType:
                  $ref: '#/components/schemas/feeType'
                unitPrice:
                  $ref: '#/components/schemas/money'
                taxes:
                  type: array
                  description: A list of tax items associated with the fee.
                  items:
                    $ref: '#/components/schemas/tax'
                  maxItems: 10
                frequency:
                  description: The frequency at which the fee is charged, such as monthly or annually.
                  type:
                  - string
                  - 'null'
                  maxLength: 20
                  enum:
                  - DAILY
                  - MONTHLY
                  - QUARTERLY
                  - ONE_OFF
                  - ANNUALLY
                quantity:
                  type: integer
                  description: Represent the number of times a fee is applied based on its frequency.
                  format: int32
                  minimum: 1
                  maximum: 30
                  example: 3
                isApproved:
                  $ref: '#/components/schemas/isApproved'
                waivePeriod:
                  $ref: '#/components/schemas/waivePeriod'
              required:
              - unitPrice
            touchBistroTrainingFee:
              type:
              - object
              - 'null'
              description: Represents a monetary charge applied to a transaction or service.
              properties:
                feeType:
                  $ref: '#/components/schemas/feeType'
                unitPrice:
                  $ref: '#/components/schemas/money'
                taxes:
                  type: array
                  description: A list of tax items associated with the fee.
                  items:
                    $ref: '#/components/schemas/tax'
                  maxItems: 10
                frequency:
                  description: The frequency at which the fee is charged, such as monthly or annually.
                  type:
                  - string
                  - 'null'
                  maxLength: 20
                  enum:
                  - DAILY
                  - MONTHLY
                  - QUARTERLY
                  - ONE_OFF
                  - ANNUALLY
                quantity:
                  type: integer
                  description: Represent the number of times a fee is applied based on its frequency.
                  format: int32
                  minimum: 1
                  maximum: 30
                  example: 3
                isApproved:
                  $ref: '#/components/schemas/isApproved'
                waivePeriod:
                  $ref: '#/components/schemas/waivePeriod'
              required:
              - unitPrice
            tokenSharingSetupFee:
              type:
              - object
              - 'null'
              description: Represents a monetary charge applied to a transaction or service.
              properties:
                feeType:
                  $ref: '#/components/schemas/feeType'
                unitPrice:
                  $ref: '#/components/schemas/money'
                taxes:
                  type: array
                  description: A list of tax items associated with the fee.
                  items:
                    $ref: '#/components/schemas/tax'
                  maxItems: 10
                frequency:
                  description: The frequency at which the fee is charged, such as monthly or annually.
                  type:
                  - string
                  - 'null'
                  maxLength: 20
                  enum:
                  - DAILY
                  - MONTHLY
                  - QUARTERLY
                  - ONE_OFF
                  - ANNUALLY
                quantity:
                  type: integer
                  description: Represent the number of times a fee is applied based on its frequency.
                  format: int32
                  minimum: 1
                  maximum: 30
                  example: 3
                isApproved:
                  $ref: '#/components/schemas/isApproved'
                waivePeriod:
                  $ref: '#/components/schemas/waivePeriod'
              required:
              - unitPrice
            vaultPerTransactionFee:
              type:
              - object
              - 'null'
              description: Represents a monetary charge applied to a transaction or service.
              properties:
                feeType:
                  $ref: '#/components/schemas/feeType'
                unitPrice:
                  $ref: '#/components/schemas/money'
                taxes:
                  type: array
                  description: A list of tax items associated with the fee.
                  items:
                    $ref: '#/components/schemas/tax'
                  maxItems: 10
                frequency:
                  description: The frequency at which the fee is charged, such as monthly or annually.
                  type:
                  - string
                  - 'null'
                  maxLength: 20
                  enum:
                  - DAILY
                  - MONTHLY
                  - QUARTERLY
                  - ONE_OFF
                  - ANNUALLY
                quantity:
                  type: integer
                  description: Represent the number of times a fee is applied based on its frequency.
                  format: int32
                  minimum: 1
                  maximum: 30
                  example: 3
                isApproved:
                  $ref: '#/components/schemas/isApproved'
                waivePeriod:
                  $ref: '#/components/schemas/waivePeriod'
              required:
              - unitPrice
            cloudAccessFee:
              type:
              - object
              - 'null'
              description: Represents a monetary charge applied to a transaction or service.
              properties:
                feeType:
                  $ref: '#/components/schemas/feeType'
                unitPrice:
                  $ref: '#/components/schemas/money'
                taxes:
                  type: array
                  description: A list of tax items associated with the fee.
                  items:
                    $ref: '#/components/schemas/tax'
                  maxItems: 10
                frequency:
                  description: The frequency at which the fee is charged, such as monthly or annually.
                  type:
                  - string
                  - 'null'
                  maxLength: 20
                  enum:
                  - DAILY
                  - MONTHLY
                  - QUARTERLY
                  - ONE_OFF
                  - ANNUALLY
                quantity:
                  type: integer
                  description: Represent the number of times a fee is applied based on its frequency.
                  format: int32
                  minimum: 1
                  maximum: 30
                  example: 3
                isApproved:
                  $ref: '#/components/schemas/isApproved'
                waivePeriod:
                  $ref: '#/components/schemas/waivePeriod'
              required:
              - unitPrice
            kioskTransactionFee:
              type:
              - object
              - 'null'
              description: Represents a monetary charge applied to a transaction or service.
              properties:
                feeType:
                  $ref: '#/components/schemas/feeType'
                unitPrice:
                  $ref: '#/components/schemas/money'
                taxes:
                  type: array
                  description: A list of tax items associated with the fee.
                  items:
                    $ref: '#/components/schemas/tax'
                  maxItems: 10
                frequency:
                  description: The frequency at which the fee is charged, such as monthly or annually.
                  type:
                  - string
                  - 'null'
                  maxLength: 20
                  enum:
                  - DAILY
                  - MONTHLY
                  - QUARTERLY
                  - ONE_OFF
                  - ANNUALLY
                quantity:
                  type: integer
                  description: Represent the number of times a fee is applied based on its frequency.
                  format: int32
                  minimum: 1
                  maximum: 30
                  example: 3
                isApproved:
                  $ref: '#/components/schemas/isApproved'
                waivePeriod:
                  $ref: '#/components/schemas/waivePeriod'
              required:
              - unitPrice
            p2peFee:
              type:
              - object
              - 'null'
              description: Represents a monetary charge applied to a transaction or service.
              properties:
                feeType:
                  $ref: '#/components/schemas/feeType'
                unitPrice:
                  $ref: '#/components/schemas/money'
                taxes:
                  type: array
                  description: A list of tax items associated with the fee.
                  items:
                    $ref: '#/components/schemas/tax'
                  maxItems: 10
                frequency:
                  description: The frequency at which the fee is charged, such as monthly or annually.
                  type:
                  - string
                  - 'null'
                  maxLength: 20
                  enum:
                  - DAILY
                  - MONTHLY
                  - QUARTERLY
                  - ONE_OFF
                  - ANNUALLY
                quantity:
                  type: integer
                  description: Represent the number of times a fee is applied based on its frequency.
                  format: int32
                  minimum: 1
                  maximum: 30
                  example: 3
                isApproved:
                  $ref: '#/components/schemas/isApproved'
                waivePeriod:
                  $ref: '#/components/schemas/waivePeriod'
              required:
              - unitPrice
            p2peIndoorFee:
              type:
              - object
              - 'null'
              description: Represents a monetary charge applied to a transaction or service.
              properties:
                feeType:
                  $ref: '#/components/schemas/feeType'
                unitPrice:
                  $ref: '#/components/schemas/money'
                taxes:
                  type: array
                  description: A list of tax items associated with the fee.
                  items:
                    $ref: '#/components/schemas/tax'
                  maxItems: 10
                frequency:
                  description: The frequency at which the fee is charged, such as monthly or annually.
                  type:
                  - string
                  - 'null'
                  maxLength: 20
                  enum:
                  - DAILY
                  - MONTHLY
                  - QUARTERLY
                  - ONE_OFF
                  - ANNUALLY
                quantity:
                  type: integer
                  description: Represent the number of times a fee is applied based on its frequency.
                  format: int32
                  minimum: 1
                  maximum: 30
                  example: 3
                isApproved:
                  $ref: '#/components/schemas/isApproved'
                waivePeriod:
                  $ref: '#/components/schemas/waivePeriod'
              required:
              - unitPrice
            p2peOutdoorFee:
              type:
              - object
              - 'null'
              description: Represents a monetary charge applied to a transaction or service.
              properties:
                feeType:
                  $ref: '#/components/schemas/feeType'
                unitPrice:
                  $ref: '#/components/schemas/money'
                taxes:
                  type: array
                  description: A list of tax items associated with the fee.
                  items:
                    $ref: '#/components/schemas/tax'
                  maxItems: 10
                frequency:
                  description: The frequency at which the fee is charged, such as monthly or annually.
                  type:
                  - string
                  - 'null'
                  maxLength: 20
                  enum:
                  - DAILY
                  - MONTHLY
                  - QUARTERLY
                  - ONE_OFF
                  - ANNUALLY
                quantity:
                  type: integer
                  description: Represent the number of times a fee is applied based on its frequency.
                  format: int32
                  minimum: 1
                  maximum: 30
                  example: 3
                isApproved:
                  $ref: '#/components/schemas/isApproved'
                waivePeriod:
                  $ref: '#/components/schemas/waivePeriod'
              required:
              - unitPrice
            p2pePerTransactionFee:
              type:
              - object
              - 'null'
              description: Represents a monetary charge applied to a transaction or service.
              properties:
                feeType:
                  $ref: '#/components/schemas/feeType'
                unitPrice:
                  $ref: '#/components/schemas/money'
                taxes:
                  type: array
                  description: A list of tax items associated with the fee.
                  items:
                    $ref: '#/components/schemas/tax'
                  maxItems: 10
                frequency:
                  description: The frequency at which the fee is charged, such as monthly or annually.
                  type:
                  - string
                  - 'null'
                  maxLength: 20
                  enum:
                  - DAILY
                  - MONTHLY
                  - QUARTERLY
                  - ONE_OFF
                  - ANNUALLY
                quantity:
                  type: integer
                  description: Represent the number of times a fee is applied based on its frequency.
                  format: int32
                  minimum: 1
                  maximum: 30
                  example: 3
                isApproved:
                  $ref: '#/components/schemas/isApproved'
                waivePeriod:
                  $ref: '#/components/schemas/waivePeriod'
              required:
              - unitPrice
        terminals:
          type: array
          description: A list of payment terminals available for the integrated product.
          items:
            $ref: '#/components/schemas/terminal'
          maxItems: 21
        creditElectronicCashRegistersQuantity:
          type: integer
          description: A number representing the quantity of electronic cash registers used for credit transactions.
          format: int32
          minimum: 1
          maximum: 100
        debitElectronicCashRegistersQuantity:
          type: integer
          description: A number representing the quantity of electronic cash registers used for debit transactions.
          format: int32
          minimum: 1
          maximum: 100
        debitCreditElectronicCashRegistersQuantity:
          type: integer
          description: A number representing the quantity of electronic cash registers used for both debit and credit transactions.
          format: int32
          minimum: 1
          maximum: 100
        storeAndForwardCreditElectronicCashRegistersQuantity:
          type: integer
          description: A number representing the quantity of electronic cash registers used for store and forward credit transactions.
          format: int32
          minimum: 1
          maximum: 100
        storeAndForwardDebitElectronicCashRegistersQuantity:
          type: integer
          description: A number representing the quantity of electronic cash registers used for store and forward debit transactions.
          format: int32
          minimum: 1
          maximum: 100
    wireless:
      type:
      - object
      - 'null'
      description: An object containing details about the wireless connectivity product.
      properties:
        terminals:
          type: array
          description: A list of payment terminals available at the counter.
          items:
            $ref: '#/components/schemas/terminal'
          maxItems: 21
        feeDetails:
          $ref: '#/components/schemas/wirelessFeeDetails'
    feeDetails:
      type:
      - object
      - 'null'
      description: An object containing the fees details
      properties:
        accountServiceFee:
          description: A fee charged for maintaining the account associated with the order.
          type:
          - object
          - 'null'
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
        consolidatedAccountServiceFee:
          description: A combined or aggregated fee charged for the maintenance of consolidated accounts.
          type:
          - object
          - 'null'
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
        minimumMerchantDiscountRateFee:
          description: The minimum Merchant Discount Rate that applies to a transaction.
          type:
          - object
          - 'null'
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
        paperStatementFee:
          description: A fee charged for receiving paper statements.
          type:
          - object
          - 'null'
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
        pciSecurityFee:
          description: A fee charged to cover the costs of ensuring compliance with the Payment Card Industry Data.
          type:
          - object
          - 'null'
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
        totalAdminFee:
          description: The total administrative fee applied to an order.
          type:
          - object
          - 'null'
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
        upgradeFee:
          description: A fee charged for upgrading a product to a newer version.
          type:
          - object
          - 'null'
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
        agedCloseBatchFee:
          description: A fee charged when a batch of transactions remains open beyond a defined period without being settled.
          type:
          - object
          - 'null'
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
        mastercardComplianceFee:
          description: A fee associated with ensuring compliance with MasterCard's regulatory.
          type:
          - object
          - 'null'
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
        dialCommunicationFee:
          description: A fee charged for using dial-up communication methods to transmit transaction data.
          type:
          - object
          - 'null'
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
        handlingFee:
          description: A fee charged to cover the costs associated with the preparation and processing of an order.
          type:
          - object
          - 'null'
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
        chargeBackFee:
          description: A fee applied when a chargeback is initiated by a customer.
          type:
          - object
          - 'null'
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
        consolidation:
          description: A fee charged for combining multiple services or transactions into a single package.
          type:
          - object
          - 'null'
          properties:
            feeType:
              $ref: '#/components/schemas/feeType'
            unitPrice:
              $ref: '#/components/schemas/money'
            taxes:
              type: array
              description: A list of tax items associated with the fee.
              items:
                $ref: '#/components/schemas/tax'
              maxItems: 10
            frequency:
              description: The frequency at which the fee is charged, such as monthly or annually.
              type:
              - string
              - 'null'
              maxLength: 20
              enum:
              - DAILY
              - MONTHLY
              - QUARTERLY
              - ONE_OFF
              - ANNUALLY
            quantity:
              type: integer
              description: Represent the number of times a fee is applied based on its frequency.
              format: int32
              minimum: 1
              maximum: 30
              example: 3
            isApproved:
              $ref: '#/components/schemas/isApproved'
            waivePeriod:
              $ref: '#/components/schemas/waivePeriod'
          required:
          - unitPrice
    merchantId:
      type: string
      description: "Thirteen character long identification provided to merchants by Moneris. \n"
      minLength: 13
      maxLength: 13
      example: 0123456789101
    transitNumber:
      type:
      - string
      - 'null'
      description: Attribute representing the five-digit branch number of a financial institution.
      maxLength: 10
    transactionPlanTier:
      type:
      - string
      - 'null'
      description: The level or band within the transaction plan.
      maxLength: 10
    assessmentPlans:
      type: array
      description: A list of assessment items.
      items:
        $ref: '#/components/schemas/assessmentPlan'
      maxItems: 20
    applicationDetails:
      type:
      - object
      - 'null'
      description: Details about the application
      properties:
        applicationType:
          type:
          - string
          - 'null'
          description: The type of application being submitted
          enum:
          - NET_NEW_MERCHANT
          - EXISTING_MERCHANT_ADD_POS
          - EXISTING_MERCHANT_UPGRADE_POS
          example: NET_NEW_MERCHANT
    updatePartnerBankOrderRequest:
      type: object
      description: An object containing all the Order payload partner bank details.
      properties:
        solutions:
          $ref: '#/components/schemas/solutions'
        deliveryAddress:
          type:
          - object
          - 'null'
          description: An object containing the delivery address details.
          allOf:
          - $ref: '#/components/schemas/address'
          - $ref: '#/components/schemas/addressee'
        bankerInformation:
          $ref: '#/components/schemas/bankerInformation'
        orderCreatedBy:
          $ref: '#/components/schemas/orderCreatedBy'
      required:
      - solutions
      - deliveryAddress
      - bankerInformation
    amount:
      type: integer
      format: int32
      minimum: 0
      maximum: 999999999
      example: 10000
      description: Amount
  responses:
    forbidden:
      description: Forbidden. The user does not have permission to access the requested resource.
      headers:
        Api-Version:
          $ref: '#/components/headers/apiVersion'
        X-Correlation-Id:
          $ref: '#/components/headers/correlationId'
        Sunset:
          $ref: '#/components/headers/sunset'
        X-RateLimit-Limit:
          $ref: '#/components/headers/rateLimitCount'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/rateLimitRemaining'
        WWW-Authenticate:
          schema:
            type: string
            example: Bearer, error="insufficient_scope"
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/error'
          example:
            type: https://developer.moneris.com/en/More/Testing/Response%20Codes
            title: FORBIDDEN_REQUEST
            status: 403
            detail: null
            instance: null
            category: UNAUTHORIZED_ERROR
            errors: []
    tooManyRequests:
      description: Too Many Requests
      headers:
        Api-Version:
          $ref: '#/components/headers/apiVersion'
        X-Correlation-Id:
          $ref: '#/components/headers/correlationId'
        Sunset:
          $ref: '#/components/headers/sunset'
        X-RateLimit-Limit:
          $ref: '#/components/headers/rateLimitCount'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/rateLimitRemaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/rateLimitReset'
        Retry-After:
          $ref: '#/components/headers/rateLimitReset'
    conflict:
      description: Request could not be completed due to a conflict with resource state or existing idempotency key.
      headers:
        Api-Version:
          $ref: '#/components/headers/apiVersion'
        X-Correlation-Id:
          $ref: '#/components/headers/correlationId'
        Sunset:
          $ref: '#/components/headers/sunset'
        X-RateLimit-Limit:
          $ref: '#/components/headers/rateLimitCount'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/rateLimitRemaining'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/error'
          examples:
            idempotency_error:
              $ref: '#/components/examples/IdempotencyRequestErrorResponse'
    unauthorized:
      description: Not authorized. The user does not have a valid API Key or Access Token.
      headers:
        Api-Version:
          $ref: '#/components/headers/apiVersion'
        X-Correlation-Id:
          $ref: '#/components/headers/correlationId'
        Sunset:
          $ref: '#/components/headers/sunset'
        X-RateLimit-Limit:
          $ref: '#/components/headers/rateLimitCount'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/rateLimitRemaining'
        WWW-Authenticate:
          schema:
            type: string
            example: Bearer, error="invalid_token"
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/error'
          example:
            type: https://developer.moneris.com/en/More/Testing/Response%20Codes
            title: UNAUTHORIZED_REQUEST
            status: 401
            detail: null
            instance: null
            category: UNAUTHORIZED_ERROR
            errors: []
    serviceUnavailable:
      description: Service Temporarily Unavailable
      headers:
        Api-Version:
          $ref: '#/components/headers/apiVersion'
        X-Correlation-Id:
          $ref: '#/components/headers/correlationId'
        Sunset:
          $ref: '#/components/headers/sunset'
        Retry-After:
          $ref: '#/components/headers/retryAfter'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/error'
          example:
            type: https://api-developer.moneris.com/responsehandling/
            title: SERVICE_UNAVAILABLE
            status: 503
            detail: null
            instance: null
            category: INTERNAL_SERVER_ERROR
            errors: []
    badRequest:
      description: Bad Request.
      headers:
        Api-Version:
          $ref: '#/components/headers/apiVersion'
        X-Correlation-Id:
          $ref: '#/components/headers/correlationId'
        Sunset:
          $ref: '#/components/headers/sunset'
        X-RateLimit-Limit:
          $ref: '#/components/headers/rateLimitCount'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/rateLimitRemaining'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/error'
    unprocessableContent:
      description: "The API cannot complete the requested action due to semantic or business validation errors. \n"
      headers:
        Api-Version:
          $ref: '#/components/headers/apiVersion'
        X-Correlation-Id:
          $ref: '#/components/headers/correlationId'
        Sunset:
          $ref: '#/components/headers/sunset'
        X-RateLimit-Limit:
          $ref: '#/components/headers/rateLimitCount'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/rateLimitRemaining'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/error'
    notFound:
      description: Not Found.
      headers:
        Api-Version:
          $ref: '#/components/headers/apiVersion'
        X-Correlation-Id:
          $ref: '#/components/headers/correlationId'
        Sunset:
          $ref: '#/components/headers/sunset'
        X-RateLimit-Limit:
          $ref: '#/components/headers/rateLimitCount'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/rateLimitRemaining'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/error'
          example:
            type: https://developer.moneris.com/en/More/Testing/Response%20Codes
            title: NOT_FOUND
            status: 404
            detail: null
            instance: /payments/pi0105ARZ3NDEKTSV4RRFFQ69G5FAV
            category: INVALID_REQUEST_ERROR
            errors: []
    internalServer:
      description: Unexpected error.
      headers:
        Api-Version:
          $ref: '#/components/headers/apiVersion'
        X-Correlation-Id:
          $ref: '#/components/headers/correlationId'
        Sunset:
          $ref: '#/components/headers/sunset'
        X-RateLimit-Limit:
          $ref: '#/components/headers/rateLimitCount'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/rateLimitRemaining'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/error'
          example:
            type: https://api-developer.moneris.com/responsehandling/
            title: INTERNAL_SERVER_ERROR
            status: 500
            detail: null
            instance: null
            category: INTERNAL_SERVER_ERROR
            errors: []
  parameters:
    apiVersion:
      in: header
      name: Api-Version
      required: true
      example: '2024-09-17'
      description: "The endpoint's API Version. \n\nMust be provided through the headers section. \n"
      schema:
        $ref: '#/components/schemas/apiVersion'
    merchantOrderId:
      in: path
      name: merchant-order-id
      description: The unique identifier of the merchant
      required: true
      schema:
        $ref: '#/components/schemas/merchantOrderId'
    prm-merchants_merchantId:
      in: path
      name: merchant-id
      example: 0123456789101
      required: true
      description: "Thirteen character identification code. \nNote: This code is provided by Moneris and is required to identify the Merchant executing the transaction.\"\n"
      schema:
        $ref: '#/components/schemas/merchantId'
    correlationId:
      in: header
      name: X-Correlation-Id
      example: 06f1e47b-a1b5-4902-be9c-bccc506127c4
      description: "Correlates a series of requests within the same flow.\n\nNote: This ID is generated by Moneris with every request or response, if it doesn't exist. \nMerchants are to echo back the value with every request that is part of the call flow.\"\n"
      required: false
      schema:
        type: string
        example: 06f1e47b-a1b5-4902-be9c-bccc506127c4
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
      description: 'An API key is a token that a client provides when making API calls.


        API keys are supposed to be a secret that only the client and server know about.

        '
    OAuth2:
      type: oauth2
      description: 'OAuth 2.0 is an authorization protocol that gives an API client limited access to user data on a web server.


        OAuth relies on authentication scenarios, that allows the resource owner (user) to share the protected content from the server, hosting the resource, without sharing their credentials. For that purpose, an OAuth 2.0 server issues access tokens that the client applications can use to access protected resources on behalf of the resource owner.


        Moneris recommends the use of OAuth 2.0 as it provides fine grained authorization levels.

        '
      flows:
        clientCredentials:
          tokenUrl: /oauth2/token
          scopes:
            payment.read: Grants read access to payment related APIs
            payment.write: Grants read & write access to payment related APIs
            refund.read: Grants read access to refunds
            refund.write: Grants read & write access to refunds
            customer.read: Grants read access to customer data
            customer.write: Grants read & write access to customer data
            kount.read: Grants read access to Kount inquiries
            kount.write: Grants read & write access to Kount inquiries
            onboarding.merchant.read: Grants read access to merchant onboarding related APIs
            onboarding.merchant.write: Grants read & write access to merchant onboarding related APIs
            onboarding.order.read: Grants read access to onboarding orders related APIs
            onboarding.order.write: Grants read & write access to onboarding orders related APIs
            dispute.read: Grants read access to disputes
            dispute.write: Grants read & write access to disputes