Payment Methods API

The Payment Methods API allows you to accept a variety of payment methods through a single API. A PaymentMethod object contains the payment method details to create payments. With the Payment Methods API, you can combine a PaymentMethod:

• With a PaymentIntent to accept a payment
• With a SetupIntent and a Customer to save payment details for later

Supported payment methods

To determine which payment methods to use for specific locales, see the guide to payment methods.

The guide includes available payment methods for different regions, a detailed description of each payment method’s characteristics, and the geographic regions where they’re most relevant. You can enable any payment methods available to you in the Dashboard. Activation is generally instantaneous and doesn’t require additional contracts.

Customer actions

​​Some payment methods require your customer to take additional steps to complete the payment. The PaymentIntent object’s next_action parameter specifies the type of customer action.

Some common actions that customers need to perform are:

• ​​Redirect to their bank’s online service to authenticate and approve the payment.
• Verify ownership of their account by providing a one-time code that you post to the Stripe API (for example, microdeposits).
• Push funds (for example, in the case for bank transfers) through their bank’s online service.

Not all payment methods require additional customer actions. For example, card payments (excluding 3D Secure) require no additional authentication beyond collecting card details.

Immediate or delayed notification of payment success

Some payment methods immediately return payment status when a transaction is attempted (for example, card payments) but other methods have a delay such as ACH debits. For those that immediately return payment status, the PaymentIntent status either changes to succeeded or requires_payment_method. A status of succeeded guarantees that you will receive the funds from your customers.

Payment methods with delayed notification can’t guarantee payment during the delay. The status of the PaymentIntent object will be processing until the payment status is either successful or failed. It’s common for businesses to hold an order in a pending state during this time, not fulfilling the order until the payment is successful.

Single-use or reusable

You can reuse certain payment methods (for example, cards or bank debits) for additional payments without authorizing and collecting payment details again.

You should always set up reusable payment methods for future use to reduce the chance of future declines and payment friction (such as authentication being required). Reusable payment methods can be set up for future use when accepting a payment or set up for future use without taking a payment.

Single-use payment methods (for example, some kinds of bank transfers) can’t be attached to customers because they’re consumed after a payment attempt.

Use webhooks to track payment status

Configure webhooks by creating a webhook endpoint or other type of event destination for payment methods that either require customer action or when payment notification is delayed. Stripe sends the following events when the PaymentIntent status is updated:

​​You can also use the following options instead of setting up an event destination to listen to events:

• Manually track the status of payments in the Stripe Dashboard, if your business accepts a low volume of orders from payment methods with delayed notification. The Dashboard allows you to view all your Stripe payments, send email receipts, handle payouts, or retry failed payments.
• Use polling (for example, repeatedly retrieving a PaymentIntent so that you can check its status). Note that polling is significantly less reliable and may not work at scale. Stripe enforces rate limiting on API requests, so exercise caution if you use polling.
• Use a partner application to handle common business events, like automation or marketing and sales, by integrating a partner application.

The PaymentMethod object

A PaymentMethod contains reusable payment method details for creating payments (for example, card expiration date or billing address), it doesn’t include transaction-specific information (for example, amount, currency). A PaymentMethod is attached to a PaymentIntent to represent the states of a payment lifecycle. Each PaymentMethod has a type attribute (for example, "type": "sepa_debit" ) and an additional hash whose name matches the type and contains information specific to the PaymentMethod type (for example, "sepa_debit":{}). Example of a sepa_debit PaymentMethod object:

{
  "id": "pm_123456789",
  "object": "payment_method",
  "billing_details": {
    "address": {...},
    "email": "jenny@example.com",
    "name": "Jenny Rosen",
    "phone": "+335555555555"
  },
  "sepa_debit": {
    "bank_code": "37040044",
    "branch_code": "94832",
    "country": "FR",
    "fingerprint": "ygEJfUjzWMGyWnZg",
    "last4": "3000"
  },
  "type": "sepa_debit",
  (...)
}