---
updatedAt: 2026-05-26T03:38:31.000Z
agentTools:
  siteIndex: https://merchants.westpac.com.au/llms.txt
  projectIndex: https://merchants.westpac.com.au/onlinepay/llms.txt
---

# Create Theme

> ⚠️
>
> This tool is provided to you for the purposes of assisting you with setting up your website to work with OnlinePay. In using the tool, you acknowledge that you are responsible for your website and for any connectivity with OnlinePay. You are responsible for the use of any output generated by the tool or use of any content and its integration and functionality with your website. You must have adequate technical skills and/or your own support in using the tool.
>
> You must not enter or use any Personal Information including customer Personal Information into or with the tool. The tool is provided for educational and testing purposes only to assist you with your website and live customer data such as card number(s), customer names or other Personal Information must never be used or inputted into the tool.

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Checkout API",
    "version": "1.42.4",
    "description": "The Checkout API enables merchants to create and manage hosted payment pages, accept payments via multiple methods (cards, digital wallets, local payment methods), and manage theming and templates for the checkout experience.",
    "contact": {
      "name": "Verifone Developer Support",
      "url": "https://docs.verifone.com"
    },
    "license": {
      "name": "Apache 2.0",
      "url": "https://www.apache.org/licenses/LICENSE-2.0.html"
    }
  },
  "tags": [
    {
      "name": "Theming",
      "description": "Manage visual themes for the checkout page. Upload images and apply branding colours, fonts, and logos to customise the shopper experience.",
      "x-gitbook-description-document": {
        "object": "document",
        "data": {
          "schemaVersion": 9
        },
        "nodes": [
          {
            "object": "block",
            "type": "paragraph",
            "isVoid": false,
            "data": {},
            "nodes": [
              {
                "object": "text",
                "leaves": [
                  {
                    "object": "leaf",
                    "text": "Manage visual themes for the checkout page. Upload images and apply branding colours, fonts, and logos to customise the shopper experience.",
                    "marks": []
                  }
                ],
                "key": "0XKvYjoBVdXT"
              }
            ],
            "key": "SMFcCcpYWGQS"
          }
        ],
        "key": "h9BVXdjm6650"
      },
      "x-gitbook-description-html": "<p>Manage visual themes for the checkout page. Upload images and apply branding colours, fonts, and logos to customise the shopper experience.</p>"
    }
  ],
  "servers": [
    {
      "url": "https://au.gsc.verifone.cloud/oidc/checkout-service",
      "description": "Australia"
    },
    {
      "url": "https://cst.test-gsc.vfims.com/oidc/checkout-service",
      "description": "Global Sandbox"
    }
  ],
  "paths": {
    "/v2/theme": {
      "post": {
        "tags": [
          "Theming"
        ],
        "summary": "Create Theme",
        "security": [
          {
            "BasicAuth": []
          },
          {
            "BearerAuth": []
          }
        ],
        "operationId": "postV2Theme",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateThemeRequest"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "description": "Successful",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Theme"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "details": {
                          "type": "object",
                          "description": "The details object displays any errors or warnings that occur during the request.",
                          "properties": {
                            "warnings": {
                              "type": "array",
                              "items": {
                                "type": "object"
                              }
                            }
                          },
                          "x-gitbook-description-html": "<p>The details object displays any errors or warnings that occur during the request.</p>"
                        }
                      }
                    }
                  ]
                }
              }
            },
            "x-gitbook-description-html": "<p>Successful</p>"
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "x-gitbook-description-html": "<p>Bad Request</p>"
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "x-gitbook-description-html": "<p>Unauthorized</p>"
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "x-gitbook-description-html": "<p>Forbidden</p>"
          },
          "500": {
            "description": "Internal Server Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "x-gitbook-description-html": "<p>Internal Server Error</p>"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "details": {
        "type": "object"
      },
      "Theme": {
        "required": [
          "name"
        ],
        "type": "object",
        "properties": {
          "name": {
            "maxLength": 255,
            "type": "string"
          },
          "logo": {
            "type": "string",
            "description": "Uploaded image Id",
            "x-format": {
              "guid": true
            },
            "x-gitbook-description-html": "<p>Uploaded image Id</p>"
          },
          "entity_id": {
            "type": "string",
            "description": "Entity Id can be located on the organization level as Organization ID (Administration > Organizations > [Organization] > Organisation ID value)",
            "x-format": {
              "guid": true
            },
            "x-gitbook-description-html": "<p>Entity Id can be located on the organization level as Organization ID (Administration > Organizations > [Organization] > Organisation ID value)</p>"
          },
          "base_font_family": {
            "type": "string",
            "description": "base fonts available for theme",
            "enum": [
              "Roboto",
              "Open Sans",
              "Lato",
              "Slabo",
              "Oswald",
              "Source Sans Pro",
              "Montserrat",
              "Raleway",
              "PT Sans",
              "Lora",
              "Noto Sans",
              "Noto Serif",
              "Nunito Sans",
              "Concert One",
              "Prompt",
              "Work Sans"
            ],
            "x-gitbook-description-html": "<p>base fonts available for theme</p>"
          },
          "text_color": {
            "type": "string",
            "description": "6 digit hex code, e.g. <code>ffe0e0</code>",
            "x-constraint": {
              "length": 6
            },
            "x-format": {
              "hex": {
                "byteAligned": false
              }
            },
            "x-gitbook-description-html": "<p>6 digit hex code, e.g. <code>ffe0e0</code></p>"
          },
          "heading_color": {
            "type": "string",
            "description": "6 digit hex code, e.g. <code>ffe0e0</code>",
            "x-constraint": {
              "length": 6
            },
            "x-format": {
              "hex": {
                "byteAligned": false
              }
            },
            "x-gitbook-description-html": "<p>6 digit hex code, e.g. <code>ffe0e0</code></p>"
          },
          "background_color": {
            "type": "string",
            "description": "6 digit hex code, e.g. <code>ffe0e0</code>",
            "x-constraint": {
              "length": 6
            },
            "x-format": {
              "hex": {
                "byteAligned": false
              }
            },
            "x-gitbook-description-html": "<p>6 digit hex code, e.g. <code>ffe0e0</code></p>"
          },
          "panel_background_color": {
            "type": "string",
            "description": "6 digit hex code, e.g. <code>ffe0e0</code>",
            "x-constraint": {
              "length": 6
            },
            "x-format": {
              "hex": {
                "byteAligned": false
              }
            },
            "x-gitbook-description-html": "<p>6 digit hex code, e.g. <code>ffe0e0</code></p>"
          },
          "primary_color": {
            "type": "string",
            "description": "6 digit hex code, e.g. <code>ffe0e0</code>",
            "x-constraint": {
              "length": 6
            },
            "x-format": {
              "hex": {
                "byteAligned": false
              }
            },
            "x-gitbook-description-html": "<p>6 digit hex code, e.g. <code>ffe0e0</code></p>"
          },
          "primary_color_inverse": {
            "type": "string",
            "description": "6 digit hex code, e.g. <code>ffe0e0</code>",
            "x-constraint": {
              "length": 6
            },
            "x-format": {
              "hex": {
                "byteAligned": false
              }
            },
            "x-gitbook-description-html": "<p>6 digit hex code, e.g. <code>ffe0e0</code></p>"
          },
          "primary_color_disabled": {
            "type": "string",
            "description": "6 digit hex code, e.g. <code>ffe0e0</code>",
            "x-constraint": {
              "length": 6
            },
            "x-format": {
              "hex": {
                "byteAligned": false
              }
            },
            "x-gitbook-description-html": "<p>6 digit hex code, e.g. <code>ffe0e0</code></p>"
          },
          "primary_color_inverse_disabled": {
            "type": "string",
            "description": "6 digit hex code, e.g. <code>ffe0e0</code>",
            "x-constraint": {
              "length": 6
            },
            "x-format": {
              "hex": {
                "byteAligned": false
              }
            },
            "x-gitbook-description-html": "<p>6 digit hex code, e.g. <code>ffe0e0</code></p>"
          },
          "error_color": {
            "type": "string",
            "description": "6 digit hex code, e.g. <code>ffe0e0</code>",
            "x-constraint": {
              "length": 6
            },
            "x-format": {
              "hex": {
                "byteAligned": false
              }
            },
            "x-gitbook-description-html": "<p>6 digit hex code, e.g. <code>ffe0e0</code></p>"
          },
          "error_color_inverse": {
            "type": "string",
            "description": "6 digit hex code, e.g. <code>ffe0e0</code>",
            "x-constraint": {
              "length": 6
            },
            "x-format": {
              "hex": {
                "byteAligned": false
              }
            },
            "x-gitbook-description-html": "<p>6 digit hex code, e.g. <code>ffe0e0</code></p>"
          },
          "input_border_radius": {
            "type": "number"
          },
          "input_border_width": {
            "type": "number"
          },
          "hide_verifone_seal": {
            "type": "boolean",
            "description": "Show/Hide verifone seal on the checkout page",
            "x-gitbook-description-html": "<p>Show/Hide verifone seal on the checkout page</p>"
          },
          "config": {
            "$ref": "#/components/schemas/config"
          },
          "id": {
            "type": "string",
            "x-format": {
              "guid": true
            }
          },
          "created_at": {
            "type": "string",
            "format": "date"
          },
          "updated_at": {
            "type": "string",
            "format": "date"
          }
        },
        "description": "Theme parameters",
        "x-gitbook-description-html": "<p>Theme parameters</p>"
      },
      "ErrorResponse": {
        "type": "object",
        "properties": {
          "code": {
            "type": "number",
            "description": "A 3-digit code which uniquely identify an error.",
            "x-gitbook-description-html": "<p>A 3-digit code which uniquely identify an error.</p>"
          },
          "details": {
            "$ref": "#/components/schemas/details"
          },
          "message": {
            "maxLength": 2048,
            "type": "string",
            "description": "A description of the error.",
            "x-gitbook-description-html": "<p>A description of the error.</p>"
          },
          "timestamp": {
            "type": "string",
            "description": "Error timestamp",
            "format": "date-time",
            "x-gitbook-description-html": "<p>Error timestamp</p>"
          }
        },
        "example": {
          "code": 400,
          "message": "Invalid request parameters",
          "timestamp": "2024-01-15T10:30:00Z"
        }
      },
      "CreateThemeRequest": {
        "required": [
          "name"
        ],
        "type": "object",
        "properties": {
          "name": {
            "maxLength": 255,
            "type": "string"
          },
          "logo": {
            "type": "string",
            "description": "Uploaded image Id",
            "x-format": {
              "guid": true
            },
            "x-gitbook-description-html": "<p>Uploaded image Id</p>"
          },
          "entity_id": {
            "type": "string",
            "description": "Entity Id can be located on the organization level as Organization ID (Administration > Organizations > [Organization] > Organisation ID value)",
            "x-format": {
              "guid": true
            },
            "x-gitbook-description-html": "<p>Entity Id can be located on the organization level as Organization ID (Administration > Organizations > [Organization] > Organisation ID value)</p>"
          },
          "base_font_family": {
            "type": "string",
            "description": "base fonts available for theme",
            "enum": [
              "Roboto",
              "Open Sans",
              "Lato",
              "Slabo",
              "Oswald",
              "Source Sans Pro",
              "Montserrat",
              "Raleway",
              "PT Sans",
              "Lora",
              "Noto Sans",
              "Noto Serif",
              "Nunito Sans",
              "Concert One",
              "Prompt",
              "Work Sans"
            ],
            "x-gitbook-description-html": "<p>base fonts available for theme</p>"
          },
          "text_color": {
            "type": "string",
            "description": "6 digit hex code, e.g. <code>ffe0e0</code>",
            "x-constraint": {
              "length": 6
            },
            "x-format": {
              "hex": {
                "byteAligned": false
              }
            },
            "x-gitbook-description-html": "<p>6 digit hex code, e.g. <code>ffe0e0</code></p>"
          },
          "heading_color": {
            "type": "string",
            "description": "6 digit hex code, e.g. <code>ffe0e0</code>",
            "x-constraint": {
              "length": 6
            },
            "x-format": {
              "hex": {
                "byteAligned": false
              }
            },
            "x-gitbook-description-html": "<p>6 digit hex code, e.g. <code>ffe0e0</code></p>"
          },
          "background_color": {
            "type": "string",
            "description": "6 digit hex code, e.g. <code>ffe0e0</code>",
            "x-constraint": {
              "length": 6
            },
            "x-format": {
              "hex": {
                "byteAligned": false
              }
            },
            "x-gitbook-description-html": "<p>6 digit hex code, e.g. <code>ffe0e0</code></p>"
          },
          "panel_background_color": {
            "type": "string",
            "description": "6 digit hex code, e.g. <code>ffe0e0</code>",
            "x-constraint": {
              "length": 6
            },
            "x-format": {
              "hex": {
                "byteAligned": false
              }
            },
            "x-gitbook-description-html": "<p>6 digit hex code, e.g. <code>ffe0e0</code></p>"
          },
          "primary_color": {
            "type": "string",
            "description": "6 digit hex code, e.g. <code>ffe0e0</code>",
            "x-constraint": {
              "length": 6
            },
            "x-format": {
              "hex": {
                "byteAligned": false
              }
            },
            "x-gitbook-description-html": "<p>6 digit hex code, e.g. <code>ffe0e0</code></p>"
          },
          "primary_color_inverse": {
            "type": "string",
            "description": "6 digit hex code, e.g. <code>ffe0e0</code>",
            "x-constraint": {
              "length": 6
            },
            "x-format": {
              "hex": {
                "byteAligned": false
              }
            },
            "x-gitbook-description-html": "<p>6 digit hex code, e.g. <code>ffe0e0</code></p>"
          },
          "primary_color_disabled": {
            "type": "string",
            "description": "6 digit hex code, e.g. <code>ffe0e0</code>",
            "x-constraint": {
              "length": 6
            },
            "x-format": {
              "hex": {
                "byteAligned": false
              }
            },
            "x-gitbook-description-html": "<p>6 digit hex code, e.g. <code>ffe0e0</code></p>"
          },
          "primary_color_inverse_disabled": {
            "type": "string",
            "description": "6 digit hex code, e.g. <code>ffe0e0</code>",
            "x-constraint": {
              "length": 6
            },
            "x-format": {
              "hex": {
                "byteAligned": false
              }
            },
            "x-gitbook-description-html": "<p>6 digit hex code, e.g. <code>ffe0e0</code></p>"
          },
          "error_color": {
            "type": "string",
            "description": "6 digit hex code, e.g. <code>ffe0e0</code>",
            "x-constraint": {
              "length": 6
            },
            "x-format": {
              "hex": {
                "byteAligned": false
              }
            },
            "x-gitbook-description-html": "<p>6 digit hex code, e.g. <code>ffe0e0</code></p>"
          },
          "error_color_inverse": {
            "type": "string",
            "description": "6 digit hex code, e.g. <code>ffe0e0</code>",
            "x-constraint": {
              "length": 6
            },
            "x-format": {
              "hex": {
                "byteAligned": false
              }
            },
            "x-gitbook-description-html": "<p>6 digit hex code, e.g. <code>ffe0e0</code></p>"
          },
          "input_border_radius": {
            "type": "number"
          },
          "input_border_width": {
            "type": "number"
          },
          "hide_verifone_seal": {
            "type": "boolean",
            "default": false,
            "description": "Show/Hide verifone seal on the checkout page",
            "x-gitbook-description-html": "<p>Show/Hide verifone seal on the checkout page</p>"
          },
          "config": {
            "$ref": "#/components/schemas/config"
          }
        },
        "description": "Theme parameters",
        "x-gitbook-description-html": "<p>Theme parameters</p>"
      },
      "config": {
        "type": "object",
        "properties": {
          "is_default": {
            "type": "boolean",
            "default": false,
            "description": "Specifies whether the theme is the default theme for the entity. Only one default theme allowed per Entity/Organization.",
            "x-gitbook-description-html": "<p>Specifies whether the theme is the default theme for the entity. Only one default theme allowed per Entity/Organization.</p>"
          }
        }
      }
    },
    "securitySchemes": {
      "BasicAuth": {
        "type": "http",
        "scheme": "basic",
        "description": "HTTP Basic authentication using entity credentials (username:password encoded in Base64).",
        "x-gitbook-description-html": "<p>HTTP Basic authentication using entity credentials (username:password encoded in Base64).</p>"
      },
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT",
        "description": "OAuth 2.0 Bearer token obtained via the OIDC authentication endpoint.",
        "x-gitbook-description-html": "<p>OAuth 2.0 Bearer token obtained via the OIDC authentication endpoint.</p>"
      }
    }
  },
  "x-tagGroups": [
    {
      "name": "Payments",
      "tags": [
        "Checkout"
      ]
    },
    {
      "name": "Customisation",
      "tags": [
        "Theming",
        "Templating"
      ]
    },
    {
      "name": "Reference",
      "tags": [
        "Error codes"
      ]
    }
  ],
  "x-alt-definitions": {
    "paymentContractIdDef": {
      "type": "object",
      "properties": {
        "AMEX": {
          "type": "string",
          "description": "Payment Contract to be used for AMEX card payments",
          "x-format": {
            "guid": true
          },
          "x-gitbook-description-html": "<p>Payment Contract to be used for AMEX card payments</p>"
        },
        "JCB": {
          "type": "string",
          "description": "Payment Contract to be used for JCB card payments",
          "x-format": {
            "guid": true
          },
          "x-gitbook-description-html": "<p>Payment Contract to be used for JCB card payments</p>"
        },
        "MASTERCARD": {
          "type": "string",
          "description": "Payment Contract to be used for MASTERCARD card payments",
          "x-format": {
            "guid": true
          },
          "x-gitbook-description-html": "<p>Payment Contract to be used for MASTERCARD card payments</p>"
        },
        "VISA": {
          "type": "string",
          "description": "Payment Contract to be used for VISA card payments",
          "x-format": {
            "guid": true
          },
          "x-gitbook-description-html": "<p>Payment Contract to be used for VISA card payments</p>"
        }
      }
    },
    "threedSecureDef": {
      "type": "object",
      "description": "Used for <a target=\"_blank\" href=\"https://docs.verifone.com/online-payments/checkout/accepting-payments/3d-secure-payments\">3D-Secure payments</a>",
      "properties": {
        "accountAgeIndicator": {
          "type": "string",
          "description": "Length of time cardholder has had account. <br /> Possible Values: <br />  * 01 - No account <br />  * 02 - Created during transaction <br />  * 03 - Less than 30 days <br />  * 04 - 30-60 days <br />  * 05 - More than 60 days <br />",
          "enum": [
            "01",
            "02",
            "03",
            "04",
            "05"
          ],
          "x-gitbook-description-html": "<p>Length of time cardholder has had account. <br> Possible Values: <br>  * 01 - No account <br>  * 02 - Created during transaction <br>  * 03 - Less than 30 days <br>  * 04 - 30-60 days <br>  * 05 - More than 60 days <br></p>"
        },
        "accountCreateDate": {
          "type": "string",
          "format": "date",
          "description": "Date the cardholder opened the account. `Format: YYYYMMDD`",
          "x-gitbook-description-html": "<p>Date the cardholder opened the account. <code>Format: YYYYMMDD</code></p>"
        },
        "accountChangeIndicator": {
          "type": "string",
          "description": "Length of time since the last change to the cardholder account. This includes shipping address, <br /> new payment account or new user added. Possible Values: <br /> * 01 - Changed during transaction <br /> * 02 - Less than 30 days <br /> * 03 - 30-60 days <br /> * 04 - More than 60 days <br />",
          "enum": [
            "01",
            "02",
            "03",
            "04"
          ],
          "x-gitbook-description-html": "<p>Length of time since the last change to the cardholder account. This includes shipping address, <br> new payment account or new user added. Possible Values: <br> * 01 - Changed during transaction <br> * 02 - Less than 30 days <br> * 03 - 30-60 days <br> * 04 - More than 60 days <br></p>"
        },
        "accountChangeDate": {
          "type": "string",
          "format": "date",
          "description": "Date the cardholder's account was last changed. This includes changes to the billing or shipping address, new payment accounts or new users added.` Format: YYYYMMDD` <br />",
          "x-gitbook-description-html": "<p>Date the cardholder's account was last changed. This includes changes to the billing or shipping address, new payment accounts or new users added.<code> Format: YYYYMMDD</code> <br></p>"
        },
        "accountPwdChangeIndicator": {
          "type": "string",
          "description": "Length of time since the cardholder changed or reset the password on the account. <br />  Possible Values: <br />  * 01 - No change <br />  * 02 - Changed during transaction <br />  * 03 - Less than 30 days <br />  * 04 - 30-60 days <br />  * 05 - More than 60 days <br />",
          "enum": [
            "01",
            "02",
            "03",
            "04",
            "05"
          ],
          "x-gitbook-description-html": "<p>Length of time since the cardholder changed or reset the password on the account. <br>  Possible Values: <br>  * 01 - No change <br>  * 02 - Changed during transaction <br>  * 03 - Less than 30 days <br>  * 04 - 30-60 days <br>  * 05 - More than 60 days <br></p>"
        },
        "accountPwdChangeDate": {
          "type": "string",
          "format": "date",
          "description": "Date the cardholder last changed or reset password on account. `Format: YYYYMMDD`",
          "x-gitbook-description-html": "<p>Date the cardholder last changed or reset password on account. <code>Format: YYYYMMDD</code></p>"
        },
        "accountId": {
          "type": "string",
          "description": "Additional cardholder account information.",
          "maxLength": 64,
          "x-gitbook-description-html": "<p>Additional cardholder account information.</p>"
        },
        "accountPurchases": {
          "type": "integer",
          "description": "Number of purchases with this cardholder account during the previous six months.",
          "maximum": 9999,
          "x-gitbook-description-html": "<p>Number of purchases with this cardholder account during the previous six months.</p>"
        },
        "acsWindowSize": {
          "type": "string",
          "description": "An override field that a merchant can pass in to set the challenge window size to display to the end <br /> cardholder.The ACS will reply with content that is formatted appropriately to this window size to allow <br /> for the best user experience. The sizes are width x height in pixels of the window displayed in <br /> the cardholder browser window. Possible values: <br />  * 01 - 250x400 <br />  * 02 - 390x400 <br />  * 03 - 500x600 <br />  * 04 - 600x400 <br />  * 05 - Full page <br />",
          "enum": [
            "01",
            "02",
            "03",
            "04",
            "05"
          ],
          "x-gitbook-description-html": "<p>An override field that a merchant can pass in to set the challenge window size to display to the end <br> cardholder.The ACS will reply with content that is formatted appropriately to this window size to allow <br> for the best user experience. The sizes are width x height in pixels of the window displayed in <br> the cardholder browser window. Possible values: <br>  * 01 - 250x400 <br>  * 02 - 390x400 <br>  * 03 - 500x600 <br>  * 04 - 600x400 <br>  * 05 - Full page <br></p>"
        },
        "addCardAttempts": {
          "type": "integer",
          "description": "Number of add card attempts in the last 24 hours.",
          "maximum": 999,
          "x-gitbook-description-html": "<p>Number of add card attempts in the last 24 hours.</p>"
        },
        "addressMatch": {
          "type": "string",
          "description": "Indicates whether cardholder billing and shipping addresses match. <br /> Possible Values: <br />  * Y - Shipping address matches billing address <br />  * N - Shipping address does not match billing address <br />",
          "enum": [
            "Y",
            "N"
          ],
          "x-gitbook-description-html": "<p>Indicates whether cardholder billing and shipping addresses match. <br> Possible Values: <br>  * Y - Shipping address matches billing address <br>  * N - Shipping address does not match billing address <br></p>"
        },
        "alternateAuthenticationMethod": {
          "type": "string",
          "description": "Mechanism used by the cardholder to authenticate to the 3DS requester. <br />  Possible Values: <br />  * 01 - No authentication occurred (e.g. Guest Checkout) <br />  * 02 - Login to the cardholder account at the Merchant system using Merchant system credentials <br />  * 03 - Login to the cardholder account at the Merchant system using a Federated ID <br />  * 04 - Login to the cardholder account at the Merchant system using Issuer credentials <br />  * 05 - Login to the cardholder account at the Merchant system using third-party authentication <br />  * 06 - Login to the cardholder account at the Merchant system using FIDO Authenticator <br />",
          "enum": [
            "01",
            "02",
            "03",
            "04",
            "05",
            "06"
          ],
          "x-gitbook-description-html": "<p>Mechanism used by the cardholder to authenticate to the 3DS requester. <br>  Possible Values: <br>  * 01 - No authentication occurred (e.g. Guest Checkout) <br>  * 02 - Login to the cardholder account at the Merchant system using Merchant system credentials <br>  * 03 - Login to the cardholder account at the Merchant system using a Federated ID <br>  * 04 - Login to the cardholder account at the Merchant system using Issuer credentials <br>  * 05 - Login to the cardholder account at the Merchant system using third-party authentication <br>  * 06 - Login to the cardholder account at the Merchant system using FIDO Authenticator <br></p>"
        },
        "alternateAuthenticationDate": {
          "type": "string",
          "format": "date",
          "description": "Date and time in UTC of the cardholder authentication. ` Format: YYYYMMDDHHMM`",
          "x-gitbook-description-html": "<p>Date and time in UTC of the cardholder authentication. <code> Format: YYYYMMDDHHMM</code></p>"
        },
        "alternateAuthenticationData": {
          "type": "string",
          "description": "Data that documents and supports a specific authentication <br /> process that was sent in the AlternateAuthenticationMethod field. <br />",
          "maxLength": 2048,
          "x-gitbook-description-html": "<p>Data that documents and supports a specific authentication <br> process that was sent in the AlternateAuthenticationMethod field. <br></p>"
        },
        "threeDSContractId": {
          "type": "string",
          "description": "The ID of the threeDSContract used.",
          "maxLength": 36,
          "x-format": {
            "guid": true
          },
          "x-gitbook-description-html": "<p>The ID of the threeDSContract used.</p>"
        },
        "authenticationIndicator": {
          "type": "string",
          "description": "Indicates the type of Authentication request. 01 - Payment transaction <br />  02 - Recurring transaction  <br />  03 - Installment transaction  <br />  04 - Add card  <br />  05 - Maintain card  <br />  06 - Cardholder verification as part of EMV token ID&V <br />",
          "enum": [
            "01",
            "02",
            "03",
            "04",
            "05",
            "06"
          ],
          "x-gitbook-description-html": "<p>Indicates the type of Authentication request. 01 - Payment transaction <br>  02 - Recurring transaction  <br>  03 - Installment transaction  <br>  04 - Add card  <br>  05 - Maintain card  <br>  06 - Cardholder verification as part of EMV token ID&#x26;V <br></p>"
        },
        "categoryCode": {
          "type": "integer",
          "description": "Merchant category code (MCC) NOTE: This field is required by Mastercard and VISA Brazil extensions. <br />",
          "maximum": 9999,
          "x-gitbook-description-html": "<p>Merchant category code (MCC) NOTE: This field is required by Mastercard and VISA Brazil extensions. <br></p>"
        },
        "challengeIndicator": {
          "type": "string",
          "description": "NOTE: This is a 2.0 required field, Cardinal will default to 01 on Merchant Configuration <br /> - can be overridden by the merchant. Possible Values: <br /> * 01 - No preference <br /> * 02 - No challenge requested <br /> * 03 - Challenge requested (3DS Requestor Preference)  <br /> * 04 - Challenge requested (Mandate) <br /> * 05 - No challenge requested (transactional risk analysis is already performed) <br /> * 06 - No challenge requested (Data share only) <br /> * 07 - No challenge requested (strong consumer authentication is already performed) <br /> * 08 - No challenge requested (utilise whitelist exemption if no challenge required) <br /> * 09 - Challenge requested (whitelist prompt requested if challenge required) <br /> * 90 - CB specific value <br />",
          "default": "01",
          "enum": [
            "01",
            "02",
            "03",
            "04",
            "05",
            "06",
            "07",
            "08",
            "09",
            "90"
          ],
          "x-gitbook-description-html": "<p>NOTE: This is a 2.0 required field, Cardinal will default to 01 on Merchant Configuration <br> - can be overridden by the merchant. Possible Values: <br> * 01 - No preference <br> * 02 - No challenge requested <br> * 03 - Challenge requested (3DS Requestor Preference)  <br> * 04 - Challenge requested (Mandate) <br> * 05 - No challenge requested (transactional risk analysis is already performed) <br> * 06 - No challenge requested (Data share only) <br> * 07 - No challenge requested (strong consumer authentication is already performed) <br> * 08 - No challenge requested (utilise whitelist exemption if no challenge required) <br> * 09 - Challenge requested (whitelist prompt requested if challenge required) <br> * 90 - CB specific value <br></p>"
        },
        "deliveryEmail": {
          "type": "string",
          "description": "For electronic delivery, email address to which the merchandise was delivered.",
          "maxLength": 255,
          "x-format": {
            "email": {
              "minDomainSegments": 2
            }
          },
          "x-gitbook-description-html": "<p>For electronic delivery, email address to which the merchandise was delivered.</p>"
        },
        "deliveryTimeFrame": {
          "type": "string",
          "description": "Indicates the delivery timeframe.  <br /> Possible Values: <br />  * 01 - Electronic delivery <br />  * 02 - Same day shipping <br />  * 03 - Overnight shipping <br />  * 04 - Two or more day shipping <br />",
          "enum": [
            "01",
            "02",
            "03",
            "04"
          ],
          "x-gitbook-description-html": "<p>Indicates the delivery timeframe.  <br> Possible Values: <br>  * 01 - Electronic delivery <br>  * 02 - Same day shipping <br>  * 03 - Overnight shipping <br>  * 04 - Two or more day shipping <br></p>"
        },
        "enabled": {
          "type": "boolean",
          "description": "Whether 3DS should be used.",
          "default": true,
          "enum": [
            true
          ],
          "x-gitbook-description-html": "<p>Whether 3DS should be used.</p>"
        },
        "fraudActivity": {
          "type": "string",
          "description": "Indicates whether the merchant experienced suspicious activity (including previous fraud) on the account. <br /> Possible Values: <br />  * 01 - No suspicious activity <br />  * 02 - Suspicious activity observed <br />",
          "enum": [
            "01",
            "02"
          ],
          "x-gitbook-description-html": "<p>Indicates whether the merchant experienced suspicious activity (including previous fraud) on the account. <br> Possible Values: <br>  * 01 - No suspicious activity <br>  * 02 - Suspicious activity observed <br></p>"
        },
        "giftCardAmount": {
          "type": "integer",
          "description": "The purchase amount total for prepaid gift cards in major units. <br /> Example: $123.45 USD = 12345 <br />",
          "maximum": 999999999999999,
          "x-gitbook-description-html": "<p>The purchase amount total for prepaid gift cards in major units. <br> Example: $123.45 USD = 12345 <br></p>"
        },
        "giftCardCurrencyCode": {
          "type": "string",
          "description": "ISO 4217 currency code for the gift card purchased.",
          "minLength": 3,
          "maxLength": 3,
          "x-gitbook-description-html": "<p>ISO 4217 currency code for the gift card purchased.</p>"
        },
        "giftCardCount": {
          "type": "integer",
          "description": "Total count of individual prepaid gift cards purchased.",
          "maximum": 99,
          "x-gitbook-description-html": "<p>Total count of individual prepaid gift cards purchased.</p>"
        },
        "installment": {
          "type": "number",
          "description": "Indicates the maximum number of authorizations for installment payments. An integer value greater than 1 indicating the maximum number of permitted authorizations for installment payments. ** Required for Recurring and Installment transactions, when authenticationIndicator=\"02\" & \"03\" **",
          "minimum": 2,
          "maximum": 999,
          "x-gitbook-description-html": "<p>Indicates the maximum number of authorizations for installment payments. An integer value greater than 1 indicating the maximum number of permitted authorizations for installment payments. ** Required for Recurring and Installment transactions, when authenticationIndicator=\"02\" &#x26; \"03\" **</p>"
        },
        "messageCategory": {
          "type": "string",
          "description": "Category of the message for a specific use case. <br />  Possible Values: <br />  * 01 - PA (payment) <br />  * 02 - NPA (non payment) <br />  NOTE: Default is payment (01). Configured on Merchant account, or can be overridden on transaction. <br />",
          "enum": [
            "01",
            "02"
          ],
          "x-gitbook-description-html": "<p>Category of the message for a specific use case. <br>  Possible Values: <br>  * 01 - PA (payment) <br>  * 02 - NPA (non payment) <br>  NOTE: Default is payment (01). Configured on Merchant account, or can be overridden on transaction. <br></p>"
        },
        "paymentUseCase": {
          "type": "string",
          "description": "Indicates the type of payment.The value from this field will be mapped to the data field on the CB-USECASE extension <br />  Possible Values: <br />  * 01 - Single Payment <br />  * 02 - Fixed Amount and Term Subscription <br />  * 03 - Payment By Instalments <br />  * 04 - Payment By Shipment <br />  * 05 - Other Recurring Payments <br />  NOTE: Required for CB transactions (Required if message_category = 01, or message_category = 02 and authentication_indicator = 02 or 03 <br />",
          "default": "01",
          "enum": [
            "01",
            "02",
            "03",
            "04",
            "05"
          ],
          "x-gitbook-description-html": "<p>Indicates the type of payment.The value from this field will be mapped to the data field on the CB-USECASE extension <br>  Possible Values: <br>  * 01 - Single Payment <br>  * 02 - Fixed Amount and Term Subscription <br>  * 03 - Payment By Instalments <br>  * 04 - Payment By Shipment <br>  * 05 - Other Recurring Payments <br>  NOTE: Required for CB transactions (Required if message_category = 01, or message_category = 02 and authentication_indicator = 02 or 03 <br></p>"
        },
        "paymentAccountIndicator": {
          "type": "string",
          "description": "Indicates the length of time that the payment account was enrolled in the merchant account. <br /> Possible Values: <br />  * 01 - No account (guest checkout) <br />  * 02 - During the transaction <br />  * 03 - Less than 30 days <br />  * 04 - 30-60 days <br />  * 05 - More than 60 days <br />",
          "enum": [
            "01",
            "02",
            "03",
            "04",
            "05"
          ],
          "x-gitbook-description-html": "<p>Indicates the length of time that the payment account was enrolled in the merchant account. <br> Possible Values: <br>  * 01 - No account (guest checkout) <br>  * 02 - During the transaction <br>  * 03 - Less than 30 days <br>  * 04 - 30-60 days <br>  * 05 - More than 60 days <br></p>"
        },
        "paymentAccountAge": {
          "type": "string",
          "format": "date",
          "description": "Date the payment account was added to the cardholder account. ` Format: YYYYMMDD`",
          "x-gitbook-description-html": "<p>Date the payment account was added to the cardholder account. <code> Format: YYYYMMDD</code></p>"
        },
        "preOrderIndicator": {
          "type": "string",
          "description": "Indicates whether cardholder is placing an order with a future availability or release date. <br />  Possible Values: <br />  * 01 - Merchandise available <br />  * 02 - Future availability <br />",
          "enum": [
            "01",
            "02"
          ],
          "x-gitbook-description-html": "<p>Indicates whether cardholder is placing an order with a future availability or release date. <br>  Possible Values: <br>  * 01 - Merchandise available <br>  * 02 - Future availability <br></p>"
        },
        "preOrderDate": {
          "type": "string",
          "format": "date",
          "description": "Expected date that a pre-ordered purchase will be available. `Format: YYYYMMDD`",
          "x-gitbook-description-html": "<p>Expected date that a pre-ordered purchase will be available. <code>Format: YYYYMMDD</code></p>"
        },
        "priorAuthenticationData": {
          "type": "string",
          "description": "This field carry data that the ACS can use to verify the authentication process",
          "maxLength": 2048,
          "x-gitbook-description-html": "<p>This field carry data that the ACS can use to verify the authentication process</p>"
        },
        "priorAuthenticationMethod": {
          "type": "string",
          "description": "Mechanism used by the Cardholder to previously authenticate to the 3DS Requestor. <br />  * 01 - Frictionless authentication occurred by ACS <br />  * 02 - Cardholder challenge occurred by ACS <br />  * 03 - AVS verified <br />  * 04 - Other issuer methods <br />",
          "enum": [
            "01",
            "02",
            "03",
            "04"
          ],
          "x-gitbook-description-html": "<p>Mechanism used by the Cardholder to previously authenticate to the 3DS Requestor. <br>  * 01 - Frictionless authentication occurred by ACS <br>  * 02 - Cardholder challenge occurred by ACS <br>  * 03 - AVS verified <br>  * 04 - Other issuer methods <br></p>"
        },
        "priorAuthenticationTime": {
          "type": "string",
          "format": "date",
          "description": "Date and time in UTC of the prior cardholder authentication. ` Format: YYYYMMDDHHMM`",
          "x-gitbook-description-html": "<p>Date and time in UTC of the prior cardholder authentication. <code> Format: YYYYMMDDHHMM</code></p>"
        },
        "priorAuthenticationRef": {
          "type": "string",
          "description": "This data element contains a ACS Transaction ID for a prior authenticated transaction. <br /> For example, the first recurring transaction that was authenticated with the cardholder <br />",
          "maxLength": 36,
          "x-gitbook-description-html": "<p>This data element contains a ACS Transaction ID for a prior authenticated transaction. <br> For example, the first recurring transaction that was authenticated with the cardholder <br></p>"
        },
        "productCode": {
          "type": "string",
          "description": "Merchant product code.  <br /> Possible Values:  <br />  * PHY - Goods/Service Purchase  <br />  * CHA - Check Acceptance  <br />  * ACF - Account Funding  <br />  * QCT - Quasi-Cash Transaction  <br />  * PAL - Prepaid Activation and Load  <br /> NOTE: This value defaults to PHY. This field can be used to override that value if applicable.  <br />",
          "enum": [
            "PHY",
            "CHA",
            "ACF",
            "QCT",
            "PAL"
          ],
          "x-gitbook-description-html": "<p>Merchant product code.  <br> Possible Values:  <br>  * PHY - Goods/Service Purchase  <br>  * CHA - Check Acceptance  <br>  * ACF - Account Funding  <br>  * QCT - Quasi-Cash Transaction  <br>  * PAL - Prepaid Activation and Load  <br> NOTE: This value defaults to PHY. This field can be used to override that value if applicable.  <br></p>"
        },
        "recurringEnd": {
          "type": "string",
          "format": "date",
          "description": "The date after which no further recurring authorizations should be performed. `Format: YYYYMMDD` ** Required for Recurring and Installment transactions, when authenticationIndicator=\"02\" & \"03\" **",
          "x-gitbook-description-html": "<p>The date after which no further recurring authorizations should be performed. <code>Format: YYYYMMDD</code> ** Required for Recurring and Installment transactions, when authenticationIndicator=\"02\" &#x26; \"03\" **</p>"
        },
        "recurringFrequency": {
          "type": "number",
          "description": "Conditional: Integer value indicating the minimum number of days between recurring authorizations. A frequency of monthly is indicated by the value 28. Multiple of 28 days will be used to indicate months. Example: 6 months = 168 ** Required for Recurring and Installment transactions, when authenticationIndicator=\"02\" & \"03\" **",
          "maximum": 9999,
          "x-gitbook-description-html": "<p>Conditional: Integer value indicating the minimum number of days between recurring authorizations. A frequency of monthly is indicated by the value 28. Multiple of 28 days will be used to indicate months. Example: 6 months = 168 ** Required for Recurring and Installment transactions, when authenticationIndicator=\"02\" &#x26; \"03\" **</p>"
        },
        "reorderIndicator": {
          "type": "string",
          "description": "Indicates whether cardholder is placing an order with a future availability or release date. <br />  Possible Values: <br />  * 01 - Merchandise available <br />  * 02 - Future availability <br />",
          "enum": [
            "01",
            "02"
          ],
          "x-gitbook-description-html": "<p>Indicates whether cardholder is placing an order with a future availability or release date. <br>  Possible Values: <br>  * 01 - Merchandise available <br>  * 02 - Future availability <br></p>"
        },
        "requestorId": {
          "type": "string",
          "description": "This value is a Directory Server assigned 3DS Requestor Name value, each DS may provide a unique ID. <br /> NOTE: This is a 2.0 value only and if passed will override the Requestor Name value that is, <br /> configured on the Merchant's profile.",
          "maxLength": 35,
          "x-gitbook-description-html": "<p>This value is a Directory Server assigned 3DS Requestor Name value, each DS may provide a unique ID. <br> NOTE: This is a 2.0 value only and if passed will override the Requestor Name value that is, <br> configured on the Merchant's profile.</p>"
        },
        "requestorName": {
          "type": "string",
          "description": "This value is a Directory Server assigned 3DS Requestor Name value, each DS may provide a unique ID. <br /> NOTE: This is a 2.0 value only and if passed will override the Requestor Name value that is configured <br /> on the Merchant's profile.",
          "maxLength": 40,
          "x-gitbook-description-html": "<p>This value is a Directory Server assigned 3DS Requestor Name value, each DS may provide a unique ID. <br> NOTE: This is a 2.0 value only and if passed will override the Requestor Name value that is configured <br> on the Merchant's profile.</p>"
        },
        "shippingAddressUsageIndicator": {
          "type": "string",
          "description": "Indicates when the shipping address used for transaction was first used. <br /> Possible Values: <br />  * 01 - This transaction <br />  * 02 - Less than 30 days <br />  * 03 - 30-60 days <br />  * 04 - More than 60 days <br />",
          "enum": [
            "01",
            "02",
            "03",
            "04"
          ],
          "x-gitbook-description-html": "<p>Indicates when the shipping address used for transaction was first used. <br> Possible Values: <br>  * 01 - This transaction <br>  * 02 - Less than 30 days <br>  * 03 - 30-60 days <br>  * 04 - More than 60 days <br></p>"
        },
        "shippingAddressUsageDate": {
          "type": "string",
          "format": "date",
          "description": "Date when the shipping address used for this transaction was first used. <br />  `Format: YYYYMMDD` <br />",
          "x-gitbook-description-html": "<p>Date when the shipping address used for this transaction was first used. <br>  <code>Format: YYYYMMDD</code> <br></p>"
        },
        "shippingMethodIndicator": {
          "type": "string",
          "description": "Indicates shipping method chosen for the transaction. <br />  Possible Values:  <br />  * 01 - Ship to cardholder billing address <br />  * 02 - Ship to another verified address on file with merchant <br />  * 03 - Ship to address that is different than billing address <br />  * 04 - Ship to store (store address should be populated on request) <br />  * 05 - Digital goods <br />  * 06 - Travel and event tickets, not shipped <br />  * 07 - Other <br />",
          "enum": [
            "01",
            "02",
            "03",
            "04",
            "05",
            "06",
            "07"
          ],
          "x-gitbook-description-html": "<p>Indicates shipping method chosen for the transaction. <br>  Possible Values:  <br>  * 01 - Ship to cardholder billing address <br>  * 02 - Ship to another verified address on file with merchant <br>  * 03 - Ship to address that is different than billing address <br>  * 04 - Ship to store (store address should be populated on request) <br>  * 05 - Digital goods <br>  * 06 - Travel and event tickets, not shipped <br>  * 07 - Other <br></p>"
        },
        "shippingNameIndicator": {
          "type": "string",
          "description": "Indicates if the cardholder name on the account is identical to the <br /> shipping name used for the transaction. Possible Values: <br /> * 01 - Account and shipping name identical <br /> * 02 - Account and shipping name differ <br />",
          "enum": [
            "01",
            "02"
          ],
          "x-gitbook-description-html": "<p>Indicates if the cardholder name on the account is identical to the <br> shipping name used for the transaction. Possible Values: <br> * 01 - Account and shipping name identical <br> * 02 - Account and shipping name differ <br></p>"
        },
        "totalItems": {
          "type": "string",
          "description": "Total items in the shopping cart of the shopper",
          "pattern": "^[0-9]{2}$",
          "x-gitbook-description-html": "<p>Total items in the shopping cart of the shopper</p>"
        },
        "merchantScore": {
          "type": "string",
          "description": "Merchant score",
          "maxLength": 20,
          "x-format": {
            "alphanum": true
          },
          "x-gitbook-description-html": "<p>Merchant score</p>"
        },
        "transactionCountDay": {
          "type": "integer",
          "description": "Number of transactions (successful or abandoned) for this cardholder account within the last 24 hours. <br />",
          "maximum": 999,
          "x-gitbook-description-html": "<p>Number of transactions (successful or abandoned) for this cardholder account within the last 24 hours. <br></p>"
        },
        "transactionCountYear": {
          "type": "integer",
          "description": "Number of transactions (successful or abandoned) for this cardholder account within the last year. <br />",
          "maximum": 999,
          "x-gitbook-description-html": "<p>Number of transactions (successful or abandoned) for this cardholder account within the last year. <br></p>"
        },
        "transactionMode": {
          "type": "string",
          "description": "Transaction mode identifier. Identifies the channel the transaction originates from. Available Options: <br /> M - Moto (Mail Order Telephone Order) <br /> P - Mobile Device <br /> R - Retail (Physical Store) <br /> S - Computer Device <br /> T - Tablet Device <br />",
          "enum": [
            "M",
            "P",
            "R",
            "S",
            "T"
          ],
          "x-gitbook-description-html": "<p>Transaction mode identifier. Identifies the channel the transaction originates from. Available Options: <br> M - Moto (Mail Order Telephone Order) <br> P - Mobile Device <br> R - Retail (Physical Store) <br> S - Computer Device <br> T - Tablet Device <br></p>"
        },
        "version": {
          "type": "string",
          "description": "This field contains the 3DS version that can be leveraged to force a transaction down the 1.0 rails.",
          "enum": [
            "1.0.2",
            "2.1.0",
            "2.2.0"
          ],
          "deprecated": true,
          "x-gitbook-description-html": "<p>This field contains the 3DS version that can be leveraged to force a transaction down the 1.0 rails.</p>"
        },
        "whiteListStatus": {
          "type": "string",
          "description": "Enables the communication of trusted beneficiary/whitelist status between the ACS, the DS and the 3DS Requestor.",
          "enum": [
            "Y",
            "N"
          ],
          "x-gitbook-description-html": "<p>Enables the communication of trusted beneficiary/whitelist status between the ACS, the DS and the 3DS Requestor.</p>"
        },
        "whiteListStatusSource": {
          "type": "string",
          "description": "This data element will be populated by the system setting Whitelist Status.",
          "enum": [
            1,
            2,
            3
          ],
          "x-gitbook-description-html": "<p>This data element will be populated by the system setting Whitelist Status.</p>"
        }
      },
      "required": [
        "threeDSContractId",
        "transactionMode"
      ],
      "x-gitbook-description-html": "<p>Used for <a href=\"https://docs.verifone.com/online-payments/checkout/accepting-payments/3d-secure-payments\">3D-Secure payments</a></p>"
    },
    "card": {
      "type": "object",
      "properties": {
        "scaComplianceLevel": {
          "type": "string",
          "description": "Strong Customer Authentication (SCA) compliance level, possible values </br>\n     * NONE: No SCA required. </br>\n     * WALLET: Depend on the wallet SCA mechanism. For Google Pay this means that MasterCard will shift liability, Visa will not. </br>\n     * FORCE_3DS: Do an additional 3DS step regardless of whether the wallet indicates the token is SCA-compliant.\nenum:\n- NONE\n- WALLET\n- FORCE_3DS",
          "x-gitbook-description-html": "<p>Strong Customer Authentication (SCA) compliance level, possible values <br>\n* NONE: No SCA required. <br>\n* WALLET: Depend on the wallet SCA mechanism. For Google Pay this means that MasterCard will shift liability, Visa will not. <br>\n* FORCE_3DS: Do an additional 3DS step regardless of whether the wallet indicates the token is SCA-compliant.\nenum:</p>\n<ul>\n<li>NONE</li>\n<li>WALLET</li>\n<li>FORCE_3DS</li>\n</ul>"
        },
        "threedSecure": {
          "$ref": "#/x-alt-definitions/threedSecureDef"
        },
        "authorizationType": {
          "type": "string",
          "description": "Card Authorization Type (PRE_AUTH, FINAL_AUTH).  When capture now is set to true pre-authorization transactions cannot be done.",
          "default": "FINAL_AUTH",
          "x-gitbook-description-html": "<p>Card Authorization Type (PRE_AUTH, FINAL_AUTH).  When capture now is set to true pre-authorization transactions cannot be done.</p>"
        },
        "encryptedCard": {
          "type": "string",
          "description": "Encrypted card details",
          "maxLength": 4096,
          "x-gitbook-description-html": "<p>Encrypted card details</p>"
        },
        "cardEncryptionKeyAlias": {
          "type": "string",
          "description": "Public key alias",
          "x-gitbook-description-html": "<p>Public key alias</p>"
        },
        "returnUrl": {
          "type": "string",
          "description": "URL belonging to the Merchant website, where the Customer would be redirected after the Checkout has been completed.",
          "x-format": {
            "uri": true
          },
          "x-gitbook-description-html": "<p>URL belonging to the Merchant website, where the Customer would be redirected after the Checkout has been completed.</p>"
        }
      },
      "required": [
        "scaComplianceLevel",
        "threedSecure"
      ]
    },
    "Model1": {
      "type": "object",
      "properties": {
        "scaComplianceLevel": {
          "type": "string",
          "description": "Strong Customer Authentication (SCA) compliance level, possible values </br>\n     * NONE: No SCA required. </br>\n     * WALLET: Depend on the wallet SCA mechanism. For Google Pay this means that MasterCard will shift liability, Visa will not. </br>\n     * FORCE_3DS: Do an additional 3DS step regardless of whether the wallet indicates the token is SCA-compliant.\nenum:\n- NONE\n- WALLET\n- FORCE_3DS",
          "x-gitbook-description-html": "<p>Strong Customer Authentication (SCA) compliance level, possible values <br>\n* NONE: No SCA required. <br>\n* WALLET: Depend on the wallet SCA mechanism. For Google Pay this means that MasterCard will shift liability, Visa will not. <br>\n* FORCE_3DS: Do an additional 3DS step regardless of whether the wallet indicates the token is SCA-compliant.\nenum:</p>\n<ul>\n<li>NONE</li>\n<li>WALLET</li>\n<li>FORCE_3DS</li>\n</ul>"
        },
        "authorizationType": {
          "type": "string",
          "description": "Card Authorization Type (PRE_AUTH, FINAL_AUTH).  When capture now is set to true pre-authorization transactions cannot be done.",
          "default": "FINAL_AUTH",
          "x-gitbook-description-html": "<p>Card Authorization Type (PRE_AUTH, FINAL_AUTH).  When capture now is set to true pre-authorization transactions cannot be done.</p>"
        },
        "encryptedCard": {
          "type": "string",
          "description": "Encrypted card details",
          "maxLength": 4096,
          "x-gitbook-description-html": "<p>Encrypted card details</p>"
        },
        "cardEncryptionKeyAlias": {
          "type": "string",
          "description": "Public key alias",
          "x-gitbook-description-html": "<p>Public key alias</p>"
        },
        "returnUrl": {
          "type": "string",
          "description": "URL belonging to the Merchant website, where the Customer would be redirected after the Checkout has been completed.",
          "x-format": {
            "uri": true
          },
          "x-gitbook-description-html": "<p>URL belonging to the Merchant website, where the Customer would be redirected after the Checkout has been completed.</p>"
        }
      },
      "required": [
        "scaComplianceLevel"
      ]
    },
    "CVV": {
      "type": "object",
      "properties": {
        "validation_rule": {
          "type": "string",
          "default": "NONE",
          "enum": [
            "NONE",
            "LUHN"
          ]
        },
        "usage": {
          "type": "string",
          "default": "REQUIRED",
          "enum": [
            "REQUIRED",
            "PROHIBITED"
          ]
        }
      }
    },
    "input_overrides": {
      "type": "object",
      "title": "Payment Details",
      "properties": {
        "CVV": {
          "$ref": "#/x-alt-definitions/CVV"
        },
        "CREDIT_TERM": {
          "$ref": "#/x-alt-definitions/CVV"
        },
        "IDENTITY_CARD_NUMBER": {
          "$ref": "#/x-alt-definitions/CVV"
        }
      }
    },
    "Model2": {
      "type": "object",
      "title": "Card Brands",
      "description": "Need to enable merchants to configure additional input fields on checkout for the input in scope.",
      "properties": {
        "AMEX": {
          "$ref": "#/x-alt-definitions/input_overrides"
        },
        "JCB": {
          "$ref": "#/x-alt-definitions/input_overrides"
        },
        "MASTERCARD": {
          "$ref": "#/x-alt-definitions/input_overrides"
        },
        "VISA": {
          "$ref": "#/x-alt-definitions/input_overrides"
        }
      },
      "x-gitbook-description-html": "<p>Need to enable merchants to configure additional input fields on checkout for the input in scope.</p>"
    },
    "threed_secure_duplicate": {
      "type": "object",
      "properties": {
        "account_age_indicator": {
          "type": "string",
          "description": "Length of time cardholder has had account. <br /> Possible Values: <br />  * 01 - No account <br />  * 02 - Created during transaction <br />  * 03 - Less than 30 days <br />  * 04 - 30-60 days <br />  * 05 - More than 60 days <br />",
          "enum": [
            "01",
            "02",
            "03",
            "04",
            "05"
          ],
          "x-gitbook-description-html": "<p>Length of time cardholder has had account. <br> Possible Values: <br>  * 01 - No account <br>  * 02 - Created during transaction <br>  * 03 - Less than 30 days <br>  * 04 - 30-60 days <br>  * 05 - More than 60 days <br></p>"
        },
        "account_create_date": {
          "type": "string",
          "format": "date",
          "description": "Date the cardholder opened the account. `Format: YYYYMMDD`",
          "x-gitbook-description-html": "<p>Date the cardholder opened the account. <code>Format: YYYYMMDD</code></p>"
        },
        "account_change_indicator": {
          "type": "string",
          "description": "Length of time since the last change to the cardholder account. This includes shipping address, <br /> new payment account or new user added. Possible Values: <br /> * 01 - Changed during transaction <br /> * 02 - Less than 30 days <br /> * 03 - 30-60 days <br /> * 04 - More than 60 days <br />",
          "enum": [
            "01",
            "02",
            "03",
            "04"
          ],
          "x-gitbook-description-html": "<p>Length of time since the last change to the cardholder account. This includes shipping address, <br> new payment account or new user added. Possible Values: <br> * 01 - Changed during transaction <br> * 02 - Less than 30 days <br> * 03 - 30-60 days <br> * 04 - More than 60 days <br></p>"
        },
        "account_change_date": {
          "type": "string",
          "format": "date",
          "description": "Date the cardholder's account was last changed. This includes changes to the billing or shipping address, new payment accounts or new users added.` Format: YYYYMMDD` <br />",
          "x-gitbook-description-html": "<p>Date the cardholder's account was last changed. This includes changes to the billing or shipping address, new payment accounts or new users added.<code> Format: YYYYMMDD</code> <br></p>"
        },
        "account_pwd_change_indicator": {
          "type": "string",
          "description": "Length of time since the cardholder changed or reset the password on the account. <br />  Possible Values: <br />  * 01 - No change <br />  * 02 - Changed during transaction <br />  * 03 - Less than 30 days <br />  * 04 - 30-60 days <br />  * 05 - More than 60 days <br />",
          "enum": [
            "01",
            "02",
            "03",
            "04",
            "05"
          ],
          "x-gitbook-description-html": "<p>Length of time since the cardholder changed or reset the password on the account. <br>  Possible Values: <br>  * 01 - No change <br>  * 02 - Changed during transaction <br>  * 03 - Less than 30 days <br>  * 04 - 30-60 days <br>  * 05 - More than 60 days <br></p>"
        },
        "account_pwd_change_date": {
          "type": "string",
          "format": "date",
          "description": "Date the cardholder last changed or reset password on account. `Format: YYYYMMDD`",
          "x-gitbook-description-html": "<p>Date the cardholder last changed or reset password on account. <code>Format: YYYYMMDD</code></p>"
        },
        "account_id": {
          "type": "string",
          "description": "Additional cardholder account information.",
          "maxLength": 64,
          "x-gitbook-description-html": "<p>Additional cardholder account information.</p>"
        },
        "account_purchases": {
          "type": "integer",
          "description": "Number of purchases with this cardholder account during the previous six months.",
          "maximum": 9999,
          "x-gitbook-description-html": "<p>Number of purchases with this cardholder account during the previous six months.</p>"
        },
        "acs_window_size": {
          "type": "string",
          "description": "An override field that a merchant can pass in to set the challenge window size to display to the end <br /> cardholder.The ACS will reply with content that is formatted appropriately to this window size to allow <br /> for the best user experience. The sizes are width x height in pixels of the window displayed in <br /> the cardholder browser window. Possible values: <br />  * 01 - 250x400 <br />  * 02 - 390x400 <br />  * 03 - 500x600 <br />  * 04 - 600x400 <br />  * 05 - Full page <br />",
          "enum": [
            "01",
            "02",
            "03",
            "04",
            "05"
          ],
          "x-gitbook-description-html": "<p>An override field that a merchant can pass in to set the challenge window size to display to the end <br> cardholder.The ACS will reply with content that is formatted appropriately to this window size to allow <br> for the best user experience. The sizes are width x height in pixels of the window displayed in <br> the cardholder browser window. Possible values: <br>  * 01 - 250x400 <br>  * 02 - 390x400 <br>  * 03 - 500x600 <br>  * 04 - 600x400 <br>  * 05 - Full page <br></p>"
        },
        "add_card_attempts": {
          "type": "integer",
          "description": "Number of add card attempts in the last 24 hours.",
          "maximum": 999,
          "x-gitbook-description-html": "<p>Number of add card attempts in the last 24 hours.</p>"
        },
        "address_match": {
          "type": "string",
          "description": "Indicates whether cardholder billing and shipping addresses match. <br /> Possible Values: <br />  * Y - Shipping address matches billing address <br />  * N - Shipping address does not match billing address <br />",
          "enum": [
            "Y",
            "N"
          ],
          "x-gitbook-description-html": "<p>Indicates whether cardholder billing and shipping addresses match. <br> Possible Values: <br>  * Y - Shipping address matches billing address <br>  * N - Shipping address does not match billing address <br></p>"
        },
        "alternate_authentication_method": {
          "type": "string",
          "description": "Mechanism used by the cardholder to authenticate to the 3DS requester. <br />  Possible Values: <br />  * 01 - No authentication occurred (e.g. Guest Checkout) <br />  * 02 - Login to the cardholder account at the Merchant system using Merchant system credentials <br />  * 03 - Login to the cardholder account at the Merchant system using a Federated ID <br />  * 04 - Login to the cardholder account at the Merchant system using Issuer credentials <br />  * 05 - Login to the cardholder account at the Merchant system using third-party authentication <br />  * 06 - Login to the cardholder account at the Merchant system using FIDO Authenticator <br />",
          "enum": [
            "01",
            "02",
            "03",
            "04",
            "05",
            "06"
          ],
          "x-gitbook-description-html": "<p>Mechanism used by the cardholder to authenticate to the 3DS requester. <br>  Possible Values: <br>  * 01 - No authentication occurred (e.g. Guest Checkout) <br>  * 02 - Login to the cardholder account at the Merchant system using Merchant system credentials <br>  * 03 - Login to the cardholder account at the Merchant system using a Federated ID <br>  * 04 - Login to the cardholder account at the Merchant system using Issuer credentials <br>  * 05 - Login to the cardholder account at the Merchant system using third-party authentication <br>  * 06 - Login to the cardholder account at the Merchant system using FIDO Authenticator <br></p>"
        },
        "alternate_authentication_date": {
          "type": "string",
          "format": "date",
          "description": "Date and time in UTC of the cardholder authentication. ` Format: YYYYMMDDHHMM`",
          "x-gitbook-description-html": "<p>Date and time in UTC of the cardholder authentication. <code> Format: YYYYMMDDHHMM</code></p>"
        },
        "alternate_authentication_data": {
          "type": "string",
          "description": "Data that documents and supports a specific authentication <br /> process that was sent in the AlternateAuthenticationMethod field. <br />",
          "maxLength": 2048,
          "x-gitbook-description-html": "<p>Data that documents and supports a specific authentication <br> process that was sent in the AlternateAuthenticationMethod field. <br></p>"
        },
        "threeds_contract_id": {
          "type": "string",
          "description": "The ID of the threeDSContract used.",
          "maxLength": 36,
          "x-format": {
            "guid": true
          },
          "x-gitbook-description-html": "<p>The ID of the threeDSContract used.</p>"
        },
        "authentication_indicator": {
          "type": "string",
          "description": "Indicates the type of Authentication request. 01 - Payment transaction <br />  02 - Recurring transaction  <br />  03 - Installment transaction  <br />  04 - Add card  <br />  05 - Maintain card  <br />  06 - Cardholder verification as part of EMV token ID&V <br />",
          "enum": [
            "01",
            "02",
            "03",
            "04",
            "05",
            "06"
          ],
          "x-gitbook-description-html": "<p>Indicates the type of Authentication request. 01 - Payment transaction <br>  02 - Recurring transaction  <br>  03 - Installment transaction  <br>  04 - Add card  <br>  05 - Maintain card  <br>  06 - Cardholder verification as part of EMV token ID&#x26;V <br></p>"
        },
        "category_code": {
          "type": "integer",
          "description": "Merchant category code (MCC) NOTE: This field is required by Mastercard and VISA Brazil extensions. <br />",
          "maximum": 9999,
          "x-gitbook-description-html": "<p>Merchant category code (MCC) NOTE: This field is required by Mastercard and VISA Brazil extensions. <br></p>"
        },
        "challenge_indicator": {
          "type": "string",
          "description": "NOTE: This is a 2.0 required field, Cardinal will default to 01 on Merchant Configuration <br /> - can be overridden by the merchant. Possible Values: <br /> * 01 - No preference <br /> * 02 - No challenge requested <br /> * 03 - Challenge requested (3DS Requestor Preference) <br /> * 04 - Challenge requested (Mandate) <br /> * 05 - No challenge requested (transactional risk analysis is already performed) <br /> * 06 - No challenge requested (Data share only) <br /> * 07 - No challenge requested (strong consumer authentication is already performed) <br /> * 08 - No challenge requested (utilise whitelist exemption if no challenge required) <br /> * 09 - Challenge requested (whitelist prompt requested if challenge required) <br /> * 90 - CB specific value <br />",
          "default": "01",
          "enum": [
            "01",
            "02",
            "03",
            "04",
            "05",
            "06",
            "07",
            "08",
            "09",
            "90"
          ],
          "x-gitbook-description-html": "<p>NOTE: This is a 2.0 required field, Cardinal will default to 01 on Merchant Configuration <br> - can be overridden by the merchant. Possible Values: <br> * 01 - No preference <br> * 02 - No challenge requested <br> * 03 - Challenge requested (3DS Requestor Preference) <br> * 04 - Challenge requested (Mandate) <br> * 05 - No challenge requested (transactional risk analysis is already performed) <br> * 06 - No challenge requested (Data share only) <br> * 07 - No challenge requested (strong consumer authentication is already performed) <br> * 08 - No challenge requested (utilise whitelist exemption if no challenge required) <br> * 09 - Challenge requested (whitelist prompt requested if challenge required) <br> * 90 - CB specific value <br></p>"
        },
        "delivery_email": {
          "type": "string",
          "description": "For electronic delivery, email address to which the merchandise was delivered.",
          "maxLength": 255,
          "x-format": {
            "email": {
              "minDomainSegments": 2
            }
          },
          "x-gitbook-description-html": "<p>For electronic delivery, email address to which the merchandise was delivered.</p>"
        },
        "delivery_time_frame": {
          "type": "string",
          "description": "Indicates the delivery timeframe.  <br /> Possible Values: <br />  * 01 - Electronic delivery <br />  * 02 - Same day shipping <br />  * 03 - Overnight shipping <br />  * 04 - Two or more day shipping <br />",
          "enum": [
            "01",
            "02",
            "03",
            "04"
          ],
          "x-gitbook-description-html": "<p>Indicates the delivery timeframe.  <br> Possible Values: <br>  * 01 - Electronic delivery <br>  * 02 - Same day shipping <br>  * 03 - Overnight shipping <br>  * 04 - Two or more day shipping <br></p>"
        },
        "enabled": {
          "type": "boolean",
          "description": "Whether 3DS should be used.",
          "default": true,
          "enum": [
            true
          ],
          "x-gitbook-description-html": "<p>Whether 3DS should be used.</p>"
        },
        "fraud_activity": {
          "type": "string",
          "description": "Indicates whether the merchant experienced suspicious activity (including previous fraud) on the account. <br /> Possible Values: <br />  * 01 - No suspicious activity <br />  * 02 - Suspicious activity observed <br />",
          "enum": [
            "01",
            "02"
          ],
          "x-gitbook-description-html": "<p>Indicates whether the merchant experienced suspicious activity (including previous fraud) on the account. <br> Possible Values: <br>  * 01 - No suspicious activity <br>  * 02 - Suspicious activity observed <br></p>"
        },
        "gift_card_amount": {
          "type": "integer",
          "description": "The purchase amount total for prepaid gift cards in major units. <br /> Example: $123.45 USD = 12345 <br />",
          "maximum": 999999999999999,
          "x-gitbook-description-html": "<p>The purchase amount total for prepaid gift cards in major units. <br> Example: $123.45 USD = 12345 <br></p>"
        },
        "gift_card_currency_code": {
          "type": "string",
          "description": "ISO 4217 currency code for the gift card purchased.",
          "minLength": 3,
          "maxLength": 3,
          "x-gitbook-description-html": "<p>ISO 4217 currency code for the gift card purchased.</p>"
        },
        "gift_card_count": {
          "type": "integer",
          "description": "Total count of individual prepaid gift cards purchased.",
          "maximum": 99,
          "x-gitbook-description-html": "<p>Total count of individual prepaid gift cards purchased.</p>"
        },
        "installment": {
          "type": "number",
          "description": "Indicates the maximum number of authorizations for installment payments. An integer value greater than 1 indicating the maximum number of permitted authorizations for installment payments. ** Required for Recurring and Installment transactions, when authenticationIndicator=\"02\" & \"03\" **",
          "minimum": 2,
          "maximum": 999,
          "x-gitbook-description-html": "<p>Indicates the maximum number of authorizations for installment payments. An integer value greater than 1 indicating the maximum number of permitted authorizations for installment payments. ** Required for Recurring and Installment transactions, when authenticationIndicator=\"02\" &#x26; \"03\" **</p>"
        },
        "message_category": {
          "type": "string",
          "description": "Category of the message for a specific use case. <br />  Possible Values: <br />  * 01 - PA (payment) <br />  * 02 - NPA (non payment) <br />  NOTE: Default is payment (01). Configured on Merchant account, or can be overridden on transaction. <br />",
          "enum": [
            "01",
            "02"
          ],
          "x-gitbook-description-html": "<p>Category of the message for a specific use case. <br>  Possible Values: <br>  * 01 - PA (payment) <br>  * 02 - NPA (non payment) <br>  NOTE: Default is payment (01). Configured on Merchant account, or can be overridden on transaction. <br></p>"
        },
        "payment_use_case": {
          "type": "string",
          "description": "Indicates the type of payment.The value from this field will be mapped to the data field on the CB-USECASE extension <br />  Possible Values: <br />  * 01 - Single Payment <br />  * 02 - Fixed Amount and Term Subscription <br />  * 03 - Payment By Instalments <br />  * 04 - Payment By Shipment <br />  * 05 - Other Recurring Payments <br />  NOTE: Required for CB transactions (Required if message_category = 01, or message_category = 02 and authentication_indicator = 02 or 03 <br />",
          "default": "01",
          "enum": [
            "01",
            "02",
            "03",
            "04",
            "05"
          ],
          "x-gitbook-description-html": "<p>Indicates the type of payment.The value from this field will be mapped to the data field on the CB-USECASE extension <br>  Possible Values: <br>  * 01 - Single Payment <br>  * 02 - Fixed Amount and Term Subscription <br>  * 03 - Payment By Instalments <br>  * 04 - Payment By Shipment <br>  * 05 - Other Recurring Payments <br>  NOTE: Required for CB transactions (Required if message_category = 01, or message_category = 02 and authentication_indicator = 02 or 03 <br></p>"
        },
        "payment_account_indicator": {
          "type": "string",
          "description": "Indicates the length of time that the payment account was enrolled in the merchant account. <br /> Possible Values: <br />  * 01 - No account (guest checkout) <br />  * 02 - During the transaction <br />  * 03 - Less than 30 days <br />  * 04 - 30-60 days <br />  * 05 - More than 60 days <br />",
          "enum": [
            "01",
            "02",
            "03",
            "04",
            "05"
          ],
          "x-gitbook-description-html": "<p>Indicates the length of time that the payment account was enrolled in the merchant account. <br> Possible Values: <br>  * 01 - No account (guest checkout) <br>  * 02 - During the transaction <br>  * 03 - Less than 30 days <br>  * 04 - 30-60 days <br>  * 05 - More than 60 days <br></p>"
        },
        "payment_account_age": {
          "type": "string",
          "format": "date",
          "description": "Date the payment account was added to the cardholder account. ` Format: YYYYMMDD`",
          "x-gitbook-description-html": "<p>Date the payment account was added to the cardholder account. <code> Format: YYYYMMDD</code></p>"
        },
        "pre_order_indicator": {
          "type": "string",
          "description": "Indicates whether cardholder is placing an order with a future availability or release date. <br />  Possible Values: <br />  * 01 - Merchandise available <br />  * 02 - Future availability <br />",
          "enum": [
            "01",
            "02"
          ],
          "x-gitbook-description-html": "<p>Indicates whether cardholder is placing an order with a future availability or release date. <br>  Possible Values: <br>  * 01 - Merchandise available <br>  * 02 - Future availability <br></p>"
        },
        "pre_order_date": {
          "type": "string",
          "format": "date",
          "description": "Expected date that a pre-ordered purchase will be available. `Format: YYYYMMDD`",
          "x-gitbook-description-html": "<p>Expected date that a pre-ordered purchase will be available. <code>Format: YYYYMMDD</code></p>"
        },
        "prior_authentication_data": {
          "type": "string",
          "description": "This field carry data that the ACS can use to verify the authentication process",
          "maxLength": 2048,
          "x-gitbook-description-html": "<p>This field carry data that the ACS can use to verify the authentication process</p>"
        },
        "prior_authentication_method": {
          "type": "string",
          "description": "Mechanism used by the Cardholder to previously authenticate to the 3DS Requestor. <br />  * 01 - Frictionless authentication occurred by ACS <br />  * 02 - Cardholder challenge occurred by ACS <br />  * 03 - AVS verified <br />  * 04 - Other issuer methods <br />",
          "enum": [
            "01",
            "02",
            "03",
            "04"
          ],
          "x-gitbook-description-html": "<p>Mechanism used by the Cardholder to previously authenticate to the 3DS Requestor. <br>  * 01 - Frictionless authentication occurred by ACS <br>  * 02 - Cardholder challenge occurred by ACS <br>  * 03 - AVS verified <br>  * 04 - Other issuer methods <br></p>"
        },
        "prior_authentication_time": {
          "type": "string",
          "format": "date",
          "description": "Date and time in UTC of the prior cardholder authentication. ` Format: YYYYMMDDHHMM`",
          "x-gitbook-description-html": "<p>Date and time in UTC of the prior cardholder authentication. <code> Format: YYYYMMDDHHMM</code></p>"
        },
        "prior_authentication_ref": {
          "type": "string",
          "description": "This data element contains a ACS Transaction ID for a prior authenticated transaction. <br /> For example, the first recurring transaction that was authenticated with the cardholder <br />",
          "maxLength": 36,
          "x-gitbook-description-html": "<p>This data element contains a ACS Transaction ID for a prior authenticated transaction. <br> For example, the first recurring transaction that was authenticated with the cardholder <br></p>"
        },
        "product_code": {
          "type": "string",
          "description": "Merchant product code.  <br /> Possible Values:  <br />  * PHY - Goods/Service Purchase  <br />  * CHA - Check Acceptance  <br />  * ACF - Account Funding  <br />  * QCT - Quasi-Cash Transaction  <br />  * PAL - Prepaid Activation and Load  <br /> NOTE: This value defaults to PHY. This field can be used to override that value if applicable.  <br />",
          "enum": [
            "PHY",
            "CHA",
            "ACF",
            "QCT",
            "PAL"
          ],
          "x-gitbook-description-html": "<p>Merchant product code.  <br> Possible Values:  <br>  * PHY - Goods/Service Purchase  <br>  * CHA - Check Acceptance  <br>  * ACF - Account Funding  <br>  * QCT - Quasi-Cash Transaction  <br>  * PAL - Prepaid Activation and Load  <br> NOTE: This value defaults to PHY. This field can be used to override that value if applicable.  <br></p>"
        },
        "recurring_end": {
          "type": "string",
          "format": "date",
          "description": "The date after which no further recurring authorizations should be performed. `Format: YYYYMMDD` ** Required for Recurring and Installment transactions, when authenticationIndicator=\"02\" & \"03\" **",
          "x-gitbook-description-html": "<p>The date after which no further recurring authorizations should be performed. <code>Format: YYYYMMDD</code> ** Required for Recurring and Installment transactions, when authenticationIndicator=\"02\" &#x26; \"03\" **</p>"
        },
        "recurring_frequency": {
          "type": "number",
          "description": "Conditional: Integer value indicating the minimum number of days between recurring authorizations. A frequency of monthly is indicated by the value 28. Multiple of 28 days will be used to indicate months. Example: 6 months = 168 ** Required for Recurring and Installment transactions, when authenticationIndicator=\"02\" & \"03\" **",
          "maximum": 9999,
          "x-gitbook-description-html": "<p>Conditional: Integer value indicating the minimum number of days between recurring authorizations. A frequency of monthly is indicated by the value 28. Multiple of 28 days will be used to indicate months. Example: 6 months = 168 ** Required for Recurring and Installment transactions, when authenticationIndicator=\"02\" &#x26; \"03\" **</p>"
        },
        "reorder_indicator": {
          "type": "string",
          "description": "Indicates whether cardholder is placing an order with a future availability or release date. <br />  Possible Values: <br />  * 01 - Merchandise available <br />  * 02 - Future availability <br />",
          "enum": [
            "01",
            "02"
          ],
          "x-gitbook-description-html": "<p>Indicates whether cardholder is placing an order with a future availability or release date. <br>  Possible Values: <br>  * 01 - Merchandise available <br>  * 02 - Future availability <br></p>"
        },
        "requestor_id": {
          "type": "string",
          "description": "This value is a Directory Server assigned 3DS Requestor Name value, each DS may provide a unique ID. <br /> NOTE: This is a 2.0 value only and if passed will override the Requestor Name value that is, <br /> configured on the Merchant's profile.",
          "maxLength": 35,
          "x-gitbook-description-html": "<p>This value is a Directory Server assigned 3DS Requestor Name value, each DS may provide a unique ID. <br> NOTE: This is a 2.0 value only and if passed will override the Requestor Name value that is, <br> configured on the Merchant's profile.</p>"
        },
        "requestor_name": {
          "type": "string",
          "description": "This value is a Directory Server assigned 3DS Requestor Name value, each DS may provide a unique ID. <br /> NOTE: This is a 2.0 value only and if passed will override the Requestor Name value that is configured <br /> on the Merchant's profile.",
          "maxLength": 40,
          "x-gitbook-description-html": "<p>This value is a Directory Server assigned 3DS Requestor Name value, each DS may provide a unique ID. <br> NOTE: This is a 2.0 value only and if passed will override the Requestor Name value that is configured <br> on the Merchant's profile.</p>"
        },
        "shipping_address_usage_indicator": {
          "type": "string",
          "description": "Indicates when the shipping address used for transaction was first used. <br /> Possible Values: <br />  * 01 - This transaction <br />  * 02 - Less than 30 days <br />  * 03 - 30-60 days <br />  * 04 - More than 60 days <br />",
          "enum": [
            "01",
            "02",
            "03",
            "04"
          ],
          "x-gitbook-description-html": "<p>Indicates when the shipping address used for transaction was first used. <br> Possible Values: <br>  * 01 - This transaction <br>  * 02 - Less than 30 days <br>  * 03 - 30-60 days <br>  * 04 - More than 60 days <br></p>"
        },
        "shipping_address_usage_date": {
          "type": "string",
          "format": "date",
          "description": "Date when the shipping address used for this transaction was first used. <br />  `Format: YYYYMMDD` <br />",
          "x-gitbook-description-html": "<p>Date when the shipping address used for this transaction was first used. <br>  <code>Format: YYYYMMDD</code> <br></p>"
        },
        "shipping_method_indicator": {
          "type": "string",
          "description": "Indicates shipping method chosen for the transaction. <br />  Possible Values:  <br />  * 01 - Ship to cardholder billing address <br />  * 02 - Ship to another verified address on file with merchant <br />  * 03 - Ship to address that is different than billing address <br />  * 04 - Ship to store (store address should be populated on request) <br />  * 05 - Digital goods <br />  * 06 - Travel and event tickets, not shipped <br />  * 07 - Other <br />",
          "enum": [
            "01",
            "02",
            "03",
            "04",
            "05",
            "06",
            "07"
          ],
          "x-gitbook-description-html": "<p>Indicates shipping method chosen for the transaction. <br>  Possible Values:  <br>  * 01 - Ship to cardholder billing address <br>  * 02 - Ship to another verified address on file with merchant <br>  * 03 - Ship to address that is different than billing address <br>  * 04 - Ship to store (store address should be populated on request) <br>  * 05 - Digital goods <br>  * 06 - Travel and event tickets, not shipped <br>  * 07 - Other <br></p>"
        },
        "shipping_name_indicator": {
          "type": "string",
          "description": "Indicates if the cardholder name on the account is identical to the <br /> shipping name used for the transaction. Possible Values: <br /> * 01 - Account and shipping name identical <br /> * 02 - Account and shipping name differ <br />",
          "enum": [
            "01",
            "02"
          ],
          "x-gitbook-description-html": "<p>Indicates if the cardholder name on the account is identical to the <br> shipping name used for the transaction. Possible Values: <br> * 01 - Account and shipping name identical <br> * 02 - Account and shipping name differ <br></p>"
        },
        "total_items": {
          "type": "string",
          "description": "Total items in the shopping cart of the shopper",
          "pattern": "^[0-9]{2}$",
          "x-gitbook-description-html": "<p>Total items in the shopping cart of the shopper</p>"
        },
        "merchant_score": {
          "type": "string",
          "description": "Merchant score",
          "maxLength": 20,
          "x-format": {
            "alphanum": true
          },
          "x-gitbook-description-html": "<p>Merchant score</p>"
        },
        "transaction_count_day": {
          "type": "integer",
          "description": "Number of transactions (successful or abandoned) for this cardholder account within the last 24 hours. <br />",
          "maximum": 999,
          "x-gitbook-description-html": "<p>Number of transactions (successful or abandoned) for this cardholder account within the last 24 hours. <br></p>"
        },
        "transaction_count_year": {
          "type": "integer",
          "description": "Number of transactions (successful or abandoned) for this cardholder account within the last year. <br />",
          "maximum": 999,
          "x-gitbook-description-html": "<p>Number of transactions (successful or abandoned) for this cardholder account within the last year. <br></p>"
        },
        "transaction_mode": {
          "type": "string",
          "description": "Transaction mode identifier. Identifies the channel the transaction originates from. Available Options: <br /> M - Moto (Mail Order Telephone Order) <br /> P - Mobile Device <br /> R - Retail (Physical Store) <br /> S - Computer Device <br /> T - Tablet Device <br />",
          "enum": [
            "M",
            "P",
            "R",
            "S",
            "T"
          ],
          "x-gitbook-description-html": "<p>Transaction mode identifier. Identifies the channel the transaction originates from. Available Options: <br> M - Moto (Mail Order Telephone Order) <br> P - Mobile Device <br> R - Retail (Physical Store) <br> S - Computer Device <br> T - Tablet Device <br></p>"
        },
        "version": {
          "type": "string",
          "description": "This field contains the 3DS version that can be leveraged to force a transaction down the 1.0 rails.",
          "enum": [
            "1.0.2",
            "2.1.0",
            "2.2.0"
          ],
          "deprecated": true,
          "x-gitbook-description-html": "<p>This field contains the 3DS version that can be leveraged to force a transaction down the 1.0 rails.</p>"
        },
        "white_list_status": {
          "type": "string",
          "description": "Enables the communication of trusted beneficiary between the ACS, the DS and the 3DS Requestor. <br> Possible Values: <br> * `Y` - 3DS Requestor is trustlisted by cardholder  <br> * `N` - 3DS Requestor is not trustlisted by cardholder  <br> * `E` - Not eligible as determined by issuer <br> * `P` - Pending confirmation by cardholder <br> * `R` - Cardholder rejected <br> * `U` - Trustlist status unknown, unavailable, or does not apply <br> Note: This field may be returned for 2.1.0 if the MasterCard PSD2 extensions are passed and issuer supports them.\n",
          "enum": [
            "Y",
            "N",
            "E",
            "P",
            "R",
            "U"
          ],
          "x-gitbook-description-html": "<p>Enables the communication of trusted beneficiary between the ACS, the DS and the 3DS Requestor. <br> Possible Values: <br> * <code>Y</code> - 3DS Requestor is trustlisted by cardholder  <br> * <code>N</code> - 3DS Requestor is not trustlisted by cardholder  <br> * <code>E</code> - Not eligible as determined by issuer <br> * <code>P</code> - Pending confirmation by cardholder <br> * <code>R</code> - Cardholder rejected <br> * <code>U</code> - Trustlist status unknown, unavailable, or does not apply <br> Note: This field may be returned for 2.1.0 if the MasterCard PSD2 extensions are passed and issuer supports them.</p>"
        },
        "white_list_status_source": {
          "type": "string",
          "description": "This data element will be populated by the system setting Whitelist Status.",
          "enum": [
            "01",
            "02",
            "03"
          ],
          "x-gitbook-description-html": "<p>This data element will be populated by the system setting Whitelist Status.</p>"
        }
      },
      "required": [
        "threeds_contract_id",
        "transaction_mode"
      ]
    },
    "Model3": {
      "type": "object",
      "properties": {
        "sca_compliance_level": {
          "type": "string",
          "description": "Strong Customer Authentication (SCA) compliance level, possible values </br>\n     * NONE: No SCA required. </br>\n     * WALLET: Depend on the wallet SCA mechanism. For Google Pay this means that MasterCard will shift liability, Visa will not. </br>\n     * FORCE_3DS: Do an additional 3DS step regardless of whether the wallet indicates the token is SCA-compliant.\nenum:\n- NONE\n- WALLET\n- FORCE_3DS",
          "x-gitbook-description-html": "<p>Strong Customer Authentication (SCA) compliance level, possible values <br>\n* NONE: No SCA required. <br>\n* WALLET: Depend on the wallet SCA mechanism. For Google Pay this means that MasterCard will shift liability, Visa will not. <br>\n* FORCE_3DS: Do an additional 3DS step regardless of whether the wallet indicates the token is SCA-compliant.\nenum:</p>\n<ul>\n<li>NONE</li>\n<li>WALLET</li>\n<li>FORCE_3DS</li>\n</ul>"
        },
        "threed_secure": {
          "$ref": "#/x-alt-definitions/threed_secure_duplicate"
        },
        "authorization_type": {
          "type": "string",
          "description": "Card Authorization Type (PRE_AUTH, FINAL_AUTH).  When capture now is set to true pre-authorization transactions cannot be done.",
          "default": "FINAL_AUTH",
          "x-gitbook-description-html": "<p>Card Authorization Type (PRE_AUTH, FINAL_AUTH).  When capture now is set to true pre-authorization transactions cannot be done.</p>"
        },
        "encrypted_card": {
          "type": "string",
          "description": "Encrypted card details",
          "maxLength": 4096,
          "x-gitbook-description-html": "<p>Encrypted card details</p>"
        },
        "card_encryption_key_alias": {
          "type": "string",
          "description": "Public key alias",
          "x-gitbook-description-html": "<p>Public key alias</p>"
        },
        "return_url": {
          "type": "string",
          "description": "URL belonging to the Merchant website, where the Customer would be redirected after the Checkout has been completed. If this parameter is used, the customer will be redirected after spending 10 seconds on the payment confirmation page provided by OnlinePay in case of HPP and PAYMENT LINK transactions. For IFRAME transaction the redirect is performed right after the checkout page without passing through the payment confirmation page.   <br /> <b>Note:</b> The time after which redirection happens can be customized using redirect_method.",
          "x-format": {
            "uri": true
          },
          "x-gitbook-description-html": "<p>URL belonging to the Merchant website, where the Customer would be redirected after the Checkout has been completed. If this parameter is used, the customer will be redirected after spending 10 seconds on the payment confirmation page provided by OnlinePay in case of HPP and PAYMENT LINK transactions. For IFRAME transaction the redirect is performed right after the checkout page without passing through the payment confirmation page.   <br> <b>Note:</b> The time after which redirection happens can be customized using redirect_method.</p>"
        }
      },
      "required": [
        "sca_compliance_level",
        "threed_secure"
      ]
    },
    "Model4": {
      "type": "object",
      "properties": {
        "sca_compliance_level": {
          "type": "string",
          "description": "Strong Customer Authentication (SCA) compliance level, possible values </br>\n     * NONE: No SCA required. </br>\n     * WALLET: Depend on the wallet SCA mechanism. For Google Pay this means that MasterCard will shift liability, Visa will not. </br>\n     * FORCE_3DS: Do an additional 3DS step regardless of whether the wallet indicates the token is SCA-compliant.\nenum:\n- NONE\n- WALLET\n- FORCE_3DS",
          "x-gitbook-description-html": "<p>Strong Customer Authentication (SCA) compliance level, possible values <br>\n* NONE: No SCA required. <br>\n* WALLET: Depend on the wallet SCA mechanism. For Google Pay this means that MasterCard will shift liability, Visa will not. <br>\n* FORCE_3DS: Do an additional 3DS step regardless of whether the wallet indicates the token is SCA-compliant.\nenum:</p>\n<ul>\n<li>NONE</li>\n<li>WALLET</li>\n<li>FORCE_3DS</li>\n</ul>"
        },
        "authorization_type": {
          "type": "string",
          "description": "Card Authorization Type (PRE_AUTH, FINAL_AUTH).  When capture now is set to true pre-authorization transactions cannot be done.",
          "default": "FINAL_AUTH",
          "x-gitbook-description-html": "<p>Card Authorization Type (PRE_AUTH, FINAL_AUTH).  When capture now is set to true pre-authorization transactions cannot be done.</p>"
        },
        "encrypted_card": {
          "type": "string",
          "description": "Encrypted card details",
          "maxLength": 4096,
          "x-gitbook-description-html": "<p>Encrypted card details</p>"
        },
        "card_encryption_key_alias": {
          "type": "string",
          "description": "Public key alias",
          "x-gitbook-description-html": "<p>Public key alias</p>"
        },
        "return_url": {
          "type": "string",
          "description": "URL belonging to the Merchant website, where the Customer would be redirected after the Checkout has been completed. If this parameter is used, the customer will be redirected after spending 10 seconds on the payment confirmation page provided by OnlinePay in case of HPP and PAYMENT LINK transactions. For IFRAME transaction the redirect is performed right after the checkout page without passing through the payment confirmation page.   <br /> <b>Note:</b> The time after which redirection happens can be customized using redirect_method.",
          "x-format": {
            "uri": true
          },
          "x-gitbook-description-html": "<p>URL belonging to the Merchant website, where the Customer would be redirected after the Checkout has been completed. If this parameter is used, the customer will be redirected after spending 10 seconds on the payment confirmation page provided by OnlinePay in case of HPP and PAYMENT LINK transactions. For IFRAME transaction the redirect is performed right after the checkout page without passing through the payment confirmation page.   <br> <b>Note:</b> The time after which redirection happens can be customized using redirect_method.</p>"
        }
      },
      "required": [
        "sca_compliance_level"
      ]
    },
    "tokenPreferenceDef": {
      "type": "object",
      "description": "Read <a target=\"_blank\" href=\"https://docs.verifone.com/online-payments/tokenization\">Tokenization</a> for additional information",
      "properties": {
        "tokenScope": {
          "type": "string",
          "description": "The token scope under which a token gets created",
          "x-format": {
            "guid": true
          },
          "x-gitbook-description-html": "<p>The token scope under which a token gets created</p>"
        },
        "tokenExpiryDate": {
          "type": "string",
          "format": "date",
          "description": "Token expiry date",
          "x-gitbook-description-html": "<p>Token expiry date</p>"
        },
        "tokenType": {
          "type": "string",
          "description": "Token type",
          "enum": [
            "REUSE",
            "REUSE_AND_ANALYTICS",
            "ANALYTICS"
          ],
          "x-gitbook-description-html": "<p>Token type</p>"
        }
      },
      "required": [
        "tokenScope"
      ],
      "x-gitbook-description-html": "<p>Read <a href=\"https://docs.verifone.com/online-payments/tokenization\">Tokenization</a> for additional information</p>"
    },
    "Model5": {
      "type": "object",
      "properties": {
        "scaComplianceLevel": {
          "type": "string",
          "description": "Strong Customer Authentication (SCA) compliance level, possible values </br>\n     * NONE: No SCA required. </br>\n     * WALLET: Depend on the wallet SCA mechanism. For Google Pay this means that MasterCard will shift liability, Visa will not. </br>\n     * FORCE_3DS: Do an additional 3DS step regardless of whether the wallet indicates the token is SCA-compliant.\nenum:\n- NONE\n- WALLET\n- FORCE_3DS",
          "x-gitbook-description-html": "<p>Strong Customer Authentication (SCA) compliance level, possible values <br>\n* NONE: No SCA required. <br>\n* WALLET: Depend on the wallet SCA mechanism. For Google Pay this means that MasterCard will shift liability, Visa will not. <br>\n* FORCE_3DS: Do an additional 3DS step regardless of whether the wallet indicates the token is SCA-compliant.\nenum:</p>\n<ul>\n<li>NONE</li>\n<li>WALLET</li>\n<li>FORCE_3DS</li>\n</ul>"
        },
        "threedSecure": {
          "$ref": "#/x-alt-definitions/threedSecureDef"
        },
        "authorizationType": {
          "type": "string",
          "description": "Card Authorization Type (PRE_AUTH, FINAL_AUTH).  When capture now is set to true pre-authorization transactions cannot be done.",
          "default": "FINAL_AUTH",
          "x-gitbook-description-html": "<p>Card Authorization Type (PRE_AUTH, FINAL_AUTH).  When capture now is set to true pre-authorization transactions cannot be done.</p>"
        },
        "shopperInteraction": {
          "type": "string",
          "description": "Shopper interaction to send within the payment request",
          "default": "ECOMMERCE",
          "enum": [
            "ECOMMERCE",
            "MAIL",
            "TELEPHONE"
          ],
          "x-gitbook-description-html": "<p>Shopper interaction to send within the payment request</p>"
        },
        "paymentContractId": {
          "type": "string",
          "description": "This parameter can be found in the portal on the Payment Provider Contract attached to your organization or given to you by a OnlinePay employee. It is used to retrieve MID and other merchant configurations necessary for a card payment.",
          "x-format": {
            "guid": true
          },
          "required": [
            "paymentContractId"
          ],
          "x-alternatives": [
            {
              "type": "string",
              "description": "This parameter can be found in the portal on the Payment Provider Contract attached to your organization or given to you by a OnlinePay employee. It is used to retrieve MID and other merchant configurations necessary for a card payment.",
              "x-format": {
                "guid": true
              },
              "x-gitbook-description-html": "<p>This parameter can be found in the portal on the Payment Provider Contract attached to your organization or given to you by a OnlinePay employee. It is used to retrieve MID and other merchant configurations necessary for a card payment.</p>"
            },
            {
              "$ref": "#/x-alt-definitions/paymentContractIdDef"
            }
          ],
          "x-gitbook-description-html": "<p>This parameter can be found in the portal on the Payment Provider Contract attached to your organization or given to you by a OnlinePay employee. It is used to retrieve MID and other merchant configurations necessary for a card payment.</p>"
        },
        "tokenPreference": {
          "$ref": "#/x-alt-definitions/tokenPreferenceDef"
        }
      },
      "required": [
        "scaComplianceLevel",
        "threedSecure",
        "paymentContractId"
      ]
    },
    "Model6": {
      "type": "object",
      "properties": {
        "scaComplianceLevel": {
          "type": "string",
          "description": "Strong Customer Authentication (SCA) compliance level, possible values </br>\n     * NONE: No SCA required. </br>\n     * WALLET: Depend on the wallet SCA mechanism. For Google Pay this means that MasterCard will shift liability, Visa will not. </br>\n     * FORCE_3DS: Do an additional 3DS step regardless of whether the wallet indicates the token is SCA-compliant.\nenum:\n- NONE\n- WALLET\n- FORCE_3DS",
          "x-gitbook-description-html": "<p>Strong Customer Authentication (SCA) compliance level, possible values <br>\n* NONE: No SCA required. <br>\n* WALLET: Depend on the wallet SCA mechanism. For Google Pay this means that MasterCard will shift liability, Visa will not. <br>\n* FORCE_3DS: Do an additional 3DS step regardless of whether the wallet indicates the token is SCA-compliant.\nenum:</p>\n<ul>\n<li>NONE</li>\n<li>WALLET</li>\n<li>FORCE_3DS</li>\n</ul>"
        },
        "authorizationType": {
          "type": "string",
          "description": "Card Authorization Type (PRE_AUTH, FINAL_AUTH).  When capture now is set to true pre-authorization transactions cannot be done.",
          "default": "FINAL_AUTH",
          "x-gitbook-description-html": "<p>Card Authorization Type (PRE_AUTH, FINAL_AUTH).  When capture now is set to true pre-authorization transactions cannot be done.</p>"
        },
        "shopperInteraction": {
          "type": "string",
          "description": "Shopper interaction to send within the payment request",
          "default": "ECOMMERCE",
          "enum": [
            "ECOMMERCE",
            "MAIL",
            "TELEPHONE"
          ],
          "x-gitbook-description-html": "<p>Shopper interaction to send within the payment request</p>"
        },
        "paymentContractId": {
          "type": "string",
          "description": "This parameter can be found in the portal on the Payment Provider Contract attached to your organization or given to you by a OnlinePay employee. It is used to retrieve MID and other merchant configurations necessary for a card payment.",
          "x-format": {
            "guid": true
          },
          "required": [
            "paymentContractId"
          ],
          "x-alternatives": [
            {
              "type": "string",
              "description": "This parameter can be found in the portal on the Payment Provider Contract attached to your organization or given to you by a OnlinePay employee. It is used to retrieve MID and other merchant configurations necessary for a card payment.",
              "x-format": {
                "guid": true
              },
              "x-gitbook-description-html": "<p>This parameter can be found in the portal on the Payment Provider Contract attached to your organization or given to you by a OnlinePay employee. It is used to retrieve MID and other merchant configurations necessary for a card payment.</p>"
            },
            {
              "$ref": "#/x-alt-definitions/paymentContractIdDef"
            }
          ],
          "x-gitbook-description-html": "<p>This parameter can be found in the portal on the Payment Provider Contract attached to your organization or given to you by a OnlinePay employee. It is used to retrieve MID and other merchant configurations necessary for a card payment.</p>"
        },
        "tokenPreference": {
          "$ref": "#/x-alt-definitions/tokenPreferenceDef"
        }
      },
      "required": [
        "scaComplianceLevel",
        "paymentContractId"
      ]
    },
    "Model7": {
      "type": "object",
      "properties": {
        "scaComplianceLevel": {
          "type": "string",
          "enum": [
            "NONE",
            "WALLET"
          ]
        },
        "authorizationType": {
          "type": "string",
          "description": "Card Authorization Type (PRE_AUTH, FINAL_AUTH).  When capture now is set to true pre-authorization transactions cannot be done.",
          "default": "FINAL_AUTH",
          "x-gitbook-description-html": "<p>Card Authorization Type (PRE_AUTH, FINAL_AUTH).  When capture now is set to true pre-authorization transactions cannot be done.</p>"
        },
        "shopperInteraction": {
          "type": "string",
          "description": "Shopper interaction to send within the payment request",
          "default": "ECOMMERCE",
          "enum": [
            "ECOMMERCE",
            "MAIL",
            "TELEPHONE"
          ],
          "x-gitbook-description-html": "<p>Shopper interaction to send within the payment request</p>"
        },
        "paymentContractId": {
          "type": "string",
          "description": "This parameter can be found in the portal on the Payment Provider Contract attached to your organization or given to you by a OnlinePay employee. It is used to retrieve MID and other merchant configurations necessary for a card payment.",
          "x-format": {
            "guid": true
          },
          "required": [
            "paymentContractId"
          ],
          "x-alternatives": [
            {
              "type": "string",
              "description": "Payment Contract Id",
              "x-format": {
                "guid": true
              },
              "x-gitbook-description-html": "<p>Payment Contract Id</p>"
            },
            {
              "$ref": "#/x-alt-definitions/paymentContractIdDef"
            }
          ],
          "x-gitbook-description-html": "<p>This parameter can be found in the portal on the Payment Provider Contract attached to your organization or given to you by a OnlinePay employee. It is used to retrieve MID and other merchant configurations necessary for a card payment.</p>"
        },
        "tokenPreference": {
          "$ref": "#/x-alt-definitions/tokenPreferenceDef"
        }
      },
      "required": [
        "paymentContractId"
      ]
    },
    "Model8": {
      "type": "object",
      "properties": {
        "scaComplianceLevel": {
          "type": "string",
          "description": "Strong Customer Authentication (SCA) compliance level, possible values </br>\n     * NONE: No SCA required. </br>\n     * WALLET: Depend on the wallet SCA mechanism. For Google Pay this means that MasterCard will shift liability, Visa will not. </br>\n     * FORCE_3DS: Do an additional 3DS step regardless of whether the wallet indicates the token is SCA-compliant.\nenum:\n- NONE\n- WALLET\n- FORCE_3DS",
          "x-gitbook-description-html": "<p>Strong Customer Authentication (SCA) compliance level, possible values <br>\n* NONE: No SCA required. <br>\n* WALLET: Depend on the wallet SCA mechanism. For Google Pay this means that MasterCard will shift liability, Visa will not. <br>\n* FORCE_3DS: Do an additional 3DS step regardless of whether the wallet indicates the token is SCA-compliant.\nenum:</p>\n<ul>\n<li>NONE</li>\n<li>WALLET</li>\n<li>FORCE_3DS</li>\n</ul>"
        },
        "threedSecure": {
          "$ref": "#/x-alt-definitions/threedSecureDef"
        },
        "authorizationType": {
          "type": "string",
          "description": "Card Authorization Type (PRE_AUTH, FINAL_AUTH).  When capture now is set to true pre-authorization transactions cannot be done.",
          "default": "FINAL_AUTH",
          "x-gitbook-description-html": "<p>Card Authorization Type (PRE_AUTH, FINAL_AUTH).  When capture now is set to true pre-authorization transactions cannot be done.</p>"
        }
      },
      "required": [
        "scaComplianceLevel",
        "threedSecure"
      ]
    },
    "Model9": {
      "type": "object",
      "properties": {
        "scaComplianceLevel": {
          "type": "string",
          "description": "Strong Customer Authentication (SCA) compliance level, possible values </br>\n     * NONE: No SCA required. </br>\n     * WALLET: Depend on the wallet SCA mechanism. For Google Pay this means that MasterCard will shift liability, Visa will not. </br>\n     * FORCE_3DS: Do an additional 3DS step regardless of whether the wallet indicates the token is SCA-compliant.\nenum:\n- NONE\n- WALLET\n- FORCE_3DS",
          "x-gitbook-description-html": "<p>Strong Customer Authentication (SCA) compliance level, possible values <br>\n* NONE: No SCA required. <br>\n* WALLET: Depend on the wallet SCA mechanism. For Google Pay this means that MasterCard will shift liability, Visa will not. <br>\n* FORCE_3DS: Do an additional 3DS step regardless of whether the wallet indicates the token is SCA-compliant.\nenum:</p>\n<ul>\n<li>NONE</li>\n<li>WALLET</li>\n<li>FORCE_3DS</li>\n</ul>"
        },
        "authorizationType": {
          "type": "string",
          "description": "Card Authorization Type (PRE_AUTH, FINAL_AUTH).  When capture now is set to true pre-authorization transactions cannot be done.",
          "default": "FINAL_AUTH",
          "x-gitbook-description-html": "<p>Card Authorization Type (PRE_AUTH, FINAL_AUTH).  When capture now is set to true pre-authorization transactions cannot be done.</p>"
        }
      },
      "required": [
        "scaComplianceLevel"
      ]
    },
    "Model10": {
      "type": "object",
      "properties": {
        "imageUrl": {
          "type": "string",
          "description": "Image URL for the line item",
          "maxLength": 2000,
          "x-format": {
            "uri": true
          },
          "x-gitbook-description-html": "<p>Image URL for the line item</p>"
        },
        "itemUrl": {
          "type": "string",
          "description": "Item URL for the line item",
          "maxLength": 2000,
          "x-format": {
            "uri": true
          },
          "x-gitbook-description-html": "<p>Item URL for the line item</p>"
        },
        "name": {
          "type": "string",
          "description": "Descriptive name of the order line item",
          "maxLength": 255,
          "x-gitbook-description-html": "<p>Descriptive name of the order line item</p>"
        },
        "quantity": {
          "type": "integer",
          "default": 1,
          "description": "Quantity of the order line item",
          "x-gitbook-description-html": "<p>Quantity of the order line item</p>"
        },
        "unitPrice": {
          "type": "number",
          "description": "Unit Price",
          "x-gitbook-description-html": "<p>Unit Price</p>"
        },
        "unitPriceTax": {
          "type": "number",
          "description": "Unit Price Tax",
          "x-gitbook-description-html": "<p>Unit Price Tax</p>"
        },
        "taxRate": {
          "type": "number",
          "description": "Additional details specific to this type of event",
          "x-gitbook-description-html": "<p>Additional details specific to this type of event</p>"
        },
        "totalTaxAmount": {
          "type": "number",
          "description": "Total tax amount",
          "x-gitbook-description-html": "<p>Total tax amount</p>"
        },
        "totalAmount": {
          "type": "number",
          "description": "Total Amount",
          "x-gitbook-description-html": "<p>Total Amount</p>"
        },
        "sku": {
          "type": "string",
          "description": "The stock keeping unit (SKU) for the item.",
          "maxLength": 127,
          "x-gitbook-description-html": "<p>The stock keeping unit (SKU) for the item.</p>"
        },
        "description": {
          "type": "string",
          "description": "The detailed item description.",
          "maxLength": 127,
          "x-gitbook-description-html": "<p>The detailed item description.</p>"
        },
        "category": {
          "type": "string",
          "description": "The item category type. <br />  The possible values are: <br />  * DIGITAL_GOODS - Goods that are stored, delivered, and used in their electronic format. This value is not currently supported for API callers that leverage the [PayPal for Commerce Platform](https://www.paypal.com/us/webapps/mpp/commerce-platform) product. <br />  * DIGITAL_GOODS - A tangible item that can be shipped with proof of delivery. <br />",
          "enum": [
            "DIGITAL_GOODS",
            "PHYSICAL_GOODS"
          ],
          "x-gitbook-description-html": "<p>The item category type. <br>  The possible values are: <br>  * DIGITAL_GOODS - Goods that are stored, delivered, and used in their electronic format. This value is not currently supported for API callers that leverage the <a href=\"https://www.paypal.com/us/webapps/mpp/commerce-platform\">PayPal for Commerce Platform</a> product. <br>  * DIGITAL_GOODS - A tangible item that can be shipped with proof of delivery. <br></p>"
        }
      },
      "required": [
        "name",
        "quantity",
        "unitPrice",
        "taxRate",
        "totalTaxAmount",
        "totalAmount"
      ]
    },
    "lineItems": {
      "type": "array",
      "description": "List of shopping cart items, to be displayed on the page. Read <a target=\"_blank\" href=\"https://docs.verifone.com/online-payments/checkout/line-items\">Line items</a> for details.",
      "items": {
        "$ref": "#/x-alt-definitions/Model10"
      },
      "x-gitbook-description-html": "<p>List of shopping cart items, to be displayed on the page. Read <a href=\"https://docs.verifone.com/online-payments/checkout/line-items\">Line items</a> for details.</p>"
    },
    "Model11": {
      "type": "object",
      "properties": {
        "imageUrl": {
          "type": "string",
          "description": "Image URL for the line item",
          "maxLength": 2000,
          "x-format": {
            "uri": true
          },
          "x-gitbook-description-html": "<p>Image URL for the line item</p>"
        },
        "itemUrl": {
          "type": "string",
          "description": "Item URL for the line item",
          "maxLength": 2000,
          "x-format": {
            "uri": true
          },
          "x-gitbook-description-html": "<p>Item URL for the line item</p>"
        },
        "name": {
          "type": "string",
          "description": "Descriptive name of the order line item",
          "maxLength": 255,
          "x-gitbook-description-html": "<p>Descriptive name of the order line item</p>"
        },
        "quantity": {
          "type": "integer",
          "default": 1,
          "description": "Quantity of the order line item",
          "x-gitbook-description-html": "<p>Quantity of the order line item</p>"
        },
        "unitPrice": {
          "type": "number",
          "description": "Unit Price",
          "x-gitbook-description-html": "<p>Unit Price</p>"
        },
        "unitPriceTax": {
          "type": "number",
          "description": "Unit Price Tax",
          "x-gitbook-description-html": "<p>Unit Price Tax</p>"
        },
        "taxRate": {
          "type": "number",
          "description": "Additional details specific to this type of event",
          "x-gitbook-description-html": "<p>Additional details specific to this type of event</p>"
        },
        "totalTaxAmount": {
          "type": "number",
          "description": "Total tax amount",
          "x-gitbook-description-html": "<p>Total tax amount</p>"
        },
        "totalAmount": {
          "type": "number",
          "description": "Total Amount",
          "x-gitbook-description-html": "<p>Total Amount</p>"
        },
        "sku": {
          "type": "string",
          "description": "The stock keeping unit (SKU) for the item.",
          "maxLength": 127,
          "x-gitbook-description-html": "<p>The stock keeping unit (SKU) for the item.</p>"
        },
        "description": {
          "type": "string",
          "description": "The detailed item description.",
          "maxLength": 127,
          "x-gitbook-description-html": "<p>The detailed item description.</p>"
        },
        "category": {
          "type": "string",
          "description": "The item category type. <br />  The possible values are: <br />  * DIGITAL_GOODS - Goods that are stored, delivered, and used in their electronic format. This value is not currently supported for API callers that leverage the [PayPal for Commerce Platform](https://www.paypal.com/us/webapps/mpp/commerce-platform) product. <br />  * DIGITAL_GOODS - A tangible item that can be shipped with proof of delivery. <br />",
          "enum": [
            "DIGITAL_GOODS",
            "PHYSICAL_GOODS"
          ],
          "x-gitbook-description-html": "<p>The item category type. <br>  The possible values are: <br>  * DIGITAL_GOODS - Goods that are stored, delivered, and used in their electronic format. This value is not currently supported for API callers that leverage the <a href=\"https://www.paypal.com/us/webapps/mpp/commerce-platform\">PayPal for Commerce Platform</a> product. <br>  * DIGITAL_GOODS - A tangible item that can be shipped with proof of delivery. <br></p>"
        }
      },
      "required": [
        "name",
        "unitPrice",
        "totalAmount"
      ]
    },
    "Model12": {
      "type": "array",
      "items": {
        "$ref": "#/x-alt-definitions/Model11"
      }
    },
    "Model13": {
      "type": "object",
      "properties": {
        "validationRule": {
          "type": "string",
          "default": "NONE",
          "enum": [
            "NONE",
            "LUHN"
          ]
        },
        "usage": {
          "type": "string",
          "default": "REQUIRED",
          "enum": [
            "REQUIRED",
            "PROHIBITED"
          ]
        }
      }
    },
    "Model14": {
      "type": "object",
      "properties": {
        "CVV": {
          "$ref": "#/x-alt-definitions/Model13"
        },
        "CREDIT_TERM": {
          "$ref": "#/x-alt-definitions/Model13"
        },
        "IDENTITY_CARD_NUMBER": {
          "$ref": "#/x-alt-definitions/Model13"
        }
      }
    },
    "Model15": {
      "type": "object",
      "description": "Need to enable merchants to configure additional input fields on checkout for the input in scope.",
      "properties": {
        "AMEX": {
          "$ref": "#/x-alt-definitions/Model14"
        },
        "JCB": {
          "$ref": "#/x-alt-definitions/Model14"
        },
        "MASTERCARD": {
          "$ref": "#/x-alt-definitions/Model14"
        },
        "VISA": {
          "$ref": "#/x-alt-definitions/Model14"
        }
      },
      "x-gitbook-description-html": "<p>Need to enable merchants to configure additional input fields on checkout for the input in scope.</p>"
    },
    "token_preference": {
      "type": "object",
      "description": "Read <a target=\"_blank\" href=\"https://docs.verifone.com/online-payments/tokenization\">Tokenization</a> for additional information",
      "properties": {
        "token_scope": {
          "type": "string",
          "description": "The token scope under which a token gets created",
          "x-format": {
            "guid": true
          },
          "x-gitbook-description-html": "<p>The token scope under which a token gets created</p>"
        },
        "token_expiry_date": {
          "type": "string",
          "format": "date",
          "description": "Token expiry date",
          "x-gitbook-description-html": "<p>Token expiry date</p>"
        },
        "token_type": {
          "type": "string",
          "description": "Token type",
          "enum": [
            "REUSE",
            "REUSE_AND_ANALYTICS",
            "ANALYTICS"
          ],
          "x-gitbook-description-html": "<p>Token type</p>"
        }
      },
      "required": [
        "token_scope"
      ],
      "x-gitbook-description-html": "<p>Read <a href=\"https://docs.verifone.com/online-payments/tokenization\">Tokenization</a> for additional information</p>"
    },
    "card_token_preference": {
      "type": "object",
      "description": "Read <a target=\"_blank\" href=\"https://docs.verifone.com/online-payments/tokenization\">Tokenization</a> for additional information",
      "properties": {
        "token_scope": {
          "type": "string",
          "description": "The token scope under which a token gets created",
          "x-format": {
            "guid": true
          },
          "x-gitbook-description-html": "<p>The token scope under which a token gets created</p>"
        },
        "token_expiry_date": {
          "type": "string",
          "format": "date",
          "description": "Token expiry date",
          "x-gitbook-description-html": "<p>Token expiry date</p>"
        },
        "token_type": {
          "type": "string",
          "description": "Token type",
          "enum": [
            "REUSE",
            "REUSE_AND_ANALYTICS",
            "ANALYTICS"
          ],
          "x-gitbook-description-html": "<p>Token type</p>"
        },
        "reuse_token_type": {
          "type": "string",
          "description": "Reuse token type",
          "enum": [
            "TAVE",
            "CHASE",
            "INTERNAL"
          ],
          "x-gitbook-description-html": "<p>Reuse token type</p>"
        }
      },
      "required": [
        "token_scope"
      ],
      "x-gitbook-description-html": "<p>Read <a href=\"https://docs.verifone.com/online-payments/tokenization\">Tokenization</a> for additional information</p>"
    },
    "Model16": {
      "type": "object",
      "properties": {
        "sca_compliance_level": {
          "type": "string",
          "description": "Strong Customer Authentication (SCA) compliance level, possible values </br>\n     * NONE: No SCA required. </br>\n     * WALLET: Depend on the wallet SCA mechanism. For Google Pay this means that MasterCard will shift liability, Visa will not. </br>\n     * FORCE_3DS: Do an additional 3DS step regardless of whether the wallet indicates the token is SCA-compliant.\nenum:\n- NONE\n- WALLET\n- FORCE_3DS",
          "x-gitbook-description-html": "<p>Strong Customer Authentication (SCA) compliance level, possible values <br>\n* NONE: No SCA required. <br>\n* WALLET: Depend on the wallet SCA mechanism. For Google Pay this means that MasterCard will shift liability, Visa will not. <br>\n* FORCE_3DS: Do an additional 3DS step regardless of whether the wallet indicates the token is SCA-compliant.\nenum:</p>\n<ul>\n<li>NONE</li>\n<li>WALLET</li>\n<li>FORCE_3DS</li>\n</ul>"
        },
        "threed_secure": {
          "$ref": "#/x-alt-definitions/threed_secure_duplicate"
        },
        "authorization_type": {
          "type": "string",
          "description": "Card Authorization Type (PRE_AUTH, FINAL_AUTH).  When capture now is set to true pre-authorization transactions cannot be done.",
          "default": "FINAL_AUTH",
          "x-gitbook-description-html": "<p>Card Authorization Type (PRE_AUTH, FINAL_AUTH).  When capture now is set to true pre-authorization transactions cannot be done.</p>"
        },
        "shopper_interaction": {
          "$ref": "#/components/schemas/shopper_interaction"
        },
        "payment_contract_id": {
          "type": "string",
          "description": "This parameter can be found in the portal on the Payment Provider Contract attached to your organization or given to you by a OnlinePay employee. It is used to retrieve MID and other merchant configurations necessary for a card payment.",
          "x-format": {
            "guid": true
          },
          "required": [
            "payment_contract_id"
          ],
          "x-alternatives": [
            {
              "type": "string",
              "description": "This parameter can be found in the portal on the Payment Provider Contract attached to your organization or given to you by a OnlinePay employee. It is used to retrieve MID and other merchant configurations necessary for a card payment.",
              "x-format": {
                "guid": true
              },
              "x-gitbook-description-html": "<p>This parameter can be found in the portal on the Payment Provider Contract attached to your organization or given to you by a OnlinePay employee. It is used to retrieve MID and other merchant configurations necessary for a card payment.</p>"
            },
            {
              "$ref": "#/x-alt-definitions/paymentContractIdDef"
            }
          ],
          "x-gitbook-description-html": "<p>This parameter can be found in the portal on the Payment Provider Contract attached to your organization or given to you by a OnlinePay employee. It is used to retrieve MID and other merchant configurations necessary for a card payment.</p>"
        },
        "token_preference": {
          "$ref": "#/x-alt-definitions/token_preference"
        }
      },
      "required": [
        "sca_compliance_level",
        "threed_secure",
        "payment_contract_id"
      ]
    },
    "Model18": {
      "type": "object",
      "properties": {
        "sca_compliance_level": {
          "type": "string",
          "enum": [
            "NONE",
            "WALLET"
          ]
        },
        "authorization_type": {
          "type": "string",
          "description": "Card Authorization Type (PRE_AUTH, FINAL_AUTH).  When capture now is set to true pre-authorization transactions cannot be done.",
          "default": "FINAL_AUTH",
          "x-gitbook-description-html": "<p>Card Authorization Type (PRE_AUTH, FINAL_AUTH).  When capture now is set to true pre-authorization transactions cannot be done.</p>"
        },
        "shopper_interaction": {
          "$ref": "#/components/schemas/shopper_interaction"
        },
        "payment_contract_id": {
          "type": "string",
          "description": "This parameter can be found in the portal on the Payment Provider Contract attached to your organization or given to you by a OnlinePay employee. It is used to retrieve MID and other merchant configurations necessary for a card payment.",
          "x-format": {
            "guid": true
          },
          "required": [
            "payment_contract_id"
          ],
          "x-alternatives": [
            {
              "type": "string",
              "description": "This parameter can be found in the portal on the Payment Provider Contract attached to your organization or given to you by a OnlinePay employee. It is used to retrieve MID and other merchant configurations necessary for a card payment.",
              "x-format": {
                "guid": true
              },
              "x-gitbook-description-html": "<p>This parameter can be found in the portal on the Payment Provider Contract attached to your organization or given to you by a OnlinePay employee. It is used to retrieve MID and other merchant configurations necessary for a card payment.</p>"
            },
            {
              "$ref": "#/x-alt-definitions/paymentContractIdDef"
            }
          ],
          "x-gitbook-description-html": "<p>This parameter can be found in the portal on the Payment Provider Contract attached to your organization or given to you by a OnlinePay employee. It is used to retrieve MID and other merchant configurations necessary for a card payment.</p>"
        },
        "token_preference": {
          "$ref": "#/x-alt-definitions/token_preference"
        }
      },
      "required": [
        "payment_contract_id"
      ]
    },
    "Model19": {
      "type": "object",
      "properties": {
        "sca_compliance_level": {
          "type": "string",
          "description": "Strong Customer Authentication (SCA) compliance level, possible values </br>\n     * NONE: No SCA required. </br>\n     * WALLET: Depend on the wallet SCA mechanism. For Google Pay this means that MasterCard will shift liability, Visa will not. </br>\n     * FORCE_3DS: Do an additional 3DS step regardless of whether the wallet indicates the token is SCA-compliant.\nenum:\n- NONE\n- WALLET\n- FORCE_3DS",
          "x-gitbook-description-html": "<p>Strong Customer Authentication (SCA) compliance level, possible values <br>\n* NONE: No SCA required. <br>\n* WALLET: Depend on the wallet SCA mechanism. For Google Pay this means that MasterCard will shift liability, Visa will not. <br>\n* FORCE_3DS: Do an additional 3DS step regardless of whether the wallet indicates the token is SCA-compliant.\nenum:</p>\n<ul>\n<li>NONE</li>\n<li>WALLET</li>\n<li>FORCE_3DS</li>\n</ul>"
        },
        "threed_secure": {
          "$ref": "#/x-alt-definitions/threed_secure_duplicate"
        },
        "authorization_type": {
          "type": "string",
          "description": "Card Authorization Type (PRE_AUTH, FINAL_AUTH).  When capture now is set to true pre-authorization transactions cannot be done.",
          "default": "FINAL_AUTH",
          "x-gitbook-description-html": "<p>Card Authorization Type (PRE_AUTH, FINAL_AUTH).  When capture now is set to true pre-authorization transactions cannot be done.</p>"
        }
      },
      "required": [
        "sca_compliance_level",
        "threed_secure"
      ]
    },
    "Model20": {
      "type": "object",
      "properties": {
        "sca_compliance_level": {
          "type": "string",
          "description": "Strong Customer Authentication (SCA) compliance level, possible values </br>\n     * NONE: No SCA required. </br>\n     * WALLET: Depend on the wallet SCA mechanism. For Google Pay this means that MasterCard will shift liability, Visa will not. </br>\n     * FORCE_3DS: Do an additional 3DS step regardless of whether the wallet indicates the token is SCA-compliant.\nenum:\n- NONE\n- WALLET\n- FORCE_3DS",
          "x-gitbook-description-html": "<p>Strong Customer Authentication (SCA) compliance level, possible values <br>\n* NONE: No SCA required. <br>\n* WALLET: Depend on the wallet SCA mechanism. For Google Pay this means that MasterCard will shift liability, Visa will not. <br>\n* FORCE_3DS: Do an additional 3DS step regardless of whether the wallet indicates the token is SCA-compliant.\nenum:</p>\n<ul>\n<li>NONE</li>\n<li>WALLET</li>\n<li>FORCE_3DS</li>\n</ul>"
        },
        "authorization_type": {
          "type": "string",
          "description": "Card Authorization Type (PRE_AUTH, FINAL_AUTH).  When capture now is set to true pre-authorization transactions cannot be done.",
          "default": "FINAL_AUTH",
          "x-gitbook-description-html": "<p>Card Authorization Type (PRE_AUTH, FINAL_AUTH).  When capture now is set to true pre-authorization transactions cannot be done.</p>"
        }
      },
      "required": [
        "sca_compliance_level"
      ]
    },
    "Model21": {
      "type": "object",
      "properties": {
        "image_url": {
          "type": "string",
          "description": "Image URL for the line item",
          "maxLength": 2000,
          "x-format": {
            "uri": true
          },
          "x-gitbook-description-html": "<p>Image URL for the line item</p>"
        },
        "item_url": {
          "type": "string",
          "description": "Item URL for the line item",
          "maxLength": 2000,
          "x-format": {
            "uri": true
          },
          "x-gitbook-description-html": "<p>Item URL for the line item</p>"
        },
        "name": {
          "type": "string",
          "description": "Descriptive name of the order line item",
          "maxLength": 255,
          "x-gitbook-description-html": "<p>Descriptive name of the order line item</p>"
        },
        "quantity": {
          "type": "integer",
          "default": 1,
          "description": "Quantity of the order line item",
          "x-gitbook-description-html": "<p>Quantity of the order line item</p>"
        },
        "unit_price": {
          "type": "number",
          "description": "Unit Price",
          "x-gitbook-description-html": "<p>Unit Price</p>"
        },
        "unit_price_tax": {
          "type": "number",
          "description": "Unit Price Tax",
          "x-gitbook-description-html": "<p>Unit Price Tax</p>"
        },
        "tax_rate": {
          "type": "number",
          "description": "Additional details specific to this type of event",
          "x-gitbook-description-html": "<p>Additional details specific to this type of event</p>"
        },
        "total_tax_amount": {
          "type": "number",
          "description": "Total tax amount",
          "x-gitbook-description-html": "<p>Total tax amount</p>"
        },
        "total_amount": {
          "type": "number",
          "description": "Total Amount",
          "x-gitbook-description-html": "<p>Total Amount</p>"
        },
        "sku": {
          "type": "string",
          "description": "The stock keeping unit (SKU) for the item.",
          "maxLength": 127,
          "x-gitbook-description-html": "<p>The stock keeping unit (SKU) for the item.</p>"
        },
        "description": {
          "type": "string",
          "description": "The detailed item description.",
          "maxLength": 127,
          "x-gitbook-description-html": "<p>The detailed item description.</p>"
        },
        "category": {
          "type": "string",
          "description": "The item category type. <br />  The possible values are: <br />  * DIGITAL_GOODS - Goods that are stored, delivered, and used in their electronic format. This value is not currently supported for API callers that leverage the [PayPal for Commerce Platform](https://www.paypal.com/us/webapps/mpp/commerce-platform) product. <br />  * DIGITAL_GOODS - A tangible item that can be shipped with proof of delivery. <br />",
          "enum": [
            "DIGITAL_GOODS",
            "PHYSICAL_GOODS"
          ],
          "x-gitbook-description-html": "<p>The item category type. <br>  The possible values are: <br>  * DIGITAL_GOODS - Goods that are stored, delivered, and used in their electronic format. This value is not currently supported for API callers that leverage the <a href=\"https://www.paypal.com/us/webapps/mpp/commerce-platform\">PayPal for Commerce Platform</a> product. <br>  * DIGITAL_GOODS - A tangible item that can be shipped with proof of delivery. <br></p>"
        }
      },
      "required": [
        "name",
        "quantity",
        "unit_price",
        "tax_rate",
        "total_tax_amount",
        "total_amount"
      ]
    },
    "line_items": {
      "description": "List of shopping cart items, to be displayed on the page. Read <a target=\"_blank\" href=\"https://docs.verifone.com/online-payments/checkout/line-items\">Line items</a> for details.",
      "type": "array",
      "items": {
        "$ref": "#/x-alt-definitions/Model21"
      },
      "x-gitbook-description-html": "<p>List of shopping cart items, to be displayed on the page. Read <a href=\"https://docs.verifone.com/online-payments/checkout/line-items\">Line items</a> for details.</p>"
    },
    "Model22": {
      "type": "object",
      "properties": {
        "image_url": {
          "type": "string",
          "description": "Image URL for the line item",
          "maxLength": 2000,
          "x-format": {
            "uri": true
          },
          "x-gitbook-description-html": "<p>Image URL for the line item</p>"
        },
        "item_url": {
          "type": "string",
          "description": "Item URL for the line item",
          "maxLength": 2000,
          "x-format": {
            "uri": true
          },
          "x-gitbook-description-html": "<p>Item URL for the line item</p>"
        },
        "name": {
          "type": "string",
          "description": "Descriptive name of the order line item",
          "maxLength": 255,
          "x-gitbook-description-html": "<p>Descriptive name of the order line item</p>"
        },
        "quantity": {
          "type": "integer",
          "default": 1,
          "description": "Quantity of the order line item",
          "x-gitbook-description-html": "<p>Quantity of the order line item</p>"
        },
        "unit_price": {
          "type": "number",
          "description": "Unit Price",
          "x-gitbook-description-html": "<p>Unit Price</p>"
        },
        "unit_price_tax": {
          "type": "number",
          "description": "Unit Price Tax",
          "x-gitbook-description-html": "<p>Unit Price Tax</p>"
        },
        "tax_rate": {
          "type": "number",
          "description": "Additional details specific to this type of event",
          "x-gitbook-description-html": "<p>Additional details specific to this type of event</p>"
        },
        "total_tax_amount": {
          "type": "number",
          "description": "Total tax amount",
          "x-gitbook-description-html": "<p>Total tax amount</p>"
        },
        "total_amount": {
          "type": "number",
          "description": "Total Amount",
          "x-gitbook-description-html": "<p>Total Amount</p>"
        },
        "sku": {
          "type": "string",
          "description": "The stock keeping unit (SKU) for the item.",
          "maxLength": 127,
          "x-gitbook-description-html": "<p>The stock keeping unit (SKU) for the item.</p>"
        },
        "description": {
          "type": "string",
          "description": "The detailed item description.",
          "maxLength": 127,
          "x-gitbook-description-html": "<p>The detailed item description.</p>"
        },
        "category": {
          "type": "string",
          "description": "The item category type. <br />  The possible values are: <br />  * DIGITAL_GOODS - Goods that are stored, delivered, and used in their electronic format. This value is not currently supported for API callers that leverage the [PayPal for Commerce Platform](https://www.paypal.com/us/webapps/mpp/commerce-platform) product. <br />  * DIGITAL_GOODS - A tangible item that can be shipped with proof of delivery. <br />",
          "enum": [
            "DIGITAL_GOODS",
            "PHYSICAL_GOODS"
          ],
          "x-gitbook-description-html": "<p>The item category type. <br>  The possible values are: <br>  * DIGITAL_GOODS - Goods that are stored, delivered, and used in their electronic format. This value is not currently supported for API callers that leverage the <a href=\"https://www.paypal.com/us/webapps/mpp/commerce-platform\">PayPal for Commerce Platform</a> product. <br>  * DIGITAL_GOODS - A tangible item that can be shipped with proof of delivery. <br></p>"
        }
      },
      "required": [
        "name",
        "unit_price",
        "total_amount"
      ]
    },
    "Model23": {
      "type": "array",
      "items": {
        "$ref": "#/x-alt-definitions/Model22"
      }
    }
  }
}
```