Getting Started with Hybrid API Enrollment

If you're using the Full API Enrollment or Hybrid API Enrollment, continue reading. For the White-Glove Enrollment option, please refer to the Stax Connect documentation.

By combining the Stax Enrollment API with our pre-built Signup Application, the Hybrid API Enrollment flow allows you to quickly implement a streamlined merchant enrollment process. This approach offers the benefits of automation without the need to develop the entire solution within your app.

Enrollment Process Overview

POST /admin/enroll

Simultaneously create a merchant, registration, and user record
Receive an ephemeral bearer token to facilitate SSO into the platform

API Reference Guide

Use these endpoints to implement and manage your merchant enrollment workflow:

Enroll a Merchant

Initialize the merchant enrollment process and create all necessary records.

Update Registration Data

Modify merchant information during the registration process.

Add Documentation

Upload supporting documents required for merchant approval.

Monitor Status

Track the underwriting and approval status of merchant applications.

Terms & Conditions

Retrieve the latest terms and conditions for merchant agreements.

Testing & Development

Testing Merchant Enrollment

Important Testing Considerations:

API Limitations: Underwriting fields cannot be changed via the API directly
Test Mode: Use Stax Connect Test Mode to simulate different application and merchant statuses during testing
Partnership Support: Contact your partnership resource for more information on testing the merchant enrollment flow

Testing Best Practices:

Test various merchant scenarios (approvals, rejections, pending states)
Validate SSO token functionality and expiration
Ensure proper error handling for failed enrollment attempts
Test document upload functionality with various file types