Corgi BankDocumentation
OpenAPI

Accept a FedCash currency order or deposit for physical shipment

POST/cash-operations/fedcash-shipments

The FedCash module's shipment contract. Kind order is currency or coin into the contract vault; kind deposit leaves the vault for a Reserve Bank office. Staff confirm and a different supervisor decides before GL 1020 moves.

Headers

Idempotency-KeystringRequired

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

amountintegerRequired
cash_unit_idstringRequired
idstringRequired
kindstringRequired

Order, deposit

locationstringRequired
needed_bystring · date-timeRequired
notesobjectRequired
windowstringRequired

Returns

200 OK

accepted_atstring · date-timeRequired
referencestringRequired

Errors

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

400401403404409412413422424429500503

to move to open esc to close