Versions Compared

Old Version 3

changes.mady.by.user p_demou

Saved on

compared with

New Version Current

changes.mady.by.user Former user

Saved on

Key

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

Learn how you can configure and execute Stripe Payment Gateway Run

What does this section cover?

to configure the Business Definitions that dictate the overall behaviour of Process Payment Gateway Requests

Back to Stripe Payment Gateway Main Page

Note
titleIMPORTANT NOTE

Status
colourGreen
titleApplicable up to CRM.COM R10
Stripe Payment Gateway Run is available for up to CRM.COM R10. For CRM.COM R11.0.0 and onward, please refer to Using Automatic Payment Run Definitions 

Panel
nameblue

Table of Contents

Table of Contents
minLevel2

Navigating to Process Payment Gateway Requests

that should automatically be paid
Info

What are Stripe Payment Gateway Runs?

Payment Gateway Runs are used to log the execution of the payment runs. A new payment gateway processing run is created each time a payment processing run definition is applied.

Payment Gateway runs can be performed only within an effective payment gateway run definition.

A new payment gateway run is created each time a recurring Stripe Payment Gateway Run Definition is submitted. Whenever a run has been submitted, the following are executed:

The bills

FINANCE > PAYMENT GATEWAY > STRIPE > PROCESS PAYMENT GATEWAY REQUESTS

What are Process Payment Gateway Requests Definitions?

Process Payment Gateway Requests Definitions are a set of user defined criteria regulating the execution of payments.  When run, Bills to be settled with Stripe registered cards are identified, and the corresponding Payment Requests are created and sent to Stripe.  The funds are consequently deducted from the customer's Stripe account and added to the merchant/seller, (i.e. company's Stripe account)

Run Definitions must be submitted when created to be executed. They can be either executed once or on a recurring basis, depending on the defined scheduling settings. Once a Definition is executed, a Process Run is logged and once the Run is completed, information all the newly created requests is available on the Payment Gateway Requests screen. 
The user has the option to delete the specific run as long as it is not yet executed (still in 'Draft' state).  
For a Definition to be submitted it needs to have an 'Effective' Life Cycle State. The Life Cycle State can be changed between 'Effective' and 'Not Effective' using the dedicated action.

  • Navigate to Process Payment Gateway Requests Definitions and explore existing records via the Summary page. 

  • Click on the link (name or number) of the record of your interest to access the Data Entry page and see more detail, or submit the Definition. 

  • Use the Actions Menu to create a NEW Definition, modify (EDIT), or DELETE an existing one.  

  • Use BACK to return to the Summary page and CANCEL to revert any unwanted changes made to the Definition.

Check the Validations & Restrictions Table below for a list of available Actions when working with Process Payment Gateway Requests Definitions, including each Action's related validations, restrictions, and a description of its system process.  View the Attributes Table for a comprehensive description of the Process Payment Gateway Requests Definitions fields.


PAYMENT GATEWAY RUN DEFINITIONSImage Added

Anchor
validations
validations
Validations & Restrictions

ActionValidationsRestrictionsSystem Processing
Create
  • Mandatory Fields must be defined
  • Name and alternative code must be unique
  • Not Applicable
  •  Not Applicable
Edit
  • Mandatory Fields must be defined
  • Name and alternative code must be unique
  • Not Applicable
  •  Not Applicable
Delete
  • Not Applicable
  • Run Definitions cannot be deleted if there exists at least one scheduled or completed run for that Definition
  • Not Applicable
Submit
  • Not Applicable
  • Not Applicable
  • The Bills whose payment must be automated are identified, based on the following criteria:
    • The
accounts receivable includes the Stripe accounts receivable payment preference
    • Accounts Receivable criteria include the Stripe Accounts Receivable Payment Preference and is also set to be used for recurring payments
    • If
segment
    • Segment criteria
exists
    • exist then
    • , Accounts
receivable
    • Receivable are filtered based on the specified
segments
    • Segments
    • The
bill
    • Bill is included in the latest normal
billing run
    • Billing Run or
in
    • one of the specified normal
billing runs
    • Billing Runs
    • The
bills due date
    • Bill's Due Date is equal to or before the date of execution (i.e., the
bills
    • Bills are due or overdue)
    • The
bills
    • Bills are unsettled
    • If the run is executed only for failed
payment requests thenA rejected payment gateway request
    • Payment Requests, then a rejected Payment Gateway Request referring to that
bill exists
    • Bill must exist
  • A
payment gateway request
  • Payment Gateway Request is created
, using:
  • The stripe accounts receivable payment preference's default card
  • The payment type, payment method, payment category and payment notes specified on the payment gateway processing run definition
  • The requests are submitting new charges to Stripe system
    • The related
    • Charges from new requests are submitted to Stripe
    • The resulting successful payments are created in CRM.COM. 

    In order to modify the scheduling information of a submitted Payment Gateway Run you can Edit the definition.

    Creating, Editing & Deleting Validations & Restrictions

    ActionValidationsRestrictionsAdditional Information
    General   
    Create   
    Edit   
    Delete   

    Stripe Payment Gateway Run attributes 

    Name

    Description

    Attributes

    An * indicates a field is mandatory

     It defines bills automatically If enabled then Determines segment Not Included in Segment

    Determines when the definition should be applied in order to create the payment requests. Payment Gateway Run Definitions can be applied ad hoc or on a recurring basis. Scheduling settings hold the following information:

    Method: It provides the following options

    Name

    Description

    Main Information
    Unified codeAn auto-generated code which is used to group the various instances of each Payment Gateway Run Definition.

    Name*

    		The name of the definitionDefinition
    Alternative code*The unique alternative code of the definitionDefinition.
    DescriptionA description of the definition Definition that can be used for the description element Description Element, sent to the orderOrder.
    Life cycle stateCycle StateThe life cycle state Life Cycle State of the definitionDefinition. The supported values are effective and not effective'Effective' and 'Not effective'.
    StateThe state of the definition Definition which can be active or inactive'Active' or 'Inactive'. Only one active definition 'Active' Definition can exist at any pointa time.
    VersionAn auto-generated number which is used to specify the version of each the Payment Gateway Run Definition. New Payment Gateway Run Definition New versions are created each time they the Definitions are edited, if they are already been used by any payment gateway runsbeing executed once.
    Payment GatewayThe payment gateway that it will be used to execute the run, .  It should default to the active 'Active' Stripe Payment Gateway Provider.
    Payment Settings 
    Payment Type*

    The

    payment type that will be used by the process in order to create the payments that will be submitted to

    type of payment used in the submission process to the Stripe Payment Gateway.

    Payment Method*

    The

    payment

    method

    that will be

    used

    by the process in order

    to create the payments

    that will be

    submitted to the Stripe Payment Gateway.

    Only

    payment

    methods included in Stripe Payment Gateway Provided can be selected.

    Payment Category

    The

    payment category that will be used by the process in order

    category used to create the payments

    that will be

    submitted to the Stripe Payment Gateway.

    Payment NotesNotes that will be added Additional notes on the created payment that will be created.
    Criteria
    Accounts Receivable Criteria: Define the criteria that will be used to retrieve the unsettled Bills that will be paid automatically
    Billing Run Filter Method*

    It determines Determines the method that will be used to filter the billsBills. The supported options are the following:

    A set of normal billing runs that will be
    • Bills included Included in the latest Latest normal billing runBilling Run
    • Bills includes in specific billing runs
    		Billing Run Selection
    • Included in Specific Billing Runs
    Included Billing Runs

    The set of Normal Billing Runs considered in order to retrieve theunsettled bills that will automatically be paidthe unsettled Bills for automatic payment. This option is applicable and mandatory only mandatory if the "Bills included Included in specific billing runsBilling Runs" option is selected as a Billing Run Filter Method

    Mandatory Conditions: Only if the Bills included in specific billing runs option is selected

    Process only failed payment requestsProcess Only Failed Payment RequestsIf checked the process will only retrieve only bills Bills which were already processed and failed to be submitted whose submission to Stripe failed.
    Segment Criteria: Determine the criteria that are used to identify the accounts that need to be paid. At least one Segment should be specified, in one of the two options

    Included

    in Segment

    Segments

    A list of segments Segments which are used to filter the payment gateway Payment Gateway accounts that will be sent for payment.

    • The Segment criteria consist of
    the following:
    • Segment: A select box with all the segments having accounts receivable as the segment entity
    • a select box and a drop-down menu containing Segments having Accounts Receivable as the Segment entity

    Excluded Segments

    A list of segments Segments which are used to excluded the payment gateway exclude certain accounts from the Payment Gateway accounts that will be sent for payment.

    • The Segment criteria consist of
    the following:
    • Segment: A select box with all the segments having accounts receivable as the segment entitya select box and a drop-down menu containing Segments having Accounts Receivable as the Segment entity.)
    Scheduling Settings Scheduling Settings*
    Settings *The following options are available:
    • Run now
    • Run on specific Date / Time
    • Repeat
    • Start at: It determines the date and time that the definition should be applied. If the run now option is selected then the date / time is read only and set to 30 seconds after saving the record. Two options are available
      • Specific Date / Time
      • After X UOT: measured in seconds, minutes, days, weeks or months
    • End by Date / Time: It determines the latest date and time that the definition should be applied. This is available only if the repeat option is selected. Two options are available
      • Specific Date / Time
      • After X UOT: measured in seconds, minutes, days, weeks or months
    • Every X UOT: It determines how often the runs should be repeated. The definitions can be scheduled to be applied per seconds, minutes, days, weeks or months. This is available only if the repeat option is selected.

    Configuring a Stripe Payment Gateway Run tailored to your company's needs

  • Navigate to FINANCE > PAYMENT GATEWAY > STRIPE > PROCESS PAYMENT GATEWAY REQUESTS 
    • Either search for an existing one or from the Top Menu click on NEW

  • MAIN INFORMATION

    1. Provide the required information

      1. Name

      2. Alternative Code

      3. Description

    2. View information regarding the following

      1.  Scheduled Date

      2. Version

      3. Life Cycle State

        Stripe Payment Gateway Run - Main InformationImage Removed

  • PAYMENT SETTINGS

    1. Provide the required information

      1. Payment Type

      2. Payment Method

      3. Payment Category

      4. Payment Notes

        Stripe Payment Gateway Run - Payment SettingsImage Removed

    • CRITERIA

  • ACCOUNTS RECEIVABLE CRITERIA

    1. Provide the required information

      1. Process Only Failed Payment Requests

      2. Billing Run Filter Method

        Stripe Payment Gateway Run - Accounts Receivable CriteriaImage Removed

    • SEGMENT CRITERIA

    Provide the required information

    1. Included Segments

    2. Excluded Segments

      Stripe Payment Gateway Run - SegmentsImage Removed

    SCHEDULING SETTINGS

    Include PageScheduler Task - GlobalScheduler Task - Global 

    LOG INFORMATION

    Include PageWIP:Log Information - GlobalWIP:Log Information - Global
  • From the Top Menu click on Save

    • Executing a Stripe Payment Gateway Run

    Include PageExecuting Runs - GlobalExecuting Runs - Global

    Modifying a Stripe Payment Gateway Run

    Include PageVersioningVersioning

    Deleting a Stripe Payment Gateway Run

    Deleting a scheduled job of the specific Run

    Include PageDeleting a run- GlobalDeleting a run- Global

    Changing the Life Cycle State of a Stripe Payment Gateway Run definition

    Include PageChange Life Cycle State of a Run definition - GlobalChange Life Cycle State of a Run definition - Global

    Reading Stripe Payment Gateway Run Logs

    Include PageReading Run Logs - GlobalReading Run Logs - Global InfoIf you have access, you may navigate to Stripe, log in to your Merchant Account Dashboard to view more information regarding the Payment through Stripe.
    • Run Repeatedly
    • Advance Scheduling

    Check out Scheduler Task to find out how each option may be configured

    Process Runs
    Process RunsIncludes the standard Process Run information
    Log Information
    Log InformationThe standard set of Log Details information available in all entities  
    Panel
    namegrey

    Related Areas

    Filter by label (Content by label)
    showLabelsfalse
    spacesV4Manual
    showSpacefalseexcerpttrue
    labelsstripe-basics-r7,stripe-advanced-r7,stripe-admin-r7

    heatmap

    Helpful Links

    Panel
    namegrey

    Popular Labels

    Popular Labels
    spaceKeyV4Manual
    style
    Filter by label (Content by label)
    showLabelsfalse
    spacesV4Manual
    showSpacefalse
    labelsglobal