Merchants > API Reference > Endpoints > Voucher

Voucher

Voucher abuse recommendations need to be enabled on your account before they can be used. Please speak to your account manager about enabling voucher abuse recommendations.

Field Status Definitions

Required Required fields must be sent. If the data is not sent Ravelin will return an error.

Important Important fields are crucial for performance where that data is relevant for your business.

Optional Optional fields are additional data points that can be shared with Ravelin.
These fields are unlikely to impact performance but may be visible in the Ravelin dashboard.

POST api.ravelin.com/v2/voucher

Show all

timestamp integer required

The time at which this data payload was valid. When sending events in realtime, this will usually be 'now'. This is used to merge data that arrives out-of-order.

A Unix timestamp preferably as an integer count of milliseconds since 1970-01-01T00:00 UTC (nanoseconds are also accepted).

voucher object required

A voucher is added whenever a new voucher code is created.

Show definition

voucherCode string required

A unique identifier for the voucher, usually the code a customer enters to redeem the voucher.

value integer required

The value of the voucher.

currency string required

The ISO 4217 currency code

Pattern: ^[a-zA-Z]{3}$

creationTime integer required

The time the voucher was created.

A Unix timestamp preferably as an integer count of milliseconds since 1970-01-01T00:00 UTC (nanoseconds are also accepted).

referrerId string optional

The customerId of the customer who created this voucher.

expiry integer optional

The time after which the voucher can no longer be redeemed.

A Unix timestamp preferably as an integer count of milliseconds since 1970-01-01T00:00 UTC (nanoseconds are also accepted).

referralValue integer optional

The amount the owner of the voucher gets when the voucher is used.

voucherType string optional

The type of voucher.

One of: REFERRAL, REACTIVATION, GENERAL, or STAFF.

custom object optional

Custom data that is relevant to your domain. This can be any json object. Please include any details that you think are relevant to fraud that our schema does not capture.

eventType string optional

An eventType should identify what event in your system triggered this API call.

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_]*$

POST https://api.ravelin.com/v2/voucher HTTP/1.1
Authorization: token ...
Content-Type: application/json

{
    "timestamp": 1512828988826,
    "voucher": {
        "voucherCode": "DISCOUNT-1234",
        "referrerId": "USER-1234",
        "expiry": 1512828988826,
        "value": 20,
        "currency": "GBP",
        "voucherType": "GENERAL",
        "referralValue": 10,
        "creationTime": 1512828988826
    }
}

Response

status integer	The HTTP response status code.
timestamp integer	A unix timestamp indicating when we finished handling the request.

{
  "status": 200,
  "timestamp": 1512828988
}

Feedback

Was this page helpful?