Verifone · Schema

MerchantOrderResponse

MerchantOrderResponse from Verifone Order API

PaymentsPOSTerminal ManagementeCommerceFinTechPayment ProcessingOmnichannel
View JSON Schema on GitHub

JSON Schema

order-service-api-merchantorderresponse.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/verifone/refs/heads/main/json-schema/order-service-api-merchantorderresponse.json",
  "title": "MerchantOrderResponse",
  "description": "MerchantOrderResponse from Verifone Order API",
  "allOf": [
    {
      "$ref": "#/components/schemas/MerchantOrder"
    },
    {
      "properties": {
        "orderId": {
          "$ref": "#/components/schemas/OrderId"
        },
        "status": {
          "$ref": "#/components/schemas/OrderStatusEnum"
        },
        "createdUserUid": {
          "$ref": "#/components/schemas/CreatedUserId"
        },
        "createdBy": {
          "$ref": "#/components/schemas/UserName"
        },
        "createdDate": {
          "type": "string",
          "description": "The created date for this order.",
          "format": "date-time"
        },
        "modifiedUserUid": {
          "description": "The assigned User_ID corresponding to the Order Modified By.",
          "type": "string",
          "format": "uuid"
        },
        "modifiedBy": {
          "$ref": "#/components/schemas/UserName"
        },
        "modifiedDate": {
          "type": "string",
          "description": "The last modified date for this order.",
          "format": "date-time"
        },
        "orderType": {
          "type": "string",
          "default": "MerchantOrder"
        },
        "entityUid": {
          "$ref": "#/components/schemas/EntityUid"
        },
        "merchantCompanyEntityUid": {
          "$ref": "#/components/schemas/MerchantCompanyEntityUid"
        },
        "merchantCompanyGroupEntityUid": {
          "description": "For Group Feature, `entityType = MERCHANT_COMPANY_GROUP``.",
          "type": "string",
          "format": "uuid"
        },
        "internal": {
          "$ref": "#/components/schemas/InternalAllocatedInformationNewCompanyAndSite"
        }
      }
    }
  ],
  "required": [
    "orderId",
    "status",
    "orderType",
    "entityUid",
    "merchantCompanyEntityUid"
  ]
}