Corgi BankDocumentation
OpenAPI

Reconcile a business date against the ATM network's settlement report

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

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

business_datestring · dateRequired

A business date, YYYY-MM-DD

evidencestringRequired
networkstringRequired

Returns

200 OK

computedobjectRequired

The same figures from the switch's own transactions

15 child attributes
acquired_inquiriesintegerRequired
acquired_withdrawal_amountintegerRequired
acquired_withdrawalsintegerRequired
acquirer_interchange_amountintegerRequired
business_datestring · dateRequired

A business date, YYYY-MM-DD

issued_inquiriesintegerRequired
issued_withdrawal_amountintegerRequired

Cash plus the acquirer's surcharge

issued_withdrawalsintegerRequired
issuer_interchange_amountintegerRequired
net_settlement_amountintegerRequired

Positive: the network pays the bank

networkstringRequired
participantstringRequired
report_sha256stringRequired
surcharge_amountintegerRequired
switch_fee_amountintegerRequired
created_atstring · date-timeRequired
idstringRequired
itemsarray of stringsRequired

The transactions it settles

journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

makerstringRequired
posted_atstring · date-time or nullOptional
posted_bystringOptional
reportobjectRequired

SettlementReport is the shared network's settlement report for one participant and date, as the network adapter delivers it.

15 child attributes
acquired_inquiriesintegerRequired
acquired_withdrawal_amountintegerRequired
acquired_withdrawalsintegerRequired
acquirer_interchange_amountintegerRequired
business_datestring · dateRequired

A business date, YYYY-MM-DD

issued_inquiriesintegerRequired
issued_withdrawal_amountintegerRequired

Cash plus the acquirer's surcharge

issued_withdrawalsintegerRequired
issuer_interchange_amountintegerRequired
net_settlement_amountintegerRequired

Positive: the network pays the bank

networkstringRequired
participantstringRequired
report_sha256stringRequired
surcharge_amountintegerRequired
switch_fee_amountintegerRequired
requestobjectRequired

SettlementRequest proposes a network settlement for a business date.

3 child attributes
business_datestring · dateRequired

A business date, YYYY-MM-DD

evidencestringRequired
networkstringRequired
reviewobject or nullOptional

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

4 child attributes
actorstringRequired
approvebooleanRequired
evidencestringRequired
recorded_atstring · date-timeRequired

Errors

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

400401403404409412413422424429500503

to move to open esc to close