Corgi BankDocumentation
OpenAPI

List ATM transactions

GET/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 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.

Query parameters

limitintegerOptional

Page size

Default 10. Maximum 100.

starting_afterstringOptional

The id of the last item seen; returns the page after it

ending_beforestringOptional

The id of the first item seen; returns the page before it

terminal_refstringOptional
statusstringOptional

Returns

200 OK

dataarray of objectsRequired
37 child attributes
account_idstringOptional

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

accounts_movement_idstringOptional
acquirer_idstringOptional
authorization_codestringOptional
authorized_amountintegerRequired
business_datestring · dateRequired

A business date, YYYY-MM-DD

card_idstringOptional

Example card_2tVh8nqLxq4GbDe0K1F6S9zRcWm

created_atstring · date-timeRequired
deposited_amountintegerRequired
device_sequenceintegerOptional

The request's message sequence

dispenseobjectOptional

Notes planned by cassette position

dispensed_amountintegerRequired
idstringRequired
journal_idsarray of stringsOptional
networkstringOptional
network_processing_codestringOptional
network_rrnstringOptional
network_stanstringOptional
network_transmitted_atstring · date-time or nullOptional
operationstringRequired
outcomeobject or nullOptional

Outcome is what the terminal, its journal or the network said physically happened.

8 child attributes
check_keptbooleanOptional
deposit_notesobjectOptional
devicestringOptional
presentedobjectOptional
recorded_atstring · date-timeRequired
resultstringRequired
retractedobjectOptional
sourcestringRequired

Solicited_status, journal, network_reversal, exception_resolution

pan_maskedstringRequired
payments_idstringOptional
reasonstringRequired
requested_amountintegerRequired
response_codestringRequired
retracted_amountintegerRequired
reversed_amountintegerRequired
routestringRequired
serialstringOptional

The terminal's transaction serial

statusstringRequired
surcharge_amountintegerRequired
terminal_idstringRequired

The 8-character terminal identification

terminal_locationstringRequired
terminal_refstringOptional

The bank's terminal (atmt_); empty for an issued transaction

to_account_idstringOptional

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

updated_atstring · date-timeRequired
has_morebooleanRequired

Whether another page follows

Errors

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

400401403404409412413422424429500503

to move to open esc to close