Configure Stripe integration

Nicolas Audet
Nicolas Audet
  • Updated

Overview

Integrating Stripe within gaiia allows your customers to pay for their invoices by using either a credit card, or a bank payment using Automated Clearing House (ACH).

By default, bank payment will be disabled. To enable them, follow this guide , and then follow these steps: Enable bank payments for Stripe

Additionally, you can also charge a fee to your customers for either credit card or bank payments, check this article: Adding a processing fee for Credit Card and ACH payments

Currently, part of this process can only be done in the backend by our engineers. The steps below will guide you on what information we need, and what should be done on your side. If you need any assistance, feel free to contact your Customer Success Manager.

 

Steps

A. Prepare your Stripe API keys

  1. Start composing a message to your Customer Success Manager. This will help you in the next steps
  2. Navigate to Stripe's website

  3. Click on the Developers button in the upper-right corner

  4. Select the API keys tab

  5. In the Standard keys section, click on Reveal next to the following keys, and copy them in your message:
    • Publishable key
    • Secret key

      stripe-integration-get-api-keys.png

  6. Toggle the Test mode radio button in the upper-right corner

    stripe-integration-set-test-mode.png

  7. Repeat step 5, those test keys will be used for your gaiia sandbox instance

  8. Toggle off the Test mode radio button in the upper-right corner

 

B. Configuring the webhook

  1. Select the Webhooks tab

  2. Click Add endpoint

    stripe-integration-add-endpoint.png

  3. Set Endpoint URL to:

    • https://6bpu8a02c8.execute-api.us-east-1.amazonaws.com/production/on-stripe-webhook-event?billingSettingsId=gaiia billing setting ID

      stripe-integration-configure-endpoint.png

      Your gaiia billing setting ID can be found by navigating to gaiia's Admin page, selecting the Billing tab and scrolling down to Other settings

  4. Click on Select events, and select the following events:

    • charge.dispute.closed
    • charge.dispute.created
    • charge.dispute.funds_reinstated
    • charge.dispute.funds_withdrawn
    • charge.dispute.updated
    • charge.refund.updated
    • customer.source.expiring
    • customer.source.updated
    • payment_method.automatically_updated
    • radar.early_fraud_warning.created
    • radar.early_fraud_warning.updated
    • source.canceled
  5. Optionally, if you are located in the US and need ACH - Direct debit support, also add these events:

    • payment_intent.canceled
    • payment_intent.succeeded
    • payment_intent.payment_failed
    • setup_intent.canceled
    • setup_intent.setup_failed
    • setup_intent.succeeded
  6. Confirm by clicking Add endpoint

  7. Copy the webhook Signing secret in your message by clicking Reveal

    stripe-integration-get-secret.png

  8. Toggle the Test mode radio button in the upper-right corner
  9. Repeat from steps 2 to 7 to configure the sandbox webhook

 

C. Finishing the process

  1. Navigate to the Payments page in the left-hand navigation bar
  2. Select Fraud & Risk
  3. In Rules, enable Block if CVC verification fails
  4. Send the message containing your API keys & secrets to your Customer Success Manager, and wait for a confirmation that Stripe has been integrated before following additional guides related to payments.

Related to

Was this article helpful?

Have more questions? Submit a request