Getting Started with Use Case Tutorials

Use case tutorials are designed to help platform users perform specific tasks. However, some tasks are applicable to only 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. Visit the Payrix API documentation portal for Payrix API, PayFields, and PayFrame use cases.

Prerequisites

Make sure you complete 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 Payrix 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 process, so you can access and explore specific use cases that align with the actions necessary to keep your business flowing smoothly.

Section	Description	Example
Objective	The expected outcome of following the use case steps	Create a user team and customize member roles and user capabilities.
Audience	The entity levels that the use case can be applied by and is 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	The related topics or next steps in a longer process after accomplishing the use case objective	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:

Use Case Tutorial usage steps

Select a Use Case Tutorial category (for example, Chargebacks or Disbursements).
Review Objective to ensure the use case is what you’re looking for.
Review Audience to ensure it applies to your entity level: Facilitator, Referrer, or Merchant.
Review Environment to verify you can perform the use case in Sandbox or Production.
Read the Prerequisites to ensure you are prepared to perform the use case.
Read the Warnings and Tips sections to avoid issues and streamline your usage.
Read Additional Resources articles if you’re unfamiliar with any of the concepts or terms.
Execute the Use Case Steps, reviewing the final result against your outcome to ensure success.
Read the Next Steps section for additional use case tutorials that might relate to the current one.
Review the Conclusion to understand what you can do after completing the objective.
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: