Skip to main content

Stripe

Integrating Stripe with Osano​

Connecting to Stripe​

In order for Osano to discover data stored in your systems, we must connect to those data providers via an API. We require, at minimum, read-only access to establish a connection to these providers. Each provider you connect may require different information. Please see the linked vendor documentation for instructions on where and how to obtain this data.

Setup​

An admin must create a API Key with the required scopes and enter that information in Osano to establish a connection via apiKey.

Authenticated Roles​

admin

Authentication Actions​

  • API Key -Instructions for obtaining your Stripe Auth Token.

  • Required Scopes

    When creating restricted keys for Stripe (Developers -> API Keys -> Create Restricted Key), you will need to select the following permissions:

Resource TypePermission (None, Read, Write)
All Core resources → Customers, Charges, and DisputesWrite
All Checkout resources → Checkout SessionsRead
All Billing resources → InvoicesRead
All Orders resources → OrdersRead

Note: Please ensure your Stripe version is set to 2020-08-27 or later in the Stripe Developer Dashboard for user search.

Authentication Methods​

  • oauth
  • apiKey

Bearer authentication with API Key

Core Functionality​

  • Data Discovery
  • User Search
  • Data Deletion

Base URL​

https://api.stripe.com/v1

  • email
  • name
  • phoneNumber
  • address
  • birthday
  • userId

Endpoints​

Used for data discovery

  • GET /customers
  • GET /orders
  • GET /charges
  • GET /checkout/sessions
  • GET /invoices
  • GET /disputes
  • GET /refunds

Used for user search

  • GET /customers/search?query=email:"$email"
  • GET /orders?customer=$customerId
  • GET /charges?customer=$customerId
  • GET /checkout/sessions?customer=$customerId
  • GET /invoices?customer=$customerId
  • GET /disputes?charge=$chargeId
  • GET /refunds?charge=$chargeId

Used for data deletion

  • DELETE /customers/:customerid

Demo Video​

Last Modified: 2025-03-27