Shift4 Payments

Shift4 Payments is a leading integrated payments and commerce technology provider and a Fortune 1000 company. The company processes payments for hospitality, retail, gaming, sports, e-commerce, and other verticals, offering checkout flows, custom payment forms, hosted UI components, and a developer API that supports global payment methods, subscriptions, fraud prevention, and 3D Secure. Developers integrate Shift4 through a REST API, JavaScript library, webhooks, and a sandbox testing environment.
3 APIs 0 Features
PaymentsFintechCommerceCheckout
GitHubOrganization
Sources

opencollection: 1.0.0
info:
  name: Shift4 Payments API
  version: '1.0'
request:
  auth:
    type: basic
    username: '{{username}}'
    password: '{{password}}'
items:
- info:
    name: Charges
    type: folder
  items:
  - info:
      name: List Charges
      type: http
    http:
      method: GET
      url: https://api.shift4.com/charges
      params:
      - name: limit
        value: ''
        type: query
        description: A limit on the number of objects to be returned.
      - name: startingAfter
        value: ''
        type: query
        description: A cursor for use in pagination.
      - name: endingBefore
        value: ''
        type: query
        description: A cursor for use in pagination.
    docs: List Charges
  - info:
      name: Create a Charge
      type: http
    http:
      method: POST
      url: https://api.shift4.com/charges
      body:
        type: json
        data: '{}'
    docs: Create a Charge
  - info:
      name: Retrieve a Charge
      type: http
    http:
      method: GET
      url: https://api.shift4.com/charges/:chargeId
      params:
      - name: chargeId
        value: ''
        type: path
    docs: Retrieve a Charge
  - info:
      name: Update a Charge
      type: http
    http:
      method: POST
      url: https://api.shift4.com/charges/:chargeId
      params:
      - name: chargeId
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Update a Charge
  - info:
      name: Capture a Charge
      type: http
    http:
      method: POST
      url: https://api.shift4.com/charges/:chargeId/capture
      params:
      - name: chargeId
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Capture a Charge
- info:
    name: Refunds
    type: folder
  items:
  - info:
      name: List Refunds
      type: http
    http:
      method: GET
      url: https://api.shift4.com/refunds
      params:
      - name: limit
        value: ''
        type: query
        description: A limit on the number of objects to be returned.
    docs: List Refunds
  - info:
      name: Refund a Charge
      type: http
    http:
      method: POST
      url: https://api.shift4.com/refunds
      body:
        type: json
        data: '{}'
    docs: Refund a Charge
  - info:
      name: Retrieve a Refund
      type: http
    http:
      method: GET
      url: https://api.shift4.com/refunds/:refundId
      params:
      - name: refundId
        value: ''
        type: path
    docs: Retrieve a Refund
  - info:
      name: Update a Refund
      type: http
    http:
      method: POST
      url: https://api.shift4.com/refunds/:refundId
      params:
      - name: refundId
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Update a Refund
- info:
    name: Customers
    type: folder
  items:
  - info:
      name: List Customers
      type: http
    http:
      method: GET
      url: https://api.shift4.com/customers
      params:
      - name: limit
        value: ''
        type: query
        description: A limit on the number of objects to be returned.
    docs: List Customers
  - info:
      name: Create a Customer
      type: http
    http:
      method: POST
      url: https://api.shift4.com/customers
      body:
        type: json
        data: '{}'
    docs: Create a Customer
  - info:
      name: Retrieve a Customer
      type: http
    http:
      method: GET
      url: https://api.shift4.com/customers/:customerId
      params:
      - name: customerId
        value: ''
        type: path
    docs: Retrieve a Customer
  - info:
      name: Update a Customer
      type: http
    http:
      method: POST
      url: https://api.shift4.com/customers/:customerId
      params:
      - name: customerId
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Update a Customer
  - info:
      name: Delete a Customer
      type: http
    http:
      method: DELETE
      url: https://api.shift4.com/customers/:customerId
      params:
      - name: customerId
        value: ''
        type: path
    docs: Delete a Customer
- info:
    name: Cards
    type: folder
  items:
  - info:
      name: List Cards
      type: http
    http:
      method: GET
      url: https://api.shift4.com/customers/:customerId/cards
      params:
      - name: customerId
        value: ''
        type: path
      - name: limit
        value: ''
        type: query
        description: A limit on the number of objects to be returned.
    docs: List Cards
  - info:
      name: Create a Card
      type: http
    http:
      method: POST
      url: https://api.shift4.com/customers/:customerId/cards
      params:
      - name: customerId
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Create a Card
  - info:
      name: Retrieve a Card
      type: http
    http:
      method: GET
      url: https://api.shift4.com/customers/:customerId/cards/:cardId
      params:
      - name: customerId
        value: ''
        type: path
      - name: cardId
        value: ''
        type: path
    docs: Retrieve a Card
  - info:
      name: Update a Card
      type: http
    http:
      method: POST
      url: https://api.shift4.com/customers/:customerId/cards/:cardId
      params:
      - name: customerId
        value: ''
        type: path
      - name: cardId
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Update a Card
  - info:
      name: Delete a Card
      type: http
    http:
      method: DELETE
      url: https://api.shift4.com/customers/:customerId/cards/:cardId
      params:
      - name: customerId
        value: ''
        type: path
      - name: cardId
        value: ''
        type: path
    docs: Delete a Card
- info:
    name: Tokens
    type: folder
  items:
  - info:
      name: Create a Card Token
      type: http
    http:
      method: POST
      url: https://api.shift4.com/tokens
      body:
        type: json
        data: '{}'
    docs: Create a Card Token
- info:
    name: Subscriptions
    type: folder
  items:
  - info:
      name: Create a Subscription
      type: http
    http:
      method: POST
      url: https://api.shift4.com/subscriptions
      body:
        type: json
        data: '{}'
    docs: Create a Subscription
  - info:
      name: Retrieve a Subscription
      type: http
    http:
      method: GET
      url: https://api.shift4.com/subscriptions/:subscriptionId
      params:
      - name: subscriptionId
        value: ''
        type: path
    docs: Retrieve a Subscription
  - info:
      name: Update a Subscription
      type: http
    http:
      method: POST
      url: https://api.shift4.com/subscriptions/:subscriptionId
      params:
      - name: subscriptionId
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Update a Subscription
- info:
    name: Plans
    type: folder
  items:
  - info:
      name: List Plans
      type: http
    http:
      method: GET
      url: https://api.shift4.com/plans
      params:
      - name: limit
        value: ''
        type: query
        description: A limit on the number of objects to be returned.
    docs: List Plans
  - info:
      name: Create a Plan
      type: http
    http:
      method: POST
      url: https://api.shift4.com/plans
      body:
        type: json
        data: '{}'
    docs: Create a Plan
  - info:
      name: Retrieve a Plan
      type: http
    http:
      method: GET
      url: https://api.shift4.com/plans/:planId
      params:
      - name: planId
        value: ''
        type: path
    docs: Retrieve a Plan
  - info:
      name: Update a Plan
      type: http
    http:
      method: POST
      url: https://api.shift4.com/plans/:planId
      params:
      - name: planId
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Update a Plan
- info:
    name: Payment Methods
    type: folder
  items:
  - info:
      name: List Payment Methods
      type: http
    http:
      method: GET
      url: https://api.shift4.com/payment-methods
      params:
      - name: limit
        value: ''
        type: query
        description: A limit on the number of objects to be returned.
    docs: List Payment Methods
  - info:
      name: Create a Payment Method
      type: http
    http:
      method: POST
      url: https://api.shift4.com/payment-methods
      body:
        type: json
        data: '{}'
    docs: Create a Payment Method
  - info:
      name: Retrieve a Payment Method
      type: http
    http:
      method: GET
      url: https://api.shift4.com/payment-methods/:paymentMethodId
      params:
      - name: paymentMethodId
        value: ''
        type: path
    docs: Retrieve a Payment Method
- info:
    name: Payment Links
    type: folder
  items:
  - info:
      name: Create a Payment Link
      type: http
    http:
      method: POST
      url: https://api.shift4.com/payment-links
      body:
        type: json
        data: '{}'
    docs: Create a Payment Link
  - info:
      name: Retrieve a Payment Link
      type: http
    http:
      method: GET
      url: https://api.shift4.com/payment-links/:linkId
      params:
      - name: linkId
        value: ''
        type: path
    docs: Retrieve a Payment Link
- info:
    name: Checkout Sessions
    type: folder
  items:
  - info:
      name: Create a Checkout Session
      type: http
    http:
      method: POST
      url: https://api.shift4.com/checkout/sessions
      body:
        type: json
        data: '{}'
    docs: Create a Checkout Session
  - info:
      name: Retrieve a Checkout Session
      type: http
    http:
      method: GET
      url: https://api.shift4.com/checkout/sessions/:sessionId
      params:
      - name: sessionId
        value: ''
        type: path
    docs: Retrieve a Checkout Session
- info:
    name: Credits
    type: folder
  items:
  - info:
      name: List Credits
      type: http
    http:
      method: GET
      url: https://api.shift4.com/credits
      params:
      - name: limit
        value: ''
        type: query
        description: A limit on the number of objects to be returned.
    docs: List Credits
  - info:
      name: Create a Credit
      type: http
    http:
      method: POST
      url: https://api.shift4.com/credits
      body:
        type: json
        data: '{}'
    docs: Create a Credit
  - info:
      name: Retrieve a Credit
      type: http
    http:
      method: GET
      url: https://api.shift4.com/credits/:creditId
      params:
      - name: creditId
        value: ''
        type: path
    docs: Retrieve a Credit
- info:
    name: Disputes
    type: folder
  items:
  - info:
      name: List Disputes
      type: http
    http:
      method: GET
      url: https://api.shift4.com/disputes
      params:
      - name: limit
        value: ''
        type: query
        description: A limit on the number of objects to be returned.
    docs: List Disputes
  - info:
      name: Retrieve a Dispute
      type: http
    http:
      method: GET
      url: https://api.shift4.com/disputes/:disputeId
      params:
      - name: disputeId
        value: ''
        type: path
    docs: Retrieve a Dispute
- info:
    name: Fraud Warnings
    type: folder
  items:
  - info:
      name: List Fraud Warnings
      type: http
    http:
      method: GET
      url: https://api.shift4.com/fraud-warnings
      params:
      - name: limit
        value: ''
        type: query
        description: A limit on the number of objects to be returned.
    docs: List Fraud Warnings
- info:
    name: Blacklist
    type: folder
  items:
  - info:
      name: List Blacklist Rules
      type: http
    http:
      method: GET
      url: https://api.shift4.com/blacklist
      params:
      - name: limit
        value: ''
        type: query
        description: A limit on the number of objects to be returned.
    docs: List Blacklist Rules
  - info:
      name: Create a Blacklist Rule
      type: http
    http:
      method: POST
      url: https://api.shift4.com/blacklist
      body:
        type: json
        data: '{}'
    docs: Create a Blacklist Rule
  - info:
      name: Retrieve a Blacklist Rule
      type: http
    http:
      method: GET
      url: https://api.shift4.com/blacklist/:ruleId
      params:
      - name: ruleId
        value: ''
        type: path
    docs: Retrieve a Blacklist Rule
  - info:
      name: Update a Blacklist Rule
      type: http
    http:
      method: POST
      url: https://api.shift4.com/blacklist/:ruleId
      params:
      - name: ruleId
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Update a Blacklist Rule
  - info:
      name: Delete a Blacklist Rule
      type: http
    http:
      method: DELETE
      url: https://api.shift4.com/blacklist/:ruleId
      params:
      - name: ruleId
        value: ''
        type: path
    docs: Delete a Blacklist Rule
- info:
    name: File Uploads
    type: folder
  items:
  - info:
      name: Upload a File
      type: http
    http:
      method: POST
      url: https://api.shift4.com/files
      body:
        type: multipart-form
        data:
        - name: file
          type: text
          value: ''
        - name: purpose
          type: text
          value: ''
    docs: Upload a File
- info:
    name: Payouts
    type: folder
  items:
  - info:
      name: List Payouts
      type: http
    http:
      method: GET
      url: https://api.shift4.com/payouts
      params:
      - name: limit
        value: ''
        type: query
        description: A limit on the number of objects to be returned.
    docs: List Payouts
  - info:
      name: Retrieve a Payout
      type: http
    http:
      method: GET
      url: https://api.shift4.com/payouts/:payoutId
      params:
      - name: payoutId
        value: ''
        type: path
    docs: Retrieve a Payout
- info:
    name: Webhook Endpoints
    type: folder
  items:
  - info:
      name: List Webhook Endpoints
      type: http
    http:
      method: GET
      url: https://api.shift4.com/webhook-endpoints
      params:
      - name: limit
        value: ''
        type: query
        description: A limit on the number of objects to be returned.
    docs: List Webhook Endpoints
  - info:
      name: Create a Webhook Endpoint
      type: http
    http:
      method: POST
      url: https://api.shift4.com/webhook-endpoints
      body:
        type: json
        data: '{}'
    docs: Create a Webhook Endpoint
  - info:
      name: Retrieve a Webhook Endpoint
      type: http
    http:
      method: GET
      url: https://api.shift4.com/webhook-endpoints/:endpointId
      params:
      - name: endpointId
        value: ''
        type: path
    docs: Retrieve a Webhook Endpoint
  - info:
      name: Update a Webhook Endpoint
      type: http
    http:
      method: POST
      url: https://api.shift4.com/webhook-endpoints/:endpointId
      params:
      - name: endpointId
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Update a Webhook Endpoint
- info:
    name: Events
    type: folder
  items:
  - info:
      name: List Events
      type: http
    http:
      method: GET
      url: https://api.shift4.com/events
      params:
      - name: limit
        value: ''
        type: query
        description: A limit on the number of objects to be returned.
    docs: List Events
  - info:
      name: Retrieve an Event
      type: http
    http:
      method: GET
      url: https://api.shift4.com/events/:eventId
      params:
      - name: eventId
        value: ''
        type: path
    docs: Retrieve an Event
bundled: true
Shift4 Payments

APIs

Shift4 Payments API

Shift4 Checkout

Shift4 JavaScript Library

Collections

Shift4 Payments API

Pricing Plans

Shift4 Payments Plans Pricing

Rate Limits

Shift4 Payments Rate Limits

FinOps

Shift4 Payments Finops

Semantic Vocabularies

Shift4 Payments Context

API Governance Rules

Shift4 Payments API Rules

JSON Structure

Shift4 Charge Structure

Shift4 Customer Structure

Shift4 Subscription Structure

Example Payloads

Shift4 Api Create Charge Example

Shift4 Api Create Checkout Session Example

Shift4 Api Create Customer Example

Shift4 Api Create Refund Example

Shift4 Api Create Subscription Example

Shift4 Api Create Token Example

Shift4 Api List Events Example

Resources

Sources
