GuardSettlement

Request a funded settlement for one Guard

The same thing for a single Guard, returning one settlement rather than a list. A wrapper: it builds a one-line request and calls the same service method, so every check -- including the per-request ceiling -- exists in exactly one place and batching buys the caller no headroom. No batch reference, because a lone settlement already has its own.

Required entitlement: regulated.risk-management.canSettleGuard
Entitles the regulated user to settle existing guard positions for their customers

post/api-regulated/v1/guards/{guardId}/request-funded-settlement

Request

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

Path parameters

guardIdstring required

Request body

foreignAmountnumber required
customerIdstring uuid

Response

Funded settlement request raised

Changes

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