on_hold state.
While a collect is on hold:
- Funds are not yet credited to your balance. A
balance_transactionobject is not created. - You will not see the collect as
succeeded. - You may be reached out for additional information.
The collect will transition either to
succeeded(funds credited) orfailed(funds returned via a reversal).
Subscribing to Compliance Hold Events
You can subscribe to thecollect.on_hold webhook event to be notified when a collect is placed on a compliance hold.
This is useful for:
- Pausing downstream order fulfillment until the collect clears.
- Alerting your operations team to follow up with the customer.
- Reconciling delayed credits in your books.
See Also
State Machine
How a collect moves between states, including holds.
Reversals
What happens if a held collect ultimately fails.