Giftpro API
  • Getting started
  • Common uses
    • Redeem at point-of-sale
    • Retrieving customer data
  • Filtering
  • Pagination
  • Errors
  • Reference
    • Properties
      • Delivery methods
    • Locations
    • Categories
    • Orders
      • Statuses
      • Address properties
    • Codes
      • Statuses
    • Balance events
      • Types of event
    • Vouchers
Powered by GitBook
On this page
  • Activation
  • Chargeback
  • Code change
  • Topup
  • Redeemed
  • Refund
  • Reverse chargeback
  • Unredeemed
  1. Reference
  2. Balance events

Types of event

PreviousBalance eventsNextVouchers

Last updated 1 year ago

Activation

This is the initial loading of the balance for the customer to use, this will be the first event in balance history for all vouchers. In most cases this will occur at the time of sale.

Chargeback

If a chargeback is received then the balance is reduced to zero via this balance entry, later on if the chargeback is won then this wil be reversed with a entry re-adding the balance.

The overall voucher status will have been updated if the voucher was not already used prior to the chargeback.

Code change

A zero-value balance event it indicates that the codes used for the voucher have been modified, the balance available does not change with this event.

Topup

A topup is will add to the balance available on the code, the locationID on the event will specify where this happened if it occurred at a POS.

Depending on the configuration of the property and voucher, a topup may modify the voucher expiry dates.

Redeemed

A redemption will use part or all of the remaining balance, there will be a locationID which specifies where the balance was used.

Refund

If a voucher is subsequently refunded then a new balance entry will be added moving the balance to zero.

A refund cannot be reversed.

Reverse chargeback

Unredeemed

This is always the opposite to an earlier .

A reversal of an earlier event. This happen where the customer has changed their mind about using the voucher.

Reverse Chargeback
Chargeback
Redeemed