Collection statuses

Collections have a status field that reflects the current state the collection is in.

Status

Description

pending

The collection has been created on Root and is queued to be delivered to the payment provider.

submitted

The collection has been delivered to the payment provider.

processing

The collection is busy being processed by the payment provider.

successful

The collection has been successfully collected from the policyholder. (If you’re using Debit Orders, read here how collections behave uniquely in certain situations).

failed

This collection has failed to collect. A failure reason is captured on the collection, and would typically be “insufficient funds”.

cancelled

The collection has been cancelled before submission to the payment provider. A collection can’t be cancelled once submitted to the payment provider.