Stripe

This documentation for the Stripe integration describes the technical capabilities of this integration, including authorization, scopes/permissions, and utilized endpoints. For more information on how to integrate Stripe, visit our connection instructions.

Version

This integration utilizes the Stripe API v1.

Base URL

The base URL used for all Stripe API endpoints:

https://api.stripe.com/v1

---

Authentication & Authorization

The DataGrail Stripe integration connects using API Key authentication which requires an API Key.

Sensitive Credentials

Publicly exposing your API credentials can allow unauthorized access to Stripe API endpoints by a third party. DataGrail stores your API credentials encrypted and protected.

Scopes

The Stripe integration requires specific scopes that must be granted in order to function for a given capability.

Scope	Access	Deletion	Data Discovery
Charges	✅		✅
Disputes	✅		✳️
Customers	✅	✅	✅
Events	✅		✳️
PaymentIntents	✅
PaymentMethods	✅
Sources	✅
Invoices	✅
Subscriptions	✅
Orders	✅
Authorizations	✅		✳️
Cardholders	✅		✳️
Cards	✅	✅	✳️
Transactions	✅	✅	✳️
All Connect resources			✅
Checkout Sessions			✳️
Identity Verification Sessions and Reports			✅
Payment Links			✳️
Reviews			✳️
Tax Settings and Registrations	✅		✅
Refunds			✳️
Accounts			✳️
Identity Verification Reports			✳️
Payouts			✳️
Setup Intents			✳️
Tax Settings			✳️
Top-ups			✳️
External Accounts			✳️
Persons			✳️
Treasury Financial Accounts			✳️

✳️ optional scope

Endpoints Utilized

DataGrail uses the following endpoints to authorize and test the connection:

Method	Endpoint	Purpose	Docs
GET	/customers	Returns a list of your customers
GET	/customers/customer_id	Returns a list of your customers
GET	/invoices	Returns a list of all invoices, or list the invoices for a specific customer
GET	/orders	Returns a list of your orders

---

Limits

Limits in Stripe are calculated using the leaky bucket algorithm. All requests that are made after rate limits have been exceeded are throttled and an HTTP 429 Too Many Requests error is returned. Requests succeed again after enough requests have emptied out of the bucket.

• DataGrail supports requests throttling to stay within 70-80% of specified service rate limits.
• DataGrail processes API responses with HTTP 429 status to interrupt requests, waiting and retrying (using an exponential backoff strategy).

---

Capabilities

Access

DataGrail's Stripe integration provides Synchronous Access capabilities for the following supported identifier category: Email.

Data Interactions

For Access requests, DataGrail will take the following actions:

1. Search for Customers using the Data Subject email address.
2. Retrieve a Customer using a Service ID, which Stripe treats like a "customer ID."
3. If a match is found, DataGrail will extract all objects related to the Customer:

Match Found

• tax IDs
• bank accounts
• cards
• charges
• payment methods
• payment intents
• invoices
• subscriptions
• orders

4. Search for cardholders whose email matches the email from the Data Subject provided in the request.
5. If a match is found, DataGrail will extract all objects related to the cardholders:

Match Found

• authorization objects
• cards
• transactions

Endpoints Utilized

Method	Endpoint	Purpose	Docs
GET	/charges	Returns a list of charges you’ve previously created
GET	/customers	Returns a list of your customers
GET	/customers/customer_id	Returns a list of your customers
GET	/customers/customer_id/tax_ids	Returns a list of tax IDs for a customer
GET	/invoices	Returns a list of all invoices, or list the invoices for a specific customer
GET	/issuing/authorizations	Returns a list of Issuing Authorization objects
GET	/issuing/cardholders	Returns a list of Issuing Cardholder objects
GET	/issuing/cards	Returns a list of Issuing Card objects
GET	/orders	Returns a list of your orders
GET	/payment_intents	Returns a list of PaymentIntents
GET	/payment_methods	Returns a list of PaymentMethods for Treasury flows
GET	/subscriptions	Returns a list of subscriptions that have not been canceled
GET	/transactions	Returns a list of Issuing Transaction objects

---

Deletion

DataGrail's Stripe integration provides Synchronous Deletion capabilities for the following supported identifier category: Email.

Data Interactions

For Deletion requests, DataGrail will take the following actions:

1. Request a customer be permanently deleted. It cannot be undone and also immediately cancels any active subscriptions on the customer.
2. Deletes bank accounts from a customer.
3. Deletes cards from a customer.

Endpoints Utilized

Method	Endpoint	Purpose	Docs
DEL	/customers/customer_id	Permanently deletes a customer
DEL	/customers/customer_id/sources/item_id	Delete bank accounts from a Customer

---

Data Discovery

DataGrail's Stripe integration provides data discovery capabilities based on the principle of finding any and all personal data that's stored in a data system.

Data Interactions

For discovery requests, DataGrail will take the following actions:

1. Count number of all records for each of supported objects.
2. Fetch example records for each of the supported objects.

Supported Objects

• Customers
• Payment Methods
• Charges
• Payment Intents
• Invoices
• Subscriptions
• Orders
• Customer Bank Accounts (related to the customer)
• Cards (related to the customer)
• Tax IDs (related to the customer)
• Disputes
• Events
• Refunds
• Accounts
• Checkout Sessions
• Identity Verification Reports
• Payment Links
• Payouts
• Reviews
• Setup Intents
• Tax Settings
• Top-ups
• External Accounts (related to owner's account)
• Persons (related to owner's account)
• Cardholders
• Authorizations
• Cards
• Transactions
• Treasury Financial Accounts

3. Sample data for the next analysis and classification.

Endpoints Utilized

Method	Endpoint	Purpose	Docs
GET	/accounts	Returns a list of accounts connected to your platform via Connect
GET	/charges	Returns a list of charges you’ve previously created
GET	/checkout/sessions	Returns a list of Checkout Sessions
GET	/customers	Returns a list of your customers
GET	/customers/account_id/external_accounts	Returns a list of all bank accounts
GET	/customers/account_id/persons	Returns a list of all persons
GET	/customers/customer_id/bank_accounts	Returns a list of all bank accounts
GET	/customers/customer_id/cards	Returns a list of all cards
GET	/customers/customer_id/tax_ids	Returns a list of tax IDs for a customer
GET	/disputes	Returns a list of your disputes
GET	/events	Returns a list of all events
GET	/financial_accounts	Returns a list of all Financial Accounts
GET	/identity/verification_reports	Returns a list of all verification reports
GET	/invoices	Returns a list of all invoices, or list the invoices for a specific customer
GET	/issuing/authorizations	Returns a list of Issuing Authorization objects
GET	/issuing/cardholders	Returns a list of Issuing Cardholder objects
GET	/issuing/cards	Returns a list of Issuing Card objects
GET	/orders	Returns a list of your orders
GET	/payment_intents	Returns a list of PaymentIntents
GET	/payment_links	Returns a list of your payment links
GET	/payment_methods	Returns a list of PaymentMethods for Treasury flows
GET	/payouts	Returns a list of existing payouts
GET	/refunds	Refund objects allow you to refund a previously created charge that isn’t refunded yet.
GET	/reviews	Returns a list of Review objects that have open set to true.
GET	/setup_intents	Returns a list of SetupIntents
GET	/subscriptions	Returns a list of subscriptions that have not been canceled
GET	/tax/settings	Retrieves Tax Settings for a merchant
GET	/topups	Returns a list of top-ups
GET	/transactions	Returns a list of Issuing Transaction objects