Retrieves the registration data used by our underwriting team during onboarding.
Key Features:
Underwriting Status Monitoring
underwriting_status
: Indicates the status of the merchant's application. Possible values are:
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.
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.
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
: Indicates the merchant's account status. Must be "ACTIVE" before the merchant can process payments.
Webhooks: Listen for update_account_status
events when the status becomes ACTIVE
.
Conditional Approval:
Applicable for Partners with Conditional Approval Enabled
Conditional Approval allows merchants to start processing payments while certain requirements are still pending (e.g., missing banking information).
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.