GuardSettlement

Withdraw a funded settlement request

Withdraws a request that has not been funded, freeing the slice of the Guard it claimed. The row is kept and moves to FUNDING_CANCELLED -- the slice is released by dropping out of the claimed total, not by writing an amount back. Refused once the money has arrived: from then on CurrencyGuard is holding client funds and is committed to executing.

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

post/api-regulated/v1/guards/{guardId}/guard-settlements/{settlementId}/cancel-funding-request

Request

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

Path parameters

guardIdstring required
settlementIdstring required

Request body

reasonstring

Response

Funding request withdrawn

Changes

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