Stripe
Stripe (opens in a new tab) provides online payment processing solutions for businesses.
Prerequisites
In order to integrate with Stripe, you'll need to collect the following information:
| Name | Description |
|---|---|
| Domain* | Your Stripe URL (default:api.stripe.com) |
| API key* | Your Stripe API Key. Follow Stripe's docs to generate an API key (opens in a new tab) |
Integrating with Stripe
To integrate an existing system with Stripe:
- Navigate to Data map → View Systems and choose the system that you want to connect.
- Click on the Integrations tab.
- Pick the vendor or system type that you want to integrate with from the Connection type drop-down menu.
- Complete the required fields for the integration and click Save.
You may confirm your connection is working using the Test connection button, if desired.
To learn more, please see our guide for Managing Integrations.
Technical detail
Fides utilizes API endpoints to access the API service for a SaaS application. An API service is the programmatic interface through which Fides can query and update data within an application to access, rectify, or delete personal information. Each SaaS tool will have a unique set of endpoints to enable privacy functions.
Stripe endpoints
In the table below, you can find which endpoints are used for each type of privacy function. Clicking on the endpoint will take you to the documentation for that endpoint.
| Privacy function | Endpoint | Description |
|---|---|---|
| Access Requests | Customer (opens in a new tab) | Returns information about a customer |
| Update or Erasure Requests | Customer (opens in a new tab) | Used to mask or erase information about a customer |
| Access Requests | Charge (opens in a new tab) | Returns information about customer charges |
| Access Requests | Dispute (opens in a new tab) | Returns disputes for a customer charge |
| Access Requests | Payment Intent (opens in a new tab) | Returns payment intents associated with a customer |
| Access Requests | Payment Method (opens in a new tab) | Returns a customer's payment methods |
| Update or Erasure Requests | Payment Method (opens in a new tab) | Used to mask or erase information about a customer's payment method |
| Access Requests | Bank Account (opens in a new tab) | Returns bank accounts associated with a customer |
| Update or Erasure Requests | Bank Account (opens in a new tab) | Used to mask or erase information about a customer's bank account |
| Access Requests | Cards (opens in a new tab) | Returns cards associated with a customer |
| Update or Erasure Requests | Cards (opens in a new tab) | Used to mask or erase information about a customer's cards |
| Access Requests | Credit Note (opens in a new tab) | Returns credit notes associated with a customer |
| Access Requests | Customer Balance Transaction (opens in a new tab) | Returns transactions that updated the customer's balances |
| Access Requests | Tax ID (opens in a new tab) | Returns Tax IDs associated with a customer |
| Update or Erasure Requests | TaxID (opens in a new tab) | Erases information about customer tax IDs |
| Access Requests | Invoice (opens in a new tab) | Returns customer invoices |
| Update or Erasure Requests | Invoice (opens in a new tab) | Used to erase a customer's draft invoices |
| Access Requests | Invoice Item (opens in a new tab) | Returns invoice items associated with a customer |
| Update or Erasure Requests | Invoice Item (opens in a new tab) | Used to erase invoice items from a customer's invoice |
| Access Requests | Subscription (opens in a new tab) | Returns a customer's subscriptions |
| Update or Erasure Requests | Subscription (opens in a new tab) | Used to cancel a customer's subscriptions |