Stripe ACH Environment Setup

Table of Contents

Prerequisites
Stripe Configuration
Cart Operation Service Configuration for ACH Payments
Order Operation Service Configuration for ACH Payments
Authentication Service Data Configuration
Local Testing
Going to Production

Prerequisites

Prior to configuring your environment for Stripe ACH, please complete the base environment setup guide.

Stripe Configuration

In the Stripe Dashboard, you’ll need to enable the ACH payment method.

Cart Operation Service Configuration for ACH Payments

Add the following properties to declare the STRIPE gateway & ACH payment method as an available payment method.

broadleaf:
  cartoperation:
    service:
      checkout:
        checkout-payment-method-options:
          - payment-method-type: ACH
            payment-method-gateway-type: STRIPE

Stripe ACH payments always use AuthorizeAndCapture transactions. To ensure that CartOperationServices only attempts AuthorizeAndCapture transactions for ACH, the following property must be declared:

broadleaf:
  cartoperation:
    service:
      checkout:
        checkout-transaction-types:
          STRIPE.ACH: AUTHORIZE_AND_CAPTURE

Order Operation Service Configuration for ACH Payments

When the order is canceled or an order item is returned, the refund transaction is executed and this transaction requires the async result from the webhook. When the refund transaction is completed Stripe sends the webhook event to the webhook endpoint. After this event is processed successfully, the webhook sends an event to the paymentTransactionWebhookOutput message channel. This event should be processed by the FulfillmentAwaitingRefundResultWebhookListener or ReturnConfirmationRefundWebhookListener listeners in the OrderOperationService. By default, these listeners are disabled. To enable them add the following property:

broadleaf:
  orderoperation:
    async-payment-transaction-support:
      enabled: true

Authentication Service Data Configuration

The following permissions must be defined for Stripe ACH:

Stripe Payment Intent endpoint Permissions

INSERT INTO auth.blc_security_scope ("id", "name", "open") VALUES ('-611', 'STRIPE_PAYMENT_INTENT', 'N');
INSERT INTO auth.blc_permission_scope (id, "permission", is_permission_root, scope_id) VALUES('-1011', 'STRIPE_PAYMENT_INTENT', 'Y', '-611');
INSERT INTO auth.blc_permission_scope (id, "permission", is_permission_root, scope_id) VALUES('-1012', 'STRIPE_PAYMENT_INTENT', 'Y', '-100');

INSERT INTO auth.blc_user_permission ("id", "archived", "last_updated", "name", "is_account_perm") VALUES('-1011', 'N', '1970-01-01 00:00:00.000', 'ALL_STRIPE_PAYMENT_INTENT', 'N');
INSERT INTO auth.blc_role_permission_xref (role_id, permission_id) VALUES ('-100', '-1011');

INSERT INTO auth.blc_client_scopes ("id", "scope") VALUES ('anonymous', 'STRIPE_PAYMENT_INTENT');
INSERT INTO auth.blc_client_permissions ("id", "permission") VALUES ('anonymous', 'ALL_STRIPE_PAYMENT_INTENT');

INSERT INTO auth.blc_client_scopes ("id", "scope") VALUES ('openapi', 'STRIPE_PAYMENT_INTENT');
INSERT INTO auth.blc_client_permissions ("id", "permission") VALUES ('openapi', 'ALL_STRIPE_PAYMENT_INTENT');

Note	Based on the Auth data configured in your environment, you may need modify the ids defined in the scripts above.

Local Testing

Stripe ACH transaction results are always communicated via webhook interactions. To get the webhooks setup up for local testing, see Testing locally documentation.

Going to Production

Make sure that you’ve finished enabling ACH payments with the Stripe Dashboard.
Make sure that you’ve defined your production webhooks & provided your webhook endpoint secret to the Broadleaf ecosystem