Capture a currency or coin order or deposit for independent review
/cash-operations/fedcash/instructionsCash writer with a recent step-up. Captures an order or deposit against a vault unit; another supervisor must decide it.
Headers
Idempotency-KeystringOptionalSend on every write that creates or changes money or state; a replay with the same key returns the original result with 200.
Body parameters
endpointstringRequiredevidencestringRequiredkindstringRequiredOrder, deposit
office_codestringRequiredpackagesarray of objectsRequired6 child attributes
denomination_amountintegerRequiredformstringRequiredCurrency, coin
qualitystringOptionalFit, new, unfit, mixed
quantityintegerRequiredseriesstringOptionalIke: Eisenhower dollar bags (deposit only)
unitstringRequiredBundle, strap, bag
ship_datestring · dateRequiredA business date, YYYY-MM-DD
unit_idstringRequiredReturns
200 OK
actorstringRequiredamountintegerRequiredcreated_atstring · date-timeRequireddecisionobject or nullOptional4 child attributes
actorstringRequiredapprovebooleanRequiredevidencestringRequiredrecorded_atstring · date-timeRequireddiscrepancyobject or nullOptionalDiscrepancy is a Fed difference advice or a counted difference that needs independent review.
7 child attributes
actorstringRequiredamountintegerRequiredSigned: short is negative
created_atstring · date-timeRequireddecisionobject or nullOptional4 child attributes
actorstringRequiredapprovebooleanRequiredevidencestringRequiredrecorded_atstring · date-timeRequiredevidencestringRequiredidstringRequiredinstruction_idstringRequiredendpointstringRequiredevidencestringRequiredexecutionobject or nullOptionalFedExecution is the committed custody and fee posting.
5 child attributes
actorstringRequiredcash_movement_idstringRequiredfee_journal_idstringOptionalExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
journal_idstringRequiredExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
recorded_atstring · date-timeRequiredfee_amountintegerRequiredfeesarray of objectsRequired5 child attributes
amountintegerRequiredbilling_codestringRequiredFRB billing code
codestringRequiredUcap, cross_shipping
descriptionstringRequiredunitsintegerRequiredidstringRequiredkindstringRequiredOrder, deposit
office_codestringRequiredpackagesarray of objectsRequired6 child attributes
denomination_amountintegerRequiredformstringRequiredCurrency, coin
qualitystringOptionalFit, new, unfit, mixed
quantityintegerRequiredseriesstringOptionalIke: Eisenhower dollar bags (deposit only)
unitstringRequiredBundle, strap, bag
receiptobject or nullOptionalReceipt is a captured physical count against the instruction.
7 child attributes
actorstringRequiredamountintegerRequireddifference_amountintegerRequiredevidencestringRequiredpackagesarray of objectsRequired6 child attributes
denomination_amountintegerRequiredformstringRequiredCurrency, coin
qualitystringOptionalFit, new, unfit, mixed
quantityintegerRequiredseriesstringOptionalIke: Eisenhower dollar bags (deposit only)
unitstringRequiredBundle, strap, bag
recorded_atstring · date-timeRequiredseal_numbersarray of stringsRequiredship_datestring · dateRequiredA business date, YYYY-MM-DD
shipmentobject or nullOptionalFedCashShipment is the armored-carrier hand-off.
4 child attributes
actorstringRequiredcarrier_referencestringRequiredidstringRequiredrecorded_atstring · date-timeRequiredstatusstringRequiredsubmissionobject or nullOptionalSubmission is the Reserve Bank office's acknowledgement.
4 child attributes
actorstringRequiredfeesarray of objectsRequired5 child attributes
amountintegerRequiredbilling_codestringRequiredFRB billing code
codestringRequiredUcap, cross_shipping
descriptionstringRequiredunitsintegerRequiredoperator_idstringRequiredrecorded_atstring · date-timeRequiredunit_idstringRequiredErrors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503