Shift4 Payments · Schema

Shift4 Charge

A Shift4 charge resource. Source: shift4-java SDK Charge response model and dev.shift4.com/docs/api.

PaymentsFintechCommerceCheckout

Properties

Name Type Description
id string
clientObjectId string
created integer Unix timestamp (seconds).
amount integer Amount in smallest currency unit.
amountRefunded integer
currency string ISO 4217 currency code.
description string
status string
type string
captured boolean
refunded boolean
disputed boolean
customerId string
subscriptionId string
merchantAccountId string
metadata object
failureCode string
failureIssuerDeclineCode string
failureMessage string
View JSON Schema on GitHub

JSON Schema

shift4-charge-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/shift4-payments/json-schema/shift4-charge-schema.json",
  "title": "Shift4 Charge",
  "description": "A Shift4 charge resource. Source: shift4-java SDK Charge response model and dev.shift4.com/docs/api.",
  "type": "object",
  "properties": {
    "id": { "type": "string" },
    "clientObjectId": { "type": "string" },
    "created": { "type": "integer", "description": "Unix timestamp (seconds)." },
    "amount": { "type": "integer", "description": "Amount in smallest currency unit." },
    "amountRefunded": { "type": "integer" },
    "currency": { "type": "string", "description": "ISO 4217 currency code." },
    "description": { "type": "string" },
    "status": { "type": "string", "enum": ["SUCCESSFUL", "FAILED", "PENDING"] },
    "type": { "type": "string", "enum": ["FIRST_RECURRING", "SUBSEQUENT_RECURRING", "CARDHOLDER_INITIATED", "MERCHANT_INITIATED"] },
    "captured": { "type": "boolean" },
    "refunded": { "type": "boolean" },
    "disputed": { "type": "boolean" },
    "customerId": { "type": "string" },
    "subscriptionId": { "type": "string" },
    "merchantAccountId": { "type": "string" },
    "metadata": { "type": "object", "additionalProperties": { "type": "string" } },
    "failureCode": { "type": "string" },
    "failureIssuerDeclineCode": { "type": "string" },
    "failureMessage": { "type": "string" }
  },
  "required": ["id", "amount", "currency", "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-charge"
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 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.