Stripe Payment Provider Setup

The Stripe Payment Provider Setup feature allows administrators to integrate with Stripe to process credit card payments directly within the system. Its primary purpose is to provide a secure and seamless checkout experience for users while simplifying financial reconciliation for your operations. This article is intended for OPS-COM administrators responsible for financial setup and payment gateways.

Setup and Configuration

This feature requires configuration within the OPS-COM administration portal as well as the external Stripe developer dashboard.

Admin Side: Administrators must have the appropriate system role permissions enabled to access the payments configuration menus and establish external integrations.

User Side: End-users interact with this feature seamlessly during the checkout process on the web portal or when interacting with field staff using handheld devices.

Admin Portal Configuration

1. Hover over System Configuration, click Payments, then Setup Payment Types.

2. Click the Add Type button.

3. Click the Payment Provider drop-down menu and choose Stripe.js.

4. Name the payment type, select the applicable user types, and click the Settings tab.

5. Enter your Stripe public key into the Publishable Key field.

6. Enter your Stripe secret key into the Secret Key field.

7. Verify that the Currency setting is correct for your region (the default is US dollars).

Only enter testing credentials into the configuration fields until you are completely ready for your users to have live access to this payment method.

Stripe Web hook Configuration

Webhooks are absolutely essential for Stripe to notify OPS-COM regarding payment successes or refund completions. Without these webhooks correctly configured, the system will not communicate any transaction information back to OPS-COM.

Register Your Endpoint

To begin receiving notifications, you must define exactly where Stripe should send the transaction data.

1. Navigate to your Stripe Dashboard, click Developers, and select Webhooks.

2. Click the Add Destination button to open the configuration window.

3. Select the specific event types the system needs to process (payment_intent.succeeded, payment_intent.payment_failed, and payment_intent.canceled).

4. Click the Continue button.

5. Select Webhook endpoint and click the Continue button.

6. Enter a descriptive name for the webhook.

7. Enter the specific URL provided by OPS-COM into the Endpoint URL field (e.g., https://[CLIENTID].ops-com.com/api/system/payments/stripe/callback).

Retrieve Your Signing Secret

Once the endpoint is created, Stripe generates a unique security key to verify that the data sent to your server is authentic.

1. Locate the Signing secret section on the summary page for your newly created webhook.

2. Click the Reveal button to display the string (which typically begins with the prefix whsec_).

3. Copy this entire string and navigate back to your OPS-COM payment settings.

4. Paste the copied secret into the Webhook Secret field.

5. Copy the Destination ID provided by Stripe.

6. Paste the ID into the Webhook ID field to ensure all incoming data is securely verified.

Ensure that your Webhook Secret is correctly matched between Stripe and OPS-COM to prevent pending status errors on completed payments.

Using this Feature

The checkout process is optimized for both web portal users and administrators using handheld devices in the field.

Web Portal Transactions

1. Click the Pay with Credit Card button when you reach the final stage of a transaction to open the secure payment form.

2. Enter the required credit card details into the form.

3. Click the Submit Payment button to complete the purchase.

Handheld App Transactions

1. Tap Checkout to open the payment summary within the OPS-COM for Android app.

2. Tap Select Payment Method and choose Stripe.

3. Tap and Hold the Process Payment button to finalize the transaction.

Managing Transactions and Reports

Administrators can seamlessly review all processed payments and manage financial returns through the standard reporting interfaces.

1. Hover over Financial Management, click Transaction Reports, then Recent Payments.

2. Review the Status column to determine the current state of each payment, and the Payment Date column to see exactly when the transaction occurred.

3. Click the View Details icon next to a specific transaction to see the full Stripe receipt.

4. Click the Refund Payment button to initiate a return of funds.

5. Click the Confirm Refund drop-down menu and choose Full Refund to finalize the reversal.

Best Practices and Considerations

• Perform thorough deployment testing: Organizations should always keep Live Mode disabled during the initial deployment until all testing is verified with test credit card information. It is highly recommended to process a single, small test transaction in Live Mode using a real card before making the payment option available to the general public.

• Maintain strict security requirements: Maintaining the security of your financial environment is critical. You should never share your Stripe secret key or webhook secret with anyone, nor should you store it in plain text outside of the secure administration configuration screens.

• Rotate security keys regularly: Change the signing secret periodically. Additionally, ensure you only subscribe to the strictly required event types within Stripe to minimize unnecessary data transmission.