← Shift4

Create Charge with Shift4 API

Pipedream makes it easy to connect APIs for Shift4 and 2,400+ other apps remarkably fast.

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Create Charge with the Shift4 API
No credit card required
Intro to Pipedream
Watch us build a workflow
Watch us build a workflow
8 min
Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo
Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo

Developers Pipedream

Getting Started

Create a workflow to Create Charge with the Shift4 API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the Create Charge action
    1. Connect your Shift4 account
    2. Optional- Select a Customer ID
    3. Configure Amount
    4. Configure Currency
    5. Optional- Select a Type
    6. Optional- Configure Description
    7. Optional- Configure Card
    8. Optional- Configure Payment Method
    9. Optional- Configure Flow
    10. Optional- Configure Captured
    11. Optional- Configure Shipping
    12. Optional- Configure Billing
    13. Optional- Configure 3D Secure
    14. Optional- Configure Metadata
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

Create Charge with Shift4 API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + Shift4
 
Try it
Create Charge with Shift4 API on New Submission from Typeform API
Typeform + Shift4
 
Try it
Create Charge with Shift4 API on New Submission (Instant) from Jotform API
Jotform + Shift4
 
Try it
Create Charge with Shift4 API on New Scheduled Tasks from Pipedream API
Pipedream + Shift4
 
Try it
Create Charge with Shift4 API on npm Download Counts from npm API
npm + Shift4
 
Try it

Details

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Create Charge on Shift4
Description:Creates a new charge object. [See the documentation](https://dev.shift4.com/docs/api#charges-create-a-new-charge)
Version:0.0.1
Key:shift4-create-charge

Code

import { ConfigurationError } from "@pipedream/platform";
import { TYPE_OPTIONS } from "../../common/constants.mjs";
import { parseObject } from "../../common/utils.mjs";
import shift4 from "../../shift4.app.mjs";

export default {
  key: "shift4-create-charge",
  name: "Create Charge",
  description: "Creates a new charge object. [See the documentation](https://dev.shift4.com/docs/api#charges-create-a-new-charge)",
  version: "0.0.1",
  type: "action",
  props: {
    shift4,
    customerId: {
      propDefinition: [
        shift4,
        "customerId",
      ],
      optional: true,
    },
    amount: {
      propDefinition: [
        shift4,
        "amount",
      ],
    },
    currency: {
      propDefinition: [
        shift4,
        "currency",
      ],
    },
    type: {
      type: "string",
      label: "Type",
      description: "The type of the charge.",
      options: TYPE_OPTIONS,
      optional: true,
    },
    description: {
      propDefinition: [
        shift4,
        "description",
      ],
      optional: true,
    },
    card: {
      propDefinition: [
        shift4,
        "card",
      ],
      optional: true,
    },
    paymentMethod: {
      type: "string",
      label: "Payment Method",
      description: "Payment method details or identifier.",
      optional: true,
    },
    flow: {
      type: "object",
      label: "Flow",
      description: "Details specific to the payment method charge.",
      optional: true,
    },
    captured: {
      type: "boolean",
      label: "Captured",
      description: "Whether this charge should be immediately captured.",
      optional: true,
    },
    shipping: {
      type: "object",
      label: "Shipping",
      description: "Shipping details. Sample object: `{name: \"string\", address: {line1: \"string\", line2: \"string\", zip: \"string\", city: \"string\", state: \"string\", country: \"country represented as two-letter ISO country code\"}}`",
      optional: true,
    },
    billing: {
      type: "object",
      label: "Billing",
      description: "Billing details. Sample object: `{name: \"string\", email: \"string\", address: {line1: \"string\", line2: \"string\", zip: \"string\", city: \"string\", state: \"string\", country: \"country represented as two-letter ISO country code\"}, vat: \"string\"}`",
      optional: true,
    },
    threeDSecure: {
      type: "object",
      label: "3D Secure",
      description: "3D Secure options.",
      optional: true,
    },
    metadata: {
      propDefinition: [
        shift4,
        "metadata",
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    if (!this.customerId && !this.card && !this.paymentMethod) {
      throw new ConfigurationError("Either **CustomerId**, **Card** or **PaymentMethod** is required!");
    }

    try {
      const response = await this.shift4.createCharge({
        $,
        data: {
          amount: this.amount,
          currency: this.currency,
          type: this.type,
          description: this.description,
          customerId: this.customerId,
          card: this.card && parseObject(this.card),
          paymentMethod: this.paymentMethod && parseObject(this.paymentMethod),
          flow: this.flow && parseObject(this.flow),
          captured: this.captured,
          shipping: this.shipping && parseObject(this.shipping),
          billing: this.billing && parseObject(this.billing),
          threeDSecure: this.threeDSecure && parseObject(this.threeDSecure),
          metadata: this.metadata && parseObject(this.metadata),
        },
      });

      $.export("$summary", `Successfully created charge with Id: ${response.id}`);
      return response;
    } catch ({ message }) {
      throw new ConfigurationError(JSON.parse(message).error.message);
    }
  },
};

Configuration

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.
LabelPropTypeDescription
Shift4shift4appThis component uses the Shift4 app.
Customer IDcustomerIdstringSelect a value from the drop down menu.
Amountamountinteger

The charge amount in minor units of a given currency. For example, 10€ is represented as '1000'.

Currencycurrencystring

The charge currency represented as a three-letter ISO currency code.

TypetypestringSelect a value from the drop down menu:{ "label": "First Recurring", "value": "first_recurring" }{ "label": "Subsequent Recurring", "value": "subsequent_recurring" }{ "label": "Merchant Initiated", "value": "merchant_initiated" }{ "label": "Customer Initiated", "value": "customer_initiated" }
Descriptiondescriptionstring

A description for the charge.

Cardcardstring

Card token, card details or card identifier.

Payment MethodpaymentMethodstring

Payment method details or identifier.

Flowflowobject

Details specific to the payment method charge.

Capturedcapturedboolean

Whether this charge should be immediately captured.

Shippingshippingobject

Shipping details. Sample object: {name: "string", address: {line1: "string", line2: "string", zip: "string", city: "string", state: "string", country: "country represented as two-letter ISO country code"}}

Billingbillingobject

Billing details. Sample object: {name: "string", email: "string", address: {line1: "string", line2: "string", zip: "string", city: "string", state: "string", country: "country represented as two-letter ISO country code"}, vat: "string"}

3D SecurethreeDSecureobject

3D Secure options.

Metadatametadataobject

Metadata object.

Authentication

Shift4 uses API keys for authentication. When you connect your Shift4 account, Pipedream securely stores the keys so you can easily authenticate to Shift4 APIs in both code and no-code steps.

To retrieve your API keys,

  • Navigate to your Shift4 account and sign in
  • Click the dropdown on the top right
  • Go to “Account Settings” > “API keys”

About Shift4

We’re changing the way the world experiences commerce.

More Ways to Use Shift4

Triggers

New Charge from the Shift4 API

Emit new event when a new charge is successfully created.

 
Try it
New Charge Updated from the Shift4 API

Emit new event when a charge object is updated.

 
Try it
New Customer from the Shift4 API

Emit new event when a new customer is created.

 
Try it

Actions

Create Customer with the Shift4 API

Creates a new customer object. See the documentation

 
Try it
Create Plan with the Shift4 API

Creates a new plan object. See the documentation

 
Try it
Create Token with the Shift4 API

Creates a new token object. See the documentation

 
Try it

Explore Other Apps

1
-
24
of
2,400+
apps by most popular

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.
Premium
Salesforce
Salesforce
Web services API for interacting with Salesforce
Premium
HubSpot
HubSpot
HubSpot's CRM platform contains the marketing, sales, service, operations, and website-building software you need to grow your business.
Premium
Zoho CRM
Zoho CRM
Zoho CRM is an online Sales CRM software that manages your sales, marketing, and support in one CRM platform.
Premium
Stripe
Stripe
Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.
Shopify
Shopify
Shopify is a complete commerce platform that lets anyone start, manage, and grow a business. You can use Shopify to build an online store, manage sales, market to customers, and accept payments in digital and physical locations.
Premium
WooCommerce
WooCommerce
WooCommerce is the open-source ecommerce platform for WordPress.
Premium
Snowflake
Snowflake
A data warehouse built for the cloud
Premium
MongoDB
MongoDB
MongoDB is an open source NoSQL database management program.
Supabase
Supabase
Supabase is an open source Firebase alternative.
MySQL
MySQL
MySQL is an open-source relational database management system.
PostgreSQL
PostgreSQL
PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.
Premium
AWS
AWS
Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.
Premium
Twilio SendGrid
Twilio SendGrid
Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.
Amazon SES
Amazon SES
Amazon SES is a cloud-based email service provider that can integrate into any application for high volume email automation
Premium
Klaviyo
Klaviyo
Email Marketing and SMS Marketing Platform
Premium
Zendesk
Zendesk
Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.
Notion
Notion
Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.
Slack
Slack
Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.
Microsoft Teams
Microsoft Teams
Microsoft Teams has communities, events, chats, channels, meetings, storage, tasks, and calendars in one place.
Schedule
Schedule
Trigger workflows on an interval or cron schedule.