Versions Compared

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?

Table of Contents
minLevel2

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:

  1. The bills that should automatically be paid are identified, based on the following criteria:
    • The accounts receivable includes the Stripe accounts receivable payment preference and is also set to be used for recurring payments
    • If segment criteria exists exist then:
      • Accounts receivable are filtered based on the specified segments
    • The bill is included in the latest normal billing run or in one of the specified normal billing runs
    • The bills due date is equal to or before the date of execution (i.e., the bills are due)
    • The bills are unsettled
    • If the run is executed only for failed payment requests then:
      • A rejected payment gateway request referring to that bill exists
  2. A 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
  3. The requests are submitting new charges to Stripe system
  4. The related 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

ActionValidations
GeneralN/A
  • Not applicable
Create
  • Multiple payment gateway processing run definitions can exist in the system, but each one should have a unique name and alternative code.
EditN/A
  • Not applicable
Delete
  • Payment gateway request processing run definitions cannot be deleted , if is there exists at least one scheduled or completed payment processing run for that definition
Save
  • Mandatory Fields:
    • Name
    • Alternative Code
    • Payment Type
    • Payment Method
    • Billing Run Filter Method
    • Scheduling Settings

Stripe Payment Gateway Run attributes 

It defines Determines

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 definition
Alternative code*The alternative code of the definition
DescriptionA description of the definition that can be used for the 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 which can be active or inactive. Only one active definition can exist at any point
VersionAn auto generated number which is used to specify the version of each Payment Gateway Run Definition. New Payment Gateway Run Definition versions are created each time they are edited, if they are already been used by any payment gateway runs
Payment GatewayThe payment gateway that it will be used to execute the run, should default to the 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 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 Stripe Payment Gateway. Only payment methods included in Stripe Payment Gateway Provided can be selected.
Payment CategoryThe payment category that will be used by the process in order to create the payments that will be submitted to Stripe Payment Gateway.
Payment NotesNotes that will be added on the payment that will be created
Criteria
Accounts Receivable Criteria: Define the criteria that will be used to retrieve the unsettled bills that will automatically be paid
Billing Run Filter Method*

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

  • Bills included in the latest normal billing run
  • Bills includes included in specific billing runs
Billing Run Selection

A set of normal billing runs that will be considered in order to retrieve theunsettled the unsettled bills that will automatically be paid. This option is applicable and mandatory only if the "Bills included in specific billing 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 requestsIf enabled then the process will retrieve only bills which were already processed and failed to be submitted to Stripe
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

A list of segments which are used to filter the payment gateway accounts that will be sent for payment. The criteria consist of the following:

  • Segment: A select box with all the segments having accounts receivable as the segment entity
Not Included in Segment

A list of segments which are used to be excluded from the payment gateway accounts that will be sent for payment. The criteria consist of the following:

  • Segment: A select box with all the segments having accounts receivable as the segment entity
Scheduling Settings
Scheduling Settings*

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

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

  3. 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 Information

  4. PAYMENT SETTINGS

    1. Provide the required information

      1. Payment Type

      2. Payment Method

      3. Payment Category: Search and select a payment category

      4. Payment Notes

        Stripe Payment Gateway Run - Payment Settings

  5. CRITERIA

    1. 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 Criteria

    2. SEGMENT CRITERIA

      1. Provide the required information

        1. Included Segments: click on ADD and select a segment to be included during the stripe payment gateway run

        2. Excluded Segments: click on ADD and select a segment to be excluded during the stripe payment gateway run

          Stripe Payment Gateway Run - Segments


  6. SCHEDULING SETTINGS

    Include Page
    Scheduler Task - Global
    Scheduler Task - Global
     

  7. From the Top Menu click on SAVE
  8. LOG INFORMATION

    Include Page
    WIP:Log Information - Global
    WIP:Log Information - Global

    From the Top Menu click on Save



Executing a Stripe Payment Gateway Run

Include Page
Executing Runs - Global
Executing Runs - Global

Modifying a Stripe Payment Gateway Run

Include Page
Versioning
Versioning

Deleting a Stripe Payment Gateway Run

Deleting a scheduled job of the specific Run

Include Page
Deleting a runRun- Global
Deleting a runRun- Global

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

Include Page
Change Life Cycle State of a Run definition - Global
Change Life Cycle State of a Run definition - Global

Reading Stripe Payment Gateway Run Logs

  1. Navigate to FINANCE > PAYMENT GATEWAY > STRIPE > PROCESS PAYMENT GATEWAY REQUESTS 
  2. Search for an existing Payment Gateway Run that has been executed
  3. Process Runs

    1. The following information is available regarding the Stripe Payment Gateway Run
      1. Number: The number of the run
      2. Version: The Run Definition's version
      3. Life Cycle State: The Life Cycle State of the Run
      4. Start Date: The date when the Run started
      5. End Date: The date when the Run ended
      6. Process Successfully: Drill down including the notifications created successfully. 
      7. Processed With Errors: Drill down including the entities that were not successfully processed thus no Stripe Payment Gateway Requests were created for the specified entities or they were rejected

        Info

        Visit Configuring and Executing Stripe Payment Gateway Run to find out more information regarding created Stripe Payment Gateway Requests.

        Stripe Payment Gateway Run Logs

Info

If you have access , you may navigate to Stripe, log in to your Merchant Account Dashboard to view more information regarding the Payment through Stripe.

Panel
namegrey

Related Areas

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

Panel
namegrey

Popular Labels

Popular Labels
spaceKeyV4Manual
styleheatmap