Headers

• Account-ID string(uuid) Required

  Account ID - Can be found on the Dashboard under Settings → API Tokens

Responses

• 201 application/json

  Voucher resent

  Hide response attribute Show response attribute object

  • data object

    Record of a voucher email sent to a customer, either as part of order fulfillment or as a manual resend

    Hide data attributes Show data attributes object

    • id string(uuid)

      Unique identifier for this email record. Internal use only - not displayed to customers. Used for tracking email delivery and audit purposes.

    • recipient_email string(email)

      Email address where the vouchers were sent

    • recipient_name string | null

      Name of the email recipient for personalization

    • created_at string(date-time)

      Timestamp when this email was sent

    • updated_at string(date-time)

      Timestamp when this email record was last updated

    • vouchers array[object]

      List of vouchers included in this email

      A voucher groups one or more redeemables for delivery to a customer. Vouchers handle the presentation and delivery method (email, postal, collection) of redeemable items.

      Hide vouchers attributes Show vouchers attributes object

      • id string(uuid)

        Unique identifier for the voucher. Internal use only - not displayed to customers. Use this ID for API operations like downloading PDFs or resending emails.

      • reference string

        Unique human-readable voucher reference code used for lookup and customer support. Displayed to: Customers in voucher emails, PDF vouchers, and on voucher QR code pages. Also searchable in the dashboard. Maximum 30 characters.

      • name string

        Display name of the voucher, typically derived from the product name. Displayed to: Customers on PDF vouchers and in emails. Also shown in dashboard.

      • recipient_name string | null

        Name of the person receiving this voucher. Used for personalization in emails and printed vouchers. Displayed to: Customers in voucher emails ("To: [recipient_name]") and on PDF vouchers. Maximum 60 characters. Null if not provided.

      • from_name string | null

        Name of the person sending this voucher. Used for personalization in gift messages. Displayed to: Customers in voucher emails ("From: [from_name]") and on PDF vouchers. Maximum 60 characters. Null if not provided.

      • message string | null

        Personal message from sender to recipient, displayed on the voucher. Displayed to: Customers on PDF vouchers and in voucher emails as the gift message. Maximum 191 characters. Null if no message provided.

      • custom_fields object

        Additional custom data for the voucher, such as design template settings or delivery-specific information. Structure varies by voucher configuration.

        Additional properties are allowed.

      • created_at string(date-time)

        Timestamp when the voucher was created

      • updated_at string(date-time)

        Timestamp when the voucher was last modified

      • order_date string(date-time)

        Timestamp when the parent order was created. Useful for sorting vouchers by purchase date.

      • redeemables array[object]

        All redeemable items included in this voucher. A voucher always contains at least one redeemable.

        A redeemable item that can be redeemed by a customer. Represents either a monetary value (gift card) or a standard item (experience, product, service).

        Hide redeemables attributes Show redeemables attributes object

        • id string(uuid)

          Unique identifier for the redeemable. Internal use only - not displayed to customers. Use this ID for API operations like redemption, cancellation, top-up, or validity updates.

        • type string

          Type of redeemable:

          • monetary: Gift card or voucher with a monetary value that can be redeemed for any amount up to its balance
          • standard: Single-use voucher for a specific experience, product, or service

          Values are monetary or standard.

        • status string

          Current redemption status:

          • issued: Active and eligible to be redeemed
          • not_yet_valid: Created but not yet within the valid_from/valid_to date range
          • redeemed: Fully redeemed (standard type) or has zero balance remaining (monetary type)
          • expired: Past the valid_to date and can no longer be redeemed
          • cancelled: Manually cancelled and cannot be redeemed

          Values are issued, not_yet_valid, redeemed, expired, or cancelled.

        • valid_from string(date) | null

          First date this redeemable can be used (inclusive). Null means valid immediately.

        • valid_to string(date) | null

          Last date this redeemable can be used (inclusive). Null means no expiration date.

        • valid_days array[string] | null

          Specific days of the week when this redeemable can be used. Null or empty array means valid all days.

          Values are monday, tuesday, wednesday, thursday, friday, saturday, or sunday.

        • currency_code string

          ISO 4217 currency code in lowercase. Applies to monetary_value for monetary type redeemables.

        • monetary_value integer | null

          For monetary type: Remaining balance in cents (smallest currency unit). Can be partially redeemed. For standard type: Always null.

        • name string

          Display name of the redeemable item, typically the product name. For variant products, combines product name and variant name (e.g., "Spa Day - Deluxe Package"). Displayed to: Customers on redemption screens, voucher details, and in terminal/POS during redemption.

        • custom_fields object

          Additional custom data for the redeemable, such as product-specific attributes or redemption instructions. Structure varies by product configuration.

          Additional properties are allowed.

        • tags object

          Key-value pairs for categorizing and filtering redeemables. Inherited from the parent product and order.

          Hide tags attribute Show tags attribute object

          • * string Additional properties
        • created_at string(date-time)

          Timestamp when the redeemable was created

        • updated_at string(date-time)

          Timestamp when the redeemable was last modified (e.g., redeemed, topped up, validity updated)

        • is_live boolean

          Indicates if this is a live (production) redeemable (true) or a test redeemable (false)

        • invalid_reason string | null

          Human-readable explanation of why this redeemable cannot currently be redeemed (e.g., "Expired on 2024-12-31", "Not valid on weekends"). Null if redeemable is valid.

        • redeem_locations array[object]

          List of redeem locations where this redeemable can be redeemed.

          Redeem location information needed for API operations

          Hide redeem_locations attributes Show redeem_locations attributes object

          • id string(uuid)

            Location UUID used in Redeem-Location-ID header

          • name string

            Location display name

          • is_active boolean

            Whether the location is currently active

• 404

  Voucher not found

• 422

  Cannot resend fully redeemed voucher