Excerpt | ||
---|---|---|
| ||
Learn how you can configure and execute Stripe Payment Gateway Run |
to configure the Business Definitions that dictate the overall behaviour of Process Payment Gateway Requests |
Back to Stripe Payment Gateway Main Page
Note | ||||||
---|---|---|---|---|---|---|
| ||||||
|
Panel | ||||
---|---|---|---|---|
| ||||
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 paidNavigating 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 in order 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 in 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.
Anchor | ||||
---|---|---|---|---|
|
Action | Validations | Restrictions | System Processing |
---|---|---|---|
Create |
|
|
|
Edit |
|
|
|
Delete |
|
|
|
Submit |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
- 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
|
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 |
|
Create |
|
Edit |
|
Delete |
|
Save |
|
Stripe Payment Gateway Run attributes
Name
Attributes
An * indicates a field is mandatory
Name | Description | ||
---|---|---|---|
Main Information | |||
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 definitionDefinition | ||
Alternative code* | The alternative unique code of the definitionDefinition. | ||
Description | A description of the definition Definition that can be used for the description element Description Element sent to the orderOrder. | ||
Life cycle stateCycle State | The life cycle state Life Cycle State of the definitionDefinition. The supported values are effective and not effective'Effective' and 'Not effective'. | ||
State | The 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. | ||
Version | An 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 Gateway | The 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 totype of payment used in the submission process to the Stripe Payment Gateway. | ||
Payment Method* | The paymentmethod that will beused by the process in orderto create the payments that will besubmitted to the Stripe Payment Gateway. Only paymentmethods included in Stripe Payment Gateway Provided can be selected. | ||
Payment Category | The payment category that will be used by the process in ordercategory used to create the payments that will besubmitted to the Stripe Payment Gateway. | ||
Payment Notes | Notes 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 Bills that will automatically 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
| Billing Run Selection |
|
Included Billing Runs | The set of Normal Billing Runs considered in order to retrieve the unsettled bills that will automatically be paidBills 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 requests | If enabled thenProcess Only Failed Payment Requests | If 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 Segment should be specified, in one of the two options | |||
Included in SegmentSegments | A list of segments Segments which are used to filter the payment gateway Payment Gateway accounts that will be sent for payment.
| Not Included in Segment
| |
Excluded Segments | A list of segments Segments which are used to be excluded exclude certain accounts from the payment gateway Payment Gateway accounts that will be sent for payment.
| ||
Scheduling Settings | Scheduling Settings* | ||
Settings * | The following options are available:
|
Configuring a Stripe Payment Gateway Run tailored to your company's needs
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: Search and select a 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: click on ADD and select a segment to be included during the stripe payment gateway run
Excluded Segments: click on ADD and select a segment to be excluded during the stripe payment gateway run
SCHEDULING SETTINGS
LOG INFORMATION
Executing a Stripe Payment Gateway Run
Modifying a Stripe Payment Gateway Run
Deleting a Stripe Payment Gateway Run
Deleting a scheduled job of the specific Run
Changing the Life Cycle State of a Stripe Payment Gateway Run definition
Reading Stripe Payment Gateway Run Logs
Process Runs
The following information is available regarding the Stripe Payment Gateway RunProcessed 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. |
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. |
Check out Scheduler Task to find out how each option may be configured | |
Process Runs | |
---|---|
Process Runs | Includes the standard Process Run information |
Log Information | |
Log Information | The standard set of Log Details information available in all entities |
Panel | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
Related Areas
|
Panel | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
Popular Labels | ||||||||||
spaceKey | V4Manual | style | heatmap||||||||
Helpful Links
|