GuardSettlement

Request funded settlements

Raises one or more funded settlement requests, all of them or none. Each line becomes a settlement in AWAITING_FUNDING that claims its slice of the Guard immediately; no rate is struck until the client's money arrives and CurrencyGuard executes. Lines naming the same Guard are summed before the available amount is checked. More than one Guard shares a batch reference, so the whole request can be paid with a single payment, and must then be one company settling in one currency.

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

post/api-regulated/v1/guards/request-funded-settlements

Request

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

Request body

customerIdstring uuid

Response

Funded settlement requests raised

Changes

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