Record the carrier's progress on a replenishment order
/cards/atm/replenishments/{id}/updatesThe armored-carrier module records scheduled, completed or cancelled progress under cards:atm:replenishment. Completed updates name the accounts custody movement that loaded the unit. The switch does not move vault cash itself.
Path parameters
idstringRequiredHeaders
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
carrier_referencestringRequiredcash_movement_idstringOptionalCompleted: the accounts custody movement that loaded the unit
evidencestringRequiredstatusstringRequiredScheduled, completed, cancelled
Returns
200 OK
actorstringRequiredcreated_atstring · date-timeRequiredorderobjectRequiredReplenishmentOrder is what the switch hands the armored carrier module: the narrow interface between ATM operations and cash logistics.
9 child attributes
amountintegerRequiredcash_unit_idstringRequiredidstringRequiredlocationstringRequiredneeded_bystring · date-timeRequirednotesobjectRequiredRequested notes by denomination in cents
reasonstringRequiredLow_cash, out_of_cash, manual
terminal_idstringRequiredterminal_refstringRequiredreceiptobject or nullOptionalCarrierReceipt is the carrier module's acknowledgement of an order.
2 child attributes
accepted_atstring · date-timeRequiredreferencestringRequiredstatusstringRequiredupdated_atstring · date-timeRequiredupdatesarray of objectsRequired4 child attributes
carrier_referencestringRequiredcash_movement_idstringOptionalCompleted: the accounts custody movement that loaded the unit
evidencestringRequiredstatusstringRequiredScheduled, completed, cancelled
Errors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503