GuardSettlement

Preview a guard settlement

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

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)

Path parameters

guardIdstring required

Query parameters

foreignAmountnumber required

Response

Settlement preview calculated

guardIdstring
payReceive'PAY' | 'RECEIVE'
foreignAmountnumber
foreignCurrencystring
guardRatenumber
guardAmountnumber

The protected amount covering this slice — the cap the client can pay

guardCurrencystring
spotFxBidnumber
spotFxAsknumber
settlementZone'PROTECTION' | 'SAVINGS' | 'UNKNOWN'
fundingAmountnumber

What the client sends: the cap (Pay) or the foreign amount (Receive)

fundingCurrencystring
conversionAmountnumber

Indicative cost at the observed mid, for the savings route

fundingDeadlinestring

When funds must arrive — the settlement window end

previewedAtstring
settleableboolean

False when a real settlement would be refused — see validationErrors

validationErrorsstring[]

Why a settlement would be refused, empty when settleable

Example response

{
  "guardId": "GSP1000104",
  "payReceive": "PAY",
  "foreignAmount": 10000,
  "foreignCurrency": "USD",
  "guardRate": 1.25,
  "guardAmount": 8000,
  "guardCurrency": "GBP",
  "spotFxBid": 1.1995,
  "spotFxAsk": 1.2005,
  "settlementZone": "PROTECTION",
  "fundingAmount": 8000,
  "fundingCurrency": "GBP",
  "conversionAmount": 7692.31,
  "fundingDeadline": "2026-10-03T00:00:00Z",
  "previewedAt": "2026-10-01T09:30:00Z",
  "settleable": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.