Corgi BankDocumentation
OpenAPI

ATM

Bank-owned terminals and shared-network traffic: a documented CADP1 device protocol modelled on NDC-style states (NCR NDC is proprietary and is not implemented), on-us authorisation, Pulse/STAR-style acquiring and issuing, surcharge disclosure, electronic journal and cash reconciliation to per-unit ATM custody on GL 1020, and replenishment handed to an armored-carrier module. Simulators and software PIN security are refused in production.

OBJECTThe ATM objectBank-owned terminals and shared-network traffic: a documented CADP1 device protocol modelled on NDC-style states (NCR NDC is proprietary and is not implemented), on-us authorisation, Pulse/STAR-style acquiring and issuing, surcharge disclosure, electronic journal and cash reconciliation to per-unit ATM custody on GL 1020, and replenishment handed to an armored-carrier module. Simulators and software PIN security are refused in production.GETList the ATM exception queue/cards/atm/exceptions · 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 settlementsPOSTReconcile a business date against the ATM network's settlement report/cards/atm/network-settlements · 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 settlementsGETList replenishment orders/cards/atm/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 settlementsPOSTBoard an ATM on its custody unit for independent review/cards/atm/terminals · 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 settlementsGETList boarded ATMs with their live state/cards/atm/terminals · 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 settlementsGETList ATM transactions/cards/atm/transactions · 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 settlementsPOSTRun one ATM pass: age unanswered dispenses, finish postings and deliver queued reversals/cards/atm/work-passes · 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 settlementsPOSTAnswer one Corgi ATM Device Protocol message from a terminal/cards/atm/device/messages · Requires the verified svc_atmdevice service JWT with cards:atm:deviceGETRead an ATM exception with its resolutions/cards/atm/exceptions/{id} · 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 settlementsGETRead an uploaded electronic journal and its reconciliation/cards/atm/journal-uploads/{id} · 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 settlementsGETRead an ATM network settlement/cards/atm/network-settlements/{id} · 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 settlementsPOSTAnswer one shared ATM network message for a card the bank issued/cards/atm/network/messages · Requires the verified svc_atmnetwork service JWT with cards:atm:networkGETRead a replenishment order/cards/atm/replenishments/{id} · 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 settlementsGETRead an ATM configuration version and its review/cards/atm/terminal-configurations/{id} · 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 settlementsGETRead one ATM's configuration and state/cards/atm/terminals/{id} · 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 settlementsGETRead one ATM transaction and its outcome/cards/atm/transactions/{id} · 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 settlementsPOSTPropose how an ATM exception ends/cards/atm/exceptions/{id}/resolutions · 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 settlementsPOSTPost an approved ATM network settlement/cards/atm/network-settlements/{id}/applications · 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 settlementsPOSTIndependently review an ATM network settlement/cards/atm/network-settlements/{id}/reviews · 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 settlementsPOSTRecord the carrier's progress on a replenishment order/cards/atm/replenishments/{id}/updates · The armored-carrier module records scheduled, completed or cancelled progress under cards:atm:replenishmentPOSTCarry out an approved ATM exception resolution/cards/atm/resolutions/{id}/applications · 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 settlementsPOSTIndependently review an ATM exception resolution/cards/atm/resolutions/{id}/reviews · 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 settlementsPOSTIndependently review an ATM configuration version/cards/atm/terminal-configurations/{id}/reviews · 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 settlementsGETList an ATM's counters reconciliations against its custody ledger/cards/atm/terminals/{id}/cash-reconciliations · 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 settlementsPOSTQueue a command for an ATM: in or out of service, counters, journal or configuration/cards/atm/terminals/{id}/commands · 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 settlementsPOSTPropose a new configuration version for an ATM/cards/atm/terminals/{id}/configurations · 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 settlementsPOSTAsk the armored carrier module to replenish an ATM/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

to move to open esc to close