Corgi BankDocumentation
OpenAPI

The ATM object

Terminal is a boarded terminal with its active configuration and state.

Attributes

active_versionintegerRequired
cash_unit_idstringRequired
configobject or nullOptional

TerminalConfig is one proposed version of a terminal's configuration.

8 child attributes
cash_ledger_account_idstringRequired

The unit's GL 1020 ledger account, as accounts reported it

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

created_atstring · date-timeRequired
idstringRequired
makerstringRequired
requestobjectRequired

TerminalRequest 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
addressobjectRequired

Address of a terminal: the location Regulation E receipts print (12 CFR 1005.9(a)(5)).

5 child attributes
citystringRequired
countrystringRequired
line1stringRequired
postal_codestringRequired
statestringRequired
cash_unit_idstringRequired

The accounts ATM custody unit on GL 1020

cassettesarray of objectsRequired
3 child attributes
capacity_notesintegerRequired

What a replenishment fills the cassette to

denomination_amountintegerRequired
positionintegerRequired
evidencestringRequired
low_cash_threshold_amountintegerRequired

Estimated cassette cash below this requests replenishment

max_notesintegerRequired
max_withdrawal_amountintegerRequired
namestringRequired
operationsarray of stringsRequired
surcharge_amountintegerRequired

Disclosed on screen to cards other banks issued (12 CFR 1005.16)

terminal_idstringRequired

8 characters, the network card acceptor terminal identification

reviewobject or nullOptional

Review is an independent decision on a maker's proposal.

4 child attributes
actorstringRequired
approvebooleanRequired
evidencestringRequired
recorded_atstring · date-timeRequired
terminal_refstringRequired

The terminal's id (atmt_)

versionintegerRequired
created_atstring · date-timeRequired
created_bystringRequired
idstringRequired
stateobjectRequired

TerminalState is the terminal's live operating state.

11 child attributes
available_operationsarray of stringsRequired
cassettesarray of objectsRequired
4 child attributes
denomination_amountintegerRequired
notesintegerRequired
positionintegerRequired
supplystringRequired

OK, LOW, OUT

commanded_out_of_servicebooleanRequired
counter_cycleintegerRequired
devicesobjectRequired
last_sequenceintegerRequired
out_of_cashbooleanRequired
retract_bin_notesintegerRequired
sequence_epochintegerRequired
supervisorbooleanRequired
updated_atstring · date-timeRequired
statusstringRequired

Pending_review, active, rejected

terminal_idstringRequired

to move to open esc to close