Ask the armored carrier module to replenish an ATM

POST/cards/atm/terminals/{id}/replenishments

Verified ATM operations staff with cards:atm:read on reads and cards:atm:write plus authentication within five minutes on writes; an independent reviewer holding cards:atm:approve decides configurations, exception resolutions and network settlements. Device messages require svc_atmdevice with cards:atm:device; network messages require svc_atmnetwork with cards:atm:network; replenishment updates admit the carrier's cards:atm:replenishment identity. The general cards:read and cards:write scopes do not open the switch. CADP1 is a bank-defined NDC-style cycle, not NCR NDC. The network link is a bank-defined ISO 8583:1987 subset, not a certified Pulse or STAR interface. Software PIN work is refused in production. Surcharges on cards other banks issued are disclosed on screen (12 CFR 1005.16). Cash posts to the terminal's ATM custody unit on GL 1020. See services/cards/atm/README.md.

Path parameters

idstringRequired

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

evidencestringRequired

Returns

200 OK

actorstringRequired

created_atstring · date-timeRequired

orderobjectRequired

ReplenishmentOrder is what the switch hands the armored carrier module: the narrow interface between ATM operations and cash logistics.

9 child attributes

amountintegerRequired

cash_unit_idstringRequired

idstringRequired

locationstringRequired

needed_bystring · date-timeRequired

notesobjectRequired

Requested notes by denomination in cents

reasonstringRequired

Low_cash, out_of_cash, manual

terminal_idstringRequired

terminal_refstringRequired

receiptobject or nullOptional

CarrierReceipt is the carrier module's acknowledgement of an order.

2 child attributes

accepted_atstring · date-timeRequired

referencestringRequired

statusstringRequired

updated_atstring · date-timeRequired

updatesarray of objectsRequired

4 child attributes

carrier_referencestringRequired

cash_movement_idstringOptional

Completed: the accounts custody movement that loaded the unit

evidencestringRequired

statusstringRequired

Scheduled, completed, cancelled

Errors

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

400401403404409412413422424429500503