Verifone · Schema

CreateTemplateRequest

CheckoutTemplate from Checkout API

PaymentsPOSTerminal ManagementeCommerceFinTechPayment ProcessingOmnichannel

Properties

Name	Type	Description
name	string
entity_id	string	Entity Id can be located on the organization level as Organization ID (Administration > Organizations > [Organization] > Organisation ID value)
billing_is_same_as_shipping	boolean	Indicates whether billing address is same as shipping address or not.
shipping_first_billing_second	boolean	Indicates the order of addresses in which the merchant wants to collect the information from the customer.
field_settings	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/verifone/refs/heads/main/json-schema/checkout-api-checkouttemplate.json",
  "title": "CreateTemplateRequest",
  "description": "CheckoutTemplate from Checkout API",
  "required": [
    "name"
  ],
  "type": "object",
  "properties": {
    "name": {
      "maxLength": 255,
      "type": "string"
    },
    "entity_id": {
      "type": "string",
      "description": "Entity Id can be located on the organization level as Organization ID (Administration > Organizations > [Organization] > Organisation ID value)"
    },
    "billing_is_same_as_shipping": {
      "type": "boolean",
      "default": true,
      "description": "Indicates whether billing address is same as shipping address or not."
    },
    "shipping_first_billing_second": {
      "type": "boolean",
      "default": false,
      "description": "Indicates the order of addresses in which the merchant wants to collect the information from the customer."
    },
    "field_settings": {
      "type": "object",
      "properties": {
        "billing": {
          "$ref": "#/components/schemas/address_details"
        },
        "company_name": {
          "$ref": "#/components/schemas/template_field_mode"
        },
        "company_registration_number": {
          "$ref": "#/components/schemas/template_field_mode"
        },
        "email_address": {
          "$ref": "#/components/schemas/template_field_mode"
        },
        "entity_id": {
          "$ref": "#/components/schemas/template_field_mode"
        },
        "phone_number": {
          "$ref": "#/components/schemas/template_field_mode"
        },
        "shipping": {
          "$ref": "#/components/schemas/address_details"
        },
        "title": {
          "$ref": "#/components/schemas/template_field_mode"
        },
        "work_phone": {
          "$ref": "#/components/schemas/template_field_mode"
        },
        "tax": {
          "type": "object",
          "properties": {
            "identifier": {
              "$ref": "#/components/schemas/template_field_mode"
            }
          }
        }
      }
    }
  }
}