---
title: "Create Template"
method: POST
path: "/v2/template/checkoutDetails"
tags: ["Templating"]
---

# Create Template

`POST /v2/template/checkoutDetails`

## Request body

- CheckoutTemplate
  - `name` string, required
  - `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
    - `billing` AddressDetails
      - `address_1` TemplateFieldMode
        - `mode` 'HIDDEN' | 'READ_ONLY' | 'OPTIONAL' | 'REQUIRED'
      - `address_2` TemplateFieldMode
        - `mode` 'HIDDEN' | 'READ_ONLY' | 'OPTIONAL' | 'REQUIRED'
      - `address_3` TemplateFieldMode
        - `mode` 'HIDDEN' | 'READ_ONLY' | 'OPTIONAL' | 'REQUIRED'
      - `city` TemplateFieldMode
        - `mode` 'HIDDEN' | 'READ_ONLY' | 'OPTIONAL' | 'REQUIRED'
      - `country_code` TemplateFieldMode
        - `mode` 'HIDDEN' | 'READ_ONLY' | 'OPTIONAL' | 'REQUIRED'
      - `first_name` TemplateFieldMode
        - `mode` 'HIDDEN' | 'READ_ONLY' | 'OPTIONAL' | 'REQUIRED'
      - `middle_name` TemplateFieldMode
        - `mode` 'HIDDEN' | 'READ_ONLY' | 'OPTIONAL' | 'REQUIRED'
      - `last_name` TemplateFieldMode
        - `mode` 'HIDDEN' | 'READ_ONLY' | 'OPTIONAL' | 'REQUIRED'
      - `phone` TemplateFieldMode
        - `mode` 'HIDDEN' | 'READ_ONLY' | 'OPTIONAL' | 'REQUIRED'
      - `postal_code` TemplateFieldMode
        - `mode` 'HIDDEN' | 'READ_ONLY' | 'OPTIONAL' | 'REQUIRED'
      - `state` TemplateFieldMode
        - `mode` 'HIDDEN' | 'READ_ONLY' | 'OPTIONAL' | 'REQUIRED'
    - `company_name` TemplateFieldMode
      - `mode` 'HIDDEN' | 'READ_ONLY' | 'OPTIONAL' | 'REQUIRED'
    - `company_registration_number` TemplateFieldMode
      - `mode` 'HIDDEN' | 'READ_ONLY' | 'OPTIONAL' | 'REQUIRED'
    - `email_address` TemplateFieldMode
      - `mode` 'HIDDEN' | 'READ_ONLY' | 'OPTIONAL' | 'REQUIRED'
    - `entity_id` TemplateFieldMode
      - `mode` 'HIDDEN' | 'READ_ONLY' | 'OPTIONAL' | 'REQUIRED'
    - `phone_number` TemplateFieldMode
      - `mode` 'HIDDEN' | 'READ_ONLY' | 'OPTIONAL' | 'REQUIRED'
    - `shipping` AddressDetails
      - `address_1` TemplateFieldMode
        - `mode` 'HIDDEN' | 'READ_ONLY' | 'OPTIONAL' | 'REQUIRED'
      - `address_2` TemplateFieldMode
        - `mode` 'HIDDEN' | 'READ_ONLY' | 'OPTIONAL' | 'REQUIRED'
      - `address_3` TemplateFieldMode
        - `mode` 'HIDDEN' | 'READ_ONLY' | 'OPTIONAL' | 'REQUIRED'
      - `city` TemplateFieldMode
        - `mode` 'HIDDEN' | 'READ_ONLY' | 'OPTIONAL' | 'REQUIRED'
      - `country_code` TemplateFieldMode
        - `mode` 'HIDDEN' | 'READ_ONLY' | 'OPTIONAL' | 'REQUIRED'
      - `first_name` TemplateFieldMode
        - `mode` 'HIDDEN' | 'READ_ONLY' | 'OPTIONAL' | 'REQUIRED'
      - `middle_name` TemplateFieldMode
        - `mode` 'HIDDEN' | 'READ_ONLY' | 'OPTIONAL' | 'REQUIRED'
      - `last_name` TemplateFieldMode
        - `mode` 'HIDDEN' | 'READ_ONLY' | 'OPTIONAL' | 'REQUIRED'
      - `phone` TemplateFieldMode
        - `mode` 'HIDDEN' | 'READ_ONLY' | 'OPTIONAL' | 'REQUIRED'
      - `postal_code` TemplateFieldMode
        - `mode` 'HIDDEN' | 'READ_ONLY' | 'OPTIONAL' | 'REQUIRED'
      - `state` TemplateFieldMode
        - `mode` 'HIDDEN' | 'READ_ONLY' | 'OPTIONAL' | 'REQUIRED'
    - `title` TemplateFieldMode
      - `mode` 'HIDDEN' | 'READ_ONLY' | 'OPTIONAL' | 'REQUIRED'
    - `work_phone` TemplateFieldMode
      - `mode` 'HIDDEN' | 'READ_ONLY' | 'OPTIONAL' | 'REQUIRED'
    - `tax` object
      - `identifier` TemplateFieldMode
        - `mode` 'HIDDEN' | 'READ_ONLY' | 'OPTIONAL' | 'REQUIRED'

## Response `200`

Successful

- object
  - `name` string, required
  - `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
    - `billing` AddressDetails
      - `address_1` TemplateFieldMode
        - `mode` 'HIDDEN' | 'READ_ONLY' | 'OPTIONAL' | 'REQUIRED'
      - `address_2` TemplateFieldMode
        - `mode` 'HIDDEN' | 'READ_ONLY' | 'OPTIONAL' | 'REQUIRED'
      - `address_3` TemplateFieldMode
        - `mode` 'HIDDEN' | 'READ_ONLY' | 'OPTIONAL' | 'REQUIRED'
      - `city` TemplateFieldMode
        - `mode` 'HIDDEN' | 'READ_ONLY' | 'OPTIONAL' | 'REQUIRED'
      - `country_code` TemplateFieldMode
        - `mode` 'HIDDEN' | 'READ_ONLY' | 'OPTIONAL' | 'REQUIRED'
      - `first_name` TemplateFieldMode
        - `mode` 'HIDDEN' | 'READ_ONLY' | 'OPTIONAL' | 'REQUIRED'
      - `middle_name` TemplateFieldMode
        - `mode` 'HIDDEN' | 'READ_ONLY' | 'OPTIONAL' | 'REQUIRED'
      - `last_name` TemplateFieldMode
        - `mode` 'HIDDEN' | 'READ_ONLY' | 'OPTIONAL' | 'REQUIRED'
      - `phone` TemplateFieldMode
        - `mode` 'HIDDEN' | 'READ_ONLY' | 'OPTIONAL' | 'REQUIRED'
      - `postal_code` TemplateFieldMode
        - `mode` 'HIDDEN' | 'READ_ONLY' | 'OPTIONAL' | 'REQUIRED'
      - `state` TemplateFieldMode
        - `mode` 'HIDDEN' | 'READ_ONLY' | 'OPTIONAL' | 'REQUIRED'
    - `company_name` TemplateFieldMode
      - `mode` 'HIDDEN' | 'READ_ONLY' | 'OPTIONAL' | 'REQUIRED'
    - `company_registration_number` TemplateFieldMode
      - `mode` 'HIDDEN' | 'READ_ONLY' | 'OPTIONAL' | 'REQUIRED'
    - `email_address` TemplateFieldMode
      - `mode` 'HIDDEN' | 'READ_ONLY' | 'OPTIONAL' | 'REQUIRED'
    - `entity_id` TemplateFieldMode
      - `mode` 'HIDDEN' | 'READ_ONLY' | 'OPTIONAL' | 'REQUIRED'
    - `phone_number` TemplateFieldMode
      - `mode` 'HIDDEN' | 'READ_ONLY' | 'OPTIONAL' | 'REQUIRED'
    - `shipping` AddressDetails
      - `address_1` TemplateFieldMode
        - `mode` 'HIDDEN' | 'READ_ONLY' | 'OPTIONAL' | 'REQUIRED'
      - `address_2` TemplateFieldMode
        - `mode` 'HIDDEN' | 'READ_ONLY' | 'OPTIONAL' | 'REQUIRED'
      - `address_3` TemplateFieldMode
        - `mode` 'HIDDEN' | 'READ_ONLY' | 'OPTIONAL' | 'REQUIRED'
      - `city` TemplateFieldMode
        - `mode` 'HIDDEN' | 'READ_ONLY' | 'OPTIONAL' | 'REQUIRED'
      - `country_code` TemplateFieldMode
        - `mode` 'HIDDEN' | 'READ_ONLY' | 'OPTIONAL' | 'REQUIRED'
      - `first_name` TemplateFieldMode
        - `mode` 'HIDDEN' | 'READ_ONLY' | 'OPTIONAL' | 'REQUIRED'
      - `middle_name` TemplateFieldMode
        - `mode` 'HIDDEN' | 'READ_ONLY' | 'OPTIONAL' | 'REQUIRED'
      - `last_name` TemplateFieldMode
        - `mode` 'HIDDEN' | 'READ_ONLY' | 'OPTIONAL' | 'REQUIRED'
      - `phone` TemplateFieldMode
        - `mode` 'HIDDEN' | 'READ_ONLY' | 'OPTIONAL' | 'REQUIRED'
      - `postal_code` TemplateFieldMode
        - `mode` 'HIDDEN' | 'READ_ONLY' | 'OPTIONAL' | 'REQUIRED'
      - `state` TemplateFieldMode
        - `mode` 'HIDDEN' | 'READ_ONLY' | 'OPTIONAL' | 'REQUIRED'
    - `title` TemplateFieldMode
      - `mode` 'HIDDEN' | 'READ_ONLY' | 'OPTIONAL' | 'REQUIRED'
    - `work_phone` TemplateFieldMode
      - `mode` 'HIDDEN' | 'READ_ONLY' | 'OPTIONAL' | 'REQUIRED'
    - `tax` object
      - `identifier` TemplateFieldMode
        - `mode` 'HIDDEN' | 'READ_ONLY' | 'OPTIONAL' | 'REQUIRED'
  - `id` string
  - `created_at` string, date
  - `updated_at` string, date
  - `status` 'ACTIVE' | 'INACTIVE' — Indicates whether the template is active or not.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `500` — Internal Server Error

---

[API](https://skmtc.net/verifone/apis/checkout-api.md) · [All operations](https://skmtc.net/verifone/apis/checkout-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/verifone/checkout-api/revisions/ed8dc1f12a5a/schema)