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

voucherRedemption object required

Represents the redemption of the voucher.

Show definition
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-_]*$
customerId string optional

The unique identifier of the customer. If your system allows anonymous checkout then we recommend making this the customer's email address.

customer object optional
Show definition
Authorization: token ...
Content-Type: application/json

  "timestamp": 1512828988826,
  "customerId": "abc-123-ZYZ",
  "voucherRedemption": {
    "paymentMethodId": "VOUCH-89-abc-123-ZYZ",
    "voucherCode": "VOUCH-89",
    "redemptionTime": 1512828988826,
    "success": true,
    "value": 10000,
    "currency": "GBP",
    "voucherType": "GENERAL"