Skip to main content

Managing Physical Tags

In the Enterprise ecosystem, Tags represent physical tokens—such as NFC cards or wristbands that are linked to a specific wallet.

They allow wallet holders to easily make payments at Sticitt Terminals


1. Linking a Tag (Creation)

To activate a physical tag, you must "link" its unique hardware ID to a funding wallet.

Endpoint: Link tag

Prerequisites:

  • The Wallet must be linked to or owned by your Partner Account.
  • You must have the physical Tag Number (printed on the card or wristband).

Key Parameters

  • tagHexNumber (Required): The unique identifier printed on the physical tag or read from the chip.
  • walletId (Required): The wallet that will fund transactions made by this tag.
  • name (Optional): A display name for the tag holder (e.g., "John's Wristband").
  • dailyLimitCents (Optional): A safety cap on spending. The tag cannot spend more than this amount in a single day, even if the wallet has a higher balance.
  • notes (Optional): A text string displayed to the Merchant Terminal when the tag is scanned.
    • Best Practice: Use this for critical alerts like "Peanut Allergy"

2. Updating a Tag

You can modify a tag's settings at any time. This is useful for adjusting spending limits or disabling lost tags immediately.

Endpoint: Update tag

Mutable Fields

  • notes: Update allergy info or class details.
  • name: Update the holder's name.
  • dailyLimitCents: Increase or decrease the daily spending cap.
  • enabled: Set to false to instantly block the tag from making payments (e.g., if lost or stolen).

3. Retrieving Tags

You can query tags to view their current limits, status, or usage.

Get Single Tag: Get tag by ID Returns the full details of a specific tag.

Get Tags by Wallet: Get tags on wallet by ID Returns a list of all physical tags currently linked to a specific wallet (e.g., if a user has both a card and a wristband).