# Reserve funds on a wallet

> The reservations.create operation: POST /api/v1/wallets/{id}/reservations in the REST API and the reservations_create tool in the MCP server.

Holds an amount of a wallet's credits for usage that is about to happen (spec §17.2): taken in spend order
(promo credits first, soonest expiry first) and moved to `reserved`, so nothing else can spend them. Capture
what was used (`reservations.capture`) or release the hold (`reservations.release`) before `expiresAt`
(`ttlSeconds`, at most an hour); after that the funds go back to the wallet by themselves
(`reservation.expired`).

Answers 402 `insufficient_funds` when the wallet's spendable credits are less than the amount. A frozen or
closed wallet takes no reservations. The same `idempotencyKey` (or `Idempotency-Key`) and request returns the
same reservation. For thousands of small charges a minute, use leases instead (§17.3).

## At a glance

- **REST:** `POST /api/v1/wallets/{id}/reservations`
- **MCP tool:** `reservations_create`
- **Operation ID:** `reservations.create`
- **Scope:** Brand
- **Permission:** `wallets:write`
- **Risk tier:** `write`
- **Dry run:** Supported (send `Ownrecord-Dry-Run: true`)
- **Idempotency:** `Idempotency-Key` required
- **Modes:** Test and live
- **Plan feature:** `usage_billing.enabled`
- **Authentication:** API key with the `wallets:write` scope
- **Since:** M6

## Request

### Path parameters

| Field | Type       | Description           |
| ----- | ---------- | --------------------- |
| `id`  | `wal_…` ID | The wallet (`wal_…`). |

### Body

A JSON object (`Content-Type: application/json`):

| Field             | Type                | Required | Description                                                                                                          |
| ----------------- | ------------------- | -------- | -------------------------------------------------------------------------------------------------------------------- |
| `amount`          | object              | Yes      | The amount to hold, in the wallet's currency.                                                                        |
| `amount.amount`   | string              | Yes      | Integer micros as a string (5000000 = 5.00).                                                                         |
| `amount.currency` | string              | Yes      | ISO 4217 currency code: the wallet's currency.                                                                       |
| `ttlSeconds`      | integer (1 to 3600) | Yes      | How long the hold lasts, 1 to 3600 seconds.                                                                          |
| `metadata`        | object              | No       | Your own key-value pairs (at most 50 keys, values of at most 500 characters).                                        |
| `idempotencyKey`  | string              | No       | Unique per wallet: the same key and request returns the same reservation (default: the request's `Idempotency-Key`). |

## Response

`201 Created` with a JSON object:

| Field            | Type                                                                  | Description                                                                    |
| ---------------- | --------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
| `id`             | string                                                                |                                                                                |
| `object`         | `"reservation"`                                                       |                                                                                |
| `brandId`        | `brd_…` ID                                                            |                                                                                |
| `livemode`       | boolean                                                               |                                                                                |
| `walletId`       | `wal_…` ID                                                            |                                                                                |
| `kind`           | one of `single`, `lease`                                              | `single` (§17.2) or `lease` (§17.3).                                           |
| `status`         | one of `active`, `expired_pending`, `captured`, `released`, `expired` | `active`, `captured`, `released`, `expired` (or `expired_pending` for leases). |
| `amount`         | money                                                                 | What was reserved.                                                             |
| `captured`       | money                                                                 | What was captured so far.                                                      |
| `outstanding`    | money                                                                 | What is still held: `amount − captured` while open, zero once closed.          |
| `expiresAt`      | date-time                                                             |                                                                                |
| `closedAt`       | date-time or null                                                     |                                                                                |
| `idempotencyKey` | string                                                                |                                                                                |
| `metadata`       | object                                                                |                                                                                |
| `createdAt`      | date-time                                                             |                                                                                |
| `updatedAt`      | date-time                                                             |                                                                                |

## Examples

### Hold €3 for five minutes

```http
POST /api/v1/wallets/wal_01m4ty7w2a5qx7mhd9k8w6s0b1/reservations
Authorization: Bearer or_test_…
Idempotency-Key: 3f1c9a52-7d0e-4b8f-9a61-0c2d5e8b7f14
Content-Type: application/json

{
  "amount": {
    "amount": "3000000",
    "currency": "EUR"
  },
  "ttlSeconds": 300,
  "idempotencyKey": "job-8841",
  "metadata": {
    "job": "8841"
  }
}
```

Response (`201`):

```json
{
  "id": "res_01m4ty7w2a5qx7mhd9k8w6s0b4",
  "object": "reservation",
  "brandId": "brd_01m4tx5nj8emwbyf7y9vcf47x4",
  "livemode": false,
  "walletId": "wal_01m4ty7w2a5qx7mhd9k8w6s0b1",
  "kind": "single",
  "status": "active",
  "amount": {
    "amount": "3000000",
    "currency": "EUR"
  },
  "captured": {
    "amount": "0",
    "currency": "EUR"
  },
  "outstanding": {
    "amount": "3000000",
    "currency": "EUR"
  },
  "expiresAt": "2026-10-16T10:20:00.000Z",
  "closedAt": null,
  "idempotencyKey": "job-8841",
  "metadata": {
    "job": "8841"
  },
  "createdAt": "2026-10-16T10:15:00.000Z",
  "updatedAt": "2026-10-16T10:15:00.000Z"
}
```

## Errors

| Code                                                                                                       | HTTP status | When                                                                                                                                            | What to do                                                                                                                                                                                |
| ---------------------------------------------------------------------------------------------------------- | ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [`validation_failed`](https://ownrecord.io/docs/reference/errors.md#validation_failed)                     | 400         | The amount isn't positive, `ttlSeconds` isn't 1 to 3600, or the metadata or idempotency key is malformed.                                       | Fix the fields listed in `details.issues` and send the request again.                                                                                                                     |
| [`resource_not_found`](https://ownrecord.io/docs/reference/errors.md#resource_not_found)                   | 404         | This brand has no such wallet in this mode (wallets belong to one brand and one mode).                                                          | Check the ID and that your credentials are scoped to the right organization, entity, brand and mode.                                                                                      |
| [`insufficient_funds`](https://ownrecord.io/docs/reference/errors.md#insufficient_funds)                   | 402         | The wallet's spendable credits (unexpired, not already reserved) are less than the amount (`details.requested`, `details.available`). HTTP 402. | Reserve or capture a smaller amount, or top up the wallet first. `details.requested` and `details.available` are in integer micros.                                                       |
| [`wallet_fresh_balance_capped`](https://ownrecord.io/docs/reference/errors.md#wallet_fresh_balance_capped) | 402         | The wallet has the credits, but the brand caps how much of recently bought credits can be used (`details.freeAt`; §20, WP-M9-risk). HTTP 402.   | Ask for less now, or wait until `details.freeAt`: the brand caps how much of a fresh balance can be used (`details.cap`, micros) until the credits are `details.untilAgeHours` hours old. |
| [`wallet_currency_mismatch`](https://ownrecord.io/docs/reference/errors.md#wallet_currency_mismatch)       | 400         | The amount isn't in the wallet's currency.                                                                                                      | Use the wallet for this currency. A customer has one wallet per currency (`details.expected`, `details.actual`).                                                                          |
| [`wallet_frozen`](https://ownrecord.io/docs/reference/errors.md#wallet_frozen)                             | 409         | The wallet is frozen: it takes no new reservations.                                                                                             | Unfreeze the wallet (`wallets.update` with `status: active`) once the review is done. Reservations made before the freeze can still be captured or released.                              |
| [`wallet_closed`](https://ownrecord.io/docs/reference/errors.md#wallet_closed)                             | 409         | The wallet is closed.                                                                                                                           | Reopen the wallet with `wallets.update` (`status: active`). A purchase of credits in its currency reopens it, too.                                                                        |
| [`idempotency_key_reused`](https://ownrecord.io/docs/reference/errors.md#idempotency_key_reused)           | 409         | The idempotency key was used before for another request.                                                                                        | Use a new Idempotency-Key for a different request, or resend the original request unchanged.                                                                                              |
| [`version_conflict`](https://ownrecord.io/docs/reference/errors.md#version_conflict)                       | 409         | The wallet changed at the same moment (another reservation, capture or grant); retry.                                                           | Fetch the object again and retry the change.                                                                                                                                              |
| [`scope_required`](https://ownrecord.io/docs/reference/errors.md#scope_required)                           | 400         | The request names no brand (an org or entity key without `Ownrecord-Brand`).                                                                    | Call the operation with credentials or a target at its level: an organization, a legal entity, a brand or the platform (`details.required_scope`).                                        |
| [`permission_denied`](https://ownrecord.io/docs/reference/errors.md#permission_denied)                     | 403         | You can't change this brand's wallets (`wallets:write`: owners, admins and support).                                                            | Ask an organization owner or admin for a role or scope that allows this action.                                                                                                           |
| [`livemode_not_allowed`](https://ownrecord.io/docs/reference/errors.md#livemode_not_allowed)               | 403         | You have no live-mode access, so you can't use live wallets.                                                                                    | Use test mode, or credentials for the target's mode. Developers need live access granted by an organization owner or admin.                                                               |
| [`entitlement_required`](https://ownrecord.io/docs/reference/errors.md#entitlement_required)               | 403         | The organization's plan doesn't include usage billing (`usage_billing.enabled`).                                                                | Upgrade the organization's plan, or remove something to get back under the limit.                                                                                                         |

It can also return these [common errors](https://ownrecord.io/docs/reference.md#common-errors): [`api_version_unsupported`](https://ownrecord.io/docs/reference/errors.md#api_version_unsupported), [`invalid_json`](https://ownrecord.io/docs/reference/errors.md#invalid_json), [`unsupported_media_type`](https://ownrecord.io/docs/reference/errors.md#unsupported_media_type), [`authentication_required`](https://ownrecord.io/docs/reference/errors.md#authentication_required), [`api_key_invalid`](https://ownrecord.io/docs/reference/errors.md#api_key_invalid), [`idempotency_key_required`](https://ownrecord.io/docs/reference/errors.md#idempotency_key_required), [`idempotency_in_progress`](https://ownrecord.io/docs/reference/errors.md#idempotency_in_progress), [`approval_required`](https://ownrecord.io/docs/reference/errors.md#approval_required), [`approval_rejected`](https://ownrecord.io/docs/reference/errors.md#approval_rejected), [`approval_expired`](https://ownrecord.io/docs/reference/errors.md#approval_expired), [`stale_approval`](https://ownrecord.io/docs/reference/errors.md#stale_approval), [`approval_policy_denied`](https://ownrecord.io/docs/reference/errors.md#approval_policy_denied), [`rate_limited`](https://ownrecord.io/docs/reference/errors.md#rate_limited), [`internal_error`](https://ownrecord.io/docs/reference/errors.md#internal_error).
