Test scenarios

Design your UAT test plan around Roots onboarding, account, counterparty, payment, RFI, and funds-availability lifecycles.

See API availability for current UAT behavior and planned test-contract gaps.

Test the happy path

Validate that your integration can create and reconcile each record type available to your UAT program.

Scenario	Validate
Front-office access	A valid user can sign in and retrieve the current session.
API key	An authorized user can create a labeled key and store its one-time secret securely.
Business end customer	Your system stores Roots and internal IDs for the business and its associated people.
Association	Your system records UBO, director, control-person, and authorized-signatory relationships.
Account	Your system handles a newly created account as non-final until its current status permits activity.
Counterparty	Your system prevents payment creation when a counterparty is pending or blocked.
Payment	Your system records the Roots payment ID, your `external_id`, and the payment lifecycle state.
RFI or hold	Your system stops the affected automation and routes the case to a human workflow.

Test state handling

Your application should handle every documented current payment state.

Payment state	Expected application behavior
`Pending`	Show the payment as in progress. Do not report delivery.
`Submitted`	Continue monitoring for a terminal result.
`Settled`	Reconcile the completed payment.
`Failed`	Investigate before creating a replacement instruction.
`Returned`	Reconcile returned funds before creating a replacement instruction.

Target schema — confirm in API reference

Roots has not published deterministic UAT personas, values, or triggers for RFI_REQUIRED, EDD_REQUIRED, rejected onboarding, blocked counterparties, returned payments, or post-funding holds.

Confirm the test data and trigger behavior before you make automated assertions for these outcomes. Until then, test your application with representative state fixtures in your own environment and verify the released Roots behavior manually.

Next steps

Read Onboarding and review lifecycle for review outcomes.
Read Holds, restrictions, and RFIs for blocked-workflow behavior.
Read Track payment status for payment-state handling.