Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Back to Generic Gateways Main Page

Status
colourYellow
titleAvailable from CRM.COM R11.0.0

Excerpt
hiddentrue

Understand the usage of Payment Gateways within CRM.COM

Panel
nameblue

Table of Contents

Table of Contents

What are Payment Gateways?

Payment Gateways are 3rd party systems third-party systems used to perform paymentsPayments. CRM.COM has an integration is  integrated with the Stripe Payment Gateway, however, it also supports partial handling of payments for other 3rd party, Payment Payments for other third-party Payment Gateways, referred to as Generic Gateways. CRM.COM , creates Payment Requests , for Payments that are destined intended for Generic Gateways , and these requests which can be further handled by WEB APIs. For example, CRM.COM Web APIs , can be can, for example, be used to gather collect all the Payment Requests that require handling by a Payment Gateway, as well as to update CRM.COM with the results , such as completing or rejecting the Payment Requestsof the Payment Requests.  i.e., whether the Requests were completed or rejected.

Payment Gateways Glossary

TermDescription
Payment GatewayPayment Gateway is the framework that allows a merchant Third-party Systems that provide a framework for merchants to accept Credit Card and other forms of electronic payments. These are 3rd party systemselectronic payments.
Generic Payment Gateway ProviderWithin CRM.COM Generic Payment Gateway Providers, are the Payment The Payment Gateways for which no direct integration exists with CRM.COM.
Stripe Payment Gateway ProviderStripe Payment Gateway Provider  is Provider is a built-in integration of CRM.COM and the Stripe payment gatewayPayment Gateway.
Payment RequestThese are requests for Payments A Request for Payment created within CRM.COM , and that require requires processing by 3rd third-party Payment Gateways , whether this is such as Stripe or by a Generic Payment Gateway.
"Pending Verification" PaymentPayments created in CRM.COM that require further processing by 3rd a third-party Payment Gateway. The CRM.COM Payment can only be posted once the Payment Gateway updates CRM.COM with a successful resultthat it was successful.
"Pending Verification" Payment CancellationPayment Cancellations created

Payments that have been cancelled in CRM.COM that require further processing by

3rd

a third-party Payment Gateway. The CRM.COM Payment can only be posted once the

Payment

Gateway updates CRM.COM

with a

that it was successful

result

.
Payment Gateway account refunds customer when CRM.COM Payment Cancellation

should refund the customer on the Payment Gateway's side
Payment Gateway merchant accountThe account

takes place.

Payment Gateway Merchant AccountThe Payment Gateway 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, your business), from where customer Payments will be effected and from where money will be is 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 / ConceptDescription
Automatic Wallet Top-upWallets are mini simple accounts which primarily handle financials related to the financial transactions involving Rewards and Prepaid Subscriptions. Funds from the Wallets a Wallet are deducted , usually when a payment is made for a Prepaid Subscription , is billed or when a Rewards Participant redeems his awardsParticipants redeem their Awards.
A functionality is available to detect which detects whether the balance of the Wallet Balance has gone under fallen beneath a certain amount, and if so, the System will create threshold, in which case the System automatically creates a Payment Request to Top-up the Wallet to the Payment Gateway the customer has is registered with, to automatically top up the Wallet.
This is particularly helpful in cases where the customers make useful to avoid the interruption of a Subscription Service with a recurring fee, and would like to automatically make a payment whenever required, so that their Subscription is never deactivatedwhich requires automatic payments.
Automatic Bill PaymentUnsettled Bills can be directly paid by requests Requests made to the Payment Gateway. In this way, a Bill will is always get handled before it is due, without customers the customer worrying whether the payment Payment has been made. This works functions like a Direct Debit requestsRequest, however which in this case is electronically handled via a Payment Gateway.
Refunding Cancelled PaymentsWhen a Payment that was handled and successfully completed 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 be refunded. A request is created to be handled by the Payment Gateway and to refund the customer accordingly, deducting money from the merchant's account.
Communicating Payment Gateway information Information to customersCustomers

Payment Gateway Cards and Payment Gateway Requests can be communicated to customers through email or SMS using Communication Tags which will retrieve data specific to the customer data. Lists with of customer accounts (known as Segments) that have Payment Gateway Requests or Payment Gateway Cards can be created and used in various places in parts of 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.se. to all customers that belong in a Segment.


Payment Gateways Access & Viewing Controls

Business Network Characteristics define the level of access for each recordentry. i.e. Whether , whether it will be available for selection, for viewing or editing etc.

EntityNetwork CharacteristicsDescription

Generic Gateway Provider

Global Viewing Access Entities

Generic Gateway Provider has no access restrictions. It can be viewed and selected by all users.
Payment Gateway RequestsGlobal Viewing Access EntitiesPayment Gateway Requests have no access restrictions. They can be viewed and selected by all users.
Payment Gateway RunsGlobal Viewing Access EntitiesPayment Gateway Runs have no access restrictions. They can be viewed and selected by all users.

 

Payment Gateways Related Modules

EntityInteraction of Payment Gateways with the Entity
WalletsSystem can be set to automatically top-up Wallets when their balance falls to a defined amountbelow a certain threshold.
Accounts ReceivableThe details required by the Payment Gateway , for example, (e.g. Credit Card or Bank account number) are saved on the Payment Peferences Preferences of the Accounts receivableReceivable.
BillsBills can Billscan be settled by Payments executed through the Payment Gateway.
StripeStripe is a Payment Gateway with which CRM.COM has integrated with, and is integrated. CRM.COM uses the Automatic Payment Run Definitions to update Stripe with the payments Payments that must be handled.

 

Payment Gateways - Business Examples

The following section provides business examples to help you understand of how the CRM.COM Payment Gateways module is used.

Handling Payments Online via a Payment Gateway

Panel
nameblue
titleHandling Payments Online via 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 a Zulu account at Zulu. Zulu is updated with any the payments made in CRM.COM in on an hourly basis , and in return, responds to CRM.COM with either a successful success or erroneous error message. Payments to be handled by Zulu are the following:

  • Manual Payments (When customers call in to make a payment)
  • Automatic Bill Payments (When for unsettled Bills exist)
  • Automatic Wallet Top-Up (When when the amount of the Wallet goes to 0 amount reaches €0, 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 Identifier field to be the Payment Medium Identifier
      (to be used when registering the customer Accounts Receivable. , use the 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 Wallet with €20 every time the balance goes to 0 amount and its Balance reaches €0 and if its related Accounts Receivable belongs to the newly created specified 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 Definition should be scheduled to be executed every 1 hour.
  • User Process
    • Accounts Receivable:
      • When the user must register registers 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 as 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 "a 'Pending Verification" ' Life Cycle State State. 
    • Technical Staff is responsible for implementing a communication to Zulu (every hour) to inform them of the new Payments that should be made, Payments to beeffected(using CRM.COM WEB APIs to gather collect pending Payment Requests) and update CRM.COM with Zulu's responses on the Payment Requeststhe respective responses from Zulu.
 
        • .
Panel
namegrey

Related Areas

Filter by label (Content by label)
showLabelsfalse
spacesV4Manual
showSpacefalse
labelspayment-gateways-basics,payment-gateways-advanced,payment-gateways-admin