API Usage Flows

Learn about the flows for integrating with our API as a partner.

As a partner, you can integrate with our API using one of three flows, depending on your needs. This page explains the options so you can choose the one that works best for you.

Flow 1: Simplest Flow (Just making payments)

In this flow, you can just make payments without registering a company or users. We’ll handle the company registration for you behind the scenes.

• How It Works:
  • You skip the company/user registration step entirely.
  • Our system automatically creates and manages the company on your behalf.
• Use Case:
  • Perfect if you want make payments without the need for your clients to register.
• Steps:
  • Make a payment for that user.
• Benefits:
  • Easiest solution possible.

Flow 2: Simplified Flow (One company with user registration)

In this flow, you can register users and make payments without registering a company. We’ll handle the company registration for you behind the scenes.

• How It Works:
  • You skip the company registration step entirely.
  • Our system automatically creates and manages the company on your behalf.
• Use Case:
  • Perfect if you have a single location or don’t want to deal with company management.
• Steps:
  1. Register a user using the API.
  2. Make a payment for that user.
• Benefits:
  • Faster setup with less work for you.

Flow 3: Full Flow (Multiple locations with user registration)

In this flow, you register a company and its locations before registering users and making payments. This gives you control over which location receives each payment.

• How It Works:
  • You explicitly register a company and add its locations.
  • Payment requests identify their destination with LocationId.
• Use Case:
  • Ideal if you have multiple locations and want to manage them separately.
• Steps:
  1. Register a company, optionally including its initial Locations array.
  2. Add or list locations through the company locations endpoints.
  3. Register users.
  4. Make payments using the appropriate LocationId.
• Benefits:
  • Better organization and flexibility for multi-location partners.

Which Flow Should You Use?

Here’s a quick guide to help you decide:

• Choose Flow 1 if:
  • You have a single location.
  • You just want to make payments without user registration.
• Choose Flow 2 if:
  • You have a single location.
  • You want a user registration.
• Choose Flow 3 if:
  • You have multiple locations.
  • You need to track users and payments per location separately.

Next Steps

Ready to get started? Check out these pages for more details:

• API Authorization
• Register a Company
• Manage Company Locations
• Register a User
• Make a Payment

If you have questions, feel free to reach out to our support team!