API to evaluate a customer's request for a refund or credit

Unified Compensation Request: Request body

The UCR API requires the following key data points:

  • originalOrderId of the full reservation details sent via order validation API
  • Account ID or guest account id using _GUEST format. In case guest account is used isGuestAccount parameter should be "true".
  • Compensation Request Data - the main object that contains all relevant data about the compensation (whose structure will vary given item level/order level integration). It includes:
    the amount that was requested
    the channel through which the request was made,
    the type of compensation that was requested by the consumer (e.g. Replacement, Refund, etc..)
    the reason provided for the request (e.g. Damaged Goods)
  "eventId": "r48987fgdse0r",
  "eventTime": 1415287568000,
  "connectionInformation": {
    "customerIP": "",
    "userAgent": "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/47.0.2526.73 Safari/537.36",
    "forterTokenCookie": "2315688945984"
  "originalOrderId": "2356fdse0rr489",
  "accountId": "e520-ba9a-367-60b",
  "compensationRequest": {
    "initiationType": "CALL_CENTER",
    "items": [
        "basicItemData": {
          "name": "White GenericBrand handbag",
          "quantity": 1,
          "type": "TANGIBLE",
          "price": {
            "amountUSD": "99.95"
          "productId": "Ag54352R7768kkO",
          "category": "Apparel and accessories"
        "itemCompensationData": {
          "initiationTime": 1415287568000,
          "requestedReturnType": "SHIP_TO_WAREHOUSE",
          "compensationTypeRequested": "REFUND",
          "reasonCategory": "CHANGED_MY_MIND",
          "internalReasonCategory": "defective item"
    "totalRequestedAmount": {
      "amountUSD": "99.95"
  "hasProofOfPurchase": true

Unified Compensation Request: Response

The UCR API response will contain Forter’s decision regarding the compensation request and if applicable, a recommendation based on the customer’s evaluation and merchant’s business policies.

  "forterDecision": "decline",
  "correlationId": "HGJ7512345H3DE",
  "additionalTags": "",
  "recommendations": [
  "decisionReason": "repeat policy abuse",
  "status": "success"