Card readers
Overview
Connects to Square. The till puts the amount on a Square Terminal at your counter. The customer taps or inserts a card and may add a tip. Staff see what was taken, with the tip shown apart, and the card brand and last four digits. A checkout ends as taken, or as cancelled with the reason Square gives. Your shop is the seller: the Square account, the access token and the money are yours, and Adminium is not a party to any payment. The card is read by the Terminal and goes to Square, so no card number reaches your server. A refund made in Adminium goes back through Square. An Interac payment (Canada) is refunded only on the Terminal, so Adminium refuses it. Refunds and disputes made in the Square Dashboard are read by Adminium too. You set it up in Studio → Payments with an access token from your own Square account: the sandbox token for test payments, the production token for live ones. You pair each reader in Payments → Card readers with a device code that you type on the Terminal. Adminium asks the readers from the server, so a server with no public address works. Square keeps a Terminal checkout for 30 days, and Adminium keeps its own copy of what was taken. Square is not offered in Germany; there, use a Stripe reader through Card payments instead. It has no screens and no tables of its own, and it works with every app. It needs Adminium 0.3.60 or newer.
What it attaches to
This one is not tied to one app. It works inside Adminium itself, and in any app that hosts add-ons.
What connecting lets it do
It needs an access token from your own Square account: the sandbox token for test payments and the production token for live ones. Both are kept encrypted on your server, and no part of the add-on ever reaches a browser. The token opens the whole Square account, because Square has no narrower token for an application of your own, so keep it in Studio and nowhere else; if it ever leaks, make a new one in the Square Developer Console. It brings no tables of its own. Its server half may call the two addresses below, one for test and one for live, and nothing else.
Addresses its server code may reach
- connect.squareupsandbox.com
- connect.squareup.com
That list is the whole list: a call to any other address is refused and recorded.
What it needs to connect
An API key
What it adds
Where it appears 4
- In Adminium: its card under Studio → Payments, where you paste the access token for the sandbox or for production, and Check says whose Square account it is
- In Adminium: Payments → Card readers, where Pair a reader gives the reader a name and shows a device code to type on the Square Terminal
- At the till: the amount goes to the Square Terminal, the customer taps or inserts a card and may add a tip, and the till shows what was taken, the tip apart, with the card brand and last four digits; a checkout ends taken, or cancelled with the reason Square gives
- Refunds: a refund made in Adminium goes back through Square, except an Interac payment (Canada), which is refunded only on the Terminal; refunds and disputes made in the Square Dashboard show in Payments → Activity
Tables it brings 0
None — it brings no tables of its own.
Settings you configure 1
- Access token
If you switch it off
Disconnecting removes an add-on’s surfaces. It never drops the tables it created, deletes the files it wrote, or removes the rows it added — everything it wrote stays in your database. The credentials it was given are revoked and deleted with it.
What stays
Every payment already taken stays recorded against its record, with the tip apart and the card brand and last four digits. Adminium keeps its own copy, so a payment still reads in full after the 30 days Square keeps a Terminal checkout. It brought no tables of its own. Your Square account and the money in it are untouched.
What goes
Card readers leaves Studio → Payments, and the till can no longer put an amount on a Terminal. Refunds and disputes made in the Square Dashboard are no longer read. Square has no way to unpair a Terminal from outside it, so sign each Terminal out on the device itself.
About the demo
No demo on this site makes a real call to anyone else’s service. Every add-on ships a stand-in transport that answers from built-in data, and it is on by default. Real credentials are a self-host choice, described in the add-on’s own README.
How to switch it on None of the demos on this site include it. In your own Adminium (0.3.60 or newer), install Card readers from Add-ons, open Studio → Payments and connect it with the sandbox access token from your own Square account, to try test payments before you use the production token. Readers are paired in Payments → Card readers.
Adminium is not affiliated with this company.