Skip to main content

Authorization

Follow this guide to create a new Stripe credential that will allow Nexla to authenticate to and exchange data with your Stripe account.
stripe_api_auth.png

Stripe

Prerequisites​

Before creating a Stripe credential, you need to obtain your Stripe API Key from your Stripe Dashboard. Stripe uses API key authentication for all API requests, with the API key sent in the Authorization header with the Bearer prefix.

To obtain your Stripe API Key, follow these steps:

  1. Sign in to your Stripe Dashboard at https://dashboard.stripe.com using your administrator credentials.

  2. Navigate to Developers in the left sidebar, then click API keys or navigate to Developers > API keys.

  3. In the Standard keys section, you will see your API keys. Stripe provides separate keys for test mode and live mode:

    • Test mode keys (starting with sk_test_) are used for development and testing
    • Live mode keys (starting with sk_live_) are used for production transactions

  4. For development and testing, use the Secret key in the Test mode section. For production, use the Secret key in the Live mode section.

  5. Click Reveal live key token or Reveal test key token to display your secret key. The secret key is hidden by default for security.

  6. Copy the secret key immediately after it's revealed, as it may not be accessible again after you navigate away from the page. The secret key starts with sk_live_ for live mode or sk_test_ for test mode.

  7. Store the API key securely, as you will need it to configure your Nexla credential. The API key is sensitive information and should be kept confidential.

The API key is sent in the Authorization: Bearer {api_key} header for all API requests to the Stripe API. The key authenticates your requests and grants access to Stripe resources based on your account permissions. If your API key is compromised, you should immediately revoke it in your Stripe Dashboard and generate a new one. For detailed information about API authentication, key management, and available endpoints, refer to the Stripe API Documentation.

Create a Stripe Credential​

  • To create a new Stripe credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – Stripe

StripeCred.png

Credential Name & Description​

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

    Resource descriptions are recommended but are not required. They should be used provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

API Key Authentication​

Stripe uses API key authentication for all API requests. The API key is sent in the Authorization header with the Bearer prefix.

  1. Enter your Stripe API Key in the API Key field. This is the secret key you obtained from your Stripe Dashboard (Developers > API keys). Use test mode keys (starting with sk_test_) for development and testing, and live mode keys (starting with sk_live_) for production. The API key is sent in the Authorization: Bearer {api_key} header for all API requests to the Stripe API. The API key is sensitive information and must be kept confidential.

    Your Stripe API key can be found in your Stripe Dashboard under Developers > API keys. The secret key is located in the Standard keys section, and you can reveal it by clicking "Reveal live key token" or "Reveal test key token".

    The API key is sent in the Authorization: Bearer {api_key} header for all API requests to the Stripe API. Use test mode keys (starting with sk_test_) for development and testing, and live mode keys (starting with sk_live_) for production.

    If your API key is compromised, you should immediately revoke it in your Stripe Dashboard and generate a new one. The API key provides access to your Stripe account data and should be treated as sensitive information. Keep your API key secure and do not share it publicly.

    For detailed information about API authentication, key management, and available endpoints, see the Stripe API Documentation.

Save the Credential​

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

  2. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.