Skip to main content
POST
/
EVENTS.REDEMPTION.ROLLBACK.SUCCEEDED
{
  "order": {
    "id": "ord_OPBS4bwowjzQ3odiMNk09WPL",
    "items": [],
    "object": "order",
    "status": "CANCELED",
    "metadata": {},
    "source_id": null,
    "created_at": "2024-02-01T08:45:31.967Z",
    "updated_at": "2024-02-01T10:23:52.507Z",
    "customer_id": "cust_IdgAFZxYwwHctOk9pPuMu308",
    "referrer_id": null
  },
  "holder": null,
  "voucher": {
    "id": "v_7JItZDjNzMjqSw0BZoxNEMBfdHHB9EHf",
    "code": "Refer-gift-90873378",
    "type": "DISCOUNT_VOUCHER",
    "active": true,
    "object": "voucher",
    "campaign": "Refer-gift",
    "discount": {
      "type": "AMOUNT",
      "amount_off": 0
    },
    "created_at": "2024-02-01T08:44:37.539Z",
    "redemption": {
      "quantity": null,
      "redeemed_quantity": 0
    },
    "updated_at": "2024-02-01T10:23:52.490Z",
    "campaign_id": "camp_QULf1Wzu4yvT3cJ3IzFp76nY",
    "category_id": null,
    "is_referral_code": true
  },
  "campaign": {
    "id": "camp_QULf1Wzu4yvT3cJ3IzFp76nY",
    "name": "Refer-gift",
    "type": "AUTO_UPDATE",
    "active": true,
    "object": "campaign",
    "voucher": {
      "gift": null,
      "type": "DISCOUNT_VOUCHER",
      "discount": {
        "type": "AMOUNT",
        "units": null,
        "amount_off": 0
      },
      "redemption": {
        "quantity": null,
        "redeemed_quantity": 0
      },
      "code_config": {
        "length": 8,
        "prefix": "Refer-gift-",
        "charset": "0123456789",
        "pattern": "########",
        "postfix": ""
      },
      "loyalty_card": null
    },
    "auto_join": false,
    "join_once": false,
    "created_at": "2024-02-01T08:44:36.722Z",
    "category_id": null,
    "campaign_type": "REFERRAL_PROGRAM",
    "is_referral_code": true,
    "referral_program": {
      "custom_event": {
        "id": "ms_f1r5Tcu5T0m3v3nT5ch3ma",
        "name": "sign_up"
      },
      "referee_reward": {
        "type": "GIFT_VOUCHER",
        "amount": 300,
        "related_object_parent": {
          "id": "camp_bfrwAVsP6Q1EM1ZjgHwheKYr",
          "name": "Gift programme",
          "object": "CAMPAIGN"
        }
      },
      "conversion_event_type": "custom_event"
    }
  },
  "customer": {
    "id": "cust_IdgAFZxYwwHctOk9pPuMu308",
    "name": "Jack Webhook",
    "email": null,
    "object": "customer",
    "metadata": {
      "region": "EMEA"
    },
    "source_id": "jck-wbhk"
  },
  "redemption": {
    "id": "r_0e3ab1f3fb99fee4b9",
    "date": "2024-02-01T08:45:32.014Z",
    "order": {
      "id": "ord_OPBS4bwowjzQ3odiMNk09WPL",
      "items": [],
      "object": "order",
      "status": "PAID",
      "metadata": {},
      "source_id": null,
      "created_at": "2024-02-01T08:45:31.967Z",
      "customer_id": "cust_IdgAFZxYwwHctOk9pPuMu308",
      "referrer_id": null
    },
    "object": "redemption",
    "result": "SUCCESS",
    "status": "SUCCEEDED",
    "voucher": {
      "id": "v_7JItZDjNzMjqSw0BZoxNEMBfdHHB9EHf",
      "code": "Refer-gift-90873378",
      "active": null,
      "object": "voucher",
      "campaign": "Refer-gift",
      "campaign_id": "camp_QULf1Wzu4yvT3cJ3IzFp76nY"
    },
    "customer": {
      "id": "cust_IdgAFZxYwwHctOk9pPuMu308",
      "name": "Jack Webhook",
      "email": null,
      "object": "customer",
      "metadata": {
        "region": "EMEA",
        "sign-up": "true"
      },
      "source_id": "jck-wbhk"
    },
    "metadata": {},
    "customer_id": "cust_IdgAFZxYwwHctOk9pPuMu308",
    "tracking_id": "track_8RFQINPxgc+pykybVOUEXQ=="
  },
  "promotion_tier": null,
  "redemption_rollback": {
    "id": "rr_0e3ac8762299fef1e3",
    "date": "2024-02-01T10:23:52.499Z",
    "order": {
      "id": "ord_OPBS4bwowjzQ3odiMNk09WPL",
      "items": [],
      "object": "order",
      "status": "CANCELED",
      "metadata": {},
      "source_id": null,
      "created_at": "2024-02-01T08:45:31.967Z",
      "updated_at": "2024-02-01T10:23:52.507Z",
      "customer_id": "cust_IdgAFZxYwwHctOk9pPuMu308",
      "referrer_id": null
    },
    "object": "redemption_rollback",
    "reason": "Fraud prevention",
    "result": "SUCCESS",
    "status": "SUCCEEDED",
    "voucher": {
      "id": "v_7JItZDjNzMjqSw0BZoxNEMBfdHHB9EHf",
      "code": "Refer-gift-90873378",
      "type": "DISCOUNT_VOUCHER",
      "active": true,
      "object": "voucher",
      "campaign": "Refer-gift",
      "discount": {
        "type": "AMOUNT",
        "amount_off": 0
      },
      "created_at": "2024-02-01T08:44:37.539Z",
      "redemption": {
        "quantity": null,
        "redeemed_quantity": 0
      },
      "updated_at": "2024-02-01T10:23:52.490Z",
      "campaign_id": "camp_QULf1Wzu4yvT3cJ3IzFp76nY",
      "category_id": null,
      "is_referral_code": true
    },
    "customer": {
      "id": "cust_IdgAFZxYwwHctOk9pPuMu308",
      "name": "Jack Webhook",
      "email": null,
      "object": "customer",
      "metadata": {
        "region": "EMEA",
        "sign-up": "true"
      },
      "source_id": "jck-wbhk"
    },
    "metadata": null,
    "redemption": "r_0e3ab1f3fb99fee4b9",
    "customer_id": "cust_IdgAFZxYwwHctOk9pPuMu308",
    "tracking_id": "track_8RFQINPxgc+pykybVOUEXQ=="
  }
}

Response

200 - application/json

Indicates that a redemption rollback is successful.

Event data object schema for redemption.rollback.succeeded.

​
customer
object

Simplified customer data.

​
order
object

Order information.

​
campaign
object

Simplified campaign data.

​
voucher
object

Simplified voucher data.

​
holder
object

Details about the redeemable holder.

​
promotion_tier
object

Simplified promotion tier data.

​
promotion_stack
object

Simplified promotion stack data.

​
redemption
object

Simplified redemption data.

​
redemption_rollback
object

Simplified redemption data.

⌘I