Documentation

RefundPurchase

Attempts to process an order refund through the original real money payment provider.

Request Details

RefundPurchaseRequest
Request Properties
OrderId (required) String

Unique order ID for the purchase in question.

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/RefundPurchase
    Content-Type: application/json
    X-SecretKey: <developer_secret_key>
{
  "PlayFabId": "20394883",
  "OrderId": "B456AE0",
  "Reason": "Customer Request"
}
        

Response Details

RefundPurchaseResponse
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": "Refunded"
  }
}

Authentication

SecretKey

Possible Error Codes

Name Code