III. Setup & Usage

Once all the necessary apps are installed, certain DocTypes must be created to make Stripe Plus Settings work. Instructions on how to create them are shown below.

Setting Up Stripe Settings

The Stripe Settings is required for Frappe to connect with a Stripe account. To set one up, do the following:

1. Create a new Stripe Settings doc.
2. In the form pop-up, name the Stripe Settings.
3. For the keys, go to your stripe.com dashboard.
4. In the dashboard, navigate to the bottom bar and click the Developers button. A menu will appear and from it, select API Keys.
5. Click the Publishable Key Token value to copy it.
6. Navigate back to the Stripe Settings pop-up and paste the copied text to the publishable_key field.
7. Repeat steps 5 and 6 for the Secret Key.
8. Click Save.

Setting Up Payment Gateway

ERPNEXT simulates online payment from customers through the Payments app. There are various payment gateways offered and Stripe is one of them. To create one, do the following:

1. Create a new Payment Gateway doc.
2. In the pop-up, click the Edit Full Form button to reveal all the necessary fields.
3. In the form, name the gateway. Select Stripe Settings in the gateway_settings field. Select the Stripe Settings doc you created in the gateway_controller field.
4. Click Save.

Setting Up Payment Gateway Account

The Payment Gateway Account is used for accounting in ERPNEXT. In Stripe Plus, it is used to determine the Stripe account used in Payment Requests.

1. Create a new Payment Gateway Account doc.
2. In the form, select the Payment Gateway doc in the payment_gateway field and select the Account dedicated for Stripe in the payment_account
3. Click Save.

Setting Up Basic Stripe Plus Settings

When enabled, Stripe Plus overrides the Payments app, extending the features and capabilities of Stripe.

1. Go to Stripe Plus Settings.
2. Click the Enable Stripe Plus checkbox.
3. Click Save.

Setting Up a Stripe Payment Method Configuration

A Stripe Payment Method Configuration is a collection of payment methods. It is customizable and can be chosen for a specific Customer or Payment Request.

Configurations readily available in one’s Stripe account (in stripe.com) can still be added by importing and Configurations created in ERPNext are automatically synced and added to the stripe.com.

Importing Stripe Payment Method Configuration

1. Go to the Stripe Payment Method Configuration List.
2. Click the Import from Stripe Account button. This will ask for a Stripe account to use.
3. Select the Stripe account you want to import configurations from and proceed. A pop-up will appear with a list of Configurations not yet added to your site.
4. Select the Configurations to import by clicking the checkbox.
5. Click Import Configurations.
6. Optional: Go to a Configuration and bind a customer to it by adding a customer in the Affected Customers table.

Creating a new Stripe Payment Method Configuration:

1. Create a new Stripe Payment Method Configuration.
2. In the form, select a Stripe Settings and name the configuration. Then, add at least one Payment Method.
3. Optional: Bind a customer by adding a customer in the Affected Customers table.
4. Click Save.

Using Stripe Plus in Payment Request

1. Select the Payment Gateway Account for Stripe
2. Select a Stripe Payment Method Configuration. If the field is empty, the default configuration will be used.

Customizing the Checkout/Payment Page (Optional)

The header of the Checkout/Payment page displays the company’s name and logo. But in the Stripe Plus Settings, these can be overridden.. To override them, set a value for the payment_page_company_name and payment_page_company_logo fields.

Setting Up Advanced Stripe Plus Settings (Optional)

The Advanced Features allows logging, notifications and accounting automation. Logging is automatically active once Advanced Features is enabled, while notifications and accounting automation requires additional configurations.

Enabling Advanced Features

1. Go to your Stripe dashboard. Navigate to the bottom bar and look for the Developers menu button.
2. Click the button and choose Webhooks. Wait until a pane appears.
3. From the pane, click the Add destination button.
4. Select all events related to Charge, Payment Intent, Setup Intent and Payout, then click Continue.
5. Choose the destination type to Webhook endpoint, then continue.
6. Set a destination name and set the endpoint url to https://<sitename>/api/method/erpusa.stripe_plus.api.webhook_receiver.receive_stripe_events.
7. Finally, create the destination.
8. Once the destination is created, look for its signing secret and copy it.
9. Go back to your site and open Stripe Plus Settings. Click the Advanced Features tab.
10. In the Signing Secret List table, add a row where the Stripe Settings is the account you used and the Signing Secret is the text you copied.

Enabling Email Notifications

1. Click the Turn on email notifications checkbox.
2. Change the notification_method to Realtime to get notified exactly when a payment is made or to Daily Digest to get a summarized list of payments based on a schedule.
3. Add at least one email address in the notification_recipient field. For multiple recipients, separate the email addresses with a comma (,).
4. For Daily Digest notifications, populate the Notification Schedule table. Add at least one by choosing an hour and minute precision. Add an optional label next to the schedule to replace the time string in the email.

Enabling Automation for Payment Entry

Sales Invoice and Orders paid through Stripe can automatically have a Payment Entry as part of the Advanced Features.

1. Select an Admin or Accounts Manager for the user_to_authorize to allow the creation of Payment Entry in the background.
2. Set a merchant_fee_account and a merchant_fee_cost_center.
3. Depending on your preference, check the Autosubmit payment entry checkbox to have the Payment Entries submitted upon creation.

Enabling Automation for Journal Entry

Bank Deposits made by Stripe (Payouts) can automatically be accounted for via Journal Entry as part of the Advanced Features. This requires an existing payout in your Stripe dashboard.

1. Under the ERP-Stripe Accounts table, bind a Stripe Payout Account with an ERPNEXT account and bank account:
   • Select the dedicated Account for Stripe for erp_account.
   • Select the Bank Account for erp_bank_account.
   • Go to your Stripe dashboard and select a Payout
   • In the Payout details, look for the bank account ID (format: ba_xxxxxxxxxx) and copy it.
   • Paste the copied ID to the stripe_payout_account.
2. Depending on your preference, check the Autosubmit journal entry checkbox to have the Journal Entries submitted upon creation.