Howler Cashless API docs
Updated
by Jesús Díaz Artiaga
Overview
These article completes the Howler Cashless API Documentation adding explanations and examples to the different endpoints that our API supports.
Pokes endpoint
GET /api/v2/events/{event_id}/pokes
Response fields
Common
These fields are common for all types of pokes
- id: the id of the poke in the database
- event_id: the id of the event
- action: describes the operation that ocurred onsite
- checkin: a ticket is scanned and its information is loaded in a NFC card/wristband
- ticket_validation: a ticket is just scanned and redeemed (no NFC chip)
- purchase: a box office purchase is made and the information of the ticket or entitlements bought are loaded in a NFC card/wristband
- order_redeemed: an online order is redeemed and the information of credits / entitlements are loaded in a NFC card/wrstiband
- topup: a NFC card/wristband is topped up. This transaction contains the payment of actual money paid to top up the chip.
- topup_credit: a NFC card/wristband is topped up. This transaction contains the information of credits loaded in the chip.
- record_credit: a NFC card/wristband is loaded with credits due to a ticket bundle, online top up, etc.
- refund: a NFC card/wristband is refunded. This transaction contains the payment of actual money returned to the customer.
- refund_credit: a NFC card/wristband is refunded. This transaction contains the information of credits substracted from the chip.
- fee: a fee is substracted or returned after a top up or refund.
- sale: a sale of products (actual good, not entitlements) is made onsite and paid with a NFC card/wristband.
- money_sale: a sale of products (actual good, not entitlements) is made onsite and paid with actual money (cash, card, etc.).
- checkpoint: an access checkpoint is made to control the access to a determinate zone.
- replacement: a NFC card/wristband is replaced by another one. This transaction contains the information to match both chips.
- replacement_topup_credit: a NFC card/wristband is replaced by another one. This transaction contains the information of credits loaded in the NFC chip.
- replacement_refund_credit: a NFC card/wristband is replaced by another one. This transaction contains the information of credits deducted in the replaced NFC chip.
- cash_recon: contains information of cash reconciliation operations to add, withdraw or money in a cashier.
- description: adds additional information to the action
- date: the date when the transaction took place onsite
- transactionable_id / transactionable_type: links the poke with the onsite transaction in the database
- line_counter: sorts the information of the poke with additional pokes that are part of the same operation
- gtag_counter: the corresponding counter stored in the NFC card/wristband used to sort the operations of each chip
- device_id: the id of the device that performed the operation
- station_id: the id of the station where the operation happened
- customer_id: the id of the customer (if known) that made the operation
- customer_gtag_id: the id of the NFC card/wristband that made the operation
- operator_id: the id of the operator that made the operation
- operator_gtag_id: the id of the operator's NFC card/wristband that made the operation
- created_at: the date when the transaction was stored in the server
Check-in / Ticketing
These fields are filled in check-in and other ticketing operations
- ticket_id: the id of the ticket that took place in the operation
- ticket_type_id: the id of the ticket type
Orders
These fields are filled when entitlements are written into a NFC chip. This can happen in check-in, box office and online order operations.
- order_id: the id of the online order that was redeemed
- catalog_item_id: the id of the catalog_item (entitlement) that has been applied to the NFC chip.
- catalog_item_type: the type of the catalog_item (entitlement) that has been applied to the NFC chip. This can be credits, accesses, operator permissions, etc.
Money
These fields are filled when there's money information included in the operation. This can happen in operations like box office, top up, refund, etc.
- payment_method: the method used to pay (cash, card, qr codes, etc)
- monetary_quantity: the amount of goods that were paid using money.
- monetary_unit_price: the unit price of the goods.
- monetary_total_price: the total price paid (quantity x unit price)
Credits
These fields are filled when there's credits information included in the operation. This can happen in operations like top up, refund, sales and any other operations that applies credits.
- credit_type: the type of credit
- credit_id: the id of the credit that is used in the operation
- credit_name: the name of the credit used in the operation
- credit_amount: the amount of credits applied/subtracted in the operation
- final_balance: the final balance of the NFC card/wristband after the operation
Onsite Sales
These fields are filled when actual products (drinks, food, merchanding, etc.) are sold onsite.
- product_id: the id of the product that was sold
- sale_item_quantity: the quantity of products that were sold
- sale_item_qty_franction_num: when a product it paid using both standard and virtual credits the quantity is expressed using a franction. This field is the numerator
- sale_item_qty_franction_den: when a product it paid using both standard and virtual credits the quantity is expressed using a franction. This field is the denominator
- sale_item_unit_price: the unit price of the product in the currency (credit) that was used to pay it
- sale_item_total_price: the total price of the product (quantity x unit price) in the currencty (credit) that was used to pay it
- standard_unit_price: the unit price of the product in standard credits
- standard_total_price: the total price of the product (quantity x unit price) in standard credits
- Include all Credit fields
User Flags
This field is filled when user flags are applied:
- user_flag_value: the value of the user flag (true/false) applied in the NFC card/wristband
Access Control
This field is filled in checkpoint operations
- access_direction: the direction (in / out) of the access control operation.
