The transaction summary report object contains a dashboard identifier (called event_id) and then an array of individual transaction summary records (transaction_summary_records), and an array of online topup summary records. (online_topup_summary_records)
| Field Name | Type | Description | Example value |
|---|---|---|---|
event_id |
string(UUID) |
Unique identifier for the dashboard | "253723ad-3e3b-4f13-b9f7-8b08d1d88906" |
online_topup_summary_records |
array(online_topup_summary_record) |
A list of online_topup_summary_recordas specified below. |
|
transaction_summary_records |
array(transaction_summary_record) |
A list of transaction_summary_records as specified below. |
These records indicate online topups that have been authorized by the guest.
<aside> đź’ˇ
Depending on the state of the transaction syncing and if the guest has visited a vendor since each of the authorized online topups, not all of these may have been applied to the wristband’s available balance through an ONLINE-APP transaction
</aside>
| Key | Type | Description |
|---|---|---|
amount |
int |
Amount in centavos |
recorded_at |
Unix time | Date and time the online topup was authorized |
<aside> đź’ˇ
All amount fields are represented in centavos/cents using integers.
For example 100 = $1.00 if currency is USD, €1.00 if the currency is EUR, etc.
</aside>
<aside> ⚠️
These records indicate only transactions that have been synced to the WristCoin servers. Because all transactions are processed and underwritten offline, it may be sometime until all the transactions appear in the report. This depends on how frequently all POS terminals are uploading their transactions. Integrations must take the terminal synchronization frequency into consideration when making billing decisions based on the reported transactions.
</aside>
<aside> đź’ˇ
Ask your WristCoin support rep. about the enforced sync interval option. It is possible to configure the mobile POS terminals to disable transaction processing if they go offline for more then a preset tolerated duration
</aside>
| Key | Type | Description |
|---|---|---|
tag_code |
string | The unique identifier of the wristband |
vendor_id |
string(UUID) |
|
terminal_timestamp |
Unix time | Date and time the transaction was performed on the mobile POS terminal |
server_timestamp |
Unix time | Date and time the transaction was uploaded to the WristCoin servers |
type |
See below for list of possible types and descriptions. | |
transaction_id |
string(UUID) |
|
amount |
int |
Amount in centavos/cents |
(see note below regarding ONLINE-APP transactions) |
| gratuity | int | Represented as centavos/cents:
ex: 100 = $1.00 if currency is USD, €1.00 if the currency is EUR, etc. |
| sales_tax | int | Represented as centavos/cents (see above) |
| activation_fee | int | Represented as centavos/cents (see above) |
| resulting_card_balance | int | Represented as centavos/cents (see above) |
| employee_email | string | Email of the account that was logged into the mobile POS terminal that performed the transaction |
| employee_id | string(UUID) | |
| vendor_name | string | This is an empty string for non vendor transactions such as topups |
| aeon_count | int | Represents the generation of the wristband if it’s reusable.
Note: If the aeon_count does not equal closeout_count, it means the wristband account is closed. When a wristband account is open, the aeon_count will be equal to the closeout count. |
| card_debit_total | int | The total debits, in centavos/cents, the wristband account had after the transaction. |
| card_offline_credit_total | int | The total face to face topups that are refundable if unspent, in centavos/cents, the wristband account had after the transaction.
Note: Face to face refunds are at the discretion of the actual end customer, event organizer, venue owner, etc.. |
| card_online_credit_total | int | The total online (self serve) topups that are refundable if unspent, in centavos/cents, the wristband account had after the transaction. |
| card_preloaded_credit_total | int | The total face to face topups (that might not be refundable depending on the tender type) the wristband account had after the transaction, in centavos/cents |
| card_reversal_total | int | Total amount of approved transaction reversals in centavos/cents. |
| rewards_awarded | int | Reward points earned this transaction. |
| rewards_redeemed | int | Reward points redeemed this transaction. |
| resulting_card_reward_balance | int | Reward point balance after the transaction |
| card_reward_credit_total | int | Total reward points the wristband account has been awarded ,after the transaction. |
| card_reward_debit_total | int | Total reward points the wristband account has redeemed, after the transaction. |
| card_preloaded_reward_points_total | int | Preloaded reward point balance. |
| Type | Description | Comments |
|---|---|---|
PURCHASE |
Purchase of line items | |
DEDUCTION |
A debit of funds from a clerk keying in a total charge | Tips are supported on deductions, but not sales tax |
ONLINE-APP |
Application of an online topup, this is when a an authorized online topup is applied to the balance available on the wristband | Online topups must be physically applied to the wristband which should happen automatically during a purchase or deduction. |
REV-REQUEST |
A transaction reversal request | Some WristCoin wallets support a delegated transaction reversal process where a request can be made that is approved by another staff authorized to do so. The lite style wristbands do not support delegated approval. |
REV-APPROVED |
A transaction reversal request that’s been approved | Once approved, the amount of the reversal is then made available to spend again. |
REV-DENIED |
A transaction reversal request that’s been denied | |
ACTIVATION-FEE |
A one time activation fee | Only gets charged once, on the first topup or online topup application |
CLOSEOUT |
Closing of the wristband account | If eligible, a refund can be issued during closeout. |
TOPUP-STD |
A cash topup | The next six entries are meant to represent different methods of payment tender for a topup. |
TOPUP-NM |
A non monetary topup | |
TOPUP-CC-IN |
A credit card topup using an integrated credit card present processing partner | |
TOPUP-DC-IN |
A credit card topup using an integrated debit card present processing partner | |
TOPUP-CC-EX |
A credit card topup using an external credit card present processing partner | |
TOPUP-DC-EX |
A credit card topup using an external debit card present processing partner | |
TOPUP-OTHER |
A topup using the tender type “other” on the POS |
The amount field for the ONLINE-APP type transactions represents the sum of all authorized online topups.