Storyous Public APIs
  1. Loyalty API
Storyous Public APIs
  • Introduction
  • Merchants API
    • Get merchant and all its places
  • Menu API
    • Get a menu tree
    • Get time-based menu
    • Get Remaining amounts of time-based menu
  • Bills API
    • Get list of payment bills
    • Get detail of a payment bill
  • Delivery API
    • Create an order through delivery API
    • Get status of delivery order
  • Deskview API
    • Get list of desks
    • Get list of sections
    • Get desk view of a place
  • Features API
    • Get list of merchants/places with a feature
  • Hotel accounts integration API
    • Provide list of accounts
    • Write consumed items to hotel account
  • Stocks API
    • Get list of stocks
    • Get list of items
    • Get list of stock ups
    • Get detail of stock up
    • Create new stock up
    • Modify stock up
    • Delete stock up
    • Get list of stock takings
    • Get detail of stock taking
    • Create new stock taking
    • Modify stock taking
    • Delete stock taking
    • Get suppliers
  • Loyalty API
    • Introduction
    • Prepayment
    • Get benefit offer
    • Report offer validation error
    • Report benefit usage
    • Get loyalty benefit usages
      GET
    • Mark benefit usages as synchronized
      POST
  • DataSync
    • Webhook receiving endpoint
      • Receive new or updated records
    • Data domains
      • Stock management
        • Stocks domain
        • StockItemCategories domain
        • StockItems domain
        • StockMovements domain
      • Sales and costs
        • Bills domain
        • BillCosts domain
        • TerminalTransactions domain
        • PaymentTypes domain
        • Loyalty domain
      • Desks
        • DeskSections domain
        • Desks domain
      • Menu
        • ItemCategories domain
        • Items domain
        • PlaceITems domain
      • Merchants
        • Merchants domain
        • Places domain
        • Persons domain
  • Reservations API
    • Create Seated Reservation
    • Reservation Changed Webhook
  • Schemas
    • Schemas
      • Loyalty api
        • BalanceBenefitOfferRequest
        • ThirdPartyLoyaltyOfferRequest
        • LoyaltyOfferValidationError
        • LoyaltyBenefitUsagesPayload
        • BenefitInput
        • PaidItem
        • Applied Benefits
        • PaymentByBalance
        • UsedBalance
        • LoyaltyOfferResponse
        • MenuProductDefinition
        • UsedGeneralDiscount
        • Prepayment
      • Desk
      • Section
    • ObjectId
  1. Loyalty API

Prepayment

Unlike spending a certain monetary value from vouchers or credits, prepayment allows merchants to let their customers top up vouchers or credits for future consumption.
As defined in Get benefit offer, balance values such as valueToUseInCurrency, controllableValueToUse, nonControllableValueToUse are representing the monetary value spending, whereas prepayment represents the value to be used by customer to top-up their credits or vouchers for future use.
The benefit provider, upon scanning a voucher or customer code, must determine which balance is used for prepayment and which for spending, and follow the Get Benefit Offer structure accordingly. It is not possible to spend and prepay within the same balance object.
This flow can also be used for voucher activation, as the POS system is abstracted from the actual state of the voucher. It is the partner’s responsibility to provide information on whether and how the voucher can be prepaid.
Prepayment implementation—by creating a balance upon scanning the QR code—follows the exact same workflows as described in the introduction diagrams in introduction, including Get Benefit Offer and error & usage reporting.
Prepayment operations are reported in the benefitUsages in the same way as spending transactions. Additionally, the POS must create a new bill item to represent the prepayment action.
There is not possibility to scan voucher to an empty basket. So there is a recommandation for voucher activation: in admin product detail to set "Voucher activation" product with 0 price and set this product not to be printed on the bill (works only with 0 CZK items).
For further details, as well as structure and validation rules, please consult Get benefit offer.

Balance Types Supporting Prepayment#

Balance Types Supporting Prepayment
Prepayment functionality is only available for the following balance types:
✅ SPV (Single Purpose Prepaid Voucher) - singlePurposePrepaidVoucher

✅ MPV (Multi Purpose Prepaid Voucher) - multiPurposePrepaidVoucher

❌ Points (Collectable Points) - collectablePoints

✅ Credits(Prepaid Credit) - prepaidCredit
Previous
Introduction
Next
Get benefit offer
Built with