Reembolsar compra

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.

Error codes

This operation may return the following PlayFab errors:

Error	Code
ProductDisabledForTitle	1609

POST

Admin

RefundPurchase

Refund Purchase

curl --request POST \
  --url https://{titleId}.playfabapi.com/Admin/RefundPurchase \
  --header 'Content-Type: application/json' \
  --header 'X-SecretKey: <api-key>' \
  --data '
{
  "PlayFabId": "20394883",
  "OrderId": "B456AE0",
  "Reason": "Customer Request"
}
'

import requests

url = "https://{titleId}.playfabapi.com/Admin/RefundPurchase"

payload = {
    "PlayFabId": "20394883",
    "OrderId": "B456AE0",
    "Reason": "Customer Request"
}
headers = {
    "X-SecretKey": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-SecretKey': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({PlayFabId: '20394883', OrderId: 'B456AE0', Reason: 'Customer Request'})
};

fetch('https://{titleId}.playfabapi.com/Admin/RefundPurchase', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{titleId}.playfabapi.com/Admin/RefundPurchase",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'PlayFabId' => '20394883',
    'OrderId' => 'B456AE0',
    'Reason' => 'Customer Request'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-SecretKey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{titleId}.playfabapi.com/Admin/RefundPurchase"

	payload := strings.NewReader("{\n  \"PlayFabId\": \"20394883\",\n  \"OrderId\": \"B456AE0\",\n  \"Reason\": \"Customer Request\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-SecretKey", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{titleId}.playfabapi.com/Admin/RefundPurchase")
  .header("X-SecretKey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"PlayFabId\": \"20394883\",\n  \"OrderId\": \"B456AE0\",\n  \"Reason\": \"Customer Request\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/Admin/RefundPurchase")

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

request = Net::HTTP::Post.new(url)
request["X-SecretKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"PlayFabId\": \"20394883\",\n  \"OrderId\": \"B456AE0\",\n  \"Reason\": \"Customer Request\"\n}"

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

{
  "code": 200,
  "status": "OK",
  "data": {
    "PurchaseStatus": "Refunded"
  }
}

{
  "code": 123,
  "errorCode": 123,
  "status": "<string>",
  "error": "<string>",
  "errorMessage": "<string>",
  "errorDetails": {}
}

Autorizações

X-SecretKey

string

header

obrigatório

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

Corpo

application/json

OrderId

string

obrigatório

Unique order ID for the purchase in question.

PlayFabId

string

obrigatório

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)

Resposta

code

integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status

string

The Http status code as a string.

data

object

Show child attributes

Exemplo:

{ "PurchaseStatus": "Refunded" }

Última modificação em 6 de outubro de 2026

Tópicos relacionados

Notas de versão do PlayFab 2016 Iniciar compra Obter compra Confirmar compra Pagar pela compra

⌘I

Refund Purchase

curl --request POST \
  --url https://{titleId}.playfabapi.com/Admin/RefundPurchase \
  --header 'Content-Type: application/json' \
  --header 'X-SecretKey: <api-key>' \
  --data '
{
  "PlayFabId": "20394883",
  "OrderId": "B456AE0",
  "Reason": "Customer Request"
}
'

import requests

url = "https://{titleId}.playfabapi.com/Admin/RefundPurchase"

payload = {
    "PlayFabId": "20394883",
    "OrderId": "B456AE0",
    "Reason": "Customer Request"
}
headers = {
    "X-SecretKey": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-SecretKey': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({PlayFabId: '20394883', OrderId: 'B456AE0', Reason: 'Customer Request'})
};

fetch('https://{titleId}.playfabapi.com/Admin/RefundPurchase', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{titleId}.playfabapi.com/Admin/RefundPurchase",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'PlayFabId' => '20394883',
    'OrderId' => 'B456AE0',
    'Reason' => 'Customer Request'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-SecretKey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{titleId}.playfabapi.com/Admin/RefundPurchase"

	payload := strings.NewReader("{\n  \"PlayFabId\": \"20394883\",\n  \"OrderId\": \"B456AE0\",\n  \"Reason\": \"Customer Request\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-SecretKey", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{titleId}.playfabapi.com/Admin/RefundPurchase")
  .header("X-SecretKey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"PlayFabId\": \"20394883\",\n  \"OrderId\": \"B456AE0\",\n  \"Reason\": \"Customer Request\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/Admin/RefundPurchase")

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

request = Net::HTTP::Post.new(url)
request["X-SecretKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"PlayFabId\": \"20394883\",\n  \"OrderId\": \"B456AE0\",\n  \"Reason\": \"Customer Request\"\n}"

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

{
  "code": 200,
  "status": "OK",
  "data": {
    "PurchaseStatus": "Refunded"
  }
}

{
  "code": 123,
  "errorCode": 123,
  "status": "<string>",
  "error": "<string>",
  "errorMessage": "<string>",
  "errorDetails": {}
}

PlayFab API

PlayFab REST API References

Reembolsar compra

Error codes

Autorizações

Corpo

Resposta