Player Data Management - Refund Purchase

Service:

Admin

API Version:

240412

NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2. Attempts to process an order refund through the original real money payment provider.

POST https://titleId.playfabapi.com/Admin/RefundPurchase

Request Header

Name	Required	Type	Description
X-SecretKey	True	string	This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Request Body

Name	Required	Type	Description
OrderId	True	string	Unique order ID for the purchase in question.
PlayFabId	True	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)

Responses

Name	Type	Description
200 OK	RefundPurchaseResponse
400 Bad Request	ApiErrorWrapper	This is the outer wrapper for all responses with errors

Security

X-SecretKey

This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Type: apiKey
In: header

Definitions

Name	Description
ApiErrorWrapper	The basic wrapper around every failed API response
RefundPurchaseRequest
RefundPurchaseResponse

ApiErrorWrapper

The basic wrapper around every failed API response

Name	Type	Description
code	integer	Numerical HTTP code
error	string	Playfab error code
errorCode	integer	Numerical PlayFab error code
errorDetails	object	Detailed description of individual issues with the request object
errorMessage	string	Description for the PlayFab errorCode
status	string	String HTTP code

RefundPurchaseRequest

Name	Type	Description
OrderId	string	Unique order ID for the purchase in question.
PlayFabId	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)

RefundPurchaseResponse

Name	Type	Description
PurchaseStatus	string	The order's updated purchase status.