Voucher Loyalty Card Pending Points Activated

The EVENTS.CUSTOMER.VOUCHER.LOYALTY_CARD.PENDING_POINTS.ACTIVATED event indicates that loyalty pending points have been successfully activated and added to a customer’s loyalty card associated with a voucher. The pending points can be activated automatically after a predefined time set in days or manually with the POST Activate Member Pending Points endpoint. This event is used in a webhook configured in Distributions in Voucherify dashboard.

This page documents only the event. If you need more details about the webhook payload data that includes this event, go to Introduction to webhooks page.

Body

application/json

Event data object schema for customer.voucher.loyalty_card.pending_points.activated.

customer

Simple Customer · object

required

Simplified customer data.

Show child attributes

customer.id

string

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

customer.name

string

Customer's first and last name.

customer.email

string

Customer's email address.

customer.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.

customer.metadata

object

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

customer.object

enum<string>

The type of the object represented by JSON.

Available options:

customer

campaign

Simple Campaign · object

required

Simplified campaign data.

Show child attributes

campaign.id

string

Campaign ID.

campaign.name

string

Campaign name.

campaign.campaign_type

string

Type of campaign.

campaign.type

enum<string>

Defines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of standalone vouchers.

AUTO_UPDATE: the campaign is dynamic, i.e. vouchers will generate based on set criteria
STATIC: vouchers need to be manually published
STANDALONE: campaign for single vouchers

Available options:

AUTO_UPDATE,

STATIC,

STANDALONE

campaign.is_referral_code

boolean

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

campaign.voucher

Simple Campaign Voucher · object

Simplified campaign voucher data.

Show child attributes

campaign.voucher.type

enum<string>

required

Type of the voucher.

Available options:

DISCOUNT_VOUCHER,

LOYALTY_CARD,

GIFT_VOUCHER

campaign.voucher.redemption

object

required

Defines the redemption limits on vouchers.

Show child attributes

campaign.voucher.redemption.quantity

integer | null

required

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

campaign.voucher.redemption.redeemed_quantity

integer

required

How many times a voucher has already been redeemed.

Example:

1

campaign.voucher.code_config

Code Config Settings · object

required

Schema containing information about config used for voucher. Defines the code pattern (prefix, suffix, length, charset, etc).

Show child attributes

campaign.voucher.code_config.length

number

required

Number of characters in a generated code (excluding prefix and postfix).

campaign.voucher.code_config.charset

string

required

Characters that can appear in the code.

campaign.voucher.code_config.prefix

string

required

A text appended before the code.

campaign.voucher.code_config.postfix

string

required

A text appended after the code.

campaign.voucher.code_config.pattern

string

required

A pattern for codes where hashes (#) will be replaced with random characters. Overrides length.

campaign.voucher.code_config.initial_count

integer

The initial count.

campaign.voucher.discount

Discount · object

Defines the voucher discount type and details. It will not be returned at all or it will return a null for LOYALTY_CARD.

Discount
Discount
Discount
Discount
Discount

Show child attributes

campaign.voucher.discount.type

enum<string>

default:AMOUNT

required

Defines the type of the voucher.

Available options:

AMOUNT

campaign.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.

campaign.voucher.discount.amount_off_formula

string

campaign.voucher.discount.aggregated_amount_limit

integer

Maximum discount amount per order.

campaign.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

campaign.voucher.discount.is_dynamic

boolean

Flag indicating whether the discount was calculated using a formula.

campaign.voucher.gift

Gift · object

Defines the voucher gift details. It will not be returned at all or it will return a null for LOYALTY_CARD.

Show child attributes

campaign.voucher.gift.amount

number

required

Total gift card income over the lifetime of the card. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $10 amount is written as 1000.

campaign.voucher.gift.balance

number

required

Available funds. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $10 amount is written as 1000.

campaign.voucher.gift.effect

enum<string>

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

Available options:

APPLY_TO_ORDER,

APPLY_TO_ITEMS

campaign.voucher.loyalty_card

Campaign Loyalty Card · object

Defines the voucher loyalty card details. It will not be returned at all or it will return a null for DISCOUNT_VOUCHER or GIFT_CARD.

Show child attributes

campaign.voucher.loyalty_card.points

integer

required

The initial number of points to assign to the loyalty card. This is the current loyalty card score i.e. the number of loyalty points on the card.

campaign.voucher.loyalty_card.expiration_rules

object

Defines the loyalty point expiration rule. This expiration rule applies when there are no expiration_rules defined for an earning rule.

Show child attributes

campaign.voucher.loyalty_card.expiration_rules.period_type

enum<string>

required

Type of period. Can be set for MONTH or FIXED_DAY_OF_YEAR. MONTH requires the period_value field. FIXED_DAY_OF_YEAR requires the fixed_month and fixed_day fields.

Available options:

FIXED_DAY_OF_YEAR,

MONTH

campaign.voucher.loyalty_card.expiration_rules.period_value

integer

Value of the period. Required for the period_type: MONTH.

campaign.voucher.loyalty_card.expiration_rules.rounding_type

enum<string>

Type of rounding of the expiration period. Optional for the period_type: MONTH.

Available options:

END_OF_MONTH,

END_OF_QUARTER,

END_OF_HALF_YEAR,

END_OF_YEAR,

PARTICULAR_MONTH

campaign.voucher.loyalty_card.expiration_rules.rounding_value

integer

Value of rounding of the expiration period. Required for the rounding_type.

campaign.voucher.loyalty_card.expiration_rules.fixed_month

integer

Determines the month when the points expire; 1 is January, 2 is February, and so on. Required for the period_type: FIXED_DAY_OF_YEAR.

Required range: 1 <= x <= 12

campaign.voucher.loyalty_card.expiration_rules.fixed_day

integer

Determines the day of the month when the points expire. Required for the period_type: FIXED_DAY_OF_YEAR.

Required range: 1 <= x <= 31

campaign.referral_program

Referral Program · object

Defines the referee reward and the way a referral is triggered. Context: REFERRAL_PROGRAM.

Show child attributes

campaign.referral_program.conversion_event_type

enum<string>

Defines how a referral is triggered.

Available options:

redemption,

custom_event

campaign.referral_program.custom_event

object

Contains details about the custom event.

Show child attributes

campaign.referral_program.custom_event.id

string

Unique custom event ID.

Example:

"ms_Ll9enAm2BCN0M1s4VxWobLFM"

campaign.referral_program.custom_event.name

string

Custom event name.

campaign.referral_program.referee_reward

object

Defines the referee reward.

Show child attributes

Details of the resource from which the reward originates.

Show child attributes

Unique identifier of the reward source.

Example:

"camp_kdxp3vf1clQ9CFs1jpqv3tZe"

Name of the reward source.

Type of resource represented by the source of the reward.

Available options:

CAMPAIGN

campaign.referral_program.referee_reward.type

enum<string>

Type of reward.

Available options:

DISCOUNT_VOUCHER,

LOYALTY_CARD,

GIFT_VOUCHER

campaign.referral_program.referee_reward.amount

string

Define the number of points to add to a loyalty card or credits to the balance on a gift card. In case of the gift card, the value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 amount is written as 10000.

campaign.auto_join

boolean

Indicates whether customers will be able to auto-join the campaign if any earning rule is fulfilled.

campaign.join_once

boolean

If this value is set to true, customers will be able to join the campaign only once. It is always false for standalone voucher campaigns and it cannot be changed in them. It is always true for loyalty campaigns.

campaign.active

boolean

Indicates whether the campaign is active.

campaign.category_id

string | null

The unique category ID that this campaign belongs to.

campaign.category

string

Unique category name.

campaign.categories

Category · object[]

Contains details about the category.

Show child attributes

campaign.categories.id

string

required

Unique category ID assigned by Voucherify.

campaign.categories.name

string

required

Category name.

campaign.categories.hierarchy

integer

required

Category hierarchy.

campaign.categories.created_at

string<date-time>

required

Timestamp representing the date and time when the category was created in the ISO 8601 format.

Example:

"2024-01-01T11:11:11.111Z"

campaign.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

campaign.categories.updated_at

string<date-time>

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

Example:

"2024-01-01T11:11:11.111Z"

campaign.categories.stacking_rules_type

enum<string>

The type of the stacking rule eligibility.

Available options:

JOINT,

EXCLUSIVE

campaign.metadata

object

A set of custom key/value pairs that you can attach to a campaign. The metadata object stores all custom attributes assigned to the campaign.

campaign.start_date

string<date-time>

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

Example:

"2022-09-20T00:00:00.000Z"

campaign.expiration_date

string<date-time>

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

Example:

"2022-09-30T00:00:00.000Z"

campaign.description

string

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

campaign.created_at

string<date-time>

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

Example:

"2024-01-01T11:11:11.111Z"

campaign.updated_at

string<date-time>

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

Example:

"2024-01-01T11:11:11.111Z"

campaign.object

enum<string>

default:campaign

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

Available options:

campaign

voucher

Simple Voucher · object

required

Simplified voucher data.

Show child attributes

voucher.code

string

required

Voucher code.

voucher.type

enum<string>

required

Type of the voucher.

Available options:

DISCOUNT_VOUCHER,

LOYALTY_CARD,

GIFT_VOUCHER

voucher.created_at

string<date-time>

required

Timestamp representing the date and time when the order was created in the ISO 8601 format.

Example:

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

voucher.object

enum<string>

default:voucher

required

The type of the object represented by JSON.

Available options:

voucher

voucher.id

string

A unique identifier that represents the voucher assigned by Voucherify.

voucher.gift

Gift · object

Gift object response.

Show child attributes

voucher.gift.amount

number

required

Total gift card income over the lifetime of the card. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $10 amount is written as 1000.

voucher.gift.balance

number

required

Available funds. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $10 amount is written as 1000.

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.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

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.loyalty_card

Simple Loyalty Card · object

Defines the loyalty card details. Simplified loyalty card data.

Show child attributes

voucher.loyalty_card.points

integer

required

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

voucher.loyalty_card.balance

integer

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

voucher.loyalty_card.next_expiration_date

string

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

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.campaign

string

Campaign name.

voucher.campaign_id

string

Campaign unique ID.

voucher.is_referral_code

boolean

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

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 referrer assigned by Voucherify.

Example:

"cust_nM4jqPiaXUvQdVSA6vTRUnix"

voucher.category_id

string | null

Unique identifier of the category that this voucher belongs to.

Example:

"cat_0b6152ce12414820dc"

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.

voucher.categories.created_at

string<date-time>

required

Timestamp representing the date and time when the category was created in the ISO 8601 format.

Example:

"2024-01-01T11:11:11.111Z"

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.updated_at

string<date-time>

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

Example:

"2024-01-01T11:11:11.111Z"

voucher.categories.stacking_rules_type

enum<string>

The type of the stacking rule eligibility.

Available options:

JOINT,

EXCLUSIVE

voucher.active

boolean

Shows whether the voucher is on or off. true indicates an active voucher and false indicates an inactive voucher.

voucher.updated_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:

"2024-01-01T11:11:11.111Z"

voucher.redemption

object

Defines the redemption limits on vouchers.

Show child attributes

voucher.redemption.quantity

integer | null

required

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

voucher.redemption.redeemed_quantity

integer

required

How many times a voucher has already been redeemed.

Example:

1

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.metadata

object

A set of custom key/value pairs that you can attach to a voucher. The metadata object stores all custom attributes assigned to the voucher.

balance

Voucher Balance · object

required

Contains information on how the balance was affected by the transaction.

Show child attributes

balance.total

integer

required

The number of all points or credits accumulated on the card as affected by add or subtract operations.

balance.object

enum<string>

required

The type of the object represented by the JSON.

Available options:

balance

balance.balance

integer

required

The available points or credits on the card after the transaction as affected by redemption or rollback.

Defines the resource that is being modified with the values that are returned in the balance object.

Show child attributes

Identifies the voucher that is being modified. The ID is assigned by the Voucherify API.

The object being modified, i.e. voucher.

Available options:

voucher

balance.type

enum<string>

The type of voucher whose balance is being adjusted due to the transaction.

Available options:

loyalty_card,

gift_voucher

balance.amount

integer

Credits added or subtracted on a gift card.

balance.points

integer

Points added or subtracted in the transaction of a loyalty card.

balance.operation_type

enum<string>

The type of the operation being performed. The operation type is AUTOMATIC if it is an automatic redemption.

Available options:

MANUAL,

AUTOMATIC

order

Simple Order · object

required

Order information.

Show child attributes

order.object

enum<string>

default:order

required

The type of the object represented by JSON.

Available options:

order

order.id

string

Unique identifier of an existing order that will be linked to the redemption of this request.

order.source_id

string

Unique source identifier of an existing order that will be linked to the redemption of this request.

order.status

enum<string>

The order status.

Available options:

CREATED,

PAID,

CANCELED,

FULFILLED

order.customer_id

string | null

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

Example:

"cust_7iUa6ICKyU6gH40dBU25kQU1"

order.referrer_id

string | null

Unique identifier of the referrer assigned by Voucherify.

Example:

"cust_nM4jqPiaXUvQdVSA6vTRUnix"

order.amount

integer

A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items' amounts.

order.discount_amount

integer

Sum of all order-level discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).

order.applied_discount_amount

integer

This field shows the order-level discount applied. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).

order.items_discount_amount

integer

Sum of all product-specific discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).

order.items_applied_discount_amount

integer

Sum of all product-specific discounts applied in a particular request. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
sum(items, i => i.applied_discount_amount)

order.total_discount_amount

integer

Sum of all order-level AND all product-specific discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).

order.total_applied_discount_amount

integer

Sum of all order-level AND all product-specific discounts applied in a particular request. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00). total_applied_discount_amount = applied_discount_amount + items_applied_discount_amount

order.total_amount

integer

Order amount after undoing all the discounts through the rollback redemption. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).

order.items

Simple Order Item · object[]

Array of items applied to the order. It can include up to 500 items.

Show child attributes

order.items.object

enum<string>

default:order_item

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

Available options:

order_item

order.items.source_id

string

The merchant’s product/SKU ID (if it is different from the Voucherify product/SKU ID).

Used along with the source_id property. It can be set to either SKU or product.

Available options:

product,

sku

order.items.product_id

string

A unique product ID assigned by Voucherify.

order.items.sku_id

string

A unique SKU ID assigned by Voucherify.

order.items.quantity

integer

The quantity of the particular item in the cart.

order.items.discount_quantity

integer

Number of dicounted items.

order.items.amount

integer

The total amount of the order item (price * quantity).

order.items.discount_amount

integer

The sum of all order-item-level discounts applied to the order.

order.items.applied_discount_amount

integer

The order-level discount applied.

order.items.price

integer

Unit price of an item. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 discount is written as 1000.

order.items.subtotal_amount

integer

Final order amount after the applied discount.

order.metadata

object

A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format. It can be used to define business validation rules or discount formulas.

transaction

Voucher Transaction · object

required

Transaction details of the voucher.

Show child attributes

transaction.id

string

required

Unique identifier of the transaction.

transaction.source_id

string | null

required

The merchant's product ID (if it is different than Voucherify's product ID).

transaction.voucher_id

string

required

Unique identifier of the voucher.

transaction.campaign_id

string

required

Unqiue identifier of the voucher's parent campaign if it is part of campaign that generates bulk codes.

transaction.source

enum<string> | null

required

The channel through which the transaction took place, whether through the API, Dashboard, or integrated tool. In case of a redemption, this value is null.

Available options:

voucherify-web-ui,

voucherify-mobile-ui,

voucherify-cockpits-ui,

bigcommerce-integration,

bigcommerce-webhook-handler,

bigcommerce.priority-webhook-handler,

shopify_public-webhook-handler,

shopify_public.priority-webhook-handler,

activecampaign-webhook-handler,

mparticle-webhook-handler,

API,

Automation

transaction.reason

string | null

required

Reason why the transaction occurred. In case of a redemption, this value is null.

transaction.type

required

Type of transaction.

Available options:

PENDING_POINTS_ACTIVATION,

POINTS_ACCRUAL,

POINTS_REDEMPTION,

POINTS_REFUND,

POINTS_ADDITION,

POINTS_REMOVAL,

POINTS_EXPIRATION,

POINTS_TRANSFER_IN,

POINTS_TRANSFER_OUT

transaction.details

object

required

Contains the detailed information about the transaction.

Show child attributes

transaction.details.balance

Voucher Balance · object

Contains information on how the balance was affected by the transaction.

Show child attributes

transaction.details.balance.total

integer

required

The number of all points or credits accumulated on the card as affected by add or subtract operations.

transaction.details.balance.object

enum<string>

required

The type of the object represented by the JSON.

Available options:

balance

transaction.details.balance.balance

integer

required

The available points or credits on the card after the transaction as affected by redemption or rollback.

Defines the resource that is being modified with the values that are returned in the balance object.

Show child attributes

Identifies the voucher that is being modified. The ID is assigned by the Voucherify API.

The object being modified, i.e. voucher.

Available options:

voucher

transaction.details.balance.type

enum<string>

The type of voucher whose balance is being adjusted due to the transaction.

Available options:

loyalty_card,

gift_voucher

transaction.details.balance.amount

integer

Credits added or subtracted on a gift card.

transaction.details.balance.points

integer

Points added or subtracted in the transaction of a loyalty card.

transaction.details.balance.operation_type

enum<string>

The type of the operation being performed. The operation type is AUTOMATIC if it is an automatic redemption.

Available options:

MANUAL,

AUTOMATIC

transaction.details.order

object

Contains information about the original order.

Show child attributes

transaction.details.order.id

string

required

Unique identifier of the order.

transaction.details.order.source_id

string

required

Unique identifier of the merchant's order if it is different from the Voucherify order ID.

transaction.details.event

object

Contains information about the event that triggers the point accrual.

Show child attributes

transaction.details.event.id

string

required

Unique event ID.

transaction.details.event.type

string

required

Type of event.

transaction.details.earning_rule

object

Contains information about the earning rule.

Show child attributes

transaction.details.earning_rule.id

string

required

Unique identifier of an earning rule, assigned by Voucherify.

transaction.details.earning_rule.source

object

required

Contains the custom earning rule name.

Show child attributes

transaction.details.earning_rule.source.banner

string

required

Name of the earning rule. This is displayed as a header for the earning rule in the Dashboard.

transaction.details.segment

object

Contains information about the segment.

Show child attributes

transaction.details.segment.id

string

required

Unique identifier of the segment.

transaction.details.segment.name

string

required

Name of the segment.

transaction.details.loyalty_tier

object

Contains information about the loyalty tier that is mapped for the earning rule and used in the transaction.

Show child attributes

transaction.details.loyalty_tier.id

string

required

Unique identifier of the loyalty tier, assigned by Voucherify.

transaction.details.loyalty_tier.name

string

required

User-defined name of the loyalty tier.

transaction.details.redemption

object

Contains information about the original redemption.

Show child attributes

transaction.details.redemption.id

string

required

Unique redemption ID.

transaction.details.rollback

object

Contains information about the redemption rollback.

Show child attributes

transaction.details.rollback.id

string

required

Unique identifier of the redemption rollback.

transaction.details.custom_event

object

Contains information about the custom event that triggers the point accrual.

Show child attributes

transaction.details.custom_event.id

string

required

Unique identifier of the event.

transaction.details.custom_event.type

string

required

Type of the custom event.

transaction.details.event_schema

object

Contains information about the custom event metadata schema.

Show child attributes

transaction.details.event_schema.id

string

required

Unique identifier of the metadata schema.

transaction.details.event_schema.name

string

required

Type of the custom event.

transaction.details.holder_loyalty_tier

object

Loyalty tier of the loyalty card holder at the moment when the transaction occurred. The loyalty tier is the tier in which the holder was before the loyalty point balance changed.

Show child attributes

transaction.details.holder_loyalty_tier.id

string

required

Unique identifier of the loyalty tier, assigned by Voucherify.

transaction.details.holder_loyalty_tier.name

string

required

User-defined name of the loyalty tier.

transaction.details.pending_points

Loyalty Pending Point Entry · object

Contains details about the pending point entry.

Show child attributes

transaction.details.pending_points.id

string

required

Unique identifier of the pending point entry, assigned by Voucherify.

Example:

"lopp_0ffd593d5ad207ba6b"

transaction.details.pending_points.voucher_id

string

required

Unique identifier of the loyalty card, assigned by Voucherify.

Example:

"v_abCdEfghI1JKLMNPqRS2Tu3vWXyza4bc"

transaction.details.pending_points.campaign_id

string

required

Unique campaign identifier, assigned by Voucherify.

Example:

"camp_weer1c3p5ZgktqfW56RfoNaG"

transaction.details.pending_points.customer_id

string

required

Unique customer identifier, assigned by Voucherify.

Example:

"cust_IdgAFZxYwwHctOk9ppZMu319"

transaction.details.pending_points.order_id

string

required

Unique order identifier, assigned by Voucherify.

Example:

"ord_0ffc0fa65f15d2df17"

transaction.details.pending_points.points

integer

required

Number of points in the pending state.

transaction.details.pending_points.activates_at

string<date>

required

Date when the pending points are activated and added to the customer's loyalty card.

transaction.details.pending_points.details

Pending Point Details · object

required

Details about how the pending points were earned.

Show child attributes

transaction.details.pending_points.details.event

object

required

Details about the event that created pending points.

Show child attributes

transaction.details.pending_points.details.event.id

string

Unique event identifier, assigned by Voucherify.

transaction.details.pending_points.details.event.type

enum<string>

Type of the event that triggered the creation of pending points.

Available options:

customer.order.paid

transaction.details.pending_points.details.event.group_id

string

Unique identifier of the request that triggered the event, assigned by Voucherify.

transaction.details.pending_points.details.event.entity_id

string

Unique identifier of the entity that triggered the event, assigned by Voucherify. For pending points, it is the customer_id of the customer who paid for the order.

transaction.details.pending_points.details.event.created_at

string<date-time>

Timestamp representing the date and time when the event occurred. The value is shown in the ISO 8601 format.

transaction.details.pending_points.details.event.category

enum<string>

Type of the event.

Available options:

ACTION,

EFFECT

transaction.details.pending_points.details.event.event_source

Event Source · object

Contains the source of the object that initiated the event.

Show child attributes

transaction.details.pending_points.details.event.event_source.channel

enum<string>

required

Determines the channel that initiated the event.

Available options:

USER_PORTAL,

API,

CLIENT_API,

INTERNAL

Example:

"API"

transaction.details.pending_points.details.event.event_source.user

object

Determines the Voucherify user who triggered the event.

Show child attributes

transaction.details.pending_points.details.event.event_source.user.id

string

required

Unique identifier of the user.

Example:

"user_xyzfghSTprSTUVWXYlk6tuvXYst7FGH7"

transaction.details.pending_points.details.event.event_source.api_key

object

Determines the API key used to initiate the event.

Show child attributes

transaction.details.pending_points.details.event.event_source.api_key.name

string

required

Channel name in the application keys.

transaction.details.pending_points.details.event.event_source.api_key.app_id

string

required

Contains the application ID from the Voucherify API key pair.

Example:

"1XXXX5XX-0XXX-XXXb-X7XX-XX2XXaXXX6XX"

transaction.details.pending_points.details.earning_rule

object

required

Contains information about the earning rule.

Show child attributes

transaction.details.pending_points.details.earning_rule.id

string

required

Unique identifier of an earning rule, assigned by Voucherify.

transaction.details.pending_points.details.earning_rule.source

object

required

Contains the custom earning rule name.

Show child attributes

transaction.details.pending_points.details.earning_rule.source.banner

string

required

Name of the earning rule. This is displayed as a header for the earning rule in the Dashboard.

transaction.details.pending_points.details.order

object

required

Details about the order that caused adding pending points.

Show child attributes

transaction.details.pending_points.details.order.id

string

required

Unique order identifier, assigned by Voucherify.

transaction.details.pending_points.details.order.source_id

string | null

required

User-defined order identifier.

transaction.details.pending_points.details.loyalty_tier

object

The loyalty tier that is mapped for the earning rule and used in the pending point transaction.

Show child attributes

transaction.details.pending_points.details.loyalty_tier.id

string

required

Unique identifier of the loyalty tier, assigned by Voucherify.

transaction.details.pending_points.details.loyalty_tier.name

string

required

User-defined name of the loyalty tier.

transaction.details.pending_points.details.holder_loyalty_tier

object

Loyalty tier of the loyalty card holder at the moment when the transaction occurred. The loyalty tier is the tier in which the holder was at the moment pending points were created.

Show child attributes

transaction.details.pending_points.details.holder_loyalty_tier.id

string

required

Unique identifier of the loyalty tier, assigned by Voucherify.

transaction.details.pending_points.details.holder_loyalty_tier.name

string

required

User-defined name of the loyalty tier.

transaction.details.pending_points.created_at

string<date-time>

required

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

transaction.details.pending_points.updated_at

string<date-time>

Timestamp representing the date and time when the pending point entry was modified. The value is shown in the ISO 8601 format.

transaction.details.reward

object

Contains information about the pay with points reward.

Show child attributes

transaction.details.reward.id

string

required

Unique reward ID.

transaction.details.reward.name

string

required

Reward name.

transaction.details.source_voucher

Simple Voucher · object

Contains information on how the balance on the donor loyalty card was affected by the transaction.

Show child attributes

transaction.details.source_voucher.code

string

required

Voucher code.

transaction.details.source_voucher.type

enum<string>

required

Type of the voucher.

Available options:

DISCOUNT_VOUCHER,

LOYALTY_CARD,

GIFT_VOUCHER

transaction.details.source_voucher.created_at

string<date-time>

required

Timestamp representing the date and time when the order was created in the ISO 8601 format.

Example:

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

transaction.details.source_voucher.object

enum<string>

default:voucher

required

The type of the object represented by JSON.

Available options:

voucher

transaction.details.source_voucher.id

string

A unique identifier that represents the voucher assigned by Voucherify.

transaction.details.source_voucher.gift

Gift · object

Gift object response.

Show child attributes

transaction.details.source_voucher.gift.amount

number

required

Total gift card income over the lifetime of the card. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $10 amount is written as 1000.

transaction.details.source_voucher.gift.balance

number

required

Available funds. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $10 amount is written as 1000.

transaction.details.source_voucher.gift.effect

enum<string>

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

Available options:

APPLY_TO_ORDER,

APPLY_TO_ITEMS

transaction.details.source_voucher.discount

Discount · object

Contains information about discount.

Discount
Discount
Discount
Discount
Discount

Show child attributes

transaction.details.source_voucher.discount.type

enum<string>

default:AMOUNT

required

Defines the type of the voucher.

Available options:

AMOUNT

transaction.details.source_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.

transaction.details.source_voucher.discount.amount_off_formula

string

transaction.details.source_voucher.discount.aggregated_amount_limit

integer

Maximum discount amount per order.

transaction.details.source_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

transaction.details.source_voucher.discount.is_dynamic

boolean

Flag indicating whether the discount was calculated using a formula.

transaction.details.source_voucher.loyalty_card

Simple Loyalty Card · object

Defines the loyalty card details. Simplified loyalty card data.

Show child attributes

transaction.details.source_voucher.loyalty_card.points

integer

required

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

transaction.details.source_voucher.loyalty_card.balance

integer

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

transaction.details.source_voucher.loyalty_card.next_expiration_date

string

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

transaction.details.source_voucher.loyalty_card.next_expiration_points

integer

The amount of points that are set to expire next.

transaction.details.source_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.

transaction.details.source_voucher.loyalty_card.expired_points

integer

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

transaction.details.source_voucher.loyalty_card.subtracted_points

integer

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

transaction.details.source_voucher.campaign

string

Campaign name.

transaction.details.source_voucher.campaign_id

string

Campaign unique ID.

transaction.details.source_voucher.is_referral_code

boolean

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

transaction.details.source_voucher.holder_id

string

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

Example:

"cust_eWgXlBBiY6THFRJwX45Iakv4"

transaction.details.source_voucher.referrer_id

string

Unique identifier of the referrer assigned by Voucherify.

Example:

"cust_nM4jqPiaXUvQdVSA6vTRUnix"

transaction.details.source_voucher.category_id

string | null

Unique identifier of the category that this voucher belongs to.

Example:

"cat_0b6152ce12414820dc"

transaction.details.source_voucher.categories

Category · object[]

Contains details about the category.

Show child attributes

transaction.details.source_voucher.categories.id

string

required

Unique category ID assigned by Voucherify.

transaction.details.source_voucher.categories.name

string

required

Category name.

transaction.details.source_voucher.categories.hierarchy

integer

required

Category hierarchy.

transaction.details.source_voucher.categories.created_at

string<date-time>

required

Timestamp representing the date and time when the category was created in the ISO 8601 format.

Example:

"2024-01-01T11:11:11.111Z"

transaction.details.source_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

transaction.details.source_voucher.categories.updated_at

string<date-time>

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

Example:

"2024-01-01T11:11:11.111Z"

transaction.details.source_voucher.categories.stacking_rules_type

enum<string>

The type of the stacking rule eligibility.

Available options:

JOINT,

EXCLUSIVE

transaction.details.source_voucher.active

boolean

Shows whether the voucher is on or off. true indicates an active voucher and false indicates an inactive voucher.

transaction.details.source_voucher.updated_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:

"2024-01-01T11:11:11.111Z"

transaction.details.source_voucher.redemption

object

Defines the redemption limits on vouchers.

Show child attributes

transaction.details.source_voucher.redemption.quantity

integer | null

required

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

transaction.details.source_voucher.redemption.redeemed_quantity

integer

required

How many times a voucher has already been redeemed.

Example:

1

transaction.details.source_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"

transaction.details.source_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"

transaction.details.source_voucher.metadata

object

A set of custom key/value pairs that you can attach to a voucher. The metadata object stores all custom attributes assigned to the voucher.

transaction.details.destination_voucher

Simple Voucher · object

Contains information on how the balance on the receiving loyalty card was affected by the transaction.

Show child attributes

transaction.details.destination_voucher.code

string

required

Voucher code.

transaction.details.destination_voucher.type

enum<string>

required

Type of the voucher.

Available options:

DISCOUNT_VOUCHER,

LOYALTY_CARD,

GIFT_VOUCHER

transaction.details.destination_voucher.created_at

string<date-time>

required

Timestamp representing the date and time when the order was created in the ISO 8601 format.

Example:

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

transaction.details.destination_voucher.object

enum<string>

default:voucher

required

The type of the object represented by JSON.

Available options:

voucher

transaction.details.destination_voucher.id

string

A unique identifier that represents the voucher assigned by Voucherify.

transaction.details.destination_voucher.gift

Gift · object

Gift object response.

Show child attributes

transaction.details.destination_voucher.gift.amount

number

required

Total gift card income over the lifetime of the card. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $10 amount is written as 1000.

transaction.details.destination_voucher.gift.balance

number

required

Available funds. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $10 amount is written as 1000.

transaction.details.destination_voucher.gift.effect

enum<string>

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

Available options:

APPLY_TO_ORDER,

APPLY_TO_ITEMS

transaction.details.destination_voucher.discount

Discount · object

Contains information about discount.

Discount
Discount
Discount
Discount
Discount

Show child attributes

transaction.details.destination_voucher.discount.type

enum<string>

default:AMOUNT

required

Defines the type of the voucher.

Available options:

AMOUNT

transaction.details.destination_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.

transaction.details.destination_voucher.discount.amount_off_formula

string

transaction.details.destination_voucher.discount.aggregated_amount_limit

integer

Maximum discount amount per order.

transaction.details.destination_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

transaction.details.destination_voucher.discount.is_dynamic

boolean

Flag indicating whether the discount was calculated using a formula.

transaction.details.destination_voucher.loyalty_card

Simple Loyalty Card · object

Defines the loyalty card details. Simplified loyalty card data.

Show child attributes

transaction.details.destination_voucher.loyalty_card.points

integer

required

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

transaction.details.destination_voucher.loyalty_card.balance

integer

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

transaction.details.destination_voucher.loyalty_card.next_expiration_date

string

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

transaction.details.destination_voucher.loyalty_card.next_expiration_points

integer

The amount of points that are set to expire next.

transaction.details.destination_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.

transaction.details.destination_voucher.loyalty_card.expired_points

integer

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

transaction.details.destination_voucher.loyalty_card.subtracted_points

integer

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

transaction.details.destination_voucher.campaign

string

Campaign name.

transaction.details.destination_voucher.campaign_id

string

Campaign unique ID.

transaction.details.destination_voucher.is_referral_code

boolean

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

transaction.details.destination_voucher.holder_id

string

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

Example:

"cust_eWgXlBBiY6THFRJwX45Iakv4"

transaction.details.destination_voucher.referrer_id

string

Unique identifier of the referrer assigned by Voucherify.

Example:

"cust_nM4jqPiaXUvQdVSA6vTRUnix"

transaction.details.destination_voucher.category_id

string | null

Unique identifier of the category that this voucher belongs to.

Example:

"cat_0b6152ce12414820dc"

transaction.details.destination_voucher.categories

Category · object[]

Contains details about the category.

Show child attributes

transaction.details.destination_voucher.categories.id

string

required

Unique category ID assigned by Voucherify.

transaction.details.destination_voucher.categories.name

string

required

Category name.

transaction.details.destination_voucher.categories.hierarchy

integer

required

Category hierarchy.

transaction.details.destination_voucher.categories.created_at

string<date-time>

required

Timestamp representing the date and time when the category was created in the ISO 8601 format.

Example:

"2024-01-01T11:11:11.111Z"

transaction.details.destination_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

transaction.details.destination_voucher.categories.updated_at

string<date-time>

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

Example:

"2024-01-01T11:11:11.111Z"

transaction.details.destination_voucher.categories.stacking_rules_type

enum<string>

The type of the stacking rule eligibility.

Available options:

JOINT,

EXCLUSIVE

transaction.details.destination_voucher.active

boolean

Shows whether the voucher is on or off. true indicates an active voucher and false indicates an inactive voucher.

transaction.details.destination_voucher.updated_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:

"2024-01-01T11:11:11.111Z"

transaction.details.destination_voucher.redemption

object

Defines the redemption limits on vouchers.

Show child attributes

transaction.details.destination_voucher.redemption.quantity

integer | null

required

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

transaction.details.destination_voucher.redemption.redeemed_quantity

integer

required

How many times a voucher has already been redeemed.

Example:

1

transaction.details.destination_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"

transaction.details.destination_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"

transaction.details.destination_voucher.metadata

object

A set of custom key/value pairs that you can attach to a voucher. The metadata object stores all custom attributes assigned to the voucher.

The related identifier of the transaction on the receiving card.

transaction.created_at

string<date-time>

required

Timestamp representing the date and time when the transaction was created in ISO 8601 format.

pending_points

Loyalty Pending Point Entry · object

required

Contains details about the pending point entry.

Show child attributes

pending_points.id

string

required

Unique identifier of the pending point entry, assigned by Voucherify.

Example:

"lopp_0ffd593d5ad207ba6b"

pending_points.voucher_id

string

required

Unique identifier of the loyalty card, assigned by Voucherify.

Example:

"v_abCdEfghI1JKLMNPqRS2Tu3vWXyza4bc"

pending_points.campaign_id

string

required

Unique campaign identifier, assigned by Voucherify.

Example:

"camp_weer1c3p5ZgktqfW56RfoNaG"

pending_points.customer_id

string

required

Unique customer identifier, assigned by Voucherify.

Example:

"cust_IdgAFZxYwwHctOk9ppZMu319"

pending_points.order_id

string

required

Unique order identifier, assigned by Voucherify.

Example:

"ord_0ffc0fa65f15d2df17"

pending_points.points

integer

required

Number of points in the pending state.

pending_points.activates_at

string<date>

required

Date when the pending points are activated and added to the customer's loyalty card.

pending_points.details

Pending Point Details · object

required

Details about how the pending points were earned.

Show child attributes

pending_points.details.event

object

required

Details about the event that created pending points.

Show child attributes

pending_points.details.event.id

string

Unique event identifier, assigned by Voucherify.

pending_points.details.event.type

enum<string>

Type of the event that triggered the creation of pending points.

Available options:

customer.order.paid

pending_points.details.event.group_id

string

Unique identifier of the request that triggered the event, assigned by Voucherify.

pending_points.details.event.entity_id

string

Unique identifier of the entity that triggered the event, assigned by Voucherify. For pending points, it is the customer_id of the customer who paid for the order.

pending_points.details.event.created_at

string<date-time>

Timestamp representing the date and time when the event occurred. The value is shown in the ISO 8601 format.

pending_points.details.event.category

enum<string>

Type of the event.

Available options:

ACTION,

EFFECT

pending_points.details.event.event_source

Event Source · object

Contains the source of the object that initiated the event.

Show child attributes

pending_points.details.event.event_source.channel

enum<string>

required

Determines the channel that initiated the event.

Available options:

USER_PORTAL,

API,

CLIENT_API,

INTERNAL

Example:

"API"

pending_points.details.event.event_source.user

object

Determines the Voucherify user who triggered the event.

Show child attributes

pending_points.details.event.event_source.user.id

string

required

Unique identifier of the user.

Example:

"user_xyzfghSTprSTUVWXYlk6tuvXYst7FGH7"

pending_points.details.event.event_source.api_key

object

Determines the API key used to initiate the event.

Show child attributes

pending_points.details.event.event_source.api_key.name

string

required

Channel name in the application keys.

pending_points.details.event.event_source.api_key.app_id

string

required

Contains the application ID from the Voucherify API key pair.

Example:

"1XXXX5XX-0XXX-XXXb-X7XX-XX2XXaXXX6XX"

pending_points.details.earning_rule

object

required

Contains information about the earning rule.

Show child attributes

pending_points.details.earning_rule.id

string

required

Unique identifier of an earning rule, assigned by Voucherify.

pending_points.details.earning_rule.source

object

required

Contains the custom earning rule name.

Show child attributes

pending_points.details.earning_rule.source.banner

string

required

Name of the earning rule. This is displayed as a header for the earning rule in the Dashboard.

pending_points.details.order

object

required

Details about the order that caused adding pending points.

Show child attributes

pending_points.details.order.id

string

required

Unique order identifier, assigned by Voucherify.

pending_points.details.order.source_id

string | null

required

User-defined order identifier.

pending_points.details.loyalty_tier

object

The loyalty tier that is mapped for the earning rule and used in the pending point transaction.

Show child attributes

pending_points.details.loyalty_tier.id

string

required

Unique identifier of the loyalty tier, assigned by Voucherify.

pending_points.details.loyalty_tier.name

string

required

User-defined name of the loyalty tier.

pending_points.details.holder_loyalty_tier

object

Loyalty tier of the loyalty card holder at the moment when the transaction occurred. The loyalty tier is the tier in which the holder was at the moment pending points were created.

Show child attributes

pending_points.details.holder_loyalty_tier.id

string

required

Unique identifier of the loyalty tier, assigned by Voucherify.

pending_points.details.holder_loyalty_tier.name

string

required

User-defined name of the loyalty tier.

pending_points.created_at

string<date-time>

required

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

pending_points.updated_at

string<date-time>

Timestamp representing the date and time when the pending point entry was modified. The value is shown in the ISO 8601 format.

Response

Webhook accepted

Introduction

Endpoints

Events

Voucher Loyalty Card Pending Points Activated

Body

Response