Lithic · Schema

Point of Sale Terminal

FinTechBaaSCard IssuingPaymentsEmbedded Finance

Properties

Name Type Description
attended boolean True if a clerk is present at the sale.
card_retention_capable boolean True if the terminal is capable of retaining the card.
on_premise boolean True if the sale was made at the place of business (vs. mobile).
operator string The person that is designated to swipe the card
partial_approval_capable boolean True if the terminal is capable of partial approval. Partial approval is when part of a transaction is approved and another payment must be used for the remainder. Example scenario: A $40 transaction
pin_capability string Status of whether the POS is able to accept PINs
acceptor_terminal_id stringnull Uniquely identifies a terminal at the card acceptor location of acquiring institutions or merchant POS Systems
type string POS Type
View JSON Schema on GitHub

JSON Schema

lithic-pos-terminal-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/pos_terminal",
  "title": "Point of Sale Terminal",
  "type": "object",
  "properties": {
    "attended": {
      "description": "True if a clerk is present at the sale.",
      "type": "boolean"
    },
    "card_retention_capable": {
      "description": "True if the terminal is capable of retaining the card.",
      "type": "boolean"
    },
    "on_premise": {
      "description": "True if the sale was made at the place of business (vs. mobile).",
      "type": "boolean"
    },
    "operator": {
      "description": "The person that is designated to swipe the card",
      "enum": [
        "ADMINISTRATIVE",
        "CARDHOLDER",
        "CARD_ACCEPTOR",
        "UNKNOWN"
      ],
      "type": "string"
    },
    "partial_approval_capable": {
      "type": "boolean",
      "description": "True if the terminal is capable of partial approval. Partial approval is when part of a transaction is approved and another payment must be used for the remainder. Example scenario: A $40 transaction is attempted on a prepaid card with a $25 balance. If partial approval is enabled, $25 can be authorized, at which point the POS will prompt the user for an additional payment of $15."
    },
    "pin_capability": {
      "description": "Status of whether the POS is able to accept PINs",
      "enum": [
        "CAPABLE",
        "INOPERATIVE",
        "NOT_CAPABLE",
        "UNSPECIFIED"
      ],
      "type": "string"
    },
    "acceptor_terminal_id": {
      "description": "Uniquely identifies a terminal at the card acceptor location of acquiring institutions or merchant POS Systems",
      "type": [
        "string",
        "null"
      ]
    },
    "type": {
      "description": "POS Type",
      "enum": [
        "ADMINISTRATIVE",
        "ATM",
        "AUTHORIZATION",
        "COUPON_MACHINE",
        "DIAL_TERMINAL",
        "ECOMMERCE",
        "ECR",
        "FUEL_MACHINE",
        "HOME_TERMINAL",
        "MICR",
        "OFF_PREMISE",
        "PAYMENT",
        "PDA",
        "PHONE",
        "POINT",
        "POS_TERMINAL",
        "PUBLIC_UTILITY",
        "SELF_SERVICE",
        "TELEVISION",
        "TELLER",
        "TRAVELERS_CHECK_MACHINE",
        "VENDING",
        "VOICE",
        "UNKNOWN"
      ],
      "type": "string"
    }
  },
  "required": [
    "attended",
    "card_retention_capable",
    "on_premise",
    "operator",
    "partial_approval_capable",
    "pin_capability",
    "type"
  ]
}