Relationship statuses

When a new Relationship is being created, it will go through a variety of statuses. These statuses indicate what action is required of either the Leader or Follower, and what sort of transactions can be created.

The Relationship status will have slightly different text depending on whether you view it on your Relationships settings page or using our List Relationships endpoint.

Status in UIStatus in APIExplanation
Pending partner setupBLOCKEDThe user is a Follower and must wait for their Trading Partner (the Leader) to set up their end of the Relationship.

No transactions can be created.

No relationship settings can be changed.
Configure setupSETUPThe user must configure their Relationship.

No transactions can be created.

Relationship settings can be changed as long as they're compatible with the Trading Partner's current settings.
Pending partner setupPENDINGThe user is a Leader and must wait for their Trading Partner (the Follower) to configure their end of the Relationship.

No transactions can be created.

Relationship settings can be changed as long as they're compatible with the Trading Partner's current settings.
Complete TestingTESTBoth Leader and Follower must complete testing.

Only Test stream transactions can be created.

If the Leader isn’t onboarded to Orderful, Followers can skip the scenario checklist and follow their Leader's testing instructions outside of Orderful.
Go-Live ReadyREADYAll scenario checklists using this Relationship have been skipped or completed. Leaders and Followers should connect to agree on a Go Live date.

The Relationship can receive Test and Live stream transactions.

On your Go Live date, you can update the Relationship status to "Live" from the Relationships settings page.
LiveLIVEThe Relationship can receive Test and Live stream transactions.

You can update the Relationship status back to "Go-Live Ready" from the Relationships settings page.

The transitions between the various statuses are illustrated here:


Did this page help you?