Saurabh Chodvadiya's blog

Integrating Stripe Payment Gateway with FastAPI: A Comprehensive Guide

Saurabh Chodvadiya's photo
Saurabh Chodvadiya
·

3 min read

Introduction:

FastAPI, a modern and efficient web framework for building APIs, has gained popularity for its simplicity and high performance. Integrating a secure and reliable payment gateway into your FastAPI application is crucial for enabling smooth and seamless transactions. In this blog, we will walk you through the process of integrating the widely-used Stripe payment gateway with FastAPI, allowing you to securely handle online payments for your web application.

Prerequisites:

Before we begin, ensure you have the following in place:

  1. A working FastAPI application set up.

  2. A Stripe account with the necessary API keys.

Step 1: Installing Dependencies:

To get started, make sure you have FastAPI and Stripe libraries installed. Open your terminal and run the following commands:

pip install fastapi uvicorn stripe

Step 2: Setting up Stripe API Keys:

Log in to your Stripe account and navigate to the Developer Dashboard. Obtain your API keys (test or live) from the “API Keys” section. For this tutorial, we will use the test keys to avoid processing real payments during development.

Step 3: Creating the FastAPI Application:

In your FastAPI project directory, create a file named main.py. This file will contain the FastAPI application code and the Stripe integration logic.

Step 4: Implementing the Stripe Payment Gateway:

Inside main.py, import the required modules and initialize the Stripe API with your test secret key. We'll also create a FastAPI endpoint to handle payment processing.

# main.py

from fastapi import FastAPI, HTTPException
import stripe

# Replace with your Stripe secret key
stripe.api_key = "sk_test_your_stripe_secret_key"

app = FastAPI()

@app.post("/process-payment/")
async def process_payment(amount: int, currency: str, token: str):
    try:
        # Create a charge using the Stripe API
        charge = stripe.Charge.create(
            amount=amount,
            currency=currency,
            source=token,  # Stripe token obtained from the client-side (e.g., Stripe.js)
            description="Payment for FastAPI Store",  # Add a description for the payment
        )

        # You can handle the charge object as per your requirements
        # For example, log the payment or perform other actions

        # Return a success response
        return {"status": "success", "charge_id": charge.id}

    except stripe.error.CardError as e:
        # Handle specific Stripe errors
        return {"status": "error", "message": str(e)}
    except stripe.error.StripeError as e:
        # Handle generic Stripe errors
        return {"status": "error", "message": "Something went wrong. Please try again later."}

# Run the FastAPI application
if __name__ == "__main__":
    import uvicorn

    uvicorn.run(app, host="0.0.0.0", port=8000)

Step 5: Running the FastAPI Server:

To start the FastAPI server, run the following command in your terminal:

uvicorn main:app --reload

Step 6: Collecting Payment Information on the Client-side:

On the client-side (e.g., a web or mobile application), you need to collect payment information securely using Stripe.js or Stripe Elements. This process involves generating a token representing the payment method (e.g., credit card) without passing sensitive data to your server.

Step 7: Making a Payment Request to FastAPI:

With the payment token and other necessary details collected on the client-side, make an HTTP POST request to your FastAPI endpoint (/process-payment/) with the payment information.

Step 8: Handling the Payment Response:

FastAPI will process the payment request using the Stripe API and return a response. Depending on the payment status, your client application can proceed accordingly. The response will include a status indicating success or an error message if the payment was declined.

Conclusion:

By following this guide, you have successfully integrated the Stripe payment gateway with your FastAPI application, allowing you to process online payments securely and efficiently. With FastAPI’s performance and Stripe’s robust payment processing capabilities, your web application is now equipped to handle seamless and secure payment transactions. Remember to follow best practices and handle errors gracefully to provide a smooth user experience. Happy coding!

stripeFastAPI