Stripe
- p_demou (Deactivated)
- Persia Xenopoulou (Deactivated)
- Frini Pouyiouka
On this page
Overview
The Stripe payment gateway is an integration of the Stripe payment system in CRM.COM and is used to accept payments online. To use the integration, a merchant account registered with Stripe is required.
Refer to Generic Gateways and PayPal for integration with other payment gateways.
Stripe functionality
- Credit cards such as Visa, American Express or MasterCard are registered with Stripe though CRM.COM and can be accepted for payments once verified.
- Processing online payments (between company and customer
- Processing transactions resulting from CRM.COM payment cancellations and refunds.
- Gateway runs create payment requests for unsettled bills or wallet top-ups.
- Payment requests are automatically created when manual payments related to Stripe are created or when payment gateway runs are executed.
Setting Up Stripe
Stripe payment gateway provider
The Stripe payment gateway provider is used to define communication parameters and to set up triggers for payment and refund requests.
Provider fields
The table describes the sections of Stripe Payment Gateway Data Entry page and explains how the fields in the page are used.
Mandatory
Configurable
Main Information | |
|---|---|
| |
| Supported Attributes Defines the attributes that must be used by payments and refunds which should be processed by Stripe | |
Select payment methods that will trigger the creation of a Stripe requests on payment posting. The same methods cannot be included in more than one payment gateway provider. | |
A list of currencies supported by Stripe. It is possible to support all currencies or specific ones. An account payment preference associated with Stripe can only be selected (when creating a payment transaction) if the currency of the accounts receivable is included in the list of currencies supported by Stripe. A payment method is selected when a payment transaction is created. If the method is associated with Stripe but the currency of the accounts receivable is not included in Stripe's list of supported currencies, then the account payment preference field will not be available. | |
When a payment made through Stripe is canceled in CRM.COM the account is refunded. Define the Payment Cancellation Types that will trigger the submission of a Stripe payment cancellation when posted. | |
Automation Settings | |
| Payments | Define default values that the Stripe automatic payment runs will use to settle bills or top-up wallets.
Default Notes |
Related configuration areas
Mandatory modules must be configured for the Stripe module to work.
Optional modules may be configured for the module to operate at its full capacity.
| Manual Link | Area | Description | Configuration Type |
|---|---|---|---|
| Financial Transactions | Payment Type | Create the type of payment that will be created and processed by Stripe when automated processes such as bill payments and wallet top-ups are triggered. | Mandatory |
| Financial Transactions | Payment Cancellation Type | Create the types of payment cancellation that will trigger a Stripe payment cancellation request. | Optional |
| Financial Transactions | Payment Methods | Create the methods of payment that will trigger Stripe requests and then add them to the Stripe payment gateway provider. A method must be added in the 'allowed payment type methods' to be available. | Mandatory |
| Accounts Receivable | Payment Preference | Create the payment preference that is associated with Stripe. The preference should be set on the customer's accounts receivable together with additional information, such as online account credentials. | Mandatory |
| Wallets | Wallet Definitions | Set the rules that will be used to top up the wallets of customers through Stripe requests. | Optional |
| Platform | Currencies | Define the currencies that will be supported by Stripe. | Mandatory |
Using Stripe Gateway
Finance > Payment Gateways > Stripe > Manage Payment Gateway Requests
Integration with a payment gateway enables the handling of payment and refund requests between CRM.COM and online accounts belonging to customers.
Requests are triggered when payments, refunds or payment cancellations, using methods and types supported by the provider, are manually created in the financial transactions Data Entry page.
Payment gateway runs also create requests to:
- Settle outstanding bills, subject to the payment preferences of the account.
- Top up wallets that fund prepaid subscriptions when the wallet's threshold (set in CRM.COM) is crossed.
Payment gateway requests are further processed using WEB APIs and sent to the gateway. The life cycle state of the request is updated to 'Posted' or 'Rejected', accordingly.
All requests are available through a dedicated Summary page. Requests cannot be processed further and do not have a Data Entry page.
Payment gateway requests fields
The table describes the fields of the Gateway Summary page and explains how the fields are used.
Number | An auto-generated unique ID for each gateway request. |
|---|---|
| Payment Gateway Provider | Processes the gateway request |
| Type | 'Payment', 'Refund' or 'Payment Cancellation'. |
| Payment Gateway Run | The processing run that automatically created the request. |
| Payment | The number of the refund created in CRM.COM. |
| Payment Cancellation | The number of the payment cancellation created in CRM.COM; applies to generic payment providers only. |
| Payment Gateway Reference Number | The number provided by the payment gateway. The number is assigned when a request is 'Posted' or 'Rejected' and therefore not available for requests in other life cycle states. |
| Account Number | The number of the accounts receivable associated with the payment gateway request. |
| Paid Bill | The number of the bill that was paid or is intended to be paid. |
| Topped-up Wallet | The number of the wallet that was topped-up.
|
| Execution Date | The date on which the request was posted or rejected by the payment gateway provider. |
| Life Cycle State | Requests can be in one of the following states:
'Pending' or 'Under Processing' requests can be rejected or posted through WEB APIs. |
| Error Code | Received by the payment gateway provider, in case of error. |
Registering Stripe cards and processing gateway requests
Validations take place before an action is initiated (prerequisite) or after it is submitted (postcondition).
Registering a Stripe card in CRM.COM
A Stripe payment gateway card allows customers to make online payments and handles the transfer of funds from the customer the seller. Cards are registered through the payment preference section of the accounts receivable module. Only the last four digits are kept in CRM.COM, for security purposes. Multiple cards can be registered for each payment preference, but each card can only be associated with one payment preference. The customer can select which Stripe card to use.
- Select an accounts receivable and click on EDIT.
- In the payment preferences section select STRIPE PAYMENT (the preference must have been previously configured to be available).
- Click on REGISTER CARD and provide the information requested in the modal window.
- Click on SAVE.
Select a DEFAULT Stripe Payment Gateway Card.
Enable 'Use for Recurring Payments' to automatically settle bills and/or top up the customer's wallet using cards registered under the Stripe Payment Preference.
Stripe card information is verified when the accounts receivable is saved. If it fails to verify, an error message is displayed and the card is not registered.
| Preconditions | The company must have an active Stripe account. Stripe payment method must be configured in the system and included in the Stripe payment gateway provider. |
|---|---|
| Postconditons | Each card can be related to only one accounts receivable payment preference. |
Creating Stripe requests through payment gateway runs
Finance > Payment Gateways > Perform Automatic Payment Runs
Payment gateway requests are created when payments, refunds or payment cancellations (associated with the gateway through their type or method) are created in CRM.COM.
Additionally, automatic payment runs identify bills to be paid or wallets that should be automatically topped up through a payment gateway.
Bill Payment: Unsettled bills can be paid through the payment gateway before they are due, sparing the customer of the anxiety associated with its timely payment. The process is similar to a direct debit transaction. The automatic payment run identifies bills that meet predefined criteria and creates the respective payment requests.
Wallet top-up: Requests can be used to automatically top-up the wallet of prepaid subscribers from their online accounts, ensuring that the service is not interrupted. The system detects when the wallet balance crosses a predetermined threshold and automatically creates a top-up request through the customer's gateway.
To enable wallet top-up, configure the top-up rules in the active wallet definition. Define the threshold that triggers top-up, the amount to credit the wallet and frequency at which the balance should be checked. Once the system is set up, the automatic payment run will create payment requests for wallets that meet predefined criteria.
To create an automatic payment run, navigate to Perform Automatic Payment Runs and create a NEW definition. Select a gateway provider, supply scheduling settings and SAVE. Once completed SUBMIT the run to create the requests.
Automatic Payment Run Definition fields
Mandatory
Configurable
| Main Information | |
|---|---|
The Only 'Effective' | |
| Process Runs | |
| Process Run Information related to processed requests. |
Additional information
| Bill Prerequisites |
| |
|---|---|---|
| Wallet Prerequisites |
| |
| Postconditions | If a 'Pending' or 'Under Processing' payment request already exists for the wallet identified for a top-up or for the bill to be paid, then the request will not be created (to avoid payment request duplication). | |
Applying business flows on Stripe
Refunding canceled payments
Customers can be refunded if Stripe payments are canceled in CRM.COM. A Stripe request is created to return funds from the merchant to the customer.
Communicating Stripe card and payment information
Stripe information, such as payment gateway requests or Stripe cards details can be communicated through the communications Data Entry page. You can use tags (text that is automatically replaced by values specific to selected records) related to Stripe cards and payments when creating communications. Tags are available for selection by typing '#'.
Refer to the communications manual for a comprehensive list of Stripe tags.
Configure CRM.COM to automatically inform customers when payments or refunds are effected by Stripe. For information on setting this up, refer to event-based communications.
Stripe Analytics
Segmenting Stripe
Stripe requests with common business characteristics can be grouped together. The resulting segments can be used in system business processes, such as identifying customers or for simple statistical calculations. For information on segmentation and how you can create Stripe lists, refer to Segmentation.
Stripe Business Example
Stripe card registration
Scenario 1
A Company ZX customer wants to start using their credit card for making payments.
Solution
Configuration
- Configure an accounts receivable payment preference using a Stripe payment gateway type for customers who want to handle their payments through credit cards.
- Create a Stripe payment method
- Configure a Stripe payment gateway provider
- Set Stripe as the payment method so that a Stripe request is triggered whenever a payment using the Stripe method is created in the system.
User Process
- Agent locates customer account.
- Stripe is selected under payment preferences and the required fields for registering the card are made available.
- Agent registers a Stripe card on behalf of 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 accepted or rejected.
Notes
If you are using a previous release, view CRM.COM Release Changes.
Glossary
| CRM.COM Term | Definition |
|---|---|
| Wallet | A customer account whose credit balance is used to fund transactions within CRM.COM. |
| Prepaid Subscription | A selection of customer services that are renewed automatically, billed on a recurring, usage or one-time basis and paid in advance. Prepaid subscriptions are funded directly from a subscriber's wallet. |
| Bill | An itemized account of the cost of physical goods supplied, termed, usage and one-time services rendered and Subscription or Job expenses. Bills consist of the invoices and credit notes created by the system for an account during the period the bill covers. |
| Accounts Receivable | A ledger of the financial transactions carried out between a company and its customers, such as invoices and payments. The accounts receivable keeps a running balance of debits and credits and displays the amount a company is owed in exchange for goods supplied and services rendered. |