Compensation request

POST

https://api.forter-secure.com/v2/unified-compensation-request/{id}

Send information about a customer-initiated request for compensation, such as a refund or a reship, in order to receive a fraud or abuse decision. The request can be made on an order level or at the item level. The response may also include recommendations based on your abuse prevention policies.

Path Parameters

idstringrequired

Header Parameters

api-versionstringrequired
Example
10.3
Description
Specify the version of the API to target.
x-forter-siteidstringrequired
Example
a1b2c3d4e5f6
Description
Forter-assigned ID for your account. Note that your Site ID for your test site is different from your production site.

Body Parameters

bodyunifiedCompensationRequestRequestrequired
Description
Send information about a customer-initiated request for compensation, such as a refund or a reship, in order to receive a fraud or abuse decision. The request can be made on an order level or at the item level. The response may also include recommendations based on your abuse prevention policies.
- accountIdstringrequired
  Example
  e520-ba9a-367-60b
  Description
  Customer's account UID in merchant's site. If the compensation request is from a guest account then this field should be populated with the original order id ending with the suffix '_GUEST'.
  Max Length
  50
- additionalEventIdentifiersobject
  - AdditionalAccountEventIdentifiers
- additionalInformationobject
  - GeneralPayloadMap
- compensationRequestCompensationRequestrequired
  Description
  Details of compensation request (type of compensation requested, items for which compensation is requested, etc.)
  - initiationTypestring<CALL_CENTER | IN_STORE | CHAT | ONLINE | SELF_SERVICE>required
    Example
    CALL_CENTER
    Description
    What channel did the customer use to initiate the request for compensation
    Allowed
    CALL_CENTERIN_STORECHATONLINESELF_SERVICE
  - itemsCompensationItem[]required
    Description
    A list of all items for which compensation is being requested
    - basicItemDataBasicItemDatarequired
      Description
      General data regarding item such as name, price, etc.
      - categorystring
        Example
        Apparel and accessories
        Description
        Item category
        Max Length
        1000
      - discountobject
        Discount
        couponCodeUsedstringrequired
        Example
        FATHERSDAY2015
        Description
        Coupon code used
        Max Length
        150
        couponDiscountAmountobject
        Amount
        amountLocalCurrencystring
        Example
        105.55
        Description
        Conditional. Transaction amount in currency chosen by the buyer
        Max Length
        20
        amountUSDstring
        Example
        99.95
        Description
        Conditional. Transaction amount in USD
        Max Length
        12
        currencystring
        Example
        CAD
        Description
        Conditional.
        Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code
        Max Length
        3
        Pattern
        [A-Z]{3}
        couponDiscountPercentstring
        Description
        Coupon discount amount
      - namestringrequired
        Example
        White GenericBrand handbag
        Description
        Item name
        Max Length
        500
      - priceAmountrequired
        Description
        Final amount due for purchase, after all discounts and promotions
        amountLocalCurrencystring
        Example
        105.55
        Description
        Conditional. Transaction amount in currency chosen by the buyer
        Max Length
        20
        amountUSDstring
        Example
        99.95
        Description
        Conditional. Transaction amount in USD
        Max Length
        12
        currencystring
        Example
        CAD
        Description
        Conditional.
        Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code
        Max Length
        3
        Pattern
        [A-Z]{3}
      - productIdstring
        Example
        Ag54352R7768kkO
        Description
        Unique identifier for item that is common to all identical items (such as SKU, ISBN, etc.)
        Max Length
        70
      - quantitynumberrequired
        Example
        1
        Description
        Item quantity
      - typestring<TANGIBLE | NON_TANGIBLE>required
        Example
        TANGIBLE
        Description
        Tangible if physical item, non-tangible if any other product
        Allowed
        TANGIBLENON_TANGIBLE
    - itemCompensationDataCompensationDatarequired
      Description
      Data relating to the return of the item
      - compensationTypeRequestedstring<REPLACEMENT | REFUND | REFUND_UPON_RETURN | CREDIT | MIXED | UNKNOWN | NO_COMPENSATION>
        Example
        REFUND
        Description
        Conditional.
        Indicates whether the customer requested a refund, store credit, replacement etc.
        Allowed
        REPLACEMENTREFUNDREFUND_UPON_RETURNCREDITMIXEDUNKNOWNNO_COMPENSATION
      - initiationTimenumberrequired
        Example
        1415287568000
        Description
        The time that the customer initiated the request for compensation in MILLISECONDS since unix epoch (Jan 1, 1970)
      - internalReasonCategorystring
        Example
        defective item
        Description
        The reason for the request as defined by the merchant
        Max Length
        40
      - reasonCategorystring<CHANGED_MY_MIND | DOES_NOT_FIT | NOT_AS_DESCRIBED | WRONG_ITEM | ARRIVED_TOO_LATE | LOW_QUALITY | DAMAGED_GOODS | GIFT_RETURN | RETURN_TO_SENDER | RETURN_POLICY_EXCEPTION | OTHER | UNKNOWN | ITEM_NOT_RECEIVED | ENTIRE_ORDER_NOT_RECEIVED | OUTBOUND_ISSUE_CARRIER | OUTBOUND_ISSUE_MERCHANT | FAILED_DELIVERY | INBOUND_LOSS | INBOUND_ISSUE_CARRIER>
        Example
        CHANGED_MY_MIND
        Description
        Conditional. Reason for compensation request
        Allowed
        CHANGED_MY_MINDDOES_NOT_FITNOT_AS_DESCRIBEDWRONG_ITEMARRIVED_TOO_LATELOW_QUALITYDAMAGED_GOODSGIFT_RETURNRETURN_TO_SENDERRETURN_POLICY_EXCEPTIONOTHERUNKNOWNITEM_NOT_RECEIVEDENTIRE_ORDER_NOT_RECEIVEDOUTBOUND_ISSUE_CARRIEROUTBOUND_ISSUE_MERCHANTFAILED_DELIVERYINBOUND_LOSSINBOUND_ISSUE_CARRIER
      - requestedReturnTypestring<SHIP_TO_WAREHOUSE | IN_STORE | NO_RETURN>required
        Example
        SHIP_TO_WAREHOUSE
        Description
        Method of return requested by customer (or the request to not return item at all)
        Allowed
        SHIP_TO_WAREHOUSEIN_STORENO_RETURN
  - orderCompensationDataobject
    - CompensationData
      - compensationTypeRequestedstring<REPLACEMENT | REFUND | REFUND_UPON_RETURN | CREDIT | MIXED | UNKNOWN | NO_COMPENSATION>
        Example
        REFUND
        Description
        Conditional.
        Indicates whether the customer requested a refund, store credit, replacement etc.
        Allowed
        REPLACEMENTREFUNDREFUND_UPON_RETURNCREDITMIXEDUNKNOWNNO_COMPENSATION
      - initiationTimenumberrequired
        Example
        1415287568000
        Description
        The time that the customer initiated the request for compensation in MILLISECONDS since unix epoch (Jan 1, 1970)
      - internalReasonCategorystring
        Example
        defective item
        Description
        The reason for the request as defined by the merchant
        Max Length
        40
      - reasonCategorystring<CHANGED_MY_MIND | DOES_NOT_FIT | NOT_AS_DESCRIBED | WRONG_ITEM | ARRIVED_TOO_LATE | LOW_QUALITY | DAMAGED_GOODS | GIFT_RETURN | RETURN_TO_SENDER | RETURN_POLICY_EXCEPTION | OTHER | UNKNOWN | ITEM_NOT_RECEIVED | ENTIRE_ORDER_NOT_RECEIVED | OUTBOUND_ISSUE_CARRIER | OUTBOUND_ISSUE_MERCHANT | FAILED_DELIVERY | INBOUND_LOSS | INBOUND_ISSUE_CARRIER>
        Example
        CHANGED_MY_MIND
        Description
        Conditional. Reason for compensation request
        Allowed
        CHANGED_MY_MINDDOES_NOT_FITNOT_AS_DESCRIBEDWRONG_ITEMARRIVED_TOO_LATELOW_QUALITYDAMAGED_GOODSGIFT_RETURNRETURN_TO_SENDERRETURN_POLICY_EXCEPTIONOTHERUNKNOWNITEM_NOT_RECEIVEDENTIRE_ORDER_NOT_RECEIVEDOUTBOUND_ISSUE_CARRIEROUTBOUND_ISSUE_MERCHANTFAILED_DELIVERYINBOUND_LOSSINBOUND_ISSUE_CARRIER
      - requestedReturnTypestring<SHIP_TO_WAREHOUSE | IN_STORE | NO_RETURN>required
        Example
        SHIP_TO_WAREHOUSE
        Description
        Method of return requested by customer (or the request to not return item at all)
        Allowed
        SHIP_TO_WAREHOUSEIN_STORENO_RETURN
  - totalRequestedAmountAmountrequired
    Description
    Total amount of the compensation requested by customer
    - amountLocalCurrencystring
      Example
      105.55
      Description
      Conditional. Transaction amount in currency chosen by the buyer
      Max Length
      20
    - amountUSDstring
      Example
      99.95
      Description
      Conditional. Transaction amount in USD
      Max Length
      12
    - currencystring
      Example
      CAD
      Description
      Conditional.
      Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code
      Max Length
      3
      Pattern
      [A-Z]{3}
- connectionInformationConnectionInformationrequired
  Description
  Connection information about the customer typically found in the HTTP request header, if the compensation was initiated online
  - checkoutToolsSessionIdstring
    Example
    HTGDVC232fdFDFdfkdjk87382938mcndjc2f4gbbGd
    Description
    CheckoutToolsSessionId received from the SDK
    Max Length
    128
  - customerIPstringrequired
    Example
    10.0.0.127
    Description
    Customer IP address in IPv4 or IPv6 format. If missing should be populated with 127.0.0.1
  - forterMobileUIDstring
    Example
    6429751237891
    Description
    Conditional.
    mobile UID. The device identifier such as IMEI in android or identifier for vendor in iOS. This should match the deviceId sent via the mobile events API (for mobile transactions only)
    Max Length
    128
  - forterTokenCookiestring
    Example
    249453te8tbf9355186fet0ken547b95_2786972955236__UDE52-n5_8dg
    Description
    Conditional. Forter token cookie from request headers
    Max Length
    128
  - merchantDeviceIdentifierstring
    Example
    HGJ7512345H3
    Description
    Conditional. A unique device identifier generated by merchant
    Max Length
    100
  - merchantProvidedSessionIdstring
    Example
    HTGDVC232fdFDFdfkdjk87382938mcndjc2f4gbbGd
    Description
    An identifier of the merchant session
    Max Length
    128
  - userAgentstringrequired
    Example
    Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/47.0.2526.73 Safari/537.36
    Description
    Customer's User agent
    Max Length
    4096
- eventIdstringrequired
  Example
  r48987fgdse0r
  Description
  Unique identifier of this compensation request
  Max Length
  40
- eventTimenumberrequired
  Example
  1415287568000
  Description
  The time that the trigger event occurred in MILLISECONDS since unix epoch (Jan 1, 1970)
- hasProofOfPurchaseboolean
  Example
  true
  Description
  Whether the user has a proof of purchase
- isGuestAccountbooleanrequired
  Description
  Boolean field indicating if account is a guest account.
- merchantAgentDataobject
  - MerchantAgentData
    - merchantAgentIdstring
      Example
      HG36885TZ
      Description
      Unique identifier of the agent processing the customer's request
    - merchantAgentNamestring
      Example
      John Smith
      Description
      Name of the agent processing the customer's request
- merchantIdentifiersobject
  - MerchantIdentifiers
    - merchantDomainstring
      Example
      HandbagsExpressDiscounts.com
      Description
      Use if merchant operates several sites (such as a regular site and a related discount brand)
      Max Length
      2048
    - merchantNamestring
      Example
      Handbags Express Discounts
      Description
      Use if merchant operates several sites (such as a regular site and a related discount brand)
      Max Length
      50
- originalOrderIdstringrequired
  Example
  2356fdse0rr489
  Description
  Unique order/transaction identifier for which compensation is being requested in this compensation event. Note that Forter treats this ID as case-insensitive; Order123 and ORDER123 will be identified as the same order.
  Max Length
  40
- statusobject
  - CompensationStatus
    - hasProofOfPurchaseboolean
    - itemStatusItemCompensationStatus[]required
      Description
      A list of all items for which compensation was requested
      - basicItemDataBasicItemDatarequired
        Description
        General data regarding item such as name, price, etc.
        categorystring
        Example
        Apparel and accessories
        Description
        Item category
        Max Length
        1000
        discountobject
        Discount
        couponCodeUsedstringrequired
        Example
        FATHERSDAY2015
        Description
        Coupon code used
        Max Length
        150
        couponDiscountAmountobject
        Amount
        amountLocalCurrencystring
        Example
        105.55
        Description
        Conditional. Transaction amount in currency chosen by the buyer
        Max Length
        20
        amountUSDstring
        Example
        99.95
        Description
        Conditional. Transaction amount in USD
        Max Length
        12
        currencystring
        Example
        CAD
        Description
        Conditional.
        Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code
        Max Length
        3
        Pattern
        [A-Z]{3}
        couponDiscountPercentstring
        Description
        Coupon discount amount
        namestringrequired
        Example
        White GenericBrand handbag
        Description
        Item name
        Max Length
        500
        priceAmountrequired
        Description
        Final amount due for purchase, after all discounts and promotions
        amountLocalCurrencystring
        Example
        105.55
        Description
        Conditional. Transaction amount in currency chosen by the buyer
        Max Length
        20
        amountUSDstring
        Example
        99.95
        Description
        Conditional. Transaction amount in USD
        Max Length
        12
        currencystring
        Example
        CAD
        Description
        Conditional.
        Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code
        Max Length
        3
        Pattern
        [A-Z]{3}
        productIdstring
        Example
        Ag54352R7768kkO
        Description
        Unique identifier for item that is common to all identical items (such as SKU, ISBN, etc.)
        Max Length
        70
        quantitynumberrequired
        Example
        1
        Description
        Item quantity
        typestring<TANGIBLE | NON_TANGIBLE>required
        Example
        TANGIBLE
        Description
        Tangible if physical item, non-tangible if any other product
        Allowed
        TANGIBLENON_TANGIBLE
      - statusDataItemCompensationStatusDatarequired
        Description
        Data relating to the return of the item
        compensationTypeGrantedstring<REPLACEMENT | REFUND | REFUND_UPON_RETURN | CREDIT | MIXED | UNKNOWN | NO_COMPENSATION>required
        Example
        REFUND
        Description
        Indicates whether the customer was granted a refund, store credit, replacement etc.
        Allowed
        REPLACEMENTREFUNDREFUND_UPON_RETURNCREDITMIXEDUNKNOWNNO_COMPENSATION
        internalReasonCategorystring
        Example
        defective item
        Description
        The reason for the request as defined by the merchant
        Max Length
        40
        reasonCategorystring<CHANGED_MY_MIND | DOES_NOT_FIT | NOT_AS_DESCRIBED | WRONG_ITEM | ARRIVED_TOO_LATE | LOW_QUALITY | DAMAGED_GOODS | GIFT_RETURN | RETURN_TO_SENDER | RETURN_POLICY_EXCEPTION | OTHER | UNKNOWN | ITEM_NOT_RECEIVED | ENTIRE_ORDER_NOT_RECEIVED | OUTBOUND_ISSUE_CARRIER | OUTBOUND_ISSUE_MERCHANT | FAILED_DELIVERY | INBOUND_LOSS | INBOUND_ISSUE_CARRIER>required
        Example
        CHANGED_MY_MIND
        Description
        Reason for compensation request
        Allowed
        CHANGED_MY_MINDDOES_NOT_FITNOT_AS_DESCRIBEDWRONG_ITEMARRIVED_TOO_LATELOW_QUALITYDAMAGED_GOODSGIFT_RETURNRETURN_TO_SENDERRETURN_POLICY_EXCEPTIONOTHERUNKNOWNITEM_NOT_RECEIVEDENTIRE_ORDER_NOT_RECEIVEDOUTBOUND_ISSUE_CARRIEROUTBOUND_ISSUE_MERCHANTFAILED_DELIVERYINBOUND_LOSSINBOUND_ISSUE_CARRIER
        returnConditionstring<GOOD_CONDITION | DAMAGED | WRONG_ITEM | NO_ITEM | NOT_ARRIVED | NO_RETURN>
        Example
        DAMAGED
        Description
        Condition of the item returned
        Allowed
        GOOD_CONDITIONDAMAGEDWRONG_ITEMNO_ITEMNOT_ARRIVEDNO_RETURN
        Max Length
        40
        returnMethodGrantedstring<SHIP_TO_WAREHOUSE | IN_STORE | NO_RETURN>required
        Example
        SHIP_TO_WAREHOUSE
        Description
        Method of return granted to customer
        Allowed
        SHIP_TO_WAREHOUSEIN_STORENO_RETURN
        statusLogobject
        CompensationStatusLog
        arrivedToWarehouseTimenumber
        Example
        1420070400000
        Description
        Time returned items arrived to the merchant's warehouse
        initiationTimenumber
        Example
        1415287568000
        Description
        The time that the customer initiated the request for compensation in MILLISECONDS since unix epoch (Jan 1, 1970)
        initiationTypestring<CALL_CENTER | IN_STORE | CHAT | ONLINE | SELF_SERVICE>
        Example
        CALL_CENTER
        Description
        What channel did the customer use to initiate the request for compensation
        Allowed
        CALL_CENTERIN_STORECHATONLINESELF_SERVICE
        shippedByCustomerTimenumber
        Example
        1420070400000
        Description
        Time returned items were shipped by the customer
        updatedStatusstring<ACCEPTED_BY_MERCHANT | REJECTED_BY_MERCHANT | WITHDRAWN_BY_CUSTOMER>required
        Example
        ACCEPTED_BY_MERCHANT
        Description
        The updated compensation request status
        Allowed
        ACCEPTED_BY_MERCHANTREJECTED_BY_MERCHANTWITHDRAWN_BY_CUSTOMER
    - merchantAgentDataobject
      - MerchantAgentData
        merchantAgentIdstring
        Example
        HG36885TZ
        Description
        Unique identifier of the agent processing the customer's request
        merchantAgentNamestring
        Example
        John Smith
        Description
        Name of the agent processing the customer's request
    - replacementOrderIdstring
      Example
      2356fdse0rr489
      Description
      Conditional.
      Unique order/transaction identifier for a replacement order issued by the merchant in response to this request
      Max Length
      40
    - shippingRefundedboolean
      Description
      Indicates whether merchant reimbursed the customer for shipping expenses
    - shippingRefundedAmountobject
      - Amount
        amountLocalCurrencystring
        Example
        105.55
        Description
        Conditional. Transaction amount in currency chosen by the buyer
        Max Length
        20
        amountUSDstring
        Example
        99.95
        Description
        Conditional. Transaction amount in USD
        Max Length
        12
        currencystring
        Example
        CAD
        Description
        Conditional.
        Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code
        Max Length
        3
        Pattern
        [A-Z]{3}
    - statusDataobject
      - ItemCompensationStatusData
        compensationTypeGrantedstring<REPLACEMENT | REFUND | REFUND_UPON_RETURN | CREDIT | MIXED | UNKNOWN | NO_COMPENSATION>required
        Example
        REFUND
        Description
        Indicates whether the customer was granted a refund, store credit, replacement etc.
        Allowed
        REPLACEMENTREFUNDREFUND_UPON_RETURNCREDITMIXEDUNKNOWNNO_COMPENSATION
        internalReasonCategorystring
        Example
        defective item
        Description
        The reason for the request as defined by the merchant
        Max Length
        40
        reasonCategorystring<CHANGED_MY_MIND | DOES_NOT_FIT | NOT_AS_DESCRIBED | WRONG_ITEM | ARRIVED_TOO_LATE | LOW_QUALITY | DAMAGED_GOODS | GIFT_RETURN | RETURN_TO_SENDER | RETURN_POLICY_EXCEPTION | OTHER | UNKNOWN | ITEM_NOT_RECEIVED | ENTIRE_ORDER_NOT_RECEIVED | OUTBOUND_ISSUE_CARRIER | OUTBOUND_ISSUE_MERCHANT | FAILED_DELIVERY | INBOUND_LOSS | INBOUND_ISSUE_CARRIER>required
        Example
        CHANGED_MY_MIND
        Description
        Reason for compensation request
        Allowed
        CHANGED_MY_MINDDOES_NOT_FITNOT_AS_DESCRIBEDWRONG_ITEMARRIVED_TOO_LATELOW_QUALITYDAMAGED_GOODSGIFT_RETURNRETURN_TO_SENDERRETURN_POLICY_EXCEPTIONOTHERUNKNOWNITEM_NOT_RECEIVEDENTIRE_ORDER_NOT_RECEIVEDOUTBOUND_ISSUE_CARRIEROUTBOUND_ISSUE_MERCHANTFAILED_DELIVERYINBOUND_LOSSINBOUND_ISSUE_CARRIER
        returnConditionstring<GOOD_CONDITION | DAMAGED | WRONG_ITEM | NO_ITEM | NOT_ARRIVED | NO_RETURN>
        Example
        DAMAGED
        Description
        Condition of the item returned
        Allowed
        GOOD_CONDITIONDAMAGEDWRONG_ITEMNO_ITEMNOT_ARRIVEDNO_RETURN
        Max Length
        40
        returnMethodGrantedstring<SHIP_TO_WAREHOUSE | IN_STORE | NO_RETURN>required
        Example
        SHIP_TO_WAREHOUSE
        Description
        Method of return granted to customer
        Allowed
        SHIP_TO_WAREHOUSEIN_STORENO_RETURN
        statusLogobject
        CompensationStatusLog
        arrivedToWarehouseTimenumber
        Example
        1420070400000
        Description
        Time returned items arrived to the merchant's warehouse
        initiationTimenumber
        Example
        1415287568000
        Description
        The time that the customer initiated the request for compensation in MILLISECONDS since unix epoch (Jan 1, 1970)
        initiationTypestring<CALL_CENTER | IN_STORE | CHAT | ONLINE | SELF_SERVICE>
        Example
        CALL_CENTER
        Description
        What channel did the customer use to initiate the request for compensation
        Allowed
        CALL_CENTERIN_STORECHATONLINESELF_SERVICE
        shippedByCustomerTimenumber
        Example
        1420070400000
        Description
        Time returned items were shipped by the customer
        updatedStatusstring<ACCEPTED_BY_MERCHANT | REJECTED_BY_MERCHANT | WITHDRAWN_BY_CUSTOMER>required
        Example
        ACCEPTED_BY_MERCHANT
        Description
        The updated compensation request status
        Allowed
        ACCEPTED_BY_MERCHANTREJECTED_BY_MERCHANTWITHDRAWN_BY_CUSTOMER
    - totalGrantedAmountAmountrequired
      Description
      Total amount of the compensation granted to customer (excluding shippingRefundedAmount)
      - amountLocalCurrencystring
        Example
        105.55
        Description
        Conditional. Transaction amount in currency chosen by the buyer
        Max Length
        20
      - amountUSDstring
        Example
        99.95
        Description
        Conditional. Transaction amount in USD
        Max Length
        12
      - currencystring
        Example
        CAD
        Description
        Conditional.
        Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code
        Max Length
        3
        Pattern
        [A-Z]{3}

Responses

200Example unifiedCompensationRequestResponse

unifiedCompensationRequestResponse
Description
The response object of a forter compensation request call
- correlationIdstringrequired
  Example
  HGJ7512345H3DE
  Description
  A Forter unique identifier that was provided as part of a Forter API response. Used to correlate between the compensation request event and final status update
- decisionReasonstringrequired
  Max Length
  1000
- forterDecisionstringrequired
  Example
  approve
  Description
  The message containing the decision
  Max Length
  1000
- merchantPolicyIdstringrequired
  Example
  0ee8ba28a8654c659addbae9253b707c
  Description
  UID of the custom policy created in Forter's Policies tool that resulted in this decision
- recommendationsstring[]required
  Description
  Forter's recommendations for the optimal way of proceeding with the compensation request
- statusstringrequired
  Example
  success
  Description
  Status of the request processing
  Max Length
  50

400

Bad Request (Often missing a required parameter)

401

Unauthorized (No valid API key provided)

404

Not Found (The requested item doesn't exist)

500

Server Error (Something went wrong on Forter's end)

curl

curl --request POST \
     --url https://api.forter-secure.com/v2/unified-compensation-request/{id} \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'api-version: 10.3' \
     --header 'x-forter-siteid: a1b2c3d4e5f6' \
     --data '{
     "accountId": "e520-ba9a-367-60b",
     "additionalEventIdentifiers": {},
     "additionalInformation": {},
     "compensationRequest": {
     "initiationType": "CALL_CENTER",
     "items": [
     {
     "basicItemData": {
     "discount": {
     "couponCodeUsed": "FATHERSDAY2015",
     "couponDiscountAmount": {}
     },
     "name": "White GenericBrand handbag",
     "price": {},
     "quantity": 1,
     "type": "TANGIBLE"
     },
     "itemCompensationData": {
     "initiationTime": 1415287568000,
     "requestedReturnType": "SHIP_TO_WAREHOUSE"
     }
     }
     ],
     "orderCompensationData": {
     "initiationTime": 1415287568000,
     "requestedReturnType": "SHIP_TO_WAREHOUSE"
     },
     "totalRequestedAmount": {}
     },
     "connectionInformation": {
     "customerIP": "10.0.0.127",
     "userAgent": "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/47.0.2526.73 Safari/537.36"
     },
     "eventId": "r48987fgdse0r",
     "eventTime": 1415287568000,
     "isGuestAccount": false,
     "merchantAgentData": {},
     "merchantIdentifiers": {},
     "originalOrderId": "2356fdse0rr489",
     "status": {
     "itemStatus": [
     {
     "basicItemData": {
     "discount": {
     "couponCodeUsed": "FATHERSDAY2015",
     "couponDiscountAmount": {}
     },
     "name": "White GenericBrand handbag",
     "price": {},
     "quantity": 1,
     "type": "TANGIBLE"
     },
     "statusData": {
     "compensationTypeGranted": "REFUND",
     "reasonCategory": "CHANGED_MY_MIND",
     "returnMethodGranted": "SHIP_TO_WAREHOUSE",
     "statusLog": {},
     "updatedStatus": "ACCEPTED_BY_MERCHANT"
     }
     }
     ],
     "merchantAgentData": {},
     "shippingRefundedAmount": {},
     "statusData": {
     "compensationTypeGranted": "REFUND",
     "reasonCategory": "CHANGED_MY_MIND",
     "returnMethodGranted": "SHIP_TO_WAREHOUSE",
     "statusLog": {},
     "updatedStatus": "ACCEPTED_BY_MERCHANT"
     },
     "totalGrantedAmount": {}
     }
     }'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
myHeaders.append("api-version", "10.3");
myHeaders.append("x-forter-siteid", "a1b2c3d4e5f6");

var raw = JSON.stringify({
   "accountId": "e520-ba9a-367-60b",
   "additionalEventIdentifiers": {},
   "additionalInformation": {},
   "compensationRequest": {
      "initiationType": "CALL_CENTER",
      "items": [
         {
            "basicItemData": {
               "discount": {
                  "couponCodeUsed": "FATHERSDAY2015",
                  "couponDiscountAmount": {}
               },
               "name": "White GenericBrand handbag",
               "price": {},
               "quantity": 1,
               "type": "TANGIBLE"
            },
            "itemCompensationData": {
               "initiationTime": 1415287568000,
               "requestedReturnType": "SHIP_TO_WAREHOUSE"
            }
         }
      ],
      "orderCompensationData": {
         "initiationTime": 1415287568000,
         "requestedReturnType": "SHIP_TO_WAREHOUSE"
      },
      "totalRequestedAmount": {}
   },
   "connectionInformation": {
      "customerIP": "10.0.0.127",
      "userAgent": "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/47.0.2526.73 Safari/537.36"
   },
   "eventId": "r48987fgdse0r",
   "eventTime": 1415287568000,
   "isGuestAccount": false,
   "merchantAgentData": {},
   "merchantIdentifiers": {},
   "originalOrderId": "2356fdse0rr489",
   "status": {
      "itemStatus": [
         {
            "basicItemData": {
               "discount": {
                  "couponCodeUsed": "FATHERSDAY2015",
                  "couponDiscountAmount": {}
               },
               "name": "White GenericBrand handbag",
               "price": {},
               "quantity": 1,
               "type": "TANGIBLE"
            },
            "statusData": {
               "compensationTypeGranted": "REFUND",
               "reasonCategory": "CHANGED_MY_MIND",
               "returnMethodGranted": "SHIP_TO_WAREHOUSE",
               "statusLog": {},
               "updatedStatus": "ACCEPTED_BY_MERCHANT"
            }
         }
      ],
      "merchantAgentData": {},
      "shippingRefundedAmount": {},
      "statusData": {
         "compensationTypeGranted": "REFUND",
         "reasonCategory": "CHANGED_MY_MIND",
         "returnMethodGranted": "SHIP_TO_WAREHOUSE",
         "statusLog": {},
         "updatedStatus": "ACCEPTED_BY_MERCHANT"
      },
      "totalGrantedAmount": {}
   }
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://api.forter-secure.com/v2/unified-compensation-request/{id}", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.forter-secure.com/v2/unified-compensation-request/{id}")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request["api-version"] = "10.3"
request["x-forter-siteid"] = "a1b2c3d4e5f6"
request.body = JSON.dump({
   "accountId": "e520-ba9a-367-60b",
   "additionalEventIdentifiers": {},
   "additionalInformation": {},
   "compensationRequest": {
      "initiationType": "CALL_CENTER",
      "items": [
         {
            "basicItemData": {
               "discount": {
                  "couponCodeUsed": "FATHERSDAY2015",
                  "couponDiscountAmount": {}
               },
               "name": "White GenericBrand handbag",
               "price": {},
               "quantity": 1,
               "type": "TANGIBLE"
            },
            "itemCompensationData": {
               "initiationTime": 1415287568000,
               "requestedReturnType": "SHIP_TO_WAREHOUSE"
            }
         }
      ],
      "orderCompensationData": {
         "initiationTime": 1415287568000,
         "requestedReturnType": "SHIP_TO_WAREHOUSE"
      },
      "totalRequestedAmount": {}
   },
   "connectionInformation": {
      "customerIP": "10.0.0.127",
      "userAgent": "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/47.0.2526.73 Safari/537.36"
   },
   "eventId": "r48987fgdse0r",
   "eventTime": 1415287568000,
   "isGuestAccount": false,
   "merchantAgentData": {},
   "merchantIdentifiers": {},
   "originalOrderId": "2356fdse0rr489",
   "status": {
      "itemStatus": [
         {
            "basicItemData": {
               "discount": {
                  "couponCodeUsed": "FATHERSDAY2015",
                  "couponDiscountAmount": {}
               },
               "name": "White GenericBrand handbag",
               "price": {},
               "quantity": 1,
               "type": "TANGIBLE"
            },
            "statusData": {
               "compensationTypeGranted": "REFUND",
               "reasonCategory": "CHANGED_MY_MIND",
               "returnMethodGranted": "SHIP_TO_WAREHOUSE",
               "statusLog": {},
               "updatedStatus": "ACCEPTED_BY_MERCHANT"
            }
         }
      ],
      "merchantAgentData": {},
      "shippingRefundedAmount": {},
      "statusData": {
         "compensationTypeGranted": "REFUND",
         "reasonCategory": "CHANGED_MY_MIND",
         "returnMethodGranted": "SHIP_TO_WAREHOUSE",
         "statusLog": {},
         "updatedStatus": "ACCEPTED_BY_MERCHANT"
      },
      "totalGrantedAmount": {}
   }
})

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.forter-secure.com/v2/unified-compensation-request/{id}"

payload = json.dumps({
   "accountId": "e520-ba9a-367-60b",
   "additionalEventIdentifiers": {},
   "additionalInformation": {},
   "compensationRequest": {
      "initiationType": "CALL_CENTER",
      "items": [
         {
            "basicItemData": {
               "discount": {
                  "couponCodeUsed": "FATHERSDAY2015",
                  "couponDiscountAmount": {}
               },
               "name": "White GenericBrand handbag",
               "price": {},
               "quantity": 1,
               "type": "TANGIBLE"
            },
            "itemCompensationData": {
               "initiationTime": 1415287568000,
               "requestedReturnType": "SHIP_TO_WAREHOUSE"
            }
         }
      ],
      "orderCompensationData": {
         "initiationTime": 1415287568000,
         "requestedReturnType": "SHIP_TO_WAREHOUSE"
      },
      "totalRequestedAmount": {}
   },
   "connectionInformation": {
      "customerIP": "10.0.0.127",
      "userAgent": "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/47.0.2526.73 Safari/537.36"
   },
   "eventId": "r48987fgdse0r",
   "eventTime": 1415287568000,
   "isGuestAccount": False,
   "merchantAgentData": {},
   "merchantIdentifiers": {},
   "originalOrderId": "2356fdse0rr489",
   "status": {
      "itemStatus": [
         {
            "basicItemData": {
               "discount": {
                  "couponCodeUsed": "FATHERSDAY2015",
                  "couponDiscountAmount": {}
               },
               "name": "White GenericBrand handbag",
               "price": {},
               "quantity": 1,
               "type": "TANGIBLE"
            },
            "statusData": {
               "compensationTypeGranted": "REFUND",
               "reasonCategory": "CHANGED_MY_MIND",
               "returnMethodGranted": "SHIP_TO_WAREHOUSE",
               "statusLog": {},
               "updatedStatus": "ACCEPTED_BY_MERCHANT"
            }
         }
      ],
      "merchantAgentData": {},
      "shippingRefundedAmount": {},
      "statusData": {
         "compensationTypeGranted": "REFUND",
         "reasonCategory": "CHANGED_MY_MIND",
         "returnMethodGranted": "SHIP_TO_WAREHOUSE",
         "statusLog": {},
         "updatedStatus": "ACCEPTED_BY_MERCHANT"
      },
      "totalGrantedAmount": {}
   }
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json',
   'api-version': '10.3',
   'x-forter-siteid': 'a1b2c3d4e5f6'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

200

// Example unifiedCompensationRequestResponse
{
  "correlationId": "HGJ7512345H3DE",
  "decisionReason": "",
  "forterDecision": "approve",
  "merchantPolicyId": "0ee8ba28a8654c659addbae9253b707c",
  "recommendations": [
    ""
  ],
  "status": "success"
}

400

// Bad Request (Often missing a required parameter)

401

// Unauthorized (No valid API key provided)

404

// Not Found (The requested item doesn't exist)

500

// Server Error (Something went wrong on Forter's end)