Documentation

ResolvePurchaseDispute

Attempts to resolve a dispute with the original order's payment provider.

Request Details

ResolvePurchaseDisputeRequest
Request Properties
OrderId (required) String

Unique order ID for the purchase in question.

Outcome (required) ResolutionOutcome

Enum for the desired purchase result state after notifying the payment provider. Valid values are Revoke, Reinstate and Manual. Manual will cause no change to the order state.

PlayFabId (required) String

Unique PlayFab assigned ID of the user on whom the operation will be performed.

Reason String

The Reason parameter should correspond with the payment providers reason field, if they require one such as Facebook. In the case of Facebook this must match one of their refund or dispute resolution enums (See: https://developers.facebook.com/docs/payments/implementation-guide/handling-disputes-refunds)

POST https://{{TitleID}}.playfabapi.com/Admin/ResolvePurchaseDispute
    Content-Type: application/json
    X-SecretKey: <developer_secret_key>
{
  "PlayFabId": "20394883",
  "OrderId": "B456AE0",
  "Reason": "Customer Request",
  "Outcome": "Reinstate"
}
        

Response Details

ResolvePurchaseDisputeResponse
Result Properties
PurchaseStatus String

The order's updated purchase status.

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
  "code": 200,
  "status": "OK",
  "data": {
    "PurchaseStatus": "Approved"
  }
}

Authentication

SecretKey

Possible Error Codes

Name Code