Versions Compared

Old Version 2

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

What are Stripe Payment Gateway Runs?

Stripe Payment Gateway Request Runs runs are used to

Creating, Editing & Deleting

Navigating to Process Payment Gateway Requests

Info

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

ActionValidationsRestrictionsAdditional Information
General   
Create   
Edit   
Delete   

Stripe Payment Gateway Run attributes 

 Name

Name

Description

 NumberAn auto generated number that uniquely identifies the accounts receivable definitions
System 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 criteria include the Stripe Accounts Receivable Payment Preference and is also set to be used for recurring payments
    • If Segment criteria exist then, Accounts Receivable are filtered based on the specified Segments
    • The Bill is included in the latest normal Billing Run or one of the specified normal Billing Runs
    • The Bill's Due Date is equal to or before the date of execution (i.e., the Bills are due or overdue)
    • The Bills are unsettled
    • If the run is executed only for failed Payment Requests, then a rejected Payment Gateway Request referring to that Bill must exist
  • A Payment Gateway Request is created
  • Charges from new requests are submitted to Stripe
  • The resulting successful payments are created in CRM.COM. 

Attributes

An * indicates a field is mandatory

MAIN INFORMATION

 

  • CRITERIA

    • 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 Note

    Visit /wiki/spaces/WIP/pages/10010220 Stripe Payment Gateway Request Runs for business examples related to Stripe Payment Gateway Request Runs

    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 Alternative code*An The unique alternative code for of the definition. On creating a new definition it defaults to the first letter of each word included in the name (in Capitals), if nothing else is specifiedDefinition.
    DescriptionA description of the Definition that can be used for the definitionthe Description Element, sent to the Order.
    Life Cycle StateThe Life Cycle State of the Definition. The supported values are '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 point
      
      
      

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

  • Navigate to PATH
     
    • Either search for an existing one or from the Top Menu click on NEW
    a time.
    VersionAn auto-generated number which is used to specify the version of the Payment Gateway Run Definition. New versions are created each time the Definitions are edited, if they are already being executed once.
    Payment GatewayThe payment gateway that it will be used to execute the run.  It should default to the 'Active' Stripe Payment Gateway Provider.
    Payment Settings
    Payment Type*

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

    Payment Method*

    The method used to create the payments submitted to the Stripe Payment Gateway.

    Only methods included in Stripe Payment Gateway Provided can be selected.

    Payment Category

    The category used to create the payments submitted to the Stripe Payment Gateway.

    Payment NotesAdditional notes on the created payment.
    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*

    Determines the method that will be used to filter the Bills. The supported options are:

    • Bills Included in the Latest normal Billing Run
    • Bills Included in Specific Billing Runs
    Included Billing Runs

    The set of Normal Billing Runs considered in order to retrieve the unsettled Bills for automatic payment. This is mandatory if "Bills Included in specific Billing Runs" is selected as a Filter Method

    Process Only Failed Payment RequestsIf checked the process will only retrieve Bills which were already processed and 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 Segments

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

    • The Segment criteria consist of a select box and a drop-down menu containing Segments having Accounts Receivable as the Segment entity

    Excluded Segments

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

    • The Segment criteria consist of a select box and a drop-down menu containing Segments having Accounts Receivable as the Segment entity.)
    Scheduling Settings
    Settings *The following options are available:
    • Run now
    • Run on specific Date / Time
    • 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