Corgi BankDocumentation
OpenAPI

Stop an approved rate sheet pricing at once

POST/ledger/fx/rate-sheets/{id}/withdrawals

Treasury staff with ledger:treasury:write and fresh authentication withdraw an approved sheet with evidence; a withdrawal only stops money moving, so it needs no second person. A withdrawn customer sheet stops quoting and converting at once, including quotes already issued on it; a closing sheet cannot be withdrawn once the close remeasured at it. Publishes ledger.fx_rate_sheet.withdrawn.

Path parameters

idstringRequired

Headers

Idempotency-KeystringOptional

Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.

Body parameters

evidencestringRequired

Returns

200 OK

actorstringRequired
atstring · date-timeRequired
business_datestring · dateRequired

A business date, YYYY-MM-DD

content_sha256stringRequired
daily_customer_limit_usd_minorintegerOptional
decisionobject or nullOptional
5 child attributes
actorstringRequired
approvebooleanRequired
atstring · date-timeRequired
content_sha256stringRequired
evidencestringRequired
evidencestringRequired
idstringRequired
linesarray of objectsRequired
5 child attributes
currency_codestringRequired
customer_buy_spread_bpsintegerOptional

The customer buys the currency: ask = mid × (1 + bps/10000)

customer_sell_spread_bpsintegerOptional

The customer sells the currency: bid = mid × (1 − bps/10000)

max_conversion_usd_minorintegerOptional
usd_per_foreign_majorstringRequired
policy_referencestringRequired
purposestringRequired
rate_snapshot_idstringRequired
rate_snapshot_sha256stringRequired
statusstringRequired

Proposed, approved or rejected

valid_fromstring · date-time or nullOptional
valid_untilstring · date-time or nullOptional

Errors

Every error is a problem document with a stable code. See Errors.

400401403404409412413422424429500503

to move to open esc to close