The ReserveRelease object Preview

Attributes

• id string Unique identifier for the object.
• amount integer Amount released. A positive integer representing how much is released in the smallest currency unit.
• currency enum Three-letter ISO currency code, in lowercase. Must be a supported currency.
• metadata nullable map Connect Only Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
• reason enum The reason for the ReserveRelease, indicating why the funds were released. Possible enum values bulk_hold_expiry The ReserveHold expired automatically according to its schedule. hold_released_early The ReserveHold was manually released before its scheduled release. hold_reversed The ReserveHold was reversed due to a refund or dispute. plan_disabled The ReserveHold was released due to its associated plan being disabled.
• released _ at timestamp The release timestamp of the funds.
• reserve _ hold nullable string Expandable The ReserveHold this ReserveRelease is associated with.
• source _ transaction nullable object The transaction which triggered this ReserveRelease.

More attributes

• object string, value is "reserve.release"
• created timestamp
• created _ by enum
• livemode boolean
• reserve _ plan nullable string Expandable

The ReserveRelease object

{ "id": "resrel_61SxyHbQOe90T6sLB41Q8rCFhzAUW", "object": "reserve.release", "amount": 500, "created": 1753406491, "created_by": "application", "currency": "usd", "livemode": false, "metadata": {}, "reason": "hold_released_early", "released_at": 1753406491, "reserve_hold": "reshold_61SxrUZH1aQJj97WT41Q8rCFhzAUW", "reserve_plan": null}

Create a ReserveRelease Preview

POST / v1 / reserve / releases

Create a ReserveRelease to manually release funds from a ReserveHold.

Parameters

• reserve _ hold string Required The ReserveHold to release.
• amount integer Amount to release from the provided ReserveHold. A positive integer representing how much to release in the smallest currency unit (e.g., 100 cents to release $1.00 or 100 to release ¥100, a zero-decimal currency). If not provided, the full releasable amount of the ReserveHold is released.
• currency enum Three-letter ISO currency code, in lowercase. Must be a supported currency.
• metadata map Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

Returns

Returns a ReserveRelease object.

cURL

Response

{ "id": "resrel_61SxyHbQOe90T6sLB41Q8rCFhzAUW", "object": "reserve.release", "amount": 500, "created": 1753406491, "created_by": "application", "currency": "usd", "livemode": false, "metadata": {}, "reason": "hold_released_early", "released_at": 1753406491, "reserve_hold": "reshold_61SxrUZH1aQJj97WT41Q8rCFhzAUW", "reserve_plan": null}

Update a ReserveRelease Preview

POST / v1 / reserve / releases /:id

Update a ReserveRelease’s metadata.

Parameters

• id string Required The identifier of the ReserveRelease to update.
• metadata map Required Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

Returns

Returns the updated ReserveRelease object.

cURL

Response

{ "id": "resrel_61SxyHbQOe90T6sLB41Q8rCFhzAUW", "object": "reserve.release", "amount": 500, "created": 1753406491, "created_by": "application", "currency": "usd", "livemode": false, "metadata": { "test_key": "test_value" }, "reason": "hold_released_early", "released_at": 1753406491, "reserve_hold": "reshold_61SxrUZH1aQJj97WT41Q8rCFhzAUW", "reserve_plan": null}