Overview

This endpoint retrieves the registration data used by our underwriting team during onboarding, providing real-time insights into merchant status and approval processes.

Key Features

Underwriting Status

Monitor application approval status with detailed substatus information and underwriting notes.

Account Status

Track merchant account activation status to determine payment processing eligibility.

Conditional Approval

Support for merchants who can start processing while requirements are pending.

Status Monitoring Details

Underwriting Status Monitoring

Primary Status Field

underwriting_status: Indicates the status of the merchant's application.

null: No decision has been made yet
APPROVED: The application has been approved
PENDED: The application is pending further information or action
REJECTED: The application has been rejected

Additional Status Information

underwriting_substatuses: An array containing objects that provide detailed reasons for the underwriting status. Useful for understanding specific requirements or issues.

underwriting_note: A human-readable note from Stax's underwriting team, informing the merchant of any additional documents or information needed to approve the application for payment processing.

Integration Notes

Use these fields to understand the real-time status of a merchant
See our Underwriting Overview for more details about the underwriting process
Webhooks: Listen for update_underwriting events when these fields change

Account Status Monitoring

Status Field

status: Indicates the merchant's account status. Must be "ACTIVE" before the merchant can process payments.

Integration Notes

Webhooks: Listen for update_account_status events when the status becomes ACTIVE
This status is separate from underwriting status, and both may need to be checked

Conditional Approval

Overview

Applicable for Partners with Conditional Approval Enabled

Conditional Approval allows merchants to begin processing payments while certain requirements remain pending (e.g., missing banking information).

Key Points

Funds may be held until the merchant fulfills the remaining requirements for full approval
If underwriting_status is "APPROVED" and there are entries in underwriting_substatuses, the account is conditionally approved
This enables faster merchant onboarding while maintaining compliance requirements

Implementation Tips

Real-time Updates

Use webhook events to stay up to date on status changes without polling the API constantly.

Status Logic

Check both underwriting_status and account_status to determine full merchant readiness.

📘
IMPORTANT: When testing merchant enrollment, note that underwriting fields cannot be changed directly via the API; however, Stax Connect Test Mode can be used by our partner developers to simulate different application and merchant statuses. Talk to your partnership resource for more information on testing the merchant enrollment flow.