Propose a new configuration version for an ATM
/cards/atm/terminals/{id}/configurationsVerified 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
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
addressobjectRequiredAddress of a terminal: the location Regulation E receipts print (12 CFR 1005.9(a)(5)).
5 child attributes
citystringRequiredcountrystringRequiredline1stringRequiredpostal_codestringRequiredstatestringRequiredcash_unit_idstringRequiredThe accounts ATM custody unit on GL 1020
cassettesarray of objectsRequired3 child attributes
capacity_notesintegerRequiredWhat a replenishment fills the cassette to
denomination_amountintegerRequiredpositionintegerRequiredevidencestringRequiredlow_cash_threshold_amountintegerRequiredEstimated cassette cash below this requests replenishment
max_notesintegerRequiredmax_withdrawal_amountintegerRequirednamestringRequiredoperationsarray of stringsRequiredsurcharge_amountintegerRequiredDisclosed on screen to cards other banks issued (12 CFR 1005.16)
terminal_idstringRequired8 characters, the network card acceptor terminal identification
Returns
200 OK
cash_ledger_account_idstringRequiredThe unit's GL 1020 ledger account, as accounts reported it
Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm
created_atstring · date-timeRequiredidstringRequiredmakerstringRequiredrequestobjectRequiredTerminalRequest boards a terminal or proposes a new configuration for it. Terminal settings that decide what a cardholder pays or can do are controls: each version is independently reviewed before the switch uses it.
11 child attributes
addressobjectRequiredAddress of a terminal: the location Regulation E receipts print (12 CFR 1005.9(a)(5)).
5 child attributes
citystringRequiredcountrystringRequiredline1stringRequiredpostal_codestringRequiredstatestringRequiredcash_unit_idstringRequiredThe accounts ATM custody unit on GL 1020
cassettesarray of objectsRequired3 child attributes
capacity_notesintegerRequiredWhat a replenishment fills the cassette to
denomination_amountintegerRequiredpositionintegerRequiredevidencestringRequiredlow_cash_threshold_amountintegerRequiredEstimated cassette cash below this requests replenishment
max_notesintegerRequiredmax_withdrawal_amountintegerRequirednamestringRequiredoperationsarray of stringsRequiredsurcharge_amountintegerRequiredDisclosed on screen to cards other banks issued (12 CFR 1005.16)
terminal_idstringRequired8 characters, the network card acceptor terminal identification
reviewobject or nullOptionalReview is an independent decision on a maker's proposal.
4 child attributes
actorstringRequiredapprovebooleanRequiredevidencestringRequiredrecorded_atstring · date-timeRequiredterminal_refstringRequiredThe terminal's id (atmt_)
versionintegerRequiredErrors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503