---
title: "Preview a guard settlement"
method: GET
path: "/api-regulated/v1/guards/{guardId}/preview-guard-settlement"
tags: ["GuardSettlement"]
---

# Preview a guard settlement

`GET /api-regulated/v1/guards/{guardId}/preview-guard-settlement`

## Request

- Base URL: `https://api.currencyguard.com`
- URL: `https://api.currencyguard.com/api-regulated/v1/guards/{guardId}/preview-guard-settlement`
- Auth: OAuth 2 (implicit, authorization URL `https://auth.currencyguard.com/oauth2/authorize`, scopes: `regulated.risk-management.canSettleGuard`)

Computes the zone, the route the drawer should offer, and the funding for settling a given foreign amount now. Writes nothing and fixes no rate.

**Required entitlement:** `regulated.risk-management.canSettleGuard`  
_Entitles the regulated user to settle existing guard positions for their customers_

## Path parameters

- `guardId` string, required

## Query parameters

- `foreignAmount` number, required

## Response `200`

Settlement preview calculated

- GuardSettlementPreviewDTO: A read-only preview of settling a Guard: zone, route and funding, computed not written
  - `guardId` string
  - `payReceive` 'PAY' | 'RECEIVE'
  - `foreignAmount` number
  - `foreignCurrency` string
  - `guardRate` number
  - `guardAmount` number: The protected amount covering this slice — the cap the client can pay
  - `guardCurrency` string
  - `spotFxBid` number
  - `spotFxAsk` number
  - `settlementZone` 'PROTECTION' | 'SAVINGS' | 'UNKNOWN'
  - `fundingAmount` number: What the client sends: the cap (Pay) or the foreign amount (Receive)
  - `fundingCurrency` string
  - `conversionAmount` number: Indicative cost at the observed mid, for the savings route
  - `fundingDeadline` string: When funds must arrive — the settlement window end
  - `previewedAt` string
  - `settleable` boolean: False when a real settlement would be refused — see validationErrors
  - `validationErrors` string[]: Why a settlement would be refused, empty when settleable

## Other responses

- `401`: Not authenticated — [`security/authentication-failed`](/problems/security/authentication-failed/)
- `403`: Not authorized — [`security/insufficient-permissions`](/problems/security/insufficient-permissions/)
- `404`: Guard not found — [`http/resource-not-found`](/problems/http/resource-not-found/)

---

[API](https://skmtc.dev/currencyguard/apis/currencyguard-trading-system-api-external.md) · [All operations](https://skmtc.dev/currencyguard/apis/currencyguard-trading-system-api-external/llms.txt) · [OpenAPI document](https://skmtc.dev/currencyguard/apis/currencyguard-trading-system-api-external/revisions/a1f3f854190d?raw)