Sign in
Create account
Sign in
Home
Payments
Business operations
Financial services
Developer tools
Security
All products
Home
Payments
Business operations
Home
Payments
Business operations
Financial services
Developer tools
Support
Overview
Payment Intents
Setup Intents
Payment Methods
Older APIs
Charges
Migrate to the new APIs
Accept a card payment
Save a card
Place a hold on a card
Charges with Connect
Sources
Orders
Testing
HomePaymentsOlder APIs

Card payments on the Charges API

Learn how to charge, save, and authenticate cards with Stripe's older APIs.

The Charges API is an older payments API that does not handle bank requests for card authentication. Try the latest payments APIs and integrations instead.

Not a developer?

Hire a Stripe certified expert or use a prebuilt solution created by one of our verified partners (no code required).

The Charges and Tokens APIs were not designed for new regulations (like SCA) and regional payment method requirements. Stripe’s latest APIs are built on top of Charges to help handle these complex payments automatically.

This older integration is still necessary for certain payment methods. As we continue evolve the APIs, check the status of supported payment methods.

Looking for an integration that’s similar to Charges? If you only accept U.S. and Canadian card payments, you can integrate to ignore authentication.

Payment flow

Charges APIPayment Intents API
  1. Collect the customer’s payment information in the browser with Elements.
  2. Tokenize the payment information with Stripe.js.
  3. Perform a request to send the token to your server.
  4. Use the token to create a charge on your server with the desired amount and currency.
  5. Fulfill the customer’s order if payment is successful.
  1. Create a PaymentIntent on your server with the desired amount and currency.
  2. Send the PaymentIntent’s client secret to the client side.
  3. Collect the customer’s payment information in the browser with Elements.
  4. Use Stripe.js or the mobile SDKs to handle 3D Secure and complete the payment on the client.
  5. Use webhooks to fulfill the customer’s order if the payment is successful.

The Charges API is limited. To get the latest Stripe features, use Stripe Checkout or migrate to the Payment Intents API. If your current integration doesn’t rely on webhooks, you can follow the synchronous flow migration guide instead.

Using the Charges API

New features won’t be added to the Charges API, but you can continue to use it to collect payments and more:

  • Accept payments
  • Save cards
  • Understand and convert currencies

Refunds

To refund a payment via the API, create a Refund and provide the ID of the charge to be refunded.

Terminal
curl https://api.stripe.com/v1/refunds \ -u
sk_test_4eC39HqLyjWDarjtT1zdp7dc
: \ -d "charge"="{{CHARGE_ID}}"

To refund part of a payment, provide an amount parameter, as an integer in cents (or the charge currency’s smallest currency unit).

Terminal
curl https://api.stripe.com/v1/refunds \ -u
sk_test_4eC39HqLyjWDarjtT1zdp7dc
: \ -d "charge"="{{CHARGE_ID}}" \ -d "amount"=1000

Apple Pay

When your customer approves the payment, your app receives a PKPayment instance containing their encrypted card details by implementing the PKPaymentAuthorizationViewControllerDelegate methods.

  1. Use the createTokenWithPayment SDK method to turn the PKPayment into a Stripe Token
  2. Use this Token to create a charge.
CheckoutViewController.swift
extension CheckoutViewController: PKPaymentAuthorizationViewControllerDelegate { @available(iOS 11.0, *) func paymentAuthorizationViewController(_ controller: PKPaymentAuthorizationViewController, didAuthorizePayment payment: PKPayment, handler: @escaping (PKPaymentAuthorizationResult) -> Void) { // Convert the PKPayment into a Token STPAPIClient.shared().createToken(withPayment: payment) { token, error in guard let token = token else { // Handle the error return } let tokenID = token.tokenId // Send the token identifier to your server to create a Charge... // If the server responds successfully, set self.paymentSucceeded to YES } }

Dynamic statement descriptor

By default, your Stripe account’s statement descriptor appears on customer statements whenever you charge their card. Additionally, you can set the statement descriptor dynamically on every charge request with the statement_descriptor argument on the Charge object.

Terminal
curl https://api.stripe.com/v1/charges \ -u
sk_test_4eC39HqLyjWDarjtT1zdp7dc
: \ -d "amount"=999 \ -d "currency"="usd" \ -d "description"="Example charge" \ -d "source"="tok_visa" \ -d "statement_descriptor"="Custom descriptor"

Statement descriptors are limited to 22 characters, cannot use the special characters <, >, ', ", or *, and must not consist solely of numbers.

When setting the statement descriptor dynamically on credit and debit card charges, the dynamic portion is appended to the settlement merchant’s statement descriptor (separated by an * and an empty space). For example, a statement descriptor for a business, named FreeCookies, that includes the kind of cookie purchased might look like FREECOOKIES* SUGAR.

The * and empty space count towards the 22 character limit and Stripe automatically allots 10 characters for the dynamic statement descriptor. This means that the settlement merchant’s descriptor might be truncated if it’s longer than 10 characters (assuming the dynamic statement descriptor is also greater than 10 characters). If the dynamic statement descriptor is also greater than 10 characters, both descriptors are truncated at 10 characters.

If you’re having issues with the character limits, you can set a shortened descriptor in the Stripe Dashboard to shorten the settlement merchant’s descriptor. This allows more room for the dynamic statement descriptor. The shortened descriptor:

  • Replaces the settlement merchant’s statement descriptor when using dynamic descriptors.
  • Can be between 2 and 10 characters.

If your account’s statement descriptor is longer than 10 characters, Stripe strongly recommends setting a shortened descriptor in the Dashboard or using a statement_descriptor_prefix. This prevents your statement descriptor from being truncated in unpredictable ways.

If you’re not sure what the statement descriptors look like when they’re combined, you can check them in the the Stripe Dashboard.

Storing information in metadata

Using Payment Intents

If using the Payment Intents API, only retrieve and update the metadata and description fields on the Payment Intent object. If using both the Payment Intent and Charge objects, you’re not guaranteed to see consistent values for these fields.

Stripe supports adding metadata to the most common requests you make, such as processing charges. Metadata isn’t shown to customers or factored into whether or not a charge is declined or blocked by our fraud prevention system.

Through metadata, you can associate other information—meaningful to you—with Stripe activity. Any metadata you include is viewable in the Dashboard (e.g., when looking at the page for an individual charge), and is also available in common reports and exports. As an example, your store’s order ID can be attached to the charge used to pay for that order. Doing so allows you, your accountant, or your finance team to easily reconcile charges in Stripe to orders in your system.

If you are using Radar, consider passing any additional customer information and order information as metadata. By doing so, you can write Radar rules using metadata attributes and have more information about the payment available within the Dashboard which can expedite your review process.

Terminal
curl https://api.stripe.com/v1/charges \ -u
sk_test_4eC39HqLyjWDarjtT1zdp7dc
: \ -d "amount"=999 \ -d "currency"="usd" \ -d "description"="Example charge" \ -d "source"="tok_visa" \ -d "metadata[order_id]"=6735

Do not store any sensitive information (personally identifiable information, card details, etc.) as metadata or in the charge’s description parameter.

Was this page helpful?
Questions? Contact us.
Developer tutorials on YouTube.
You can unsubscribe at any time. Read our privacy policy.
On this page
Payment flow
Using the Charges API
Refunds
Apple Pay
Dynamic statement descriptor
Storing information in metadata