curl --request POST \
  --url https://{cluster}.voucherify.io/v1/vouchers/{code}/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>' \
  --data '{
  "customer": {
    "id": "cust_4vMj8Twr5nBzvTrNCgipMb6M"
  },
  "order": {
    "items": [
      {
        "product_id": "prod_0ba621bae5d39762ce",
        "quantity": "1"
      },
      {
        "product_id": "prod_0b661d404787ec6d3b",
        "quantity": "1",
        "price": 3100
      }
    ]
  }
}'

{
  "valid": false,
  "reason": "redemption does not match validation rules",
  "error": {
    "code": 400,
    "key": "redemption_rules_violated",
    "message": "redemption does not match validation rules",
    "details": "Gift Card cannot be redeemed because of violated validation rules: val_wvipKm99CJuL",
    "request_id": "v-0bccef7a9585cf63b6"
  },
  "tracking_id": "track_ZGPtmYcM+Mw=",
  "code": "vBQvYFEM",
  "metadata": {}
}

Validate Voucher

deprecated

❗️ Deprecated

This endpoint represents the deprecated version of the API responsible for voucher validation, and we do not recommend using it. The new Stackable Discounts API introduces additional features and improvements while maintaining backward compatibility, including applying a combination of coupon codes and promotion tiers. Developers are encouraged to migrate to the latest version to take advantage of the latest enhancements and bug fixes. No updates will be provided to the deprecated endpoint.

To verify a voucher code given by a customer, you can use this method. It is designed for a server side integration, which means that is accessible only through private keys.

❗️ Important

This endpoint supports the validation of a single promo code. If you need to validate more than one incentive, you can use the Stackable discounts API. The stacking discounts API lets you validate up to 30 incentives per call. Before integrating Voucherify, choose which validation endpoint you prefer to use.

Gift Vouchers - validate Gift Card and control amount to redeem

Voucherify also gives the possibility to create a gift card, which allows using credits to fulfill the order. A user can specify how many credits he wants to use from the gift card. The available balance of credits is counted based on policy rules attached to the Gift Voucher definition.

This operation returns information about the validity of the code. Moreover, it returns a hashed source identifier which can be used as a tracking ID in future calls.

If a validation session is established, then the session details will be returned as well. Read more about sessions here.

Voucher validation might fail because of one of these reasons:

voucher not found - voucher doesn’t exist or was deleted
voucher expired - voucher is out of start date - expiration date time frame
voucher is disabled - learn more about a disabled voucher
customer does not match segment rules - learn more customer tracking
order does not match validation rules - learn more about validation rules

POST

vouchers

{code}

validate

curl --request POST \
  --url https://{cluster}.voucherify.io/v1/vouchers/{code}/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>' \
  --data '{
  "customer": {
    "id": "cust_4vMj8Twr5nBzvTrNCgipMb6M"
  },
  "order": {
    "items": [
      {
        "product_id": "prod_0ba621bae5d39762ce",
        "quantity": "1"
      },
      {
        "product_id": "prod_0b661d404787ec6d3b",
        "quantity": "1",
        "price": 3100
      }
    ]
  }
}'

{
  "valid": false,
  "reason": "redemption does not match validation rules",
  "error": {
    "code": 400,
    "key": "redemption_rules_violated",
    "message": "redemption does not match validation rules",
    "details": "Gift Card cannot be redeemed because of violated validation rules: val_wvipKm99CJuL",
    "request_id": "v-0bccef7a9585cf63b6"
  },
  "tracking_id": "track_ZGPtmYcM+Mw=",
  "code": "vBQvYFEM",
  "metadata": {}
}

Authorizations

X-App-Id

string

header

required

X-App-Token

string

header

required

Authorization

string

header

required

Path Parameters

code

string

required

Example:

Body

application/json

Vouchers Validate Discount Request Body
Vouchers Validate Gift Request Body
Vouchers Validate Loyalty Request Body

customer

object

Show child attributes

order

object

Show child attributes

session

object

Show child attributes

tracking_id

string

metadata

object

options

object

Show child attributes

Response

Vouchers Validate Valid Response Body
Vouchers Validate Invalid Response Body

valid

boolean

default:true

required

code

string

required

applicable_to

object

required

Show child attributes

inapplicable_to

object

required

Show child attributes

metadata

object

required

tracking_id

string

required

campaign

string

campaign_id

string

discount

object

Amount
Unit
Unit Multiple
Percent
Fixed

Show child attributes

gift

object

Show child attributes

loyalty

object

Show child attributes

reward

object

Show child attributes

order

object

Show child attributes

session

object

Show child attributes

start_date

string

expiration_date

string

Validate Stackable Discounts Validate Promotions

⌘I

Introduction

Endpoints

Events

Validate Voucher

Gift Vouchers - validate Gift Card and control amount to redeem

Authorizations

Path Parameters

Body

Response