Shift4 Payments · Schema

Shift4 Checkout Session

A Shift4 hosted checkout session. Source: shift4-java SDK CheckoutSession response model.

PaymentsFintechCommerceCheckout

Properties

Name Type Description
id string
lastCharge string
paymentLink string
invoice string
customer string
clientSecret string
metadata object
locale string
collectBillingAddress boolean
collectShippingAddress boolean
capture boolean
captchaRequired boolean
status string
allowSavedCards boolean
action string
currency string
url string
redirectUrl string
View JSON Schema on GitHub

JSON Schema

shift4-checkout-session-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/shift4-payments/json-schema/shift4-checkout-session-schema.json",
  "title": "Shift4 Checkout Session",
  "description": "A Shift4 hosted checkout session. Source: shift4-java SDK CheckoutSession response model.",
  "type": "object",
  "properties": {
    "id": { "type": "string" },
    "lastCharge": { "type": "string" },
    "paymentLink": { "type": "string" },
    "invoice": { "type": "string" },
    "customer": { "type": "string" },
    "clientSecret": { "type": "string" },
    "metadata": { "type": "object", "additionalProperties": { "type": "string" } },
    "locale": { "type": "string" },
    "collectBillingAddress": { "type": "boolean" },
    "collectShippingAddress": { "type": "boolean" },
    "capture": { "type": "boolean" },
    "captchaRequired": { "type": "boolean" },
    "status": { "type": "string", "enum": ["OPEN", "COMPLETED", "EXPIRED"] },
    "allowSavedCards": { "type": "boolean" },
    "action": { "type": "string", "enum": ["PAYMENT", "SETUP", "SUBSCRIPTION"] },
    "currency": { "type": "string" },
    "url": { "type": "string", "format": "uri" },
    "redirectUrl": { "type": "string", "format": "uri" }
  },
  "required": ["id", "status"]
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/shift4-checkout-session"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

A second provider on the same verified email joins the account you already have.