Skip to end of banner
Go to start of banner

Configuring and Executing Stripe Payment Gateway Run

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

What does this section cover?

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 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 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
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
Delete
  • Payment gateway request processing run definitions cannot be deleted, if is at least one scheduled or completed payment processing run for that definition. 

Stripe Payment Gateway Run attributes 

Name

Description

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:It defines 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 in specific billing runs
Billing Run Selection

A set of normal billing runs that will be considered in order to retrieve theunsettled 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 CriteriaDetermines 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 excluded 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

      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

        2. Excluded Segments

          Stripe Payment Gateway Run - Segments


  6. SCHEDULING SETTINGS

    1. Select from the available options according to what you would like to achieve
      1. RUN NOW: Will be executed once, now 
      2. RUN ON SPECIFIC DATE/TIME: Will be executed once, at the date defined
      3. RUN REPEATEDLY: Will be executed, starting and ending at a defined date/time and will be repeated every X UOT where UOT can be from seconds to Years
      4. ADVANCED SCHEDULING: Will be executed, starting and ending at a defined date with powerful repetition options from daily to yearly

    2. Run Now

      SCHEDULING SETTINGS - RUN NOW
       

    3. Run On Specific Date / Time

      1. Start Process
        1. Click on the calendar select the date and time the run should start being executed. 
          DATE AND TIME SELECTION
        2. Once selected click on "DONE"
          RUN ON SPECIFIC DATE TIME

    4. Run Repeatedly

      1. Start Process - On a Specific Date
        1. Click on the calendar select the date and time the run should start being executed. 
        2. Once selected click on "DONE"
      2. OR Start process - After a period of time
        1. Provide how long after current date/time the process should begin
          START PROCESS - AFTER A PERIOD OF TIME 
      3. Repeat Process
        1. EVERY: Type a number (INTEGER)
        2. UOT: Select between
          1. Seconds
          2. Minutes
          3. Hours
          4. Days
          5. Weeks
          6. Months
          7. Years
            REPEAT - UOT
      4. End Process
        1. Select between
          1. Never End
          2. On a specific date (define the date)
          3. After a period of time (define period of time)
            END PROCESS 

    5. Advance Scheduling

      1. Start Process
        1. Click on the calendar select the date and time the run should start being executed. 
        2. Once selected click on "DONE"
          ADVANCED SCHEDULING 
      2. Repeat Process
        1. Select between
          1. Daily : Define every how many days 
          2. Weekly: Select specific days of the week 
          3. Monthly:Define every how many months or on a specific day of the month
          4. Yearly: Define a specific date/month or a specific day of a month, such as the 1st Sunday of every January
            ADVANCED SCHEDULING - REPEAT PROCESS
      3. End Process
        1. Select between
          1. Never End
          2. On a specific date (define the date)
            ADVANCED - END PROCESS 
     

  7. LOG INFORMATION

    Unable to render {include} The included page could not be found.

  8. From the Top Menu click on Save

Executing a Stripe Payment Gateway Run

  1. Navigate to the definition
  2. Search for the definition you would like to execute
  3. Click on the number of the definition to go to the data entry page
  4. Confirm that SCHEDULING SETTINGS are correctly configured
  5. From the Actions Menu click on ACTIONS > "SUBMIT"
    RUNS - SUBMIT
  6. The job will be submitted to the scheduler and will become available under PROCESS RUNS
    1. Once completed the Life Cycle State will be changed from Draft to Completed
    2. If the Run fails then the Life Cycle State will be updated to Failed
      PROCESS RUN
    3. Check Process Successfully and Processed with Errors for a closer look of individual results 

 

Modifying a Stripe Payment Gateway Run

When you edit a definition that already has completed or scheduled runs then the system will automatically update the Version of the definition, by increasing its number by 1. Essentially, the system will create a new definition and will carry over all the information and configuration, apart from the Version number.

Accessing a definition with multiple versions, you will always see the latest version, while you have the option to View configuration and Runs of Previous versions by using th "VIEW PREVIOUS VERSIONS" link found in the Main Information tab

  1.  Click on the VIEW PREVIOUS VERSIONS link
    VERSIONING 
  2. Search from the modal for the version you would like to see
  3. Select the version
    1. The system will now show the configuration and the process runs of the version you have selected.
  4. To go back to the current version click on the CURRENT VERSION link under Main Information
    CURRENT VERSION 

 

Deleting a Stripe Payment Gateway Run

Deleting a scheduled job of the specific Run

If you have scheduled (submitted) a Run by mistake or you want to change the definition before execution, you have the option to delete the current job that was sent to the scheduler, given that it has not been executed yet. i.e., Life Cycle State is still Draft.

In order to delete the job follow the steps below:

  1. Navigate to the definition, for which you have scheduled a job
  2. Click on the number of the definition to move in the data entry page
  3. Go to Process Runs tab
  4. Find the job and check the left box next to the Run
  5. Click on "DELETE"


  6. A modal will open with the job information
  7. Click on "DELETE"
  8. Click "OK" on the confirmation message
  9. Close the modal
    The job will be removed from the Process Runs 

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

Definitions Life Cycle State can be changed between Effective and Not Effective by following the steps below 

  1. Go to the data entry page of the definition'
  2. If the definition's Life Cycle State is set to "Effective"
    1. From the Actions Menu click ACTIONS > SET AS NOT EFFECTIVE
  3. If the definition's Life Cycle State is set to "Not Effective"
    1. From the Actions Menu click ACTIONS > SET AS EFFECTIVE
      RUN DEFINITIONS - LIFE CYCLE STATE ACTIONS 

 

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

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

        Stripe Payment Gateway Run Logs

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.

Related Areas

Popular Labels

  • No labels