Verifone Hardware Orders API

openapi: 3.2.0
info:
  title: 3D Secure 3DS Authentication Hardware Orders API
  version: 3.43.0
  description: Operations for listing and retrieving 3DS authentication records. Use these endpoints to query historical authentication results filtered by amount, currency, card, status, and more.
servers:
- url: https://emea.gsc.verifone.cloud/oidc/3ds-service
  description: EMEA Production
- url: https://us.gsc.verifone.cloud/oidc/3ds-service
  description: Americas Production
- url: https://nz.gsc.verifone.cloud/oidc/3ds-service
  description: New Zealand Production
- url: https://cst.test-gsc.vfims.com/oidc/3ds-service
  description: Global Sandbox
- url: https://uscst-gb.gsc.vficloud.net/oidc/3ds-service
  description: Americas Sandbox
security:
- BearerAuth: []
- BasicAuth: []
tags:
- name: Hardware Orders
paths:
  /orders/hardware:
    post:
      tags:
      - Hardware Orders
      summary: Create Hardware Order
      description: Adds a new hardware order to the system.
      operationId: addHardwareOrder
      parameters:
      - $ref: '#/components/parameters/saveDraftHeaderParam'
      - $ref: '#/components/parameters/SimplifiedFlowHeaderParam'
      requestBody:
        description: Hardware to add
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HardwareOrder'
      responses:
        '200':
          description: Create Hardware Order Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HardwareOrderResponse'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        '503':
          $ref: '#/components/responses/503'
        '504':
          $ref: '#/components/responses/504'
components:
  schemas:
    HardwareOrder:
      type: object
      allOf:
      - $ref: '#/components/schemas/HardwareOrderData'
      - type: object
        properties:
          packageDetails:
            $ref: '#/components/schemas/PackageDetails'
          merchant:
            $ref: '#/components/schemas/HardwareMerchant'
        required:
        - merchant
    HardwareMerchant:
      description: details of the merchant
      type: object
      properties:
        merchantName:
          $ref: '#/components/schemas/MerchantName'
        primaryContact:
          $ref: '#/components/schemas/ContactType'
        requestedDateOfShipment:
          $ref: '#/components/schemas/RequestedDateOfShipment'
        mcc:
          $ref: '#/components/schemas/MCC'
        tradingAddress:
          $ref: '#/components/schemas/AddressWithoutType'
        shippingAddress:
          $ref: '#/components/schemas/AddressWithoutType'
        billingAddress:
          $ref: '#/components/schemas/AddressWithoutType'
        companyAddress:
          $ref: '#/components/schemas/AddressWithoutType'
        siteReferenceId:
          $ref: '#/components/schemas/SiteReferenceId'
        siteName:
          $ref: '#/components/schemas/SiteName'
        openingHours:
          type: array
          description: The list of opening periods per week day.
          items:
            $ref: '#/components/schemas/EntityOpeningHours'
          minItems: 1
        pois:
          type: array
          maxItems: 1000
          items:
            $ref: '#/components/schemas/HardwarePoiType'
      required:
      - primaryContact
    ContactName:
      allOf:
      - $ref: '#/components/schemas/Name'
    OrderStats:
      type: object
      description: Order Statistics
      properties:
        minsSinceCreatedToLastUpdate:
          type: integer
          description: Number of minutes since last status update and created order time
          default: 0
        minsSinceLastStatusUpdate:
          type: integer
          description: Number of minutes (if > 0) since last status update
          default: 0
    SignersInformation:
      description: Information on the signers in the request.
      type: object
      properties:
        providerRef:
          description: Signing Provider reference to the signers signing request.
          type: string
        contact:
          $ref: '#/components/schemas/ContactType'
        signed:
          description: Has the signer signed the contract.
          type: boolean
          default: false
        signedDateTime:
          description: Date/Time signer signed the request.
          type: string
          format: date-time
        signingLink:
          description: This is the link used for signing the contract.
          type: string
      required:
      - contact
    CountryCode3Enum:
      title: Country Code
      type: string
      description: The [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) country code.<blockquote><strong>Note:</strong> The country code for Great Britain is <code>GB</code> and not <code>UK</code> as is used in that country's top-level domain names.</blockquote>.
      enum:
      - ZZZ
      - ABW
      - AFG
      - AGO
      - AIA
      - ALA
      - ALB
      - AND
      - ARE
      - ARG
      - ARM
      - ASM
      - ATA
      - ATF
      - ATG
      - AUS
      - AUT
      - AZE
      - BDI
      - BEL
      - BEN
      - BES
      - BFA
      - BGD
      - BGR
      - BHR
      - BHS
      - BIH
      - BLM
      - BLR
      - BLZ
      - BMU
      - BOL
      - BRA
      - BRB
      - BSB
      - BRN
      - BTN
      - BVT
      - BWA
      - CAF
      - CAN
      - CCK
      - CHE
      - CHL
      - CHN
      - CIV
      - CMR
      - COD
      - COG
      - COK
      - COL
      - COM
      - CPV
      - CRI
      - CUB
      - CUW
      - CXR
      - CYM
      - CYP
      - CZE
      - DEU
      - DJI
      - DMA
      - DNK
      - DOM
      - DZA
      - ECU
      - EGY
      - ERI
      - ESH
      - ESP
      - EST
      - ETH
      - FIN
      - FJI
      - FLK
      - FRA
      - FRO
      - FSM
      - GAB
      - GBR
      - GEO
      - GGY
      - GHA
      - GIB
      - GIN
      - GLP
      - GMB
      - GNB
      - GNQ
      - GRC
      - GRD
      - GRL
      - GTM
      - GUF
      - GUM
      - GUY
      - HKG
      - HMD
      - HND
      - HRV
      - HTI
      - HUN
      - IDN
      - IMN
      - IND
      - IOT
      - IRL
      - IRN
      - IRQ
      - ISL
      - ISR
      - ITA
      - JAM
      - JEY
      - JOR
      - JPN
      - KAZ
      - KEN
      - KGZ
      - KHM
      - KIR
      - KNA
      - KOR
      - KWT
      - LAO
      - LBN
      - LBR
      - LBY
      - LCA
      - LIE
      - LKA
      - LSO
      - LTU
      - LUX
      - LVA
      - MAC
      - MAF
      - MAR
      - MCO
      - MDA
      - MDG
      - MDV
      - MEX
      - MHL
      - MKD
      - MLI
      - MLT
      - MMR
      - MNE
      - MNG
      - MNP
      - MOZ
      - MRT
      - MSR
      - MTQ
      - MUS
      - MWI
      - MYS
      - MYT
      - NAM
      - NCL
      - NER
      - NFK
      - NGA
      - NIC
      - NIU
      - NLD
      - NOR
      - NPL
      - NRU
      - NZL
      - OMN
      - PAK
      - PAN
      - PCN
      - PER
      - PHL
      - PLW
      - PNG
      - POL
      - PRI
      - PRK
      - PRT
      - PRY
      - PSE
      - PYF
      - QAT
      - REU
      - ROU
      - RUS
      - RWA
      - SAU
      - SDN
      - SEN
      - SGC
      - SGP
      - SHN
      - SJM
      - SLB
      - SLE
      - SLV
      - SMR
      - SOM
      - SPM
      - SRB
      - SSD
      - STP
      - SUR
      - SVK
      - SVN
      - SWE
      - SWZ
      - SXM
      - SYC
      - SYR
      - TCA
      - TCD
      - TGO
      - THA
      - TJK
      - TKL
      - TKM
      - TLS
      - TON
      - TTO
      - TUN
      - TUR
      - TUV
      - TWN
      - TZA
      - UGA
      - UKR
      - UMI
      - URY
      - USA
      - UZB
      - VAT
      - VCT
      - VEN
      - VGB
      - VIR
      - VNM
      - VUT
      - WLF
      - WSM
      - YEM
      - ZAF
      - ZMB
      - ZWE
    ExtendedDetails:
      description: Detailed Status of the Order
      type: object
      properties:
        status:
          $ref: '#/components/schemas/DetailedStatusEnum'
        code:
          type: string
          description: Code associated with the status (if applicable)
        information:
          type: string
          description: Extra Information associated with the status (if applicable)
        lastChangeTime:
          $ref: '#/components/schemas/LastChangeTime'
        canCancel:
          type: boolean
          description: Can this order be cancelled.
    HardwareOrderData:
      type: object
      properties:
        orderReference:
          $ref: '#/components/schemas/OrderReference'
        customerEntityUid:
          type: string
          format: uuid
          description: Verifone allocated ID for the customer this order is for (packages and bundles are associated with this entity).
        requestedDate:
          type: string
          description: The requested date for this order.
          format: date-time
        poRef:
          type: string
          description: Purchase Order Reference
        paymentDetails:
          $ref: '#/components/schemas/PaymentDetails'
        notes:
          type: string
          description: Notes for the Order
        additionalOrderData:
          type: array
          description: Input data which maybe required for the country/business unit to to complete the order. For example some countries require a VAT ID, or different legal forms of business, this will be defined by Verifone if needed for your integration
          maxItems: 100
          items:
            $ref: '#/components/schemas/VariableResponseType'
      required:
      - orderReference
      - customerEntityUid
    TimeZone:
      description: A time zone, following the format defined in the IANA tz database (https://www.iana.org/time-zones). Valid examples are America/New_York and Etc/UTC. Do not use ambiguous, non-qualified values such as EST or GB. Before including this type in your interface, please consider whether it is actually appropriate to convey time zone information with your type. It is almost always the case that this should be transformed from UTC at the time of display to the user; this type might therefore be most associated with user-preference APIs.
      type: string
      minLength: 1
      maxLength: 127
    ThreeDSecureMerchantIdentifiers:
      title: Merchant Identifier
      description: 'Override the Merchant ID (merchantId) with the default value configured in the payment provider contract (PPC), where applicable.

        In cases where the acquirer-issued Merchant ID for the authorization flow differs from the one used in the 3DS (SafeKey) flow, ensure the correct ID is applied for each flow.

        For example, Amex often requires merchants to complete separate onboarding processes for 3DS and authorization, resulting in two distinct Merchant IDs:

        * One used for SafeKey (3DS authentication) * Another used for authorization via the acquirer or gateway'
      required:
      - merchantId
      - paymentType
      properties:
        merchantId:
          type: string
          description: "Merchant ID assigned by Acquirer for 3DS flow. Override the Merchant ID (merchantId) with the default value configured in the payment provider contract (PPC), where applicable.\nIn cases where the acquirer-issued Merchant ID for the authorization flow differs from the one used in the 3DS (SafeKey) flow, ensure the correct ID is applied for each flow.\nFor example, Amex often requires merchants to complete separate onboarding processes for 3DS and authorization, resulting in two distinct Merchant IDs:\n\n  * One used for SafeKey (3DS authentication)\n  * Another used for authorization via the acquirer or gateway"
          pattern: ^$|^(?!\s*$).+
          maxLength: 30
        paymentType:
          $ref: '#/components/schemas/PaymentTypeEnum'
    VariableResponseType:
      description: Variable/Value Pairs.
      type: object
      properties:
        variableName:
          type: string
          description: Variable name (this would be provided by Verifone)
          pattern: ^[A-Za-z0-9_-]*$
        variableValue:
          type: string
          maxLength: 10000
          description: Value of the variable
    CreatedUserId:
      description: The assigned User ID corresponding to the Order Created By.
      type: string
      format: uuid
    Name:
      title: Name Details
      description: An object representing the name or component names of a party, person or business. No elements are mandatory due to the different usages, but the business rules need to be applied in the context where name is used.
      type: object
      uniqueItems: false
      properties:
        firstName:
          description: The given name of contact.
          type: string
          minLength: 1
          maxLength: 120
        lastName:
          description: The surname name or family name of the contact. This is required when the name is for a party or person. Can also include the matronymic or mother's family name where this is customarily used.
          minLength: 1
          maxLength: 120
          type: string
        prefix:
          description: The prefix to the party name. This is sometimes referred to as a title, salutation or appellation.
          maxLength: 120
          type: string
        alternateFullName:
          description: The alternate name for the party. This can be a business name or nickname. This should be used where the name of the party cannot be parsed into its constituent parts such as first name or last name. If the party is a business then this should always be present.
          maxLength: 200
          type: string
        middleName:
          description: The middle name or names for a party or person.
          maxLength: 120
          type: string
        suffix:
          description: The name suffix for the party.
          maxLength: 120
          type: string
      required:
      - firstName
      - lastName
    AdjustedPriceType:
      type: object
      properties:
        priceModel:
          type: string
          description: Pricing Model
          enum:
          - MONTHLY_FEE
          - MONTHLY_FEE_PER_DEVICE
          - MINIMUM_AMT_PER_TRX
          - AMT_PER_TRX
          - PERC_PER_TRX
          - ONE_TIME
          - YEARLY_FEE
          - QUARTERLY_FEE
        price:
          $ref: '#/components/schemas/AmountSimple'
    httpError429:
      title: HTTP 429 Error
      type: object
      description: The resource exists the number of requests has exceeded the specified quota.
      allOf:
      - $ref: '#/components/schemas/ErrorResp'
      - properties:
          code:
            type: string
            enum:
            - '429'
            default: '429'
          title:
            type: string
            enum:
            - Too Many Requests
            default: Too Many Requests
          message:
            type: string
            default: The number of requests from this client is restricted to a specified quota.
          timestamp:
            description: "The time that the error occurred. All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone."
            type: string
            format: date-time
          type:
            type: string
            enum:
            - RATE_LIMIT_ERROR
            default: RATE_LIMIT_ERROR
          param:
            description: The parameter the error relates to if the error is parameter-specific. You can use this to display a message near the correct form field, for example.
            type: string
      required:
      - code
      - title
      - message
      - type
      additionalProperties: false
    httpError404:
      title: HTTP 404 Error
      type: object
      description: The server cannot find the requested resource.
      allOf:
      - $ref: '#/components/schemas/ErrorResp'
      - properties:
          code:
            type: string
            enum:
            - '404'
            default: '404'
          title:
            type: string
            enum:
            - Not Found
            default: Not Found
          message:
            type: string
            default: The server cannot find the requested resource.
          timestamp:
            description: "The time that the error occurred. All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone."
            type: string
            format: date-time
          type:
            type: string
            enum:
            - INVALID_REQUEST_ERROR
            default: INVALID_REQUEST_ERROR
          param:
            description: The parameter the error relates to if the error is parameter-specific. You can use this to display a message near the correct form field, for example.
            type: string
      required:
      - code
      - title
      - message
      - type
      additionalProperties: false
    OrderStatusEnum:
      type: string
      enum:
      - DRAFT
      - SUBMITTED
      - INPROGRESS
      - COMPLETED
      - CANCELLED
      - ONHOLD
    LastChangeTime:
      description: Time status detailed status last changed.
      type: string
      format: date-time
    HardwareOrderResponse:
      allOf:
      - $ref: '#/components/schemas/HardwareOrder'
      - properties:
          orderId:
            $ref: '#/components/schemas/OrderId'
          status:
            $ref: '#/components/schemas/OrderStatusEnum'
          createdUserUid:
            $ref: '#/components/schemas/CreatedUserId'
          createdBy:
            $ref: '#/components/schemas/UserName'
          createdDate:
            type: string
            description: The created date for this order.
            format: date-time
          modifiedUserUid:
            description: The assigned User_ID corresponding to the Order Modified By.
            type: string
            format: uuid
          modifiedBy:
            $ref: '#/components/schemas/UserName'
          modifiedDate:
            type: string
            description: The last modified date for this order.
            format: date-time
          orderType:
            type: string
            default: HardwareOrder
          internal:
            $ref: '#/components/schemas/InternalAllocatedInformation'
      required:
      - orderId
      - status
      - orderType
      - merchantCompanyEntityUid
    BundleAndPrice:
      type: object
      properties:
        packageBundleId:
          $ref: '#/components/schemas/PackageBundleId'
        price:
          $ref: '#/components/schemas/AmountSimple'
      required:
      - packageBundleId
    ExternalOnboarding:
      description: External merchant onboarding details
      type: object
      discriminator:
        propertyName: provider
        mapping:
          BANKAXEPT: '#/components/schemas/BankAxeptExternalOnboarding'
      properties:
        provider:
          title: External Onboarding Provider
          description: The third-party provider used for merchant onboarding.
          type: string
          enum:
          - BANKAXEPT
          default: BANKAXEPT
        agreementId:
          type: string
          format: uuid
          description: 'Agreement or onboarding order identifier returned by the third-party provider when onboarding is initiated.

            '
        agreementStatus:
          type: string
          description: 'Latest onboarding or agreement status received from the third-party provider.

            '
    CustomerOrderLink:
      description: Customer Order Link Sent Details
      type: object
      properties:
        orderLink:
          description: 'The unique order link sent to the customer to help them navigate directly to the relevant  step in the order process. This link ensures the customer can update their order efficiently.

            '
          type: string
          format: uri
        linkInitiatorUserUid:
          description: The unique User ID of the user who generated the order link.
          type: string
          format: uuid
        linkInitiatorUsername:
          $ref: '#/components/schemas/UserName'
        linkReceiverUserUid:
          description: The unique User ID of the customer who received the order link.
          type: string
          format: uuid
        linkReceiverUsername:
          $ref: '#/components/schemas/UserName'
        linkSendTime:
          description: 'Date and time when the order link was sent to the customer.  This represents when the system triggered the link delivery.

            '
          type: string
          format: date-time
        linkOpendByCustomerTime:
          description: 'Date and time when the order link was opened by the customer.

            '
          type: string
          format: date-time
        customerUpdateTime:
          description: 'Date and time when the customer last updated their order after using the order link.

            '
          type: string
          format: date-time
    NotificationReminders:
      description: A container for all supported notification reminders.
      type: object
      properties:
        econtract:
          $ref: '#/components/schemas/NotificationReminder'
        draft:
          $ref: '#/components/schemas/NotificationReminder'
        docRequired:
          $ref: '#/components/schemas/NotificationReminder'
      additionalProperties: false
    BusinessTitle:
      type: string
      maxLength: 100
    SiteReferenceId:
      description: An optional identifier for the Site which can be provided if different to the merchantId.
      type: string
      maxLength: 100
      minLength: 1
    Notification:
      description: Object containing the sent date-time and template used for the notification.
      type: object
      properties:
        sentDateTime:
          description: Date and Time when the notification was sent.
          type: string
          format: date-time
        template:
          description: Template name used for the notification.
          type: string
        responseReferenceId:
          description: An ID from Messaging Service's response.
          type: string
    ContactType:
      description: The details of a Contact.
      type: object
      properties:
        contactType:
          $ref: '#/components/schemas/ContactTypeEnum'
        name:
          $ref: '#/components/schemas/ContactName'
        phoneNumbers:
          description: The phone numbers to be used for the Contact. If you include this property there should be at least one phone number.
          items:
            $ref: '#/components/schemas/Phone'
          minItems: 1
          uniqueItems: true
          type: array
        email:
          $ref: '#/components/schemas/EmailAddress'
        businessTitle:
          $ref: '#/components/schemas/BusinessTitle'
      required:
      - contactType
      - name
    EntityOpeningHours:
      title: Opening Hours
      description: An dictionary map of the different opening hours for an Entity
      type: object
      properties:
        day:
          $ref: '#/components/schemas/DayOfWeekEnum'
        times:
          $ref: '#/components/schemas/EntityOpeningPeriod'
      required:
      - day
      - times
    httpError503:
      title: HTTP 503 Error
      type: object
      description: Service Unavailable Error
      allOf:
      - $ref: '#/components/schemas/ErrorResp'
      - properties:
          code:
            type: string
            enum:
            - '503'
            default: '503'
          title:
            type: string
            enum:
            - Service Unavailable
            default: Service Unavailable
          message:
            type: string
            default: The server is not ready to handle the request. If specified please check the <strong>Retry-After</strong> for the time period specified for recovery/re-attempt of request.
          timestamp:
            description: "The time that the error occurred. All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone."
            type: string
            format: date-time
          type:
            type: string
            enum:
            - API_ERROR
            default: API_ERROR
          param:
            description: The parameter the error relates to if the error is parameter-specific. You can use this to display a message near the correct form field, for example.
            type: string
      required:
      - code
      - title
      - message
      - type
      additionalProperties: false
    ContactTypeEnum:
      title: Contact Type
      description: 'An indicator for the type of contact.


        |Value|Description|

        |----|-----------|

        |BUSINESS|Generic business contact information, e.g. info@example.com|

        |DISPUTE_HANDLING|Generic contact information specific to dispute handling, e.g. disputes@example.com|

        |OWNER|Individual contact information of the owner of the Entity, e.g. ben.jerry@example.com|

        |PERSONAL|Personal contact information of the person representing the Entity, e.g. bjerr83@example-personal-email-domain.com|'
      type: string
      enum:
      - BUSINESS
      - DISPUTE_HANDLING
      - OWNER
      - PERSONAL
      default: BUSINESS
    SiteName:
      description: The site name, if different to the merchant name.
      type: string
      minLength: 1
    VmssSchemeMatches:
      description: Number of matches found against the VMSS service.
      type: number
    EmailAddress:
      title: Email Address
      maxLength: 254
      minLength: 3
      type: string
      format: email
      pattern: ^[a-zA-Z0-9!#$%&'*+=?^_`{|}~.-]+@[a-zA-Z0-9-]+[.].+$
      description: A valid internationalized email address, as defined by RFC 5322, RFC 6530, and other RFCs. Due to RFC 5321, an email address can be up to 254 characters long even though up to 64 characters are allowed before and 255 characters are allowed after the @ sign. This pattern verifies only that the string contains an unquoted @ sign. See https://tools.ietf.org/html/rfc5322#section-3.4.1.
    httpError500:
      title: HTTP 500 Error
      type: object
      description: Unexpected Server Error
      allOf:
      - $ref: '#/components/schemas/ErrorResp'
      - properties:
          code:
            type: string
            enum:
            - '500'
            default: '500'
          title:
            type: string
            enum:
            - Internal Server Error
            default: Internal Server Error
          message:
            type: string
            default: The server encountered an unexpected condition which prevented it from fulfilling the request.
          timestamp:
            description: "The time that the error occurred. All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone."
            type: string
            format: date-time
          type:
            type: string
            enum:
            - API_ERROR
            default: API_ERROR
          param:
            description: The parameter the error relates to if the error is parameter-specific. You can use this to display a message near the correct form field, for example.
            type: string
      required:
      - code
      - title
      - message
      - type
      additionalProperties: false
    PaymentTypeEnum:
      title: Payment Type
      description: A type indicator for the payment that is being processed. Value `GIFT` is deprecated.
      type: string
      enum:
      - AFFIRM
      - AFTERPAY
      - ALIPAY
      - AMEX
      - BAIDU_PAY
      - BANK
      - BANKAXEPT
      - BARTERCARD
      - BBBY_COB
      - BBBY_PLCC
      - BLIK
      - BP_FUELCARD
      - CALLIO_GASTRO
      - CARD
      - CARDLINK
      - CARNET
      - CASH
      - CB
      - CHEQUE
      - CLAVE
      - CRYPTO
      - DANKORT
      - DEBIT
      - DINERS
      - DISCOVER
      - EASYCD
      - EBT
      - EBT_WIC_OFFLINE
      - ECARD
      - ECARDZ
      - EDENRED
      - ELECTRON
      - EZIPAY
      - FARMERS_FINANCE
      - FARMLAND
      - FARMLANDS
      - FINNISH_DIRECT_BANKING
      - FLEETCOR
      - FLEETONE
      - FLEXECASH
      - FORBRUGSFORENINGEN
      - FPF_GIFT
      - GARMIN_PAY
      - GIFT
      - GIFT_CARD
      - GIROCARD
      - IKANO
      - ISRACARD
      - ISRAEL_PRIVATE_LABEL
      - JCB
      - JD_PAY
      - KLARNA
      - KLARNA_ECOM
      - KLARAN_QR
      - KLARNA_QR
      - LANDSBANKINN
      - MASTERCARD
      - MAESTRO
      - MOBILEPAY
      - MOBILEPAY_ECOM
      - OP_ONLINE_PAYMENT
      - PAYPAL
      - PAYPAL_ECOM
      - PAYPAL_ECOM_MANAGED
      - PAYPAL_QR
      - PIX
      - PLCC
      - Q_CARD
      - RESURS_BANK
      - RURALCO
      - SAMSUNG_PAY
      - SODEXO_GASTRO
      - SUPERCARD
      - SWISH
      - SWISH_ECOM
      - TEN_PAY
      - TRANXACTOR
      - TRUE_REWARDS
      - TT_CARD
      - UP_SLOVENSKA
      - UPI
      - VENMO
      - VENMO_ECOM
      - VENMO_QR
      - VIPPS
      - VIPPS_ECOM
      - VISA
      - VOYAGER
      - VPAY
      - WECHAT
      - WESTFIELD_GIFTCARD
      - WESTPAC_DEBIT
      - WEX
      - ZELLE
      - ZIP
      - OTHER
    OrderReference:
      description: Client reference for the Order.
      type: string
      minLength: 1
    BaseAddressWithoutType:
      description: An Address following the convention of http://microformats.org/wiki/hcard
      type: object
      allOf:
      - $ref: '#/components/schemas/BaseAddress'
      properties:
        contact:
          $ref: '#/components/schemas/ContactType'
        vfiSiteId:
          maxLength: 50
          minLength: 1
          type: string
          description: Address/Site identifier known as within Verifone internal systems.
        storeNumber:
          type: string
          description: Store Number or Client/Customer ID in Oracle
        governmentOwned:
          type: boolean
          description: Indicates whether the address is government-owned. E.g. Address can be in Sweden, but can be a US Embassy.
        governmentCountry:
          $ref: '#/components/schemas/CountryCode3Enum'
    PostCode:
      description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
      type: string
      minLength: 1
      maxLength: 16
    MCC:
      description: The Merchant Category Code (MCC). A 4 digit Code classifying the type of business being done by the card acceptor or Merchant (in accordance with ISO 18245).
      type: string
      minLength: 4
      maxLength: 4
      pattern: ^[0-9]{4,4}$
    httpError401:
      title: HTTP 401 Error
      type: object
      description: The request must be authenticated to access the resource.
      allOf:
      - $ref: '#/components/schemas/ErrorResp'
      - properties:
          code:
            type: string
            enum:
            - '401'
            default: '401'
          title:
            type: string
            enum:
            - Unauthorised
            default: Unauthorised
          message:
            type: string
            default: The request requires client authentication.
          timestamp:
            description: "The time that the error occurred. All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone."
            type: string
            format: date-time
          type:
            type: string
            enum:
            - AUTHENTICATION_ERROR
            default: AUTHENTICATION_ERROR
          param:
            description: The parameter the error relates to if the error is parameter-specific. You can use this to display a message near the correct form field, for example.
            type: string
      required:
      - code
      - title
      - message
      - type
      additionalProperties: false
    OrderId:
      description: Verifone allocated ID for the Order.
      type: string
      format: uuid
    SerialNumber:
      description: The serial number

# --- truncated at 32 KB (62 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/verifone/refs/heads/main/openapi/verifone-hardware-orders-api-openapi.yml