Stripe Connector Reference
Online payment processing platforms, like Stripe, are used by a growing number of businesses. Stripe enables businesses of all sizes to process payments through APIs by keeping customers and payment information synched.
Connections
To connect to a system, whether it is a source of data or the target where you are sending data, you must create a connection with that system’s required credentials. You typically connect to different systems within a flow and can reuse each connection every time you need to connect.
This system requires the following credential information for its connections:
- Connection Name
-
Enter a connection name that will help you remember the details of this connection. You can reuse connections multiple times in a single flow, and in more than one flow, and the credentials are hidden after you create the connection. Therefore, it’s helpful to provide a name that easily identifies this connection from others.
Only you can see the connection. Other users in your Composer app must create their own connections.
- API key
-
The value in this field maps to the
Authorization
field in the specialist connector and functions as a username in Stripe. Authentication to the API is performed via HTTP Basic Authentication. Your API key is your username and a password is not required. You can find your API key in your Stripe Dashboard. The Stripe API:-
Uses API keys to authenticate requests.
-
Supplies test mode keys that have the prefix
sk_test_
and live mode secret keys that have the prefixsk_live_
. -
Allows users to use restricted API keys for granular permissions.
-
Ensures that all API requests are made via HTTPS.
-
Stripe Connect supports OAuth authentication, but Stripe does not. For more information on OAuth authentication in Stripe, see the Stripe documentation.
Triggers
Each flow starts with either a scheduler or a trigger. Schedulers are set to a default frequency of 15 minutes. Triggers, such as "each time a new record is created", are defined by you and provide multiple options related to the data in your system.
Triggers use a polling process to actively check for new updates from an external system. The polling frequency is 15 seconds.
This system provides the following trigger options:
- New charge
-
Checks for a new charge to a payment source.
- New refund
-
Executes when a new refund is created.
Polling Frequency
For triggers in this connector, the Polling Frequency field is required. This field enables you to select how often Composer makes a request to the underling system API to look for changes to records in active flows. You can select a different polling frequency for each flow in your organization. With a shorter frequency, the flow executes more often; however, a shorter frequency consumes more API calls. For example, if you have an order management flow, you might require nearly real-time updates, which can be achieved with a 15-second polling interval (which equates to 5760 API calls per day). In contrast, if your flow updates a pricing catalog, you could poll the flow every hour (which equates to 24 API calls per day).
Actions
After you connect to a system and define the trigger or configure a scheduler, you define the actions that the flow performs. For example, you can copy a record between different systems, such as Workday and Salesforce. The actions you can perform depend on which system you are connected to.
This system provides the following actions:
- Create charge
-
Create a new charge. When creating a new charge, note that:
-
In the
Amount
field, the value is an integer. For instance, 1.00 is 100. -
The following fields require values:
-
Either the
Source
or theCustomer
field -
Customer ID
Note that best practice dictates that the value in the Customer ID field should come from an existing account in Stripe. For example,cus_JQ1BWAcXfKuswb
. -
Some shipping fields are required if any shipping fields are present.
-
For more information on the Create Charge action in Stripe, see the Stripe documentation.
-
- Create customer
-
Create a new customer. When creating a new customer, the
Phone
field is the customer’s phone number and not the shipping phone number. - Find customer
-
Finds an existing customer by
Customer ID
. - Create product
-
Creates a new product object. The following field is required: Name.