補償リクエスト

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.1
Description
Specify the version of the API to target.
Default
10.1
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.
Default
8b47c6d423ba

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
  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'.
  Default
  e520-ba9a-367-60b
- 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
    Description
    What channel did the customer use to initiate the request for compensation
    Default
    CALL_CENTER
  - 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
        Description
        Item category
        Default
        Apparel and accessories
      - discountobject
        Discount
        couponCodeUsedstringrequired
        Description
        Coupon code used
        Default
        FATHERSDAY2015
        couponDiscountAmountobject
        Amount
        amountLocalCurrencystring
        Description
        Transaction amount in currency chosen by the buyer
        Default
        105.55
        amountUSDstring
        Description
        Transaction amount in USD
        Default
        99.95
        currencystring
        Description
        Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code
        Default
        CAD
        couponDiscountPercentstring
        Description
        Coupon discount amount
      - namestringrequired
        Description
        Item name
        Default
        White GenericBrand handbag
      - priceAmountrequired
        Description
        Final amount due for purchase, after all discounts and promotions
        amountLocalCurrencystring
        Description
        Transaction amount in currency chosen by the buyer
        Default
        105.55
        amountUSDstring
        Description
        Transaction amount in USD
        Default
        99.95
        currencystring
        Description
        Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code
        Default
        CAD
      - productIdstring
        Description
        Unique identifier for item that is common to all identical items (such as SKU, ISBN, etc.)
        Default
        Ag54352R7768kkO
      - quantitynumberrequired
        Description
        Item quantity
        Default
        1
      - typestring<TANGIBLE | NON_TANGIBLE>required
        Description
        Tangible if physical item, non-tangible if any other product
        Default
        TANGIBLE
    - itemCompensationDataCompensationDatarequired
      Description
      Data relating to the return of the item
      - compensationTypeRequestedstring<REPLACEMENT | REFUND | REFUND_UPON_RETURN | CREDIT | MIXED | UNKNOWN | NO_COMPENSATION>
        Description
        Indicates whether the customer requested a refund, store credit, replacement etc.
        Default
        REFUND
      - initiationTimenumberrequired
        Description
        The time that the customer initiated the request for compensation in MILLISECONDS since unix epoch (Jan 1, 1970)
        Default
        1415287568000
      - internalReasonCategorystring
        Description
        The reason for the request as defined by the merchant
        Default
        defective item
      - 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>
        Description
        Reason for compensation request
        Default
        CHANGED_MY_MIND
      - requestedReturnTypestring<SHIP_TO_WAREHOUSE | IN_STORE | NO_RETURN>required
        Description
        Method of return requested by customer (or the request to not return item at all)
        Default
        SHIP_TO_WAREHOUSE
  - orderCompensationDataobject
    - CompensationData
      - compensationTypeRequestedstring<REPLACEMENT | REFUND | REFUND_UPON_RETURN | CREDIT | MIXED | UNKNOWN | NO_COMPENSATION>
        Description
        Indicates whether the customer requested a refund, store credit, replacement etc.
        Default
        REFUND
      - initiationTimenumberrequired
        Description
        The time that the customer initiated the request for compensation in MILLISECONDS since unix epoch (Jan 1, 1970)
        Default
        1415287568000
      - internalReasonCategorystring
        Description
        The reason for the request as defined by the merchant
        Default
        defective item
      - 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>
        Description
        Reason for compensation request
        Default
        CHANGED_MY_MIND
      - requestedReturnTypestring<SHIP_TO_WAREHOUSE | IN_STORE | NO_RETURN>required
        Description
        Method of return requested by customer (or the request to not return item at all)
        Default
        SHIP_TO_WAREHOUSE
  - totalRequestedAmountAmountrequired
    Description
    Total amount of the compensation requested by customer
    - amountLocalCurrencystring
      Description
      Transaction amount in currency chosen by the buyer
      Default
      105.55
    - amountUSDstring
      Description
      Transaction amount in USD
      Default
      99.95
    - currencystring
      Description
      Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code
      Default
      CAD
- connectionInformationConnectionInformationrequired
  Description
  Connection information about the customer typically found in the HTTP request header, if the compensation was initiated online
  - checkoutToolsSessionIdstring
    Description
    CheckoutToolsSessionId received from the SDK
    Default
    HTGDVC232fdFDFdfkdjk87382938mcndjc2f4gbbGd
  - customerIPstringrequired
    Description
    Customer IP address in IPv4 or IPv6 format. If missing should be populated with 127.0.0.1
    Default
    10.0.0.127
  - forterMobileUIDstring
    Description
    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)
    Default
    6429751237891
  - forterTokenCookiestring
    Description
    Forter token cookie from request headers
    Default
    249453te8tbf9355186fet0ken547b95_2786972955236__UDE52-n5_8dg
  - merchantDeviceIdentifierstring
    Description
    A unique device identifier generated by merchant
    Default
    HGJ7512345H3
  - merchantProvidedSessionIdstring
    Description
    An identifier of the merchant session
    Default
    HTGDVC232fdFDFdfkdjk87382938mcndjc2f4gbbGd
  - userAgentstringrequired
    Description
    Customer's User agent
    Default
    Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/47.0.2526.73 Safari/537.36
- eventIdstringrequired
  Description
  Unique identifier of this compensation request
  Default
  r48987fgdse0r
- eventTimenumberrequired
  Description
  The time that the trigger event occurred in MILLISECONDS since unix epoch (Jan 1, 1970)
  Default
  1415287568000
- hasProofOfPurchaseboolean
  Description
  Whether the user has a proof of purchase
  Default
  true
- isGuestAccountbooleanrequired
  Description
  Boolean field indicating if account is a guest account.
  Default
  false
- merchantAgentDataobject
  - MerchantAgentData
    - merchantAgentIdstring
      Description
      Unique identifier of the agent processing the customer's request
      Default
      HG36885TZ
    - merchantAgentNamestring
      Description
      Name of the agent processing the customer's request
      Default
      John Smith
- merchantIdentifiersobject
  - MerchantIdentifiers
    - merchantDomainstring
      Description
      Use if merchant operates several sites (such as a regular site and a related discount brand)
      Default
      HandbagsExpressDiscounts.com
    - merchantNamestring
      Description
      Use if merchant operates several sites (such as a regular site and a related discount brand)
      Default
      Handbags Express Discounts
- originalOrderIdstringrequired
  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.
  Default
  2356fdse0rr489
- 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
        Description
        Item category
        Default
        Apparel and accessories
        discountobject
        Discount
        couponCodeUsedstringrequired
        Description
        Coupon code used
        Default
        FATHERSDAY2015
        couponDiscountAmountobject
        Amount
        amountLocalCurrencystring
        Description
        Transaction amount in currency chosen by the buyer
        Default
        105.55
        amountUSDstring
        Description
        Transaction amount in USD
        Default
        99.95
        currencystring
        Description
        Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code
        Default
        CAD
        couponDiscountPercentstring
        Description
        Coupon discount amount
        namestringrequired
        Description
        Item name
        Default
        White GenericBrand handbag
        priceAmountrequired
        Description
        Final amount due for purchase, after all discounts and promotions
        amountLocalCurrencystring
        Description
        Transaction amount in currency chosen by the buyer
        Default
        105.55
        amountUSDstring
        Description
        Transaction amount in USD
        Default
        99.95
        currencystring
        Description
        Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code
        Default
        CAD
        productIdstring
        Description
        Unique identifier for item that is common to all identical items (such as SKU, ISBN, etc.)
        Default
        Ag54352R7768kkO
        quantitynumberrequired
        Description
        Item quantity
        Default
        1
        typestring<TANGIBLE | NON_TANGIBLE>required
        Description
        Tangible if physical item, non-tangible if any other product
        Default
        TANGIBLE
      - statusDataItemCompensationStatusDatarequired
        Description
        Data relating to the return of the item
        compensationTypeGrantedstring<REPLACEMENT | REFUND | REFUND_UPON_RETURN | CREDIT | MIXED | UNKNOWN | NO_COMPENSATION>required
        Description
        Indicates whether the customer was granted a refund, store credit, replacement etc.
        Default
        REFUND
        internalReasonCategorystring
        Description
        The reason for the request as defined by the merchant
        Default
        defective item
        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
        Description
        Reason for compensation request
        Default
        CHANGED_MY_MIND
        returnConditionstring<GOOD_CONDITION | DAMAGED | WRONG_ITEM | NO_ITEM | NOT_ARRIVED | NO_RETURN>
        Description
        Condition of the item returned
        Default
        DAMAGED
        returnMethodGrantedstring<SHIP_TO_WAREHOUSE | IN_STORE | NO_RETURN>required
        Description
        Method of return granted to customer
        Default
        SHIP_TO_WAREHOUSE
        statusLogobject
        CompensationStatusLog
        arrivedToWarehouseTimenumber
        Description
        Time returned items arrived to the merchant's warehouse
        Default
        1420070400000
        initiationTimenumber
        Description
        The time that the customer initiated the request for compensation in MILLISECONDS since unix epoch (Jan 1, 1970)
        Default
        1415287568000
        initiationTypestring<CALL_CENTER | IN_STORE | CHAT | ONLINE | SELF_SERVICE>
        Description
        What channel did the customer use to initiate the request for compensation
        Default
        CALL_CENTER
        shippedByCustomerTimenumber
        Description
        Time returned items were shipped by the customer
        Default
        1420070400000
        updatedStatusstring<ACCEPTED_BY_MERCHANT | REJECTED_BY_MERCHANT | WITHDRAWN_BY_CUSTOMER>required
        Description
        The updated compensation request status
        Default
        ACCEPTED_BY_MERCHANT
    - merchantAgentDataobject
      - MerchantAgentData
        merchantAgentIdstring
        Description
        Unique identifier of the agent processing the customer's request
        Default
        HG36885TZ
        merchantAgentNamestring
        Description
        Name of the agent processing the customer's request
        Default
        John Smith
    - replacementOrderIdstring
      Description
      Unique order/transaction identifier for a replacement order issued by the merchant in response to this request
      Default
      2356fdse0rr489
    - shippingRefundedboolean
      Description
      Indicates whether merchant reimbursed the customer for shipping expenses
    - shippingRefundedAmountobject
      - Amount
        amountLocalCurrencystring
        Description
        Transaction amount in currency chosen by the buyer
        Default
        105.55
        amountUSDstring
        Description
        Transaction amount in USD
        Default
        99.95
        currencystring
        Description
        Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code
        Default
        CAD
    - statusDataobject
      - ItemCompensationStatusData
        compensationTypeGrantedstring<REPLACEMENT | REFUND | REFUND_UPON_RETURN | CREDIT | MIXED | UNKNOWN | NO_COMPENSATION>required
        Description
        Indicates whether the customer was granted a refund, store credit, replacement etc.
        Default
        REFUND
        internalReasonCategorystring
        Description
        The reason for the request as defined by the merchant
        Default
        defective item
        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
        Description
        Reason for compensation request
        Default
        CHANGED_MY_MIND
        returnConditionstring<GOOD_CONDITION | DAMAGED | WRONG_ITEM | NO_ITEM | NOT_ARRIVED | NO_RETURN>
        Description
        Condition of the item returned
        Default
        DAMAGED
        returnMethodGrantedstring<SHIP_TO_WAREHOUSE | IN_STORE | NO_RETURN>required
        Description
        Method of return granted to customer
        Default
        SHIP_TO_WAREHOUSE
        statusLogobject
        CompensationStatusLog
        arrivedToWarehouseTimenumber
        Description
        Time returned items arrived to the merchant's warehouse
        Default
        1420070400000
        initiationTimenumber
        Description
        The time that the customer initiated the request for compensation in MILLISECONDS since unix epoch (Jan 1, 1970)
        Default
        1415287568000
        initiationTypestring<CALL_CENTER | IN_STORE | CHAT | ONLINE | SELF_SERVICE>
        Description
        What channel did the customer use to initiate the request for compensation
        Default
        CALL_CENTER
        shippedByCustomerTimenumber
        Description
        Time returned items were shipped by the customer
        Default
        1420070400000
        updatedStatusstring<ACCEPTED_BY_MERCHANT | REJECTED_BY_MERCHANT | WITHDRAWN_BY_CUSTOMER>required
        Description
        The updated compensation request status
        Default
        ACCEPTED_BY_MERCHANT
    - totalGrantedAmountAmountrequired
      Description
      Total amount of the compensation granted to customer (excluding shippingRefundedAmount)
      - amountLocalCurrencystring
        Description
        Transaction amount in currency chosen by the buyer
        Default
        105.55
      - amountUSDstring
        Description
        Transaction amount in USD
        Default
        99.95
      - currencystring
        Description
        Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code
        Default
        CAD

Responses

200Example unifiedCompensationRequestResponse

unifiedCompensationRequestResponse
Description
The response object of a forter compensation request call
- correlationIdstringrequired
  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
  Default
  HGJ7512345H3DE
- decisionReasonstringrequired
  Default
- forterDecisionstringrequired
  Description
  The message containing the decision
  Default
  approve
- merchantPolicyIdstringrequired
  Description
  UID of the custom policy created in Forter's Policies tool that resulted in this decision
  Default
  0ee8ba28a8654c659addbae9253b707c
- recommendationsstring[]required
  Description
  Forter's recommendations for the optimal way of proceeding with the compensation request
  Default
- statusstringrequired
  Description
  Status of the request processing
  Default
  success

400Bad Request (Often missing a required parameter)

401Unauthorized (No valid API key provided)

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

500Server 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.1' \
     --header 'x-forter-siteid: 8b47c6d423ba' \
     --header 'authorization: Basic <base64-encoded-api-key:>' \
     --data '{
     "accountId": "e520-ba9a-367-60b",
     "additionalEventIdentifiers": {},
     "additionalInformation": {},
     "compensationRequest": {
     "initiationType": "CALL_CENTER",
     "items": [
     {
     "basicItemData": {
     "category": "Apparel and accessories",
     "discount": {
     "couponCodeUsed": "FATHERSDAY2015",
     "couponDiscountAmount": {
     "amountLocalCurrency": "105.55",
     "amountUSD": "99.95",
     "currency": "CAD"
     }
     },
     "name": "White GenericBrand handbag",
     "price": {
     "amountLocalCurrency": "105.55",
     "amountUSD": "99.95",
     "currency": "CAD"
     },
     "productId": "Ag54352R7768kkO",
     "quantity": 1,
     "type": "TANGIBLE"
     },
     "itemCompensationData": {
     "compensationTypeRequested": "REFUND",
     "initiationTime": 1415287568000,
     "internalReasonCategory": "defective item",
     "reasonCategory": "CHANGED_MY_MIND",
     "requestedReturnType": "SHIP_TO_WAREHOUSE"
     }
     }
     ],
     "orderCompensationData": {
     "compensationTypeRequested": "REFUND",
     "initiationTime": 1415287568000,
     "internalReasonCategory": "defective item",
     "reasonCategory": "CHANGED_MY_MIND",
     "requestedReturnType": "SHIP_TO_WAREHOUSE"
     },
     "totalRequestedAmount": {
     "amountLocalCurrency": "105.55",
     "amountUSD": "99.95",
     "currency": "CAD"
     }
     },
     "connectionInformation": {
     "checkoutToolsSessionId": "HTGDVC232fdFDFdfkdjk87382938mcndjc2f4gbbGd",
     "customerIP": "10.0.0.127",
     "forterMobileUID": "6429751237891",
     "forterTokenCookie": "249453te8tbf9355186fet0ken547b95_2786972955236__UDE52-n5_8dg",
     "merchantDeviceIdentifier": "HGJ7512345H3",
     "merchantProvidedSessionId": "HTGDVC232fdFDFdfkdjk87382938mcndjc2f4gbbGd",
     "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,
     "hasProofOfPurchase": true,
     "isGuestAccount": false,
     "merchantAgentData": {
     "merchantAgentId": "HG36885TZ",
     "merchantAgentName": "John Smith"
     },
     "merchantIdentifiers": {
     "merchantDomain": "HandbagsExpressDiscounts.com",
     "merchantName": "Handbags Express Discounts"
     },
     "originalOrderId": "2356fdse0rr489",
     "status": {
     "itemStatus": [
     {
     "basicItemData": {
     "category": "Apparel and accessories",
     "discount": {
     "couponCodeUsed": "FATHERSDAY2015",
     "couponDiscountAmount": {
     "amountLocalCurrency": "105.55",
     "amountUSD": "99.95",
     "currency": "CAD"
     }
     },
     "name": "White GenericBrand handbag",
     "price": {
     "amountLocalCurrency": "105.55",
     "amountUSD": "99.95",
     "currency": "CAD"
     },
     "productId": "Ag54352R7768kkO",
     "quantity": 1,
     "type": "TANGIBLE"
     },
     "statusData": {
     "compensationTypeGranted": "REFUND",
     "internalReasonCategory": "defective item",
     "reasonCategory": "CHANGED_MY_MIND",
     "returnCondition": "DAMAGED",
     "returnMethodGranted": "SHIP_TO_WAREHOUSE",
     "statusLog": {
     "arrivedToWarehouseTime": 1420070400000,
     "initiationTime": 1415287568000,
     "initiationType": "CALL_CENTER",
     "shippedByCustomerTime": 1420070400000
     },
     "updatedStatus": "ACCEPTED_BY_MERCHANT"
     }
     }
     ],
     "merchantAgentData": {
     "merchantAgentId": "HG36885TZ",
     "merchantAgentName": "John Smith"
     },
     "replacementOrderId": "2356fdse0rr489",
     "shippingRefundedAmount": {
     "amountLocalCurrency": "105.55",
     "amountUSD": "99.95",
     "currency": "CAD"
     },
     "statusData": {
     "compensationTypeGranted": "REFUND",
     "internalReasonCategory": "defective item",
     "reasonCategory": "CHANGED_MY_MIND",
     "returnCondition": "DAMAGED",
     "returnMethodGranted": "SHIP_TO_WAREHOUSE",
     "statusLog": {
     "arrivedToWarehouseTime": 1420070400000,
     "initiationTime": 1415287568000,
     "initiationType": "CALL_CENTER",
     "shippedByCustomerTime": 1420070400000
     },
     "updatedStatus": "ACCEPTED_BY_MERCHANT"
     },
     "totalGrantedAmount": {
     "amountLocalCurrency": "105.55",
     "amountUSD": "99.95",
     "currency": "CAD"
     }
     }
     }'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
myHeaders.append("api-version", "10.1");
myHeaders.append("x-forter-siteid", "8b47c6d423ba");
myHeaders.append("authorization", "Basic <base64-encoded-api-key:>");

var raw = JSON.stringify({
   "accountId": "e520-ba9a-367-60b",
   "additionalEventIdentifiers": {},
   "additionalInformation": {},
   "compensationRequest": {
      "initiationType": "CALL_CENTER",
      "items": [
         {
            "basicItemData": {
               "category": "Apparel and accessories",
               "discount": {
                  "couponCodeUsed": "FATHERSDAY2015",
                  "couponDiscountAmount": {
                     "amountLocalCurrency": "105.55",
                     "amountUSD": "99.95",
                     "currency": "CAD"
                  }
               },
               "name": "White GenericBrand handbag",
               "price": {
                  "amountLocalCurrency": "105.55",
                  "amountUSD": "99.95",
                  "currency": "CAD"
               },
               "productId": "Ag54352R7768kkO",
               "quantity": 1,
               "type": "TANGIBLE"
            },
            "itemCompensationData": {
               "compensationTypeRequested": "REFUND",
               "initiationTime": 1415287568000,
               "internalReasonCategory": "defective item",
               "reasonCategory": "CHANGED_MY_MIND",
               "requestedReturnType": "SHIP_TO_WAREHOUSE"
            }
         }
      ],
      "orderCompensationData": {
         "compensationTypeRequested": "REFUND",
         "initiationTime": 1415287568000,
         "internalReasonCategory": "defective item",
         "reasonCategory": "CHANGED_MY_MIND",
         "requestedReturnType": "SHIP_TO_WAREHOUSE"
      },
      "totalRequestedAmount": {
         "amountLocalCurrency": "105.55",
         "amountUSD": "99.95",
         "currency": "CAD"
      }
   },
   "connectionInformation": {
      "checkoutToolsSessionId": "HTGDVC232fdFDFdfkdjk87382938mcndjc2f4gbbGd",
      "customerIP": "10.0.0.127",
      "forterMobileUID": "6429751237891",
      "forterTokenCookie": "249453te8tbf9355186fet0ken547b95_2786972955236__UDE52-n5_8dg",
      "merchantDeviceIdentifier": "HGJ7512345H3",
      "merchantProvidedSessionId": "HTGDVC232fdFDFdfkdjk87382938mcndjc2f4gbbGd",
      "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,
   "hasProofOfPurchase": true,
   "isGuestAccount": false,
   "merchantAgentData": {
      "merchantAgentId": "HG36885TZ",
      "merchantAgentName": "John Smith"
   },
   "merchantIdentifiers": {
      "merchantDomain": "HandbagsExpressDiscounts.com",
      "merchantName": "Handbags Express Discounts"
   },
   "originalOrderId": "2356fdse0rr489",
   "status": {
      "itemStatus": [
         {
            "basicItemData": {
               "category": "Apparel and accessories",
               "discount": {
                  "couponCodeUsed": "FATHERSDAY2015",
                  "couponDiscountAmount": {
                     "amountLocalCurrency": "105.55",
                     "amountUSD": "99.95",
                     "currency": "CAD"
                  }
               },
               "name": "White GenericBrand handbag",
               "price": {
                  "amountLocalCurrency": "105.55",
                  "amountUSD": "99.95",
                  "currency": "CAD"
               },
               "productId": "Ag54352R7768kkO",
               "quantity": 1,
               "type": "TANGIBLE"
            },
            "statusData": {
               "compensationTypeGranted": "REFUND",
               "internalReasonCategory": "defective item",
               "reasonCategory": "CHANGED_MY_MIND",
               "returnCondition": "DAMAGED",
               "returnMethodGranted": "SHIP_TO_WAREHOUSE",
               "statusLog": {
                  "arrivedToWarehouseTime": 1420070400000,
                  "initiationTime": 1415287568000,
                  "initiationType": "CALL_CENTER",
                  "shippedByCustomerTime": 1420070400000
               },
               "updatedStatus": "ACCEPTED_BY_MERCHANT"
            }
         }
      ],
      "merchantAgentData": {
         "merchantAgentId": "HG36885TZ",
         "merchantAgentName": "John Smith"
      },
      "replacementOrderId": "2356fdse0rr489",
      "shippingRefundedAmount": {
         "amountLocalCurrency": "105.55",
         "amountUSD": "99.95",
         "currency": "CAD"
      },
      "statusData": {
         "compensationTypeGranted": "REFUND",
         "internalReasonCategory": "defective item",
         "reasonCategory": "CHANGED_MY_MIND",
         "returnCondition": "DAMAGED",
         "returnMethodGranted": "SHIP_TO_WAREHOUSE",
         "statusLog": {
            "arrivedToWarehouseTime": 1420070400000,
            "initiationTime": 1415287568000,
            "initiationType": "CALL_CENTER",
            "shippedByCustomerTime": 1420070400000
         },
         "updatedStatus": "ACCEPTED_BY_MERCHANT"
      },
      "totalGrantedAmount": {
         "amountLocalCurrency": "105.55",
         "amountUSD": "99.95",
         "currency": "CAD"
      }
   }
});

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.1"
request["x-forter-siteid"] = "8b47c6d423ba"
request["authorization"] = "Basic <base64-encoded-api-key:>"
request.body = JSON.dump({
   "accountId": "e520-ba9a-367-60b",
   "additionalEventIdentifiers": {},
   "additionalInformation": {},
   "compensationRequest": {
      "initiationType": "CALL_CENTER",
      "items": [
         {
            "basicItemData": {
               "category": "Apparel and accessories",
               "discount": {
                  "couponCodeUsed": "FATHERSDAY2015",
                  "couponDiscountAmount": {
                     "amountLocalCurrency": "105.55",
                     "amountUSD": "99.95",
                     "currency": "CAD"
                  }
               },
               "name": "White GenericBrand handbag",
               "price": {
                  "amountLocalCurrency": "105.55",
                  "amountUSD": "99.95",
                  "currency": "CAD"
               },
               "productId": "Ag54352R7768kkO",
               "quantity": 1,
               "type": "TANGIBLE"
            },
            "itemCompensationData": {
               "compensationTypeRequested": "REFUND",
               "initiationTime": 1415287568000,
               "internalReasonCategory": "defective item",
               "reasonCategory": "CHANGED_MY_MIND",
               "requestedReturnType": "SHIP_TO_WAREHOUSE"
            }
         }
      ],
      "orderCompensationData": {
         "compensationTypeRequested": "REFUND",
         "initiationTime": 1415287568000,
         "internalReasonCategory": "defective item",
         "reasonCategory": "CHANGED_MY_MIND",
         "requestedReturnType": "SHIP_TO_WAREHOUSE"
      },
      "totalRequestedAmount": {
         "amountLocalCurrency": "105.55",
         "amountUSD": "99.95",
         "currency": "CAD"
      }
   },
   "connectionInformation": {
      "checkoutToolsSessionId": "HTGDVC232fdFDFdfkdjk87382938mcndjc2f4gbbGd",
      "customerIP": "10.0.0.127",
      "forterMobileUID": "6429751237891",
      "forterTokenCookie": "249453te8tbf9355186fet0ken547b95_2786972955236__UDE52-n5_8dg",
      "merchantDeviceIdentifier": "HGJ7512345H3",
      "merchantProvidedSessionId": "HTGDVC232fdFDFdfkdjk87382938mcndjc2f4gbbGd",
      "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,
   "hasProofOfPurchase": true,
   "isGuestAccount": false,
   "merchantAgentData": {
      "merchantAgentId": "HG36885TZ",
      "merchantAgentName": "John Smith"
   },
   "merchantIdentifiers": {
      "merchantDomain": "HandbagsExpressDiscounts.com",
      "merchantName": "Handbags Express Discounts"
   },
   "originalOrderId": "2356fdse0rr489",
   "status": {
      "itemStatus": [
         {
            "basicItemData": {
               "category": "Apparel and accessories",
               "discount": {
                  "couponCodeUsed": "FATHERSDAY2015",
                  "couponDiscountAmount": {
                     "amountLocalCurrency": "105.55",
                     "amountUSD": "99.95",
                     "currency": "CAD"
                  }
               },
               "name": "White GenericBrand handbag",
               "price": {
                  "amountLocalCurrency": "105.55",
                  "amountUSD": "99.95",
                  "currency": "CAD"
               },
               "productId": "Ag54352R7768kkO",
               "quantity": 1,
               "type": "TANGIBLE"
            },
            "statusData": {
               "compensationTypeGranted": "REFUND",
               "internalReasonCategory": "defective item",
               "reasonCategory": "CHANGED_MY_MIND",
               "returnCondition": "DAMAGED",
               "returnMethodGranted": "SHIP_TO_WAREHOUSE",
               "statusLog": {
                  "arrivedToWarehouseTime": 1420070400000,
                  "initiationTime": 1415287568000,
                  "initiationType": "CALL_CENTER",
                  "shippedByCustomerTime": 1420070400000
               },
               "updatedStatus": "ACCEPTED_BY_MERCHANT"
            }
         }
      ],
      "merchantAgentData": {
         "merchantAgentId": "HG36885TZ",
         "merchantAgentName": "John Smith"
      },
      "replacementOrderId": "2356fdse0rr489",
      "shippingRefundedAmount": {
         "amountLocalCurrency": "105.55",
         "amountUSD": "99.95",
         "currency": "CAD"
      },
      "statusData": {
         "compensationTypeGranted": "REFUND",
         "internalReasonCategory": "defective item",
         "reasonCategory": "CHANGED_MY_MIND",
         "returnCondition": "DAMAGED",
         "returnMethodGranted": "SHIP_TO_WAREHOUSE",
         "statusLog": {
            "arrivedToWarehouseTime": 1420070400000,
            "initiationTime": 1415287568000,
            "initiationType": "CALL_CENTER",
            "shippedByCustomerTime": 1420070400000
         },
         "updatedStatus": "ACCEPTED_BY_MERCHANT"
      },
      "totalGrantedAmount": {
         "amountLocalCurrency": "105.55",
         "amountUSD": "99.95",
         "currency": "CAD"
      }
   }
})

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": {
               "category": "Apparel and accessories",
               "discount": {
                  "couponCodeUsed": "FATHERSDAY2015",
                  "couponDiscountAmount": {
                     "amountLocalCurrency": "105.55",
                     "amountUSD": "99.95",
                     "currency": "CAD"
                  }
               },
               "name": "White GenericBrand handbag",
               "price": {
                  "amountLocalCurrency": "105.55",
                  "amountUSD": "99.95",
                  "currency": "CAD"
               },
               "productId": "Ag54352R7768kkO",
               "quantity": 1,
               "type": "TANGIBLE"
            },
            "itemCompensationData": {
               "compensationTypeRequested": "REFUND",
               "initiationTime": 1415287568000,
               "internalReasonCategory": "defective item",
               "reasonCategory": "CHANGED_MY_MIND",
               "requestedReturnType": "SHIP_TO_WAREHOUSE"
            }
         }
      ],
      "orderCompensationData": {
         "compensationTypeRequested": "REFUND",
         "initiationTime": 1415287568000,
         "internalReasonCategory": "defective item",
         "reasonCategory": "CHANGED_MY_MIND",
         "requestedReturnType": "SHIP_TO_WAREHOUSE"
      },
      "totalRequestedAmount": {
         "amountLocalCurrency": "105.55",
         "amountUSD": "99.95",
         "currency": "CAD"
      }
   },
   "connectionInformation": {
      "checkoutToolsSessionId": "HTGDVC232fdFDFdfkdjk87382938mcndjc2f4gbbGd",
      "customerIP": "10.0.0.127",
      "forterMobileUID": "6429751237891",
      "forterTokenCookie": "249453te8tbf9355186fet0ken547b95_2786972955236__UDE52-n5_8dg",
      "merchantDeviceIdentifier": "HGJ7512345H3",
      "merchantProvidedSessionId": "HTGDVC232fdFDFdfkdjk87382938mcndjc2f4gbbGd",
      "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,
   "hasProofOfPurchase": True,
   "isGuestAccount": False,
   "merchantAgentData": {
      "merchantAgentId": "HG36885TZ",
      "merchantAgentName": "John Smith"
   },
   "merchantIdentifiers": {
      "merchantDomain": "HandbagsExpressDiscounts.com",
      "merchantName": "Handbags Express Discounts"
   },
   "originalOrderId": "2356fdse0rr489",
   "status": {
      "itemStatus": [
         {
            "basicItemData": {
               "category": "Apparel and accessories",
               "discount": {
                  "couponCodeUsed": "FATHERSDAY2015",
                  "couponDiscountAmount": {
                     "amountLocalCurrency": "105.55",
                     "amountUSD": "99.95",
                     "currency": "CAD"
                  }
               },
               "name": "White GenericBrand handbag",
               "price": {
                  "amountLocalCurrency": "105.55",
                  "amountUSD": "99.95",
                  "currency": "CAD"
               },
               "productId": "Ag54352R7768kkO",
               "quantity": 1,
               "type": "TANGIBLE"
            },
            "statusData": {
               "compensationTypeGranted": "REFUND",
               "internalReasonCategory": "defective item",
               "reasonCategory": "CHANGED_MY_MIND",
               "returnCondition": "DAMAGED",
               "returnMethodGranted": "SHIP_TO_WAREHOUSE",
               "statusLog": {
                  "arrivedToWarehouseTime": 1420070400000,
                  "initiationTime": 1415287568000,
                  "initiationType": "CALL_CENTER",
                  "shippedByCustomerTime": 1420070400000
               },
               "updatedStatus": "ACCEPTED_BY_MERCHANT"
            }
         }
      ],
      "merchantAgentData": {
         "merchantAgentId": "HG36885TZ",
         "merchantAgentName": "John Smith"
      },
      "replacementOrderId": "2356fdse0rr489",
      "shippingRefundedAmount": {
         "amountLocalCurrency": "105.55",
         "amountUSD": "99.95",
         "currency": "CAD"
      },
      "statusData": {
         "compensationTypeGranted": "REFUND",
         "internalReasonCategory": "defective item",
         "reasonCategory": "CHANGED_MY_MIND",
         "returnCondition": "DAMAGED",
         "returnMethodGranted": "SHIP_TO_WAREHOUSE",
         "statusLog": {
            "arrivedToWarehouseTime": 1420070400000,
            "initiationTime": 1415287568000,
            "initiationType": "CALL_CENTER",
            "shippedByCustomerTime": 1420070400000
         },
         "updatedStatus": "ACCEPTED_BY_MERCHANT"
      },
      "totalGrantedAmount": {
         "amountLocalCurrency": "105.55",
         "amountUSD": "99.95",
         "currency": "CAD"
      }
   }
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json',
   'api-version': '10.1',
   'x-forter-siteid': '8b47c6d423ba',
   'authorization': 'Basic <base64-encoded-api-key:>'
}

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

print(response.text)

200

// Example unifiedCompensationRequestResponse
{
  "correlationId": "",
  "decisionReason": "",
  "forterDecision": "",
  "merchantPolicyId": "",
  "recommendations": [
    ""
  ],
  "status": ""
}

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)

顧客が開始した補償要求（返金や再発送など）に関する情報を送信し、詐欺または悪用に関する決定を受け取ります。要求は注文レベルまたはアイテムレベルで行うことができます。返答には、あなたの悪用防止ポリシーに基づく推奨事項も含まれる場合があります。