---
updatedAt: 2026-07-02T02:11:51.000Z
agentTools:
  projectIndex: https://docs.clover.com/dev/llms.txt
---

# Get all service charges applied to an order

Retrieves all service charges applied to an order.

# OpenAPI definition

```json
{
  "x-samples-languages": [
    "curl",
    "node",
    "javascript",
    "java",
    "swift",
    "csharp"
  ],
  "openapi": "3.0.1",
  "info": {
    "title": "Multiple service charge (MSC) Pilot APIs (k3c)",
    "version": "3.0"
  },
  "externalDocs": {
    "url": "https://docs.clover.com"
  },
  "servers": [
    {
      "url": "https://apisandbox.dev.clover.com"
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "paths": {
    "/v3/merchants/{mId}/orders/{orderId}/order_fee_line_items": {
      "get": {
        "tags": [
          "ORDERS"
        ],
        "summary": "Get all service charges applied to an order",
        "description": "Retrieves all service charges applied to an order.",
        "operationId": "order.GetOrderFeeLineItems",
        "parameters": [
          {
            "$ref": "#/components/parameters/UserAgentHeader"
          },
          {
            "name": "mId",
            "in": "path",
            "description": "Merchant identifier.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "orderId",
            "in": "path",
            "description": "Order identifier.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "expand",
            "in": "query",
            "description": "Additional information provided as an expanded response: [employee, orderType, payments]",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response. Service charges for an order, are displayed.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LineItem"
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "components": {
    "schemas": {
      "ServiceChargeAmount": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "amount": {
            "type": "integer",
            "format": "int64"
          }
        }
      },
      "GermanInfo": {
        "type": "object",
        "properties": {
          "cardTrack2": {
            "type": "string"
          },
          "cardSequenceNumber": {
            "type": "string"
          },
          "transactionCaseGermany": {
            "type": "string"
          },
          "transactionTypeGermany": {
            "type": "string"
          },
          "terminalID": {
            "type": "string"
          },
          "traceNumber": {
            "type": "string"
          },
          "oldTraceNumber": {
            "type": "string"
          },
          "receiptNumber": {
            "type": "string"
          },
          "transactionAID": {
            "type": "string"
          },
          "transactionMSApp": {
            "type": "string"
          },
          "transactionScriptResults": {
            "type": "string"
          },
          "receiptType": {
            "type": "string"
          },
          "customerTransactionDOLValues": {
            "type": "string"
          },
          "merchantTransactionDOLValues": {
            "type": "string"
          },
          "merchantJournalDOL": {
            "type": "string"
          },
          "merchantJournalDOLValues": {
            "type": "string"
          },
          "configMerchantId": {
            "type": "string"
          },
          "configProductLabel": {
            "type": "string"
          },
          "hostResponseAidParBMP53": {
            "type": "string"
          },
          "hostResponsePrintDataBM60": {
            "type": "string"
          },
          "sepaElvReceiptFormat": {
            "type": "string"
          },
          "sepaElvExtAppLabel": {
            "type": "string"
          },
          "sepaElvPreNotification": {
            "type": "string"
          },
          "sepaElvMandate": {
            "type": "string"
          },
          "sepaElvCreditorId": {
            "type": "string"
          },
          "sepaElvMandateId": {
            "type": "string"
          },
          "sepaElvIban": {
            "type": "string"
          }
        }
      },
      "DebitRefund": {
        "type": "object",
        "properties": {
          "debitTransactionRouteInd": {
            "type": "string",
            "description": "The route that the payment transaction took, which is obtained from the RC response"
          },
          "isDebitTransactionRefundable": {
            "type": "boolean",
            "description": "True, if debitTransactionRouteInd is C, else, its determined by the EDS entitlement rule for D/S"
          }
        }
      },
      "IdentityDocument": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier"
          },
          "type": {
            "type": "string",
            "description": "Type of personal identification: National Document, Passport, etc"
          },
          "number": {
            "type": "string",
            "description": "The identification number"
          },
          "createdTime": {
            "type": "integer",
            "description": "Created timestamp.",
            "format": "int64"
          },
          "modifiedTime": {
            "type": "integer",
            "description": "Modified timestamp.",
            "format": "int64"
          },
          "deletedTime": {
            "type": "integer",
            "description": "Deleted timestamp.",
            "format": "int64"
          },
          "payment": {
            "$ref": "#/components/schemas/Reference"
          }
        }
      },
      "PromotionalMessage": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string"
          },
          "showOnMerchantReceipt": {
            "type": "boolean"
          },
          "showOnCustomerReceipt": {
            "type": "boolean"
          },
          "showOnDisplay": {
            "type": "boolean"
          }
        }
      },
      "Refund": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier"
          },
          "orderRef": {
            "description": "The order with which the refund is associated",
            "$ref": "#/components/schemas/Reference"
          },
          "device": {
            "description": "Device which processed the transaction for this refund, a 128-bit UUID, not a normal base-13 Clover ID.",
            "$ref": "#/components/schemas/Reference"
          },
          "amount": {
            "type": "integer",
            "description": "Total amount refunded, including tax and tip",
            "format": "int64"
          },
          "taxAmount": {
            "type": "integer",
            "description": "Tax amount refunded"
          },
          "tipAmount": {
            "type": "integer",
            "description": "Tip amount refunded"
          },
          "createdTime": {
            "type": "integer",
            "description": "The time when the refund was recorded on the server",
            "format": "int64"
          },
          "clientCreatedTime": {
            "type": "integer",
            "description": "The time when the refund was recorded on the client",
            "format": "int64"
          },
          "deletedTime": {
            "type": "integer",
            "description": "The time when the refund was deleted on the server",
            "format": "int64"
          },
          "gatewayProcessingTime": {
            "type": "integer",
            "description": "The time when the refund was processed by the gateway",
            "format": "int64"
          },
          "payment": {
            "description": "The payment with which the refund is associated",
            "$ref": "#/components/schemas/Reference"
          },
          "employee": {
            "$ref": "#/components/schemas/Reference"
          },
          "lineItems": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Reference"
            }
          },
          "overrideMerchantTender": {
            "description": "The tender type associated with this payment, e.g. credit card, cash, etc.",
            "$ref": "#/components/schemas/Tender"
          },
          "taxableAmountRates": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TaxableAmountRate"
            }
          },
          "serviceChargeAmount": {
            "$ref": "#/components/schemas/ServiceChargeAmount"
          },
          "additionalCharges": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AdditionalChargeAmount"
            }
          },
          "attributes": {
            "type": "object",
            "properties": {
              "default": {
                "type": "string"
              }
            }
          },
          "refundExtraData": {
            "type": "object",
            "properties": {
              "default": {
                "type": "string"
              }
            }
          },
          "germanInfo": {
            "description": "German region-specific information",
            "$ref": "#/components/schemas/GermanInfo"
          },
          "appTracking": {
            "description": "Tracking information for the app that created this refund.",
            "$ref": "#/components/schemas/AppTracking"
          },
          "voided": {
            "type": "boolean"
          },
          "voidReason": {
            "type": "string"
          },
          "cardTransaction": {
            "description": "Information about the card used for credit or debit card refunds",
            "$ref": "#/components/schemas/CardTransaction"
          },
          "transactionInfo": {
            "description": "Transaction information",
            "$ref": "#/components/schemas/TransactionInfo"
          },
          "merchant": {
            "$ref": "#/components/schemas/Reference"
          },
          "externalReferenceId": {
            "type": "string",
            "description": "The external reference id if associated with the refund"
          },
          "authCode": {
            "type": "string",
            "description": "Auth code generated by the acquire"
          },
          "status": {
            "type": "string",
            "description": "Status of the refund.It can be Fail/Success/Pending",
            "enum": [
              "FAIL",
              "SUCCESS",
              "PENDING",
              "VOIDED"
            ]
          },
          "oceanGatewayInfo": {
            "description": "Ocean Gateway info - for India region",
            "$ref": "#/components/schemas/OceanGatewayInfo"
          },
          "reason": {
            "type": "string",
            "description": "Reason why the refund was initiated"
          },
          "fxInfo": {
            "description": "Associated GEP exchange rate information",
            "$ref": "#/components/schemas/PaymentFxInfo"
          },
          "closeoutBatchInfo": {
            "description": "Information about the Batch used for payments",
            "$ref": "#/components/schemas/CloseoutBatchInfo"
          }
        }
      },
      "Modification": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string",
            "description": "the name of the modifier when it was applied"
          },
          "alternateName": {
            "type": "string"
          },
          "amount": {
            "type": "integer",
            "description": "the additional cost of the modifier when it was applied",
            "format": "int64"
          },
          "modifier": {
            "description": "The modifier object.  Values from the Modifier are copied to the Modification at the time that the order is placed.  Modifier values may change after the modification is created.",
            "$ref": "#/components/schemas/Modifier"
          },
          "quantitySold": {
            "type": "integer",
            "description": "This is only used in reports. The count of how many of these modifiers that were sold.",
            "format": "int64"
          }
        }
      },
      "Discount": {
        "required": [
          "name"
        ],
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier"
          },
          "discount": {
            "description": "If this item is based on a standard discount, this will point to the appropriate inventory.Discount",
            "$ref": "#/components/schemas/Reference"
          },
          "approver": {
            "description": "The person that authorized a discount",
            "$ref": "#/components/schemas/Reference"
          },
          "name": {
            "type": "string",
            "description": "Name of the discount"
          },
          "amount": {
            "type": "integer",
            "description": "Discount amount in fraction of currency unit (e.g. cents) based on currency fraction digits supported"
          },
          "percentage": {
            "type": "integer",
            "description": "Discount amount in percent"
          }
        }
      },
      "TransactionInfo": {
        "type": "object",
        "properties": {
          "languageIndicator": {
            "type": "string",
            "description": "2 character language used for the transaction. Deprecated in factor of transactionLocale."
          },
          "transactionLocale": {
            "type": "string",
            "description": "Locale for the transaction (e.g. en-CA)"
          },
          "accountSelection": {
            "type": "string",
            "enum": [
              "CREDIT",
              "DEBIT",
              "CHECKING",
              "SAVINGS"
            ]
          },
          "fiscalInvoiceNumber": {
            "type": "string",
            "description": "Consists of 4 digits prefix + 8 digits"
          },
          "installmentsQuantity": {
            "type": "integer",
            "description": "AR Installments: number of installments",
            "format": "int32"
          },
          "installmentsPlanCode": {
            "type": "string",
            "description": "AR Installments: plan alphanum code"
          },
          "installmentsPlanId": {
            "type": "string",
            "description": "AR Installments: selected plan id"
          },
          "installmentsPlanDesc": {
            "type": "string",
            "description": "AR Installments: selected plan desc"
          },
          "cardTypeLabel": {
            "type": "string",
            "description": "Card type label"
          },
          "cardSymbol": {
            "type": "string",
            "description": "Card Symbol for identify in payment_card_config table"
          },
          "stan": {
            "type": "integer",
            "description": "STAN(System Audit Trace Number)",
            "format": "int32"
          },
          "identityDocument": {
            "description": "Customers identification number and type",
            "$ref": "#/components/schemas/IdentityDocument"
          },
          "batchNumber": {
            "type": "string",
            "description": "Transaction Batch Number"
          },
          "receiptNumber": {
            "type": "string",
            "description": "Transaction Receipt Number"
          },
          "reversalStanRefNum": {
            "type": "string",
            "description": "Reversal STAN Ref Num"
          },
          "reversalStan": {
            "type": "integer",
            "description": "STAN for reversal",
            "format": "int32"
          },
          "reversalMac": {
            "type": "string",
            "description": "MAC for reversal"
          },
          "reversalMacKsn": {
            "type": "string",
            "description": "MAC KSN for reversal"
          },
          "terminalIdentification": {
            "type": "string",
            "description": "Designates the unique location of a terminal at a merchant"
          },
          "externalTerminalId": {
            "type": "string",
            "description": "Main internal identifier of terminal which should be the same across all Fiserv’s components"
          },
          "merchantIdentifier": {
            "type": "string",
            "description": "When concatenated with the Acquirer Identifier, uniquely identifies a given merchant"
          },
          "merchantNameLocation": {
            "type": "string",
            "description": "Indicates the name and location of the merchant"
          },
          "maskedTrack2": {
            "type": "string",
            "description": "Masked track2 data"
          },
          "receiptExtraData": {
            "type": "string",
            "description": "Extra data for receipt"
          },
          "selectedService": {
            "type": "string",
            "description": "Defines the Financial Service selected for the transaction",
            "enum": [
              "NONE",
              "PAYMENT",
              "REFUND",
              "CANCELLATION",
              "PRE_AUTH",
              "UPDATE_PRE_AUTH",
              "PAYMENT_COMPLETION",
              "CASH_ADVANCE",
              "DEFERRED_PAYMENT",
              "DEFERRED_PAYMENT_COMPLETION",
              "VOICE_AUTHORISATION",
              "CARDHOLDER_DETECTION",
              "TOKEN_REQUEST",
              "VERIFICATION"
            ]
          },
          "transactionResult": {
            "type": "string",
            "description": "Result of the transaction",
            "enum": [
              "APPROVED",
              "DECLINED",
              "ABORTED",
              "VOICE_AUTHORISATION",
              "PAYMENT_PART_ONLY",
              "PARTIALLY_APPROVED",
              "NONE"
            ]
          },
          "transactionTags": {
            "type": "string",
            "description": "Contains a hex string with needed TLV tags for certification"
          },
          "txFormat": {
            "type": "string",
            "description": "Contains the information how the data inside transactionTags should be coded - initially we cause default and nexo as formats",
            "enum": [
              "DEFAULT",
              "NEXO"
            ]
          },
          "panMask": {
            "type": "string",
            "description": "Contains the information how the PAN should masked."
          },
          "transactionSequenceCounter": {
            "type": "string",
            "description": "Counter maintained by the terminal that is incremented for each transaction at the beginning of the Perform Service function."
          },
          "applicationPanSequenceNumber": {
            "type": "string",
            "description": "Identifies and differentiates cards with the same PAN."
          },
          "reversalReason": {
            "type": "string",
            "description": "Contains the reason why the transaction should be reversed in the host. It has to be mapped in server with the expected value by the corresponding gateway",
            "enum": [
              "CHIP_DECLINE",
              "CARDHOLDER_CANCELLATION",
              "COMMUNICATION_ERROR",
              "OTHER_REASON"
            ]
          },
          "isTokenBasedTx": {
            "type": "boolean",
            "description": "Boolean to determine if the transaction done using a vaulted card is a token based transaction",
            "default": "false"
          },
          "origTransactionSequenceCounter": {
            "type": "string",
            "description": "For reversal and capture transactions, this contains the reference (transactionSequenceCounter) to the originating transaction."
          },
          "transactionSequenceCounterUpdate": {
            "type": "string",
            "description": "This field is populated when the TSC of a terminal is out of sync and is provided with an update."
          },
          "emergencyFlag": {
            "type": "boolean",
            "description": "Boolean value defining if the corresponding TX was performed in NEXO emergency mode according NEXO IS Spec chapter 10.2",
            "default": "false"
          },
          "entryType": {
            "type": "string",
            "description": "This field contains the entry type of a transaction.",
            "enum": [
              "SWIPED",
              "KEYED",
              "VOICE",
              "VAULTED",
              "OFFLINE_SWIPED",
              "OFFLINE_KEYED",
              "EMV_CONTACT",
              "EMV_CONTACTLESS",
              "MSD_CONTACTLESS",
              "PINPAD_MANUAL_ENTRY",
              "QR_CODE",
              "SCANNED"
            ]
          },
          "promotionalMessage": {
            "$ref": "#/components/schemas/PromotionalMessage"
          },
          "sepaElvTransactionInfo": {
            "$ref": "#/components/schemas/SepaElvTransactionInfo"
          },
          "clientCardType": {
            "type": "string",
            "description": "Client card type should be used only limited purpose only and should not be confused with cardType in other objects.\n This is a read only field and must not to be overwritten on server or client once set on client. \n This is set on client only for MSR tx for now as the AIDs are not identified for MSR. \n For few MSR tx, the card type was identified incorrectly on client side, and also on server side based on the bin match. \n In order to get the correct card types, this client card type will be sent to the server",
            "enum": [
              "VISA",
              "MC",
              "AMEX",
              "DISCOVER",
              "DINERS_CLUB",
              "JCB",
              "MAESTRO",
              "SOLO",
              "LASER",
              "CHINA_UNION_PAY",
              "CARTE_BLANCHE",
              "UNKNOWN",
              "GIFT_CARD",
              "EBT",
              "GIROCARD",
              "INTERAC",
              "OTHER",
              "RUPAY"
            ]
          },
          "explicitlySelectedApp": {
            "type": "string",
            "description": "The app explicitly selected by the customer via the choice button."
          },
          "isSepaElv": {
            "type": "boolean",
            "description": "Defines if the corresponding TX was performed as SEPA ELV TX."
          },
          "cardEntryType": {
            "type": "string",
            "description": "Defines if the corresponding TX was performed as SEPA ELV TX.",
            "enum": [
              "SWIPED",
              "KEYED",
              "VOICE",
              "VAULTED",
              "OFFLINE_SWIPED",
              "OFFLINE_KEYED",
              "EMV_CONTACT",
              "EMV_CONTACTLESS",
              "MSD_CONTACTLESS",
              "PINPAD_MANUAL_ENTRY",
              "QR_CODE",
              "SCANNED"
            ]
          },
          "printMessages": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/DisplayAndPrintMessage"
            }
          },
          "isPartialApprovedCashbackTransaction": {
            "type": "boolean",
            "description": "Defines if payment amount was approved but cashback amount was declined."
          }
        }
      },
      "SepaElvTransactionInfo": {
        "type": "object",
        "properties": {
          "receiptFormat": {
            "type": "string",
            "description": "Value of tag E1.DF8206 from NEXO config."
          },
          "extAppLabel": {
            "type": "string",
            "description": "Value of tag E6.DF8211 or E6.DF8212 (Online or Offline TX printout)."
          },
          "preNotification": {
            "type": "string",
            "description": "Value of tag E6.DF8214 info form NEXO config."
          },
          "mandate": {
            "type": "string",
            "description": "Value of tag E6.DF8215 info from NEXO config."
          },
          "creditorId": {
            "type": "string",
            "description": "Value of tag E6.DF8216 info from NEXO config."
          },
          "mandateId": {
            "type": "string",
            "description": "Generated by SPA according to ELV – TBD: use Trace number instead of receipt number."
          },
          "iban": {
            "type": "string",
            "description": "Received in ICC related data from IPG (tag 5F53)."
          },
          "isMerchantForced": {
            "type": "boolean",
            "description": "Defines if the corresponding SEPA ELV TX was forced by the merchant (override defined limit)"
          }
        }
      },
      "Reference": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier"
          }
        }
      },
      "CloseoutBatchInfo": {
        "type": "object",
        "properties": {
          "batchUuid": {
            "type": "string"
          },
          "batchModifiedTime": {
            "type": "integer",
            "description": "Modified time of batch",
            "format": "int64"
          }
        }
      },
      "AppTracking": {
        "type": "object",
        "properties": {
          "developerAppId": {
            "type": "string",
            "description": "The uuid from the developer application.  This is typically populated and used only on the back end."
          },
          "applicationName": {
            "type": "string",
            "description": "The name of the developer application."
          },
          "applicationID": {
            "type": "string",
            "description": "A string representing an application"
          },
          "applicationVersion": {
            "type": "string",
            "description": "A string representing a semanticversion.  See http://semver.org/"
          },
          "sourceSDK": {
            "type": "string",
            "description": "A string representing a SDK"
          },
          "sourceSDKVersion": {
            "type": "string",
            "description": "A string representing a semanticversion.  See http://semver.org/"
          }
        }
      },
      "Tag": {
        "required": [
          "name"
        ],
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier"
          },
          "name": {
            "type": "string",
            "description": "Tag name",
            "default": ""
          },
          "showInReporting": {
            "type": "boolean",
            "description": "True if tag is a summary label in the reporting app",
            "default": "false"
          },
          "items": {
            "type": "array",
            "description": "Items associated with this tag",
            "items": {
              "$ref": "#/components/schemas/Reference"
            }
          },
          "printers": {
            "type": "array",
            "description": "Printers associated with this tag",
            "items": {
              "$ref": "#/components/schemas/Reference"
            }
          }
        }
      },
      "TaxableAmountRate": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Tax rate id."
          },
          "name": {
            "type": "string",
            "description": "Tax rate name. This field is optional."
          },
          "taxableAmount": {
            "type": "integer",
            "description": "The sub-total of line items that the tax was based on. For VAT, this amount includes tax. For all others, this amount does not include tax.",
            "format": "int64"
          },
          "rate": {
            "type": "integer",
            "description": "The tax rate. 100% = 1e7.",
            "format": "int64"
          },
          "isVat": {
            "type": "boolean",
            "description": "Whether the taxable amount includes tax."
          },
          "taxAmount": {
            "type": "integer",
            "description": "The amount of tax collected. In cases where there are multiple payments for an order then it may be necessary to add an extra cent of tax to the last payment.",
            "format": "int64"
          },
          "transactionRef": {
            "description": "The refund with which the tax rate is associated",
            "$ref": "#/components/schemas/Reference"
          },
          "isDefault": {
            "type": "boolean",
            "description": "Whether the tax rate was configured as a default tax rate at the time that the refund was created."
          }
        }
      },
      "LineItemPayment": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier; TBD this is confusing because it's used as either line item id or payment id"
          },
          "percentage": {
            "type": "integer",
            "description": "Percent of this line item covered by this payment",
            "format": "int64"
          },
          "binName": {
            "type": "string",
            "description": "Bin this line item payment was for"
          },
          "refunded": {
            "type": "boolean",
            "description": "Payment has been refunded"
          }
        }
      },
      "DisplayAndPrintMessage": {
        "type": "object",
        "properties": {
          "destination": {
            "type": "string",
            "description": "Destination for the message CDSP - CustomerDisplay, CRCP - CustomerReceipt/AidParam, MDSP - MerchantDisplay, MRCP - MerchantReceipt/AidParam",
            "enum": [
              "CUSTOMER_DISPLAY",
              "CUSTOMER_RECEIPT",
              "CUSTOMER_RECEIPT_AID_PARAM",
              "MERCHANT_DISPLAY",
              "MERCHANT_RECEIPT",
              "MERCHANT_RECEIPT_AID_PARAM"
            ]
          },
          "content": {
            "type": "string",
            "description": "Contains the display and/or print message text from gateway"
          }
        }
      },
      "OceanGatewayInfo": {
        "type": "object",
        "properties": {
          "tranSource": {
            "type": "string",
            "description": "This field contains transaction source returned from Ocean as part of Notification for a transaction"
          },
          "tranChannel": {
            "type": "string",
            "description": "This field contains LPM type info returned from Ocean as part of Notification for a transaction"
          },
          "transactionType": {
            "type": "string",
            "description": "This field contains transaction type info returned from Ocean as part of Notification for a transaction"
          },
          "merchantId": {
            "type": "string",
            "description": "This field contains MerchantId returned from Ocean as part of Notification for a transaction"
          },
          "terminalId": {
            "type": "string",
            "description": "This field contains TerminalId returned from Ocean as part of Notification for a transaction"
          },
          "tenderType": {
            "type": "string",
            "description": "This field contains tender type info returned from Ocean as part of Notification for a transaction"
          },
          "entryMethod": {
            "type": "string",
            "description": "This field contains the entry method returned from Ocean as part of Notification for a transaction"
          },
          "transactionAmount": {
            "type": "string",
            "description": "This field contains the transaction amount returned from Ocean as part of Notification for a transaction"
          },
          "transactionCurrency": {
            "type": "string",
            "description": "This field contains the transaction currency returned from Ocean as part of Notification for a transaction"
          },
          "fpTransactionId": {
            "type": "string",
            "description": "This field contains the ocean generated transaction Id for a transaction"
          },
          "merchantTxnId": {
            "type": "string",
            "description": "This field contains the payment reference id provided by clover for a transaction"
          },
          "fpRefundTransactionId": {
            "type": "string",
            "description": "This field contains the refund transaction id returned from Ocean for a transaction"
          },
          "transactionStatus": {
            "type": "string",
            "description": "This field contains the transaction status returned from Ocean as part of Notification for a transaction"
          },
          "transactionStatusDescription": {
            "type": "string",
            "description": "This field contains the transaction status description returned from Ocean as part of Notification for a transaction"
          },
          "rrn": {
            "type": "string",
            "description": "This field contains rrn number (reference provided by bank) returned from Ocean as part of Notification for a transaction"
          },
          "batchNo": {
            "type": "string",
            "description": "This field contains batch number returned from Ocean as part of Notification for a transaction"
          },
          "invoiceNo": {
            "type": "string",
            "description": "This field contains invoice number returned from Ocean as part of Notification for a transaction"
          },
          "cardScheme": {
            "type": "string",
            "description": "This field contains Customer LPM information returned from Ocean as part of Notification for a transaction"
          },
          "qrType": {
            "type": "string",
            "description": "This field contains qr tpe either static or dynamic information returned from Ocean as part of Notification for a transaction"
          },
          "transactionDateTime": {
            "type": "string",
            "description": "This field contains transaction completion date info returned from Ocean as part of Notification for a transaction"
          },
          "authCode": {
            "type": "string",
            "description": "This field contains Authorization Code returned from Ocean as part of Notification for a transaction"
          },
          "pan": {
            "type": "string",
            "description": "This field contains pan information like masked virtual payment address,vehicle info,userId returned from Ocean as part of Notification for a transaction"
          },
          "customerMobile": {
            "type": "string",
            "description": "This field contains customer mobile info returned from Ocean as part of Notification for a transaction"
          },
          "customerName": {
            "type": "string",
            "description": "This field contains customer name returned from Ocean as part of Notification for a transaction"
          },
          "customerRemarks": {
            "type": "string",
            "description": "This field contains customer remarks returned from Ocean as part of Notification for a transaction"
          },
          "bankName": {
            "type": "string",
            "description": "This field contains name of the bank returned from Ocean as part of Notification for a transaction"
          },
          "bankCode": {
            "type": "string",
            "description": "This field contains bank code returned from Ocean as part of Notification for a transaction"
          },
          "emiDetails": {
            "description": "This field indicates the EMI details of a customer returned from Ocean as part of Notification for a transaction",
            "$ref": "#/components/schemas/EMIDetails"
          }
        }
      },
      "CardTransaction": {
        "type": "object",
        "properties": {
          "cardType": {
            "type": "string",
            "enum": [
              "VISA",
              "MC",
              "AMEX",
              "DISCOVER",
              "DINERS_CLUB",
              "JCB",
              "MAESTRO",
              "SOLO",
              "LASER",
              "CHINA_UNION_PAY",
              "CARTE_BLANCHE",
              "UNKNOWN",
              "GIFT_CARD",
              "EBT",
              "GIROCARD",
              "INTERAC",
              "OTHER",
              "RUPAY"
            ]
          },
          "entryType": {
            "type": "string",
            "enum": [
              "SWIPED",
              "KEYED",
              "VOICE",
              "VAULTED",
              "OFFLINE_SWIPED",
              "OFFLINE_KEYED",
              "EMV_CONTACT",
              "EMV_CONTACTLESS",
              "MSD_CONTACTLESS",
              "PINPAD_MANUAL_ENTRY",
              "QR_CODE",
              "SCANNED"
            ]
          },
          "first6": {
            "type": "string",
            "description": "The first four digits of the card number"
          },
          "last4": {
            "type": "string",
            "description": "The last four digits of the card number"
          },
          "type": {
            "type": "string",
            "enum": [
              "AUTH",
              "PREAUTH",
              "PREAUTHCAPTURE",
              "ADJUST",
              "VOID",
              "VOIDRETURN",
              "RETURN",
              "REFUND",
              "NAKEDREFUND",
              "GETBALANCE",
              "BATCHCLOSE",
              "ACTIVATE",
              "BALANCE_LOCK",
              "LOAD",
              "CASHOUT",
              "CASHOUT_ACTIVE_STATUS",
              "REDEMPTION",
              "REDEMPTION_UNLOCK",
              "RELOAD",
              "CASH_ADVANCE",
              "VOID_CREDIT",
              "REFUND_CREDIT",
              "INTERNET_ACTIVATE",
              "TOKEN_REQUEST",
              "VERIFICATION",
              "MONEY_TRANSFER"
            ]
          },
          "authCode": {
            "type": "string",
            "description": "Authorization code (if successful)"
          },
          "referenceId": {
            "type": "string"
          },
          "transactionNo": {
            "type": "string"
          },
          "state": {
            "type": "string",
            "description": "A state inferred from transaction type and whether the gateway captured the transaction",
            "enum": [
              "PENDING",
              "CLOSED"
            ]
          },
          "extra": {
            "type": "object",
            "properties": {
              "default": {
                "type": "string"
              }
            },
            "description": "Extra info to be stored as part of gateway/card transaction"
          },
          "begBalance": {
            "type": "integer"
          },
          "endBalance": {
            "type": "integer"
          },
          "avsResult": {
            "type": "string",
            "enum": [
              "SUCCESS",
              "ZIP_CODE_MATCH",
              "ZIP_CODE_MATCH_ADDRESS_NOT_CHECKED",
              "ADDRESS_MATCH",
              "ADDRESS_MATCH_ZIP_NOT_CHECKED",
              "NEITHER_MATCH",
              "SERVICE_FAILURE",
              "SERVICE_UNAVAILABLE",
              "NOT_CHECKED",
              "ZIP_CODE_NOT_MATCHED_ADDRESS_NOT_CHECKED",
              "ADDRESS_NOT_MATCHED_ZIP_CODE_NOT_CHECKED",
              "ZIP_CODE_MATCH_ADDRESS_NOT_MATCH"
            ]
          },
          "cardholderName": {
            "type": "string"
          },
          "token": {
            "type": "string"
          },
          "vaultedCard": {
            "description": "Vaulted card which can be used for subsequent transactions",
            "$ref": "#/components/schemas/VaultedCard"
          },
          "gatewayTxState": {
            "type": "string",
            "description": "The state as currently recorded. This differs from the legacy 'state' field. The legacy 'state' field is calculated from the 'type' field and whether the transaction was captured.",
            "enum": [
              "INITIATED",
              "INITIATED_ON_AUTH",
              "ACKNOWLEDGED",
              "CONNECT_FAILED",
              "TIMEOUT",
              "FAILED",
              "REVERSE_INITIATED",
              "REVERSE_INITIATED_ON_AUTH",
              "REVERSED",
              "REVERSAL_FAILED",
              "EXTERNAL"
            ]
          },
          "currency": {
            "type": "string",
            "description": "Currency code"
          },
          "captured": {
            "type": "boolean"
          },
          "debitRefund": {
            "description": "The refund parameters required for debit card refunds",
            "$ref": "#/components/schemas/DebitRefund"
          }
        }
      },
      "AdditionalChargeAmount": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Additional charge id"
          },
          "amount": {
            "type": "integer",
            "description": "Amount of the additional charge",
            "format": "int64"
          },
          "rate": {
            "type": "integer",
            "description": "Percent rate of the additional charge times 10000",
            "format": "int64"
          },
          "type": {
            "type": "string",
            "description": "The type of additional charge",
            "enum": [
              "INTERAC",
              "CREDIT_SURCHARGE",
              "CONVENIENCE_FEE",
              "INTERAC_V2",
              "DELIVERY_FEE"
            ]
          }
        }
      },
      "PaymentFxInfo": {
        "type": "object",
        "properties": {
          "submittedCurrency": {
            "type": "string",
            "description": "Customer local currency in which payment is initiated"
          },
          "processedCurrency": {
            "type": "string",
            "description": "Merchant settlement currency"
          },
          "exchangeRate": {
            "type": "string",
            "description": "Exchange rate from settlement currency to payment currency"
          },
          "submittedCurrencyMinorUnit": {
            "type": "integer",
            "description": "Payment currency minor unit",
            "format": "int32"
          },
          "submittedAmount": {
            "type": "integer",
            "description": "Payment charge amount",
            "format": "int64"
          },
          "submittedOriginalAuthAmount": {
            "type": "integer",
            "description": "submitted Original Auth Amount",
            "format": "int64"
          },
          "submittedTipAmount": {
            "type": "integer",
            "description": "Payment tip amount",
            "format": "int64"
          },
          "submittedTaxAmount": {
            "type": "integer",
            "description": "Payment tax amount",
            "format": "int64"
          },
          "submittedConvenienceFee": {
            "type": "integer",
            "description": "Payment convenience fee amount",
            "format": "int64"
          },
          "submittedSurchargeInfo": {
            "type": "string",
            "description": "Payment surcharge info amount"
          },
          "submittedCashbackAmount": {
            "type": "integer",
            "description": "Amount given back in a cash back transaction"
          },
          "submittedServiceCharge": {
            "description": "Amount record as a service charge",
            "$ref": "#/components/schemas/ServiceChargeAmount"
          },
          "submittedAdditionalCharges": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AdditionalChargeAmount"
            }
          }
        }
      },
      "EMIDetails": {
        "type": "object",
        "properties": {
          "lenderName": {
            "type": "string",
            "description": "This field contains the EMI lender name"
          },
          "tenure": {
            "type": "string",
            "description": "This field contains total EMI tenure"
          },
          "interestRate": {
            "type": "string",
            "description": "This field contains interest rate charged as part of EMI"
          },
          "interest": {
            "type": "string",
            "description": "This field contains interest amount charged as part of EMI"
          },
          "emiAmount": {
            "type": "string",
            "description": "This field contains EMI amount per month"
          },
          "lenderLoanId": {
            "type": "string",
            "description": "This field contains lender loan id for the EMI"
          },
          "fees": {
            "type": "string",
            "description": "This field contains processing fee charged for EMI"
          },
          "discountAmount": {
            "type": "string",
            "description": "This field contains discount amount provided for EMI"
          },
          "offerCashback": {
            "type": "string",
            "description": "This field contains offer cashback amount provided for EMI"
          },
          "tranAmount": {
            "type": "string",
            "description": "This field contains total transaction amount"
          },
          "totalPayable": {
            "type": "string",
            "description": "This field contains total payable amount i.e. total EMI with interest"
          }
        }
      },
      "TaxRate": {
        "required": [
          "name"
        ],
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "taxType": {
            "type": "string",
            "description": "to support Argentina's tax type",
            "enum": [
              "VAT_TAXABLE",
              "VAT_NON_TAXABLE",
              "VAT_EXEMPT",
              "INTERNAL_TAX",
              "PARTNER_TAX",
              "ORDER_FEES"
            ]
          },
          "rate": {
            "type": "integer",
            "description": "For percentage based discounts like sales tax",
            "format": "int64"
          },
          "isDefault": {
            "type": "boolean"
          },
          "items": {
            "type": "array",
            "description": "Items associated with this tax rate",
            "items": {
              "$ref": "#/components/schemas/Reference"
            }
          },
          "taxAmount": {
            "type": "integer",
            "description": "For a flat tax like recycling redemption fee, expressed as number of cents"
          },
          "deletedTime": {
            "type": "integer",
            "description": "Timestamp when tax rate was last deleted"
          },
          "modifiedTime": {
            "type": "integer",
            "description": "Timestamp when tax rate was last modified"
          }
        }
      },
      "VaultedCard": {
        "required": [
          "first6",
          "last4"
        ],
        "type": "object",
        "properties": {
          "first6": {
            "type": "string"
          },
          "last4": {
            "type": "string"
          },
          "cardholderName": {
            "type": "string"
          },
          "expirationDate": {
            "type": "string"
          },
          "token": {
            "type": "string"
          }
        }
      },
      "Modifier": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier"
          },
          "name": {
            "type": "string",
            "description": "Name of the modifier"
          },
          "alternateName": {
            "type": "string",
            "description": "Alternate name of the modifier"
          },
          "available": {
            "type": "boolean",
            "description": "True if this modifier is available across all channels",
            "default": "true"
          },
          "price": {
            "type": "integer",
            "description": "Additional cost when used",
            "default": "0"
          },
          "modifiedTime": {
            "type": "integer",
            "description": "Timestamp when the modifier was last modified"
          },
          "modifierGroup": {
            "$ref": "#/components/schemas/Reference"
          },
          "menuModifier": {
            "description": "Menu Modifier attribute that can be expanded to menu specific attributes",
            "$ref": "#/components/schemas/MenuModifier"
          },
          "deleted": {
            "type": "boolean",
            "description": "Whether the modifier has been deleted."
          }
        }
      },
      "MenuModifier": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Modifier id"
          },
          "modifier": {
            "description": "Reference to the modifier",
            "$ref": "#/components/schemas/Reference"
          },
          "price": {
            "type": "integer",
            "description": "Modifier price",
            "format": "int64"
          },
          "name": {
            "type": "string",
            "description": "Customer facing modifier name"
          },
          "description": {
            "type": "string",
            "description": "Modifier description"
          },
          "imageFilename": {
            "type": "string",
            "description": "Modifier image file path"
          },
          "enabled": {
            "type": "boolean",
            "description": "Modifier enabled for menu"
          },
          "reasonCode": {
            "type": "string",
            "description": "Reason for being filtered out"
          },
          "createdTime": {
            "type": "integer",
            "description": "Timestamp when the menu modifier was created",
            "format": "int64"
          },
          "modifiedTime": {
            "type": "integer",
            "description": "Timestamp when the menu modifier was last modified",
            "format": "int64"
          },
          "deletedTime": {
            "type": "integer",
            "description": "Timestamp when menu modifier was last deleted",
            "format": "int64"
          }
        }
      },
      "LineItem": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier."
          },
          "item": {
            "description": "A reference to the inventory item that was used to create this line item. Note that since this a reference the item can be changed and deleted any time such that it no longer matches this line item.",
            "$ref": "#/components/schemas/Reference"
          },
          "colorCode": {
            "type": "string",
            "description": "Hex code representation of the color assigned to item in the form of #fff, #ffffff, or #ffffffff. Note that item color can be changed and deleted any time such that it no longer matches this line item"
          },
          "name": {
            "type": "string",
            "description": "Line item name."
          },
          "alternateName": {
            "type": "string",
            "description": "Alternate name of the line item."
          },
          "price": {
            "type": "integer",
            "description": "Price of the item, typically in cents of merchant currency. When unit quantity is not null then this is the price for a single unit and is not the complete price.",
            "format": "int64"
          },
          "priceWithModifiers": {
            "type": "integer",
            "description": "Price of item after adding all modifications. This is used only for reporting.",
            "format": "int64"
          },
          "priceWithModifiersAndItemAndOrderDiscounts": {
            "type": "integer",
            "description": "Price of item after adding all modifications and subtracting all line item and order level discounts. This is used only for reporting.",
            "format": "int64"
          },
          "unitQty": {
            "type": "integer",
            "description": "This is applicable only if the item is priced by quantity of a unit. The item must have a priceType of PER_UNIT. The value is a fixed-point integer with scaling factor of 1000 (e.g. if charging per ounce, the value should be set to 2500 for 2.5 ounces). To compute the complete price perform the following calculation: PRICE * (UNIT QTY / 1000). If the item doesn’t have a priceType of PER_UNIT, then unitQty is ignored."
          },
          "unitName": {
            "type": "string",
            "description": "Unit name (e.g. oz, lb, etc) if priced by unit, otherwise null."
          },
          "itemCode": {
            "type": "string"
          },
          "note": {
            "type": "string"
          },
          "printed": {
            "type": "boolean",
            "description": "True if this line item has been printed out on an order printer at least once already.",
            "default": "false"
          },
          "exchangedLineItem": {
            "$ref": "#/components/schemas/Reference"
          },
          "binName": {
            "type": "string"
          },
          "userData": {
            "type": "string"
          },
          "createdTime": {
            "type": "integer",
            "format": "int64"
          },
          "orderClientCreatedTime": {
            "type": "integer",
            "format": "int64"
          },
          "discounts": {
            "type": "array",
            "description": "List of discounts applied to the line item. Each line item on an order may have zero or more percentage or amount discounts. Line item discounts are separate from order-level discounts (which are applied to the order subtotal).",
            "items": {
              "$ref": "#/components/schemas/Discount"
            }
          },
          "orderLevelDiscounts": {
            "type": "array",
            "description": "List of order level discounts attributed to this line item. Amounts are rounded to the nearest penny. This is for reporting purposes only. These rounding approximates are not used when calculating the transaction.",
            "items": {
              "$ref": "#/components/schemas/Discount"
            }
          },
          "discountAmount": {
            "type": "integer",
            "description": "Unnamed fixed discount amount in cents. Or, in reporting, this may be the calculated sum of all the line item discounts."
          },
          "orderLevelDiscountAmount": {
            "type": "integer",
            "description": "The calculated sum of order level discounts attributed, approximately to the nearest cent, to this the line item. This is only used in reporting.",
            "format": "int64"
          },
          "exchanged": {
            "type": "boolean",
            "default": "false"
          },
          "modifications": {
            "type": "array",
            "description": "List of references to modifications applied to this line item.",
            "items": {
              "$ref": "#/components/schemas/Modification"
            }
          },
          "tags": {
            "type": "array",
            "description": "List of tags associated with this line item.",
            "items": {
              "$ref": "#/components/schemas/Tag"
            }
          },
          "refunded": {
            "type": "boolean",
            "description": "True if this line item has been refunded",
            "default": "false"
          },
          "refund": {
            "description": "direct item refund",
            "$ref": "#/components/schemas/Refund"
          },
          "isRevenue": {
            "type": "boolean",
            "description": "True if this item should be counted as revenue, for example gift cards and donations would not.",
            "default": "false"
          },
          "taxRates": {
            "type": "array",
            "description": "Tax rates that apply to this line item",
            "items": {
              "$ref": "#/components/schemas/TaxRate"
            }
          },
          "payments": {
            "type": "array",
            "description": "Payments that apply to this line item",
            "items": {
              "$ref": "#/components/schemas/LineItemPayment"
            }
          },
          "revenueAmount": {
            "type": "integer",
            "description": "Revenue collected for this. This field is only used in reporting.",
            "format": "int64"
          },
          "quantitySold": {
            "type": "number",
            "description": "Quantity sold for this line item. This field is only used in reporting"
          },
          "printGroup": {
            "description": "Optional reference to the print group that this line item belongs to.",
            "$ref": "#/components/schemas/Reference"
          },
          "hidden": {
            "type": "boolean",
            "description": "True if this line item has been marked as hidden on User Interface like Orders page and receipts",
            "default": "false"
          },
          "percentage": {
            "type": "integer",
            "description": "For percentage based order fee line item, percent to charge times 10000, e.g. 12.5% will be 125000"
          },
          "orderFee": {
            "description": "A reference to the inventory order fee that was used to create this line item. Note that since this a reference the order fee can be changed and deleted any time such that it no longer matches this line item.",
            "$ref": "#/components/schemas/Reference"
          },
          "isOrderFee": {
            "type": "boolean",
            "description": "True if this line item is an order fee line item"
          },
          "isPlatformOrderFee": {
            "type": "boolean",
            "description": "True if this line item is an platform order fee line item"
          },
          "orderFeeType": {
            "type": "string",
            "description": "Used to define type of order fee line item, e.g. gratuity."
          }
        }
      },
      "Tender": {
        "required": [
          "label"
        ],
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier"
          },
          "editable": {
            "type": "boolean",
            "description": "If this merchant tender is editable"
          },
          "labelKey": {
            "type": "string",
            "description": "Label Key"
          },
          "label": {
            "type": "string",
            "description": "Label"
          },
          "opensCashDrawer": {
            "type": "boolean",
            "description": "If this tender opens the cash drawer"
          },
          "supportsTipping": {
            "type": "boolean",
            "description": "Allow tipping on payment from tender"
          },
          "enabled": {
            "type": "boolean",
            "description": "If this merchant tender is enabled"
          },
          "visible": {
            "type": "boolean",
            "description": "If this merchant tender is visible"
          },
          "instructions": {
            "type": "string",
            "description": "Instructions"
          }
        }
      }
    },
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer"
      }
    },
    "parameters": {
      "UserAgentHeader": {
        "name": "User-Agent",
        "in": "header",
        "description": "Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: `<application>/<version>`",
        "required": true,
        "schema": {
          "type": "string"
        },
        "example": "PostmanRuntime/7.44.1"
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": false,
    "samples-enabled": true
  }
}
```