Skip to content

Transaction Management

Enables authorized partners to manage and display the current balance associated with a user’s credential and account.

The HID Origo Transaction Management API allows authorized integration partners to push real-time balance updates to HID using the dedicated Balances API. These updates enable the display of the latest balance directly on the user’s wallet digital credential (e.g., Google Wallet, and Apple Wallet in future releases).

A Pass represents a digital credential that can be issued and displayed on supported mobile wallets such as Google Wallet or Apple Wallet. It functions as a digital counterpart to a physical access badge, containing credential-related data such as user identity, credential type, and optionally, real-time balance information!

This API supports only the most recent declining balance value. Individual transaction history is not supported or retained. Balances will only be displayed when the Pass is in Active or Suspend mode.

Support limited to Google Wallet

Balances-level data is currently supported only for Google University customers. Support for additional platforms, including Apple Wallet, will be added in future releases.

Important Notes:

  • HID accepts only the latest balance value.
  • Transaction-level data is not stored or processed by HID.
  • Currently, balance display is supported only for Google University customers.
  • Apple Wallet and other platform support will be introduced in a future release.
  • Organizations that choose to display balance information through an authorized partner will have access to all account balance items linked to the user’s credential.
  • The Transaction API accepts all available balance items in every request, regardless of whether any item has been added, updated, or removed.

Balances API Specification

The Balances API allows authorized integration partners to manage and display real-time balance information associated with user credentials. This API enables the retrieval of balance updates, which can be displayed on user mobile credentials, such as Google Wallet or Apple Wallet (in future releases). The API also provides the ability to access associated account balance items, giving a comprehensive overview of the balance status.

Specification