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
  1. Reference
  2. Codes

Statuses

Voucher and event ticket codes have a status attribute, the status is one of three things that decide if the code can be used for any action.

Status
Meaning

Valid

The voucher is inside its validity dates and has balance that can be used.

Grace Period

The expiryDate is in the past but the graceExpiryDate is still in the future.

Partially Redeemed

Some but not all of the voucher balance has been used.

Status
Meaning

Redeemed

The voucher has already been fully used.

Void

The voucher was cancelled and the customer refunded if applicable.

Chargeback

A chargeback against the order occurred. A chargeback can be won in the future in which case the code will return to valid, assuming it has not expired. If the chargeback is lost then it remains in this status forever.

Not Yet Valid

The voucher will become valid to use in the future, check the validFromDate

Expired

The voucher has passed its expiryDate and graceExpiryDate

PreviousCodesNextBalance events

Last updated 1 year ago