Shift4 Payments

Shift4 Payments Charges API

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

GitHub OpenAPI

Operations 5

POST /charges Create a Charge #
GET /charges List Charges #
GET /charges/{chargeId} Retrieve a Charge #
POST /charges/{chargeId} Update a Charge #
POST /charges/{chargeId}/capture Capture a Charge #

Documentation

📖
Documentation
https://dev.shift4.com/docs
📖
APIReference
https://dev.shift4.com/docs/api

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/shift4-payments/refs/heads/main/openapi/shift4-payments-charges-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shift4-payments/main/json-schema/shift4-charge-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shift4-payments/main/json-schema/shift4-customer-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shift4-payments/main/json-schema/shift4-card-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shift4-payments/main/json-schema/shift4-token-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shift4-payments/main/json-schema/shift4-subscription-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shift4-payments/main/json-schema/shift4-plan-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shift4-payments/main/json-schema/shift4-refund-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shift4-payments/main/json-schema/shift4-event-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shift4-payments/main/json-schema/shift4-checkout-session-schema.json

Other Resources

🔗
Sandbox
https://dev.shift4.com/docs
🔗
SDKs
https://github.com/shift4developer/shift4-java
🔗
SDKs
https://github.com/shift4developer/shift4-node
🔗
SDKs
https://github.com/shift4developer/shift4-python
🔗
SDKs
https://github.com/shift4developer/shift4-ruby
🔗
SDKs
https://github.com/shift4developer/shift4-php
🔗
SDKs
https://github.com/shift4developer/shift4-net
🔗
SDKs
https://github.com/shift4developer/shift4-ios
🔗
SDKs
https://github.com/shift4developer/shift4-android
🔗
SpectralRules
https://raw.githubusercontent.com/api-evangelist/shift4-payments/main/rules/shift4-api-rules.yml
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/shift4-payments/main/json-ld/shift4-payments-context.jsonld

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-charges-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

shift4-payments-charges-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Shift4 Payments Charges 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: Charges
  description: Create, retrieve, update, capture, and list charges.
paths:
  /charges:
    post:
      tags:
      - Charges
      summary: Create a Charge
      operationId: createCharge
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChargeRequest'
      responses:
        '200':
          description: Charge created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Charge'
        default:
          $ref: '#/components/responses/ErrorResponse'
    get:
      tags:
      - Charges
      summary: List Charges
      operationId: listCharges
      parameters:
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/StartingAfter'
      - $ref: '#/components/parameters/EndingBefore'
      responses:
        '200':
          description: A list of charges.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChargeList'
  /charges/{chargeId}:
    parameters:
    - name: chargeId
      in: path
      required: true
      schema:
        type: string
    get:
      tags:
      - Charges
      summary: Retrieve a Charge
      operationId: getCharge
      responses:
        '200':
          description: A charge object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Charge'
    post:
      tags:
      - Charges
      summary: Update a Charge
      operationId: updateCharge
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChargeUpdateRequest'
      responses:
        '200':
          description: Updated charge.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Charge'
  /charges/{chargeId}/capture:
    parameters:
    - name: chargeId
      in: path
      required: true
      schema:
        type: string
    post:
      tags:
      - Charges
      summary: Capture a Charge
      operationId: captureCharge
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CaptureRequest'
      responses:
        '200':
          description: Captured charge.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Charge'
components:
  schemas:
    ChargeList:
      $ref: '#/components/schemas/ListResponseCharge'
    Billing:
      type: object
      properties:
        name:
          type: string
        email:
          type: string
          format: email
        address:
          $ref: '#/components/schemas/Address'
        vatNumber:
          type: string
    CaptureRequest:
      type: object
      properties:
        amount:
          type: integer
          minimum: 1
    ChargeRequest:
      type: object
      required:
      - amount
      - currency
      properties:
        amount:
          type: integer
          minimum: 1
        currency:
          type: string
        description:
          type: string
        captured:
          type: boolean
          default: true
        customerId:
          type: string
        cardId:
          type: string
        card:
          oneOf:
          - $ref: '#/components/schemas/CardRequest'
          - type: string
            description: A token id (tok_...).
        billing:
          $ref: '#/components/schemas/Billing'
        shipping:
          $ref: '#/components/schemas/Shipping'
        metadata:
          type: object
          additionalProperties:
            type: string
    PaymentMethod:
      type: object
      properties:
        id:
          type: string
        customerId:
          type: string
        clientObjectId:
          type: string
        created:
          type: integer
          format: int64
        type:
          type: string
          enum:
          - CARD
          - APPLE_PAY
          - GOOGLE_PAY
          - THREE_D_SECURE
          - IDEAL
          - P24
          - EPS
          - BANCONTACT
          - GIROPAY
          - MULTIBANCO
          - SOFORT
          - BLIK
          - BLIK_REDIRECT
          - OTHER
        status:
          type: string
          enum:
          - REQUIRES_ACTION
          - CHARGEABLE
          - USED
          - DELETED
          - FAILED
        deleted:
          type: boolean
        billing:
          $ref: '#/components/schemas/Billing'
        applePay:
          type: object
          properties:
            cardBrand:
              type: string
            cardType:
              type: string
            first6:
              type: string
            last4:
              type: string
            amount:
              type: integer
            currency:
              type: string
            merchantTokenIdentifier:
              type: string
        googlePay:
          type: object
          properties:
            cardBrand:
              type: string
            cardType:
              type: string
            first6:
              type: string
            last4:
              type: string
        threeDSecure:
          type: object
          properties:
            currency:
              type: string
            amount:
              type: integer
        merchantAccountId:
          type: string
        metadata:
          type: object
          additionalProperties:
            type: string
    ChargeUpdateRequest:
      type: object
      properties:
        description:
          type: string
        metadata:
          type: object
          additionalProperties:
            type: string
    Card:
      type: object
      properties:
        id:
          type: string
        created:
          type: integer
          format: int64
          description: Unix timestamp.
        deleted:
          type: boolean
        first6:
          type: string
        last4:
          type: string
        fingerprint:
          type: string
        expMonth:
          type: string
        expYear:
          type: string
        cardholderName:
          type: string
        customerId:
          type: string
        brand:
          type: string
          description: Card brand.
          enum:
          - Visa
          - MasterCard
          - AmericanExpress
          - Discover
          - JCB
          - DinersClub
          - UnionPay
          - Other
        type:
          type: string
          enum:
          - Credit
          - Debit
          - Prepaid
          - Other
        country:
          type: string
        addressLine1:
          type: string
        addressLine2:
          type: string
        addressCity:
          type: string
        addressState:
          type: string
        addressZip:
          type: string
        addressCountry:
          type: string
        issuer:
          type: string
        merchantAccountId:
          type: string
    Address:
      type: object
      properties:
        line1:
          type: string
        line2:
          type: string
        zip:
          type: string
        city:
          type: string
        state:
          type: string
        country:
          type: string
          description: ISO 3166-1 alpha-2 country code.
    Charge:
      type: object
      properties:
        id:
          type: string
        clientObjectId:
          type: string
        created:
          type: integer
          format: int64
        amount:
          type: integer
          description: Smallest currency unit (e.g., cents).
        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
        card:
          $ref: '#/components/schemas/Card'
        paymentMethod:
          $ref: '#/components/schemas/PaymentMethod'
        customerId:
          type: string
        subscriptionId:
          type: string
        captured:
          type: boolean
        refunded:
          type: boolean
        refunds:
          type: array
          items:
            $ref: '#/components/schemas/Refund'
        disputed:
          type: boolean
        shipping:
          $ref: '#/components/schemas/Shipping'
        billing:
          $ref: '#/components/schemas/Billing'
        merchantAccountId:
          type: string
        metadata:
          type: object
          additionalProperties:
            type: string
        failureCode:
          type: string
        failureIssuerDeclineCode:
          type: string
        failureMessage:
          type: string
    CardRequest:
      type: object
      properties:
        cardholderName:
          type: string
        number:
          type: string
        expMonth:
          type: string
        expYear:
          type: string
        cvc:
          type: string
        addressLine1:
          type: string
        addressLine2:
          type: string
        addressCity:
          type: string
        addressState:
          type: string
        addressZip:
          type: string
        addressCountry:
          type: string
    Refund:
      type: object
      properties:
        id:
          type: string
        created:
          type: integer
          format: int64
        amount:
          type: integer
        currency:
          type: string
        charge:
          type: string
        reason:
          type: string
          enum:
          - FRAUDULENT
          - DUPLICATE
          - REQUESTED_BY_CUSTOMER
        status:
          type: string
          enum:
          - SUCCESSFUL
          - FAILED
          - PENDING
        metadata:
          type: object
          additionalProperties:
            type: string
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
              - invalid_request
              - gateway_error
              - processing_error
              - card_error
              - fraud
              - three_d_secure_error
              - blacklist_error
            code:
              type: string
            message:
              type: string
            chargeId:
              type: string
            creditId:
              type: string
            issuerDeclineCode:
              type: string
    ListResponseCharge:
      type: object
      properties:
        list:
          type: array
          items:
            $ref: '#/components/schemas/Charge'
        hasMore:
          type: boolean
        totalCount:
          type: integer
    Shipping:
      type: object
      properties:
        name:
          type: string
        email:
          type: string
          format: email
        phoneNumber:
          type: string
        address:
          $ref: '#/components/schemas/Address'
  parameters:
    StartingAfter:
      name: startingAfter
      in: query
      schema:
        type: string
      description: A cursor for use in pagination.
    EndingBefore:
      name: endingBefore
      in: query
      schema:
        type: string
      description: A cursor for use in pagination.
    Limit:
      name: limit
      in: query
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 10
      description: A limit on the number of objects to be returned.
  responses:
    ErrorResponse:
      description: An error response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
      description: Use your secret API key as the username with an empty password.