Back to Stripe Payment Gateway Main Page
Table of Contents
What is the Stripe Payment Gateway?
The Stripe Payment Gateway is an integration of the Stripe payment system in CRM.COM, which can be used to accept customer payments online.
Stripe Payment Gateway Glossary
| Term | Description |
|---|---|
| Payment Method | Payment Method is used to determine how a customer chooses to pay an amount of money, and is defined on the Financial Transaction |
| Payment Preference | Payment Preferences are used to define the preferred method of paying an outstanding amount of money, and is defined on the Accounts Receivable |
| Stripe Card | A payment card that has been registered (and authorised) in Stripe, and can be used from now on to make online payments. Stripe handles the transfer of money between the bank accounts of the customer and of the company. |
Stripe Payment Gateway Request | A communication created between CRM.COM and Stripe to either register a card or to complete a payment. Information on requests, created via a batch run, which is used to perform recurring payments for unsettled Bills, is stored in CRM.COM and is can be used for payment confirmation and/or troubleshooting. |
Stripe Payment Gateway Key Processes and Concepts
| Processes / Concept | Description |
|---|---|
| Registering a Stripe Payment Gateway Customer | In order for a company that has CRM.COM to be able to accept online payments via Stripe, it must be registered with Stripe as a Merchant. |
| Registering your customer's cards to Stripe | Any valid payment card such as Visa, American Express or MasterCard can be registered into Stripe via CRM.COM. The required registration information is forwarded to Stripe and only the last 4 digits of the payment card are kept in CRM.COM and payments can be completed once the card is registered and verified as valid. Since cards are registered via the Accounts Receivable module, the verification of the card data takes place on saving the Accounts Receivable. |
Paying Bills in batch by using Stripe
| Apart from making manual payments with the Stripe card the card may be used to pay for unsettled Bills, in a recurring basis, without any manual interaction. This is done in a batch mode, given that the Stripe card is authorised for Recurring Payments. This is accomplished by configuring a recurring run that can identify unsettled Bills (using a selection of set criteria) that can be paid via a Stripe card. For each Bill a Stripe Payment Gateway Request is created and sent to Stripe which will in turn, accept or deny the request (displaying the appropriate success or error message) For more information view Using Stripe Payment Gateway Run APPLICABLE UP TO CRM.COM R10 |
| Refunding Stripe cards | When a payment executed using a Stripe card is cancelled in CRM.COM, the card can be automatically refunded. In order to enable this functionality you need to configure the Payment Cancellation Types that will trigger automatic refunding in the Stripe Payment Gateway Provider. |
| Automatic Wallet Top up AVAILABLE FROM CRM.COM R11.0.0 | Wallets are mini accounts which primarily handle financials related to Rewards and Prepaid Subscriptions. Funds from the Wallets are deducted, usually when a Payment is made for a Prepaid Subscription, or when a Rewards Participant redeems his awards. A functionality is available to detect whether the balance of the Wallet has gone under a certain amount, and if so, the System will create a Payment Request to the Payment Gateway the customer has registered with, to automatically top up the Wallet. This is particularly helpful in cases where the customers make a Subscription with a recurring fee, and would like to automatically make a payment whenever required, so that their Subscription is never deactivated |
Automatic Bill Payment AVAILABLE FROM CRM.COM R11.0.0 | Unsettled Bills can be directly paid by requests made to the Payment Gateway. In this way a Bill will always get handled before it is due, without customers worrying whether the payment has been made. This works like a Direct Debit requests, however in this case is electronically handled via a Payment Gateway. |
Stripe Payment Gateway Access & Viewing Controls
Network Characteristics define the level of access for each record. i.e., whether the record will be available for selection, viewing or editing.
Entity | Network Characteristics | Description |
|---|---|---|
Stripe Payment Gateway Provider | Stripe Payment Gateway Provider has no access restrictions. It can be viewed and selected by all users. | |
| Stripe Payment Gateway Requests | Stripe Payment Gateway Requests have no access restrictions. They can be viewed and selected by all users. | |
| Stripe Payment Gateway Runs | Stripe Payment Gateway Runs have no access restrictions. They can be viewed and selected by all users. |
Stripe Payment Gateway Related Modules
| Entity | How Stripe interacts with the entity |
|---|---|
| Wallets AVAILABLE FROM CRM.COM R11.0.0 | System can be set to automatically top-up Wallets when their balance falls to a defined amount |
| Accounts Receivable | The details required by the Stripe, for example, Credit Card or Bank account number are saved on the Payment Peferences of the Accounts receivable |
| Bills | Bills can be settled by Payments executed through the Payment Gateway |
Stripe Payment Gateway - Business Examples
The following section provides business examples of how the Stripe Payment Gateway module is used in CRM.COM .
Register a Stripe Card for an existing Customer
Business Requirement
An existing customer of ZX company wishes to change his account's Payment Preferences in order to settle his balance using his credit card.
CRM.COM Solution
- Configuration
- Configure an Accounts Receivable Payment Preference using Stripe Payment Gateway Type, to be used on Accounts Receivable, for customers that choose to handle their balance using Stripe
- Create a Payment Method for Stripe to be used when creating Payments
- Configure Stripe Payment Gateway Provider
- Set Stripe as the Payment Method. (In this way, every time a payment is created in the system with Stripe Payment method, a Stripe request will be created)
- User Process
- Agent navigates to the customer's current account
- Stripe is selected under Payment Preferences, and fields for registering the card are made available
- Agent registers a Stripe card for the customer, creating a Stripe account for the customer in the process
- Once the account is saved, the new card is validated by the Stripe system and is either accepted or rejected
More Information on Payment Gateway Cards can be found at: Registering a Credit Card with Stripe