---
title: "Add a reserve rule"
method: POST
path: "/accounts/entities/{id}/reserve-rules"
tags: ["platforms", "Reserve rules"]
---

# Add a reserve rule

`POST /accounts/entities/{id}/reserve-rules`

## Request

- Base URL: `https://{prefix}.api.sandbox.checkout.com`
- URL: `https://{prefix}.api.sandbox.checkout.com/accounts/entities/{id}/reserve-rules`
- Auth: one of:
  - OAuth 2
    - Client credentials
    - Token URL: `string` scopes: `accounts`
  - API key in header `Authorization`
- TypeScript: <https://skmtc.dev/checkout/apis/checkout-com-api-reference/docs/accounts/entities/:id/reserve-rules/post.ts> (a function with typed inputs; its response is checked against the schema)

Create a sub-entity reserve rule.

## Request body

- ReserveRuleCreateRequest
  - `type` 'rolling', required
  - `rolling` RollingReserveRule, required
    - `percentage` number, required: The percentage of captured funds that will be reserved as a collateral balance.
    - `holding_duration` object, required: The length of time the collateral balance will be reserved for.
      - `weeks` integer, required
  - `valid_from` string, date-time, required: The date and time the reserve rule will come into effect. This must be at least 15 minutes in the future.

## Response `201`

Created

- ReserveRuleWriteResponse
  - `id` string
  - `_links` object
    - `self` Link
      - `href` string, required: The link URL

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `422`: Invalid data was sent

---

[API](https://skmtc.dev/checkout/apis/checkout-com-api-reference.md) - [All operations](https://skmtc.dev/checkout/apis/checkout-com-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/checkout/apis/checkout-com-api-reference/revisions/0f1abdb1c3e9?raw)