How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Shift4 Payments Charges API

Create, retrieve, update, capture, and list charges.

Shift4 Payments Charges API is one of 20 APIs that Shift4 Payments publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 9 JSON Schema definitions.

Tagged areas include Charges. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a JSON-LD context, and 9 JSON Schemas.

This API exposes 5 operations across 3 paths, and defines 14 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://api.shift4.com.

5 operations 3 paths 14 schemas 2 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.shift4.com
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

Shift4 Payments Charges API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (BasicAuth). By default, every request must be authenticated.

  • BasicAuth — Use your secret API key as the username with an empty password.

Paths & Operations 5

Across 3 paths, the API surfaces 5 operations — 2 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Charges 5

Create, retrieve, update, capture, and list charges.

POST
/charges
Create a Charge
createCharge body → 200default
GET
/charges
List Charges
listCharges 3 params → 200
GET
/charges/{chargeId}
Retrieve a Charge
getCharge 1 param → 200
POST
/charges/{chargeId}
Update a Charge
updateCharge 1 param body → 200
POST
/charges/{chargeId}/capture
Capture a Charge
captureCharge 1 param body → 200

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are Charge (24 properties), Card (21 properties), PaymentMethod (13 properties), CardRequest (11 properties). Each schema is shown below with its type and property counts.

Billing
object
4 properties
ListResponseCharge
object
3 properties
CardRequest
object
11 properties
Address
object
6 properties
CaptureRequest
object
1 property
Shipping
object
4 properties
Card
object
21 properties
ChargeRequest
object
10 properties 2 required
ChargeUpdateRequest
object
2 properties
ErrorResponse
object
1 property
Charge
object
24 properties
Refund
object
8 properties
PaymentMethod
object
13 properties
ChargeList

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

shift4-payments-charges-api-openapi.yml Raw ↑

Other APIs Shift4 Payments publishes across the network.

Shift4 Checkout
Shift4 JavaScript Library
Shift4 Payments Blacklist API
Shift4 Payments Cards API
Shift4 Payments Checkout Sessions API
Shift4 Payments Credits API
Shift4 Payments Customers API
Shift4 Payments Disputes API
Shift4 Payments Events API
Shift4 Payments File Uploads API
Shift4 Payments Fraud Warnings API
Shift4 Payments Payment Links API
Where this information came from

This is an independent, third-party profile of Shift4 Payments Charges API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.