Redeem Voucher (client-side)

Authorizations

X-Client-Application-Id

string

header

required

X-Client-Token

string

header

required

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

origin

string<hostname>

required

Indicates the origin (scheme, hostname, and port).

Query Parameters

code

string

required

Voucher code being redeemed.

Example:

"2CpRCE2c"

tracking_id

string

A tracking identifier of a user that redeemed a voucher. Identifier generated during voucher validation based on your internal id (e.g., email, database ID). This is a hashed customer source ID. If you also pass a customer ID, the tracking ID must be the ID of a source of the customer object. Otherwise, if you do not pass a customer ID, the tracking you provide must either be a token, like the ones returned by voucher validation, or a string identifying customer, with the options described below. Although not all information is required, the extra info helps prevent fraud.

Body

application/json

Provide the redemption context in the request body.

Discount Code
Gift Card
Loyalty Card

Request body schema for redeeming a voucher using POST v1/vouchers/{code}/redemption.

session

Discount Code Session Lock · object

Schema model for session lock object. The session object is required to establish a session between multiple parallel validation and redemption requests. If you only send the type parameter in the request, then by default the session lock will be established for 7 days. Read more on establishing a validation session.

Show child attributes

session.type

enum<string>

default:LOCK

This parameter is required to establish a new session. The session locks the redemption quantity by 1.

Available options:

LOCK

session.key

string

The session unique ID assigned by Voucherify or your own unique session ID. Sending an existing ID will result in overwriting an existing session. If no session key is provided, then a new ID will be generated.

Example:

"ssn_yQGMTeKBSw8OOuFPwlBEjzGy8d8VA9Ts"

session.ttl_unit

enum<string>

Defines the type of unit in which the session time is counted.

Available options:

HOURS,

DAYS,

MINUTES,

SECONDS,

MILLISECONDS,

MICROSECONDS,

NANOSECONDS

session.ttl

integer

Value for the period of time that the session is active. Units for this parameter are defined by the session.ttl_unit parameter.

customer

Customer ID · object

Customer's information.

Customer ID
Customer Source ID
Customer

Show child attributes

customer.id

string

The ID of an existing customer that will be linked to redemption in this request.

Example:

"cust_Vzck5i8U3OhcEUFY6MKhN9Rv"

order

Order ID · object

Order information.

Order ID
Order Source ID
Orders Create Request Body

Show child attributes

order.id

string

Unique ID assigned by Voucherify of an existing order that will be linked to the redemption of this request.

metadata

object

A set of key/value pairs that you can send in the request body to check against vouchers requiring redemption metadata validation rules to be satisfied. The validation runs against rules that are defined through the Create Validation Rules endpoint or via the Dashboard; in the Advanced Rule Builder → Advanced → Redemption metadata satisfy or Basic Builder → Attributes match → REDEMPTION METADATA. Read more.

options

object

Configure parameters returned in the response.

Show child attributes

options.expand

enum<string>[]

The expand array lets you configure the parameters included in the response. Depending on the strings included in the array, the response will contain different details. Add category as a string in the array to include a categories object in the response.

Available options:

category

Response

Returns a redemption object if the redeem operation succeeded.

Redeem Voucher Response Body
Redeem Voucher Response Body
Redeem Voucher Response Body

Response body schema for POST v1/vouchers/{code}/redemption.

string

Unique redemption ID.

Example:

"r_0bc92f81a6801f9bca"

object

string

default:redemption

The type of the object represented by the JSON. This object stores information about the redemption.

date

string<date-time>

Timestamp in ISO 8601 format indicating when the redemption occured.

Example:

"2022-10-03T12:24:58.008Z"

customer_id

string

Unique customer ID of the redeeming customer.

Example:

"cust_i8t5Tt6eiKG5K79KQlJ0Vs64"

tracking_id

string

Hashed customer source ID.

Example:

"track_fxEMFiLowFHg=="

metadata

object

The metadata object stores all custom attributes in the form of key/value pairs assigned to the redemption.

result

enum<string>

Redemption result.

Available options:

SUCCESS,

FAILURE

order

Order object - Effect: Apply to order · object

Defines the details of the order that is related to the redemption.

Order object - Effect: Apply to order
Order object - Effect: Apply to items

Show child attributes

order.id

string

Unique order ID, assigned by Voucherify.

Example:

"ord_OLWs41pBk7VFn6ZTyX9U6keh"

order.source_id

string

The merchant's order ID if it is different from the Voucherify order ID. It is really useful in case of integration between multiple systems. It can be an order ID from CRM, database or 3rd party service.

order.created_at

string<date-time>

Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format.

Example:

"2022-10-06T11:40:48.705Z"

order.updated_at

string<date-time>

Timestamp representing the date and time when the order was updated. The value is shown in the ISO 8601 format.

Example:

"2022-10-06T11:47:20.760Z"

order.status

enum<string>

Order status.

Available options:

CREATED,

PAID,

CANCELED,

FULFILLED

order.amount

integer

Order amount before applying any discount.

order.discount_amount

integer

Sum of all order-level discounts applied to the order.

order.total_discount_amount

integer

Sum of all order-level AND all product-specific discounts applied to the order.
total_discount_amount = discount_amount + items_discount_amount

order.total_amount

integer

Order amount after applying all the discounts.
total_amount = amount - total_discount_amount

order.applied_discount_amount

integer

This field shows the order-level discount applied.

order.total_applied_discount_amount

integer

This field sums up all order-level and all product-specific discounts applied in a particular request.

order.items

object[]

Array of order items that have been applied to the order. Each order item can show the effects of particular discounts on the item-level.

Show child attributes

order.items.object

string

default:order_item

The type of the object represented by JSON. This object stores information about the order_item.

order.items.product_id

string

A unique identifier that represents the product and is assigned by Voucherify.

Example:

"prod_5h0wc453_1"

order.items.sku_id

string

A unique identifier that represents the SKU and is assigned by Voucherify.

Example:

"sku_prod_5h0wc453_1_1"

order.items.quantity

integer

Quantity of the item in the cart.

order.items.amount

integer

Represents a total pre-discount amount of order item (price * quantity).

order.items.price

integer

Unit price of an item. The value is multiplied by 100 to represent 2 decimal places. For example 10000 cents for $100.00.

order.items.subtotal_amount

integer

Final order item amount after the applied item-level discount. If there are no item-level discounts applied, this item is equal to the amount.
subtotal_amount=amount-discount_amount

order.items.product

object

This object stores more information about the related product.

Show child attributes

order.items.product.id

string

A unique identifier that represents the product and is assigned by Voucherify.

Example:

"prod_5h0wc453_1"

order.items.product.source_id

string

A unique product identifier from your inventory system.

Example:

"illy-arabica"

order.items.product.name

string

Product name.

Example:

"Brewing System"

order.items.product.price

integer

Unit price of a product. The value is multiplied by 100 to represent 2 decimal places. For example 10000 cents for $100.00.

order.items.sku

object

This object stores more information about the related SKU.

Show child attributes

order.items.sku.id

string

A unique identifier that represents the SKU and is assigned by Voucherify.

Example:

"sku_prod_5h0wc453_1_1"

order.items.sku.source_id

string

A unique SKU identifier from your inventory system.

Example:

"illy-arabica-250g"

order.items.sku.sku

string

SKU name.

order.items.sku.price

integer

Unit price of a SKU. The value is multiplied by 100 to represent 2 decimal places. For example 10000 cents for $100.00.

order.metadata

object

The metadata object stores all custom attributes assigned to the order. A set of key/value pairs that are att to an order object. Stores additional information about the order in a structured format.

order.customer

object

Object containing information about the customer that is making the purchase.

Show child attributes

order.customer.id

string

Unique customer identifier of the customer making the purchase. The ID is assigned by Voucherify.

Example:

"cust_7iUa6ICKyU6gH40dBU25kQU1"

order.customer.object

string

default:customer

Type of object represented by the customer object.

order.referrer

object

Object containing information about the referrer.

Show child attributes

order.referrer.id

string

Unique referrer ID, who referred the customer making the purchase.

Example:

"cust_7iUa6ICKyU6gH40dBU25kQU1"

order.referrer.object

string

default:customer

Type of object represented by the referrer object.

order.customer_id

string

Unique customer identifier of the customer making the purchase. The ID is assigned by Voucherify.

Example:

"cust_7iUa6ICKyU6gH40dBU25kQU1"

order.referrer_id

string

Unique referrer ID.

Example:

"cust_nM4jqPiaXUvQdVSA6vTRUnix"

order.object

string

default:order

The type of the object represented by JSON. This object stores information about the order.

order.redemptions

Unstacked Redemption · object

Lists details related to the redemption.

Show child attributes

order.redemptions.redemption_ID

object

The property name is the unique redemption ID; i.e. r_0ba186c4824e4881e1. This object contains information about the redemption of an incentive.

Show child attributes

order.redemptions.redemption_ID.date

string<date-time>

Timestamp representing the date and time when the redemption was created. The value is shown in the ISO 8601 format.

Example:

"2022-09-02T17:06:56.649Z"

The source of the incentive.

Available options:

voucher,

promotion_tier

Unique ID of the related object that defines the incentive.

Represent's the campaign ID of the voucher if the redemption was based on a voucher that was part of bulk codes generated within a campaign. In case of a promotion tier, this represents the campaign ID of the promotion tier's parent campaign.

channel

object

Defines the details of the channel through which the redemption was issued.

Show child attributes

channel.channel_id

string

Unique channel ID of the user performing the redemption. This is either a user ID from a user using the Voucherify Dashboard or an X-APP-Id of a user using the API.

Example:

"user_g24UoRO3Caxu7FCT4n5tpYEa3zUG0FrH"

channel.channel_type

enum<string>

The source of the channel for the redemption. A USER corresponds to the Voucherify Dashboard and an API corresponds to the API.

Available options:

USER,

API

customer

object

Defines the customer that is related to the redemption.

Show child attributes

customer.id

string

The unique ID of a customer that is assigned by Voucherify.

Example:

"cust_eWgXlBBiY6THFRJwX45Iakv4"

customer.name

string

Customer's first and last name.

customer.email

string

Customer's email address.

customer.source_id

string

The merchant's customer ID if it is different from the Voucherify customer ID. It is really useful in case of an integration between multiple systems. It can be a customer ID from a CRM system, database or 3rd-party service.

customer.metadata

object

The metadata object stores all custom attributes assigned to the customer. A set of key/value pairs that you can attach to a customer object. It can be useful for storing additional information about the customer in a structured format.

customer.object

string

default:customer

Type of object represented is customer.

Defines the related object.

Related Object	Definition
voucher	Either a discount voucher, gift card, or loyalty card.

Available options:

voucher

Unique related object ID assigned by Voucherify, i.e. v_lfZi4rcEGe0sN9gmnj40bzwK2FH6QUno for a voucher.

voucher

Voucher Holder · object

Defines the details of the voucher being redeemed.

Show child attributes

voucher.id

string

Assigned by the Voucherify API, identifies the voucher.

Example:

"v_mkZN9v7vjYUadXnHrMza8W5c34fE5KiV"

voucher.code

string

A code that identifies a voucher. Pattern can use all letters of the English alphabet, Arabic numerals, and special characters.

Example:

"WVPblOYX"

voucher.campaign

string

A unique campaign name, identifies the voucher's parent campaign.

Example:

"Gift Card Campaign"

voucher.campaign_id

string

Assigned by the Voucherify API, identifies the voucher's parent campaign.

Example:

"camp_FNYR4jhqZBM9xTptxDGgeNBV"

voucher.category

string

Tag defining the category that this voucher belongs to. Useful when listing vouchers using the List Vouchers endpoint.

voucher.category_id

string

Unique category ID assigned by Voucherify.

Example:

"cat_0bb343dee3cdb5ec0c"

voucher.type

enum<string>

Defines the type of the voucher.

Available options:

GIFT_VOUCHER,

DISCOUNT_VOUCHER,

LOYALTY_CARD

voucher.discount

Discount · object

Contains information about discount.

Discount
Discount
Discount
Discount
Discount

Show child attributes

voucher.discount.type

enum<string>

default:AMOUNT

required

Defines the type of the voucher.

Available options:

AMOUNT

voucher.discount.amount_off

number

required

Amount taken off the subtotal of a price. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 discount is written as 1000.

voucher.discount.amount_off_formula

string

Formula used to dynamically calculate the discount.

voucher.discount.aggregated_amount_limit

integer

Maximum discount amount per order.

voucher.discount.effect

enum<string>

Defines how the discount is applied to the customer's order.

Available options:

APPLY_TO_ORDER,

APPLY_TO_ITEMS,

APPLY_TO_ITEMS_PROPORTIONALLY,

APPLY_TO_ITEMS_PROPORTIONALLY_BY_QUANTITY,

APPLY_TO_ITEMS_BY_QUANTITY

voucher.discount.is_dynamic

boolean

Flag indicating whether the discount was calculated using a formula.

voucher.gift

object

Object representing gift parameters. Child attributes are present only if type is GIFT_VOUCHER. Defaults to null.

Show child attributes

voucher.gift.amount

integer

Total gift card income over the lifetime of the card. The value is multiplied by 100 to represent 2 decimal places. For example 10000 cents for $100.00.

Example:

10000

voucher.gift.subtracted_amount

integer

Total amount of subtracted credits over the gift card lifetime. The value is multiplied by 100 to represent 2 decimal places. For example 10000 cents for $100.00.

voucher.gift.balance

integer

Available funds. The value is multiplied by 100 to represent 2 decimal places. For example 10000 cents for $100.00.

Example:

500

voucher.gift.effect

enum<string>

Defines how the credits are applied to the customer's order.

Available options:

APPLY_TO_ORDER,

APPLY_TO_ITEMS

voucher.loyalty_card

object

Object representing loyalty card parameters. Child attributes are present only if type is LOYALTY_CARD. Defaults to null.

Show child attributes

voucher.loyalty_card.points

integer

Total number of points added to the loyalty card over its lifespan.

Example:

7000

voucher.loyalty_card.balance

integer

Points available for reward redemption. This is calculated as follows: balance = points - expired_points - subtracted_points - redemption.redeemed_points.

Example:

6970

voucher.loyalty_card.next_expiration_date

string<date>

The next closest date when the next set of points are due to expire.

Example:

"2023-05-30"

voucher.loyalty_card.next_expiration_points

integer

The amount of points that are set to expire next.

voucher.loyalty_card.pending_points

integer

Shows the number of pending points that will be added to the loyalty card when they are activated automatically or manually.

voucher.loyalty_card.expired_points

integer

Shows the total number of expired points over the lifetime of the loyalty card.

voucher.loyalty_card.subtracted_points

integer

Shows the total number of subtracted points over the lifetime of the loyalty card.

voucher.start_date

string<date-time>

Activation timestamp defines when the code starts to be active in ISO 8601 format. Voucher is inactive before this date.

Example:

"2021-12-01T00:00:00.000Z"

voucher.expiration_date

string<date-time>

Expiration timestamp defines when the code expires in ISO 8601 format. Voucher is inactive after this date.

Example:

"2021-12-31T00:00:00.000Z"

voucher.validity_timeframe

Validity Timeframe · object

Set recurrent time periods when the earning rule is valid. For example, valid for 1 hour every other day.start_date required when including the validity_timeframe.

Show child attributes

voucher.validity_timeframe.duration

string

Defines the amount of time an earning rule will be active in ISO 8601 format. For example, an earning rule with a duration of PT1H will be valid for a duration of one hour.

Example:

"PT1H"

voucher.validity_timeframe.interval

string

Defines the intervening time between two time points in ISO 8601 format, expressed as a duration. For example, an earning rule with an interval of P2D will be valid every other day.

Example:

"P2D"

voucher.validity_day_of_week

enum<integer>[]

Integer array corresponding to the particular days of the week in which the voucher is valid.

0 Sunday
1 Monday
2 Tuesday
3 Wednesday
4 Thursday
5 Friday
6 Saturday

Available options:

0,

1,

2,

3,

4,

5,

6

voucher.validity_hours

Validity Hours · object

Determines the hours of validity, e.g. to create a happy hours scenario.

Show child attributes

voucher.validity_hours.daily

object[]

Defines the recurring period(s) when the resource is active. The periods should not overlap.

Show child attributes

voucher.validity_hours.daily.start_time

string<time>

Defines the starting hour of validity in the HH:mm format. The resource is inactive before this time.

Example:

"12:00"

voucher.validity_hours.daily.days_of_week

enum<integer>[]

Integer array corresponding to the particular days of the week in which the resource is valid.

0 Sunday
1 Monday
2 Tuesday
3 Wednesday
4 Thursday
5 Friday
6 Saturday

Available options:

0,

1,

2,

3,

4,

5,

6

voucher.validity_hours.daily.expiration_time

string<time>

Defines the ending hour of validity in the HH:mm format. The resource is inactive after this time.

Example:

"14:00"

voucher.active

boolean | null

A flag to toggle the voucher on or off. You can disable a voucher even though it's within the active period defined by the start_date and expiration_date.

true indicates an active voucher
false indicates an inactive voucher

voucher.additional_info

string

An optional field to keep any extra textual information about the code such as a code description and details.

voucher.metadata

object

The metadata object stores all custom attributes assigned to the code. A set of key/value pairs that you can attach to a voucher object. It can be useful for storing additional information about the voucher in a structured format.

voucher.assets

Voucher Assets · object

Stores links to images of QR and barcode that correspond to an encrypted voucher code.

Show child attributes

voucher.assets.qr

object

Stores Quick Response (QR) representation of encrypted code.

Show child attributes

voucher.assets.qr.id

string

Encrypted voucher code ID.

Example:

"U2FsdGVkX19ucFhvVmBVpVYG5KoswTsjSIaqoKg5L9ie4BK+t4pp7U7oFzjGJzj9q/bmuMOj9mEFiVKDMIkSaruKedMvHbKoPX5Sg+BaZk5QwXMf8k/OzSlOEVybpwSq+AiqPoNtjeuqtIgkDyvT6Q=="

voucher.assets.qr.url

string

URL to QR code

Optional: Attach query parameters to base URL to customize the image of the encrypted voucher code.

size: integer value from 1 to 100
format: string, either png (default) or svg

Example:

"https://dev.dl.voucherify.io/api/v1/assets/qr/U2FsdGVkX19ucFhvVmBVpVYG5KoswTsjSIaqoKg5L9ie4BK%2Bt4pp7U7oFzjGJzj9q%2FbmuMOj9mEFiVKDMIkSaruKedMvHbKoPX5Sg%2BBaZk5QwXMf8k%2FOzSlOEVybpwSq%2BAiqPoNtjeuqtIgkDyvT6Q%3D%3D"

voucher.assets.barcode

object

Stores barcode representation of encrypted code.

Show child attributes

voucher.assets.barcode.id

string

Encrypted voucher code ID.

Example:

"U2FsdGVkX19eJhGfWwUrH9+tulBkON+AnMktic+N6CVWzZ9+fHVxuVx22WakrzxiWXy0skuvvEHSeZIw9HlgyIJ+kJ1iPdUKpyENuNYJKzoZlO0mmTf6WQM6/pFs61apEn9SJx32ttCF6d3oxKISQQ=="

voucher.assets.barcode.url

string

URL to barcode

Optional: Attach query parameters to base URL to customize the image of the encrypted voucher code.

size: integer value from 1 to 100
format: string, either png (default) or svg

Example:

"https://dev.dl.voucherify.io/api/v1/assets/barcode/U2FsdGVkX19eJhGfWwUrH9%2BtulBkON%2BAnMktic%2BN6CVWzZ9%2BfHVxuVx22WakrzxiWXy0skuvvEHSeZIw9HlgyIJ%2BkJ1iPdUKpyENuNYJKzoZlO0mmTf6WQM6%2FpFs61apEn9SJx32ttCF6d3oxKISQQ%3D%3D"

voucher.is_referral_code

boolean | null

Flag indicating whether this voucher is a referral code; true for campaign type REFERRAL_PROGRAM.

voucher.created_at

string<date-time>

Timestamp representing the date and time when the voucher was created. The value is shown in the ISO 8601 format.

Example:

"2021-12-22T10:13:06.487Z"

voucher.updated_at

string<date-time>

Timestamp representing the date and time when the voucher was last updated in ISO 8601 format.

Example:

"2021-12-22T10:14:45.316Z"

voucher.holder_id

string

Unique customer identifier of the redeemable holder. It equals to the customer ID assigned by Voucherify.

Example:

"cust_eWgXlBBiY6THFRJwX45Iakv4"

voucher.referrer_id

string

Unique identifier of the referring person.

Example:

"cust_Vzck5i8U3OhcEUFY6MKhN9Rv"

voucher.object

string

default:voucher

The type of the object represented by JSON. Default is voucher.

voucher.publish

object

Stores a summary of publication events: an event counter and endpoint to return details of each event. Publication is an assignment of a code to a customer, e.g. through a distribution.

Show child attributes

voucher.publish.object

string

default:list

The type of the object represented is by default list. To get this list, you need to make a call to the endpoint returned in the url attribute.

voucher.publish.count

integer

Publication events counter.

Example:

0

voucher.publish.url

string

The endpoint where this list of publications can be accessed using a GET method. /v1/vouchers/{voucher_code}/publications

Example:

"/v1/vouchers/WVPblOYX/publications?page=1&limit=10"

voucher.redemption

object

Stores a summary of redemptions that have been applied to the voucher.

Show child attributes

voucher.redemption.quantity

integer

How many times a voucher can be redeemed. A null value means unlimited.

voucher.redemption.redeemed_quantity

integer

How many times a voucher has already been redeemed.

Example:

1

voucher.redemption.redeemed_points

integer

Total loyalty points redeemed.

Example:

100000

voucher.redemption.object

string

default:list

The type of the object represented is by default list. To get this list, you need to make a call to the endpoint returned in the url attribute.

voucher.redemption.url

string

The endpoint where this list of redemptions can be accessed using a GET method. /v1/vouchers/{voucher_code}/redemptions

Example:

"/v1/vouchers/WVPblOYX/redemptions?page=1&limit=10"

voucher.categories

Category · object[]

Contains details about the category.

Show child attributes

voucher.categories.id

string

required

Unique category ID assigned by Voucherify.

voucher.categories.name

string

required

Category name.

voucher.categories.hierarchy

integer

required

Category hierarchy. Categories with lower hierarchy are processed before categories with higher hierarchy value.

Required range: x >= 0

voucher.categories.object

enum<string>

default:category

required

The type of the object represented by the JSON. This object stores information about the category.

Available options:

category

voucher.categories.created_at

string<date-time>

required

Timestamp representing the date and time when the category was created. The value is shown in the ISO 8601 format.

Example:

"2022-07-14T10:45:13.156Z"

voucher.categories.updated_at

string<date-time>

Timestamp representing the date and time when the category was updated. The value is shown in the ISO 8601 format.

Example:

"2022-08-16T10:52:08.094Z"

voucher.validation_rules_assignments

Validation Rules Assignments List · object

List of Validation Rules Assignments

Show child attributes

voucher.validation_rules_assignments.object

enum<string>

default:list

required

The type of the object represented by JSON. This object stores information about validation rules assignments.

Available options:

list

voucher.validation_rules_assignments.data_ref

enum<string>

default:data

required

Identifies the name of the attribute that contains the array of validation rules assignments.

Available options:

data

voucher.validation_rules_assignments.data

Business Validation Rule Assignment · object[]

required

Contains array of validation rules assignments.

Show child attributes

voucher.validation_rules_assignments.data.id

string

required

The unique identifier for a assignment

voucher.validation_rules_assignments.data.rule_id

string

required

The unique identifier for a rule

The unique identifier for a related object

The type of related object

voucher.validation_rules_assignments.data.object

enum<string>

default:validation_rules_assignment

required

The type of the object represented by JSON.

Available options:

validation_rules_assignment

voucher.validation_rules_assignments.data.created_at

string<date-time>

Timestamp representing the date and time when the object was created. The value is shown in the ISO 8601 format.

Example:

"2022-03-09T11:19:04.819Z"

voucher.validation_rules_assignments.data.updated_at

string<date-time>

Timestamp representing the date and time when the object was last updated in ISO 8601 format.

Example:

"2022-03-09T11:19:04.819Z"

voucher.validation_rules_assignments.data.validation_status

enum<string>

The validation status of the assignment

Available options:

VALID,

PARTIALLY_VALID,

INVALID

voucher.validation_rules_assignments.data.validation_omitted_rules

string[]

The list of omitted rules

voucher.validation_rules_assignments.total

integer

required

Total number of validation rules assignments.

Required range: x >= 0

voucher.holder

Simple Customer · object

Simplified customer data.

Show child attributes

voucher.holder.id

string

Unique identifier of an existing customer. It is assigned by Voucherify.

voucher.holder.name

string

Customer's first and last name.

voucher.holder.email

string

Customer's email address.

voucher.holder.source_id

string

A unique identifier of the customer. It can be a customer ID or email from a CRM system, database, or a third-party service.

voucher.holder.metadata

object

A set of custom key/value pairs that are attached to the customer. It stores all custom attributes assigned to the customer.

voucher.holder.object

enum<string>

The type of the object represented by JSON.

Available options:

customer

Introduction

Endpoints

Events

Redeem Voucher (client-side)

Expand Response

Authorizations

Headers

Query Parameters

Body

Response