Verifone Merchant Orders API

openapi: 3.2.0
info:
  title: 3D Secure 3DS Authentication Merchant 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: Merchant Orders
  description: Operations to manage merchant orders.
paths:
  /orders/merchant:
    post:
      tags:
      - Merchant Orders
      summary: Create Merchant Order
      description: Adds a new merchant to the system and optionally allows for ordering hardware and services.
      operationId: addMerchantDraft
      parameters:
      - $ref: '#/components/parameters/saveDraftHeaderParam'
      - $ref: '#/components/parameters/validateAcquirerHeaderParam'
      - $ref: '#/components/parameters/validateACHHeaderParam'
      - $ref: '#/components/parameters/validateCompanyIdentityHeaderParam'
      - $ref: '#/components/parameters/SimplifiedFlowHeaderParam'
      requestBody:
        description: Merchant to add
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MerchantOrder'
      responses:
        '200':
          description: Create Merchant Order Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MerchantOrderResponse'
        '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:
  parameters:
    SimplifiedFlowHeaderParam:
      name: X-Use-Simplified-Order-Flow
      in: header
      description: An optional header indicating to the client, the new approach delegates more logic to the backend, requiring the API/UI client to supply only the essential data when possible. Our backend now intelligently derives missing fields by leveraging defaults and configurations from the Portfolio Service
      required: false
      schema:
        type: boolean
    validateACHHeaderParam:
      name: validateACH
      in: header
      description: An optional header indicating whether to validate account details against GIACT.
      required: false
      schema:
        type: boolean
    validateAcquirerHeaderParam:
      name: validateAcquirer
      in: header
      description: An optional header indicating whether to validate the acquirer.
      required: false
      schema:
        type: boolean
    saveDraftHeaderParam:
      name: saveDraft
      in: header
      description: An optional header indicating whether to save the order into a DRAFT status. If this value is not specified or set to false then the order will be SUBMITTED immediately.
      required: false
      schema:
        type: boolean
    validateCompanyIdentityHeaderParam:
      name: validateCompanyIdentity
      in: header
      description: An optional header indicating to the client to validate the merchant details stored in the order against Verifone Identity Service.
      required: false
      schema:
        type: boolean
  schemas:
    PaymentAppParameters:
      title: Base Parameters
      description: Payment Parameters - these can be specified per merchant and/or overridden at the poi level. If no values are specified then default template values will be applied.
      type: object
      properties:
        AccountVerifyEnabled:
          description: Enable Account verification for this merchant
          type: string
          minLength: 1
          maxLength: 1
          pattern: '[0-1]'
        AllowDisableMerchantPreferredAppSelection:
          description: Display the option to disable merchant preferred app selection in the 'Prompt For Card' screen
          type: string
          minLength: 1
          maxLength: 1
          pattern: '[0-1]'
        PurchaseEnabled:
          description: Enable Purchase transactions for this merchant.
          type: string
          minLength: 1
          maxLength: 1
          pattern: '[0-1]'
        PurchaseAndCashoutEnabled:
          description: Enable prompting for a cashout amount as part of a purchase transaction.
          type: string
          minLength: 1
          maxLength: 1
          pattern: '[0-1]'
        ManualPurchaseAndCashoutEnabled:
          description: Enable Manual Card Entry for Purchase with Cashout.
          type: string
          minLength: 1
          maxLength: 1
          pattern: '[0-1]'
        PurchaseSurchargeEnabled:
          description: 'Enables surcharging for Purchase (+ Cash + Tip)

            transactions. Surchargeable amount - this is the amount in

            the transaction where a surcharge can be applied to.

            Purchase only - surchargeable amount is the purchase

            amount. Purchase + Cash - surchargeable amount is the

            purchase amount only. Purchase + Cash + Tip -

            surchargeable amount is the purchase amount only. Purchase

            + Tip - surchargeable amount is the purchase amount only.'
          type: string
          minLength: 1
          maxLength: 1
          pattern: '[0-1]'
        ContactlessSurchargeEnabled:
          description: Enable contactless surcharging.
          type: string
          minLength: 1
          maxLength: 1
          pattern: '[0-1]'
        CashOutOnlySurchargeEnabled:
          description: Enables surcharging for Cashout only transactions.
          type: string
          minLength: 1
          maxLength: 1
          pattern: '[0-1]'
        PreauthCompletionSurchargeType:
          description: '0 - Disabled: Pre-Auth/Completion transactions are not subject to surcharge


            1 - Pre-Auth: Surcharge is applied to Pre-Auth (initial) transaction


            2 - Completion: Surcharge is applied to Completion transaction'
          type: string
          minLength: 1
          maxLength: 1
          pattern: '[0-2]'
        MotoSurchargeEnabled:
          description: 'Enables surcharging for mail and telephone order (MOTO)

            transactions.'
          type: string
          minLength: 1
          maxLength: 1
          pattern: '[0-1]'
        ManualPurchaseEnabled:
          description: Enable Manual Card Entry for Purchase.
          type: string
          minLength: 1
          maxLength: 1
          pattern: '[0-1]'
        ManualRefundEnabled:
          description: Manual Refund Enabled.
          type: string
          minLength: 1
          maxLength: 1
          pattern: '[0-1]'
        ManualPreAuthEnabled:
          description: Enable Manual Card Entry for PreAuth.
          type: string
          minLength: 1
          maxLength: 1
          pattern: '[0-1]'
        CashoutOnlyEnabled:
          description: Enable Cashout only transactions for this merchant.
          type: string
          minLength: 1
          maxLength: 1
          pattern: '[0-1]'
        ManualCashoutOnlyEnabled:
          description: Enable Manual Card Entry for Cashout transactions without a purchase.
          type: string
          minLength: 1
          maxLength: 1
          pattern: '[0-1]'
        RefundEnabled:
          description: Enable Refund transactions as such for this merchant.
          type: string
          minLength: 1
          maxLength: 1
          pattern: '[0-1]'
        LimitRefundAmountEnabled:
          description: Enable limit refund amount with MaxCashierRefundAmount and MaxManagerRefundAmount.
          type: string
          minLength: 1
          maxLength: 1
          pattern: '[0-1]'
        EbtEnabled:
          description: Allow EBT (Electronic benefit transfer) payment type.
          type: string
          minLength: 1
          maxLength: 1
          pattern: '[0-1]'
        VoidEnabled:
          description: Enable void transaction for magnetic stripe and chip cards for this product
          type: string
          minLength: 1
          maxLength: 1
          pattern: '[0-1]'
        ManualVoidEnabled:
          description: Enable Manual Card Entry for Void
          type: string
          minLength: 1
          maxLength: 1
          pattern: '[0-1]'
        SplitPaymentsEnabled:
          description: Allow the total to be paid with multiple payments.
          type: string
          minLength: 1
          maxLength: 1
          pattern: '[0-1]'
        PreAuthEnabled:
          description: Enable Pre-Auth transactions for this merchant.
          type: string
          minLength: 1
          maxLength: 1
          pattern: '[0-1]'
        PostAuthEnabled:
          description: Enable Post-Auth transactions for this merchant.
          type: string
          minLength: 1
          maxLength: 1
          pattern: '[0-1]'
        PreAuthCtlsEnabled:
          description: Enable Pre Authorization transaction for contactless payment methods for this merchant.
          type: string
          minLength: 1
          maxLength: 1
          pattern: '[0-1]'
        BalanceEnquiryEnabled:
          description: Enable Balance Enquiry transactions for this merchant.
          type: string
          minLength: 1
          maxLength: 1
          pattern: '[0-1]'
        MotoPaymentEnabled:
          description: Enable mail and telephone order (MOTO) payments.
          type: string
          minLength: 1
          maxLength: 1
          pattern: '[0-1]'
        MotoTipEnabled:
          description: Enable tip for moto payments for this merchant.
          type: string
          minLength: 1
          maxLength: 1
          pattern: '[0-1]'
        MotoRefundEnabled:
          description: Enable moto refunds for this merchant.
          type: string
          minLength: 1
          maxLength: 1
          pattern: '[0-1]'
        MotoPreAuthEnabled:
          description: Enable moto PreAuth for this merchant.
          type: string
          minLength: 1
          maxLength: 1
          pattern: '[0-1]'
        MotoSeparationEnabled:
          description: Determines whether to present separate options for mail and telephone orders (MOTO).
          type: string
          minLength: 1
          maxLength: 1
          pattern: '[0-1]'
        CashbackAmounts:
          description: Predefined cashout amounts presented at the cashout selection in the local currency. Maximum of 4 comma separated amounts e.g. 10.00,20.00,40.00.
          type: string
          maxLength: 150
          minLength: 0
          pattern: ^(\d+\.?\d*,){0,3}(\d+\.?\d*)$
        MaxPurchaseAmount:
          description: Represents the maximum purchase amount allowed in the currency supported by the terminal. The value should be in a decimal format, e.g. $40 = 40.00. Maximal amount supported by the payment application is 9,999,999,999.99.
          type: string
          maxLength: 13
          minLength: 0
          pattern: ^[0-9]{1,10}(\.[0-9]{2})?$
        MaxCashierRefundAmount:
          description: Maximum refund amount allowed by the cashier, in the currency supported by the terminal. The value should be in a decimal format, e.g. $40 = 40.00
          type: string
          maxLength: 15
          minLength: 0
          pattern: ^[0-9]+(\.[0-9]{2})?$
        MaxManagerRefundAmount:
          description: Maximum refund amount allowed by the manager, in the currency supported by the terminal. The value should be in a decimal format, e.g. $40 = 40.00
          type: string
          maxLength: 15
          minLength: 0
          pattern: ^[0-9]+(\.[0-9]{2})?$
        MaxRefundTotalAmountPerSettlement:
          description: Maximum refund amount allowed per settlement period, in the currency supported by the terminal. This value should be in a decimal format, e.g. $40 = 40.00
          type: string
          maxLength: 15
          minLength: 0
          pattern: ^[0-9]+(\.[0-9]{2})?$
        MaxAmountRefundPerDay:
          description: Used to determine the maximum total amount of refunds for merchant per day, in the currency of related virtual terminal. This value should be in a decimal format, e.g. $40 = 40.00.
          type: string
          maxLength: 15
          minLength: 0
          pattern: ^[0-9]+(\.[0-9]{2})?$
        MaxCountRefundPerDay:
          description: Used to determine the maximum total number of refunds for merchant per day
          type: string
          maxLength: 3
          minLength: 0
          pattern: ^[0-9]{1,3}$
        ForceOfflineEnabled:
          description: Indicates if the force offline operation is enabled for the merchant
          type: string
          minLength: 1
          maxLength: 1
          pattern: '[0-1]'
        CashbackCeiling:
          description: Maximum cashout amount allowed, in the currency supported by the terminal. The value should be in a decimal format,                  e.g. $40 = 40.00 - where the currency symbol depends on the region.
          type: string
          maxLength: 150
          minLength: 0
          pattern: ^[0-9]+(\.[0-9]{2})?$
        PrintMerchantReceipt:
          description: 'Defines the merchant receipt print options.


            0-Never Print


            1-Prompt for print


            2-Always Print


            3-Always Print when Signature is Captured'
          type: string
        PrintCustomerReceipt:
          description: 'Defines the customer receipt print options.


            0-Never Print


            1-Prompt for print


            2-Always Print'
          type: string
        ShowEmailReceiptOption:
          description: Show e-mail option for customer receipts.
          type: string
          minLength: 1
          maxLength: 1
          pattern: '[0-1]'
        ShowEmailTermsAndConditions:
          description: Determines if the device displays the Terms and Conditions text when a customer elects to receive an email receipt.
          type: string
          minLength: 1
          maxLength: 1
          pattern: '[0-1]'
        ReceiptGreeting:
          description: Placeholder for greeting text on the receipt.
          type: string
          maxLength: 10000
          minLength: 0
          pattern: ^(.|\n)*$
        ReceiptFooter:
          description: Receipt placeholder for footer text.
          type: string
          maxLength: 10000
          minLength: 0
          pattern: ^(.|\n)*$
        TipEnabled:
          description: Enable purchase with tip transaction for this product
          type: string
          minLength: 1
          maxLength: 1
          pattern: '[0-1]'
        TipAdjustmentEnabled:
          description: Enable tip adjustment. When enabled the device can support tip adjustment flow.
          type: string
          minLength: 1
          maxLength: 1
          pattern: '[0-1]'
        TipCustomOptionEnabled:
          description: Enable Custom option on the Tip screen for this merchant.
          type: string
          minLength: 1
          maxLength: 1
          pattern: '[0-1]'
        TipCustomOptionEntryMethod:
          description: 'Specifies how the customer enters a custom tip amount. Additional Tip Amount - customer enters the tip amount to be added to the total (default). Total Amount Including Tip - customer enters the total transaction amount and tip is calculated automatically, used in markets where a round-up tip strategy is common. - Possible values are: Tip Amount-0,Total Amount including Tip-1.'
          type: string
        TipLimit:
          description: Defines the maximum percentage of the transaction amount that can be added as a tip. If this is exceeded, a warning is prompted.
          type: string
          maxLength: 150
          minLength: 0
          pattern: ^[0-9]+(\.[0-9]{2})?$
        TipLimitAmount:
          description: Defines the maximum amount that can added to the transaction as a tip. When the tip amount exceeds this limit, a warning is displayed. Any tip amount is allowed when TipLimitAmount set to 0.
          type: string
          maxLength: 150
          minLength: 0
          pattern: ^[0-9]+(\.[0-9]{2})?$
        TipOverLimitAllowed:
          description: When enabled, the tip that is higher than defined by limit parameters, TipLimit (percentage) and TipLimitAmount (amount), will be allowed after confirmation.
          type: string
          minLength: 1
          maxLength: 1
          pattern: '[0-1]'
        TipPercentages:
          description: 'Pre-Defines up to 4 tip percentage options for customers to choose from, after entering the purchase amount for a transaction, e.g. 10, 15, 20, 25% = 10%, 15%, 20%, 25% respectively.                 Note that the TipEnabled parameter must be enabled, and that only whole numbers are accepted as percentage values, e.g. 10% (not 10.5%).    Note also some terminal solutions only support 3 pre-defined limits.                 '
          type: string
          maxLength: 150
          minLength: 0
          pattern: ^(\d{1,2},){0,3}(\d{1,2})$
        AutoSettlementEnabled:
          description: Settlement runs on a schedule.
          type: string
          minLength: 1
          maxLength: 1
          pattern: '[0-1]'
        AutoSettlementTime:
          description: Settlement runs at this time everyday.
          type: string
          maxLength: 5
          minLength: 4
          pattern: ^(0[0-9]|1[0-9]|2[0-3]|[0-9]):[0-5][0-9]$
        SAFEnabled:
          description: Whether SAF (offline approval when device cannot go online or reach host/gateway), 1-Enabled, 0-Not enabled
          type: string
          minLength: 1
          maxLength: 1
          pattern: '[0-1]'
        MaxSAFAccumulativeAmount:
          description: Maximum amount of all pending SAF transactions that are allowed. Once this limit is reached, the terminal cannot approve anymore transaction as SAF
          type: string
          minLength: 1
          maxLength: 15
          pattern: ^[0-9]+(\.[0-9]{2})?$
        MaxSAFTransactionAmount:
          description: Maximum amount for a single transaction to be put into SAF. This overrides card scheme settings.
          type: string
          minLength: 1
          maxLength: 15
          pattern: ^[0-9]+(\.[0-9]{2})?$
        MerchantSurcharge:
          description: Surcharging options for different card products
          type: array
          items:
            $ref: '#/components/schemas/CardProductSurcharge'
        RegionalParameters:
          $ref: '#/components/schemas/BaseRegionalParameters'
        CardHolderPresent:
          description: Select if card holder is present (Always/Prompt/Never)
          type: string
          enum:
          - Always
          - Prompt
          - Never
        MaxContactlessTransactionAmount:
          description: Maximum limit for contact less payments
          type: string
          pattern: ^[0-9]+(\.[0-9]{2})?$
        CommsFailFloorLimit:
          description: Maximum limit allowed by terminal when communications fail
          type: number
          format: decimal
          pattern: ^[0-9]+(\.[0-9]{2})?$
          deprecated: true
        VoiceAuthRefferalLimit:
          description: Maximum limit allowed for voice referral
          type: number
          format: decimal
          pattern: ^[0-9]+(\.[0-9]{2})?$
        VoiceAuthRefferalCode:
          description: Voice Referral floor limit authorisation code
          type: string
        CommerceTriggersEnabled:
          description: Enable commerce triggers.
          type: string
          minLength: 1
          maxLength: 1
          pattern: '[0-1]'
        ContactlessCvmRequiredLimit:
          description: The contactless limit which CVM is required. If this is set it will override any defaults set for card brands in the EMV config - unless these defaults are more restrictive.
          type: string
          minLength: 12
          maxLength: 12
          pattern: ^[a-fA-F0-9]*$
        OfflineFloorLimit:
          description: The limit which transactions can be approved offline. Generally this is now set to zero (0). If this is set it will override any defaults set for card brands in the EMV config - unless these defaults are more restrictive.
          type: string
          minLength: 12
          maxLength: 12
          pattern: ^[a-fA-F0-9]*$
        CashEnabled:
          description: Enables Cash handling for the terminal.
          type: string
          minLength: 1
          maxLength: 1
          pattern: '[0-1]'
        DualPricingEnabled:
          description: Enable Dual Pricing for this merchant.
          type: string
          minLength: 1
          maxLength: 1
          pattern: '[0-1]'
        DccEnabled:
          description: Enable Dynamic Currency Conversion for this merchant.
          type: string
          minLength: 1
          maxLength: 1
          pattern: '[0-1]'
        DualPricingAdjustmentRate:
          description: Adjustment rate in dual pricing payment option.
          type: number
          format: decimal
          pattern: ^-?\d+(\.\d+)?$
        DualPricingTipBasis:
          description: "0 - When the original subtotal is set 0, the tip suggestions \n    are calculated using the original subtotal requested from the POS.\n\n1 - When the original subtotal is set 1, the tip suggestions are calculated \n    using the adjusted subtotal chosen by the customer from the dual pricing payment options."
          type: string
          minLength: 1
          maxLength: 1
        TransactionCurrencyCode_5F2A:
          description: 5F2A Currency Code for the Terminal.
          type: string
          maxLength: 4
          minLength: 4
          pattern: ^[a-fA-F0-9]*$
        TransactionCurrencyExponent_5F36:
          description: 5F36 Currency Exponent based on the country code for the Terminal.
          type: string
          maxLength: 2
          minLength: 2
          pattern: ^[a-fA-F0-9]*$
        CustomCurrencySymbol:
          description: Custom Currency Code symbol for the Terminal based on country.
          type: string
          maxLength: 3
          minLength: 3
          pattern: ^[A-Z]*$
        CurrencyCode:
          $ref: '#/components/schemas/CurrencyCodeEnum'
        NumberFormatLocale:
          description: Locale for number formatting.
          type: string
          maxLength: 8
          minLength: 0
          pattern: ^[a-zA-Z-]*$
        SurchargeRefundMethod:
          description: Surcharge Refund Method 0- Default When Purchase Surcharge is Not Enabled 2- When Purchase Surcharge Enabled
          type: string
          minLength: 1
          maxLength: 1
          pattern: '[0-2]'
    EntityUidDeprecated:
      description: The Verifone allocated unique id for this site. This is allocated by Verifone when an order is initially received. Please use value returned in OrderResponse.
      type: string
      format: uuid
      deprecated: true
    ContactName:
      allOf:
      - $ref: '#/components/schemas/Name'
    TipOptions:
      title: Tip Options
      description: Tip Options
      type: object
      additionalProperties: false
      properties:
        tipEnabled:
          description: Enable tipping. When enabled the device presents a tip selection screen during a transaction, showing pre-configured tip amounts and an option for a custom amount.
          type: boolean
        tipLimit:
          description: Defines the maximum percentage of the transaction amount that can be added as a tip. If this is exceeded, a warning is prompted.
          type: integer
          format: int64
        tipPercentages:
          description: Pre-Defines up to 3 tip percentage options for customers to choose from, after entering the purchase amount for a transaction, e.g. 10, 15, 20 = 10%, 15%, 20%, respectively. Note that the TipEnabled parameter must be enabled, and that only whole numbers are accepted as percentage values, e.g. 10% (not 10.5%).
          type: string
          pattern: ([0-9]+,){0,2}([0-9]+)
          maxLength: 150
    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
    ReplacedDevice:
      title: ReplacedDevice
      type: object
      description: A device being replaced under a replacement agreement.
      required:
      - serialNumber
      - deviceModel
      properties:
        serialNumber:
          type: string
          minLength: 1
          maxLength: 12
          description: Serial number of the replaced device.
        deviceModel:
          type: string
          minLength: 1
          maxLength: 100
          description: Model name of the replaced device.
    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.
    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'
    ContactAddressType:
      description: A Contact and their address details.
      type: object
      properties:
        contact:
  

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