Shift4 Payments

Shift4 Payments Checkout Sessions API

Create hosted checkout sessions for drop-in payment acceptance.

Documentation GitHub OpenAPI

Operations 2

POST /checkout/sessions Create a Checkout Session #

GET /checkout/sessions/{sessionId} Retrieve a Checkout Session #

Work with this as data

Every API 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 apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
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 API

curl "https://apis.io/api/v1/apis/shift4-payments-checkout-sessions-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

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

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: Shift4 Payments Checkout Sessions API
  description: The Shift4 Payments API enables merchants and platforms to accept and manage payments, including one-time charges, refunds, customers, cards, tokenization, subscriptions, plans, payment methods, payment links, checkout sessions, fraud warnings, blacklist rules, disputes, file uploads, payouts, webhook endpoints, and events.
  version: '1.0'
  contact:
    name: Shift4 Developer Support
    email: devsupport@shift4.com
    url: https://dev.shift4.com
  license:
    name: Documentation
    url: https://dev.shift4.com/docs
servers:
- url: https://api.shift4.com
  description: Production
security:
- BasicAuth: []
tags:
- name: Checkout Sessions
  description: Create hosted checkout sessions for drop-in payment acceptance.
paths:
  /checkout/sessions:
    post:
      tags:
      - Checkout Sessions
      summary: Create a Checkout Session
      operationId: createCheckoutSession
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckoutSessionRequest'
      responses:
        '200':
          description: Checkout session created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckoutSession'
  /checkout/sessions/{sessionId}:
    parameters:
    - name: sessionId
      in: path
      required: true
      schema:
        type: string
    get:
      tags:
      - Checkout Sessions
      summary: Retrieve a Checkout Session
      operationId: getCheckoutSession
      responses:
        '200':
          description: A checkout session object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckoutSession'
components:
  schemas:
    LineItemRequest:
      type: object
      properties:
        name:
          type: string
        description:
          type: string
        quantity:
          type: integer
          minimum: 1
        unitAmount:
          type: integer
          minimum: 1
        currency:
          type: string
    LineItem:
      type: object
      properties:
        name:
          type: string
        description:
          type: string
        quantity:
          type: integer
        unitAmount:
          type: integer
        currency:
          type: string
    CheckoutSession:
      type: object
      properties:
        id:
          type: string
        lastCharge:
          type: string
        paymentLink:
          type: string
        invoice:
          type: string
        customer:
          type: string
        clientSecret:
          type: string
        lineItems:
          type: array
          items:
            $ref: '#/components/schemas/LineItem'
        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
        vendorReference:
          type: string
    CheckoutSessionRequest:
      type: object
      properties:
        lineItems:
          type: array
          items:
            $ref: '#/components/schemas/LineItemRequest'
        currency:
          type: string
        locale:
          type: string
        collectBillingAddress:
          type: boolean
        collectShippingAddress:
          type: boolean
        allowSavedCards:
          type: boolean
        capture:
          type: boolean
          default: true
        action:
          type: string
          enum:
          - payment
          - setup
          - subscription
        redirectUrl:
          type: string
          format: uri
        metadata:
          type: object
          additionalProperties:
            type: string
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
      description: Use your secret API key as the username with an empty password.

Shift4 Payments Checkout Sessions API

Operations 2

Documentation

Specifications

Schemas & Data

Other Resources