Back to Generic Gateways Main Page
AVAILABLE FROM CRM.COM R11.0.0
Table of Contents
What are Payment Gateways?
Payment Gateways are 3rd party systems used to perform payments. CRM.COM has an integration with Stripe Payment Gateway. However, it supports partial handling of payments for other 3rd Party Payment Gateways, referred to as Generic Gateways. CRM.COM, creates Payment Requests, for Payments that are destined for Generic Gateways, and these requests can be further handled by WEB APIs. For example, CRM.COM Web APIs can be used to gather all the Payment Requests that require handling by a Payment Gateway, as well as update CRM.COM with the results, such as completing or rejecting the Payment Requests.
Payment Gateways Glossary
| Term | Description |
|---|---|
| Payment Gateway | Payment Gateway is the framework that allows a merchant to accept Credit Card and other forms of electronic payments. These are 3rd party systems. |
| Generic Payment Gateway Provider | Within CRM.COM Generic Payment Gateway Providers, are the Payment Gateways for which no direct integration exists. |
| Stripe Payment Gateway Provider | Stripe Payment Gateway Provider is a built-in integration of CRM.COM and Stripe payment gateway |
| Payment Request | These are requests for Payments created within CRM.COM, and that require processing by 3rd party Payment Gateways, whether this is Stripe or a Generic Payment Gateway |
| "Pending Verification" Payment | Payments created in CRM.COM that require further processing by 3rd party Payment Gateway. The CRM.COM Payment can only be posted once the Payment Gateway updates CRM.COM with a successful result |
| "Pending Verification" Payment Cancellation | Payment Cancellations created in CRM.COM that require further processing by 3rd party Payment Gateway. The CRM.COM Payment can only be posted once the Payment Gateway updates CRM.COM with a successful result. CRM.COM Payment Cancellation should refund the customer on the Payment Gateway's side |
| Payment Gateway merchant account | The account owned by the business (that also has CRM.COM System) at the Payment Gateway. This is the account to where customer payments will be made, and from where the money will be taken for refunds. |
| Payment Method | Payment Method is used to determine how a customer chooses to pay an amount of money and is defined when creating a Payment |
| Payment Preference | Payment Preference is used to define the preferred method of paying an outstanding amount of money and is defined on the Accounts Receivable |
Payment Gateways Key Processes and Concepts
| Processes / Concept | Description |
|---|---|
| Automatic Wallet Top up | 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. 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 | 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. |
| Refunding Cancelled Payments | When a Payment that was handled via a Payment Gateway and successfully completed, is cancelled in CRM.COM, then the customer must receive a refund for his money. In such cases, a request will be created that is to be handled by the Payment Gateway and refund the customer accordingly, deducting money from the merchant's account. |
| Communicating Payment Gateway information to customers | Payment Gateway Cards and Payment Gateway Requests can be communicated to customers through email or SMS using Communication Tags which will retrieve specific to the customer data. Lists with customer accounts that have Payment Gateway Requests or Payment Gateway Cards can be created and used in various places in the System. These lists are known as Segments. One of the CRM.COM areas that can make use of Segments is Notifications which can be used to send Communications in bulk, i.e. To all customers that belong to a Segment. |
Payment Gateways Access & Viewing Controls
Business Network Characteristics define the level of access for each record. i.e. Whether it will be available for selection, for viewing or editing, etc.
| Entity | Network Characteristics | Description |
|---|---|---|
Generic Gateway Provider | Generic Gateway Provider has no access restrictions. It can be viewed and selected by all users. | |
| Payment Gateway Requests | Global Viewing Access Entities | Payment Gateway Requests have no access restrictions. They can be viewed and selected by all users. |
| Payment Gateway Runs | Global Viewing Access Entities | Payment Gateway Runs have no access restrictions. They can be viewed and selected by all users. |
Payment Gateways Related Modules
| Entity | Interaction of Payment Gateways with the Entity |
|---|---|
| Wallets | System can be set to automatically top-up Wallets when their balance falls to a defined amount |
| Accounts Receivable | The details required by the Payment Gateway, for example, Credit Card or Bank account number are saved on the Payment Preferences of the Accounts Receivable |
| Bills | Bills can be settled by Payments executed through the Payment Gateway |
| Stripe | Stripe is a Payment Gateway with which CRM.COM has integrated with, and uses the Automatic Payment Run Definitions to update Stripe with the payments that must be handled |
Payment Gateways - Business Examples
The following section provides business examples to help you understand how CRM.COM Payment Gateways module is used.
Handling Payments Online via a Payment Gateway
Business Requirement
Company ZX has its merchant account registered with Zulu Payment Gateway. Zulu is a Payment Gateway that handles Credit Card payments. Customers that wish to make their payments using Credit Cards must also have an account at Zulu.Zulu is updated with any payments made in CRM.COM on an hourly basis, and in return, responds to CRM.COM with either a successful or erroneous message. Payments to be handled by Zulu are the following:
- Manual Payments (When customers call in to make a payment)
- Automatic Bill Payments (When unsettled Bills exist)
- Automatic Wallet Top Up (When the amount of the Wallet goes to 0 amount it should be topped up with €20
CRM.COM Solution
- Configuration
- Create a Payment Method for Zulu (to be used when creating a new Payment in CRM.COM
- Create a Payment Preference for Zulu and set the identifier field to be the Payment Medium Identifier (to be used when registering the customer Accounts Receivable. Payment Medium Identifier to be used to save the Credit Card number)
- Create a Generic Gateway Provider for Zulu
- Create an Accounts Receivable Classification to be used in Wallet Definitions Top Up Rules
- Configure Wallet Definitions "Top Up Rules" to top up the wallet with €20 every time the balance goes to €0 amount and its related Accounts Receivable belongs to the newly created Accounts Receivable Classification
- Configure Automatic Payment Run Definitions to create Payment Requests for unsettled Bills and Wallets that need to be topped up. The definition should be scheduled to be executed every 1 hour
- User Process
- Accounts Receivable:
- When the user must register an Accounts Receivable with Zulu Gateway details, then the Zulu Payment Preference must be selected, and the Credit Card number of the customer to be provided with an Identifier
- The Classification of the account should be set to the one configured in the Wallet Top Up Rules
- Payments
- When a new payment is created the Zulu Presentment Preference, and Payment Method should be selected
These Payments will be created with "Pending Verification" Life Cycle State
- When a new payment is created the Zulu Presentment Preference, and Payment Method should be selected
- Technical Staff is responsible for implementing a communication to Zulu (every hour) to inform them of the new Payments that should be made, using CRM.COM WEB APIs to gather pending Payment Requests and update CRM.COM with Zulu's responses on the Payment Requests
- Use GET payment_gateway_requests/get_pending to update Zulu Payment Gateway
- Once a response is provided by Zulu Payment Gateway, CRM.COM should be updated accordingly, using the following WEB APIs
- Use POST payment_gateway_requests/bulk/post to post the "Pending Verification" Payments which have been successfully completed in Zulu
- Use POST payment_gateway_requests/bulk/reject to reject the "Pending Verification" Payments which have not been successfully completed in Zulu
- Accounts Receivable: