Getting Started with Use Case Tutorials

Use Case Tutorials are designed to help Platform users perform specific tasks. However, some tasks are only applicable to a subset of users or are designed only for certain development environments, and the Use Case Tutorials for these types of tasks are designed only for the relevant user levels and environments.

Note: These tutorials are based on Payrix Portal use cases only.

Payrix API use cases are available on our API Documentation Portal at portal.payrix.com/docs.
PayFields use cases are available at portal.payrix.com/docs/index/payFields.
PayFrame use cases are available portal.payrix.com/docs/index/payFrame

Prerequisites

Make sure you have completed the following prerequisites before performing any of the tasks described in the use case tutorials.

You must have a fully boarded Payrix account to perform any of the actions described in the use case tutorials.
Know your user level. For more information, visit the Glossary.
Know your user environment. For more information, visit Getting Started with Sandbox Testing.
Know the basic Portal pages and features.
Explore the Payrix Sandbox Portal.

Tutorial Navigation

Navigate through the tutorials effortlessly using the organized structure. Each tutorial is categorized by each process to allow easy access and exploration of specific use cases aligning with the specific actions you need to keep your business flowing smoothly.

Section	Description	Example

Section	Description	Example
Objective	What the expected outcome of following the use case steps is.	“Create a user team and customize member roles and user capabilities.”
Audience	The entity level(s) that the use case can be applied by and was written for: Facilitators (Payrix Premium Partners) Referrers (Payrix Pro Partners) Merchants	“Referrers”
Environment	The Portal server level and development environment that the use case applies to: Sandbox (Test)(https://test-portal.payrix.com/) Production (Live)(https://portal.payrix.com/)	“Sandbox”
Prerequisites	Any requirements that are conditions prior to being able to apply the use case.	“You must have a fully boarded Payrix account to perform any of the actions described within.”
Warnings	Insight or advice to avoid issues related to risk, visibility, and overall performance of the product during this use case.	“New Teams will not be active until you add new users and customize their access levels. The next portion of this guide will cover this topic.”
Tips	Suggestions to streamline or better prepare you to apply the use case tutorial.	“You can add new Merchant Users to specific Teams after successfully boarding by assigning your preferred team to your whitelabeled Merchant Signup Form. “
Additional Resources	Additional, longer-form reference materials or tables available in the Implementation Guide, offering more detailed context and information about the concepts of processes mentioned in the use case.	“To learn more about user access and roles, visit the Understanding Users and Roles page.”
Use Case Steps	The instructional steps for accomplishing the use case’s stated objective.	“Step 1: Click the ….. Step 2: Locate the …. Step 3: Enter your ….”
Next Steps	After the use case objective is accomplished, what are some related topics or next steps in a longer process.	“Set Up a Group: See the Set Up a Group use case for more information about setting up a group of users in the Portal. “
Conclusion	The expected outcome and final result of the use case being performed.	“The new team is now active and the team members can perform any actions associated with their assigned roles.”
References	A consolidated list of pages and articles linked within the use case for quick navigation.	“Teams page (Referrer)(Facilitator) Set Up a Group Set Up a Division”

Applying a Use Case

The steps below outline how to use any of the Use Case Tutorials included within this section of the Resource Center:

Step 1: Select a Use Case Tutorial category (e.g. Chargebacks, Disbursements, etc.).
Step 2: Review Objective to ensure the use case is what you’re looking for
Step 3: Review Audience to ensure it applies to your entity level: Facilitator, Referrer, and/or Merchant.
Step 4: Review Environment to verify you can perform the use case in Sandbox or Production
Step 5: Read the Prerequisites to ensure you are prepared to perform the use case.
Step 6: Read the Warnings and Tips sections to avoid issues and streamline your usage.
Step 7: Read Additional Resources articles If you’re unfamiliar with any of the concepts or terms.
Step 8: Execute the Use Case Steps, reviewing the final result against your outcome to ensure success.
Step 9: Read the Next Steps section for additional use case tutorials that may relate to the current one.
Step 10: Review the Conclusion for what the completed objective allows you to do.
Step 11: Review the References section to see all linked resources within the use case.

Questions

As always, if you experience issues or are confused about any process mentioned in the Use Case Tutorials section, contact our Support team for guidance or additional help.

References

Click the links in the page or items below to access any of the following pages: