A hold represents a hold placed by a payment processor or bank on a Payment Order. Creating a hold will transition the status of the linked Payment Order to held.

ℹ️
Please note that Holds in Modern Treasury have no impact on the processing of your payment, they are purely for reporting / visibility purposes.

You can directly manage holds to update your Payment Order status using the Modern Treasury Holds API:

Mark as held using Create Hold
Mark as resolved using Update Hold

Once a Payment Order status is held, you can access its current_hold information directly on the Payment Order.

Attribute	Description
id string	Unique identifier for the line item.
status string	Either `active` or `resolved`.
reason string	Contextual information for placing this Payment Order on hold (optional).
resolution string	Contextual information about the resolution of the hold (optional).
resolved_at string	Timestamp at which hold was resolved by the bank. If the hold is automatically resolved by Modern Treasury. This will be the timestamp on the bank signal or the reception timestamp if there is no explicit value.
target_id string	The ID of the payment order.
target_type string	Must be `payment_order`.
metadata object	Additional data represented as key-value pairs. Both the key and value must be strings. See Metadata.
live_mode boolean	This field will be true if this object exists in the live environment or false if it exists in the test environment.