The Sources APIDeprecated
Stripe doesn’t recommend using the deprecated Sources API. Use the PaymentMethods API. This newer API provides access to our latest features and payment method types.
Source objects allow you to accept a variety of payment methods with a single API. A source represents a customer’s payment instrument, and can be used with the Stripe API to create payments. Sources can be charged directly, or attached to customers for later reuse.
Each payment method supported by the Sources API is defined by four key characteristics. The combination of these characteristics determines how a source is made chargeable, and how it is used in a charge request to complete a payment.
- Pull or push: How the funds for the method of payment are transferred from your customer
- Flow: The type of action your customer must take to authenticate the payment
- Usage: Whether the
Sourceis reusable or not
- Synchronous or asynchronous: Whether the resulting charge can be confirmed immediately, or only after a delay
For a complete example illustrating how to accept any payment method using the Sources API, check out this sample e-commerce store, and browse its source code on GitHub.
Supported payment methods
You can enable any payment method available to you within the Dashboard. Activation is generally instantaneous, and does not require additional contracts nor include a lengthy process. For a detailed listing, take a look at the available payment methods and their supported geographical regions.
The following table maps the aforementioned key characteristics to the supported payment methods:
|Asynchronous||SEPA Direct Debit||ACH debits with authentication||ACH debits with microdeposits||—|
Pull or push of funds
Each method of payment is categorized as either pull or push, depending on how funds are transferred from the customer’s payment method.
- Using a pull method, you debit the funds from the customer’s account after the customer has provided consent. Card payments are an example of a pull method: your customer’s card is debited when a payment is made, and no customer interaction is required for subsequent debits.
- Using a push method, the customer sends the funds to you. ACH Credit Transfers are an example of a push method: Your customer is provided with bank routing and account numbers to which they should send (push) the correct amount. Once it’s confirmed that your customer has sent the funds to you, the source becomes chargeable, and is ready to be used in a charge request. Other push payment methods, such as iDEAL or Sofort, rely on a redirect for your customer to push the money to you directly from their online bank account. Generally, push methods require a customer interaction for each payment.
Flow for customer action
Certain payment methods require your customer to complete a particular action (flow) before the source is chargeable. The type of flow that applies to a payment method is stated within the
flow parameter. Each method is categorized into one of the following flow types.
Once the required flow has been completed and a source becomes chargeable, the source must be used to make a charge request for the payment to be completed. If not, the source is canceled and the customer’s authenticated payment is refunded automatically—no money is moved into your account.
Single-use or reusable
Certain payment methods allow for the creation of sources that can be reused for additional payments without your customer needing to complete the payment process again. Sources that can be reused have their
usage parameter set to
Conversely, if a source can only be used once, this parameter is set to
single_use, and a source must be created each time a customer makes a payment. Such sources should not be attached to customers—instead, they should be charged directly. They can be charged only once, and their status will change to
consumed when charged.
Reusable sources must be attached to a Customer in order to be reused. (If charged directly, their status will change to
consumed.) To learn how to attach Sources to Customers, and to manage a Customer’s sources list, refer to the Sources and Customers guide.
Synchronous or asynchronous confirmation
Once you use a payment method to create a Charge object, that charge’s status can be confirmed either immediately (synchronously), or after a certain amount of time (asynchronously).
With a synchronous payment method, the charge request’s status can be immediately confirmed as either
failed. If the charge request is successful, the payment is completed—it’s considered guaranteed that the customer has been charged, and that you’ll receive the funds. Card payments are an example of a synchronous payment method: there is real-time confirmation of the payment’s success or failure.
For asynchronous payment methods, it can take up to several days to confirm whether the payment has been successful. During this time, the payment cannot be guaranteed. The status of the payment’s
Chargeobject is initially set to
pending, until the payment has been confirmed as successful or failed. ACH debits are an example of an asynchronous method: with these debits, it takes a few days to confirm that the payment has succeeded.
Stripe sends a webhook event once a charge’s status has changed. When accepting any payment method that is asynchronous, your integration must be able to receive webhooks, so that it can receive this notification and confirm whether the customer’s payment was successful or has failed.