Succeeded

post https://example.com/EVENTS.REDEMPTION.SUCCEEDED

EVENT: "EVENTS.REDEMPTION.SUCCEEDED"
HTTP method: POST

The EVENTS.REDEMPTION.SUCCEEDED event indicates that the redemption process was successful. It confirms that the associated voucher codes and promotional tiers have been effectively applied.

This event is used in a webhook configured in Project settings in Voucherify dashboard.

📘
Webhook documentation
This page documents only the event. If you need more details about the webhook payload data that includes this event, go to Webhook v2024-01-01 page.

Example: redemption.succeeded

{
  "customer": {
    "id": "cust_1g637SqVZnkdPNdAIZ7Ra879",
    "name": "Jane Doe",
    "email": "jane@jane.io",
    "source_id": "test_customer_id_2",
    "metadata": {
      "lang": "en",
      "test": true,
      "region": "EMEA"
    },
    "object": "customer"
  },
  "order": {
    "id": "ord_3VYCHwdV0YOOch2nm1RsTKNI",
    "source_id": null,
    "status": "PAID",
    "customer_id": "cust_1g637SqVZnkdPNdAIZ7Ra879",
    "referrer_id": null,
    "amount": 7000,
    "items_discount_amount": 1000,
    "items_applied_discount_amount": 1000,
    "total_discount_amount": 1000,
    "total_applied_discount_amount": 1000,
    "total_amount": 6000,
    "items": [
      {
        "object": "order_item",
        "source_id": "adv-mug",
        "related_object": "product",
        "quantity": 2,
        "discount_quantity": 1,
        "amount": 2000,
        "discount_amount": 1000,
        "applied_discount_amount": 1000,
        "price": 1000,
        "subtotal_amount": 1000
      },
      {
        "object": "order_item",
        "source_id": "star-th-bottle",
        "related_object": "product",
        "quantity": 2,
        "amount": 5000,
        "price": 2500,
        "subtotal_amount": 5000
      }
    ],
    "metadata": {},
    "created_at": "2024-01-15T12:20:38.596843Z",
    "object": "order"
  },
  "campaign": {
    "id": "camp_kwMyXFKquedx8FzXNpVPN7QU",
    "name": "Always add missing products",
    "campaign_type": "DISCOUNT_COUPONS",
    "type": "AUTO_UPDATE",
    "is_referral_code": false,
    "voucher": {
      "type": "DISCOUNT_VOUCHER",
      "discount": {
        "type": "UNIT",
        "units": null,
        "effect": "ADD_NEW_ITEMS",
        "unit_off": 1,
        "unit_type": "prod_0df14b3a6ad8f282a8"
      },
      "redemption": {
        "quantity": null,
        "redeemed_quantity": 0
      },
      "code_config": {
        "length": 1,
        "prefix": "Always-add-prods-",
        "charset": "0123456789",
        "pattern": "#",
        "postfix": ""
      }
    },
    "auto_join": false,
    "join_once": false,
    "active": true,
    "category_id": null,
    "created_at": "2023-12-08T13:54:29.003375Z",
    "updated_at": "2023-12-15T11:07:05.173502Z",
    "object": "campaign"
  },
  "voucher": {
    "id": "v_VZgTRbJvauZR7Ub7exOtAg0MqxXljPpA",
    "code": "Always-add-prods-5",
    "discount": {
      "type": "UNIT",
      "unit_off": 1,
      "unit_type": "prod_0df14b3a6ad8f282a8",
      "effect": "ADD_NEW_ITEMS"
    },
    "type": "DISCOUNT_VOUCHER",
    "campaign": "Always add missing products",
    "campaign_id": "camp_kwMyXFKquedx8FzXNpVPN7QU",
    "is_referral_code": false,
    "category_id": null,
    "active": true,
    "created_at": "2023-12-08T14:01:18.213000Z",
    "updated_at": "2024-01-15T12:20:38.624905Z",
    "object": "voucher"
  },
  "holder": null,
  "promotion_tier": null,
  "redemption": {
    "id": "r_0e2500291ae016adea",
    "customer_id": "cust_1g637SqVZnkdPNdAIZ7Ra879",
    "tracking_id": "track_Pw6r3ejnml43kIwNS4Zj09KZ67xOfLUy",
    "date": "2024-01-15T12:20:38.635000Z",
    "order": {
      "id": "ord_3VYCHwdV0YOOch2nm1RsTKNI",
      "source_id": null,
      "status": "PAID",
      "customer_id": "cust_1g637SqVZnkdPNdAIZ7Ra879",
      "referrer_id": null,
      "amount": 7000,
      "items_discount_amount": 1000,
      "items_applied_discount_amount": 1000,
      "total_discount_amount": 1000,
      "total_applied_discount_amount": 1000,
      "total_amount": 6000,
      "items": [
        {
          "object": "order_item",
          "source_id": "adv-mug",
          "related_object": "product",
          "quantity": 2,
          "discount_quantity": 1,
          "amount": 2000,
          "discount_amount": 1000,
          "applied_discount_amount": 1000,
          "price": 1000,
          "subtotal_amount": 1000
        },
        {
          "object": "order_item",
          "source_id": "star-th-bottle",
          "related_object": "product",
          "quantity": 2,
          "amount": 5000,
          "price": 2500,
          "subtotal_amount": 5000
        }
      ],
      "metadata": {},
      "created_at": "2024-01-15T12:20:38.596843Z",
      "object": "order"
    },
    "customer": {
      "id": "cust_1g637SqVZnkdPNdAIZ7Ra879",
      "name": "Jane Doe",
      "email": "jane@jane.io",
      "source_id": "test_customer_id_2",
      "metadata": {
        "lang": "en",
        "test": true,
        "region": "EMEA"
      },
      "object": "customer"
    },
    "result": "SUCCESS",
    "status": "SUCCEEDED",
    "voucher": {
      "id": "v_VZgTRbJvauZR7Ub7exOtAg0MqxXljPpA",
      "code": "Always-add-prods-5",
      "discount": {
        "type": "UNIT",
        "unit_off": 1,
        "unit_type": "prod_0df14b3a6ad8f282a8",
        "effect": "ADD_NEW_ITEMS"
      },
      "type": "DISCOUNT_VOUCHER",
      "campaign": "Always add missing products",
      "campaign_id": "camp_kwMyXFKquedx8FzXNpVPN7QU",
      "is_referral_code": false,
      "category_id": null,
      "active": true,
      "created_at": "2023-12-08T14:01:18.213000Z",
      "updated_at": "2024-01-15T12:20:38.624905Z",
      "object": "voucher"
    },
    "metadata": {},
    "object": "redemption"
  },
  "created_at": "2024-01-15T12:20:38.636Z"
}

Response

Response body

object

customer

object | null

Simplified customer data.

string

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

name

string

Customer's first and last name.

string

Customer's email address.

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.

metadata

object

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

Has additional fields

object

string

The type of the object represented by JSON.

customer

order

object | null

Order information.

string

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

source_id

string

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

status

string

The order status.

CREATED PAID CANCELED FULFILLED

customer_id

string | null

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

referrer_id

string | null

Unique identifier of the referrer assigned by Voucherify.

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.

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

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

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

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)

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

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

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

items

array of objects

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

items

object

string

Defaults to order_item

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

order_item

source_id

string

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

related_object

string

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

product sku

product_id

string

A unique product ID assigned by Voucherify.

sku_id

string

A unique SKU ID assigned by Voucherify.

quantity

integer

The quantity of the particular item in the cart.

discount_quantity

integer

Number of dicounted items.

amount

integer

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

discount_amount

integer

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

applied_discount_amount

integer

The order-level discount applied.

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.

subtotal_amount

integer

Final order amount after the applied discount.

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.

Has additional fields

object

string

required

Defaults to order

The type of the object represented by JSON.

order

campaign

object | null

Simplified campaign data.

string

Campaign ID.

name

string

Campaign name.

campaign_type

string

Type of campaign.

type

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

AUTO_UPDATE STATIC STANDALONE

is_referral_code

boolean

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

voucher

object

Simplified campaign voucher data.

referral_program

object

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

auto_join

boolean

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

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.

active

boolean

Indicates whether the campaign is active.

category_id

string | null

The unique category ID that this campaign belongs to.

categories

array of objects

Contains details about the category.

categories

object

string

required

Unique category ID assigned by Voucherify.

name

string

required

Category name.

hierarchy

integer

required

Category hierarchy.

created_at

date-time

required

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

updated_at

date-time

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

object

string

required

Defaults to category

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

category

stacking_rules_type

string

The type of the stacking rule eligibility.

JOINT EXCLUSIVE

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.

Has additional fields

start_date

date-time

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

expiration_date

date-time

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

description

string

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

created_at

date-time

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

updated_at

date-time

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

object

string

Defaults to campaign

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

campaign

voucher

object | null

Simplified voucher data.

string

A unique identifier that represents the voucher assigned by Voucherify.

code

string

required

Voucher code.

gift

object

Contains current gift card balance information.

discount

object

Contains information about discount.

loyalty_card

object

Simplified loyalty card data.

type

string

required

Type of the voucher.

DISCOUNT_VOUCHER LOYALTY_CARD GIFT_VOUCHER

campaign

string

Campaign name.

campaign_id

string

Campaign unique ID.

is_referral_code

boolean

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

holder_id

string

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

referrer_id

string

Unique identifier of the referrer assigned by Voucherify.

category_id

string | null

Unique identifier of the category that this voucher belongs to.

categories

array of objects

Contains details about the category.

categories

object

string

required

Unique category ID assigned by Voucherify.

name

string

required

Category name.

hierarchy

integer

required

Category hierarchy.

created_at

date-time

required

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

updated_at

date-time

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

object

string

required

Defaults to category

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

category

stacking_rules_type

string

The type of the stacking rule eligibility.

JOINT EXCLUSIVE

active

boolean

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

created_at

date-time

required

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

updated_at

date-time

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

redemption

object

Defines the redemption limits on vouchers.

start_date

date-time

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

expiration_date

date-time

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

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.

Has additional fields

object

string

required

Defaults to voucher

The type of the object represented by JSON.

voucher

holder

object | null

Details about the redeemable holder.

string

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

name

string

Customer's first and last name.

string

Customer's email address.

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.

metadata

object

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

Has additional fields

object

string

The type of the object represented by JSON.

customer

promotion_tier

object | null

Simplified promotion tier data.

string

Unique promotion tier ID.

name

string

Name of the promotion tier.

banner

string | null

Text to be displayed to your customers on your website.

campaign

object

Simplified promotion tier campaign data.

metadata

object

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

Has additional fields

promotion_stack

object | null

Simplified promotion stack data.

string

Unique identifier of the promotion stack.

name

string

Name of the promotion stack.

category_id

string

Unique identifier of the category of the promotion stack.

campaign

object

Represents simplified promotion stack campaign data.

tiers

object

Contains the tier configuration.

redemption

object | null

Simplified redemption data.

string

required

Unique redemption ID.

customer_id

string | null

Unique customer ID of the redeeming customer.

tracking_id

string

Hashed customer source ID.

date

date-time

required

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

amount

integer

For gift cards, this is a positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the number of redeemed credits.
For loyalty cards, this is the number of loyalty points used in the transaction.
In the case of redemption rollback, the numbers are expressed as negative integers.

order

object

Order information.

reward

object

Simplified redemption reward result data

customer

object

Simplified customer data.

result

string

Redemption result.

SUCCESS FAILURE

status

string | null

required

SUCCEEDED FAILED ROLLED BACK

voucher

object

Simplified voucher data.

promotion_tier

object

Simplified promotion tier data.

redemption

string

Unique redemption ID of the parent redemption.

metadata

object

required

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

Has additional fields

failure_code

string

If the result is FAILURE, this parameter will provide a generic reason as to why the redemption failed.

failure_message

string

If the result is FAILURE, this parameter will provide an expanded reason as to why the redemption failed.

reason

string

The reason for the redemption rollback.

channel

object

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

object

string

required

Defaults to redemption

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

created_at

date-time

Timestamp representing the date and time when the redemption succeeded in the ISO 8601 format.

Language


     --url https://example.com/EVENTS.REDEMPTION.SUCCEEDED \

Click Try It! to start a request and see the response here! Or choose an example:

application/json

EVENT: "EVENTS.REDEMPTION.SUCCEEDED"HTTP method: POST

📘Webhook documentation

Example: redemption.succeeded

200Indicates that a redemption has succeeded.

EVENT: "EVENTS.REDEMPTION.SUCCEEDED"
HTTP method: POST

📘
Webhook documentation