Prepare a scheduled or ad hoc cash order with denomination breakdown
POST
/cash-operations/ordersHeaders
Idempotency-KeystringRequiredSend on every write that creates or changes money or state; a replay with the same key returns the original result with 200.
Body parameters
amountintegerRequiredatm_order_idstringOptionalcadencestringRequiredAd_hoc, scheduled
carrier_idstringRequiredcontract_idstringRequireddenominationsobjectRequiredUSD face value in cents -> number of pieces
evidencestringRequiredevidence_sha256stringRequiredfedcash_order_idstringOptionalfrom_unit_idstringOptionalkindstringRequiredDelivery, pickup
needed_bystring · date-timeRequiredreferencestringRequiredservicestringRequiredBranch, vault, atm, fedcash
to_unit_idstringOptionalReturns
200 OK
actorstringRequiredamountintegerRequiredatm_order_idstringOptionalbusiness_datestring · dateRequiredA business date, YYYY-MM-DD
cadencestringRequiredAd_hoc, scheduled
carrier_idstringRequiredconfirmationobject or nullOptional4 child attributes
actorstringRequiredevidencestringRequiredmovement_idstringOptionalrecorded_atstring · date-timeRequiredcontract_idstringRequiredcreated_atstring · date-timeRequireddecisionobject or nullOptional4 child attributes
actorstringRequiredapprovebooleanRequiredevidencestringRequiredrecorded_atstring · date-timeRequireddenominationsobjectRequiredUSD face value in cents -> number of pieces
evidencestringRequiredevidence_sha256stringRequiredfedcash_order_idstringOptionalfrom_unit_idstringOptionalidstringRequiredkindstringRequiredDelivery, pickup
makerstringOptionalmovement_idstringOptionalneeded_bystring · date-timeRequiredreferencestringRequiredservicestringRequiredBranch, vault, atm, fedcash
shipment_idstringOptionalstatusstringRequiredProposed, confirmed, approved, rejected, cancelled
to_unit_idstringOptionalErrors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503