| Excerpt | ||
|---|---|---|
| ||
Learn how you can configure and execute Stripe Payment Gateway Run |
What does this section cover?
| Table of Contents | ||
|---|---|---|
|
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 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
- 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
- The requests are submitting new charges to Stripe system
- 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
| Action | Validations |
|---|---|
| General | N/A |
| Create |
|
| Edit | N/A |
| Delete |
|
Stripe Payment Gateway Run attributes
Name | Description |
|---|---|
| Unified code | An 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 |
| Description | A description of the definition that can be used for the description element sent to the order |
| Life cycle state | The life cycle state of the definition. The supported values are effective and not effective |
| State | The state of the definition which can be active or inactive. Only one active definition can exist at any point |
| Version | An 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 Gateway | The 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 Category | The payment category that will be used by the process in order to create the payments that will be submitted to Stripe Payment Gateway. |
| Payment Notes | Notes 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:
|
| 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 requests | If enabled then the process will retrieve only bills which were already processed and failed to be submitted to Stripe |
| Segment Criteria | Determines 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:
|
| 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:
|
| 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:
|
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
Provide the required information
Name
Alternative Code
Description
View information regarding the following
Scheduled Date
Version
Life Cycle State
PAYMENT SETTINGS
Provide the required information
Payment Type
Payment Method
Payment Category
Payment Notes
CRITERIA
ACCOUNTS RECEIVABLE CRITERIA
Provide the required information
Process Only Failed Payment Requests
Billing Run Filter Method
SEGMENT CRITERIA
Provide the required information
Included Segments
Excluded Segments
SCHEDULING SETTINGS
Include Page Scheduler Task - Global Scheduler Task - Global 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 | ||||
|---|---|---|---|---|
|
Modifying a Stripe Payment Gateway Run
| Include Page | ||||
|---|---|---|---|---|
|
Deleting a Stripe Payment Gateway Run
Deleting a scheduled job of the specific Run
| Include Page | ||||
|---|---|---|---|---|
|
Changing the Life Cycle State of a Stripe Payment Gateway Run definition
| Include Page | ||||
|---|---|---|---|---|
|
Reading Stripe Payment Gateway Run Logs
- Navigate to FINANCE > PAYMENT GATEWAY > STRIPE > PROCESS PAYMENT GATEWAY REQUESTS
- Search for an existing Payment Gateway Run that has been executed
Process Runs
- The following information is available regarding the Stripe Payment Gateway Run
- Number: The number of the run
- Version: The Run Definition's version
- Life Cycle State: The Life Cycle State of the Run
- Start Date: The date when the Run started
- End Date: The date when the Run ended
- Process Successfully: Drill down including the notifications created successfully.
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.
- The following information is available regarding the Stripe Payment Gateway Run
| 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 | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
Related Areas
|
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
Popular Labels
|