Configuring Stripe Payment Gateway Provider

Back to Stripe Payment Gateway Main Page

Table of Contents

Navigating to the Stripe Payment Gateway Provider

FINANCE > PAYMENT GATEWAYS > STRIPE > SET UP PAYMENT GATEWAY PROVIDER

What is the Stripe Payment Gateway Provider?

The Stripe Payment Gateway Provider is a module used to define the parameters needed to communicate with the Stripe Payment Gateway.  It provides additional configuration options related to Stripe Payment Methods and Cancellation Payment Types for making refunds to registered Stripe cards.

  • Navigate to the Stripe Payment Gateway Provider and click on EDIT to modify or perform required configurations.
  • SAVE the provider once finished or CANCEL any unwanted changes.

Check the Validations & Restrictions Table below for a list of available Actions when working with the Stripe Gateway Provider, including each Action's related validations and restrictions.  View the Attributes Table for a comprehensive description of the Stripe Gateway Provider fields.
STRIPE PAYMENT GATEWAY 

Validations & Restrictions

Action
Validations
Restrictions
Create
  • Mandatory Fields are defined
  • Payment Methods used is not included in any other Gateway Provider
  • AVAILABLE FROM CRM.COM R11.0.0
    • The currencies which are added are also supported by Stripe
      • This validation is done when Stripe is created as effective or if it is set as effective
    • If the mode is set to "Test" then
      • A test secret key must be specified
    • If the mode is set to "Live" then
      • A live secret key must be specified
  • Not Applicable
Edit
  • Mandatory Fields are defined
  • Payment Methods used is not included in any other Gateway Provider
  • AVAILABLE FROM CRM.COM R11.0.0
    • The currencies which are added are also supported by Stripe
      • This validation is done when Stripe is created as effective or if it is set as effective
    • If the mode is set to "Test" then
      • A test secret key must be specified
    • If the mode is set to "Live" then
      • A live secret key must be specified
  • Not Applicable
Delete
  • Not applicable
  • The Provider cannot be deleted

 

Attributes

An * indicates a field is mandatory 

Name

Description

Main Information

Name*

The name of the Payment Gateway Provider.
Alternative Code*The alternative code of the Payment Gateway Provider.
DescriptionThe description of the provider.
Payment Gateway ProviderThe Payment Gateway Provider, which in this case defaults to Stripe and is Read-only.
Life Cycle State*

The Life Cycle State of the Provider.

Applicable up to CRM.COM R10

  • 'Effective on Live': Data created will be processed by Stripe Payment Gateway in Live Mode, resulting in actual transactions when the credit card networks are reached.
    A Live Secret Key is used by the Live Mode.
  • 'Effective on Test': Data created will be processed by Stripe Payment Gateway in Test Mode. The result will not reach the credit card networks, and no cost will be incurred.
    A Test Secret Key is used by the Test Mode.
  • 'Not Effective': No data will be processed by Stripe Payment Gateway

Applicable from CRM.COM R11.0.0

  • Effective: Data created will be processed by Stripe Payment Gateway.
  • Not Effective: No data will be processed by Stripe Payment Gateway
Authentication Settings
Mode
AVAILABLE FROM CRM.COM R11.0.0

The mode that the payment gateway will operate. The supported values are:

  • Test
  • Live

Web API Version
AVAILABLE FROM CRM.COM R11.0.0

The version of the Stripe Web API version which is used for the integration. The supported options are the following:

  • Version 2016-07-06
  • Version 2014-12-22

Test Secret Key*

The Secret Key which is necessary to access Stripe in Test Mode. The Test Secret Key must include the word 'test' as part of the key. The Test Secret Key can be retrieved from the Stripe Dashboard Account Settings.

Live Secret Key*

The Secret Key which is necessary to access Stripe in Live mode. The Live Secret Key should include the word 'live' as part of the key. The Live Secret Key can be retrieved from the Stripe Dashboard Account Settings.
Supported Attributes

Defines the attributes that are supported and can be used by payments which are processed by Strip

Payment Methods
Payment Methods

A number of Payment Methods which are linked with the Stripe Payment Gateways. Payments posted using these methods will also be submitted to Stripe, provided that all the information requested by Stripe is supplied. Payment Methods cannot be included in more than one Payment Gateway Providers.

Currencies AVAILABLE FROM CRM.COM R11.0.0

A set of currencies which are supported by the Payment Gateway.

Currency

The name of the selected Currency

Payment Preferences can be defined on Accounts Receivable only if the Accounts Receivable Currency is included in that list and Payments can be posted against the Payment Gateway Provider only if the Accounts Receivable Currency is included in that list.
The option to support all currencies or specific currencies is available

Specified currencies are also validated against the currencies supported by Stripe.Stripe supports 138 currencies for Visa, Mastercard and American Express Credit Cards. A full list of the supported currencies can be found here and are validated online while registering or modifying a Stripe card

 

Refunding Causes
Payment Cancellation TypesA list of Payment Cancellation Types that when posted will result in the submission of a Refund on Stripe. The Refund will only be created if the cancelled payment was also submitted to Stripe and was processed successfully.

Allowed Application Servers AVAILABLE FROM CRM.COM R10.0.0

The option to specify 'Allowed Application Servers' is available only if there are multiple application servers present in the System. Specifying an 'Allowed Application Server' is not mandatory, resulting in all registered application servers to be allowed.

Application ServerThe application server that will be 'Allowed'. The application servers are filtered on the organisation group of the logged in user
Added ByThe user that added the application server. This information is set automatically.
Added OnThe date on which the server was added. This information is set automatically.
Log Information
Log DetailsThe standard set of Log Details information available in all entities