VOvoucherifyio
Client-side

Validate Stackable Discounts (client-side)

Verify redeemables provided in the request. This method is accessible through public keys which you can use in client side requests coming from mobile and web browser applications.

post/client/v1/validations

Request

  • Base URL
    https://api.voucherify.io
  • URL
    https://api.voucherify.io/client/v1/validations
  • Auth
    • API key in header X-Client-Application-Id and API key in header X-Client-Token
    • or OAuth 2
      Implicit: https://api.voucherify.io/v1/oauth/token
      Scopes: client_api, client_validations

Headers

originstring hostname required

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

Request body

tracking_idstring

Is correspondent to Customer's source_id

metadataobject

A set of key/value pairs that you can attach to a redemption object. It can be useful for storing additional information about the redemption in a structured format.

Example request

{
  "redeemables": [
    {
      "reward": {
        "id": "rew_EPx1hCTpqzF0HW1z9NKckZH4"
      }
    }
  ]
}

Response

Depending on your project settings: all redeemables must be valid or just one must be valid to result as valid validation. Read more in the Stacking Rule Documentation.

idstring

Unique identifier of the validation, assigned by Voucherify.

validboolean required

The result of the validation. It takes all of the redeemables into account and returns a false if at least one redeemable is inapplicable. Returns true if all redeemables are applicable.

tracking_idstring

Hashed customer source ID.

Changes

No recorded changes to this operation across all 1 revision of this API.